jose/docs/functions/_jwt_decrypt_.jwtdecrypt.md

Function: jwtDecrypt

▸ jwtDecrypt(jwt: string | Uint8Array, key: KeyLike | JWTDecryptGetKey, options?: JWTDecryptOptions): Promise<JWTDecryptResult>

Defined in src/jwt/decrypt.ts:65

Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT Claims Set.

example

// ESM import
import jwtDecrypt from 'jose/jwt/decrypt'

example

// CJS import
const { default: jwtDecrypt } = require('jose/jwt/decrypt')

example

// usage
const jwt = 'eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..KVcNLqK-3-8ZkYIC.xSwF4VxO0kUMUD2W-cifsNUxnr-swyBq-nADBptyt6y9n79-iNc5b0AALJpRwc0wwDkJw8hNOMjApNUTMsK9b-asToZ3DXFMvwfJ6n1aWefvd7RsoZ2LInWFfVAuttJDzoGB.uuexQoWHwrLMEYRElT8pBQ'
const secretKey = Uint8Array.from([
  206, 203, 53, 165, 235, 214, 153, 188,
  248, 225,  1, 132, 105, 204,  75,  42,
  186, 185, 24, 223, 136,  66, 116,  59,
  183, 155, 52,  52, 101, 167, 201,  85
])

const { payload, protectedHeader } = await jwtDecrypt(jwt, secretKey, {
  issuer: 'urn:example:issuer',
  audience: 'urn:example:audience'
})

console.log(protectedHeader)
console.log(payload)

Parameters:

Name	Type	Description
jwt	string | Uint8Array	JSON Web Token value (encoded as JWE).
key	KeyLike | JWTDecryptGetKey	Private Key or Secret, or a function resolving one, to decrypt and verify the JWT with.
options?	JWTDecryptOptions	JWT Decryption and JWT Claims Set validation options.

Returns: Promise<JWTDecryptResult>