Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.3 KB

jwe_general_decrypt.generaldecrypt.md

File metadata and controls

56 lines (44 loc) · 2.3 KB

Function: generalDecrypt

jwe/general/decrypt.generalDecrypt

▸ generalDecrypt(jwe: GeneralJWE, key: KeyLike | GeneralDecryptGetKey, options?: DecryptOptions): Promise<GeneralDecryptResult>

Decrypts a General JWE.

example ESM import

import { generalDecrypt } from 'jose/jwe/general/decrypt'

example CJS import

const { generalDecrypt } = require('jose/jwe/general/decrypt')

example Usage

const decoder = new TextDecoder()
const jwe = {
  ciphertext: '9EzjFISUyoG-ifC2mSihfP0DPC80yeyrxhTzKt1C_VJBkxeBG0MI4Te61Pk45RAGubUvBpU9jm4',
  iv: '8Fy7A_IuoX5VXG9s',
  tag: 'W76IYV6arGRuDSaSyWrQNg',
  aad: 'VGhlIEZlbGxvd3NoaXAgb2YgdGhlIFJpbmc',
  protected: 'eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0',
  recipients: [
    {
      encrypted_key: 'Z6eD4UK_yFb5ZoKvKkGAdqywEG_m0e4IYo0x8Vf30LAMJcsc-_zSgIeiF82teZyYi2YYduHKoqImk7MRnoPZOlEs0Q5BNK1OgBmSOhCE8DFyqh9Zh48TCTP6lmBQ52naqoUJFMtHzu-0LwZH26hxos0GP3Dt19O379MJB837TdKKa87skq0zHaVLAquRHOBF77GI54Bc7O49d8aOrSu1VEFGMThlW2caspPRiTSePDMDPq7_WGk50izRhB3Asl9wmP9wEeaTrkJKRnQj5ips1SAZ1hDBsqEQKKukxP1HtdcopHV5_qgwU8Hjm5EwSLMluMQuiE6hwlkXGOujZLVizA'
    }
  ]
}

const {
  plaintext,
  protectedHeader,
  additionalAuthenticatedData
} = await generalDecrypt(jwe, privateKey)

console.log(protectedHeader)
console.log(decoder.decode(plaintext))
console.log(decoder.decode(additionalAuthenticatedData))

Parameters:

Name Type Description
jwe GeneralJWE General JWE.
key KeyLike | GeneralDecryptGetKey Private Key or Secret, or a function resolving one, to decrypt the JWE with.
options? DecryptOptions JWE Decryption options.

Returns: Promise<GeneralDecryptResult>

Defined in: jwe/general/decrypt.ts:64