4.4 KiB
Interface: JWTDecryptOptions
Combination of JWE Decryption options and JWT Claims Set verification options.
Index
Properties
- audience
- clockTolerance
- contentEncryptionAlgorithms
- crit
- currentDate
- inflateRaw
- issuer
- keyManagementAlgorithms
- maxTokenAge
- subject
- typ
Properties
audience
• Optional audience: string | string[]
Defined in src/types.d.ts:422
Expected JWT "aud" (Audience) Claim value(s).
clockTolerance
• Optional clockTolerance: string | number
Defined in src/types.d.ts:429
Expected clock tolerance
- in seconds when number (e.g. 5)
- parsed as seconds when a string (e.g. "5 seconds").
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.
currentDate
• Optional currentDate: Date
Defined in src/types.d.ts:454
Date to use when comparing NumericDate claims, defaults to new Date().
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.
issuer
• Optional issuer: string | string[]
Defined in src/types.d.ts:434
Expected JWT "iss" (Issuer) Claim value(s).
keyManagementAlgorithms
• Optional keyManagementAlgorithms: string[]
Defined in src/types.d.ts:390
A list of accepted JWE "alg" (Algorithm) Header Parameter values.
maxTokenAge
• Optional maxTokenAge: string
Defined in src/types.d.ts:439
Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value.
subject
• Optional subject: string
Defined in src/types.d.ts:444
Expected JWT "sub" (Subject) Claim value.
typ
• Optional typ: string
Defined in src/types.d.ts:449
Expected JWT "typ" (Type) Header Parameter value.