Back to Jose

Interface: JWTDecryptGetKey()

docs/jwt/decrypt/interfaces/JWTDecryptGetKey.md

6.2.122.2 KB
Original Source

Interface: JWTDecryptGetKey()<KeyType>

šŸ’— 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.

Resolves a JWT decryption key. No token components have been authenticated when this function is called.

Type Parameters

Type ParameterDefault typeDescription
KeyType extends CryptoKey | Uint8ArrayCryptoKey | Uint8ArrayType definition of the keys the function resolves. Narrowing it is what lets ResolvedKey.key be inferred at the call site.

ā–ø JWTDecryptGetKey(protectedHeader, token): JWK | KeyObject | KeyType | Promise<JWK | KeyObject | KeyType>

Resolves a key for an unverified token. Throw if no suitable key can be resolved.

Parameters

ParameterTypeDescription
protectedHeaderCompactJWEHeaderParametersJWE or JWS Protected Header.
tokenFlattenedJWEThe consumed JWE or JWS token; none of its components have been verified.

Returns

JWK | KeyObject | KeyType | Promise<JWK | KeyObject | KeyType>