Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 3.63 KB

compactDecrypt.md

File metadata and controls

60 lines (38 loc) · 3.63 KB
Raw

Function: compactDecrypt()

💗 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.

compactDecrypt(jwe, key, options)

▸ compactDecrypt(jwe, key, options?): Promise<CompactDecryptResult>

Decrypts a Compact JWE.

This function is exported (as a named export) from the main 'jose' module entry point as well as from its subpath export 'jose/jwe/compact/decrypt'.

Parameters

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

Returns

Promise<CompactDecryptResult>

Example

const jwe =
  'eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0.nyQ19eq9ogh9wA7fFtnI2oouzy5_8b5DeLkoRMfi2yijgfTs2zEnayCEofz_qhnL-nwszabd9qUeHv0-IwvhhJJS7GUJOU3ikiIe42qcIAFme1A_Fo9CTxw4XTOy-I5qanl8So91u6hwfyN1VxAqVLsSE7_23EC-gfGEg_5znew9PyXXsOIE-K_HH7IQowRrlZ1X_bM_Liu53RzDpLDvRz59mp3S8L56YqpM8FexFGTGpEaoTcEIst375qncYt3-79IVR7gZN1RWsWgjPatfvVbnh74PglQcATSf3UUhaW0OAKn6q7r3PDx6DIKQ35bgHQg5QopuN00eIfLQL2trGw.W3grIVj5HVuAb76X.6PcuDe5D6ttWFYyv0oqqdDXfI2R8wBg1F2Q80UUA_Gv8eEimNWfxIWdLxrjzgQGSvIhxmFKuLM0.a93_Ug3uZHuczj70Zavx8Q'

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

console.log(protectedHeader)
console.log(new TextDecoder().decode(plaintext))

compactDecrypt(jwe, getKey, options)

▸ compactDecrypt<KeyLikeType>(jwe, getKey, options?): Promise<CompactDecryptResult & ResolvedKey<KeyLikeType>>

Type Parameters

Type Parameter Default type
KeyLikeType extends KeyLike KeyLike

Parameters

Parameter Type Description
jwe string | Uint8Array Compact JWE.
getKey CompactDecryptGetKey Function resolving Private Key or Secret to decrypt the JWE with. See Algorithm Key Requirements.
options? DecryptOptions JWE Decryption options.

Returns

Promise<CompactDecryptResult & ResolvedKey<KeyLikeType>>