Client Installation

Most users will be executing the ssoca client binary from their workstations which require an initial setup.

Dependencies

First, users must install the ssoca client binary. After you install using one of the following methods, run ssoca version to verify. This only needs to happen once per workstation.

Homebrew or Linuxbrew

For users of Homebrew (macOS) or Linuxbrew, you may use the dpb587/homebrew-tap tap to install the latest official binaries.

brew install dpb587/tap/ssoca

Official Releases

Official binaries are listed on the Official Releases page (you may also find the same artifacts from GitHub Releases). Find the correct ssoca-client-* for your operating system and platform and install it.

For example, with the latest release on macOS:

wget -O /usr/local/bin/ssoca https://s3-external-1.amazonaws.com/dpb587-ssoca-us-east-1/artifacts/v0.19.2/ssoca-client-0.19.2-darwin-amd64
echo "d1989a9ab588928ffb3d7721a5711ce99e83ab98d6e2b5c5dab114f102dee3ba  /usr/local/bin/ssoca" | shasum -c -
chmod +x /usr/local/bin/ssoca

Local Environment

Your local environment may also provide binaries for you to download as well. Visit your ssoca server from a browser for download links and checksums.

Environment Configuration

Once you have the ssoca client available, you should configure your environment with an alias. Visiting the ssoca server from a browser may provide you with similar setup instructions. If your environment is using a custom CA certificate, use the --ca-cert option. This only needs to happen once per environment.

ssoca -e example-prod env set https://prod.example.com

You will receive a confirmation once it has connected successfully, then you may authenticate to verify access.

ssoca -e example-prod auth login

After authenticating, you can use one of the services provided by the server (e.g. OpenVPN or SSH).