Single Sign-on (SSO) for DB Console

On this page Carat arrow pointing down

CockroachDB clusters allow users to authenticate with single sign-on (SSO) to the DB Console and the SQL interface:

  • Cluster single sign-on (SSO): Enables users to access the SQL interface of a CockroachDB cluster (whether provisioned on CockroachDB Cloud or Self-Hosted) with the full security of single sign-on (SSO), and the choice of a variety of cloud-based or customer-managed identity providers (IdPs).

  • Single sign-on (SSO) for DB Console: Allows a CockroachDB user to access the DB Console in a secure cluster via an OpenID Connect (OIDC) client and an external identity provider. When SSO is configured and enabled, the DB Console login page will display an OAuth login button in addition to the password access option.

This page describes how to set up Single Sign-on to the DB Console, which includes the following steps:

If you would also like to enable SSO authentication for SQL clients, you must complete additional configuration on the Cluster Single Sign-on (SSO) using a JSON web token (JWT) page.

This SSO implementation uses the authorization code grant type to authenticate a user.


Log in to a cluster's DB Console with SSO

From the user's perspective, once the cluster is properly configured to an identity provider, the sign-in flow is as follows:

  1. A user opens the cluster's DB Console, and clicks on the Log in with your OIDC provider button that renders on the page.
  2. The user is redirected to an external identity provider.
  3. The user authenticates successfully with the provider, which completes the OAuth flow.
  4. The user is redirected to the CockroachDB cluster.
  5. CockroachDB creates a web session for the SQL user in a new browser tab.
  6. In the original browser tab, the user is redirected to the DB Console Cluster Overview.

Provision an OAuth client using Google Cloud Platform (GCP)

These steps demonstrate how to create an OIDC auth client in Google Cloud Platform to use for SSO authentication to the DB Console.

  1. Open the Credentials page for your account at Google APIs.

  2. Click + CREATE CREDENTIALS and select OAuth client ID. Specify a web application from the pulldown menu.

  3. Note the client ID and client secret of the OAuth 2.0 client—you will need to configure your cluster to use these values.

  4. Add your cluster's callback URL to the list of Authorized redirect URIs. On a local cluster, this will be https://{ your cluster's domain }:8080/oidc/v1/callback. Subsequently, when configuring your cluster, you will need to ensure that the cluster setting server.oidc_authentication.redirect_url has the same value.

    • For a Self-Hosted cluster, the domain is localhost.
    • For a Dedicated cluster, find the domain by opening the DB Console from your cluster's Tools tab in DB Console.

Configure your cluster to use an OIDC client and provider


You must have the ability to update your cluster settings, which you can achieve in several ways. Refer to the Required Privileges section on the SET CLUSTER SETTING page.

Cluster Settings

You must configure the cluster settings in the following table to enable SSO authentication to the DB Console. Refer to the Update your cluster settings section to configure your cluster settings.

Cluster Setting Description
server.oidc_authentication.enabled A Boolean that enables or disables SSO.
server.oidc_authentication.client_id Your auth client's ID.
server.oidc_authentication.client_secret Your auth client's secret.
server.oidc_authentication.redirect_url Specifies the callback URL that redirects the user to CockroachDB after a successful authentication. This can be the address of a node in the cluster or the address of a load balancer that routes traffic to the nodes. You must append the path with /oidc/v1/callback. Accepts either a single URL string (for example, https://{your_cluster's_domain }:8080/oidc/v1/callback) or a JSON object with the following format, which supports region-based OIDC authentication with a callback URL configured per region:
Example: {"redirect_urls": {"us-east-1": "https://{cluster_ip_address}:8080/oidc/v1/callback","eu-west-1": ""}}
server.oidc_authentication.provider_url Specifies the OAuth issuer identifier. Ensure that the URL does not have a terminating /. For more information, refer to the OIDC specification. Note that CockroachDB appends the required /.well-known/openid-configuration by default. You do not need to include it.
server.oidc_authentication.scopes A space-delimited list of the OAuth scopes being requested for an Access Token. The openid and email scopes must be included.
Example: openid profile email.
server.oidc_authentication.claim_json_key The field/key used to identify the user from the external identity provider's ID Token, such as email. The key can contain a single identity or a list of identities, and is parsed using server.oidc_authentication.principal_regex.
server.oidc_authentication.principal_regex Regex used to map the external identity key to a SQL user. If the identity key contains a list of identities instead of a single identity, each identity is evaluated serially until a match is found. The first match that is found is used, and the remaining identities are not evaluated. For example: ^([^@]+)@[^@]+$ matches any email address (defined as a string containing one @ sign) and extracts a username from the string to the left of @, whereas ^(.+)$ maps the claim directly to a principal. The regex must contain exactly one capture group (set of parentheses); a regex with no capture groups or multiple capture groups will never find a match.
server.oidc_authentication.autologin A Boolean that enables or disables automatic login with SSO when the DB Console is loaded. If set to false (the default), the user will have to click Log in with your OIDC provider (unless overriden with setting below) before they're authenticated.
server.oidc_authentication.button_text Specifies the text to show on the button that launches authentication with the OIDC provider. This is set to Log in with your OIDC provider by default but can be customized to reference your specific provider by name.

Update your cluster settings

  1. Open a SQL shell to your cluster:

    cockroach sql --certs-dir=certs --host={your cluster url}:26257
  2. Specify the client ID and client secret you obtained earlier:

    SET CLUSTER SETTING server.oidc_authentication.client_id = '\<client id\>';
    SET CLUSTER SETTING server.oidc_authentication.client_secret = '\<client secret\>';
  3. Specify the OAuth provider URL:

    SET CLUSTER SETTING server.oidc_authentication.provider_url = '';
  4. Specify the callback URL to redirect the user to the CockroachDB cluster. On a local cluster, this will be https://localhost:8080/oidc/v1/callback. For a Dedicated cluster, replace 'localhost' with your cluster's domain, which can be found by opening the DB Console from the Tools tab in your cluster's page in Cloud Console.

    SET CLUSTER SETTING server.oidc_authentication.redirect_url = 'https://{your cluster url}:8080/oidc/v1/callback';
  5. Specify the following values to obtain an OIDC identifier that will be mapped to a SQL user.

    Request the openid and email scopes from the Access Token:

    SET CLUSTER SETTING server.oidc_authentication.scopes = 'openid email';

    Specify the email field from the ID Token:

    SET CLUSTER SETTING server.oidc_authentication.claim_json_key = 'email';

    Use a regular expression that will extract a username from email that you can match to a SQL user. For example, '^([^@]+)@cockroachlabs\.com$' extracts the characters that precede in the email address.

    SET CLUSTER SETTING server.oidc_authentication.principal_regex = '^([^@]+)$';
  6. Create a SQL user that will log into the DB Console. The SQL username you specify must match the identifier obtained in the previous step. For example, a user with the email address will need the SQL username docs:

    CREATE USER docs;
  7. Finally, enable OIDC authentication:

    SET CLUSTER SETTING server.oidc_authentication.enabled = true;

You can optionally enable the server.oidc_authentication.autologin cluster setting to automatically log in an authenticated user who visits the DB Console.

See also

Yes No
On this page

Yes No