authhero 9.14.0 → 9.16.0

package/dist/types/authentication-flows/custom-token-exchange.d.ts

@@ -0,0 +1,21 @@
+import { Context } from "hono";
+import { z } from "@hono/zod-openapi";
+import { Bindings, Variables, GrantFlowUserResult } from "../types";
+import { EnrichedClient } from "../helpers/client";
+export declare const customTokenExchangeParamsSchema: z.ZodObject<{
+    grant_type: z.ZodLiteral<"urn:ietf:params:oauth:grant-type:token-exchange">;
+    client_id: z.ZodString;
+    client_secret: z.ZodOptional<z.ZodString>;
+    subject_token: z.ZodString;
+    subject_token_type: z.ZodString;
+    audience: z.ZodOptional<z.ZodString>;
+    scope: z.ZodOptional<z.ZodString>;
+    organization: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type CustomTokenExchangeParams = z.infer<typeof customTokenExchangeParamsSchema>;
+type Ctx = Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>;
+export declare function customTokenExchangeGrant(ctx: Ctx, params: CustomTokenExchangeParams, client: EnrichedClient): Promise<GrantFlowUserResult>;
+export {};

package/dist/types/authentication-flows/passwordless.d.ts

@@ -501,6 +501,9 @@ export declare function passwordlessGrantUser(ctx: Context<{
         owner_user_id?: string | undefined;
         registration_type?: "manual" | "open_dcr" | "iat_dcr" | undefined;
         registration_metadata?: Record<string, any> | undefined;
+        token_exchange?: {
+            allow_any_profile_of_type?: "custom_authentication"[] | undefined;
+        } | undefined;
         user_linking_mode?: "builtin" | "off" | undefined;
     };
     loginSession: {

package/dist/types/authentication-flows/token-exchange.d.ts

@@ -2,6 +2,7 @@ import { Context } from "hono";
 import { z } from "@hono/zod-openapi";
 import { Bindings, Variables, GrantFlowUserResult } from "../types";
 import { EnrichedClient } from "../helpers/client";
+export declare const SUBJECT_TOKEN_TYPE_ACCESS_TOKEN = "urn:ietf:params:oauth:token-type:access_token";
 export declare const TOKEN_EXCHANGE_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:token-exchange";
 export declare const tokenExchangeParamsSchema: z.ZodObject<{
     grant_type: z.ZodLiteral<"urn:ietf:params:oauth:grant-type:token-exchange">;
@@ -18,3 +19,21 @@ export declare function tokenExchangeGrant(ctx: Context<{
     Bindings: Bindings;
     Variables: Variables;
 }>, params: TokenExchangeParams, preloadedClient?: EnrichedClient): Promise<GrantFlowUserResult>;
+/**
+ * Resolve the organization a token-exchange request asks for and check the
+ * user may act in it: a member, or a holder of the global
+ * `admin:organizations` permission when the tenant opts into inheriting it.
+ * Shared by the org-switch exchange and Custom Token Exchange.
+ */
+export declare function authorizeOrganizationAccess(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, params: {
+    tenantId: string;
+    userId: string;
+    organizationId: string;
+    failLog: (description: string) => void;
+}): Promise<{
+    id: string;
+    name: string;
+}>;

package/dist/types/generated/locale-types.d.ts

@@ -64,6 +64,7 @@ export interface EmailOtpChallengeScreen {
     sessionExpired: () => string;
     title: () => string;
     unexpectedError: () => string;
+    usePasswordText: () => string;
 }
 export interface EmailVerificationScreen {
     description: (vars: {
@@ -98,6 +99,7 @@ export interface LoginScreen {
     editEmailText: () => string;
     emailPlaceholder: () => string;
     enterACodeBtn: () => string;
+    enterACodeShortBtn: () => string;
     federatedConnectionButtonText: (vars: {
         connectionName: string;
     }) => string;
@@ -269,6 +271,7 @@ export interface LoginPasswordScreen {
     unverifiedEmail: () => string;
     "user-blocked": () => string;
     "wrong-credentials": () => string;
+    sendCodeText: () => string;
 }
 export interface LoginPasswordlessScreen {
     authMethodEmail: () => string;

package/dist/types/helpers/client-assertion-replay.d.ts

@@ -1,5 +1,22 @@
 import { Context } from "hono";
+import { CodeType } from "@authhero/adapter-interfaces";
 import { Bindings, Variables } from "../types";
+/**
+ * Record a presented token's `jti` as spent.
+ *
+ * @returns false when the same `(namespace, jti)` was already spent, true
+ *   otherwise.
+ */
+export declare function consumeSingleUseJti(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, tenantId: string, params: {
+    codeType: Extract<CodeType, "client_assertion_jti" | "subject_token_jti">;
+    namespace: string;
+    jti: string;
+    /** The token's `exp`, in seconds — when the marker becomes collectable. */
+    exp: number;
+}): Promise<boolean>;
 export interface ConsumeClientAssertionJtiParams {
     clientId: string;
     /** The assertion's `jti`. When absent there is nothing to spend. */

package/dist/types/helpers/client-keys.d.ts

@@ -25,3 +25,12 @@ export interface ClientWithKeys {
  * asymmetric algs do).
  */
 export declare function loadClientJwks(client: ClientWithKeys, opts?: LoadClientKeysOptions): Promise<Jwk[]>;
+/**
+ * Resolve verification keys published inline (`jwks`) or by reference
+ * (`jwks_uri`). Inline takes precedence. The remote fetch goes through the
+ * SSRF guard. Returns an empty array when neither is set.
+ */
+export declare function loadJwks(source: {
+    jwks?: unknown;
+    jwks_uri?: unknown;
+}, opts?: LoadClientKeysOptions): Promise<Jwk[]>;

package/dist/types/helpers/client.d.ts

@@ -134,6 +134,9 @@ export declare const enrichedClientSchema: z.ZodObject<{
         iat_dcr: "iat_dcr";
     }>>;
     registration_metadata: z.ZodOptional<z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    token_exchange: z.ZodOptional<z.ZodObject<{
+        allow_any_profile_of_type: z.ZodOptional<z.ZodArray<z.ZodLiteral<"custom_authentication">>>;
+    }, z.core.$strip>>;
     user_linking_mode: z.ZodOptional<z.ZodEnum<{
         builtin: "builtin";
         off: "off";

package/dist/types/helpers/dcr/metadata-mapping.d.ts

@@ -23,11 +23,11 @@ export declare const dcrRequestSchema: z.ZodObject<{
     grant_types: z.ZodOptional<z.ZodArray<z.ZodString>>;
     response_types: z.ZodOptional<z.ZodArray<z.ZodString>>;
     token_endpoint_auth_method: z.ZodOptional<z.ZodEnum<{
-        none: "none";
-        private_key_jwt: "private_key_jwt";
         client_secret_post: "client_secret_post";
         client_secret_basic: "client_secret_basic";
+        none: "none";
         client_secret_jwt: "client_secret_jwt";
+        private_key_jwt: "private_key_jwt";
     }>>;
     jwks_uri: z.ZodOptional<z.ZodString>;
     jwks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;

package/dist/types/helpers/organization-branding.d.ts

@@ -0,0 +1,18 @@
+import { Branding, Organization, Theme } from "@authhero/adapter-interfaces";
+type OrganizationBranding = NonNullable<Organization["branding"]>;
+/**
+ * Layer an organization's branding over the tenant's branding and theme, the
+ * way Auth0 does when a login runs in the context of an organization.
+ *
+ * The login pages let the theme win over branding (`theme.widget.logo_url`
+ * before `branding.logo_url`, `theme.colors.primary_button` before
+ * `branding.colors.primary`, `theme.page_background` before
+ * `branding.colors.page_background`), and a theme always exists because of
+ * the DEFAULT_THEME fallback. So each org value is written into both, or it
+ * would never be visible.
+ */
+export declare function applyOrganizationBranding(branding: Branding | null, theme: Theme, orgBranding: OrganizationBranding | undefined): {
+    branding: Branding | null;
+    theme: Theme;
+};
+export {};

package/dist/types/helpers/reserved-claims.d.ts

@@ -14,9 +14,9 @@ export declare const USERINFO_RESERVED_CLAIMS: readonly ["iss", "sub", "aud", "e
  * vendor/tenant for downstream APIs while `sub` stays `auth-service`.
  * Client-bound mints keep `azp` locked (see below).
  */
-export declare const SERVICE_TOKEN_RESERVED_CLAIMS: ("iss" | "tenant_id" | "scope" | "client_id" | "org_name" | "org_id" | "sub" | "aud" | "exp" | "nbf" | "iat" | "jti" | "auth_time" | "acr" | "amr" | "act" | "sid" | "permissions" | "requested_userinfo_claims" | "gty")[];
+export declare const SERVICE_TOKEN_RESERVED_CLAIMS: ("tenant_id" | "client_id" | "scope" | "sid" | "sub" | "org_name" | "aud" | "auth_time" | "exp" | "iat" | "iss" | "permissions" | "org_id" | "acr" | "amr" | "nbf" | "jti" | "act" | "requested_userinfo_claims" | "gty")[];
 /** Client-bound mints: `azp` must stay the registered client id. */
-export declare const CLIENT_SERVICE_TOKEN_RESERVED_CLAIMS: ("iss" | "tenant_id" | "scope" | "client_id" | "org_name" | "org_id" | "sub" | "aud" | "exp" | "nbf" | "iat" | "jti" | "azp" | "auth_time" | "acr" | "amr" | "act" | "sid" | "permissions" | "requested_userinfo_claims" | "gty")[];
+export declare const CLIENT_SERVICE_TOKEN_RESERVED_CLAIMS: ("tenant_id" | "client_id" | "scope" | "sid" | "sub" | "org_name" | "aud" | "auth_time" | "exp" | "iat" | "iss" | "permissions" | "org_id" | "acr" | "amr" | "azp" | "nbf" | "jti" | "act" | "requested_userinfo_claims" | "gty")[];
 export type AccessTokenReservedClaim = (typeof ACCESS_TOKEN_RESERVED_CLAIMS)[number];
 export type IdTokenReservedClaim = (typeof ID_TOKEN_RESERVED_CLAIMS)[number];
 /**

package/dist/types/helpers/signing-certificate-authority.d.ts

@@ -0,0 +1,99 @@
+import * as x509 from "@peculiar/x509";
+/**
+ * A request to certify a signing key. Everything is plain data so an issuer
+ * can forward it over HTTP: the CA key never has to live in the auth worker.
+ */
+export interface SigningCertificateRequest {
+    /** The key to certify, as an SPKI `PUBLIC KEY` PEM. */
+    publicKey: string;
+    /** Subject distinguished name, e.g. `CN=acme`. */
+    subject: string;
+    /** URI placed in the SubjectAlternativeName, e.g. `urn:authhero:tenant:acme`. */
+    uri: string;
+    notBefore: Date;
+    notAfter: Date;
+}
+/**
+ * Issues signing-key certificates from an intermediate CA.
+ *
+ * `issueCertificate` returns the leaf only. `getIssuerCertificates` returns
+ * every intermediate that may have signed a leaf that is still published —
+ * the current one plus any that were rotated out recently — so the JWKS can
+ * attach the right chain to each key.
+ */
+export interface CertificateIssuer {
+    issueCertificate(request: SigningCertificateRequest): Promise<string>;
+    getIssuerCertificates(): Promise<string[]>;
+}
+export interface SigningCertificateAuthority {
+    issuer: CertificateIssuer;
+    /**
+     * Lifetime of issued certificates, in days. Renewal keeps the key and the
+     * `kid`, so short lifetimes are cheap.
+     *
+     * @default 30
+     */
+    validityDays?: number;
+    /**
+     * The SAN URI that binds a key to its owner. Receives the key's `tenant_id`,
+     * which is undefined for control-plane keys.
+     *
+     * Override this where the storage scope doesn't match ownership — a WFP
+     * tenant worker stores its own keys without a `tenant_id`.
+     *
+     * @default tenant keys → `urn:authhero:tenant:<tenant_id>`, control-plane
+     * keys → `urn:authhero:control-plane`
+     */
+    subjectUri?: (scope: {
+        tenant_id?: string;
+    }) => string;
+}
+export declare const DEFAULT_CA_CERT_VALIDITY_DAYS = 30;
+export declare const TENANT_URI_PREFIX = "urn:authhero:tenant:";
+export declare const CONTROL_PLANE_URI = "urn:authhero:control-plane";
+/** Parameters `createX509Certificate` / `renewX509Certificate` need to issue from the CA. */
+export interface CertificateAuthorityIssuance {
+    issuer: CertificateIssuer;
+    uri: string;
+}
+/**
+ * Resolve how a key should be certified. Only `jwt_signing` keys are
+ * CA-issued: SAML service providers pin certificates for years and gain
+ * nothing from a chain.
+ */
+export declare function certificateAuthorityIssuance(ca: SigningCertificateAuthority | undefined, key: {
+    type: string;
+    tenant_id?: string;
+}): CertificateAuthorityIssuance | undefined;
+export interface LocalCertificateIssuerOptions {
+    /** The issuing (intermediate) CA certificate, PEM. */
+    certificate: string;
+    /** The issuing CA's PKCS#8 private key, PEM. */
+    privateKey: string;
+    /**
+     * Intermediates that were rotated out but may still have signed a
+     * published leaf. They are only used to build `x5c`, never to sign.
+     */
+    previousCertificates?: string[];
+}
+/**
+ * An in-process issuer holding the intermediate's private key. Keep the root
+ * offline; this only ever needs the intermediate.
+ */
+export declare function createLocalCertificateIssuer(options: LocalCertificateIssuerOptions): CertificateIssuer;
+/** True when the certificate was issued by someone other than itself. */
+export declare function isCaIssued(cert: x509.X509Certificate): boolean;
+/**
+ * The published chain for a CA-issued certificate: `x5c` (leaf first, then
+ * its issuer, standard base64 DER per RFC 7517 §4.7) and `x5t#S256`.
+ *
+ * The issuer is matched by name *and* by verifying the leaf's signature, so a
+ * CA that computes key identifiers differently can't produce a wrong chain.
+ * Returns undefined for self-signed certificates and when no known
+ * intermediate signed the leaf — publishing no chain beats publishing a
+ * wrong one.
+ */
+export declare function certificateChainMembers(cert: x509.X509Certificate, issuerCertificates: x509.X509Certificate[]): Promise<{
+    x5c: string[];
+    "x5t#S256": string;
+} | undefined>;

package/dist/types/helpers/signing-keys.d.ts

@@ -1,5 +1,6 @@
 import { SigningKey, KeysAdapter } from "@authhero/adapter-interfaces";
 import { SigningKeyMode, SigningKeyModeOption } from "../types/AuthHeroConfig";
+import { SigningCertificateAuthority } from "./signing-certificate-authority";
 export declare function listControlPlaneKeys(keys: KeysAdapter, type?: string): Promise<SigningKey[]>;
 export declare function resolveSigningKeyMode(option: SigningKeyModeOption | undefined, tenantId: string): Promise<SigningKeyMode>;
 export interface ResolveSigningKeysOptions {
@@ -42,6 +43,12 @@ export interface EnsureSigningKeyOptions {
     name?: string;
     /** Defaults to `"jwt_signing"`. */
     type?: SigningKey["type"];
+    /**
+     * Issue the new key's certificate from this CA (`jwt_signing` only). The
+     * SAN is resolved from `tenantId`, so a WFP tenant worker that stores its
+     * keys without one should set `subjectUri` on the CA config.
+     */
+    certificateAuthority?: SigningCertificateAuthority;
 }
 export interface EnsureSigningKeyResult {
     /** True when a new key was minted; false when a signable key already existed. */