docs/jwt/decrypt/functions/jwtDecrypt.md
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.
āø jwtDecrypt<PayloadType>(jwt, key, options?): Promise<JWTDecryptResult<PayloadType>>
Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT Claims Set.
This function is exported (as a named export) from the main 'jose' module entry point as well
as from its subpath export 'jose/jwt/decrypt'.
| Type Parameter | Default type |
|---|---|
PayloadType | JWTPayload |
| Parameter | Type | Description |
|---|---|---|
jwt | string | Uint8Array | JSON Web Token value (encoded as JWE). |
key | KeyInput | Private Key or Secret to decrypt and verify the JWT with. See Algorithm Key Requirements. |
options? | JWTDecryptOptions | JWT Decryption and JWT Claims Set validation options. |
Promise<JWTDecryptResult<PayloadType>>
const secret = jose.base64url.decode('zH4NRP1HMALxxCFnRZABFA7GOJtzU_gIj02alfL1lvI')
const jwt =
'eyJhbGciOiJkaXIiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0..MB66qstZBPxAXKdsjet_lA.WHbtJTl4taHp7otOHLq3hBvv0yNPsPEKHYInmCPdDDeyV1kU-f-tGEiU4FxlSqkqAT2hVs8_wMNiQFAzPU1PUgIqWCPsBrPP3TtxYsrtwagpn4SvCsUsx0Mhw9ZhliAO8CLmCBQkqr_T9AcYsz5uZw.7nX9m7BGUu_u1p1qFHzyIg'
const { payload, protectedHeader } = await jose.jwtDecrypt(jwt, secret, {
issuer: 'urn:example:issuer',
audience: 'urn:example:audience',
})
console.log(protectedHeader)
console.log(payload)
āø jwtDecrypt<PayloadType, KeyType>(jwt, getKey, options?): Promise<JWTDecryptResult<PayloadType> & ResolvedKey<KeyType>>
Decrypts a JWT and validates its JWT Claims Set, resolving the key dynamically. The result additionally carries the resolved key.
| Type Parameter | Default type |
|---|---|
PayloadType | JWTPayload |
KeyType extends Uint8Array | CryptoKey | Uint8Array | CryptoKey |
| Parameter | Type | Description |
|---|---|---|
jwt | string | Uint8Array | JSON Web Token value (encoded as JWE). |
getKey | JWTDecryptGetKey<KeyType> | Function resolving Private Key or Secret to decrypt and verify the JWT with. See Algorithm Key Requirements. |
options? | JWTDecryptOptions | JWT Decryption and JWT Claims Set validation options. |
Promise<JWTDecryptResult<PayloadType> & ResolvedKey<KeyType>>
āø jwtDecrypt<PayloadType>(jwt, key, options?): Promise<JWTDecryptResult<PayloadType> & Partial<ResolvedKey<Uint8Array | CryptoKey>>>
Accepts either form of the key argument. Use this overload when forwarding a value that may be
either a key or a key resolution function; key is present on the result only when a resolution
function was used.
| Type Parameter | Default type |
|---|---|
PayloadType | JWTPayload |
| Parameter | Type | Description |
|---|---|---|
jwt | string | Uint8Array | JSON Web Token value (encoded as JWE). |
key | KeyInput | JWTDecryptGetKey<Uint8Array | CryptoKey> | Private Key or Secret, or a function resolving one, to decrypt and verify the JWT with. See Algorithm Key Requirements. |
options? | JWTDecryptOptions | JWT Decryption and JWT Claims Set validation options. |
Promise<JWTDecryptResult<PayloadType> & Partial<ResolvedKey<Uint8Array | CryptoKey>>>