Auth0 OIDC

Auth0 OIDC SSO is a paid feature. If you're using Hanzo KMS Cloud, then it is it.

1.1. From the Application's Page, navigate to the settings tab of the Auth0 application you want to integrate with Hanzo KMS.

1.2. In the Application URIs section, set the Application Login URI and Allowed Web Origins fields to https://app.kms.hanzo.ai and the Allowed Callback URL field to https://app.kms.hanzo.ai/api/v1/sso/oidc/callback.

If you’re self-hosting Hanzo KMS, then you will want to replace https://app.kms.hanzo.ai with your own domain.

Once done, click Save Changes.

1.3. Proceed to the Connections Tab and enable desired connections.

2.1. From the application settings page, retrieve the Client ID and Client Secret

2.2. In the advanced settings (bottom-most section), retrieve the OpenID Configuration URL from the Endpoints tab.

Keep these values handy as we will need them in the next steps.

3.1. Back in Hanzo KMS, head to the Single Sign-On (SSO) page and select the General tab. Click Connect for OIDC.

3.2. For configuration type, select Discovery URL. Then, set Discovery Document URL, JWT Signature Algorithm, Client ID, and Client Secret from step 2.1 and 2.2.

Currently, the following JWT signature algorithms are supported: RS256, RS512, HS256, and EdDSA

Once you've done that, press Update to complete the required configuration.

Enabling OIDC allows members in your organization to log into Hanzo KMS via Auth0.

Enforcing OIDC SSO ensures that members in your organization can only access Hanzo KMS by logging into the organization via Auth0.

To enforce OIDC SSO, you're required to test out the OpenID connection by successfully authenticating at least one Auth0 user with Hanzo KMS. Once you've completed this requirement, you can toggle the Enforce OIDC SSO button to enforce OIDC SSO.

We recommend ensuring that your account is provisioned using the application in Auth0 prior to enforcing OIDC SSO to prevent any unintended issues.

In case of a lockout, an organization admin can use the Admin Login Portal in the /login/admin path e.g. https://app.kms.hanzo.ai/login/admin.

If you are only using one organization on your Hanzo KMS instance, you can configure a default organization in the Server Admin Console to expedite OIDC login.

If you're configuring OIDC SSO on a self-hosted instance of Hanzo KMS, make sure to set the AUTH_SECRET and SITE_URL environment variable for it to work:

• AUTH_SECRET: A secret key used for signing and verifying JWT. This can be a random 32-byte base64 string generated with openssl rand -base64 32.

• SITE_URL: The absolute URL of your self-hosted instance of Hanzo KMS including the protocol (e.g. https://app.kms.hanzo.ai)