diff --git a/docs/guides/authentication/enterprise-sso.md b/docs/guides/authentication/enterprise-sso.md new file mode 100644 index 00000000..23d2fc9e --- /dev/null +++ b/docs/guides/authentication/enterprise-sso.md @@ -0,0 +1,163 @@ +--- +title: "Enterprise SSO" +description: "Connect your company's OpenID Connect provider to Internet Computer applications: register an OIDC client, publish one file on your domain, and optionally gate access app by app." +sidebar: + order: 2 +--- + +Internet Identity can authenticate your staff against your company's existing OpenID Connect provider, such as Okta, Entra ID, Google Workspace, or Auth0. Staff enter your company domain on the sign-in screen and authenticate with the account they already have. + +Setup is two steps and takes one OIDC client and one file on your domain. Nothing has to be registered with Internet Identity: it discovers your configuration from that file. A third, optional step controls access app by app. + +This guide is for the SSO administrator. If you are building an application, see [Internet Identity](internet-identity.md). + +## 1. Register an OIDC client + +In your identity provider, create App Integration → **OIDC** → **Web Application**. + +| Setting | Value | +|---------|-------| +| Redirect URI | `https://id.ai/callback` | +| Grant types | Authorization Code and Implicit (hybrid) | +| ID token | Allow ID Token with implicit grant | +| Access token | Leave Access Token unchecked | +| Scopes | `openid`, `profile`, `email` | + +Copy down the `client_id`, for example `0oaDEFAULT`. You need it in step 2. + +## 2. Publish the discovery file + +Serve a file over HTTPS at exactly this path on your company domain: + +```text +https://acme.com/.well-known/ii-openid-configuration +``` + +```json +{ + "client_id": "0oaDEFAULT", + "openid_configuration": "https://acme.okta.com/.well-known/openid-configuration", + "name": "Acme Corp" +} +``` + +| Field | Value | +|-------|-------| +| `client_id` | The client from step 1 | +| `openid_configuration` | Your IdP's OIDC discovery URL | +| `name` | Optional label on the sign-in screen | + +Serve it with `Access-Control-Allow-Origin: *` so applications can check the domain before sending a user into the flow. + +That is the whole setup. On **id.ai**, staff choose **Sign in with SSO**, enter **acme.com** as their company domain, then authenticate against your IdP. + +### How long a sign-in lasts + +A sign-in stays valid for eight hours. Once that much time has passed since a member of staff authenticated, they authenticate against your IdP again. Set `"session_max_age_seconds"` to choose a different length: + +```json +{ + "client_id": "0oaDEFAULT", + "openid_configuration": "https://acme.okta.com/.well-known/openid-configuration", + "session_max_age_seconds": 28800 +} +``` + +The default of eight hours (`28800`) covers a working day, so staff re-authenticate at most daily. The ceiling is 30 days (`2592000`). + +Applications choose their own session length as well, and this value caps it: an application asking for 30 days on a domain that allows eight hours gets eight hours. + +## 3. Gate access per app (optional) + +By default your staff can sign in to any Internet Computer application with the client from step 1, and your provider's assignment rules for that client apply everywhere. To govern one application on its own, give it a client of its own. + +Repeat these three steps for each application you want to gate. + + + +**a. Add a client for the app.** Register a second OIDC client, identical settings to step 1. Copy its `client_id`, for example `0oaPAYROLL`. + +**b. Assign who is allowed.** That client → **Assignments** → add the groups or users. This assignment is the access rule: assigned staff sign in as normal, anyone else is stopped by your IdP. On Entra ID, set **Assignment required** to **Yes** on the client as well. It defaults to **No**, which leaves the app open to your whole tenant. + +**c. Map the app to it.** Add one `app_clients` line to the file from step 2, keyed by the application's origin: + +```json +"app_clients": { + "https://payroll.acme.com": "0oaPAYROLL" +} +``` + +### Applications you have not listed + +By default, an application missing from `app_clients` falls back to the organization's client from step 1, so staff can sign in to it like any other. Set `"gate_all_apps": true` to refuse those sign-ins instead, and staff visiting an unlisted application are told your organization has not granted it access. + +Use `true` when the list is meant to be exhaustive, so a new application cannot be signed in to until you have added it deliberately. + +### Providers that issue a per-client subject + +This applies only once an application has a client of its own. + +Some providers, Entra ID among them, issue a different `sub` for the same person in each OIDC client. Sign-ins through the per-app client would then look like a different person from sign-ins through the organization's client. Set `"stable_identifier_claim"` to a claim that stays the same across your clients: on Entra ID that is `oid`. + +It defaults to `sub`, which is correct when your provider's `sub` is already the same in every client. + +### Hiding an app name + +The file is public, so any origin you list is visible to anyone who reads it. To map an application without naming it, use a salted hash of its origin as the key instead of the origin itself. + +Run this in a shell, with `origin` set to the application's URL: + +```bash +origin=https://payroll.acme.com +salt=$(openssl rand -hex 8) +data=$origin$salt +out=$(printf %s "$data" | openssl dgst -sha256 -r) +hash=$(echo $out | cut -d' ' -f1) +echo "$hash:$salt" +``` + +It prints one value, in the form `:`. Use it as the key in place of the origin: + +```json +"app_clients": { + "9c8dbbd738e2e390267c7dd7350623c541907a66a1f064e22c13d954e08322af:9f86d081884c7d65": "0oaPAYROLL" +} +``` + +Internet Identity matches the key by hashing the origin of whichever application the user is signing in to, so cleartext and hashed keys can be mixed in one file. + +## The complete file + +Every field, with the optional ones filled in: + +```json +{ + "client_id": "0oaDEFAULT", + "openid_configuration": "https://acme.okta.com/.well-known/openid-configuration", + "name": "Acme Corp", + "session_max_age_seconds": 28800, + "app_clients": { + "https://payroll.acme.com": "0oaPAYROLL", + "https://board.acme.com": "0oaBOARD" + }, + "gate_all_apps": false, + "stable_identifier_claim": "sub" +} +``` + +`client_id` and `openid_configuration` are required. The rest are optional: + +| Field | Default | Purpose | +|-------|---------|---------| +| `name` | the domain | Label shown on the sign-in screen | +| `session_max_age_seconds` | `28800` (eight hours) | How long a sign-in stays valid before staff authenticate again | +| `app_clients` | none | Maps an application's origin, or a salted hash of it, to the client that governs it | +| `gate_all_apps` | `false` | Refuse applications that are not listed in `app_clients` | +| `stable_identifier_claim` | `sub` | The claim that identifies the same person across your clients | + +## Next steps + +- [Internet Identity](internet-identity.md): how applications send users into this flow. +- [`@icp-sdk/auth` reference](https://js.icp.build): the client library applications use to start it. + + diff --git a/docs/guides/authentication/internet-identity.mdx b/docs/guides/authentication/internet-identity.mdx index 9bf736f7..bf567fb6 100644 --- a/docs/guides/authentication/internet-identity.mdx +++ b/docs/guides/authentication/internet-identity.mdx @@ -129,6 +129,39 @@ const authClient = new AuthClient({ The rest of the flow (`signIn`, `getIdentity`, `signOut`) is unchanged. +### One-click SSO sign-in + +To send the user to their organization's own OpenID provider instead, pass `ssoDomain` with the organization's domain. Internet Identity resolves the provider from a configuration file the organization publishes on that domain, so nothing has to be registered on either side: + +```javascript +const authClient = new AuthClient({ + identityProvider: getIdentityProviderUrl(), + ssoDomain: "acme.com", +}); +``` + +`openIdProvider` and `ssoDomain` are mutually exclusive. Each picks a different provider for the same sign-in, so setting both throws. + +If the domain comes from the user rather than your own configuration, validate it first. `isValidSsoDomain` checks that the domain is well-formed and that it publishes an SSO configuration: + +```javascript +import { isValidSsoDomain } from "@icp-sdk/auth/client"; + +const controller = new AbortController(); + +if (await isValidSsoDomain(domainInput.value, controller.signal)) { + const authClient = new AuthClient({ + identityProvider: getIdentityProviderUrl(), + ssoDomain: domainInput.value, + }); + await authClient.signIn(); +} +``` + +Call `controller.abort()` when the input changes. An aborted check rejects instead of returning `false`, so a superseded check is never read as an invalid domain. The check also never resolves in under 750 ms, which keeps a partially typed domain from flashing an error on every keystroke. + +For what an organization publishes to make this flow work, see [Enterprise SSO](enterprise-sso.md). + ### Create an authenticated agent After sign-in, create an `HttpAgent` using the delegation identity. The agent signs all subsequent canister calls with the user's delegated key: @@ -233,6 +266,19 @@ const attributesPromise = authClient.requestAttributes({ }); ``` +#### SSO-scoped attributes + +Attributes work the same way for an SSO sign-in, scoped to the organization's domain instead of a provider issuer: + +```typescript +const attributesPromise = authClient.requestAttributes({ + keys: scopedKeys({ ssoDomain: "acme.com", keys: ["name", "email"] }), + nonce: noncePromise, +}); +``` + +They arrive in the bundle as `sso:acme.com:name` and `sso:acme.com:email`. Only those two keys are available: `verified_email` is not, because Internet Identity has no basis to confirm that a user has access to an address asserted by another organization's provider. + ## Backend authentication Your backend canister receives the caller's principal automatically through the IC protocol. You do not pass the principal as a function argument: use `msg.caller` (Motoko) or `ic_cdk::api::msg_caller()` (Rust) to read it. @@ -617,6 +663,7 @@ For full details, see the [Internet Identity specification](../../references/int ## Next steps +- [Enterprise SSO](enterprise-sso.md) for connecting an organization's own OpenID provider, from the administrator's side - [Wallet integration](../digital-assets/wallet-integration.md) for token-based authentication alternatives - [Frontend frameworks](../frontends/frameworks.md) for framework-specific auth setup patterns - [Internet Identity specification](../../references/internet-identity-spec.md) for protocol details and the full alternative origins spec