Skip to main content
Module

x/jose/index.ts>jwtDecrypt

"JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes.
panva/jose
Extremely Popular
Go to Latest
function jwtDecrypt
import { jwtDecrypt } from "https://deno.land/x/jose@v4.11.1/index.ts";

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

Examples

Usage

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)

Parameters

jwt: string | Uint8Array

JSON Web Token value (encoded as JWE).

key: KeyLike | Uint8Array

Private Key or Secret to decrypt and verify the JWT with.

optional
options: JWTDecryptOptions

JWT Decryption and JWT Claims Set validation options.

Parameters

jwt: string | Uint8Array

JSON Web Token value (encoded as JWE).

getKey: JWTDecryptGetKey

Function resolving Private Key or Secret to decrypt and verify the JWT with.

optional
options: JWTDecryptOptions

JWT Decryption and JWT Claims Set validation options.