jose/docs/interfaces/_jwt_decrypt_.jwtdecryptoptions.md
2020-11-22 17:11:24 +01:00

3.2 KiB

Interface: JWTDecryptOptions

Combination of JWE Decryption options and JWT Claims Set verification options.

Index

Properties

Properties

audience

Optional audience: string | string[]

Defined in src/types.d.ts:355

Expected JWT "aud" (Audience) Claim value(s).


clockTolerance

Optional clockTolerance: string | number

Defined in src/types.d.ts:362

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:328

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


currentDate

Optional currentDate: Date

Defined in src/types.d.ts:387

Date to use when comparing NumericDate claims, defaults to new Date().


inflateRaw

Optional inflateRaw: InflateFunction

Defined in src/types.d.ts:334

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:367

Expected JWT "iss" (Issuer) Claim value(s).


keyManagementAlgorithms

Optional keyManagementAlgorithms: string[]

Defined in src/types.d.ts:323

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


maxTokenAge

Optional maxTokenAge: string

Defined in src/types.d.ts:372

Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value.


subject

Optional subject: string

Defined in src/types.d.ts:377

Expected JWT "sub" (Subject) Claim value.


typ

Optional typ: string

Defined in src/types.d.ts:382

Expected JWT "typ" (Type) Header Parameter value.