Skip to content

Latest commit

 

History

History
165 lines (95 loc) · 5.31 KB

JWTDecryptOptions.md

File metadata and controls

165 lines (95 loc) · 5.31 KB

Interface: JWTDecryptOptions

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

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

Properties

audience?

• optional audience: string | string[]

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

This option makes the JWT "aud" (Audience) Claim presence required.

clockTolerance?

• optional clockTolerance: string | number

Clock skew tolerance

  • In seconds when number (e.g. 5)
  • Resolved into a number of seconds when a string (e.g. "5 seconds", "10 minutes", "2 hours").

Used when validating the JWT "nbf" (Not Before) and "exp" (Expiration Time) claims, and when validating the "iat" (Issued At) claim if the maxTokenAge option is set.

contentEncryptionAlgorithms?

• optional contentEncryptionAlgorithms: string[]

A list of accepted JWE "enc" (Encryption Algorithm) Header Parameter values. By default all "enc" (Encryption Algorithm) values applicable for the used key/secret are allowed.

crit?

• optional crit: object

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

Index Signature

[propName: string]: boolean

currentDate?

• optional currentDate: Date

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

issuer?

• optional issuer: string | string[]

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

This option makes the JWT "iss" (Issuer) Claim presence required.

keyManagementAlgorithms?

• optional keyManagementAlgorithms: string[]

A list of accepted JWE "alg" (Algorithm) Header Parameter values. By default all "alg" (Algorithm) Header Parameter values applicable for the used key/secret are allowed except for all PBES2 Key Management Algorithms, these need to be explicitly allowed using this option.

maxDecompressedLength?

• optional maxDecompressedLength: number

Maximum allowed size (in bytes) of the decompressed plaintext when the JWE "zip" (Compression Algorithm) Header Parameter is present. By default this value is set to 250000 (250 KB). The value must be 0, a positive safe integer, or Infinity.

Set to 0 to reject all compressed JWEs during decryption.

Set to Infinity to disable the decompressed size limit.

maxPBES2Count?

• optional maxPBES2Count: number

(PBES2 Key Management Algorithms only) Maximum allowed "p2c" (PBES2 Count) Header Parameter value. The PBKDF2 iteration count defines the algorithm's computational expense. By default this value is set to 10000.

maxTokenAge?

• optional maxTokenAge: string | number

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

  • In seconds when number (e.g. 5)
  • Resolved into a number of seconds when a string (e.g. "5 seconds", "10 minutes", "2 hours").

This option makes the JWT "iat" (Issued At) Claim presence required.

requiredClaims?

• optional requiredClaims: string[]

Array of required Claim Names that must be present in the JWT Claims Set. Default is that: if the issuer option is set, then JWT "iss" (Issuer) Claim must be present; if the audience option is set, then JWT "aud" (Audience) Claim must be present; if the subject option is set, then JWT "sub" (Subject) Claim must be present; if the maxTokenAge option is set, then JWT "iat" (Issued At) Claim must be present.

subject?

• optional subject: string

Expected JWT "sub" (Subject) Claim value.

This option makes the JWT "sub" (Subject) Claim presence required.

typ?

• optional typ: string

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

This option makes the JWT "typ" (Type) Header Parameter presence required.