@hyper.authio/server 0.7.0 → 0.8.0

package/dist/index.d.ts

@@ -359,8 +359,14 @@ interface AuthioVerifierOptions extends AuthioConnectionOptions, AuthioUserClaim
     introspectionCacheDuration?: number;
     /** Seconds of clock skew tolerated on `exp` and `nbf`. Defaults to 30. */
     clockSkew?: number;
-    /** Accepted signing algorithms. Defaults to the asymmetric ones (RS*, PS*, ES*). */
-    validAlgorithms?: readonly string[];
+    /**
+     * The algorithm (or algorithms) access tokens are signed with, as the client registered in Authio signs them:
+     * RS/PS/ES 256/384/512, or HS256/384/512 verified with the `clientSecret` of `client` (its UTF-8 octets, at least
+     * 32, 48 or 64 bytes as RFC 7518 §3.2 asks). Only the client's own API holds that secret, so only it validates an HS*
+     * token locally; any other API validates such tokens with introspection. Left out, the asymmetric algorithms of the
+     * realm's keys are accepted, and never HS*.
+     */
+    accessTokenSignedResponseAlg?: string | readonly string[];
     /** Refuses a token whose `typ` claim is present and not `Bearer` (an ID token, for one). Defaults to `true`. */
     rejectNonAccessTokens?: boolean;
     /**
@@ -370,6 +376,13 @@ interface AuthioVerifierOptions extends AuthioConnectionOptions, AuthioUserClaim
     clientEncryptionKey?: AuthioEncryptionKeySource;
     /** A PEM or JWK file holding `clientEncryptionKey` (Node only). */
     clientEncryptionKeyPath?: string;
+    /**
+     * The key management algorithms (`alg`) decrypted. Defaults to RSA-OAEP and RSA-OAEP-256; RSA1_5 cannot be listed,
+     * because Node cannot decrypt it.
+     */
+    encryptionAlgorithms?: readonly string[];
+    /** The content encryption algorithms (`enc`) decrypted. Defaults to A128CBC-HS256, A192CBC-HS384, A256CBC-HS512. */
+    encryptionMethods?: readonly string[];
     /** Accepted for parity with the other Authio SDKs; RSA1_5 stays refused, because Node cannot decrypt it. */
     allowLegacyEncryptionAlgorithms?: boolean;
 }
@@ -416,6 +429,7 @@ declare const AuthioBearerErrorDescriptions: {
     readonly Empty: "The token is empty.";
     readonly Encrypted: "The token is encrypted; set clientEncryptionKey to decrypt it, or validate it with introspection ('introspectionOnly').";
     readonly SigningKeysUnavailable: "Authio could not be reached to read its signing keys.";
+    readonly Symmetric: "The token is signed with the client's secret (HS*): set accessTokenSignedResponseAlg and the client's clientSecret to validate it locally, or validate it with introspection ('introspectionOnly').";
 };
 /**
  * Creates a token verifier.

package/dist/index.js

@@ -1,4 +1,5 @@
-import { systemClock, AuthioClaimTypes, parseResourceAccess, AuthioError, AuthioDefaults, resolveIssuer, AuthioConfigurationError, resolveConnection, createAuthioDiscoveryClient, seconds, createAuthioSigningKeys, encryptionKeyFromFile, createAuthioTokenDecrypter, createAuthioClient, toScopeString, AuthioWebhookHeaders, verifyWebhookSignature, tryParseWebhookEvent, toClientCredentialsToken, isAuthioTokenEncrypted, AuthioTokenValidationError, verifyAuthioJwt, AuthioTokenTypes } from '@hyper.authio/client';
+import { systemClock, AuthioClaimTypes, parseResourceAccess, AuthioError, AuthioDefaults, resolveIssuer, AuthioConfigurationError, resolveConnection, createAuthioDiscoveryClient, seconds, AuthioHmacAlgorithms, createAuthioSigningKeys, encryptionKeyFromFile, createAuthioTokenDecrypter, AuthioAsymmetricAlgorithms, requireHmacSecretLength, createAuthioClient, toScopeString, AuthioWebhookHeaders, verifyWebhookSignature, tryParseWebhookEvent, toClientCredentialsToken, isAuthioTokenEncrypted, AuthioTokenValidationError, withClientSecret, verifyAuthioJwt, AuthioTokenTypes } from '@hyper.authio/client';
+import { decodeProtectedHeader } from 'jose';
 
 // src/user.ts
 var accessTokenTypes = /* @__PURE__ */ new Set(["bearer", "api_key"]);
@@ -551,7 +552,8 @@ var AuthioBearerErrorDescriptions = {
   Unconfirmed: "Authio could not be reached to confirm that the token is active.",
   Empty: "The token is empty.",
   Encrypted: "The token is encrypted; set clientEncryptionKey to decrypt it, or validate it with introspection ('introspectionOnly').",
-  SigningKeysUnavailable: "Authio could not be reached to read its signing keys."
+  SigningKeysUnavailable: "Authio could not be reached to read its signing keys.",
+  Symmetric: "The token is signed with the client's secret (HS*): set accessTokenSignedResponseAlg and the client's clientSecret to validate it locally, or validate it with introspection ('introspectionOnly')."
 };
 var maxCachedAnswers = 1e4;
 function createAuthioVerifier(options) {
@@ -571,7 +573,9 @@ function createAuthioVerifier(options) {
   const resourceMetadataUrl = resolveResourceMetadata(options.resourceMetadata, resource);
   const cacheDurationMs = seconds(options.introspectionCacheDuration, 30, "introspectionCacheDuration");
   const clockSkew = seconds(options.clockSkew, 30, "clockSkew") / 1e3;
-  const algorithms = options.validAlgorithms && options.validAlgorithms.length > 0 ? [...options.validAlgorithms] : void 0;
+  const algorithms = resolveAccessTokenAlgorithms(options.accessTokenSignedResponseAlg);
+  const symmetric = algorithms?.filter((algorithm) => AuthioHmacAlgorithms.includes(algorithm)) ?? [];
+  const clientSecret = symmetric.length > 0 ? resolveClientSecret(options, symmetric) : void 0;
   const rejectNonAccessTokens = options.rejectNonAccessTokens ?? true;
   const claimSettings = { roleClaims: options.roleClaims, groupClaims: options.groupClaims };
   const cache = /* @__PURE__ */ new Map();
@@ -579,7 +583,9 @@ function createAuthioVerifier(options) {
   const encryptionKey = options.clientEncryptionKey ?? (options.clientEncryptionKeyPath ? encryptionKeyFromFile(options.clientEncryptionKeyPath) : void 0);
   const decrypt = encryptionKey === void 0 ? void 0 : createAuthioTokenDecrypter(encryptionKey, {
     setting: options.clientEncryptionKey === void 0 ? "clientEncryptionKeyPath" : "clientEncryptionKey",
-    allowLegacyEncryptionAlgorithms: options.allowLegacyEncryptionAlgorithms
+    allowLegacyEncryptionAlgorithms: options.allowLegacyEncryptionAlgorithms,
+    encryptionAlgorithms: options.encryptionAlgorithms,
+    encryptionMethods: options.encryptionMethods
   });
   const requiredScopes = Object.freeze([...new Set((options.requiredScopes ?? []).filter((scope) => scope?.trim()))]);
   const introspect = async (token, key, signal) => {
@@ -609,7 +615,7 @@ function createAuthioVerifier(options) {
     }
     let keySet;
     try {
-      keySet = await signingKeys(signal);
+      keySet = withClientSecret(await signingKeys(signal), clientSecret);
     } catch (error) {
       throw new AuthioBearerError(AuthioBearerErrorDescriptions.SigningKeysUnavailable, { cause: error, reason: "signing_keys_unavailable" });
     }
@@ -623,6 +629,8 @@ function createAuthioVerifier(options) {
         now: connection.clock.now()
       }));
     } catch (error) {
+      if (error instanceof AuthioTokenValidationError && error.reason === "invalid_algorithm" && symmetric.length === 0 && isSymmetricToken(signed))
+        throw new AuthioBearerError(AuthioBearerErrorDescriptions.Symmetric, { cause: error, reason: error.reason });
       if (error instanceof AuthioTokenValidationError) throw new AuthioBearerError(error.message, { cause: error, reason: error.reason });
       throw error;
     }
@@ -704,6 +712,35 @@ function resolveResourceMetadata(setting, resource) {
     throw new AuthioConfigurationError("resourceMetadata: true needs the API's resource identifier: set options.resource, or pass the metadata URL.");
   return protectedResourceMetadataUrl(resource);
 }
+function resolveAccessTokenAlgorithms(setting) {
+  const algorithms = [...new Set((typeof setting === "string" ? [setting] : [...setting ?? []]).map((algorithm) => algorithm.trim()).filter(Boolean))];
+  const known = [...AuthioAsymmetricAlgorithms, ...AuthioHmacAlgorithms];
+  for (const algorithm of algorithms)
+    if (!known.includes(algorithm))
+      throw new AuthioConfigurationError(`The Authio accessTokenSignedResponseAlg '${algorithm}' is not one of ${known.join(", ")}.`);
+  return algorithms.length > 0 ? algorithms : void 0;
+}
+function resolveClientSecret(options, symmetric) {
+  const given = options.client;
+  const source = given && !isClient(given) ? given.clientSecret : void 0;
+  if (!source)
+    throw new AuthioConfigurationError(
+      `accessTokenSignedResponseAlg ${symmetric.join(", ")} is verified with the client secret: pass options.client as { clientId, clientSecret } (an AuthioClient does not expose its secret).`
+    );
+  if (typeof source === "string") for (const algorithm of symmetric) requireHmacSecretLength(algorithm, new TextEncoder().encode(source).length);
+  return async () => {
+    const value = typeof source === "function" ? await source() : source;
+    if (typeof value !== "string" || !value) throw new AuthioConfigurationError("The Authio clientSecret function returned no secret.");
+    return value;
+  };
+}
+function isSymmetricToken(token) {
+  try {
+    return AuthioHmacAlgorithms.includes(String(decodeProtectedHeader(token).alg));
+  } catch {
+    return false;
+  }
+}
 function resolveClient(options) {
   const given = options.client;
   if (!given) return void 0;