diff --git a/CHANGELOG.md b/CHANGELOG.md index 97e07a522a..8f8602ca59 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [3.7.1](https://github.com/panva/jose/compare/v3.7.0...v3.7.1) (2021-03-11) + + +### Bug Fixes + +* swallow invalid signature encoding errors ([e0adf49](https://github.com/panva/jose/commit/e0adf49e5789f9fc23afb1e2bd3e330e34b46b78)) + ## [3.7.0](https://github.com/panva/jose/compare/v3.6.2...v3.7.0) (2021-03-02) diff --git a/docs/classes/_jwe_compact_encrypt_.compactencrypt.md b/docs/classes/_jwe_compact_encrypt_.compactencrypt.md index 88cb609e76..11dcd73571 100644 --- a/docs/classes/_jwe_compact_encrypt_.compactencrypt.md +++ b/docs/classes/_jwe_compact_encrypt_.compactencrypt.md @@ -54,7 +54,7 @@ console.log(jwe) \+ **new CompactEncrypt**(`plaintext`: Uint8Array): [CompactEncrypt](_jwe_compact_encrypt_.compactencrypt.md) -*Defined in [src/jwe/compact/encrypt.ts:45](https://github.com/panva/jose/blob/v3.7.0/src/jwe/compact/encrypt.ts#L45)* +*Defined in [src/jwe/compact/encrypt.ts:45](https://github.com/panva/jose/blob/v3.7.1/src/jwe/compact/encrypt.ts#L45)* #### Parameters: @@ -70,7 +70,7 @@ Name | Type | Description | ▸ **encrypt**(`key`: [KeyLike](../types/_types_d_.keylike.md), `options?`: [EncryptOptions](../interfaces/_types_d_.encryptoptions.md)): Promise -*Defined in [src/jwe/compact/encrypt.ts:108](https://github.com/panva/jose/blob/v3.7.0/src/jwe/compact/encrypt.ts#L108)* +*Defined in [src/jwe/compact/encrypt.ts:108](https://github.com/panva/jose/blob/v3.7.1/src/jwe/compact/encrypt.ts#L108)* Encrypts and resolves the value of the Compact JWE string. @@ -89,7 +89,7 @@ ___ ▸ **setContentEncryptionKey**(`cek`: Uint8Array): this -*Defined in [src/jwe/compact/encrypt.ts:62](https://github.com/panva/jose/blob/v3.7.0/src/jwe/compact/encrypt.ts#L62)* +*Defined in [src/jwe/compact/encrypt.ts:62](https://github.com/panva/jose/blob/v3.7.1/src/jwe/compact/encrypt.ts#L62)* Sets a content encryption key to use, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter. @@ -110,7 +110,7 @@ ___ ▸ **setInitializationVector**(`iv`: Uint8Array): this -*Defined in [src/jwe/compact/encrypt.ts:75](https://github.com/panva/jose/blob/v3.7.0/src/jwe/compact/encrypt.ts#L75)* +*Defined in [src/jwe/compact/encrypt.ts:75](https://github.com/panva/jose/blob/v3.7.1/src/jwe/compact/encrypt.ts#L75)* Sets the JWE Initialization Vector to use for content encryption, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) @@ -131,7 +131,7 @@ ___ ▸ **setKeyManagementParameters**(`parameters`: [JWEKeyManagementHeaderParameters](../interfaces/_types_d_.jwekeymanagementheaderparameters.md)): this -*Defined in [src/jwe/compact/encrypt.ts:97](https://github.com/panva/jose/blob/v3.7.0/src/jwe/compact/encrypt.ts#L97)* +*Defined in [src/jwe/compact/encrypt.ts:97](https://github.com/panva/jose/blob/v3.7.1/src/jwe/compact/encrypt.ts#L97)* Sets the JWE Key Management parameters to be used when encrypting the Content Encryption Key. You do not need to invoke this method, it is only really @@ -151,7 +151,7 @@ ___ ▸ **setProtectedHeader**(`protectedHeader`: [JWEHeaderParameters](../interfaces/_types_d_.jweheaderparameters.md)): this -*Defined in [src/jwe/compact/encrypt.ts:85](https://github.com/panva/jose/blob/v3.7.0/src/jwe/compact/encrypt.ts#L85)* +*Defined in [src/jwe/compact/encrypt.ts:85](https://github.com/panva/jose/blob/v3.7.1/src/jwe/compact/encrypt.ts#L85)* Sets the JWE Protected Header on the CompactEncrypt object. diff --git a/docs/classes/_jwe_flattened_encrypt_.flattenedencrypt.md b/docs/classes/_jwe_flattened_encrypt_.flattenedencrypt.md index 311b259805..eb5f93b74f 100644 --- a/docs/classes/_jwe_flattened_encrypt_.flattenedencrypt.md +++ b/docs/classes/_jwe_flattened_encrypt_.flattenedencrypt.md @@ -58,7 +58,7 @@ console.log(jwe) \+ **new FlattenedEncrypt**(`plaintext`: Uint8Array): [FlattenedEncrypt](_jwe_flattened_encrypt_.flattenedencrypt.md) -*Defined in [src/jwe/flattened/encrypt.ts:75](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L75)* +*Defined in [src/jwe/flattened/encrypt.ts:75](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L75)* #### Parameters: @@ -74,7 +74,7 @@ Name | Type | Description | ▸ **encrypt**(`key`: [KeyLike](../types/_types_d_.keylike.md), `options?`: [EncryptOptions](../interfaces/_types_d_.encryptoptions.md)): Promise<[FlattenedJWE](../interfaces/_types_d_.flattenedjwe.md)\> -*Defined in [src/jwe/flattened/encrypt.ts:187](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L187)* +*Defined in [src/jwe/flattened/encrypt.ts:187](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L187)* Encrypts and resolves the value of the Flattened JWE object. @@ -93,7 +93,7 @@ ___ ▸ **setAdditionalAuthenticatedData**(`aad`: Uint8Array): this -*Defined in [src/jwe/flattened/encrypt.ts:144](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L144)* +*Defined in [src/jwe/flattened/encrypt.ts:144](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L144)* Sets the Additional Authenticated Data on the FlattenedEncrypt object. @@ -111,7 +111,7 @@ ___ ▸ **setContentEncryptionKey**(`cek`: Uint8Array): this -*Defined in [src/jwe/flattened/encrypt.ts:157](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L157)* +*Defined in [src/jwe/flattened/encrypt.ts:157](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L157)* Sets a content encryption key to use, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter. @@ -132,7 +132,7 @@ ___ ▸ **setInitializationVector**(`iv`: Uint8Array): this -*Defined in [src/jwe/flattened/encrypt.ts:173](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L173)* +*Defined in [src/jwe/flattened/encrypt.ts:173](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L173)* Sets the JWE Initialization Vector to use for content encryption, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) @@ -153,7 +153,7 @@ ___ ▸ **setKeyManagementParameters**(`parameters`: [JWEKeyManagementHeaderParameters](../interfaces/_types_d_.jwekeymanagementheaderparameters.md)): this -*Defined in [src/jwe/flattened/encrypt.ts:92](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L92)* +*Defined in [src/jwe/flattened/encrypt.ts:92](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L92)* Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is really only needed for ECDH-ES based algorithms @@ -174,7 +174,7 @@ ___ ▸ **setProtectedHeader**(`protectedHeader`: [JWEHeaderParameters](../interfaces/_types_d_.jweheaderparameters.md)): this -*Defined in [src/jwe/flattened/encrypt.ts:105](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L105)* +*Defined in [src/jwe/flattened/encrypt.ts:105](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L105)* Sets the JWE Protected Header on the FlattenedEncrypt object. @@ -192,7 +192,7 @@ ___ ▸ **setSharedUnprotectedHeader**(`sharedUnprotectedHeader`: [JWEHeaderParameters](../interfaces/_types_d_.jweheaderparameters.md)): this -*Defined in [src/jwe/flattened/encrypt.ts:118](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L118)* +*Defined in [src/jwe/flattened/encrypt.ts:118](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L118)* Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object. @@ -210,7 +210,7 @@ ___ ▸ **setUnprotectedHeader**(`unprotectedHeader`: [JWEHeaderParameters](../interfaces/_types_d_.jweheaderparameters.md)): this -*Defined in [src/jwe/flattened/encrypt.ts:131](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/encrypt.ts#L131)* +*Defined in [src/jwe/flattened/encrypt.ts:131](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/encrypt.ts#L131)* Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object. diff --git a/docs/classes/_jws_compact_sign_.compactsign.md b/docs/classes/_jws_compact_sign_.compactsign.md index 1517827908..402e8984eb 100644 --- a/docs/classes/_jws_compact_sign_.compactsign.md +++ b/docs/classes/_jws_compact_sign_.compactsign.md @@ -53,7 +53,7 @@ console.log(jws) \+ **new CompactSign**(`payload`: Uint8Array): [CompactSign](_jws_compact_sign_.compactsign.md) -*Defined in [src/jws/compact/sign.ts:44](https://github.com/panva/jose/blob/v3.7.0/src/jws/compact/sign.ts#L44)* +*Defined in [src/jws/compact/sign.ts:44](https://github.com/panva/jose/blob/v3.7.1/src/jws/compact/sign.ts#L44)* #### Parameters: @@ -69,7 +69,7 @@ Name | Type | Description | ▸ **setProtectedHeader**(`protectedHeader`: [JWSHeaderParameters](../interfaces/_types_d_.jwsheaderparameters.md)): this -*Defined in [src/jws/compact/sign.ts:58](https://github.com/panva/jose/blob/v3.7.0/src/jws/compact/sign.ts#L58)* +*Defined in [src/jws/compact/sign.ts:58](https://github.com/panva/jose/blob/v3.7.1/src/jws/compact/sign.ts#L58)* Sets the JWS Protected Header on the Sign object. @@ -87,7 +87,7 @@ ___ ▸ **sign**(`key`: [KeyLike](../types/_types_d_.keylike.md), `options?`: [SignOptions](../interfaces/_types_d_.signoptions.md)): Promise -*Defined in [src/jws/compact/sign.ts:69](https://github.com/panva/jose/blob/v3.7.0/src/jws/compact/sign.ts#L69)* +*Defined in [src/jws/compact/sign.ts:69](https://github.com/panva/jose/blob/v3.7.1/src/jws/compact/sign.ts#L69)* Signs and resolves the value of the Compact JWS string. diff --git a/docs/classes/_jws_flattened_sign_.flattenedsign.md b/docs/classes/_jws_flattened_sign_.flattenedsign.md index d10bb3676e..923b9dbb10 100644 --- a/docs/classes/_jws_flattened_sign_.flattenedsign.md +++ b/docs/classes/_jws_flattened_sign_.flattenedsign.md @@ -53,7 +53,7 @@ console.log(jws) \+ **new FlattenedSign**(`payload`: Uint8Array): [FlattenedSign](_jws_flattened_sign_.flattenedsign.md) -*Defined in [src/jws/flattened/sign.ts:56](https://github.com/panva/jose/blob/v3.7.0/src/jws/flattened/sign.ts#L56)* +*Defined in [src/jws/flattened/sign.ts:56](https://github.com/panva/jose/blob/v3.7.1/src/jws/flattened/sign.ts#L56)* #### Parameters: @@ -69,7 +69,7 @@ Name | Type | Description | ▸ **setProtectedHeader**(`protectedHeader`: [JWSHeaderParameters](../interfaces/_types_d_.jwsheaderparameters.md)): this -*Defined in [src/jws/flattened/sign.ts:70](https://github.com/panva/jose/blob/v3.7.0/src/jws/flattened/sign.ts#L70)* +*Defined in [src/jws/flattened/sign.ts:70](https://github.com/panva/jose/blob/v3.7.1/src/jws/flattened/sign.ts#L70)* Sets the JWS Protected Header on the FlattenedSign object. @@ -87,7 +87,7 @@ ___ ▸ **setUnprotectedHeader**(`unprotectedHeader`: [JWSHeaderParameters](../interfaces/_types_d_.jwsheaderparameters.md)): this -*Defined in [src/jws/flattened/sign.ts:83](https://github.com/panva/jose/blob/v3.7.0/src/jws/flattened/sign.ts#L83)* +*Defined in [src/jws/flattened/sign.ts:83](https://github.com/panva/jose/blob/v3.7.1/src/jws/flattened/sign.ts#L83)* Sets the JWS Unprotected Header on the FlattenedSign object. @@ -105,7 +105,7 @@ ___ ▸ **sign**(`key`: [KeyLike](../types/_types_d_.keylike.md), `options?`: [SignOptions](../interfaces/_types_d_.signoptions.md)): Promise<[FlattenedJWS](../interfaces/_types_d_.flattenedjws.md)\> -*Defined in [src/jws/flattened/sign.ts:97](https://github.com/panva/jose/blob/v3.7.0/src/jws/flattened/sign.ts#L97)* +*Defined in [src/jws/flattened/sign.ts:97](https://github.com/panva/jose/blob/v3.7.1/src/jws/flattened/sign.ts#L97)* Signs and resolves the value of the Flattened JWS object. diff --git a/docs/classes/_jws_general_sign_.generalsign.md b/docs/classes/_jws_general_sign_.generalsign.md index 8f12ac8ac9..d62a1dacd7 100644 --- a/docs/classes/_jws_general_sign_.generalsign.md +++ b/docs/classes/_jws_general_sign_.generalsign.md @@ -71,7 +71,7 @@ const jws = await sign.sign() \+ **new GeneralSign**(`payload`: Uint8Array): [GeneralSign](_jws_general_sign_.generalsign.md) -*Defined in [src/jws/general/sign.ts:124](https://github.com/panva/jose/blob/v3.7.0/src/jws/general/sign.ts#L124)* +*Defined in [src/jws/general/sign.ts:124](https://github.com/panva/jose/blob/v3.7.1/src/jws/general/sign.ts#L124)* #### Parameters: @@ -87,7 +87,7 @@ Name | Type | Description | ▸ **addSignature**(`key`: [KeyLike](../types/_types_d_.keylike.md), `options?`: [SignOptions](../interfaces/_types_d_.signoptions.md)): [Signature](../interfaces/_jws_general_sign_.signature.md) -*Defined in [src/jws/general/sign.ts:133](https://github.com/panva/jose/blob/v3.7.0/src/jws/general/sign.ts#L133)* +*Defined in [src/jws/general/sign.ts:133](https://github.com/panva/jose/blob/v3.7.1/src/jws/general/sign.ts#L133)* #### Parameters: @@ -104,7 +104,7 @@ ___ ▸ **sign**(): Promise<[GeneralJWS](../interfaces/_types_d_.generaljws.md)\> -*Defined in [src/jws/general/sign.ts:143](https://github.com/panva/jose/blob/v3.7.0/src/jws/general/sign.ts#L143)* +*Defined in [src/jws/general/sign.ts:143](https://github.com/panva/jose/blob/v3.7.1/src/jws/general/sign.ts#L143)* Signs and resolves the value of the General JWS object. diff --git a/docs/classes/_jwt_encrypt_.encryptjwt.md b/docs/classes/_jwt_encrypt_.encryptjwt.md index a245b16357..b11f58a832 100644 --- a/docs/classes/_jwt_encrypt_.encryptjwt.md +++ b/docs/classes/_jwt_encrypt_.encryptjwt.md @@ -64,7 +64,7 @@ console.log(jwt) \+ **new EncryptJWT**(`payload`: [JWTPayload](../interfaces/_types_d_.jwtpayload.md)): [EncryptJWT](_jwt_encrypt_.encryptjwt.md) -*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L10)* +*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L10)* #### Parameters: @@ -80,7 +80,7 @@ Name | Type | Description | ▸ **encrypt**(`key`: [KeyLike](../types/_types_d_.keylike.md), `options?`: [EncryptOptions](../interfaces/_types_d_.encryptoptions.md)): Promise -*Defined in [src/jwt/encrypt.ts:160](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L160)* +*Defined in [src/jwt/encrypt.ts:160](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L160)* Encrypts and returns the JWT. @@ -99,7 +99,7 @@ ___ ▸ **replicateAudienceAsHeader**(): this -*Defined in [src/jwt/encrypt.ts:149](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L149)* +*Defined in [src/jwt/encrypt.ts:149](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L149)* Replicates the "aud" (Audience) Claim as a JWE Protected Header Parameter as per [RFC7519#section-5.3](https://tools.ietf.org/html/rfc7519#section-5.3). @@ -112,7 +112,7 @@ ___ ▸ **replicateIssuerAsHeader**(): this -*Defined in [src/jwt/encrypt.ts:131](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L131)* +*Defined in [src/jwt/encrypt.ts:131](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L131)* Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter as per [RFC7519#section-5.3](https://tools.ietf.org/html/rfc7519#section-5.3). @@ -125,7 +125,7 @@ ___ ▸ **replicateSubjectAsHeader**(): this -*Defined in [src/jwt/encrypt.ts:140](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L140)* +*Defined in [src/jwt/encrypt.ts:140](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L140)* Replicates the "sub" (Subject) Claim as a JWE Protected Header Parameter as per [RFC7519#section-5.3](https://tools.ietf.org/html/rfc7519#section-5.3). @@ -138,7 +138,7 @@ ___ ▸ **setAudience**(`audience`: string \| string[]): this -*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L47)* +*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L47)* Set "aud" (Audience) Claim. @@ -156,7 +156,7 @@ ___ ▸ **setContentEncryptionKey**(`cek`: Uint8Array): this -*Defined in [src/jwt/encrypt.ts:103](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L103)* +*Defined in [src/jwt/encrypt.ts:103](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L103)* Sets a content encryption key to use, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter. @@ -177,7 +177,7 @@ ___ ▸ **setExpirationTime**(`input`: number \| string): this -*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L85)* +*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L85)* Set "exp" (Expiration Time) Claim. @@ -195,7 +195,7 @@ ___ ▸ **setInitializationVector**(`iv`: Uint8Array): this -*Defined in [src/jwt/encrypt.ts:119](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L119)* +*Defined in [src/jwt/encrypt.ts:119](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L119)* Sets the JWE Initialization Vector to use for content encryption, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) @@ -216,7 +216,7 @@ ___ ▸ **setIssuedAt**(`input?`: number): this -*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L100)* +*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L100)* Set "iat" (Issued At) Claim. @@ -234,7 +234,7 @@ ___ ▸ **setIssuer**(`issuer`: string): this -*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L27)* +*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L27)* Set "iss" (Issuer) Claim. @@ -252,7 +252,7 @@ ___ ▸ **setJti**(`jwtId`: string): this -*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L57)* +*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L57)* Set "jti" (JWT ID) Claim. @@ -270,7 +270,7 @@ ___ ▸ **setKeyManagementParameters**(`parameters`: [JWEKeyManagementHeaderParameters](../interfaces/_types_d_.jwekeymanagementheaderparameters.md)): this -*Defined in [src/jwt/encrypt.ts:87](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L87)* +*Defined in [src/jwt/encrypt.ts:87](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L87)* Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is really only needed for ECDH-ES based algorithms @@ -291,7 +291,7 @@ ___ ▸ **setNotBefore**(`input`: number \| string): this -*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L69)* +*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L69)* Set "nbf" (Not Before) Claim. @@ -309,7 +309,7 @@ ___ ▸ **setProtectedHeader**(`protectedHeader`: [JWEHeaderParameters](../interfaces/_types_d_.jweheaderparameters.md)): this -*Defined in [src/jwt/encrypt.ts:71](https://github.com/panva/jose/blob/v3.7.0/src/jwt/encrypt.ts#L71)* +*Defined in [src/jwt/encrypt.ts:71](https://github.com/panva/jose/blob/v3.7.1/src/jwt/encrypt.ts#L71)* Sets the JWE Protected Header on the EncryptJWT object. @@ -327,7 +327,7 @@ ___ ▸ **setSubject**(`subject`: string): this -*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L37)* +*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L37)* Set "sub" (Subject) Claim. diff --git a/docs/classes/_jwt_sign_.signjwt.md b/docs/classes/_jwt_sign_.signjwt.md index a7bf1fe45d..9a25fa71f8 100644 --- a/docs/classes/_jwt_sign_.signjwt.md +++ b/docs/classes/_jwt_sign_.signjwt.md @@ -63,7 +63,7 @@ console.log(jwt) \+ **new SignJWT**(`payload`: [JWTPayload](../interfaces/_types_d_.jwtpayload.md)): [SignJWT](_jwt_sign_.signjwt.md) -*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L10)* +*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L10)* #### Parameters: @@ -79,7 +79,7 @@ Name | Type | Description | ▸ **setAudience**(`audience`: string \| string[]): this -*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L47)* +*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L47)* Set "aud" (Audience) Claim. @@ -97,7 +97,7 @@ ___ ▸ **setExpirationTime**(`input`: number \| string): this -*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L85)* +*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L85)* Set "exp" (Expiration Time) Claim. @@ -115,7 +115,7 @@ ___ ▸ **setIssuedAt**(`input?`: number): this -*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L100)* +*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L100)* Set "iat" (Issued At) Claim. @@ -133,7 +133,7 @@ ___ ▸ **setIssuer**(`issuer`: string): this -*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L27)* +*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L27)* Set "iss" (Issuer) Claim. @@ -151,7 +151,7 @@ ___ ▸ **setJti**(`jwtId`: string): this -*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L57)* +*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L57)* Set "jti" (JWT ID) Claim. @@ -169,7 +169,7 @@ ___ ▸ **setNotBefore**(`input`: number \| string): this -*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L69)* +*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L69)* Set "nbf" (Not Before) Claim. @@ -187,7 +187,7 @@ ___ ▸ **setProtectedHeader**(`protectedHeader`: [JWSHeaderParameters](../interfaces/_types_d_.jwsheaderparameters.md)): this -*Defined in [src/jwt/sign.ts:57](https://github.com/panva/jose/blob/v3.7.0/src/jwt/sign.ts#L57)* +*Defined in [src/jwt/sign.ts:57](https://github.com/panva/jose/blob/v3.7.1/src/jwt/sign.ts#L57)* Sets the JWS Protected Header on the SignJWT object. @@ -205,7 +205,7 @@ ___ ▸ **setSubject**(`subject`: string): this -*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L37)* +*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L37)* Set "sub" (Subject) Claim. @@ -223,7 +223,7 @@ ___ ▸ **sign**(`key`: [KeyLike](../types/_types_d_.keylike.md), `options?`: [SignOptions](../interfaces/_types_d_.signoptions.md)): Promise -*Defined in [src/jwt/sign.ts:68](https://github.com/panva/jose/blob/v3.7.0/src/jwt/sign.ts#L68)* +*Defined in [src/jwt/sign.ts:68](https://github.com/panva/jose/blob/v3.7.1/src/jwt/sign.ts#L68)* Signs and returns the JWT. diff --git a/docs/classes/_jwt_unsecured_.unsecuredjwt.md b/docs/classes/_jwt_unsecured_.unsecuredjwt.md index 7e85a844ce..e1b956ebb4 100644 --- a/docs/classes/_jwt_unsecured_.unsecuredjwt.md +++ b/docs/classes/_jwt_unsecured_.unsecuredjwt.md @@ -64,7 +64,7 @@ console.log(payload) \+ **new UnsecuredJWT**(`payload`: [JWTPayload](../interfaces/_types_d_.jwtpayload.md)): [UnsecuredJWT](_jwt_unsecured_.unsecuredjwt.md) -*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L10)* +*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L10)* #### Parameters: @@ -80,7 +80,7 @@ Name | Type | Description | ▸ **encode**(): string -*Defined in [src/jwt/unsecured.ts:55](https://github.com/panva/jose/blob/v3.7.0/src/jwt/unsecured.ts#L55)* +*Defined in [src/jwt/unsecured.ts:55](https://github.com/panva/jose/blob/v3.7.1/src/jwt/unsecured.ts#L55)* Encodes the Unsecured JWT. @@ -92,7 +92,7 @@ ___ ▸ **setAudience**(`audience`: string \| string[]): this -*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L47)* +*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L47)* Set "aud" (Audience) Claim. @@ -110,7 +110,7 @@ ___ ▸ **setExpirationTime**(`input`: number \| string): this -*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L85)* +*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L85)* Set "exp" (Expiration Time) Claim. @@ -128,7 +128,7 @@ ___ ▸ **setIssuedAt**(`input?`: number): this -*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L100)* +*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L100)* Set "iat" (Issued At) Claim. @@ -146,7 +146,7 @@ ___ ▸ **setIssuer**(`issuer`: string): this -*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L27)* +*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L27)* Set "iss" (Issuer) Claim. @@ -164,7 +164,7 @@ ___ ▸ **setJti**(`jwtId`: string): this -*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L57)* +*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L57)* Set "jti" (JWT ID) Claim. @@ -182,7 +182,7 @@ ___ ▸ **setNotBefore**(`input`: number \| string): this -*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L69)* +*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L69)* Set "nbf" (Not Before) Claim. @@ -200,7 +200,7 @@ ___ ▸ **setSubject**(`subject`: string): this -*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.7.0/src/lib/jwt_producer.ts#L37)* +*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.7.1/src/lib/jwt_producer.ts#L37)* Set "sub" (Subject) Claim. @@ -218,7 +218,7 @@ ___ ▸ `Static`**decode**(`jwt`: string, `options?`: [JWTClaimVerificationOptions](../interfaces/_types_d_.jwtclaimverificationoptions.md)): object -*Defined in [src/jwt/unsecured.ts:77](https://github.com/panva/jose/blob/v3.7.0/src/jwt/unsecured.ts#L77)* +*Defined in [src/jwt/unsecured.ts:77](https://github.com/panva/jose/blob/v3.7.1/src/jwt/unsecured.ts#L77)* Decodes an unsecured JWT. diff --git a/docs/classes/_util_errors_.josealgnotallowed.md b/docs/classes/_util_errors_.josealgnotallowed.md index ef7584f05e..71ea67b947 100644 --- a/docs/classes/_util_errors_.josealgnotallowed.md +++ b/docs/classes/_util_errors_.josealgnotallowed.md @@ -21,7 +21,7 @@ An error subclass thrown when a JOSE Algorithm is not allowed per developer pref \+ **new JOSEAlgNotAllowed**(`message?`: string): [JOSEAlgNotAllowed](_util_errors_.josealgnotallowed.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:49](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L49)* +*Defined in [src/util/errors.ts:49](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L49)* ___ diff --git a/docs/classes/_util_errors_.joseerror.md b/docs/classes/_util_errors_.joseerror.md index 18aa307531..51e2d0b379 100644 --- a/docs/classes/_util_errors_.joseerror.md +++ b/docs/classes/_util_errors_.joseerror.md @@ -23,7 +23,7 @@ JOSE Error subclasses inherit from. \+ **new JOSEError**(`message?`: string): [JOSEError](_util_errors_.joseerror.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | • **code**: string = "ERR\_JOSE\_GENERIC" -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* A unique error code for the particular error subclass. diff --git a/docs/classes/_util_errors_.josenotsupported.md b/docs/classes/_util_errors_.josenotsupported.md index d1a5148ac8..911e5b0d4a 100644 --- a/docs/classes/_util_errors_.josenotsupported.md +++ b/docs/classes/_util_errors_.josenotsupported.md @@ -22,7 +22,7 @@ implementation or JOSE in general. \+ **new JOSENotSupported**(`message?`: string): [JOSENotSupported](_util_errors_.josenotsupported.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -40,7 +40,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:57](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L57)* +*Defined in [src/util/errors.ts:57](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L57)* ___ diff --git a/docs/classes/_util_errors_.jwedecryptionfailed.md b/docs/classes/_util_errors_.jwedecryptionfailed.md index 959e51881d..a5784412bc 100644 --- a/docs/classes/_util_errors_.jwedecryptionfailed.md +++ b/docs/classes/_util_errors_.jwedecryptionfailed.md @@ -21,7 +21,7 @@ An error subclass thrown when a JWE ciphertext decryption fails. \+ **new JWEDecryptionFailed**(`message?`: string): [JWEDecryptionFailed](_util_errors_.jwedecryptionfailed.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:64](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L64)* +*Defined in [src/util/errors.ts:64](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L64)* ___ @@ -49,7 +49,7 @@ ___ *Overrides [JOSEError](_util_errors_.joseerror.md).[message](_util_errors_.joseerror.md#message)* -*Defined in [src/util/errors.ts:66](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L66)* +*Defined in [src/util/errors.ts:66](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L66)* ___ diff --git a/docs/classes/_util_errors_.jweinvalid.md b/docs/classes/_util_errors_.jweinvalid.md index b59596cbaa..0c665d78c7 100644 --- a/docs/classes/_util_errors_.jweinvalid.md +++ b/docs/classes/_util_errors_.jweinvalid.md @@ -21,7 +21,7 @@ An error subclass thrown when a JWE is invalid. \+ **new JWEInvalid**(`message?`: string): [JWEInvalid](_util_errors_.jweinvalid.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:73](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L73)* +*Defined in [src/util/errors.ts:73](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L73)* ___ diff --git a/docs/classes/_util_errors_.jwkinvalid.md b/docs/classes/_util_errors_.jwkinvalid.md index ec848c22cf..2d0db4d0f3 100644 --- a/docs/classes/_util_errors_.jwkinvalid.md +++ b/docs/classes/_util_errors_.jwkinvalid.md @@ -21,7 +21,7 @@ An error subclass thrown when a JWK is invalid. \+ **new JWKInvalid**(`message?`: string): [JWKInvalid](_util_errors_.jwkinvalid.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:94](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L94)* +*Defined in [src/util/errors.ts:94](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L94)* ___ diff --git a/docs/classes/_util_errors_.jwksinvalid.md b/docs/classes/_util_errors_.jwksinvalid.md index 3b31569c5c..0da9eb134c 100644 --- a/docs/classes/_util_errors_.jwksinvalid.md +++ b/docs/classes/_util_errors_.jwksinvalid.md @@ -21,7 +21,7 @@ An error subclass thrown when a JWKS is invalid. \+ **new JWKSInvalid**(`message?`: string): [JWKSInvalid](_util_errors_.jwksinvalid.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:101](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L101)* +*Defined in [src/util/errors.ts:101](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L101)* ___ diff --git a/docs/classes/_util_errors_.jwksmultiplematchingkeys.md b/docs/classes/_util_errors_.jwksmultiplematchingkeys.md index 4872e5e8da..98b9d98b84 100644 --- a/docs/classes/_util_errors_.jwksmultiplematchingkeys.md +++ b/docs/classes/_util_errors_.jwksmultiplematchingkeys.md @@ -21,7 +21,7 @@ An error subclass thrown when multiple keys match from a JWKS. \+ **new JWKSMultipleMatchingKeys**(`message?`: string): [JWKSMultipleMatchingKeys](_util_errors_.jwksmultiplematchingkeys.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:117](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L117)* +*Defined in [src/util/errors.ts:117](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L117)* ___ @@ -49,7 +49,7 @@ ___ *Overrides [JOSEError](_util_errors_.joseerror.md).[message](_util_errors_.joseerror.md#message)* -*Defined in [src/util/errors.ts:119](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L119)* +*Defined in [src/util/errors.ts:119](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L119)* ___ diff --git a/docs/classes/_util_errors_.jwksnomatchingkey.md b/docs/classes/_util_errors_.jwksnomatchingkey.md index 053116e3d8..7adf620ce1 100644 --- a/docs/classes/_util_errors_.jwksnomatchingkey.md +++ b/docs/classes/_util_errors_.jwksnomatchingkey.md @@ -21,7 +21,7 @@ An error subclass thrown when no keys match from a JWKS. \+ **new JWKSNoMatchingKey**(`message?`: string): [JWKSNoMatchingKey](_util_errors_.jwksnomatchingkey.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:108](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L108)* +*Defined in [src/util/errors.ts:108](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L108)* ___ @@ -49,7 +49,7 @@ ___ *Overrides [JOSEError](_util_errors_.joseerror.md).[message](_util_errors_.joseerror.md#message)* -*Defined in [src/util/errors.ts:110](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L110)* +*Defined in [src/util/errors.ts:110](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L110)* ___ diff --git a/docs/classes/_util_errors_.jwsinvalid.md b/docs/classes/_util_errors_.jwsinvalid.md index 666883b403..12e0eaa8a7 100644 --- a/docs/classes/_util_errors_.jwsinvalid.md +++ b/docs/classes/_util_errors_.jwsinvalid.md @@ -21,7 +21,7 @@ An error subclass thrown when a JWS is invalid. \+ **new JWSInvalid**(`message?`: string): [JWSInvalid](_util_errors_.jwsinvalid.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:80](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L80)* +*Defined in [src/util/errors.ts:80](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L80)* ___ diff --git a/docs/classes/_util_errors_.jwssignatureverificationfailed.md b/docs/classes/_util_errors_.jwssignatureverificationfailed.md index 323f92ff4f..5a8a201276 100644 --- a/docs/classes/_util_errors_.jwssignatureverificationfailed.md +++ b/docs/classes/_util_errors_.jwssignatureverificationfailed.md @@ -21,7 +21,7 @@ An error subclass thrown when JWS signature verification fails. \+ **new JWSSignatureVerificationFailed**(`message?`: string): [JWSSignatureVerificationFailed](_util_errors_.jwssignatureverificationfailed.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:126](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L126)* +*Defined in [src/util/errors.ts:126](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L126)* ___ @@ -49,7 +49,7 @@ ___ *Overrides [JOSEError](_util_errors_.joseerror.md).[message](_util_errors_.joseerror.md#message)* -*Defined in [src/util/errors.ts:128](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L128)* +*Defined in [src/util/errors.ts:128](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L128)* ___ diff --git a/docs/classes/_util_errors_.jwtclaimvalidationfailed.md b/docs/classes/_util_errors_.jwtclaimvalidationfailed.md index 458e3443b1..6cbcd4e33a 100644 --- a/docs/classes/_util_errors_.jwtclaimvalidationfailed.md +++ b/docs/classes/_util_errors_.jwtclaimvalidationfailed.md @@ -25,7 +25,7 @@ An error subclass thrown when a JWT Claim Set member validation fails. *Overrides [JOSEError](_util_errors_.joseerror.md).[constructor](_util_errors_.joseerror.md#constructor)* -*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L36)* #### Parameters: @@ -43,7 +43,7 @@ Name | Type | Default value | • **claim**: string -*Defined in [src/util/errors.ts:31](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L31)* +*Defined in [src/util/errors.ts:31](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L31)* The Claim for which the validation failed. @@ -55,7 +55,7 @@ ___ *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:26](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L26)* +*Defined in [src/util/errors.ts:26](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L26)* ___ @@ -79,7 +79,7 @@ ___ • **reason**: string -*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L36)* Reason code for the validation failure. diff --git a/docs/classes/_util_errors_.jwtexpired.md b/docs/classes/_util_errors_.jwtexpired.md index 939adc15d6..6b3870026b 100644 --- a/docs/classes/_util_errors_.jwtexpired.md +++ b/docs/classes/_util_errors_.jwtexpired.md @@ -25,7 +25,7 @@ An error subclass thrown when a JWT is expired. *Overrides [JOSEError](_util_errors_.joseerror.md).[constructor](_util_errors_.joseerror.md#constructor)* -*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L36)* #### Parameters: @@ -43,7 +43,7 @@ Name | Type | Default value | • **claim**: string -*Defined in [src/util/errors.ts:31](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L31)* +*Defined in [src/util/errors.ts:31](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L31)* The Claim for which the validation failed. @@ -55,7 +55,7 @@ ___ *Overrides [JWTClaimValidationFailed](_util_errors_.jwtclaimvalidationfailed.md).[code](_util_errors_.jwtclaimvalidationfailed.md#code)* -*Defined in [src/util/errors.ts:135](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L135)* +*Defined in [src/util/errors.ts:135](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L135)* ___ @@ -79,7 +79,7 @@ ___ • **reason**: string -*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L36)* Reason code for the validation failure. diff --git a/docs/classes/_util_errors_.jwtinvalid.md b/docs/classes/_util_errors_.jwtinvalid.md index dee052117b..ea5784c175 100644 --- a/docs/classes/_util_errors_.jwtinvalid.md +++ b/docs/classes/_util_errors_.jwtinvalid.md @@ -21,7 +21,7 @@ An error subclass thrown when a JWT is invalid. \+ **new JWTInvalid**(`message?`: string): [JWTInvalid](_util_errors_.jwtinvalid.md) -*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L11)* #### Parameters: @@ -39,7 +39,7 @@ Name | Type | *Overrides [JOSEError](_util_errors_.joseerror.md).[code](_util_errors_.joseerror.md#code)* -*Defined in [src/util/errors.ts:87](https://github.com/panva/jose/blob/v3.7.0/src/util/errors.ts#L87)* +*Defined in [src/util/errors.ts:87](https://github.com/panva/jose/blob/v3.7.1/src/util/errors.ts#L87)* ___ diff --git a/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md b/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md index ce12f769a0..a3e8ecceaf 100644 --- a/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md +++ b/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md @@ -2,7 +2,7 @@ ▸ **compactDecrypt**(`jwe`: string \| Uint8Array, `key`: [KeyLike](../types/_types_d_.keylike.md) \| [CompactDecryptGetKey](../interfaces/_jwe_compact_decrypt_.compactdecryptgetkey.md), `options?`: [DecryptOptions](../interfaces/_types_d_.decryptoptions.md)): Promise<[CompactDecryptResult](../interfaces/_types_d_.compactdecryptresult.md)\> -*Defined in [src/jwe/compact/decrypt.ts:63](https://github.com/panva/jose/blob/v3.7.0/src/jwe/compact/decrypt.ts#L63)* +*Defined in [src/jwe/compact/decrypt.ts:63](https://github.com/panva/jose/blob/v3.7.1/src/jwe/compact/decrypt.ts#L63)* Decrypts a Compact JWE. diff --git a/docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md b/docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md index 0f194007c2..c2f298ed8c 100644 --- a/docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md +++ b/docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md @@ -2,7 +2,7 @@ ▸ **flattenedDecrypt**(`jwe`: [FlattenedJWE](../interfaces/_types_d_.flattenedjwe.md), `key`: [KeyLike](../types/_types_d_.keylike.md) \| [FlattenedDecryptGetKey](../interfaces/_jwe_flattened_decrypt_.flatteneddecryptgetkey.md), `options?`: [DecryptOptions](../interfaces/_types_d_.decryptoptions.md)): Promise<[FlattenedDecryptResult](../interfaces/_types_d_.flatteneddecryptresult.md)\> -*Defined in [src/jwe/flattened/decrypt.ts:92](https://github.com/panva/jose/blob/v3.7.0/src/jwe/flattened/decrypt.ts#L92)* +*Defined in [src/jwe/flattened/decrypt.ts:92](https://github.com/panva/jose/blob/v3.7.1/src/jwe/flattened/decrypt.ts#L92)* Decrypts a Flattened JWE. diff --git a/docs/functions/_jwe_general_decrypt_.generaldecrypt.md b/docs/functions/_jwe_general_decrypt_.generaldecrypt.md index adf7a8c791..e004deee6b 100644 --- a/docs/functions/_jwe_general_decrypt_.generaldecrypt.md +++ b/docs/functions/_jwe_general_decrypt_.generaldecrypt.md @@ -2,7 +2,7 @@ ▸ **generalDecrypt**(`jwe`: [GeneralJWE](../interfaces/_types_d_.generaljwe.md), `key`: [KeyLike](../types/_types_d_.keylike.md) \| [GeneralDecryptGetKey](../interfaces/_jwe_general_decrypt_.generaldecryptgetkey.md), `options?`: [DecryptOptions](../interfaces/_types_d_.decryptoptions.md)): Promise<[GeneralDecryptResult](../interfaces/_types_d_.generaldecryptresult.md)\> -*Defined in [src/jwe/general/decrypt.ts:80](https://github.com/panva/jose/blob/v3.7.0/src/jwe/general/decrypt.ts#L80)* +*Defined in [src/jwe/general/decrypt.ts:80](https://github.com/panva/jose/blob/v3.7.1/src/jwe/general/decrypt.ts#L80)* Decrypts a General JWE. diff --git a/docs/functions/_jwk_embedded_.embeddedjwk.md b/docs/functions/_jwk_embedded_.embeddedjwk.md index ae0a4340d6..79a058d061 100644 --- a/docs/functions/_jwk_embedded_.embeddedjwk.md +++ b/docs/functions/_jwk_embedded_.embeddedjwk.md @@ -2,7 +2,7 @@ ▸ **EmbeddedJWK**(`protectedHeader`: [JWSHeaderParameters](../interfaces/_types_d_.jwsheaderparameters.md), `token`: [FlattenedJWSInput](../interfaces/_types_d_.flattenedjwsinput.md)): Promise -*Defined in [src/jwk/embedded.ts:43](https://github.com/panva/jose/blob/v3.7.0/src/jwk/embedded.ts#L43)* +*Defined in [src/jwk/embedded.ts:43](https://github.com/panva/jose/blob/v3.7.1/src/jwk/embedded.ts#L43)* EmbeddedJWK is an implementation of a GetKeyFunction intended to be used with the JWS/JWT verify operations whenever you need to opt-in to verify signatures with diff --git a/docs/functions/_jwk_from_key_like_.fromkeylike.md b/docs/functions/_jwk_from_key_like_.fromkeylike.md index 140fa1c49b..3853febace 100644 --- a/docs/functions/_jwk_from_key_like_.fromkeylike.md +++ b/docs/functions/_jwk_from_key_like_.fromkeylike.md @@ -2,7 +2,7 @@ ▸ **fromKeyLike**(`key`: [KeyLike](../types/_types_d_.keylike.md)): Promise<[JWK](../interfaces/_types_d_.jwk.md)\> -*Defined in [src/jwk/from_key_like.ts:32](https://github.com/panva/jose/blob/v3.7.0/src/jwk/from_key_like.ts#L32)* +*Defined in [src/jwk/from_key_like.ts:32](https://github.com/panva/jose/blob/v3.7.1/src/jwk/from_key_like.ts#L32)* Converts a runtime-specific key representation (KeyLike) to a JWK. diff --git a/docs/functions/_jwk_parse_.parsejwk.md b/docs/functions/_jwk_parse_.parsejwk.md index 0d9bc88c9a..64d9dfe3aa 100644 --- a/docs/functions/_jwk_parse_.parsejwk.md +++ b/docs/functions/_jwk_parse_.parsejwk.md @@ -2,7 +2,7 @@ ▸ **parseJwk**(`jwk`: [JWK](../interfaces/_types_d_.jwk.md), `alg?`: string, `octAsKeyObject?`: false \| true): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/jwk/parse.ts:50](https://github.com/panva/jose/blob/v3.7.0/src/jwk/parse.ts#L50)* +*Defined in [src/jwk/parse.ts:50](https://github.com/panva/jose/blob/v3.7.1/src/jwk/parse.ts#L50)* Converts a JWK to a runtime-specific key representation (KeyLike). Either JWK "alg" (Algorithm) Parameter must be present or the optional "alg" argument. When diff --git a/docs/functions/_jwk_thumbprint_.calculatethumbprint.md b/docs/functions/_jwk_thumbprint_.calculatethumbprint.md index df47e08262..f184d486f0 100644 --- a/docs/functions/_jwk_thumbprint_.calculatethumbprint.md +++ b/docs/functions/_jwk_thumbprint_.calculatethumbprint.md @@ -2,7 +2,7 @@ ▸ **calculateThumbprint**(`jwk`: [JWK](../interfaces/_types_d_.jwk.md), `digestAlgorithm?`: \"sha256\" \| \"sha384\" \| \"sha512\"): Promise -*Defined in [src/jwk/thumbprint.ts:47](https://github.com/panva/jose/blob/v3.7.0/src/jwk/thumbprint.ts#L47)* +*Defined in [src/jwk/thumbprint.ts:47](https://github.com/panva/jose/blob/v3.7.1/src/jwk/thumbprint.ts#L47)* Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint as per [RFC7638](https://tools.ietf.org/html/rfc7638). diff --git a/docs/functions/_jwks_remote_.createremotejwkset.md b/docs/functions/_jwks_remote_.createremotejwkset.md index 86d27a7f47..261f4f9688 100644 --- a/docs/functions/_jwks_remote_.createremotejwkset.md +++ b/docs/functions/_jwks_remote_.createremotejwkset.md @@ -2,7 +2,7 @@ ▸ **createRemoteJWKSet**(`url`: URL, `options?`: [RemoteJWKSetOptions](../interfaces/_jwks_remote_.remotejwksetoptions.md)): [GetKeyFunction](../interfaces/_types_d_.getkeyfunction.md)<[JWSHeaderParameters](../interfaces/_types_d_.jwsheaderparameters.md), [FlattenedJWSInput](../interfaces/_types_d_.flattenedjwsinput.md)\> -*Defined in [src/jwks/remote.ts:245](https://github.com/panva/jose/blob/v3.7.0/src/jwks/remote.ts#L245)* +*Defined in [src/jwks/remote.ts:245](https://github.com/panva/jose/blob/v3.7.1/src/jwks/remote.ts#L245)* Returns a function that resolves to a key object downloaded from a remote endpoint returning a JSON Web Key Set, that is, for example, diff --git a/docs/functions/_jws_compact_verify_.compactverify.md b/docs/functions/_jws_compact_verify_.compactverify.md index ab41f012d7..3d8f0beef3 100644 --- a/docs/functions/_jws_compact_verify_.compactverify.md +++ b/docs/functions/_jws_compact_verify_.compactverify.md @@ -2,7 +2,7 @@ ▸ **compactVerify**(`jws`: string \| Uint8Array, `key`: [KeyLike](../types/_types_d_.keylike.md) \| [CompactVerifyGetKey](../interfaces/_jws_compact_verify_.compactverifygetkey.md), `options?`: [VerifyOptions](../interfaces/_types_d_.verifyoptions.md)): Promise<[CompactVerifyResult](../interfaces/_types_d_.compactverifyresult.md)\> -*Defined in [src/jws/compact/verify.ts:60](https://github.com/panva/jose/blob/v3.7.0/src/jws/compact/verify.ts#L60)* +*Defined in [src/jws/compact/verify.ts:60](https://github.com/panva/jose/blob/v3.7.1/src/jws/compact/verify.ts#L60)* Verifies the signature and format of and afterwards decodes the Compact JWS. diff --git a/docs/functions/_jws_flattened_verify_.flattenedverify.md b/docs/functions/_jws_flattened_verify_.flattenedverify.md index 4e6709ae8a..3c64cd0947 100644 --- a/docs/functions/_jws_flattened_verify_.flattenedverify.md +++ b/docs/functions/_jws_flattened_verify_.flattenedverify.md @@ -2,7 +2,7 @@ ▸ **flattenedVerify**(`jws`: [FlattenedJWSInput](../interfaces/_types_d_.flattenedjwsinput.md), `key`: [KeyLike](../types/_types_d_.keylike.md) \| [FlattenedVerifyGetKey](../interfaces/_jws_flattened_verify_.flattenedverifygetkey.md), `options?`: [VerifyOptions](../interfaces/_types_d_.verifyoptions.md)): Promise<[FlattenedVerifyResult](../interfaces/_types_d_.flattenedverifyresult.md)\> -*Defined in [src/jws/flattened/verify.ts:75](https://github.com/panva/jose/blob/v3.7.0/src/jws/flattened/verify.ts#L75)* +*Defined in [src/jws/flattened/verify.ts:75](https://github.com/panva/jose/blob/v3.7.1/src/jws/flattened/verify.ts#L75)* Verifies the signature and format of and afterwards decodes the Flattened JWS. diff --git a/docs/functions/_jws_general_verify_.generalverify.md b/docs/functions/_jws_general_verify_.generalverify.md index b21517d79f..5e90923530 100644 --- a/docs/functions/_jws_general_verify_.generalverify.md +++ b/docs/functions/_jws_general_verify_.generalverify.md @@ -2,7 +2,7 @@ ▸ **generalVerify**(`jws`: [GeneralJWSInput](../interfaces/_types_d_.generaljwsinput.md), `key`: [KeyLike](../types/_types_d_.keylike.md) \| [GeneralVerifyGetKey](../interfaces/_jws_general_verify_.generalverifygetkey.md), `options?`: [VerifyOptions](../interfaces/_types_d_.verifyoptions.md)): Promise<[GeneralVerifyResult](../interfaces/_types_d_.generalverifyresult.md)\> -*Defined in [src/jws/general/verify.ts:69](https://github.com/panva/jose/blob/v3.7.0/src/jws/general/verify.ts#L69)* +*Defined in [src/jws/general/verify.ts:69](https://github.com/panva/jose/blob/v3.7.1/src/jws/general/verify.ts#L69)* Verifies the signature and format of and afterwards decodes the General JWS. diff --git a/docs/functions/_jwt_decrypt_.jwtdecrypt.md b/docs/functions/_jwt_decrypt_.jwtdecrypt.md index be0dc48523..2659a38b5c 100644 --- a/docs/functions/_jwt_decrypt_.jwtdecrypt.md +++ b/docs/functions/_jwt_decrypt_.jwtdecrypt.md @@ -2,7 +2,7 @@ ▸ **jwtDecrypt**(`jwt`: string \| Uint8Array, `key`: [KeyLike](../types/_types_d_.keylike.md) \| [JWTDecryptGetKey](../interfaces/_jwt_decrypt_.jwtdecryptgetkey.md), `options?`: [JWTDecryptOptions](../interfaces/_jwt_decrypt_.jwtdecryptoptions.md)): Promise<[JWTDecryptResult](../interfaces/_types_d_.jwtdecryptresult.md)\> -*Defined in [src/jwt/decrypt.ts:65](https://github.com/panva/jose/blob/v3.7.0/src/jwt/decrypt.ts#L65)* +*Defined in [src/jwt/decrypt.ts:65](https://github.com/panva/jose/blob/v3.7.1/src/jwt/decrypt.ts#L65)* Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT Claims Set. diff --git a/docs/functions/_jwt_verify_.jwtverify.md b/docs/functions/_jwt_verify_.jwtverify.md index 2d0ced9728..2cfe4bcd27 100644 --- a/docs/functions/_jwt_verify_.jwtverify.md +++ b/docs/functions/_jwt_verify_.jwtverify.md @@ -2,7 +2,7 @@ ▸ **jwtVerify**(`jwt`: string \| Uint8Array, `key`: [KeyLike](../types/_types_d_.keylike.md) \| [JWTVerifyGetKey](../interfaces/_jwt_verify_.jwtverifygetkey.md), `options?`: [JWTVerifyOptions](../interfaces/_jwt_verify_.jwtverifyoptions.md)): Promise<[JWTVerifyResult](../interfaces/_types_d_.jwtverifyresult.md)\> -*Defined in [src/jwt/verify.ts:67](https://github.com/panva/jose/blob/v3.7.0/src/jwt/verify.ts#L67)* +*Defined in [src/jwt/verify.ts:67](https://github.com/panva/jose/blob/v3.7.1/src/jwt/verify.ts#L67)* Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the JWT Claims Set. diff --git a/docs/functions/_util_decode_protected_header_.decodeprotectedheader.md b/docs/functions/_util_decode_protected_header_.decodeprotectedheader.md index 7c998a3b73..09ff6cdbc8 100644 --- a/docs/functions/_util_decode_protected_header_.decodeprotectedheader.md +++ b/docs/functions/_util_decode_protected_header_.decodeprotectedheader.md @@ -2,7 +2,7 @@ ▸ **decodeProtectedHeader**(`token`: string \| object): [ProtectedHeaderParameters](../types/_util_decode_protected_header_.protectedheaderparameters.md) -*Defined in [src/util/decode_protected_header.ts:34](https://github.com/panva/jose/blob/v3.7.0/src/util/decode_protected_header.ts#L34)* +*Defined in [src/util/decode_protected_header.ts:34](https://github.com/panva/jose/blob/v3.7.1/src/util/decode_protected_header.ts#L34)* Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization. diff --git a/docs/functions/_util_generate_key_pair_.generatekeypair.md b/docs/functions/_util_generate_key_pair_.generatekeypair.md index f1b4465c75..9855e23798 100644 --- a/docs/functions/_util_generate_key_pair_.generatekeypair.md +++ b/docs/functions/_util_generate_key_pair_.generatekeypair.md @@ -2,7 +2,7 @@ ▸ **generateKeyPair**(`alg`: string, `options?`: [GenerateKeyPairOptions](../interfaces/_util_generate_key_pair_.generatekeypairoptions.md)): Promise<{ privateKey: [KeyLike](../types/_types_d_.keylike.md) ; publicKey: [KeyLike](../types/_types_d_.keylike.md) }\> -*Defined in [src/util/generate_key_pair.ts:47](https://github.com/panva/jose/blob/v3.7.0/src/util/generate_key_pair.ts#L47)* +*Defined in [src/util/generate_key_pair.ts:47](https://github.com/panva/jose/blob/v3.7.1/src/util/generate_key_pair.ts#L47)* Generates a private and a public key for a given JWA algorithm identifier. This can only generate asymmetric key pairs. For symmetric secrets use the diff --git a/docs/functions/_util_generate_secret_.generatesecret.md b/docs/functions/_util_generate_secret_.generatesecret.md index 341eb2f6c2..51be6a2198 100644 --- a/docs/functions/_util_generate_secret_.generatesecret.md +++ b/docs/functions/_util_generate_secret_.generatesecret.md @@ -2,7 +2,7 @@ ▸ **generateSecret**(`alg`: string): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/util/generate_secret.ts:28](https://github.com/panva/jose/blob/v3.7.0/src/util/generate_secret.ts#L28)* +*Defined in [src/util/generate_secret.ts:28](https://github.com/panva/jose/blob/v3.7.1/src/util/generate_secret.ts#L28)* Generates a symmetric secret key for a given JWA algorithm identifier. diff --git a/docs/interfaces/_jwe_compact_decrypt_.compactdecryptgetkey.md b/docs/interfaces/_jwe_compact_decrypt_.compactdecryptgetkey.md index 5c10e36837..ba68402478 100644 --- a/docs/interfaces/_jwe_compact_decrypt_.compactdecryptgetkey.md +++ b/docs/interfaces/_jwe_compact_decrypt_.compactdecryptgetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWEHeaderParameters](_types_d_.jweheaderparameters.md), `token`: [FlattenedJWE](_types_d_.flattenedjwe.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for Compact JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jwe_flattened_decrypt_.flatteneddecryptgetkey.md b/docs/interfaces/_jwe_flattened_decrypt_.flatteneddecryptgetkey.md index 91846c8d8e..ec156b83f5 100644 --- a/docs/interfaces/_jwe_flattened_decrypt_.flatteneddecryptgetkey.md +++ b/docs/interfaces/_jwe_flattened_decrypt_.flatteneddecryptgetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) \| undefined, `token`: [FlattenedJWE](_types_d_.flattenedjwe.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for Flattened JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jwe_general_decrypt_.generaldecryptgetkey.md b/docs/interfaces/_jwe_general_decrypt_.generaldecryptgetkey.md index 4add594678..97e29c22a6 100644 --- a/docs/interfaces/_jwe_general_decrypt_.generaldecryptgetkey.md +++ b/docs/interfaces/_jwe_general_decrypt_.generaldecryptgetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWEHeaderParameters](_types_d_.jweheaderparameters.md), `token`: [FlattenedJWE](_types_d_.flattenedjwe.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for General JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jwks_remote_.remotejwksetoptions.md b/docs/interfaces/_jwks_remote_.remotejwksetoptions.md index 098f6a0bc4..18e57937c8 100644 --- a/docs/interfaces/_jwks_remote_.remotejwksetoptions.md +++ b/docs/interfaces/_jwks_remote_.remotejwksetoptions.md @@ -16,7 +16,7 @@ Options for the remote JSON Web Key Set. • `Optional` **agent**: Agent \| Agent -*Defined in [src/jwks/remote.ts:55](https://github.com/panva/jose/blob/v3.7.0/src/jwks/remote.ts#L55)* +*Defined in [src/jwks/remote.ts:55](https://github.com/panva/jose/blob/v3.7.1/src/jwks/remote.ts#L55)* An instance of http.Agent or https.Agent to pass to the http.get or https.get method options. Use when behind an http(s) proxy. @@ -29,7 +29,7 @@ ___ • `Optional` **cooldownDuration**: number -*Defined in [src/jwks/remote.ts:47](https://github.com/panva/jose/blob/v3.7.0/src/jwks/remote.ts#L47)* +*Defined in [src/jwks/remote.ts:47](https://github.com/panva/jose/blob/v3.7.1/src/jwks/remote.ts#L47)* Duration for which no more HTTP requests will be triggered after a previous successful fetch. Default is 30000. @@ -40,7 +40,7 @@ ___ • `Optional` **timeoutDuration**: number -*Defined in [src/jwks/remote.ts:41](https://github.com/panva/jose/blob/v3.7.0/src/jwks/remote.ts#L41)* +*Defined in [src/jwks/remote.ts:41](https://github.com/panva/jose/blob/v3.7.1/src/jwks/remote.ts#L41)* Timeout for the HTTP request. When reached the request will be aborted and the verification will fail. Default is 5000. diff --git a/docs/interfaces/_jws_compact_verify_.compactverifygetkey.md b/docs/interfaces/_jws_compact_verify_.compactverifygetkey.md index 54c930589a..2027bb90b8 100644 --- a/docs/interfaces/_jws_compact_verify_.compactverifygetkey.md +++ b/docs/interfaces/_jws_compact_verify_.compactverifygetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md), `token`: [FlattenedJWSInput](_types_d_.flattenedjwsinput.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for Compact JWS Verification dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jws_flattened_verify_.flattenedverifygetkey.md b/docs/interfaces/_jws_flattened_verify_.flattenedverifygetkey.md index 9e10df65d7..741d0cbb14 100644 --- a/docs/interfaces/_jws_flattened_verify_.flattenedverifygetkey.md +++ b/docs/interfaces/_jws_flattened_verify_.flattenedverifygetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) \| undefined, `token`: [FlattenedJWSInput](_types_d_.flattenedjwsinput.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for Flattened JWS Verification dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jws_general_sign_.signature.md b/docs/interfaces/_jws_general_sign_.signature.md index 2d36639816..c1135e943d 100644 --- a/docs/interfaces/_jws_general_sign_.signature.md +++ b/docs/interfaces/_jws_general_sign_.signature.md @@ -13,7 +13,7 @@ ▸ **setProtectedHeader**(`protectedHeader`: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md)): [Signature](_jws_general_sign_.signature.md) -*Defined in [src/jws/general/sign.ts:13](https://github.com/panva/jose/blob/v3.7.0/src/jws/general/sign.ts#L13)* +*Defined in [src/jws/general/sign.ts:13](https://github.com/panva/jose/blob/v3.7.1/src/jws/general/sign.ts#L13)* Sets the JWS Protected Header on the Signature object. @@ -31,7 +31,7 @@ ___ ▸ **setUnprotectedHeader**(`unprotectedHeader`: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md)): [Signature](_jws_general_sign_.signature.md) -*Defined in [src/jws/general/sign.ts:20](https://github.com/panva/jose/blob/v3.7.0/src/jws/general/sign.ts#L20)* +*Defined in [src/jws/general/sign.ts:20](https://github.com/panva/jose/blob/v3.7.1/src/jws/general/sign.ts#L20)* Sets the JWS Unprotected Header on the Signature object. diff --git a/docs/interfaces/_jws_general_verify_.generalverifygetkey.md b/docs/interfaces/_jws_general_verify_.generalverifygetkey.md index ee4639a0bf..acf4837b8a 100644 --- a/docs/interfaces/_jws_general_verify_.generalverifygetkey.md +++ b/docs/interfaces/_jws_general_verify_.generalverifygetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md), `token`: [FlattenedJWSInput](_types_d_.flattenedjwsinput.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for General JWS Verification dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jwt_decrypt_.jwtdecryptgetkey.md b/docs/interfaces/_jwt_decrypt_.jwtdecryptgetkey.md index e9a74036c5..4441945df2 100644 --- a/docs/interfaces/_jwt_decrypt_.jwtdecryptgetkey.md +++ b/docs/interfaces/_jwt_decrypt_.jwtdecryptgetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWEHeaderParameters](_types_d_.jweheaderparameters.md), `token`: [FlattenedJWE](_types_d_.flattenedjwe.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for JWT Decryption dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jwt_decrypt_.jwtdecryptoptions.md b/docs/interfaces/_jwt_decrypt_.jwtdecryptoptions.md index 037fa9a2c4..266a0649c0 100644 --- a/docs/interfaces/_jwt_decrypt_.jwtdecryptoptions.md +++ b/docs/interfaces/_jwt_decrypt_.jwtdecryptoptions.md @@ -24,7 +24,7 @@ Combination of JWE Decryption options and JWT Claims Set verification options. • `Optional` **audience**: string \| string[] -*Defined in [src/types.d.ts:422](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L422)* +*Defined in [src/types.d.ts:422](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L422)* Expected JWT "aud" (Audience) Claim value(s). @@ -34,7 +34,7 @@ ___ • `Optional` **clockTolerance**: string \| number -*Defined in [src/types.d.ts:429](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L429)* +*Defined in [src/types.d.ts:429](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L429)* Expected clock tolerance - in seconds when number (e.g. 5) @@ -46,7 +46,7 @@ ___ • `Optional` **contentEncryptionAlgorithms**: string[] -*Defined in [src/types.d.ts:395](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L395)* +*Defined in [src/types.d.ts:395](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L395)* A list of accepted JWE "enc" (Encryption Algorithm) Header Parameter values. @@ -56,7 +56,7 @@ ___ • `Optional` **crit**: { [propName:string]: boolean; } -*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L378)* +*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L378)* An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either `true` or `false`. `true` when the @@ -83,7 +83,7 @@ ___ • `Optional` **currentDate**: Date -*Defined in [src/types.d.ts:456](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L456)* +*Defined in [src/types.d.ts:456](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L456)* Date to use when comparing NumericDate claims, defaults to `new Date()`. @@ -93,7 +93,7 @@ ___ • `Optional` **inflateRaw**: [InflateFunction](_types_d_.inflatefunction.md) -*Defined in [src/types.d.ts:401](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L401)* +*Defined in [src/types.d.ts:401](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L401)* In a browser runtime you have to provide an implementation for Inflate Raw when you expect JWEs with compressed plaintext. @@ -104,7 +104,7 @@ ___ • `Optional` **issuer**: string \| string[] -*Defined in [src/types.d.ts:434](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L434)* +*Defined in [src/types.d.ts:434](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L434)* Expected JWT "iss" (Issuer) Claim value(s). @@ -114,7 +114,7 @@ ___ • `Optional` **keyManagementAlgorithms**: string[] -*Defined in [src/types.d.ts:390](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L390)* +*Defined in [src/types.d.ts:390](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L390)* A list of accepted JWE "alg" (Algorithm) Header Parameter values. @@ -124,7 +124,7 @@ ___ • `Optional` **maxTokenAge**: string \| number -*Defined in [src/types.d.ts:441](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L441)* +*Defined in [src/types.d.ts:441](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L441)* Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. - in seconds when number (e.g. 5) @@ -136,7 +136,7 @@ ___ • `Optional` **subject**: string -*Defined in [src/types.d.ts:446](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L446)* +*Defined in [src/types.d.ts:446](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L446)* Expected JWT "sub" (Subject) Claim value. @@ -146,6 +146,6 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:451](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L451)* +*Defined in [src/types.d.ts:451](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L451)* Expected JWT "typ" (Type) Header Parameter value. diff --git a/docs/interfaces/_jwt_verify_.jwtverifygetkey.md b/docs/interfaces/_jwt_verify_.jwtverifygetkey.md index ca065526c9..2fea156966 100644 --- a/docs/interfaces/_jwt_verify_.jwtverifygetkey.md +++ b/docs/interfaces/_jwt_verify_.jwtverifygetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ▸ (`protectedHeader`: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md), `token`: [FlattenedJWSInput](_types_d_.flattenedjwsinput.md)): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Interface for JWT Verification dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_jwt_verify_.jwtverifyoptions.md b/docs/interfaces/_jwt_verify_.jwtverifyoptions.md index 51f797bd4f..29be56e72b 100644 --- a/docs/interfaces/_jwt_verify_.jwtverifyoptions.md +++ b/docs/interfaces/_jwt_verify_.jwtverifyoptions.md @@ -22,7 +22,7 @@ Combination of JWS Verification options and JWT Claims Set verification options. • `Optional` **algorithms**: string[] -*Defined in [src/types.d.ts:466](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L466)* +*Defined in [src/types.d.ts:466](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L466)* A list of accepted JWS "alg" (Algorithm) Header Parameter values. @@ -32,7 +32,7 @@ ___ • `Optional` **audience**: string \| string[] -*Defined in [src/types.d.ts:422](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L422)* +*Defined in [src/types.d.ts:422](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L422)* Expected JWT "aud" (Audience) Claim value(s). @@ -42,7 +42,7 @@ ___ • `Optional` **clockTolerance**: string \| number -*Defined in [src/types.d.ts:429](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L429)* +*Defined in [src/types.d.ts:429](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L429)* Expected clock tolerance - in seconds when number (e.g. 5) @@ -54,7 +54,7 @@ ___ • `Optional` **crit**: { [propName:string]: boolean; } -*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L378)* +*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L378)* An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either `true` or `false`. `true` when the @@ -81,7 +81,7 @@ ___ • `Optional` **currentDate**: Date -*Defined in [src/types.d.ts:456](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L456)* +*Defined in [src/types.d.ts:456](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L456)* Date to use when comparing NumericDate claims, defaults to `new Date()`. @@ -91,7 +91,7 @@ ___ • `Optional` **issuer**: string \| string[] -*Defined in [src/types.d.ts:434](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L434)* +*Defined in [src/types.d.ts:434](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L434)* Expected JWT "iss" (Issuer) Claim value(s). @@ -101,7 +101,7 @@ ___ • `Optional` **maxTokenAge**: string \| number -*Defined in [src/types.d.ts:441](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L441)* +*Defined in [src/types.d.ts:441](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L441)* Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. - in seconds when number (e.g. 5) @@ -113,7 +113,7 @@ ___ • `Optional` **subject**: string -*Defined in [src/types.d.ts:446](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L446)* +*Defined in [src/types.d.ts:446](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L446)* Expected JWT "sub" (Subject) Claim value. @@ -123,6 +123,6 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:451](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L451)* +*Defined in [src/types.d.ts:451](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L451)* Expected JWT "typ" (Type) Header Parameter value. diff --git a/docs/interfaces/_types_d_.compactdecryptresult.md b/docs/interfaces/_types_d_.compactdecryptresult.md index 822b84aa6a..83d25a121e 100644 --- a/docs/interfaces/_types_d_.compactdecryptresult.md +++ b/docs/interfaces/_types_d_.compactdecryptresult.md @@ -13,7 +13,7 @@ • **plaintext**: Uint8Array -*Defined in [src/types.d.ts:567](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L567)* +*Defined in [src/types.d.ts:567](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L567)* Plaintext. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:572](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L572)* +*Defined in [src/types.d.ts:572](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L572)* JWE Protected Header. diff --git a/docs/interfaces/_types_d_.compactverifyresult.md b/docs/interfaces/_types_d_.compactverifyresult.md index f7e66749c1..f37b0bbfb0 100644 --- a/docs/interfaces/_types_d_.compactverifyresult.md +++ b/docs/interfaces/_types_d_.compactverifyresult.md @@ -13,7 +13,7 @@ • **payload**: Uint8Array -*Defined in [src/types.d.ts:598](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L598)* +*Defined in [src/types.d.ts:598](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L598)* JWS Payload. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:603](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L603)* +*Defined in [src/types.d.ts:603](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L603)* JWS Protected Header. diff --git a/docs/interfaces/_types_d_.critoption.md b/docs/interfaces/_types_d_.critoption.md index 67f62ed868..609804fc77 100644 --- a/docs/interfaces/_types_d_.critoption.md +++ b/docs/interfaces/_types_d_.critoption.md @@ -14,7 +14,7 @@ Shared Interface with a "crit" property for all sign and verify operations. • `Optional` **crit**: { [propName:string]: boolean; } -*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L378)* +*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L378)* An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either `true` or `false`. `true` when the diff --git a/docs/interfaces/_types_d_.decryptoptions.md b/docs/interfaces/_types_d_.decryptoptions.md index 21d779615e..7ab6c3b5e6 100644 --- a/docs/interfaces/_types_d_.decryptoptions.md +++ b/docs/interfaces/_types_d_.decryptoptions.md @@ -17,7 +17,7 @@ JWE Decryption options. • `Optional` **contentEncryptionAlgorithms**: string[] -*Defined in [src/types.d.ts:395](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L395)* +*Defined in [src/types.d.ts:395](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L395)* A list of accepted JWE "enc" (Encryption Algorithm) Header Parameter values. @@ -27,7 +27,7 @@ ___ • `Optional` **crit**: { [propName:string]: boolean; } -*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L378)* +*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L378)* An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either `true` or `false`. `true` when the @@ -54,7 +54,7 @@ ___ • `Optional` **inflateRaw**: [InflateFunction](_types_d_.inflatefunction.md) -*Defined in [src/types.d.ts:401](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L401)* +*Defined in [src/types.d.ts:401](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L401)* In a browser runtime you have to provide an implementation for Inflate Raw when you expect JWEs with compressed plaintext. @@ -65,6 +65,6 @@ ___ • `Optional` **keyManagementAlgorithms**: string[] -*Defined in [src/types.d.ts:390](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L390)* +*Defined in [src/types.d.ts:390](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L390)* A list of accepted JWE "alg" (Algorithm) Header Parameter values. diff --git a/docs/interfaces/_types_d_.deflatefunction.md b/docs/interfaces/_types_d_.deflatefunction.md index fcb3c6221e..7915a3019b 100644 --- a/docs/interfaces/_types_d_.deflatefunction.md +++ b/docs/interfaces/_types_d_.deflatefunction.md @@ -6,7 +6,7 @@ Deflate Raw implementation, e.g. promisified [zlib.deflateRaw](https://nodejs.or ▸ (`input`: Uint8Array): Promise -*Defined in [src/types.d.ts:523](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L523)* +*Defined in [src/types.d.ts:523](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L523)* Deflate Raw implementation, e.g. promisified [zlib.deflateRaw](https://nodejs.org/api/zlib.html#zlib_zlib_deflateraw_buffer_options_callback). diff --git a/docs/interfaces/_types_d_.encryptoptions.md b/docs/interfaces/_types_d_.encryptoptions.md index 166e710076..367bf7a6e9 100644 --- a/docs/interfaces/_types_d_.encryptoptions.md +++ b/docs/interfaces/_types_d_.encryptoptions.md @@ -15,7 +15,7 @@ JWE Encryption options. • `Optional` **crit**: { [propName:string]: boolean; } -*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L378)* +*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L378)* An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either `true` or `false`. `true` when the @@ -42,7 +42,7 @@ ___ • `Optional` **deflateRaw**: [DeflateFunction](_types_d_.deflatefunction.md) -*Defined in [src/types.d.ts:412](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L412)* +*Defined in [src/types.d.ts:412](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L412)* In a browser runtime you have to provide an implementation for Deflate Raw when you will be producing JWEs with compressed plaintext. diff --git a/docs/interfaces/_types_d_.flatteneddecryptresult.md b/docs/interfaces/_types_d_.flatteneddecryptresult.md index be1e695258..95ac0dea92 100644 --- a/docs/interfaces/_types_d_.flatteneddecryptresult.md +++ b/docs/interfaces/_types_d_.flatteneddecryptresult.md @@ -16,7 +16,7 @@ • `Optional` **additionalAuthenticatedData**: Uint8Array -*Defined in [src/types.d.ts:538](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L538)* +*Defined in [src/types.d.ts:538](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L538)* JWE AAD. @@ -26,7 +26,7 @@ ___ • **plaintext**: Uint8Array -*Defined in [src/types.d.ts:543](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L543)* +*Defined in [src/types.d.ts:543](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L543)* Plaintext. @@ -36,7 +36,7 @@ ___ • `Optional` **protectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:548](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L548)* +*Defined in [src/types.d.ts:548](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L548)* JWE Protected Header. @@ -46,7 +46,7 @@ ___ • `Optional` **sharedUnprotectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:553](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L553)* +*Defined in [src/types.d.ts:553](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L553)* JWE Shared Unprotected Header. @@ -56,6 +56,6 @@ ___ • `Optional` **unprotectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:558](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L558)* +*Defined in [src/types.d.ts:558](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L558)* JWE Per-Recipient Unprotected Header. diff --git a/docs/interfaces/_types_d_.flattenedjwe.md b/docs/interfaces/_types_d_.flattenedjwe.md index 408b4dacb3..7826a1e7ff 100644 --- a/docs/interfaces/_types_d_.flattenedjwe.md +++ b/docs/interfaces/_types_d_.flattenedjwe.md @@ -21,7 +21,7 @@ Flattened JWE definition. • `Optional` **aad**: string -*Defined in [src/types.d.ts:262](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L262)* +*Defined in [src/types.d.ts:262](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L262)* The "aad" member MUST be present and contain the value BASE64URL(JWE AAD)) when the JWE AAD value is non-empty; @@ -35,7 +35,7 @@ ___ • **ciphertext**: string -*Defined in [src/types.d.ts:268](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L268)* +*Defined in [src/types.d.ts:268](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L268)* The "ciphertext" member MUST be present and contain the value BASE64URL(JWE Ciphertext). @@ -46,7 +46,7 @@ ___ • `Optional` **encrypted\_key**: string -*Defined in [src/types.d.ts:275](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L275)* +*Defined in [src/types.d.ts:275](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L275)* The "encrypted_key" member MUST be present and contain the value BASE64URL(JWE Encrypted Key) when the JWE Encrypted Key value is @@ -58,7 +58,7 @@ ___ • `Optional` **header**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:285](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L285)* +*Defined in [src/types.d.ts:285](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L285)* The "header" member MUST be present and contain the value JWE Per- Recipient Unprotected Header when the JWE Per-Recipient @@ -73,7 +73,7 @@ ___ • **iv**: string -*Defined in [src/types.d.ts:292](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L292)* +*Defined in [src/types.d.ts:292](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L292)* The "iv" member MUST be present and contain the value BASE64URL(JWE Initialization Vector) when the JWE Initialization @@ -85,7 +85,7 @@ ___ • `Optional` **protected**: string -*Defined in [src/types.d.ts:300](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L300)* +*Defined in [src/types.d.ts:300](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L300)* The "protected" member MUST be present and contain the value BASE64URL(UTF8(JWE Protected Header)) when the JWE Protected @@ -98,7 +98,7 @@ ___ • **tag**: string -*Defined in [src/types.d.ts:307](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L307)* +*Defined in [src/types.d.ts:307](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L307)* The "tag" member MUST be present and contain the value BASE64URL(JWE Authentication Tag) when the JWE Authentication Tag @@ -110,7 +110,7 @@ ___ • `Optional` **unprotected**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:316](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L316)* +*Defined in [src/types.d.ts:316](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L316)* The "unprotected" member MUST be present and contain the value JWE Shared Unprotected Header when the JWE Shared Unprotected Header diff --git a/docs/interfaces/_types_d_.flattenedjws.md b/docs/interfaces/_types_d_.flattenedjws.md index 5734318214..3e7c104df8 100644 --- a/docs/interfaces/_types_d_.flattenedjws.md +++ b/docs/interfaces/_types_d_.flattenedjws.md @@ -17,7 +17,7 @@ is not returned when JWS Unencoded Payload Option • `Optional` **payload**: string -*Defined in [src/types.d.ts:160](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L160)* +*Defined in [src/types.d.ts:160](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L160)* ___ @@ -25,4 +25,4 @@ ___ • **signature**: string -*Defined in [src/types.d.ts:161](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L161)* +*Defined in [src/types.d.ts:161](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L161)* diff --git a/docs/interfaces/_types_d_.flattenedjwsinput.md b/docs/interfaces/_types_d_.flattenedjwsinput.md index a7a43196bc..c843d51d7e 100644 --- a/docs/interfaces/_types_d_.flattenedjwsinput.md +++ b/docs/interfaces/_types_d_.flattenedjwsinput.md @@ -18,7 +18,7 @@ Uint8Array for detached signature validation. • `Optional` **header**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:110](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L110)* +*Defined in [src/types.d.ts:110](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L110)* The "header" member MUST be present and contain the value JWS Unprotected Header when the JWS Unprotected Header value is non- @@ -32,7 +32,7 @@ ___ • **payload**: string \| Uint8Array -*Defined in [src/types.d.ts:117](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L117)* +*Defined in [src/types.d.ts:117](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L117)* The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When RFC7797 "b64": false is used @@ -44,7 +44,7 @@ ___ • `Optional` **protected**: string -*Defined in [src/types.d.ts:125](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L125)* +*Defined in [src/types.d.ts:125](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L125)* The "protected" member MUST be present and contain the value BASE64URL(UTF8(JWS Protected Header)) when the JWS Protected @@ -57,7 +57,7 @@ ___ • **signature**: string -*Defined in [src/types.d.ts:131](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L131)* +*Defined in [src/types.d.ts:131](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L131)* The "signature" member MUST be present and contain the value BASE64URL(JWS Signature). diff --git a/docs/interfaces/_types_d_.flattenedverifyresult.md b/docs/interfaces/_types_d_.flattenedverifyresult.md index ca4d74a223..81ed48052c 100644 --- a/docs/interfaces/_types_d_.flattenedverifyresult.md +++ b/docs/interfaces/_types_d_.flattenedverifyresult.md @@ -14,7 +14,7 @@ • **payload**: Uint8Array -*Defined in [src/types.d.ts:579](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L579)* +*Defined in [src/types.d.ts:579](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L579)* JWS Payload. @@ -24,7 +24,7 @@ ___ • `Optional` **protectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:584](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L584)* +*Defined in [src/types.d.ts:584](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L584)* JWS Protected Header. @@ -34,6 +34,6 @@ ___ • `Optional` **unprotectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:589](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L589)* +*Defined in [src/types.d.ts:589](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L589)* JWS Unprotected Header. diff --git a/docs/interfaces/_types_d_.generaldecryptresult.md b/docs/interfaces/_types_d_.generaldecryptresult.md index ccc275cea0..db549e0dd7 100644 --- a/docs/interfaces/_types_d_.generaldecryptresult.md +++ b/docs/interfaces/_types_d_.generaldecryptresult.md @@ -16,7 +16,7 @@ • `Optional` **additionalAuthenticatedData**: Uint8Array -*Defined in [src/types.d.ts:538](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L538)* +*Defined in [src/types.d.ts:538](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L538)* JWE AAD. @@ -26,7 +26,7 @@ ___ • **plaintext**: Uint8Array -*Defined in [src/types.d.ts:543](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L543)* +*Defined in [src/types.d.ts:543](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L543)* Plaintext. @@ -36,7 +36,7 @@ ___ • `Optional` **protectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:548](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L548)* +*Defined in [src/types.d.ts:548](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L548)* JWE Protected Header. @@ -46,7 +46,7 @@ ___ • `Optional` **sharedUnprotectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:553](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L553)* +*Defined in [src/types.d.ts:553](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L553)* JWE Shared Unprotected Header. @@ -56,6 +56,6 @@ ___ • `Optional` **unprotectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:558](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L558)* +*Defined in [src/types.d.ts:558](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L558)* JWE Per-Recipient Unprotected Header. diff --git a/docs/interfaces/_types_d_.generaljwe.md b/docs/interfaces/_types_d_.generaljwe.md index aed4a06950..c629056d72 100644 --- a/docs/interfaces/_types_d_.generaljwe.md +++ b/docs/interfaces/_types_d_.generaljwe.md @@ -12,4 +12,4 @@ • **recipients**: Pick<[FlattenedJWE](_types_d_.flattenedjwe.md), \"encrypted\_key\" \| \"header\"\>[] -*Defined in [src/types.d.ts:320](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L320)* +*Defined in [src/types.d.ts:320](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L320)* diff --git a/docs/interfaces/_types_d_.generaljws.md b/docs/interfaces/_types_d_.generaljws.md index ad699da359..4c0abe83b4 100644 --- a/docs/interfaces/_types_d_.generaljws.md +++ b/docs/interfaces/_types_d_.generaljws.md @@ -17,7 +17,7 @@ is not returned when JWS Unencoded Payload Option • `Optional` **payload**: string -*Defined in [src/types.d.ts:170](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L170)* +*Defined in [src/types.d.ts:170](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L170)* ___ @@ -25,4 +25,4 @@ ___ • **signatures**: Omit<[FlattenedJWSInput](_types_d_.flattenedjwsinput.md), \"payload\"\>[] -*Defined in [src/types.d.ts:171](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L171)* +*Defined in [src/types.d.ts:171](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L171)* diff --git a/docs/interfaces/_types_d_.generaljwsinput.md b/docs/interfaces/_types_d_.generaljwsinput.md index 59e1225db3..e862f1a84d 100644 --- a/docs/interfaces/_types_d_.generaljwsinput.md +++ b/docs/interfaces/_types_d_.generaljwsinput.md @@ -16,7 +16,7 @@ Uint8Array for detached signature validation. • **payload**: string \| Uint8Array -*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L144)* +*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L144)* The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When RFC7797 "b64": false is used @@ -28,7 +28,7 @@ ___ • **signatures**: Omit<[FlattenedJWSInput](_types_d_.flattenedjwsinput.md), \"payload\"\>[] -*Defined in [src/types.d.ts:151](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L151)* +*Defined in [src/types.d.ts:151](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L151)* The "signatures" member value MUST be an array of JSON objects. Each object represents a signature or MAC over the JWS Payload and diff --git a/docs/interfaces/_types_d_.generalverifyresult.md b/docs/interfaces/_types_d_.generalverifyresult.md index c54ccb51a5..7394ca4891 100644 --- a/docs/interfaces/_types_d_.generalverifyresult.md +++ b/docs/interfaces/_types_d_.generalverifyresult.md @@ -14,7 +14,7 @@ • **payload**: Uint8Array -*Defined in [src/types.d.ts:579](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L579)* +*Defined in [src/types.d.ts:579](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L579)* JWS Payload. @@ -24,7 +24,7 @@ ___ • `Optional` **protectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:584](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L584)* +*Defined in [src/types.d.ts:584](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L584)* JWS Protected Header. @@ -34,6 +34,6 @@ ___ • `Optional` **unprotectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:589](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L589)* +*Defined in [src/types.d.ts:589](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L589)* JWS Unprotected Header. diff --git a/docs/interfaces/_types_d_.getkeyfunction.md b/docs/interfaces/_types_d_.getkeyfunction.md index dc9b0d347d..ffabf285c2 100644 --- a/docs/interfaces/_types_d_.getkeyfunction.md +++ b/docs/interfaces/_types_d_.getkeyfunction.md @@ -16,7 +16,7 @@ Name | ▸ (`protectedHeader`: T, `token`: T2): Promise<[KeyLike](../types/_types_d_.keylike.md)\> -*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L79)* +*Defined in [src/types.d.ts:79](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L79)* Generic Interface for consuming operations dynamic key resolution. No token components have been verified at the time of this function call. diff --git a/docs/interfaces/_types_d_.inflatefunction.md b/docs/interfaces/_types_d_.inflatefunction.md index 4733cc81e4..2d8dd955fb 100644 --- a/docs/interfaces/_types_d_.inflatefunction.md +++ b/docs/interfaces/_types_d_.inflatefunction.md @@ -6,7 +6,7 @@ Inflate Raw implementation, e.g. promisified [zlib.inflateRaw](https://nodejs.or ▸ (`input`: Uint8Array): Promise -*Defined in [src/types.d.ts:530](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L530)* +*Defined in [src/types.d.ts:530](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L530)* Inflate Raw implementation, e.g. promisified [zlib.inflateRaw](https://nodejs.org/api/zlib.html#zlib_zlib_inflateraw_buffer_options_callback). diff --git a/docs/interfaces/_types_d_.joseheaderparameters.md b/docs/interfaces/_types_d_.joseheaderparameters.md index 2d79f8c071..c63420488b 100644 --- a/docs/interfaces/_types_d_.joseheaderparameters.md +++ b/docs/interfaces/_types_d_.joseheaderparameters.md @@ -18,7 +18,7 @@ • `Optional` **cty**: string -*Defined in [src/types.d.ts:208](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L208)* +*Defined in [src/types.d.ts:208](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L208)* "cty" (Content Type) Header Parameter. @@ -28,7 +28,7 @@ ___ • `Optional` **jwk**: Pick<[JWK](_types_d_.jwk.md), \"kty\" \| \"crv\" \| \"x\" \| \"y\" \| \"e\" \| \"n\"\> -*Defined in [src/types.d.ts:198](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L198)* +*Defined in [src/types.d.ts:198](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L198)* "jwk" (JSON Web Key) Header Parameter. @@ -38,7 +38,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:178](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L178)* +*Defined in [src/types.d.ts:178](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L178)* "kid" (Key ID) Header Parameter. @@ -48,7 +48,7 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:203](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L203)* +*Defined in [src/types.d.ts:203](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L203)* "typ" (Type) Header Parameter. @@ -58,7 +58,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:188](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L188)* +*Defined in [src/types.d.ts:188](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L188)* "x5c" (X.509 Certificate Chain) Header Parameter. @@ -68,7 +68,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:183](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L183)* +*Defined in [src/types.d.ts:183](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L183)* "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. @@ -78,6 +78,6 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:193](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L193)* +*Defined in [src/types.d.ts:193](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L193)* "x5u" (X.509 URL) Header Parameter. diff --git a/docs/interfaces/_types_d_.jweheaderparameters.md b/docs/interfaces/_types_d_.jweheaderparameters.md index 4518973578..f9faa65508 100644 --- a/docs/interfaces/_types_d_.jweheaderparameters.md +++ b/docs/interfaces/_types_d_.jweheaderparameters.md @@ -31,7 +31,7 @@ Any other JWE Header member. • `Optional` **alg**: string -*Defined in [src/types.d.ts:331](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L331)* +*Defined in [src/types.d.ts:331](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L331)* JWE "alg" (Algorithm) Header Parameter. @@ -41,7 +41,7 @@ ___ • `Optional` **crit**: string[] -*Defined in [src/types.d.ts:341](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L341)* +*Defined in [src/types.d.ts:341](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L341)* JWE "crit" (Critical) Header Parameter. @@ -51,7 +51,7 @@ ___ • `Optional` **cty**: string -*Defined in [src/types.d.ts:208](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L208)* +*Defined in [src/types.d.ts:208](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L208)* "cty" (Content Type) Header Parameter. @@ -61,7 +61,7 @@ ___ • `Optional` **enc**: string -*Defined in [src/types.d.ts:336](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L336)* +*Defined in [src/types.d.ts:336](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L336)* JWE "enc" (Encryption Algorithm) Header Parameter. @@ -71,7 +71,7 @@ ___ • `Optional` **jwk**: Pick<[JWK](_types_d_.jwk.md), \"kty\" \| \"crv\" \| \"x\" \| \"y\" \| \"e\" \| \"n\"\> -*Defined in [src/types.d.ts:198](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L198)* +*Defined in [src/types.d.ts:198](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L198)* "jwk" (JSON Web Key) Header Parameter. @@ -81,7 +81,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:178](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L178)* +*Defined in [src/types.d.ts:178](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L178)* "kid" (Key ID) Header Parameter. @@ -91,7 +91,7 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:203](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L203)* +*Defined in [src/types.d.ts:203](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L203)* "typ" (Type) Header Parameter. @@ -101,7 +101,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:188](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L188)* +*Defined in [src/types.d.ts:188](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L188)* "x5c" (X.509 Certificate Chain) Header Parameter. @@ -111,7 +111,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:183](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L183)* +*Defined in [src/types.d.ts:183](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L183)* "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. @@ -121,7 +121,7 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:193](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L193)* +*Defined in [src/types.d.ts:193](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L193)* "x5u" (X.509 URL) Header Parameter. @@ -131,6 +131,6 @@ ___ • `Optional` **zip**: string -*Defined in [src/types.d.ts:346](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L346)* +*Defined in [src/types.d.ts:346](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L346)* JWE "zip" (Compression Algorithm) Header Parameter. diff --git a/docs/interfaces/_types_d_.jwekeymanagementheaderparameters.md b/docs/interfaces/_types_d_.jwekeymanagementheaderparameters.md index c05f8f5d44..3c2c16326c 100644 --- a/docs/interfaces/_types_d_.jwekeymanagementheaderparameters.md +++ b/docs/interfaces/_types_d_.jwekeymanagementheaderparameters.md @@ -19,7 +19,7 @@ Recognized JWE Key Management-related Header Parameters. • `Optional` **apu**: Uint8Array -*Defined in [src/types.d.ts:243](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L243)* +*Defined in [src/types.d.ts:243](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L243)* ___ @@ -27,7 +27,7 @@ ___ • `Optional` **apv**: Uint8Array -*Defined in [src/types.d.ts:244](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L244)* +*Defined in [src/types.d.ts:244](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L244)* ___ @@ -35,7 +35,7 @@ ___ • `Optional` **epk**: [KeyLike](../types/_types_d_.keylike.md) -*Defined in [src/types.d.ts:245](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L245)* +*Defined in [src/types.d.ts:245](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L245)* ___ @@ -43,7 +43,7 @@ ___ • `Optional` **iv**: Uint8Array -*Defined in [src/types.d.ts:246](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L246)* +*Defined in [src/types.d.ts:246](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L246)* ___ @@ -51,7 +51,7 @@ ___ • `Optional` **p2c**: number -*Defined in [src/types.d.ts:247](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L247)* +*Defined in [src/types.d.ts:247](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L247)* ___ @@ -59,4 +59,4 @@ ___ • `Optional` **p2s**: Uint8Array -*Defined in [src/types.d.ts:248](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L248)* +*Defined in [src/types.d.ts:248](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L248)* diff --git a/docs/interfaces/_types_d_.jwk.md b/docs/interfaces/_types_d_.jwk.md index b099bd3ee3..9892e216f9 100644 --- a/docs/interfaces/_types_d_.jwk.md +++ b/docs/interfaces/_types_d_.jwk.md @@ -37,7 +37,7 @@ JSON Web Key ([JWK](https://tools.ietf.org/html/rfc7517)). • `Optional` **alg**: string -*Defined in [src/types.d.ts:14](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L14)* +*Defined in [src/types.d.ts:14](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L14)* JWK "alg" (Algorithm) Parameter. @@ -47,7 +47,7 @@ ___ • `Optional` **crv**: string -*Defined in [src/types.d.ts:15](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L15)* +*Defined in [src/types.d.ts:15](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L15)* ___ @@ -55,7 +55,7 @@ ___ • `Optional` **d**: string -*Defined in [src/types.d.ts:16](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L16)* +*Defined in [src/types.d.ts:16](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L16)* ___ @@ -63,7 +63,7 @@ ___ • `Optional` **dp**: string -*Defined in [src/types.d.ts:17](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L17)* +*Defined in [src/types.d.ts:17](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L17)* ___ @@ -71,7 +71,7 @@ ___ • `Optional` **dq**: string -*Defined in [src/types.d.ts:18](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L18)* +*Defined in [src/types.d.ts:18](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L18)* ___ @@ -79,7 +79,7 @@ ___ • `Optional` **e**: string -*Defined in [src/types.d.ts:19](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L19)* +*Defined in [src/types.d.ts:19](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L19)* ___ @@ -87,7 +87,7 @@ ___ • `Optional` **ext**: false \| true -*Defined in [src/types.d.ts:23](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L23)* +*Defined in [src/types.d.ts:23](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L23)* JWK "ext" (Extractable) Parameter. @@ -97,7 +97,7 @@ ___ • `Optional` **k**: string -*Defined in [src/types.d.ts:24](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L24)* +*Defined in [src/types.d.ts:24](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L24)* ___ @@ -105,7 +105,7 @@ ___ • `Optional` **key\_ops**: string[] -*Defined in [src/types.d.ts:28](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L28)* +*Defined in [src/types.d.ts:28](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L28)* JWK "key_ops" (Key Operations) Parameter. @@ -115,7 +115,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:32](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L32)* +*Defined in [src/types.d.ts:32](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L32)* JWK "kid" (Key ID) Parameter. @@ -125,7 +125,7 @@ ___ • `Optional` **kty**: string -*Defined in [src/types.d.ts:36](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L36)* +*Defined in [src/types.d.ts:36](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L36)* JWK "kty" (Key Type) Parameter. @@ -135,7 +135,7 @@ ___ • `Optional` **n**: string -*Defined in [src/types.d.ts:37](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L37)* +*Defined in [src/types.d.ts:37](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L37)* ___ @@ -143,7 +143,7 @@ ___ • `Optional` **oth**: Array<{ d?: string ; r?: string ; t?: string }\> -*Defined in [src/types.d.ts:38](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L38)* +*Defined in [src/types.d.ts:38](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L38)* ___ @@ -151,7 +151,7 @@ ___ • `Optional` **p**: string -*Defined in [src/types.d.ts:43](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L43)* +*Defined in [src/types.d.ts:43](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L43)* ___ @@ -159,7 +159,7 @@ ___ • `Optional` **q**: string -*Defined in [src/types.d.ts:44](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L44)* +*Defined in [src/types.d.ts:44](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L44)* ___ @@ -167,7 +167,7 @@ ___ • `Optional` **qi**: string -*Defined in [src/types.d.ts:45](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L45)* +*Defined in [src/types.d.ts:45](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L45)* ___ @@ -175,7 +175,7 @@ ___ • `Optional` **use**: string -*Defined in [src/types.d.ts:49](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L49)* +*Defined in [src/types.d.ts:49](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L49)* JWK "use" (Public Key Use) Parameter. @@ -185,7 +185,7 @@ ___ • `Optional` **x**: string -*Defined in [src/types.d.ts:50](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L50)* +*Defined in [src/types.d.ts:50](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L50)* ___ @@ -193,7 +193,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:55](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L55)* +*Defined in [src/types.d.ts:55](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L55)* JWK "x5c" (X.509 Certificate Chain) Parameter. @@ -203,7 +203,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:59](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L59)* +*Defined in [src/types.d.ts:59](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L59)* JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. @@ -213,7 +213,7 @@ ___ • `Optional` **x5t#S256**: string -*Defined in [src/types.d.ts:63](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L63)* +*Defined in [src/types.d.ts:63](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L63)* "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. @@ -223,7 +223,7 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:67](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L67)* +*Defined in [src/types.d.ts:67](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L67)* JWK "x5u" (X.509 URL) Parameter. @@ -233,4 +233,4 @@ ___ • `Optional` **y**: string -*Defined in [src/types.d.ts:51](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L51)* +*Defined in [src/types.d.ts:51](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L51)* diff --git a/docs/interfaces/_types_d_.jwsheaderparameters.md b/docs/interfaces/_types_d_.jwsheaderparameters.md index 4bfe189ea5..e7e2f04fb1 100644 --- a/docs/interfaces/_types_d_.jwsheaderparameters.md +++ b/docs/interfaces/_types_d_.jwsheaderparameters.md @@ -30,7 +30,7 @@ Any other JWS Header member. • `Optional` **alg**: string -*Defined in [src/types.d.ts:219](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L219)* +*Defined in [src/types.d.ts:219](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L219)* JWS "alg" (Algorithm) Header Parameter. @@ -40,7 +40,7 @@ ___ • `Optional` **b64**: false \| true -*Defined in [src/types.d.ts:226](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L226)* +*Defined in [src/types.d.ts:226](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L226)* This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing Input computation as per @@ -52,7 +52,7 @@ ___ • `Optional` **crit**: string[] -*Defined in [src/types.d.ts:231](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L231)* +*Defined in [src/types.d.ts:231](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L231)* JWS "crit" (Critical) Header Parameter. @@ -62,7 +62,7 @@ ___ • `Optional` **cty**: string -*Defined in [src/types.d.ts:208](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L208)* +*Defined in [src/types.d.ts:208](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L208)* "cty" (Content Type) Header Parameter. @@ -72,7 +72,7 @@ ___ • `Optional` **jwk**: Pick<[JWK](_types_d_.jwk.md), \"kty\" \| \"crv\" \| \"x\" \| \"y\" \| \"e\" \| \"n\"\> -*Defined in [src/types.d.ts:198](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L198)* +*Defined in [src/types.d.ts:198](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L198)* "jwk" (JSON Web Key) Header Parameter. @@ -82,7 +82,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:178](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L178)* +*Defined in [src/types.d.ts:178](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L178)* "kid" (Key ID) Header Parameter. @@ -92,7 +92,7 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:203](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L203)* +*Defined in [src/types.d.ts:203](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L203)* "typ" (Type) Header Parameter. @@ -102,7 +102,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:188](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L188)* +*Defined in [src/types.d.ts:188](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L188)* "x5c" (X.509 Certificate Chain) Header Parameter. @@ -112,7 +112,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:183](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L183)* +*Defined in [src/types.d.ts:183](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L183)* "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. @@ -122,6 +122,6 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:193](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L193)* +*Defined in [src/types.d.ts:193](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L193)* "x5u" (X.509 URL) Header Parameter. diff --git a/docs/interfaces/_types_d_.jwtclaimverificationoptions.md b/docs/interfaces/_types_d_.jwtclaimverificationoptions.md index 095e14f275..cd5383d666 100644 --- a/docs/interfaces/_types_d_.jwtclaimverificationoptions.md +++ b/docs/interfaces/_types_d_.jwtclaimverificationoptions.md @@ -20,7 +20,7 @@ JWT Claims Set verification options. • `Optional` **audience**: string \| string[] -*Defined in [src/types.d.ts:422](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L422)* +*Defined in [src/types.d.ts:422](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L422)* Expected JWT "aud" (Audience) Claim value(s). @@ -30,7 +30,7 @@ ___ • `Optional` **clockTolerance**: string \| number -*Defined in [src/types.d.ts:429](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L429)* +*Defined in [src/types.d.ts:429](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L429)* Expected clock tolerance - in seconds when number (e.g. 5) @@ -42,7 +42,7 @@ ___ • `Optional` **currentDate**: Date -*Defined in [src/types.d.ts:456](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L456)* +*Defined in [src/types.d.ts:456](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L456)* Date to use when comparing NumericDate claims, defaults to `new Date()`. @@ -52,7 +52,7 @@ ___ • `Optional` **issuer**: string \| string[] -*Defined in [src/types.d.ts:434](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L434)* +*Defined in [src/types.d.ts:434](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L434)* Expected JWT "iss" (Issuer) Claim value(s). @@ -62,7 +62,7 @@ ___ • `Optional` **maxTokenAge**: string \| number -*Defined in [src/types.d.ts:441](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L441)* +*Defined in [src/types.d.ts:441](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L441)* Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. - in seconds when number (e.g. 5) @@ -74,7 +74,7 @@ ___ • `Optional` **subject**: string -*Defined in [src/types.d.ts:446](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L446)* +*Defined in [src/types.d.ts:446](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L446)* Expected JWT "sub" (Subject) Claim value. @@ -84,6 +84,6 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:451](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L451)* +*Defined in [src/types.d.ts:451](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L451)* Expected JWT "typ" (Type) Header Parameter value. diff --git a/docs/interfaces/_types_d_.jwtdecryptresult.md b/docs/interfaces/_types_d_.jwtdecryptresult.md index a12047c3cd..6e5882c1ca 100644 --- a/docs/interfaces/_types_d_.jwtdecryptresult.md +++ b/docs/interfaces/_types_d_.jwtdecryptresult.md @@ -13,7 +13,7 @@ • **payload**: [JWTPayload](_types_d_.jwtpayload.md) -*Defined in [src/types.d.ts:622](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L622)* +*Defined in [src/types.d.ts:622](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L622)* JWT Claims Set. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:627](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L627)* +*Defined in [src/types.d.ts:627](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L627)* JWE Protected Header. diff --git a/docs/interfaces/_types_d_.jwtpayload.md b/docs/interfaces/_types_d_.jwtpayload.md index 57c5f12181..7d894f43a2 100644 --- a/docs/interfaces/_types_d_.jwtpayload.md +++ b/docs/interfaces/_types_d_.jwtpayload.md @@ -27,7 +27,7 @@ Any other JWT Claim Set member. • `Optional` **aud**: string \| string[] -*Defined in [src/types.d.ts:492](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L492)* +*Defined in [src/types.d.ts:492](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L492)* JWT Audience [RFC7519#section-4.1.3](https://tools.ietf.org/html/rfc7519#section-4.1.3). @@ -37,7 +37,7 @@ ___ • `Optional` **exp**: number -*Defined in [src/types.d.ts:507](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L507)* +*Defined in [src/types.d.ts:507](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L507)* JWT Expiration Time - [RFC7519#section-4.1.4](https://tools.ietf.org/html/rfc7519#section-4.1.4). @@ -47,7 +47,7 @@ ___ • `Optional` **iat**: number -*Defined in [src/types.d.ts:512](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L512)* +*Defined in [src/types.d.ts:512](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L512)* JWT Issued At - [RFC7519#section-4.1.6](https://tools.ietf.org/html/rfc7519#section-4.1.6). @@ -57,7 +57,7 @@ ___ • `Optional` **iss**: string -*Defined in [src/types.d.ts:482](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L482)* +*Defined in [src/types.d.ts:482](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L482)* JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1). @@ -67,7 +67,7 @@ ___ • `Optional` **jti**: string -*Defined in [src/types.d.ts:497](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L497)* +*Defined in [src/types.d.ts:497](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L497)* JWT ID - [RFC7519#section-4.1.7](https://tools.ietf.org/html/rfc7519#section-4.1.7). @@ -77,7 +77,7 @@ ___ • `Optional` **nbf**: number -*Defined in [src/types.d.ts:502](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L502)* +*Defined in [src/types.d.ts:502](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L502)* JWT Not Before - [RFC7519#section-4.1.5](https://tools.ietf.org/html/rfc7519#section-4.1.5). @@ -87,6 +87,6 @@ ___ • `Optional` **sub**: string -*Defined in [src/types.d.ts:487](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L487)* +*Defined in [src/types.d.ts:487](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L487)* JWT Subject - [RFC7519#section-4.1.2](https://tools.ietf.org/html/rfc7519#section-4.1.2). diff --git a/docs/interfaces/_types_d_.jwtverifyresult.md b/docs/interfaces/_types_d_.jwtverifyresult.md index 0db124cad0..bdffd9abe5 100644 --- a/docs/interfaces/_types_d_.jwtverifyresult.md +++ b/docs/interfaces/_types_d_.jwtverifyresult.md @@ -13,7 +13,7 @@ • **payload**: [JWTPayload](_types_d_.jwtpayload.md) -*Defined in [src/types.d.ts:610](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L610)* +*Defined in [src/types.d.ts:610](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L610)* JWT Claims Set. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:615](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L615)* +*Defined in [src/types.d.ts:615](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L615)* JWS Protected Header. diff --git a/docs/interfaces/_types_d_.signoptions.md b/docs/interfaces/_types_d_.signoptions.md index f9d4bf4d7c..defbba18f7 100644 --- a/docs/interfaces/_types_d_.signoptions.md +++ b/docs/interfaces/_types_d_.signoptions.md @@ -14,7 +14,7 @@ JWS Signing options. • `Optional` **crit**: { [propName:string]: boolean; } -*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L378)* +*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L378)* An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either `true` or `false`. `true` when the diff --git a/docs/interfaces/_types_d_.verifyoptions.md b/docs/interfaces/_types_d_.verifyoptions.md index 1f15e2c3fc..0e85dd281d 100644 --- a/docs/interfaces/_types_d_.verifyoptions.md +++ b/docs/interfaces/_types_d_.verifyoptions.md @@ -15,7 +15,7 @@ JWS Verification options. • `Optional` **algorithms**: string[] -*Defined in [src/types.d.ts:466](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L466)* +*Defined in [src/types.d.ts:466](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L466)* A list of accepted JWS "alg" (Algorithm) Header Parameter values. @@ -25,7 +25,7 @@ ___ • `Optional` **crit**: { [propName:string]: boolean; } -*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L378)* +*Defined in [src/types.d.ts:378](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L378)* An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either `true` or `false`. `true` when the diff --git a/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md b/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md index c1512a3ac7..26935cb83a 100644 --- a/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md +++ b/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md @@ -13,7 +13,7 @@ • `Optional` **crv**: string -*Defined in [src/util/generate_key_pair.ts:10](https://github.com/panva/jose/blob/v3.7.0/src/util/generate_key_pair.ts#L10)* +*Defined in [src/util/generate_key_pair.ts:10](https://github.com/panva/jose/blob/v3.7.1/src/util/generate_key_pair.ts#L10)* The EC "crv" (Curve) or OKP "crv" (Subtype of Key Pair) value to generate. The curve must be both supported on the runtime as well as applicable for @@ -25,7 +25,7 @@ ___ • `Optional` **modulusLength**: number -*Defined in [src/util/generate_key_pair.ts:16](https://github.com/panva/jose/blob/v3.7.0/src/util/generate_key_pair.ts#L16)* +*Defined in [src/util/generate_key_pair.ts:16](https://github.com/panva/jose/blob/v3.7.1/src/util/generate_key_pair.ts#L16)* A hint for RSA algorithms to generate an RSA key of a given `modulusLength` (Key size in bits). JOSE requires 2048 bits or larger. Default is 2048. diff --git a/docs/types/_types_d_.keylike.md b/docs/types/_types_d_.keylike.md index 51f285a71d..a93c13e4e8 100644 --- a/docs/types/_types_d_.keylike.md +++ b/docs/types/_types_d_.keylike.md @@ -2,7 +2,7 @@ Ƭ **KeyLike**: KeyObject \| CryptoKey \| Uint8Array -*Defined in [src/types.d.ts:96](https://github.com/panva/jose/blob/v3.7.0/src/types.d.ts#L96)* +*Defined in [src/types.d.ts:96](https://github.com/panva/jose/blob/v3.7.1/src/types.d.ts#L96)* KeyLike are platform-specific references to keying material. diff --git a/docs/types/_util_decode_protected_header_.protectedheaderparameters.md b/docs/types/_util_decode_protected_header_.protectedheaderparameters.md index a7126a236e..bd9845265a 100644 --- a/docs/types/_util_decode_protected_header_.protectedheaderparameters.md +++ b/docs/types/_util_decode_protected_header_.protectedheaderparameters.md @@ -2,4 +2,4 @@ Ƭ **ProtectedHeaderParameters**: [JWSHeaderParameters](../interfaces/_types_d_.jwsheaderparameters.md) & [JWEHeaderParameters](../interfaces/_types_d_.jweheaderparameters.md) -*Defined in [src/util/decode_protected_header.ts:8](https://github.com/panva/jose/blob/v3.7.0/src/util/decode_protected_header.ts#L8)* +*Defined in [src/util/decode_protected_header.ts:8](https://github.com/panva/jose/blob/v3.7.1/src/util/decode_protected_header.ts#L8)* diff --git a/docs/variables/_util_base64url_.decode.md b/docs/variables/_util_base64url_.decode.md index e6f6b6a5c3..f9e705ee15 100644 --- a/docs/variables/_util_base64url_.decode.md +++ b/docs/variables/_util_base64url_.decode.md @@ -2,4 +2,4 @@ • `Const` **decode**: Base64UrlDecode = base64url.decode -*Defined in [src/util/base64url.ts:23](https://github.com/panva/jose/blob/v3.7.0/src/util/base64url.ts#L23)* +*Defined in [src/util/base64url.ts:23](https://github.com/panva/jose/blob/v3.7.1/src/util/base64url.ts#L23)* diff --git a/docs/variables/_util_base64url_.encode.md b/docs/variables/_util_base64url_.encode.md index a57cd4a144..7622bd429f 100644 --- a/docs/variables/_util_base64url_.encode.md +++ b/docs/variables/_util_base64url_.encode.md @@ -2,4 +2,4 @@ • `Const` **encode**: Base64UrlEncode = base64url.encode -*Defined in [src/util/base64url.ts:22](https://github.com/panva/jose/blob/v3.7.0/src/util/base64url.ts#L22)* +*Defined in [src/util/base64url.ts:22](https://github.com/panva/jose/blob/v3.7.1/src/util/base64url.ts#L22)* diff --git a/package.json b/package.json index 5aae165670..e4648d27d6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jose", - "version": "3.7.0", + "version": "3.7.1", "description": "Universal 'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK with no dependencies", "keywords": [ "browser",