From 076eea11bb6e3f9e284663e53923747a2a6f6c3e Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Sat, 14 Nov 2020 18:28:54 +0100 Subject: [PATCH] chore(release): 3.0.0 --- CHANGELOG.md | 15 ++++++ .../_jwe_compact_encrypt_.compactencrypt.md | 12 ++--- ...jwe_flattened_encrypt_.flattenedencrypt.md | 18 ++++---- .../classes/_jws_compact_sign_.compactsign.md | 6 +-- .../_jws_flattened_sign_.flattenedsign.md | 8 ++-- docs/classes/_jwt_encrypt_.encryptjwt.md | 32 ++++++------- docs/classes/_jwt_sign_.signjwt.md | 20 ++++---- docs/classes/_jwt_unsecured_.unsecuredjwt.md | 20 ++++---- .../_util_errors_.josealgnotallowed.md | 4 +- docs/classes/_util_errors_.joseerror.md | 4 +- .../classes/_util_errors_.josenotsupported.md | 4 +- .../_util_errors_.jwedecryptionfailed.md | 6 +-- docs/classes/_util_errors_.jweinvalid.md | 4 +- docs/classes/_util_errors_.jwkinvalid.md | 4 +- docs/classes/_util_errors_.jwksinvalid.md | 4 +- .../_util_errors_.jwksmultiplematchingkeys.md | 6 +-- .../_util_errors_.jwksnomatchingkey.md | 6 +-- docs/classes/_util_errors_.jwsinvalid.md | 4 +- ..._errors_.jwssignatureverificationfailed.md | 6 +-- .../_util_errors_.jwtclaimvalidationfailed.md | 8 ++-- docs/classes/_util_errors_.jwtexpired.md | 8 ++-- docs/classes/_util_errors_.jwtinvalid.md | 4 +- .../_jwe_compact_decrypt_.compactdecrypt.md | 2 +- ...jwe_flattened_decrypt_.flatteneddecrypt.md | 2 +- docs/functions/_jwk_embedded_.embeddedjwk.md | 2 +- docs/functions/_jwk_parse_.parsejwk.md | 2 +- .../_jwk_thumbprint_.calculatethumbprint.md | 2 +- .../_jwks_remote_.createremotejwkset.md | 2 +- .../_jws_compact_verify_.compactverify.md | 2 +- .../_jws_flattened_verify_.flattenedverify.md | 2 +- docs/functions/_jwt_decrypt_.jwtdecrypt.md | 2 +- docs/functions/_jwt_verify_.jwtverify.md | 2 +- ...util_generate_key_pair_.generatekeypair.md | 2 +- .../_util_generate_secret_.generatesecret.md | 2 +- ...e_compact_decrypt_.compactdecryptgetkey.md | 2 +- ...attened_decrypt_.flatteneddecryptgetkey.md | 2 +- .../_jwks_remote_.remotejwksetoptions.md | 4 +- ...jws_compact_verify_.compactverifygetkey.md | 2 +- ...flattened_verify_.flattenedverifygetkey.md | 2 +- .../_jwt_decrypt_.jwtdecryptgetkey.md | 2 +- .../_jwt_decrypt_.jwtdecryptoptions.md | 20 ++++---- .../_jwt_verify_.jwtverifygetkey.md | 2 +- .../_jwt_verify_.jwtverifyoptions.md | 16 +++---- .../_types_d_.compactdecryptresult.md | 4 +- .../_types_d_.compactverifyresult.md | 4 +- docs/interfaces/_types_d_.decryptoptions.md | 6 +-- docs/interfaces/_types_d_.deflatefunction.md | 2 +- docs/interfaces/_types_d_.encryptoptions.md | 2 +- .../_types_d_.flatteneddecryptresult.md | 10 ++-- docs/interfaces/_types_d_.flattenedjwe.md | 16 +++---- docs/interfaces/_types_d_.flattenedjws.md | 4 +- .../interfaces/_types_d_.flattenedjwsinput.md | 8 ++-- .../_types_d_.flattenedverifyresult.md | 6 +-- docs/interfaces/_types_d_.getkeyfunction.md | 2 +- docs/interfaces/_types_d_.inflatefunction.md | 2 +- .../_types_d_.joseheaderparameters.md | 14 +++--- .../_types_d_.jweheaderparameters.md | 22 ++++----- ...pes_d_.jwekeymanagementheaderparameters.md | 12 ++--- docs/interfaces/_types_d_.jwk.md | 46 +++++++++---------- .../_types_d_.jwsheaderparameters.md | 20 ++++---- .../_types_d_.jwtclaimverificationoptions.md | 14 +++--- docs/interfaces/_types_d_.jwtdecryptresult.md | 4 +- docs/interfaces/_types_d_.jwtpayload.md | 14 +++--- docs/interfaces/_types_d_.jwtverifyresult.md | 4 +- docs/interfaces/_types_d_.verifyoptions.md | 2 +- ...nerate_key_pair_.generatekeypairoptions.md | 2 +- docs/types/_types_d_.keylike.md | 2 +- package.json | 2 +- 68 files changed, 259 insertions(+), 244 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a11c33cb52..54cb6a78b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,21 @@ 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.0.0](https://github.com/panva/jose/compare/v2.0.3...v3.0.0) (2020-11-14) + + +### ⚠ BREAKING CHANGES + +* Revised, Promise-based API +* No dependencies +* Browser support (using [Web Cryptography API](https://www.w3.org/TR/WebCryptoAPI/)) +* Support for verification using a remote JWKS endpoint +* Experimental Node.js libuv thread pool based runtime (non-blocking 🎉) + +### Features + +* Revised API, No dependencies, Browser Support, Promises ([357fe0b](https://github.com/panva/jose/commit/357fe0b964903e8c84ab49f0f27ddf0447d44c84)) + ## [2.0.3](https://github.com/panva/jose/compare/v2.0.2...v2.0.3) (2020-10-29) diff --git a/docs/classes/_jwe_compact_encrypt_.compactencrypt.md b/docs/classes/_jwe_compact_encrypt_.compactencrypt.md index 63845aa87d..5a82b24f96 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.x/src/jwe/compact/encrypt.ts#L45)* +*Defined in [src/jwe/compact/encrypt.ts:45](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/compact/encrypt.ts#L108)* +*Defined in [src/jwe/compact/encrypt.ts:108](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/compact/encrypt.ts#L62)* +*Defined in [src/jwe/compact/encrypt.ts:62](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/compact/encrypt.ts#L75)* +*Defined in [src/jwe/compact/encrypt.ts:75](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/compact/encrypt.ts#L97)* +*Defined in [src/jwe/compact/encrypt.ts:97](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/compact/encrypt.ts#L85)* +*Defined in [src/jwe/compact/encrypt.ts:85](https://github.com/panva/jose/blob/v3.0.0/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 ac4a1ea4c7..29785944fc 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.x/src/jwe/flattened/encrypt.ts#L75)* +*Defined in [src/jwe/flattened/encrypt.ts:75](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L187)* +*Defined in [src/jwe/flattened/encrypt.ts:187](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L144)* +*Defined in [src/jwe/flattened/encrypt.ts:144](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L157)* +*Defined in [src/jwe/flattened/encrypt.ts:157](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L173)* +*Defined in [src/jwe/flattened/encrypt.ts:173](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L92)* +*Defined in [src/jwe/flattened/encrypt.ts:92](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L105)* +*Defined in [src/jwe/flattened/encrypt.ts:105](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L118)* +*Defined in [src/jwe/flattened/encrypt.ts:118](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwe/flattened/encrypt.ts#L131)* +*Defined in [src/jwe/flattened/encrypt.ts:131](https://github.com/panva/jose/blob/v3.0.0/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 158237c8ef..b75260aff8 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.x/src/jws/compact/sign.ts#L44)* +*Defined in [src/jws/compact/sign.ts:44](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jws/compact/sign.ts#L58)* +*Defined in [src/jws/compact/sign.ts:58](https://github.com/panva/jose/blob/v3.0.0/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)): Promise\ -*Defined in [src/jws/compact/sign.ts:68](https://github.com/panva/jose/blob/v3.x/src/jws/compact/sign.ts#L68)* +*Defined in [src/jws/compact/sign.ts:68](https://github.com/panva/jose/blob/v3.0.0/src/jws/compact/sign.ts#L68)* 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 d6f984ca1c..76589e6e09 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.x/src/jws/flattened/sign.ts#L56)* +*Defined in [src/jws/flattened/sign.ts:56](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jws/flattened/sign.ts#L70)* +*Defined in [src/jws/flattened/sign.ts:70](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jws/flattened/sign.ts#L83)* +*Defined in [src/jws/flattened/sign.ts:83](https://github.com/panva/jose/blob/v3.0.0/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)): Promise\<[FlattenedJWS](../interfaces/_types_d_.flattenedjws.md)> -*Defined in [src/jws/flattened/sign.ts:96](https://github.com/panva/jose/blob/v3.x/src/jws/flattened/sign.ts#L96)* +*Defined in [src/jws/flattened/sign.ts:96](https://github.com/panva/jose/blob/v3.0.0/src/jws/flattened/sign.ts#L96)* Signs and resolves the value of the Flattened JWS object. diff --git a/docs/classes/_jwt_encrypt_.encryptjwt.md b/docs/classes/_jwt_encrypt_.encryptjwt.md index fd9e9e8efd..90aae1dfad 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.x/src/lib/jwt_producer.ts#L10)* +*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L160)* +*Defined in [src/jwt/encrypt.ts:160](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L149)* +*Defined in [src/jwt/encrypt.ts:149](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L131)* +*Defined in [src/jwt/encrypt.ts:131](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L140)* +*Defined in [src/jwt/encrypt.ts:140](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L47)* +*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L103)* +*Defined in [src/jwt/encrypt.ts:103](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L85)* +*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L119)* +*Defined in [src/jwt/encrypt.ts:119](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L100)* +*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L27)* +*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L57)* +*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L87)* +*Defined in [src/jwt/encrypt.ts:87](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L69)* +*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/encrypt.ts#L71)* +*Defined in [src/jwt/encrypt.ts:71](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L37)* +*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.0.0/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 2e02106582..747770227a 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.x/src/lib/jwt_producer.ts#L10)* +*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L47)* +*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L85)* +*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L100)* +*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L27)* +*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L57)* +*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L69)* +*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/sign.ts#L57)* +*Defined in [src/jwt/sign.ts:57](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L37)* +*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.0.0/src/lib/jwt_producer.ts#L37)* Set "sub" (Subject) Claim. @@ -223,7 +223,7 @@ ___ ▸ **sign**(`key`: [KeyLike](../types/_types_d_.keylike.md)): Promise\ -*Defined in [src/jwt/sign.ts:67](https://github.com/panva/jose/blob/v3.x/src/jwt/sign.ts#L67)* +*Defined in [src/jwt/sign.ts:67](https://github.com/panva/jose/blob/v3.0.0/src/jwt/sign.ts#L67)* Signs and returns the JWT. diff --git a/docs/classes/_jwt_unsecured_.unsecuredjwt.md b/docs/classes/_jwt_unsecured_.unsecuredjwt.md index 1b5553a2e3..5294d22f47 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.x/src/lib/jwt_producer.ts#L10)* +*Defined in [src/lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/unsecured.ts#L55)* +*Defined in [src/jwt/unsecured.ts:55](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L47)* +*Defined in [src/lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L85)* +*Defined in [src/lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L100)* +*Defined in [src/lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L27)* +*Defined in [src/lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L57)* +*Defined in [src/lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L69)* +*Defined in [src/lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.0.0/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.x/src/lib/jwt_producer.ts#L37)* +*Defined in [src/lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.0.0/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.x/src/jwt/unsecured.ts#L77)* +*Defined in [src/jwt/unsecured.ts:77](https://github.com/panva/jose/blob/v3.0.0/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 338c8b67ee..1b40f7b0fc 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L49)* +*Defined in [src/util/errors.ts:49](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L49)* ___ diff --git a/docs/classes/_util_errors_.joseerror.md b/docs/classes/_util_errors_.joseerror.md index d986cf1df9..28d232710e 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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 4d036aa831..34a4d2c5a5 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L57)* +*Defined in [src/util/errors.ts:57](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L57)* ___ diff --git a/docs/classes/_util_errors_.jwedecryptionfailed.md b/docs/classes/_util_errors_.jwedecryptionfailed.md index 4e521a0969..59c55d5784 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L64)* +*Defined in [src/util/errors.ts:64](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L66)* +*Defined in [src/util/errors.ts:66](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L66)* ___ diff --git a/docs/classes/_util_errors_.jweinvalid.md b/docs/classes/_util_errors_.jweinvalid.md index 00b1564b60..10a35becc3 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L73)* +*Defined in [src/util/errors.ts:73](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L73)* ___ diff --git a/docs/classes/_util_errors_.jwkinvalid.md b/docs/classes/_util_errors_.jwkinvalid.md index 72e919de84..309bc5ab30 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L94)* +*Defined in [src/util/errors.ts:94](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L94)* ___ diff --git a/docs/classes/_util_errors_.jwksinvalid.md b/docs/classes/_util_errors_.jwksinvalid.md index ab78162a8d..32abc94406 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L101)* +*Defined in [src/util/errors.ts:101](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L101)* ___ diff --git a/docs/classes/_util_errors_.jwksmultiplematchingkeys.md b/docs/classes/_util_errors_.jwksmultiplematchingkeys.md index e040782d5a..a07e65e459 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L117)* +*Defined in [src/util/errors.ts:117](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L119)* +*Defined in [src/util/errors.ts:119](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L119)* ___ diff --git a/docs/classes/_util_errors_.jwksnomatchingkey.md b/docs/classes/_util_errors_.jwksnomatchingkey.md index 61eaf2161f..d9fc0ff020 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L108)* +*Defined in [src/util/errors.ts:108](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L110)* +*Defined in [src/util/errors.ts:110](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L110)* ___ diff --git a/docs/classes/_util_errors_.jwsinvalid.md b/docs/classes/_util_errors_.jwsinvalid.md index d8425a4913..0825608d79 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L80)* +*Defined in [src/util/errors.ts:80](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L80)* ___ diff --git a/docs/classes/_util_errors_.jwssignatureverificationfailed.md b/docs/classes/_util_errors_.jwssignatureverificationfailed.md index ee9af34f4b..2789421ae4 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L126)* +*Defined in [src/util/errors.ts:126](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L128)* +*Defined in [src/util/errors.ts:128](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L128)* ___ diff --git a/docs/classes/_util_errors_.jwtclaimvalidationfailed.md b/docs/classes/_util_errors_.jwtclaimvalidationfailed.md index 521124b196..2a1c3e55a8 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.x/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L31)* +*Defined in [src/util/errors.ts:31](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L26)* +*Defined in [src/util/errors.ts:26](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.0.0/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 2d95e7ae13..cd54a637a3 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.x/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L31)* +*Defined in [src/util/errors.ts:31](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L135)* +*Defined in [src/util/errors.ts:135](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L36)* +*Defined in [src/util/errors.ts:36](https://github.com/panva/jose/blob/v3.0.0/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 4eed358b28..296ab725d3 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.x/src/util/errors.ts#L11)* +*Defined in [src/util/errors.ts:11](https://github.com/panva/jose/blob/v3.0.0/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.x/src/util/errors.ts#L87)* +*Defined in [src/util/errors.ts:87](https://github.com/panva/jose/blob/v3.0.0/src/util/errors.ts#L87)* ___ diff --git a/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md b/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md index 50573d666e..67752db651 100644 --- a/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md +++ b/docs/functions/_jwe_compact_decrypt_.compactdecrypt.md @@ -2,7 +2,7 @@ ▸ **compactDecrypt**(`jwe`: string, `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:62](https://github.com/panva/jose/blob/v3.x/src/jwe/compact/decrypt.ts#L62)* +*Defined in [src/jwe/compact/decrypt.ts:62](https://github.com/panva/jose/blob/v3.0.0/src/jwe/compact/decrypt.ts#L62)* Decrypts a Compact JWE. diff --git a/docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md b/docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md index 38acf834ec..b9c9654b69 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.x/src/jwe/flattened/decrypt.ts#L92)* +*Defined in [src/jwe/flattened/decrypt.ts:92](https://github.com/panva/jose/blob/v3.0.0/src/jwe/flattened/decrypt.ts#L92)* Decrypts a Flattened JWE. diff --git a/docs/functions/_jwk_embedded_.embeddedjwk.md b/docs/functions/_jwk_embedded_.embeddedjwk.md index 4fe6d2c45a..c9cc12114f 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.x/src/jwk/embedded.ts#L43)* +*Defined in [src/jwk/embedded.ts:43](https://github.com/panva/jose/blob/v3.0.0/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_parse_.parsejwk.md b/docs/functions/_jwk_parse_.parsejwk.md index 08c15b0911..5751b1c8b8 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.x/src/jwk/parse.ts#L50)* +*Defined in [src/jwk/parse.ts:50](https://github.com/panva/jose/blob/v3.0.0/src/jwk/parse.ts#L50)* Converts a JWK to a runtime-specific key representation. Either JWK "alg" (Algorithm) Parameter must be present or the optional "alg" argument. When running on a platform diff --git a/docs/functions/_jwk_thumbprint_.calculatethumbprint.md b/docs/functions/_jwk_thumbprint_.calculatethumbprint.md index 35b7802272..5c4b76372b 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.x/src/jwk/thumbprint.ts#L47)* +*Defined in [src/jwk/thumbprint.ts:47](https://github.com/panva/jose/blob/v3.0.0/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 4deef39a70..38b0ee81e7 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:233](https://github.com/panva/jose/blob/v3.x/src/jwks/remote.ts#L233)* +*Defined in [src/jwks/remote.ts:233](https://github.com/panva/jose/blob/v3.0.0/src/jwks/remote.ts#L233)* 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 f93b90a837..177b6c7e4e 100644 --- a/docs/functions/_jws_compact_verify_.compactverify.md +++ b/docs/functions/_jws_compact_verify_.compactverify.md @@ -2,7 +2,7 @@ ▸ **compactVerify**(`jws`: string, `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:59](https://github.com/panva/jose/blob/v3.x/src/jws/compact/verify.ts#L59)* +*Defined in [src/jws/compact/verify.ts:59](https://github.com/panva/jose/blob/v3.0.0/src/jws/compact/verify.ts#L59)* 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 c956bc757c..a9af064fb1 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.x/src/jws/flattened/verify.ts#L75)* +*Defined in [src/jws/flattened/verify.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/jws/flattened/verify.ts#L75)* Verifies the signature and format of and afterwards decodes the Flattened JWS. diff --git a/docs/functions/_jwt_decrypt_.jwtdecrypt.md b/docs/functions/_jwt_decrypt_.jwtdecrypt.md index 8cfe7be4f8..98d0ffae42 100644 --- a/docs/functions/_jwt_decrypt_.jwtdecrypt.md +++ b/docs/functions/_jwt_decrypt_.jwtdecrypt.md @@ -2,7 +2,7 @@ ▸ **jwtDecrypt**(`jwt`: string, `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.x/src/jwt/decrypt.ts#L65)* +*Defined in [src/jwt/decrypt.ts:65](https://github.com/panva/jose/blob/v3.0.0/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 6db7d0df08..60bf49924e 100644 --- a/docs/functions/_jwt_verify_.jwtverify.md +++ b/docs/functions/_jwt_verify_.jwtverify.md @@ -2,7 +2,7 @@ ▸ **jwtVerify**(`jwt`: string, `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:66](https://github.com/panva/jose/blob/v3.x/src/jwt/verify.ts#L66)* +*Defined in [src/jwt/verify.ts:66](https://github.com/panva/jose/blob/v3.0.0/src/jwt/verify.ts#L66)* 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_generate_key_pair_.generatekeypair.md b/docs/functions/_util_generate_key_pair_.generatekeypair.md index 453fd054c9..6420b5b8a7 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: CryptoKey \| KeyObject ; publicKey: CryptoKey \| KeyObject }> -*Defined in [src/util/generate_key_pair.ts:41](https://github.com/panva/jose/blob/v3.x/src/util/generate_key_pair.ts#L41)* +*Defined in [src/util/generate_key_pair.ts:41](https://github.com/panva/jose/blob/v3.0.0/src/util/generate_key_pair.ts#L41)* 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 36c3b163f3..21f9f14204 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.x/src/util/generate_secret.ts#L28)* +*Defined in [src/util/generate_secret.ts:28](https://github.com/panva/jose/blob/v3.0.0/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 275f987f3e..8c3a6bbe41 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:75](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L75)* +*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L75)* 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 ad3ed42128..e47591c90f 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:75](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L75)* +*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L75)* 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/_jwks_remote_.remotejwksetoptions.md b/docs/interfaces/_jwks_remote_.remotejwksetoptions.md index 332bac5b78..917904d034 100644 --- a/docs/interfaces/_jwks_remote_.remotejwksetoptions.md +++ b/docs/interfaces/_jwks_remote_.remotejwksetoptions.md @@ -15,7 +15,7 @@ Options for the remote JSON Web Key Set. • `Optional` **cooldownDuration**: number -*Defined in [src/jwks/remote.ts:45](https://github.com/panva/jose/blob/v3.x/src/jwks/remote.ts#L45)* +*Defined in [src/jwks/remote.ts:45](https://github.com/panva/jose/blob/v3.0.0/src/jwks/remote.ts#L45)* Duration for which no more HTTP requests will be triggered after a previous successful fetch. Default is 30000. @@ -26,7 +26,7 @@ ___ • `Optional` **timeoutDuration**: number -*Defined in [src/jwks/remote.ts:39](https://github.com/panva/jose/blob/v3.x/src/jwks/remote.ts#L39)* +*Defined in [src/jwks/remote.ts:39](https://github.com/panva/jose/blob/v3.0.0/src/jwks/remote.ts#L39)* 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 3e88aba16c..ad96ddba1a 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:75](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L75)* +*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L75)* 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 f087651387..f1331550b1 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:75](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L75)* +*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L75)* 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/_jwt_decrypt_.jwtdecryptgetkey.md b/docs/interfaces/_jwt_decrypt_.jwtdecryptgetkey.md index 6942667852..d39ff62b58 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:75](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L75)* +*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L75)* 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 ebe6546df0..78c451b59f 100644 --- a/docs/interfaces/_jwt_decrypt_.jwtdecryptoptions.md +++ b/docs/interfaces/_jwt_decrypt_.jwtdecryptoptions.md @@ -23,7 +23,7 @@ Combination of JWE Decryption options and JWT Claims Set verification options. • `Optional` **audience**: string \| string[] -*Defined in [src/types.d.ts:355](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L355)* +*Defined in [src/types.d.ts:355](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L355)* Expected JWT "aud" (Audience) Claim value(s). @@ -33,7 +33,7 @@ ___ • `Optional` **clockTolerance**: string \| number -*Defined in [src/types.d.ts:362](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L362)* +*Defined in [src/types.d.ts:362](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L362)* Expected clock tolerance - in seconds when number (e.g. 5) @@ -45,7 +45,7 @@ ___ • `Optional` **contentEncryptionAlgorithms**: string[] -*Defined in [src/types.d.ts:328](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L328)* +*Defined in [src/types.d.ts:328](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L328)* A list of accepted JWE "enc" (Encryption Algorithm) Header Parameter values. @@ -55,7 +55,7 @@ ___ • `Optional` **currentDate**: Date -*Defined in [src/types.d.ts:387](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L387)* +*Defined in [src/types.d.ts:387](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L387)* Date to use when comparing NumericDate claims, defaults to `new Date()`. @@ -65,7 +65,7 @@ ___ • `Optional` **inflateRaw**: [InflateFunction](_types_d_.inflatefunction.md) -*Defined in [src/types.d.ts:334](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L334)* +*Defined in [src/types.d.ts:334](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L334)* In a browser runtime you have to provide an implementation for Inflate Raw when you expect JWEs with compressed plaintext. @@ -76,7 +76,7 @@ ___ • `Optional` **issuer**: string \| string[] -*Defined in [src/types.d.ts:367](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L367)* +*Defined in [src/types.d.ts:367](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L367)* Expected JWT "iss" (Issuer) Claim value(s). @@ -86,7 +86,7 @@ ___ • `Optional` **keyManagementAlgorithms**: string[] -*Defined in [src/types.d.ts:323](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L323)* +*Defined in [src/types.d.ts:323](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L323)* A list of accepted JWE "alg" (Algorithm) Header Parameter values. @@ -96,7 +96,7 @@ ___ • `Optional` **maxTokenAge**: string -*Defined in [src/types.d.ts:372](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L372)* +*Defined in [src/types.d.ts:372](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L372)* Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. @@ -106,7 +106,7 @@ ___ • `Optional` **subject**: string -*Defined in [src/types.d.ts:377](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L377)* +*Defined in [src/types.d.ts:377](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L377)* Expected JWT "sub" (Subject) Claim value. @@ -116,6 +116,6 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:382](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L382)* +*Defined in [src/types.d.ts:382](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L382)* Expected JWT "typ" (Type) Header Parameter value. diff --git a/docs/interfaces/_jwt_verify_.jwtverifygetkey.md b/docs/interfaces/_jwt_verify_.jwtverifygetkey.md index 2c51dbefbd..f736f64ba9 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:75](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L75)* +*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L75)* 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 bd36dfcb7c..372bd7095d 100644 --- a/docs/interfaces/_jwt_verify_.jwtverifyoptions.md +++ b/docs/interfaces/_jwt_verify_.jwtverifyoptions.md @@ -21,7 +21,7 @@ Combination of JWS Verification options and JWT Claims Set verification options. • `Optional` **algorithms**: string[] -*Defined in [src/types.d.ts:397](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L397)* +*Defined in [src/types.d.ts:397](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L397)* A list of accepted JWS "alg" (Algorithm) Header Parameter values. @@ -31,7 +31,7 @@ ___ • `Optional` **audience**: string \| string[] -*Defined in [src/types.d.ts:355](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L355)* +*Defined in [src/types.d.ts:355](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L355)* Expected JWT "aud" (Audience) Claim value(s). @@ -41,7 +41,7 @@ ___ • `Optional` **clockTolerance**: string \| number -*Defined in [src/types.d.ts:362](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L362)* +*Defined in [src/types.d.ts:362](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L362)* Expected clock tolerance - in seconds when number (e.g. 5) @@ -53,7 +53,7 @@ ___ • `Optional` **currentDate**: Date -*Defined in [src/types.d.ts:387](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L387)* +*Defined in [src/types.d.ts:387](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L387)* Date to use when comparing NumericDate claims, defaults to `new Date()`. @@ -63,7 +63,7 @@ ___ • `Optional` **issuer**: string \| string[] -*Defined in [src/types.d.ts:367](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L367)* +*Defined in [src/types.d.ts:367](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L367)* Expected JWT "iss" (Issuer) Claim value(s). @@ -73,7 +73,7 @@ ___ • `Optional` **maxTokenAge**: string -*Defined in [src/types.d.ts:372](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L372)* +*Defined in [src/types.d.ts:372](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L372)* Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. @@ -83,7 +83,7 @@ ___ • `Optional` **subject**: string -*Defined in [src/types.d.ts:377](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L377)* +*Defined in [src/types.d.ts:377](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L377)* Expected JWT "sub" (Subject) Claim value. @@ -93,6 +93,6 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:382](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L382)* +*Defined in [src/types.d.ts:382](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L382)* Expected JWT "typ" (Type) Header Parameter value. diff --git a/docs/interfaces/_types_d_.compactdecryptresult.md b/docs/interfaces/_types_d_.compactdecryptresult.md index f7d1628e13..e35e370a9b 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:491](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L491)* +*Defined in [src/types.d.ts:491](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L491)* Plaintext. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:496](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L496)* +*Defined in [src/types.d.ts:496](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L496)* JWE Protected Header. diff --git a/docs/interfaces/_types_d_.compactverifyresult.md b/docs/interfaces/_types_d_.compactverifyresult.md index 451b82bff3..d49b872efd 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:520](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L520)* +*Defined in [src/types.d.ts:520](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L520)* JWS Payload. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:525](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L525)* +*Defined in [src/types.d.ts:525](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L525)* JWS Protected Header. diff --git a/docs/interfaces/_types_d_.decryptoptions.md b/docs/interfaces/_types_d_.decryptoptions.md index 6e7af6a0b8..8d0a15d5d8 100644 --- a/docs/interfaces/_types_d_.decryptoptions.md +++ b/docs/interfaces/_types_d_.decryptoptions.md @@ -16,7 +16,7 @@ JWE Decryption options. • `Optional` **contentEncryptionAlgorithms**: string[] -*Defined in [src/types.d.ts:328](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L328)* +*Defined in [src/types.d.ts:328](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L328)* A list of accepted JWE "enc" (Encryption Algorithm) Header Parameter values. @@ -26,7 +26,7 @@ ___ • `Optional` **inflateRaw**: [InflateFunction](_types_d_.inflatefunction.md) -*Defined in [src/types.d.ts:334](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L334)* +*Defined in [src/types.d.ts:334](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L334)* In a browser runtime you have to provide an implementation for Inflate Raw when you expect JWEs with compressed plaintext. @@ -37,6 +37,6 @@ ___ • `Optional` **keyManagementAlgorithms**: string[] -*Defined in [src/types.d.ts:323](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L323)* +*Defined in [src/types.d.ts:323](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L323)* 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 699468b4f5..ec4bd1ad53 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:449](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L449)* +*Defined in [src/types.d.ts:449](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L449)* 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 c3d6250c2a..f0aed51d09 100644 --- a/docs/interfaces/_types_d_.encryptoptions.md +++ b/docs/interfaces/_types_d_.encryptoptions.md @@ -14,7 +14,7 @@ JWE Encryption options. • `Optional` **deflateRaw**: [DeflateFunction](_types_d_.deflatefunction.md) -*Defined in [src/types.d.ts:345](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L345)* +*Defined in [src/types.d.ts:345](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L345)* 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 c7253c6cb0..440c624d7f 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:464](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L464)* +*Defined in [src/types.d.ts:464](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L464)* JWE AAD. @@ -26,7 +26,7 @@ ___ • **plaintext**: Uint8Array -*Defined in [src/types.d.ts:469](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L469)* +*Defined in [src/types.d.ts:469](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L469)* Plaintext. @@ -36,7 +36,7 @@ ___ • `Optional` **protectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:474](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L474)* +*Defined in [src/types.d.ts:474](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L474)* JWE Protected Header. @@ -46,7 +46,7 @@ ___ • `Optional` **sharedUnprotectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:479](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L479)* +*Defined in [src/types.d.ts:479](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L479)* JWE Shared Unprotected Header. @@ -56,6 +56,6 @@ ___ • `Optional` **unprotectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:484](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L484)* +*Defined in [src/types.d.ts:484](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L484)* JWE Per-Recipient Unprotected Header. diff --git a/docs/interfaces/_types_d_.flattenedjwe.md b/docs/interfaces/_types_d_.flattenedjwe.md index a9be78dafd..986065431b 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:228](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L228)* +*Defined in [src/types.d.ts:228](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L228)* 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:234](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L234)* +*Defined in [src/types.d.ts:234](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L234)* 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:241](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L241)* +*Defined in [src/types.d.ts:241](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L241)* 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:251](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L251)* +*Defined in [src/types.d.ts:251](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L251)* 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:258](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L258)* +*Defined in [src/types.d.ts:258](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L258)* 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:266](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L266)* +*Defined in [src/types.d.ts:266](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L266)* 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:273](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L273)* +*Defined in [src/types.d.ts:273](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L273)* 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:282](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L282)* +*Defined in [src/types.d.ts:282](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L282)* 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 efb4222574..7d9aef3436 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:136](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L136)* +*Defined in [src/types.d.ts:136](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L136)* ___ @@ -25,4 +25,4 @@ ___ • **signature**: string -*Defined in [src/types.d.ts:137](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L137)* +*Defined in [src/types.d.ts:137](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L137)* diff --git a/docs/interfaces/_types_d_.flattenedjwsinput.md b/docs/interfaces/_types_d_.flattenedjwsinput.md index 5b64d239e6..d1ce4a25ab 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:106](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L106)* +*Defined in [src/types.d.ts:106](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L106)* 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:113](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L113)* +*Defined in [src/types.d.ts:113](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L113)* 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:121](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L121)* +*Defined in [src/types.d.ts:121](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L121)* 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:127](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L127)* +*Defined in [src/types.d.ts:127](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L127)* 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 97ed5e1921..62381632d1 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:503](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L503)* +*Defined in [src/types.d.ts:503](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L503)* JWS Payload. @@ -24,7 +24,7 @@ ___ • `Optional` **protectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:508](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L508)* +*Defined in [src/types.d.ts:508](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L508)* JWS Protected Header. @@ -34,6 +34,6 @@ ___ • `Optional` **unprotectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:513](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L513)* +*Defined in [src/types.d.ts:513](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L513)* JWS Unprotected Header. diff --git a/docs/interfaces/_types_d_.getkeyfunction.md b/docs/interfaces/_types_d_.getkeyfunction.md index 8c7dbf8c7f..31e23603e9 100644 --- a/docs/interfaces/_types_d_.getkeyfunction.md +++ b/docs/interfaces/_types_d_.getkeyfunction.md @@ -14,7 +14,7 @@ Name | ▸ (`protectedHeader`: T, `token`: T2): Promise\<[KeyLike](../types/_types_d_.keylike.md)> -*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L75)* +*Defined in [src/types.d.ts:75](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L75)* 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 b3d8dfd1ef..83c9e9aaef 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:456](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L456)* +*Defined in [src/types.d.ts:456](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L456)* 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 0954a9d391..2a4061cb03 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:174](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L174)* +*Defined in [src/types.d.ts:174](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L174)* "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:164](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L164)* +*Defined in [src/types.d.ts:164](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L164)* "jwk" (JSON Web Key) Header Parameter. @@ -38,7 +38,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L144)* +*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L144)* "kid" (Key ID) Header Parameter. @@ -48,7 +48,7 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:169](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L169)* +*Defined in [src/types.d.ts:169](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L169)* "typ" (Type) Header Parameter. @@ -58,7 +58,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:154](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L154)* +*Defined in [src/types.d.ts:154](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L154)* "x5c" (X.509 Certificate Chain) Header Parameter. @@ -68,7 +68,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:149](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L149)* +*Defined in [src/types.d.ts:149](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L149)* "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. @@ -78,6 +78,6 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:159](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L159)* +*Defined in [src/types.d.ts:159](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L159)* "x5u" (X.509 URL) Header Parameter. diff --git a/docs/interfaces/_types_d_.jweheaderparameters.md b/docs/interfaces/_types_d_.jweheaderparameters.md index 4a0be0c59a..5ca0e04a10 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:293](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L293)* +*Defined in [src/types.d.ts:293](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L293)* JWE "alg" (Algorithm) Header Parameter. @@ -41,7 +41,7 @@ ___ • `Optional` **crit**: string[] -*Defined in [src/types.d.ts:303](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L303)* +*Defined in [src/types.d.ts:303](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L303)* JWE "crit" (Critical) Header Parameter. @@ -51,7 +51,7 @@ ___ • `Optional` **cty**: string -*Defined in [src/types.d.ts:174](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L174)* +*Defined in [src/types.d.ts:174](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L174)* "cty" (Content Type) Header Parameter. @@ -61,7 +61,7 @@ ___ • `Optional` **enc**: string -*Defined in [src/types.d.ts:298](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L298)* +*Defined in [src/types.d.ts:298](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L298)* 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:164](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L164)* +*Defined in [src/types.d.ts:164](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L164)* "jwk" (JSON Web Key) Header Parameter. @@ -81,7 +81,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L144)* +*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L144)* "kid" (Key ID) Header Parameter. @@ -91,7 +91,7 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:169](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L169)* +*Defined in [src/types.d.ts:169](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L169)* "typ" (Type) Header Parameter. @@ -101,7 +101,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:154](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L154)* +*Defined in [src/types.d.ts:154](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L154)* "x5c" (X.509 Certificate Chain) Header Parameter. @@ -111,7 +111,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:149](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L149)* +*Defined in [src/types.d.ts:149](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L149)* "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. @@ -121,7 +121,7 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:159](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L159)* +*Defined in [src/types.d.ts:159](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L159)* "x5u" (X.509 URL) Header Parameter. @@ -131,6 +131,6 @@ ___ • `Optional` **zip**: string -*Defined in [src/types.d.ts:308](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L308)* +*Defined in [src/types.d.ts:308](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L308)* JWE "zip" (Compression Algorithm) Header Parameter. diff --git a/docs/interfaces/_types_d_.jwekeymanagementheaderparameters.md b/docs/interfaces/_types_d_.jwekeymanagementheaderparameters.md index 2b9c918fee..c7667d087f 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:209](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L209)* +*Defined in [src/types.d.ts:209](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L209)* ___ @@ -27,7 +27,7 @@ ___ • `Optional` **apv**: Uint8Array -*Defined in [src/types.d.ts:210](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L210)* +*Defined in [src/types.d.ts:210](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L210)* ___ @@ -35,7 +35,7 @@ ___ • `Optional` **epk**: [KeyLike](../types/_types_d_.keylike.md) -*Defined in [src/types.d.ts:211](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L211)* +*Defined in [src/types.d.ts:211](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L211)* ___ @@ -43,7 +43,7 @@ ___ • `Optional` **iv**: Uint8Array -*Defined in [src/types.d.ts:212](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L212)* +*Defined in [src/types.d.ts:212](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L212)* ___ @@ -51,7 +51,7 @@ ___ • `Optional` **p2c**: number -*Defined in [src/types.d.ts:213](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L213)* +*Defined in [src/types.d.ts:213](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L213)* ___ @@ -59,4 +59,4 @@ ___ • `Optional` **p2s**: Uint8Array -*Defined in [src/types.d.ts:214](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L214)* +*Defined in [src/types.d.ts:214](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L214)* diff --git a/docs/interfaces/_types_d_.jwk.md b/docs/interfaces/_types_d_.jwk.md index 03654e082f..4529a98674 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:12](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L12)* +*Defined in [src/types.d.ts:12](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L12)* JWK "alg" (Algorithm) Parameter. @@ -47,7 +47,7 @@ ___ • `Optional` **crv**: string -*Defined in [src/types.d.ts:13](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L13)* +*Defined in [src/types.d.ts:13](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L13)* ___ @@ -55,7 +55,7 @@ ___ • `Optional` **d**: string -*Defined in [src/types.d.ts:14](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L14)* +*Defined in [src/types.d.ts:14](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L14)* ___ @@ -63,7 +63,7 @@ ___ • `Optional` **dp**: string -*Defined in [src/types.d.ts:15](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L15)* +*Defined in [src/types.d.ts:15](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L15)* ___ @@ -71,7 +71,7 @@ ___ • `Optional` **dq**: string -*Defined in [src/types.d.ts:16](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L16)* +*Defined in [src/types.d.ts:16](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L16)* ___ @@ -79,7 +79,7 @@ ___ • `Optional` **e**: string -*Defined in [src/types.d.ts:17](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L17)* +*Defined in [src/types.d.ts:17](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L17)* ___ @@ -87,7 +87,7 @@ ___ • `Optional` **ext**: false \| true -*Defined in [src/types.d.ts:21](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L21)* +*Defined in [src/types.d.ts:21](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L21)* JWK "ext" (Extractable) Parameter. @@ -97,7 +97,7 @@ ___ • `Optional` **k**: string -*Defined in [src/types.d.ts:22](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L22)* +*Defined in [src/types.d.ts:22](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L22)* ___ @@ -105,7 +105,7 @@ ___ • `Optional` **key\_ops**: string[] -*Defined in [src/types.d.ts:26](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L26)* +*Defined in [src/types.d.ts:26](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L26)* JWK "key_ops" (Key Operations) Parameter. @@ -115,7 +115,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:30](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L30)* +*Defined in [src/types.d.ts:30](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L30)* JWK "kid" (Key ID) Parameter. @@ -125,7 +125,7 @@ ___ • `Optional` **kty**: string -*Defined in [src/types.d.ts:34](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L34)* +*Defined in [src/types.d.ts:34](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L34)* JWK "kty" (Key Type) Parameter. @@ -135,7 +135,7 @@ ___ • `Optional` **n**: string -*Defined in [src/types.d.ts:35](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L35)* +*Defined in [src/types.d.ts:35](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L35)* ___ @@ -143,7 +143,7 @@ ___ • `Optional` **oth**: Array\<{ d?: string ; r?: string ; t?: string }> -*Defined in [src/types.d.ts:36](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L36)* +*Defined in [src/types.d.ts:36](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L36)* ___ @@ -151,7 +151,7 @@ ___ • `Optional` **p**: string -*Defined in [src/types.d.ts:41](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L41)* +*Defined in [src/types.d.ts:41](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L41)* ___ @@ -159,7 +159,7 @@ ___ • `Optional` **q**: string -*Defined in [src/types.d.ts:42](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L42)* +*Defined in [src/types.d.ts:42](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L42)* ___ @@ -167,7 +167,7 @@ ___ • `Optional` **qi**: string -*Defined in [src/types.d.ts:43](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L43)* +*Defined in [src/types.d.ts:43](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L43)* ___ @@ -175,7 +175,7 @@ ___ • `Optional` **use**: string -*Defined in [src/types.d.ts:47](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L47)* +*Defined in [src/types.d.ts:47](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L47)* JWK "use" (Public Key Use) Parameter. @@ -185,7 +185,7 @@ ___ • `Optional` **x**: string -*Defined in [src/types.d.ts:48](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L48)* +*Defined in [src/types.d.ts:48](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L48)* ___ @@ -193,7 +193,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:53](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L53)* +*Defined in [src/types.d.ts:53](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L53)* JWK "x5c" (X.509 Certificate Chain) Parameter. @@ -203,7 +203,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:57](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L57)* +*Defined in [src/types.d.ts:57](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L57)* JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. @@ -213,7 +213,7 @@ ___ • `Optional` **x5t#S256**: string -*Defined in [src/types.d.ts:61](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L61)* +*Defined in [src/types.d.ts:61](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L61)* "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. @@ -223,7 +223,7 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:65](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L65)* +*Defined in [src/types.d.ts:65](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L65)* JWK "x5u" (X.509 URL) Parameter. @@ -233,4 +233,4 @@ ___ • `Optional` **y**: string -*Defined in [src/types.d.ts:49](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L49)* +*Defined in [src/types.d.ts:49](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L49)* diff --git a/docs/interfaces/_types_d_.jwsheaderparameters.md b/docs/interfaces/_types_d_.jwsheaderparameters.md index 445907b2bb..73c643abf2 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:185](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L185)* +*Defined in [src/types.d.ts:185](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L185)* JWS "alg" (Algorithm) Header Parameter. @@ -40,7 +40,7 @@ ___ • `Optional` **b64**: false \| true -*Defined in [src/types.d.ts:192](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L192)* +*Defined in [src/types.d.ts:192](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L192)* 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:197](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L197)* +*Defined in [src/types.d.ts:197](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L197)* JWS "crit" (Critical) Header Parameter. @@ -62,7 +62,7 @@ ___ • `Optional` **cty**: string -*Defined in [src/types.d.ts:174](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L174)* +*Defined in [src/types.d.ts:174](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L174)* "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:164](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L164)* +*Defined in [src/types.d.ts:164](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L164)* "jwk" (JSON Web Key) Header Parameter. @@ -82,7 +82,7 @@ ___ • `Optional` **kid**: string -*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L144)* +*Defined in [src/types.d.ts:144](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L144)* "kid" (Key ID) Header Parameter. @@ -92,7 +92,7 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:169](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L169)* +*Defined in [src/types.d.ts:169](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L169)* "typ" (Type) Header Parameter. @@ -102,7 +102,7 @@ ___ • `Optional` **x5c**: string[] -*Defined in [src/types.d.ts:154](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L154)* +*Defined in [src/types.d.ts:154](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L154)* "x5c" (X.509 Certificate Chain) Header Parameter. @@ -112,7 +112,7 @@ ___ • `Optional` **x5t**: string -*Defined in [src/types.d.ts:149](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L149)* +*Defined in [src/types.d.ts:149](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L149)* "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. @@ -122,6 +122,6 @@ ___ • `Optional` **x5u**: string -*Defined in [src/types.d.ts:159](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L159)* +*Defined in [src/types.d.ts:159](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L159)* "x5u" (X.509 URL) Header Parameter. diff --git a/docs/interfaces/_types_d_.jwtclaimverificationoptions.md b/docs/interfaces/_types_d_.jwtclaimverificationoptions.md index a444cb855e..a9692566b8 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:355](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L355)* +*Defined in [src/types.d.ts:355](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L355)* Expected JWT "aud" (Audience) Claim value(s). @@ -30,7 +30,7 @@ ___ • `Optional` **clockTolerance**: string \| number -*Defined in [src/types.d.ts:362](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L362)* +*Defined in [src/types.d.ts:362](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L362)* Expected clock tolerance - in seconds when number (e.g. 5) @@ -42,7 +42,7 @@ ___ • `Optional` **currentDate**: Date -*Defined in [src/types.d.ts:387](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L387)* +*Defined in [src/types.d.ts:387](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L387)* 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:367](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L367)* +*Defined in [src/types.d.ts:367](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L367)* Expected JWT "iss" (Issuer) Claim value(s). @@ -62,7 +62,7 @@ ___ • `Optional` **maxTokenAge**: string -*Defined in [src/types.d.ts:372](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L372)* +*Defined in [src/types.d.ts:372](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L372)* Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. @@ -72,7 +72,7 @@ ___ • `Optional` **subject**: string -*Defined in [src/types.d.ts:377](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L377)* +*Defined in [src/types.d.ts:377](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L377)* Expected JWT "sub" (Subject) Claim value. @@ -82,6 +82,6 @@ ___ • `Optional` **typ**: string -*Defined in [src/types.d.ts:382](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L382)* +*Defined in [src/types.d.ts:382](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L382)* Expected JWT "typ" (Type) Header Parameter value. diff --git a/docs/interfaces/_types_d_.jwtdecryptresult.md b/docs/interfaces/_types_d_.jwtdecryptresult.md index 76a32095c4..94054b4a33 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:544](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L544)* +*Defined in [src/types.d.ts:544](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L544)* JWT Claims Set. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWEHeaderParameters](_types_d_.jweheaderparameters.md) -*Defined in [src/types.d.ts:549](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L549)* +*Defined in [src/types.d.ts:549](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L549)* JWE Protected Header. diff --git a/docs/interfaces/_types_d_.jwtpayload.md b/docs/interfaces/_types_d_.jwtpayload.md index 06db126500..593726a82d 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:418](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L418)* +*Defined in [src/types.d.ts:418](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L418)* 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:433](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L433)* +*Defined in [src/types.d.ts:433](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L433)* 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:438](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L438)* +*Defined in [src/types.d.ts:438](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L438)* 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:408](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L408)* +*Defined in [src/types.d.ts:408](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L408)* 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:423](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L423)* +*Defined in [src/types.d.ts:423](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L423)* 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:428](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L428)* +*Defined in [src/types.d.ts:428](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L428)* 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:413](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L413)* +*Defined in [src/types.d.ts:413](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L413)* 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 49bcc90c1d..1989e88fc1 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:532](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L532)* +*Defined in [src/types.d.ts:532](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L532)* JWT Claims Set. @@ -23,6 +23,6 @@ ___ • **protectedHeader**: [JWSHeaderParameters](_types_d_.jwsheaderparameters.md) -*Defined in [src/types.d.ts:537](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L537)* +*Defined in [src/types.d.ts:537](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L537)* JWS Protected Header. diff --git a/docs/interfaces/_types_d_.verifyoptions.md b/docs/interfaces/_types_d_.verifyoptions.md index eb55cfb7d4..f538bc67a1 100644 --- a/docs/interfaces/_types_d_.verifyoptions.md +++ b/docs/interfaces/_types_d_.verifyoptions.md @@ -14,6 +14,6 @@ JWS Verification options. • `Optional` **algorithms**: string[] -*Defined in [src/types.d.ts:397](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L397)* +*Defined in [src/types.d.ts:397](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L397)* A list of accepted JWS "alg" (Algorithm) Header Parameter values. diff --git a/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md b/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md index c92257bccb..3ab26312ee 100644 --- a/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md +++ b/docs/interfaces/_util_generate_key_pair_.generatekeypairoptions.md @@ -12,7 +12,7 @@ • `Optional` **crv**: string -*Defined in [src/util/generate_key_pair.ts:10](https://github.com/panva/jose/blob/v3.x/src/util/generate_key_pair.ts#L10)* +*Defined in [src/util/generate_key_pair.ts:10](https://github.com/panva/jose/blob/v3.0.0/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 diff --git a/docs/types/_types_d_.keylike.md b/docs/types/_types_d_.keylike.md index f72a1948e3..78ce444fe6 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:92](https://github.com/panva/jose/blob/v3.x/src/types.d.ts#L92)* +*Defined in [src/types.d.ts:92](https://github.com/panva/jose/blob/v3.0.0/src/types.d.ts#L92)* KeyLike are platform-specific references to keying material. diff --git a/package.json b/package.json index 4640d1501c..10a5bf5fe4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jose", - "version": "2.0.3", + "version": "3.0.0", "description": "JSON Web Almost Everything - JWA, JWS, JWE, JWK, JWT, JWKS with no dependencies", "keywords": [ "compact",