Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 3.46 KB

jwe_flattened_decrypt.flattenedDecrypt.md

File metadata and controls

65 lines (45 loc) · 3.46 KB
Raw

Function: flattenedDecrypt

💗 Help the project

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.

▸ flattenedDecrypt(jwe, key, options?): Promise<FlattenedDecryptResult>

Decrypts a Flattened JWE.

Parameters

Name Type Description
jwe FlattenedJWE Flattened JWE.
key Uint8Array | KeyLike Private Key or Secret to decrypt the JWE with. See Algorithm Key Requirements.
options? DecryptOptions JWE Decryption options.

Returns

Promise<FlattenedDecryptResult>

Example

const jwe = {
  ciphertext: '9EzjFISUyoG-ifC2mSihfP0DPC80yeyrxhTzKt1C_VJBkxeBG0MI4Te61Pk45RAGubUvBpU9jm4',
  iv: '8Fy7A_IuoX5VXG9s',
  tag: 'W76IYV6arGRuDSaSyWrQNg',
  encrypted_key:
    'Z6eD4UK_yFb5ZoKvKkGAdqywEG_m0e4IYo0x8Vf30LAMJcsc-_zSgIeiF82teZyYi2YYduHKoqImk7MRnoPZOlEs0Q5BNK1OgBmSOhCE8DFyqh9Zh48TCTP6lmBQ52naqoUJFMtHzu-0LwZH26hxos0GP3Dt19O379MJB837TdKKa87skq0zHaVLAquRHOBF77GI54Bc7O49d8aOrSu1VEFGMThlW2caspPRiTSePDMDPq7_WGk50izRhB3Asl9wmP9wEeaTrkJKRnQj5ips1SAZ1hDBsqEQKKukxP1HtdcopHV5_qgwU8Hjm5EwSLMluMQuiE6hwlkXGOujZLVizA',
  aad: 'VGhlIEZlbGxvd3NoaXAgb2YgdGhlIFJpbmc',
  protected: 'eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0',
}

const { plaintext, protectedHeader, additionalAuthenticatedData } =
  await jose.flattenedDecrypt(jwe, privateKey)

console.log(protectedHeader)
const decoder = new TextDecoder()
console.log(decoder.decode(plaintext))
console.log(decoder.decode(additionalAuthenticatedData))

▸ flattenedDecrypt<KeyLikeType>(jwe, getKey, options?): Promise<FlattenedDecryptResult & ResolvedKey<KeyLikeType>>

Type parameters

Name Type
KeyLikeType extends KeyLike = KeyLike

Parameters

Name Type Description
jwe FlattenedJWE Flattened JWE.
getKey FlattenedDecryptGetKey Function resolving Private Key or Secret to decrypt the JWE with. See Algorithm Key Requirements.
options? DecryptOptions JWE Decryption options.

Returns

Promise<FlattenedDecryptResult & ResolvedKey<KeyLikeType>>