Back to Jose

Interface: GeneralDecryptGetKey()

docs/jwe/general/decrypt/interfaces/GeneralDecryptGetKey.md

6.2.122.2 KB
Original Source

Interface: GeneralDecryptGetKey()<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 key for General JWE decryption from unverified headers and token data.

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.

ā–ø GeneralDecryptGetKey(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
protectedHeaderJWEHeaderParameters | undefinedJWE 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>