Skip to content

Latest commit

 

History

History
371 lines (288 loc) · 14.8 KB

openid-connect-configuration.md

File metadata and controls

371 lines (288 loc) · 14.8 KB
icon
key-skeleton

OpenID Connect Configuration

The installation guide explain how to set up a new Keycloak instance to enable authentication on your datalab.

However, chances are that your organization already has an existing IAM system in place. This guide covers how to integrate Onyxia with various commonly used OIDC providers, including Keycloak, Auth0, and Microsoft Entra ID.

API Reference

Overview of all the available parameters

{% code title="apps/onyxia/values.yaml" %}

onyxia:
  api:
    env:
      # Mandatory and no other authentication mode is currently supported.
      authentication.mode: "openidconnect"

      # Mandatory: The issuer URI of the OIDC provider.  
      oidc.issuer-uri: "..."

      # Mandatory: The client ID of the OIDC client representing the Onyxia Web Application.
      oidc.clientID: "..."

      # Mandatory: Defines which claim in the Access Token's JWT serves as the unique 
      # user identifier.  
      # This identifier must contain only lowercase alphanumeric characters and `-`. 
      # Specifically, it must comply with RFC 1123: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
      #
      # - If your usernames already conform to this constraint, you can use 
      #   `"preferred_username"` for a more human-readable identifier.
      # - If usernames contain special characters, use another claim 
      #   such as `"sub"` (Ensure that the `sub` values comply with RFC 1123).  
      #
      oidc.username-claim: "..."

      # Optional: Defaults to `"groups"`. Defines which claim represents user groups.
      # See: https://docs.onyxia.sh/admin-doc/setting-up-group-projects
      oidc.groups-claim: "..."

      # Optional: Defaults to `"roles"`. Defines which claim represents user roles.
      oidc.roles-claim: "..."

      # Optional: Additional query parameters to append to the OIDC provider login URL.  
      # Example: If using Keycloak with Google OAuth as an identity provider, you might want  
      # to preselect Google as the login option using `"kc_idp_hint=google"`.  
      # 
      # ⚠️ This string is appended as-is. Ensure it is properly URI-encoded.  
      # If adding multiple parameters, separate them with `&`.  
      #
      # Example: `"foo=foo%20value&bar=bar%20value"`
      oidc.extra-query-params: "..."

      # Optional: Specifies the expected audience (`aud`) value in the Access Token.  
      # If provided, Onyxia will validate the `aud` claim in the token and reject 
      # requests where it does not match (or does not include a matching entry if `aud` is an array).
      oidc.audience: "..."

      # Optional: Specifies the OIDC scopes requested by the Onyxia client.  
      # Defaults to `"openid profile"`.  
      # This is a space-separated list. `"openid"` is always requested, 
      # regardless of this setting.
      oidc.scope: "..."
      
      # Optional: Automatically logs out users after a set period of inactivity. 
      # If you are using Keycloak do not provide this value, it's inferred automatically. 
      oidc.idleSessionLifetimeInSeconds: "..."

      # Optional: The Onyxia API fetches `<issuer-uri>/.well-known/openid-configuration` 
      # to retrieve JWKs for validating Access Tokens (used as Authorization Bearers).  
      #
      # ⚠️ In development, if you lack proper root certificates, you can disable TLS verification.  
      # However, in production, it is strongly recommended to mount the correct `cacerts` instead.
      oidc.skip-tls-verify: "true|false"

{% endcode %}

OIDC Provider Specific Configuration Guides

{% tabs %} {% tab title="Keycloak" %} Onyxia Login Theme

Each version of Onyxia ships with a custom Keycloak login theme. You can download it from the release page. Specific instructions for loading the theme in your Onyxia instance can be found in this guide.

If you are deploying Keycloak using Helm, as instructed in the installation guide, here are the relevant lines in the Onyxia-ops repository.

Choosing the Unique User Identifier Claim

Onyxia requires a unique user identifier. You must specify which claim in the Access Token should be used for this purpose.

Ideally, you can use preferred_username as an identifier, but this requires ensuring it complies with RFC 1123. This means it must contain only lowercase alphanumeric characters and -.

Since this format is restrictive, if you already have an existing user base, preferred_username may not be an option. In that case, you have two alternatives:

  • Define a custom claim: Configure a Keycloak mapper to generate an RFC 1123-compliant claim in the Access Token.
  • Use "sub": This claim is guaranteed to be unique and always present, but ensure that the sub values comply with RFC 1123.

If you are starting fresh with no existing users, you can enforce a regex pattern in the User Profile Attributes to require usernames that comply with the restriction.

More details can be found in the installation guide (search for "pattern").

Configuring Keycloak

Beyond what's covered in the installation guide, if you need a more general tutorial on setting up a public Keycloak OIDC client like Onyxia, refer to the following guide. It includes a test project to validate your configuration.

For Onyxia, use these substitutions in the guide:

  • <KC_DOMAIN>: auth.lab.my-domain.net
  • <KC_RELATIVE_PATH>: /auth
  • <REALM_NAME>: datalab
  • <APP_DOMAIN>: datalab.my-domain.net
  • <BASE_URL>: /
  • <DEV_PORT>: 5173
  • ✅ Note that Onyxia implement an auto logout countdown that will start to display once minute befor auto logout if you configure your client as a sensible app.

{% embed url="https://docs.oidc-spa.dev/providers-configuration/keycloak" %}

Here is an overview of what your Onyxia values.yaml should look like:

{% code title="apps/onyxia/values.yaml" %}

onyxia:
  api:
    env:
      authentication.mode: "openidconnect"
      # Example: "https://auth.lab.my-domain.net/auth/realms/datalab"
      oidc.issuer-uri: "https://<KC_DOMAIN><KC_RELATIVE_PATH>/realms/<REALM_NAME>"
      # Example: "onyxia"
      oidc.clientID: "<ONYXIA_CLIENT_ID>"
      # Examples:
      # `"preferred_username"` if a regex pattern is enforced for usernames.
      # `"my-custom-claim"`    if a custom Keycloak mapper is configured.
      # `"sub"`                always works and is unique.
      oidc.username-claim: "..."

{% endcode %} {% endtab %}

{% tab title="Microsoft Entra ID" %} Follow this guide to configure a Microsoft Entra ID application for Onyxia.

For Onyxia, use these substitutions:

  • "My App" → "Onyxia"
  • "My App - API" → "Onyxia - API"
  • "api://my-app-api" → "api://onyxia-api"
  • "https://my-app.com/" → "https://datalab.my-domain.net/"

{% embed url="https://docs.oidc-spa.dev/providers-configuration/microsoft-entra-id" %}

Here is what your configuration should look like:

{% code title="apps/onyxia/values.yaml" %}

onyxia:
  api:
    env:
      authentication.mode: "openidconnect"
      oidc.issuer-uri: "https://login.microsoftonline.com/<Directory (tenant) ID (Onyxia)>/v2.0"
      oidc.clientID: "<Application (client) ID (Onyxia)>"
      # ⚠️ Do **not** use `"sub"` or `"upn"` as they may contain 
      # non-alphanumeric characters.
      oidc.username-claim: "oid"
      # Example: "profile api://onyxia-api/access_as_user"
      oidc.scope: "profile <Application ID URI (Onyxia - API)>/<scope name (usually access_as_user)>"
      # Example: "api://onyxia-api"
      oidc.audience: "<Application ID URI (Onyxia - API)>"

{% endcode %} {% endtab %}

{% tab title="Auth0" %} Follow this guide to configure an Auth0 application for Onyxia.

For Onyxia, use these substitutions:

  • "My App" → "Onyxia"
  • <APP_DOMAIN> → datalab.my-domain.net
  • <BASE_URL> → /
  • <DEV_PORT> → 5173
  • "My App - API" → "Onyxia - API"
  • https://myapp.my-company.com/api → https://datalab.my-domain.net/api
  • "auth.my-company.com" → "auth.my-domain.net"

{% embed url="https://docs.oidc-spa.dev/providers-configuration/auth0" %}

Generating an RFC 1123-Compliant Claim in the Access Token

By default, Auth0 does not issue a claim that Onyxia can use as a unique user identifier. You must create one by defining a custom claim in the access token using an Auth0 Trigger Action.

Steps to Create the onyxia-username Claim

1️⃣ Create a Custom Action:

  1. Go to Auth0 Dashboard → Actions → Library.
  2. Click Create Action.
  3. Set:
    • Name: GenerateOnyxiaUsername
    • Trigger: Post Login
    • Runtime: Node 22
  4. Click Create.

2️⃣ Add the Custom Code:
Replace the default content with:

function toRFC1123(input) {
  if (!input) return "";
  let output = input.toLowerCase().replace(/[^a-z0-9-]/g, "-").replace(/^-+|-+$/g, "");
  return output.length > 63 ? output.substring(0, 63).replace(/-+$/, "") : output;
}

exports.onExecutePostLogin = async (event, api) => {
  const sub = event.user.user_id;
  if (sub) api.accessToken.setCustomClaim("onyxia-username", toRFC1123(sub));
};

3️⃣ Deploy and Activate the Action:

  1. Click Deploy.
  2. Go to Auth0 Dashboard → Actions → Triggers → Post Login.
  3. Drag & drop GenerateOnyxiaUsername into the flow.
  4. Click Apply Changes.

Now, your access token will include the onyxia-username claim.

Preview of the decoded JWT of the Access Token issued by Auth0
with the custom action enabled when previewed with the
test app of the oidc-spa guide

Final Configuration

{% code title="apps/onyxia/values.yaml" %}

onyxia:
  api:
    env:
      authentication.mode: "openidconnect"
      oidc.issuer-uri: "https://auth.my-domain.net"
      oidc.clientID: "<Onyxia Application Client ID>"  
      oidc.username-claim: "onyxia-username"
      oidc.audience: "https://datalab.my-domain.net/api"
      # Optional: Auto logout after inactivity.
      oidc.idleSessionLifetimeInSeconds: "300"

{% endcode %} {% endtab %}

{% tab title="Other" %} If you're using another OIDC provider and need help configuring Onyxia, reach out on Slack. We’ll be happy to schedule a call and assist with the integration.

However, here are some generic instructions. (Replace https://my-app.com/ by https://datalab.my-domain.net/.)

{% embed url="https://docs.oidc-spa.dev/providers-configuration/other" %} {% endtab %} {% endtabs %}

OIDC Configuration for Services Onyxia Connects To

Onyxia uses an OIDC client for authentication, but it also connects to other OIDC-enabled services.
Each of these services can have its own OIDC configuration, allowing Onyxia to authenticate
using a separate client identity.

In the region configuration, you can specify an optional oidcConfiguration object for
each service:

  • S3 (MinIO STS) → onyxia.api.regions[].data.S3.sts.oidcConfiguration
  • Vault → onyxia.api.regions[].vault.oidcConfiguration
  • Kubernetes API → onyxia.api.regions[].services.k8sPublicEndpoint.oidcConfiguration

Each configuration follows this structure:

type OidcConfiguration = {
    issuerURI?: string;
    clientID?: string;
    extraQueryParams?: string;
    scope?: string;
    audience?: string;
    idleSessionLifetimeInSeconds?: number;
};

If no oidcConfiguration is provided for a service, Onyxia will reuse its own OIDC client
and the same Access Token for authentication. However, it is recommended to provide
a separate client ID for each service to improve access control and security.

Example Configuration in values.yaml

{% code title="" %}

onyxia:
  api:
    env:
      authentication.mode: "openidconnect"
      oidc.issuer-uri: "https://auth.lab.my-domain.net/auth/realms/datalab"
      oidc.clientID: "onyxia"
    regions: 
      [
        {
          data: {
            S3: {
              sts: {
                oidcConfiguration: {
                  clientID: "onyxia-minio",
                }
              }
            }
          },
          vault: {
            oidcConfiguration: {
              clientID: "onyxia-vault"
            }
          },
          services: {
            k8sPublicEndpoint: {
              oidcConfiguration: {
                clientID: "onyxia-k8s"
              }
            }
          }
        }
      ]

{% endcode %}

⚠ Important: Consistency of Claims Across Services

When configuring OIDC for Onyxia, you define specific claims that indicate where to find
the user identifier, groups, and roles within the Access Token's JWT.

These claims cannot be configured separately for each service Onyxia interacts with (e.g., S3, Vault, Kubernetes API).
They must remain consistent across all OIDC-enabled services to ensure proper authentication and authorization.

Ensuring Claim Consistency Across Services

When a user logs in, the OIDC provider issues an Access Token for the onyxia client.
This token includes claims such as:

{
  "sub": "abcd1234",
  "preferred_username": "jhondoe",
  "groups": [ "funathon", "spark-lab" ],
  "roles": [ "vip", "admin-keycloak" ]
}

If oidc.username-claim: "preferred_username" is configured in Onyxia’s main configuration,
then all services it connects to—such as onyxia-minio, onyxia-vault, and onyxia-k8s—
must also receive Access Tokens where the preferred_username claim exists and holds the same value.

To prevent issues, all OIDC clients (onyxia, onyxia-minio, onyxia-vault, onyxia-k8s)
should be configured within the same SSO realm in your OIDC provider.
This ensures that every issued Access Token follows the same claim structure and contains
consistent values for the same user.

If you're unsure whether your setup meets this requirement, check the JWT of each Access Token
issued for different clients and confirm that the claims are aligned.