Back to Jose

jwks/remote

docs/jwks/remote/README.md

6.2.121.6 KB
Original Source

jwks/remote

Verification using a JSON Web Key Set (JWKS) available on an HTTP(S) URL

Interfaces

InterfaceDescription
ExportedJWKSCacheShape of an externally persisted remote JWKS cache.
RemoteJWKSetA key resolver created by createRemoteJWKSet.
RemoteJWKSetOptionsRemote JWKS resolver options.

Type Aliases

Type AliasDescription
FetchImplementationCustom fetch function. Must return HTTP 200 with a JSON JWKS. See customFetch.
JWKSCacheInputValues accepted by the jwksCache option.

Variables

VariableDescription
customFetchConfigures a custom fetch implementation for remote JWKS retrieval.
jwksCacheSymbol used to configure an externally persisted remote JWKS cache.

Functions

FunctionDescription
createRemoteJWKSetCreates a resolver for a JSON Web Key Set available at an HTTP(S) URL. Fetches the JSON Web Key Set when the cache is missing or stale. An unmatched key triggers another fetch only when cooldownDuration has elapsed since the last successful fetch. Selection uses the header's "alg" and "kid" and respects the JWK's "use" and "key_ops". Exactly one key must match.