Skip to main content
Module

x/jose/index.ts>jwtDecrypt

"JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS with no dependencies using runtime's native crypto in Node.js, Browser, Cloudflare Workers, Electron, and Deno.
panva/jose
Extremely Popular
Go to Latest
function jwtDecrypt
import { jwtDecrypt } from "https://deno.land/x/jose@v4.8.3/index.ts";

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

Examples

Usage

const jwt = 'eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..KVcNLqK-3-8ZkYIC.xSwF4VxO0kUMUD2W-cifsNUxnr-swyBq-nADBptyt6y9n79-iNc5b0AALJpRwc0wwDkJw8hNOMjApNUTMsK9b-asToZ3DXFMvwfJ6n1aWefvd7RsoZ2LInWFfVAuttJDzoGB.uuexQoWHwrLMEYRElT8pBQ'

const { payload, protectedHeader } = await jose.jwtDecrypt(jwt, secretKey, {
  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.