Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.34 KB

_types_d_.decryptoptions.md

File metadata and controls

70 lines (43 loc) · 2.34 KB

Interface: DecryptOptions

JWE Decryption options.

Index

Properties

Properties

contentEncryptionAlgorithms

Optional contentEncryptionAlgorithms: string[]

Defined in src/types.d.ts:395

A list of accepted JWE "enc" (Encryption Algorithm) Header Parameter values.


crit

Optional crit: { [propName:string]: boolean; }

Defined in src/types.d.ts:378

An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either true or false. true when the Header Parameter MUST be integrity protected, false when it's irrelevant.

This makes the "Extension Header Parameter "${parameter}" is not recognized" error go away.

Use this when a given JWS/JWT/JWE profile requires the use of proprietary non-registered "crit" (Critical) Header Parameters. This will only make sure the Header Parameter is syntactically correct when provided and that it is optionally integrity protected. It will not process the Header Parameter in any way or reject if the operation if it is missing. You MUST still verify the Header Parameter was present and process it according to the profile's validation steps after the operation succeeds.

The JWS extension Header Parameter b64 is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available.


inflateRaw

Optional inflateRaw: InflateFunction

Defined in src/types.d.ts:401

In a browser runtime you have to provide an implementation for Inflate Raw when you expect JWEs with compressed plaintext.


keyManagementAlgorithms

Optional keyManagementAlgorithms: string[]

Defined in src/types.d.ts:390

A list of accepted JWE "alg" (Algorithm) Header Parameter values.