Back to Jose

Interface: GeneralVerifyGetKey()

docs/jws/general/verify/interfaces/GeneralVerifyGetKey.md

6.2.22.4 KB
Original Source

Interface: GeneralVerifyGetKey()

šŸ’— Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

Interface for General JWS Verification dynamic key resolution. No token components have been verified at the time of this function call.

See

createRemoteJWKSet to verify using a remote JSON Web Key Set.

ā–ø GeneralVerifyGetKey(protectedHeader, token): Uint8Array | CryptoKey | JWK | KeyObject | Promise<Uint8Array | CryptoKey | JWK | KeyObject>

Dynamic key resolution function. No token components have been verified at the time of this function call.

If a suitable key for the token cannot be matched, throw an error instead.

Parameters

ParameterTypeDescription
protectedHeaderJWSHeaderParametersJWE or JWS Protected Header.
tokenFlattenedJWSInputThe consumed JWE or JWS token.

Returns

Uint8Array | CryptoKey | JWK | KeyObject | Promise<Uint8Array | CryptoKey | JWK | KeyObject>