Skip to main content

Interface: SigningKeySet

Defined in: auth-core/src/signingKeySet.ts:26

The key set returned by createSigningKeySet.

Properties​

jwks​

jwks: () => JsonWebKeySet

Defined in: auth-core/src/signingKeySet.ts:34

The JWKS document to serve at jwks_uri: the signing key plus every retired key still inside its grace window. Computed per call, so a key drops out once its window closes without a restart.

Returns​

JsonWebKeySet


sign​

sign: (args) => string

Defined in: auth-core/src/signingKeySet.ts:36

Signs a JWT with the current signing key (kid in the header).

Parameters​

ParameterType
args{ expiresInSeconds?: number; payload: JwtPayload; typ?: string; }
args.expiresInSeconds?number
args.payloadJwtPayload
args.typ?string

Returns​

string


signingKey​

signingKey: SigningKey

Defined in: auth-core/src/signingKeySet.ts:28

The key that signs new tokens.


verify​

verify: (token) => JwtPayload | null

Defined in: auth-core/src/signingKeySet.ts:45

Verifies a JWT against the published keys — a token signed by a retired key passes until that key leaves the JWKS. Returns null when invalid.

Parameters​

ParameterType
tokenstring

Returns​

JwtPayload | null