From 77b4654c58880f51f2211d4cf015c5d08faf6ce6 Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Wed, 12 May 2021 14:09:15 +0200 Subject: [PATCH] chore(release): 3.12.0 --- CHANGELOG.md | 7 +++ .../jwe_compact_encrypt.compactencrypt.md | 24 ++++---- .../jwe_flattened_encrypt.flattenedencrypt.md | 36 +++++------ docs/classes/jws_compact_sign.compactsign.md | 12 ++-- .../jws_flattened_sign.flattenedsign.md | 16 ++--- docs/classes/jws_general_sign.generalsign.md | 10 ++-- docs/classes/jwt_encrypt.encryptjwt.md | 60 +++++++++---------- docs/classes/jwt_sign.signjwt.md | 42 ++++++------- docs/classes/jwt_unsecured.unsecuredjwt.md | 42 ++++++------- docs/classes/util_errors.josealgnotallowed.md | 10 ++-- docs/classes/util_errors.joseerror.md | 10 ++-- docs/classes/util_errors.josenotsupported.md | 10 ++-- .../util_errors.jwedecryptionfailed.md | 12 ++-- docs/classes/util_errors.jweinvalid.md | 10 ++-- docs/classes/util_errors.jwkinvalid.md | 10 ++-- docs/classes/util_errors.jwksinvalid.md | 10 ++-- .../util_errors.jwksmultiplematchingkeys.md | 12 ++-- docs/classes/util_errors.jwksnomatchingkey.md | 12 ++-- docs/classes/util_errors.jwsinvalid.md | 10 ++-- ...l_errors.jwssignatureverificationfailed.md | 12 ++-- .../util_errors.jwtclaimvalidationfailed.md | 14 ++--- docs/classes/util_errors.jwtexpired.md | 14 ++--- docs/classes/util_errors.jwtinvalid.md | 10 ++-- .../jwe_compact_decrypt.compactdecrypt.md | 4 +- .../jwe_flattened_decrypt.flatteneddecrypt.md | 4 +- .../jwe_general_decrypt.generaldecrypt.md | 4 +- docs/functions/jwk_embedded.embeddedjwk.md | 4 +- .../jwk_from_key_like.fromkeylike.md | 4 +- docs/functions/jwk_parse.parsejwk.md | 4 +- .../jwk_thumbprint.calculatethumbprint.md | 4 +- .../jwks_remote.createremotejwkset.md | 4 +- .../jws_compact_verify.compactverify.md | 4 +- .../jws_flattened_verify.flattenedverify.md | 4 +- .../jws_general_verify.generalverify.md | 4 +- docs/functions/jwt_decrypt.jwtdecrypt.md | 4 +- docs/functions/jwt_verify.jwtverify.md | 4 +- docs/functions/util_base64url.decode.md | 6 +- docs/functions/util_base64url.encode.md | 6 +- ..._protected_header.decodeprotectedheader.md | 4 +- .../util_generate_key_pair.generatekeypair.md | 7 ++- .../util_generate_secret.generatesecret.md | 10 +++- docs/functions/util_random.random.md | 6 +- ...we_compact_decrypt.compactdecryptgetkey.md | 6 +- ...lattened_decrypt.flatteneddecryptgetkey.md | 6 +- ...we_general_decrypt.generaldecryptgetkey.md | 6 +- .../jwks_remote.remotejwksetoptions.md | 6 +- .../jws_compact_verify.compactverifygetkey.md | 6 +- ..._flattened_verify.flattenedverifygetkey.md | 6 +- docs/interfaces/jws_general_sign.signature.md | 8 +-- .../jws_general_verify.generalverifygetkey.md | 6 +- .../jwt_decrypt.jwtdecryptgetkey.md | 6 +- .../jwt_decrypt.jwtdecryptoptions.md | 28 ++++----- docs/interfaces/jwt_verify.jwtverifygetkey.md | 6 +- .../interfaces/jwt_verify.jwtverifyoptions.md | 24 ++++---- docs/interfaces/types.compactdecryptresult.md | 4 +- docs/interfaces/types.compactverifyresult.md | 4 +- docs/interfaces/types.critoption.md | 6 +- docs/interfaces/types.decryptoptions.md | 12 ++-- docs/interfaces/types.deflatefunction.md | 4 +- docs/interfaces/types.encryptoptions.md | 8 +-- .../types.flatteneddecryptresult.md | 12 ++-- docs/interfaces/types.flattenedjwe.md | 16 ++--- docs/interfaces/types.flattenedjws.md | 10 ++-- docs/interfaces/types.flattenedjwsinput.md | 8 +-- .../interfaces/types.flattenedverifyresult.md | 8 +-- docs/interfaces/types.generaldecryptresult.md | 12 ++-- docs/interfaces/types.generaljwe.md | 16 ++--- docs/interfaces/types.generaljws.md | 4 +- docs/interfaces/types.generaljwsinput.md | 4 +- docs/interfaces/types.generalverifyresult.md | 8 +-- docs/interfaces/types.getkeyfunction.md | 6 +- docs/interfaces/types.inflatefunction.md | 4 +- docs/interfaces/types.joseheaderparameters.md | 16 ++--- docs/interfaces/types.jweheaderparameters.md | 24 ++++---- .../types.jwekeymanagementheaderparameters.md | 12 ++-- docs/interfaces/types.jwk.md | 46 +++++++------- docs/interfaces/types.jwsheaderparameters.md | 22 +++---- .../types.jwtclaimverificationoptions.md | 16 ++--- docs/interfaces/types.jwtdecryptresult.md | 4 +- docs/interfaces/types.jwtpayload.md | 14 ++--- docs/interfaces/types.jwtverifyresult.md | 4 +- docs/interfaces/types.signoptions.md | 6 +- docs/interfaces/types.verifyoptions.md | 8 +-- ...enerate_key_pair.generatekeypairoptions.md | 17 +++++- ...l_generate_secret.generatesecretoptions.md | 21 +++++++ docs/modules/util_generate_secret.md | 4 ++ docs/types/types.keylike.md | 2 +- ...tected_header.protectedheaderparameters.md | 2 +- package.json | 2 +- 89 files changed, 514 insertions(+), 462 deletions(-) create mode 100644 docs/interfaces/util_generate_secret.generatesecretoptions.md diff --git a/CHANGELOG.md b/CHANGELOG.md index a885ace7a9..6539848236 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [3.12.0](https://github.com/panva/jose/compare/v3.11.6...v3.12.0) (2021-05-12) + + +### Features + +* **webcrypto:** allow generate* modules extractable: false override ([afae428](https://github.com/panva/jose/commit/afae428f39eb920297ef474878d4266172d9a015)) + ## [3.11.6](https://github.com/panva/jose/compare/v3.11.5...v3.11.6) (2021-04-30) diff --git a/docs/classes/jwe_compact_encrypt.compactencrypt.md b/docs/classes/jwe_compact_encrypt.compactencrypt.md index 3d4d5c4899..be54dfaea7 100644 --- a/docs/classes/jwe_compact_encrypt.compactencrypt.md +++ b/docs/classes/jwe_compact_encrypt.compactencrypt.md @@ -45,7 +45,7 @@ console.log(jwe) \+ **new CompactEncrypt**(`plaintext`: *Uint8Array*): [*CompactEncrypt*](jwe_compact_encrypt.compactencrypt.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -53,7 +53,7 @@ console.log(jwe) **Returns:** [*CompactEncrypt*](jwe_compact_encrypt.compactencrypt.md) -Defined in: [jwe/compact/encrypt.ts:34](https://github.com/panva/jose/blob/v3.11.6/src/jwe/compact/encrypt.ts#L34) +Defined in: [jwe/compact/encrypt.ts:34](https://github.com/panva/jose/blob/v3.12.0/src/jwe/compact/encrypt.ts#L34) ## Methods @@ -63,7 +63,7 @@ Defined in: [jwe/compact/encrypt.ts:34](https://github.com/panva/jose/blob/v3.11 Encrypts and resolves the value of the Compact JWE string. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -72,7 +72,7 @@ Encrypts and resolves the value of the Compact JWE string. **Returns:** *Promise* -Defined in: [jwe/compact/encrypt.ts:97](https://github.com/panva/jose/blob/v3.11.6/src/jwe/compact/encrypt.ts#L97) +Defined in: [jwe/compact/encrypt.ts:97](https://github.com/panva/jose/blob/v3.12.0/src/jwe/compact/encrypt.ts#L97) ___ @@ -85,7 +85,7 @@ is generated for the JWE enc" (Encryption Algorithm) Header Parameter. You do not need to invoke this method, it is only really intended for test and vector validation purposes. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -93,7 +93,7 @@ test and vector validation purposes. **Returns:** [*CompactEncrypt*](jwe_compact_encrypt.compactencrypt.md) -Defined in: [jwe/compact/encrypt.ts:51](https://github.com/panva/jose/blob/v3.11.6/src/jwe/compact/encrypt.ts#L51) +Defined in: [jwe/compact/encrypt.ts:51](https://github.com/panva/jose/blob/v3.12.0/src/jwe/compact/encrypt.ts#L51) ___ @@ -106,7 +106,7 @@ a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter. You do not need to invoke this method, it is only really intended for test and vector validation purposes. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -114,7 +114,7 @@ intended for test and vector validation purposes. **Returns:** [*CompactEncrypt*](jwe_compact_encrypt.compactencrypt.md) -Defined in: [jwe/compact/encrypt.ts:64](https://github.com/panva/jose/blob/v3.11.6/src/jwe/compact/encrypt.ts#L64) +Defined in: [jwe/compact/encrypt.ts:64](https://github.com/panva/jose/blob/v3.12.0/src/jwe/compact/encrypt.ts#L64) ___ @@ -126,7 +126,7 @@ 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 intended for test and vector validation purposes. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -134,7 +134,7 @@ intended for test and vector validation purposes. **Returns:** [*CompactEncrypt*](jwe_compact_encrypt.compactencrypt.md) -Defined in: [jwe/compact/encrypt.ts:86](https://github.com/panva/jose/blob/v3.11.6/src/jwe/compact/encrypt.ts#L86) +Defined in: [jwe/compact/encrypt.ts:86](https://github.com/panva/jose/blob/v3.12.0/src/jwe/compact/encrypt.ts#L86) ___ @@ -144,7 +144,7 @@ ___ Sets the JWE Protected Header on the CompactEncrypt object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -152,4 +152,4 @@ Sets the JWE Protected Header on the CompactEncrypt object. **Returns:** [*CompactEncrypt*](jwe_compact_encrypt.compactencrypt.md) -Defined in: [jwe/compact/encrypt.ts:74](https://github.com/panva/jose/blob/v3.11.6/src/jwe/compact/encrypt.ts#L74) +Defined in: [jwe/compact/encrypt.ts:74](https://github.com/panva/jose/blob/v3.12.0/src/jwe/compact/encrypt.ts#L74) diff --git a/docs/classes/jwe_flattened_encrypt.flattenedencrypt.md b/docs/classes/jwe_flattened_encrypt.flattenedencrypt.md index 92c4ca1374..c3b293b45e 100644 --- a/docs/classes/jwe_flattened_encrypt.flattenedencrypt.md +++ b/docs/classes/jwe_flattened_encrypt.flattenedencrypt.md @@ -50,7 +50,7 @@ console.log(jwe) \+ **new FlattenedEncrypt**(`plaintext`: *Uint8Array*): [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -58,7 +58,7 @@ console.log(jwe) **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:65](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L65) +Defined in: [jwe/flattened/encrypt.ts:65](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L65) ## Methods @@ -68,7 +68,7 @@ Defined in: [jwe/flattened/encrypt.ts:65](https://github.com/panva/jose/blob/v3. Encrypts and resolves the value of the Flattened JWE object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -77,7 +77,7 @@ Encrypts and resolves the value of the Flattened JWE object. **Returns:** *Promise*<[*FlattenedJWE*](../interfaces/types.flattenedjwe.md)\> -Defined in: [jwe/flattened/encrypt.ts:177](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L177) +Defined in: [jwe/flattened/encrypt.ts:177](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L177) ___ @@ -87,7 +87,7 @@ ___ Sets the Additional Authenticated Data on the FlattenedEncrypt object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -95,7 +95,7 @@ Sets the Additional Authenticated Data on the FlattenedEncrypt object. **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:134](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L134) +Defined in: [jwe/flattened/encrypt.ts:134](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L134) ___ @@ -108,7 +108,7 @@ is generated for the JWE enc" (Encryption Algorithm) Header Parameter. You do not need to invoke this method, it is only really intended for test and vector validation purposes. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -116,7 +116,7 @@ test and vector validation purposes. **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:147](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L147) +Defined in: [jwe/flattened/encrypt.ts:147](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L147) ___ @@ -129,7 +129,7 @@ a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter. You do not need to invoke this method, it is only really intended for test and vector validation purposes. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -137,7 +137,7 @@ intended for test and vector validation purposes. **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:163](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L163) +Defined in: [jwe/flattened/encrypt.ts:163](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L163) ___ @@ -150,7 +150,7 @@ Use of this is method is really only needed for ECDH-ES based algorithms when utilizing the Agreement PartyUInfo or Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed and missing. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -158,7 +158,7 @@ Other parameters will always be randomly generated when needed and missing. **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:82](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L82) +Defined in: [jwe/flattened/encrypt.ts:82](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L82) ___ @@ -168,7 +168,7 @@ ___ Sets the JWE Protected Header on the FlattenedEncrypt object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -176,7 +176,7 @@ Sets the JWE Protected Header on the FlattenedEncrypt object. **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:95](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L95) +Defined in: [jwe/flattened/encrypt.ts:95](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L95) ___ @@ -186,7 +186,7 @@ ___ Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -194,7 +194,7 @@ Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object. **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:108](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L108) +Defined in: [jwe/flattened/encrypt.ts:108](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L108) ___ @@ -204,7 +204,7 @@ ___ Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -212,4 +212,4 @@ Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object. **Returns:** [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md) -Defined in: [jwe/flattened/encrypt.ts:121](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/encrypt.ts#L121) +Defined in: [jwe/flattened/encrypt.ts:121](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/encrypt.ts#L121) diff --git a/docs/classes/jws_compact_sign.compactsign.md b/docs/classes/jws_compact_sign.compactsign.md index ebdad36f7e..d40d619327 100644 --- a/docs/classes/jws_compact_sign.compactsign.md +++ b/docs/classes/jws_compact_sign.compactsign.md @@ -42,7 +42,7 @@ console.log(jws) \+ **new CompactSign**(`payload`: *Uint8Array*): [*CompactSign*](jws_compact_sign.compactsign.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -50,7 +50,7 @@ console.log(jws) **Returns:** [*CompactSign*](jws_compact_sign.compactsign.md) -Defined in: [jws/compact/sign.ts:31](https://github.com/panva/jose/blob/v3.11.6/src/jws/compact/sign.ts#L31) +Defined in: [jws/compact/sign.ts:31](https://github.com/panva/jose/blob/v3.12.0/src/jws/compact/sign.ts#L31) ## Methods @@ -60,7 +60,7 @@ Defined in: [jws/compact/sign.ts:31](https://github.com/panva/jose/blob/v3.11.6/ Sets the JWS Protected Header on the Sign object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -68,7 +68,7 @@ Sets the JWS Protected Header on the Sign object. **Returns:** [*CompactSign*](jws_compact_sign.compactsign.md) -Defined in: [jws/compact/sign.ts:45](https://github.com/panva/jose/blob/v3.11.6/src/jws/compact/sign.ts#L45) +Defined in: [jws/compact/sign.ts:45](https://github.com/panva/jose/blob/v3.12.0/src/jws/compact/sign.ts#L45) ___ @@ -78,7 +78,7 @@ ___ Signs and resolves the value of the Compact JWS string. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -87,4 +87,4 @@ Signs and resolves the value of the Compact JWS string. **Returns:** *Promise* -Defined in: [jws/compact/sign.ts:56](https://github.com/panva/jose/blob/v3.11.6/src/jws/compact/sign.ts#L56) +Defined in: [jws/compact/sign.ts:56](https://github.com/panva/jose/blob/v3.12.0/src/jws/compact/sign.ts#L56) diff --git a/docs/classes/jws_flattened_sign.flattenedsign.md b/docs/classes/jws_flattened_sign.flattenedsign.md index 1c6ac5479d..29de3b2979 100644 --- a/docs/classes/jws_flattened_sign.flattenedsign.md +++ b/docs/classes/jws_flattened_sign.flattenedsign.md @@ -42,7 +42,7 @@ console.log(jws) \+ **new FlattenedSign**(`payload`: *Uint8Array*): [*FlattenedSign*](jws_flattened_sign.flattenedsign.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -50,7 +50,7 @@ console.log(jws) **Returns:** [*FlattenedSign*](jws_flattened_sign.flattenedsign.md) -Defined in: [jws/flattened/sign.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/jws/flattened/sign.ts#L43) +Defined in: [jws/flattened/sign.ts:43](https://github.com/panva/jose/blob/v3.12.0/src/jws/flattened/sign.ts#L43) ## Methods @@ -60,7 +60,7 @@ Defined in: [jws/flattened/sign.ts:43](https://github.com/panva/jose/blob/v3.11. Sets the JWS Protected Header on the FlattenedSign object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -68,7 +68,7 @@ Sets the JWS Protected Header on the FlattenedSign object. **Returns:** [*FlattenedSign*](jws_flattened_sign.flattenedsign.md) -Defined in: [jws/flattened/sign.ts:57](https://github.com/panva/jose/blob/v3.11.6/src/jws/flattened/sign.ts#L57) +Defined in: [jws/flattened/sign.ts:57](https://github.com/panva/jose/blob/v3.12.0/src/jws/flattened/sign.ts#L57) ___ @@ -78,7 +78,7 @@ ___ Sets the JWS Unprotected Header on the FlattenedSign object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -86,7 +86,7 @@ Sets the JWS Unprotected Header on the FlattenedSign object. **Returns:** [*FlattenedSign*](jws_flattened_sign.flattenedsign.md) -Defined in: [jws/flattened/sign.ts:70](https://github.com/panva/jose/blob/v3.11.6/src/jws/flattened/sign.ts#L70) +Defined in: [jws/flattened/sign.ts:70](https://github.com/panva/jose/blob/v3.12.0/src/jws/flattened/sign.ts#L70) ___ @@ -96,7 +96,7 @@ ___ Signs and resolves the value of the Flattened JWS object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -105,4 +105,4 @@ Signs and resolves the value of the Flattened JWS object. **Returns:** *Promise*<[*FlattenedJWS*](../interfaces/types.flattenedjws.md)\> -Defined in: [jws/flattened/sign.ts:84](https://github.com/panva/jose/blob/v3.11.6/src/jws/flattened/sign.ts#L84) +Defined in: [jws/flattened/sign.ts:84](https://github.com/panva/jose/blob/v3.12.0/src/jws/flattened/sign.ts#L84) diff --git a/docs/classes/jws_general_sign.generalsign.md b/docs/classes/jws_general_sign.generalsign.md index 634194a56c..888d5405b8 100644 --- a/docs/classes/jws_general_sign.generalsign.md +++ b/docs/classes/jws_general_sign.generalsign.md @@ -48,7 +48,7 @@ const jws = await sign.sign() \+ **new GeneralSign**(`payload`: *Uint8Array*): [*GeneralSign*](jws_general_sign.generalsign.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -56,7 +56,7 @@ const jws = await sign.sign() **Returns:** [*GeneralSign*](jws_general_sign.generalsign.md) -Defined in: [jws/general/sign.ts:99](https://github.com/panva/jose/blob/v3.11.6/src/jws/general/sign.ts#L99) +Defined in: [jws/general/sign.ts:99](https://github.com/panva/jose/blob/v3.12.0/src/jws/general/sign.ts#L99) ## Methods @@ -64,7 +64,7 @@ Defined in: [jws/general/sign.ts:99](https://github.com/panva/jose/blob/v3.11.6/ ▸ **addSignature**(`key`: [*KeyLike*](../types/types.keylike.md), `options?`: [*SignOptions*](../interfaces/types.signoptions.md)): [*Signature*](../interfaces/jws_general_sign.signature.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -73,7 +73,7 @@ Defined in: [jws/general/sign.ts:99](https://github.com/panva/jose/blob/v3.11.6/ **Returns:** [*Signature*](../interfaces/jws_general_sign.signature.md) -Defined in: [jws/general/sign.ts:108](https://github.com/panva/jose/blob/v3.11.6/src/jws/general/sign.ts#L108) +Defined in: [jws/general/sign.ts:108](https://github.com/panva/jose/blob/v3.12.0/src/jws/general/sign.ts#L108) ___ @@ -85,4 +85,4 @@ Signs and resolves the value of the General JWS object. **Returns:** *Promise*<[*GeneralJWS*](../interfaces/types.generaljws.md)\> -Defined in: [jws/general/sign.ts:118](https://github.com/panva/jose/blob/v3.11.6/src/jws/general/sign.ts#L118) +Defined in: [jws/general/sign.ts:118](https://github.com/panva/jose/blob/v3.12.0/src/jws/general/sign.ts#L118) diff --git a/docs/classes/jwt_encrypt.encryptjwt.md b/docs/classes/jwt_encrypt.encryptjwt.md index d5ba641ea1..14d3272034 100644 --- a/docs/classes/jwt_encrypt.encryptjwt.md +++ b/docs/classes/jwt_encrypt.encryptjwt.md @@ -29,7 +29,7 @@ console.log(jwt) ## Hierarchy -* *ProduceJWT* +- *ProduceJWT* ↳ **EncryptJWT** @@ -63,7 +63,7 @@ console.log(jwt) \+ **new EncryptJWT**(`payload`: [*JWTPayload*](../interfaces/types.jwtpayload.md)): [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -73,7 +73,7 @@ console.log(jwt) Inherited from: ProduceJWT.constructor -Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L10) +Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L10) ## Methods @@ -83,7 +83,7 @@ Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.11.6/ Encrypts and returns the JWT. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -92,7 +92,7 @@ Encrypts and returns the JWT. **Returns:** *Promise* -Defined in: [jwt/encrypt.ts:151](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L151) +Defined in: [jwt/encrypt.ts:151](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L151) ___ @@ -105,7 +105,7 @@ Replicates the "aud" (Audience) Claim as a JWE Protected Header Parameter as per **Returns:** [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -Defined in: [jwt/encrypt.ts:140](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L140) +Defined in: [jwt/encrypt.ts:140](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L140) ___ @@ -118,7 +118,7 @@ Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter as per **Returns:** [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -Defined in: [jwt/encrypt.ts:122](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L122) +Defined in: [jwt/encrypt.ts:122](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L122) ___ @@ -131,7 +131,7 @@ Replicates the "sub" (Subject) Claim as a JWE Protected Header Parameter as per **Returns:** [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -Defined in: [jwt/encrypt.ts:131](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L131) +Defined in: [jwt/encrypt.ts:131](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L131) ___ @@ -141,7 +141,7 @@ ___ Set "aud" (Audience) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -151,7 +151,7 @@ Set "aud" (Audience) Claim. Inherited from: ProduceJWT.setAudience -Defined in: [lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L47) +Defined in: [lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L47) ___ @@ -164,7 +164,7 @@ is generated for the JWE enc" (Encryption Algorithm) Header Parameter. You do not need to invoke this method, it is only really intended for test and vector validation purposes. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -172,7 +172,7 @@ test and vector validation purposes. **Returns:** [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -Defined in: [jwt/encrypt.ts:94](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L94) +Defined in: [jwt/encrypt.ts:94](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L94) ___ @@ -182,7 +182,7 @@ ___ Set "exp" (Expiration Time) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -192,7 +192,7 @@ Set "exp" (Expiration Time) Claim. Inherited from: ProduceJWT.setExpirationTime -Defined in: [lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L85) +Defined in: [lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L85) ___ @@ -205,7 +205,7 @@ a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter. You do not need to invoke this method, it is only really intended for test and vector validation purposes. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -213,7 +213,7 @@ intended for test and vector validation purposes. **Returns:** [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -Defined in: [jwt/encrypt.ts:110](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L110) +Defined in: [jwt/encrypt.ts:110](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L110) ___ @@ -223,7 +223,7 @@ ___ Set "iat" (Issued At) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -233,7 +233,7 @@ Set "iat" (Issued At) Claim. Inherited from: ProduceJWT.setIssuedAt -Defined in: [lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L100) +Defined in: [lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L100) ___ @@ -243,7 +243,7 @@ ___ Set "iss" (Issuer) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -253,7 +253,7 @@ Set "iss" (Issuer) Claim. Inherited from: ProduceJWT.setIssuer -Defined in: [lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L27) +Defined in: [lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L27) ___ @@ -263,7 +263,7 @@ ___ Set "jti" (JWT ID) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -273,7 +273,7 @@ Set "jti" (JWT ID) Claim. Inherited from: ProduceJWT.setJti -Defined in: [lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L57) +Defined in: [lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L57) ___ @@ -286,7 +286,7 @@ Use of this is method is really only needed for ECDH-ES based algorithms when utilizing the Agreement PartyUInfo or Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed and missing. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -294,7 +294,7 @@ Other parameters will always be randomly generated when needed and missing. **Returns:** [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -Defined in: [jwt/encrypt.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L78) +Defined in: [jwt/encrypt.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L78) ___ @@ -304,7 +304,7 @@ ___ Set "nbf" (Not Before) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -314,7 +314,7 @@ Set "nbf" (Not Before) Claim. Inherited from: ProduceJWT.setNotBefore -Defined in: [lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L69) +Defined in: [lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L69) ___ @@ -324,7 +324,7 @@ ___ Sets the JWE Protected Header on the EncryptJWT object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -332,7 +332,7 @@ Sets the JWE Protected Header on the EncryptJWT object. **Returns:** [*EncryptJWT*](jwt_encrypt.encryptjwt.md) -Defined in: [jwt/encrypt.ts:62](https://github.com/panva/jose/blob/v3.11.6/src/jwt/encrypt.ts#L62) +Defined in: [jwt/encrypt.ts:62](https://github.com/panva/jose/blob/v3.12.0/src/jwt/encrypt.ts#L62) ___ @@ -342,7 +342,7 @@ ___ Set "sub" (Subject) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -352,4 +352,4 @@ Set "sub" (Subject) Claim. Inherited from: ProduceJWT.setSubject -Defined in: [lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L37) +Defined in: [lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L37) diff --git a/docs/classes/jwt_sign.signjwt.md b/docs/classes/jwt_sign.signjwt.md index 4d9ddec899..32baf22465 100644 --- a/docs/classes/jwt_sign.signjwt.md +++ b/docs/classes/jwt_sign.signjwt.md @@ -29,7 +29,7 @@ console.log(jwt) ## Hierarchy -* *ProduceJWT* +- *ProduceJWT* ↳ **SignJWT** @@ -57,7 +57,7 @@ console.log(jwt) \+ **new SignJWT**(`payload`: [*JWTPayload*](../interfaces/types.jwtpayload.md)): [*SignJWT*](jwt_sign.signjwt.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -67,7 +67,7 @@ console.log(jwt) Inherited from: ProduceJWT.constructor -Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L10) +Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L10) ## Methods @@ -77,7 +77,7 @@ Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.11.6/ Set "aud" (Audience) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -87,7 +87,7 @@ Set "aud" (Audience) Claim. Inherited from: ProduceJWT.setAudience -Defined in: [lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L47) +Defined in: [lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L47) ___ @@ -97,7 +97,7 @@ ___ Set "exp" (Expiration Time) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -107,7 +107,7 @@ Set "exp" (Expiration Time) Claim. Inherited from: ProduceJWT.setExpirationTime -Defined in: [lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L85) +Defined in: [lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L85) ___ @@ -117,7 +117,7 @@ ___ Set "iat" (Issued At) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -127,7 +127,7 @@ Set "iat" (Issued At) Claim. Inherited from: ProduceJWT.setIssuedAt -Defined in: [lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L100) +Defined in: [lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L100) ___ @@ -137,7 +137,7 @@ ___ Set "iss" (Issuer) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -147,7 +147,7 @@ Set "iss" (Issuer) Claim. Inherited from: ProduceJWT.setIssuer -Defined in: [lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L27) +Defined in: [lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L27) ___ @@ -157,7 +157,7 @@ ___ Set "jti" (JWT ID) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -167,7 +167,7 @@ Set "jti" (JWT ID) Claim. Inherited from: ProduceJWT.setJti -Defined in: [lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L57) +Defined in: [lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L57) ___ @@ -177,7 +177,7 @@ ___ Set "nbf" (Not Before) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -187,7 +187,7 @@ Set "nbf" (Not Before) Claim. Inherited from: ProduceJWT.setNotBefore -Defined in: [lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L69) +Defined in: [lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L69) ___ @@ -197,7 +197,7 @@ ___ Sets the JWS Protected Header on the SignJWT object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -205,7 +205,7 @@ Sets the JWS Protected Header on the SignJWT object. **Returns:** [*SignJWT*](jwt_sign.signjwt.md) -Defined in: [jwt/sign.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/jwt/sign.ts#L43) +Defined in: [jwt/sign.ts:43](https://github.com/panva/jose/blob/v3.12.0/src/jwt/sign.ts#L43) ___ @@ -215,7 +215,7 @@ ___ Set "sub" (Subject) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -225,7 +225,7 @@ Set "sub" (Subject) Claim. Inherited from: ProduceJWT.setSubject -Defined in: [lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L37) +Defined in: [lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L37) ___ @@ -235,7 +235,7 @@ ___ Signs and returns the JWT. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -244,4 +244,4 @@ Signs and returns the JWT. **Returns:** *Promise* -Defined in: [jwt/sign.ts:54](https://github.com/panva/jose/blob/v3.11.6/src/jwt/sign.ts#L54) +Defined in: [jwt/sign.ts:54](https://github.com/panva/jose/blob/v3.12.0/src/jwt/sign.ts#L54) diff --git a/docs/classes/jwt_unsecured.unsecuredjwt.md b/docs/classes/jwt_unsecured.unsecuredjwt.md index 9d00330bf8..f55b517830 100644 --- a/docs/classes/jwt_unsecured.unsecuredjwt.md +++ b/docs/classes/jwt_unsecured.unsecuredjwt.md @@ -38,7 +38,7 @@ console.log(payload) ## Hierarchy -* *ProduceJWT* +- *ProduceJWT* ↳ **UnsecuredJWT** @@ -66,7 +66,7 @@ console.log(payload) \+ **new UnsecuredJWT**(`payload`: [*JWTPayload*](../interfaces/types.jwtpayload.md)): [*UnsecuredJWT*](jwt_unsecured.unsecuredjwt.md) -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -76,7 +76,7 @@ console.log(payload) Inherited from: ProduceJWT.constructor -Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L10) +Defined in: [lib/jwt_producer.ts:10](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L10) ## Methods @@ -88,7 +88,7 @@ Encodes the Unsecured JWT. **Returns:** *string* -Defined in: [jwt/unsecured.ts:49](https://github.com/panva/jose/blob/v3.11.6/src/jwt/unsecured.ts#L49) +Defined in: [jwt/unsecured.ts:49](https://github.com/panva/jose/blob/v3.12.0/src/jwt/unsecured.ts#L49) ___ @@ -98,7 +98,7 @@ ___ Set "aud" (Audience) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -108,7 +108,7 @@ Set "aud" (Audience) Claim. Inherited from: ProduceJWT.setAudience -Defined in: [lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L47) +Defined in: [lib/jwt_producer.ts:47](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L47) ___ @@ -118,7 +118,7 @@ ___ Set "exp" (Expiration Time) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -128,7 +128,7 @@ Set "exp" (Expiration Time) Claim. Inherited from: ProduceJWT.setExpirationTime -Defined in: [lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L85) +Defined in: [lib/jwt_producer.ts:85](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L85) ___ @@ -138,7 +138,7 @@ ___ Set "iat" (Issued At) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -148,7 +148,7 @@ Set "iat" (Issued At) Claim. Inherited from: ProduceJWT.setIssuedAt -Defined in: [lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L100) +Defined in: [lib/jwt_producer.ts:100](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L100) ___ @@ -158,7 +158,7 @@ ___ Set "iss" (Issuer) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -168,7 +168,7 @@ Set "iss" (Issuer) Claim. Inherited from: ProduceJWT.setIssuer -Defined in: [lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L27) +Defined in: [lib/jwt_producer.ts:27](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L27) ___ @@ -178,7 +178,7 @@ ___ Set "jti" (JWT ID) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -188,7 +188,7 @@ Set "jti" (JWT ID) Claim. Inherited from: ProduceJWT.setJti -Defined in: [lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L57) +Defined in: [lib/jwt_producer.ts:57](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L57) ___ @@ -198,7 +198,7 @@ ___ Set "nbf" (Not Before) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -208,7 +208,7 @@ Set "nbf" (Not Before) Claim. Inherited from: ProduceJWT.setNotBefore -Defined in: [lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L69) +Defined in: [lib/jwt_producer.ts:69](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L69) ___ @@ -218,7 +218,7 @@ ___ Set "sub" (Subject) Claim. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -228,17 +228,17 @@ Set "sub" (Subject) Claim. Inherited from: ProduceJWT.setSubject -Defined in: [lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.11.6/src/lib/jwt_producer.ts#L37) +Defined in: [lib/jwt_producer.ts:37](https://github.com/panva/jose/blob/v3.12.0/src/lib/jwt_producer.ts#L37) ___ ### decode -▸ `Static`**decode**(`jwt`: *string*, `options?`: [*JWTClaimVerificationOptions*](../interfaces/types.jwtclaimverificationoptions.md)): *object* +▸ `Static` **decode**(`jwt`: *string*, `options?`: [*JWTClaimVerificationOptions*](../interfaces/types.jwtclaimverificationoptions.md)): *object* Decodes an unsecured JWT. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -252,4 +252,4 @@ Decodes an unsecured JWT. | `header` | [*JWSHeaderParameters*](../interfaces/types.jwsheaderparameters.md) | | `payload` | [*JWTPayload*](../interfaces/types.jwtpayload.md) | -Defined in: [jwt/unsecured.ts:62](https://github.com/panva/jose/blob/v3.11.6/src/jwt/unsecured.ts#L62) +Defined in: [jwt/unsecured.ts:62](https://github.com/panva/jose/blob/v3.12.0/src/jwt/unsecured.ts#L62) diff --git a/docs/classes/util_errors.josealgnotallowed.md b/docs/classes/util_errors.josealgnotallowed.md index 63841bc217..086706cc81 100644 --- a/docs/classes/util_errors.josealgnotallowed.md +++ b/docs/classes/util_errors.josealgnotallowed.md @@ -6,7 +6,7 @@ An error subclass thrown when a JOSE Algorithm is not allowed per developer pref ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JOSEAlgNotAllowed** @@ -27,7 +27,7 @@ An error subclass thrown when a JOSE Algorithm is not allowed per developer pref \+ **new JOSEAlgNotAllowed**(`message?`: *string*): [*JOSEAlgNotAllowed*](util_errors.josealgnotallowed.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -37,7 +37,7 @@ An error subclass thrown when a JOSE Algorithm is not allowed per developer pref Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -49,7 +49,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:58](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L58) +Defined in: [util/errors.ts:58](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L58) ___ @@ -61,4 +61,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:56](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L56) +Defined in: [util/errors.ts:56](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L56) diff --git a/docs/classes/util_errors.joseerror.md b/docs/classes/util_errors.joseerror.md index 69347d5723..028e9f03bf 100644 --- a/docs/classes/util_errors.joseerror.md +++ b/docs/classes/util_errors.joseerror.md @@ -7,7 +7,7 @@ JOSE Error subclasses inherit from. ## Hierarchy -* *Error* +- *Error* ↳ **JOSEError** @@ -52,7 +52,7 @@ JOSE Error subclasses inherit from. \+ **new JOSEError**(`message?`: *string*): [*JOSEError*](util_errors.joseerror.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -62,7 +62,7 @@ JOSE Error subclasses inherit from. Overrides: Error.constructor -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -72,7 +72,7 @@ Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/u A unique error code for the particular error subclass. -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ___ @@ -82,4 +82,4 @@ ___ A unique error code for the particular error subclass. -Defined in: [util/errors.ts:11](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L11) +Defined in: [util/errors.ts:11](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L11) diff --git a/docs/classes/util_errors.josenotsupported.md b/docs/classes/util_errors.josenotsupported.md index 0600c54e7e..619e2d27f8 100644 --- a/docs/classes/util_errors.josenotsupported.md +++ b/docs/classes/util_errors.josenotsupported.md @@ -7,7 +7,7 @@ implementation or JOSE in general. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JOSENotSupported** @@ -28,7 +28,7 @@ implementation or JOSE in general. \+ **new JOSENotSupported**(`message?`: *string*): [*JOSENotSupported*](util_errors.josenotsupported.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -38,7 +38,7 @@ implementation or JOSE in general. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -50,7 +50,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:68](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L68) +Defined in: [util/errors.ts:68](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L68) ___ @@ -62,4 +62,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:66](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L66) +Defined in: [util/errors.ts:66](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L66) diff --git a/docs/classes/util_errors.jwedecryptionfailed.md b/docs/classes/util_errors.jwedecryptionfailed.md index 1627a6ef0d..d148b175d3 100644 --- a/docs/classes/util_errors.jwedecryptionfailed.md +++ b/docs/classes/util_errors.jwedecryptionfailed.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWE ciphertext decryption fails. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWEDecryptionFailed** @@ -28,7 +28,7 @@ An error subclass thrown when a JWE ciphertext decryption fails. \+ **new JWEDecryptionFailed**(`message?`: *string*): [*JWEDecryptionFailed*](util_errors.jwedecryptionfailed.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -38,7 +38,7 @@ An error subclass thrown when a JWE ciphertext decryption fails. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -50,7 +50,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:77](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L77) +Defined in: [util/errors.ts:77](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L77) ___ @@ -60,7 +60,7 @@ ___ Overrides: JOSEError.message -Defined in: [util/errors.ts:79](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L79) +Defined in: [util/errors.ts:79](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L79) ___ @@ -72,4 +72,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:75](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L75) +Defined in: [util/errors.ts:75](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L75) diff --git a/docs/classes/util_errors.jweinvalid.md b/docs/classes/util_errors.jweinvalid.md index 63c06068f4..a821425aee 100644 --- a/docs/classes/util_errors.jweinvalid.md +++ b/docs/classes/util_errors.jweinvalid.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWE is invalid. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWEInvalid** @@ -27,7 +27,7 @@ An error subclass thrown when a JWE is invalid. \+ **new JWEInvalid**(`message?`: *string*): [*JWEInvalid*](util_errors.jweinvalid.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -37,7 +37,7 @@ An error subclass thrown when a JWE is invalid. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -49,7 +49,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:88](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L88) +Defined in: [util/errors.ts:88](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L88) ___ @@ -61,4 +61,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:86](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L86) +Defined in: [util/errors.ts:86](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L86) diff --git a/docs/classes/util_errors.jwkinvalid.md b/docs/classes/util_errors.jwkinvalid.md index 8b79bd75ae..bb33c866a7 100644 --- a/docs/classes/util_errors.jwkinvalid.md +++ b/docs/classes/util_errors.jwkinvalid.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWK is invalid. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWKInvalid** @@ -27,7 +27,7 @@ An error subclass thrown when a JWK is invalid. \+ **new JWKInvalid**(`message?`: *string*): [*JWKInvalid*](util_errors.jwkinvalid.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -37,7 +37,7 @@ An error subclass thrown when a JWK is invalid. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -49,7 +49,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:115](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L115) +Defined in: [util/errors.ts:115](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L115) ___ @@ -61,4 +61,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:113](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L113) +Defined in: [util/errors.ts:113](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L113) diff --git a/docs/classes/util_errors.jwksinvalid.md b/docs/classes/util_errors.jwksinvalid.md index ecc24bbd73..88927166eb 100644 --- a/docs/classes/util_errors.jwksinvalid.md +++ b/docs/classes/util_errors.jwksinvalid.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWKS is invalid. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWKSInvalid** @@ -27,7 +27,7 @@ An error subclass thrown when a JWKS is invalid. \+ **new JWKSInvalid**(`message?`: *string*): [*JWKSInvalid*](util_errors.jwksinvalid.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -37,7 +37,7 @@ An error subclass thrown when a JWKS is invalid. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -49,7 +49,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:124](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L124) +Defined in: [util/errors.ts:124](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L124) ___ @@ -61,4 +61,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:122](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L122) +Defined in: [util/errors.ts:122](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L122) diff --git a/docs/classes/util_errors.jwksmultiplematchingkeys.md b/docs/classes/util_errors.jwksmultiplematchingkeys.md index e7358f199d..025283977d 100644 --- a/docs/classes/util_errors.jwksmultiplematchingkeys.md +++ b/docs/classes/util_errors.jwksmultiplematchingkeys.md @@ -6,7 +6,7 @@ An error subclass thrown when multiple keys match from a JWKS. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWKSMultipleMatchingKeys** @@ -28,7 +28,7 @@ An error subclass thrown when multiple keys match from a JWKS. \+ **new JWKSMultipleMatchingKeys**(`message?`: *string*): [*JWKSMultipleMatchingKeys*](util_errors.jwksmultiplematchingkeys.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -38,7 +38,7 @@ An error subclass thrown when multiple keys match from a JWKS. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -50,7 +50,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:144](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L144) +Defined in: [util/errors.ts:144](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L144) ___ @@ -60,7 +60,7 @@ ___ Overrides: JOSEError.message -Defined in: [util/errors.ts:146](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L146) +Defined in: [util/errors.ts:146](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L146) ___ @@ -72,4 +72,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:142](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L142) +Defined in: [util/errors.ts:142](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L142) diff --git a/docs/classes/util_errors.jwksnomatchingkey.md b/docs/classes/util_errors.jwksnomatchingkey.md index d270c0f417..14fd40ade6 100644 --- a/docs/classes/util_errors.jwksnomatchingkey.md +++ b/docs/classes/util_errors.jwksnomatchingkey.md @@ -6,7 +6,7 @@ An error subclass thrown when no keys match from a JWKS. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWKSNoMatchingKey** @@ -28,7 +28,7 @@ An error subclass thrown when no keys match from a JWKS. \+ **new JWKSNoMatchingKey**(`message?`: *string*): [*JWKSNoMatchingKey*](util_errors.jwksnomatchingkey.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -38,7 +38,7 @@ An error subclass thrown when no keys match from a JWKS. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -50,7 +50,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:133](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L133) +Defined in: [util/errors.ts:133](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L133) ___ @@ -60,7 +60,7 @@ ___ Overrides: JOSEError.message -Defined in: [util/errors.ts:135](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L135) +Defined in: [util/errors.ts:135](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L135) ___ @@ -72,4 +72,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:131](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L131) +Defined in: [util/errors.ts:131](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L131) diff --git a/docs/classes/util_errors.jwsinvalid.md b/docs/classes/util_errors.jwsinvalid.md index e4b1fb2fe1..5360a5cdd5 100644 --- a/docs/classes/util_errors.jwsinvalid.md +++ b/docs/classes/util_errors.jwsinvalid.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWS is invalid. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWSInvalid** @@ -27,7 +27,7 @@ An error subclass thrown when a JWS is invalid. \+ **new JWSInvalid**(`message?`: *string*): [*JWSInvalid*](util_errors.jwsinvalid.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -37,7 +37,7 @@ An error subclass thrown when a JWS is invalid. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -49,7 +49,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:97](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L97) +Defined in: [util/errors.ts:97](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L97) ___ @@ -61,4 +61,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:95](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L95) +Defined in: [util/errors.ts:95](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L95) diff --git a/docs/classes/util_errors.jwssignatureverificationfailed.md b/docs/classes/util_errors.jwssignatureverificationfailed.md index 3fed575f5e..66790ff1d5 100644 --- a/docs/classes/util_errors.jwssignatureverificationfailed.md +++ b/docs/classes/util_errors.jwssignatureverificationfailed.md @@ -6,7 +6,7 @@ An error subclass thrown when JWS signature verification fails. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWSSignatureVerificationFailed** @@ -28,7 +28,7 @@ An error subclass thrown when JWS signature verification fails. \+ **new JWSSignatureVerificationFailed**(`message?`: *string*): [*JWSSignatureVerificationFailed*](util_errors.jwssignatureverificationfailed.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -38,7 +38,7 @@ An error subclass thrown when JWS signature verification fails. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -50,7 +50,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:155](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L155) +Defined in: [util/errors.ts:155](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L155) ___ @@ -60,7 +60,7 @@ ___ Overrides: JOSEError.message -Defined in: [util/errors.ts:157](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L157) +Defined in: [util/errors.ts:157](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L157) ___ @@ -72,4 +72,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:153](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L153) +Defined in: [util/errors.ts:153](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L153) diff --git a/docs/classes/util_errors.jwtclaimvalidationfailed.md b/docs/classes/util_errors.jwtclaimvalidationfailed.md index 49cc81aa15..ca680b1241 100644 --- a/docs/classes/util_errors.jwtclaimvalidationfailed.md +++ b/docs/classes/util_errors.jwtclaimvalidationfailed.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWT Claim Set member validation fails. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWTClaimValidationFailed** @@ -31,7 +31,7 @@ An error subclass thrown when a JWT Claim Set member validation fails. \+ **new JWTClaimValidationFailed**(`message`: *string*, `claim?`: *string*, `reason?`: *string*): [*JWTClaimValidationFailed*](util_errors.jwtclaimvalidationfailed.md) -#### Parameters: +#### Parameters | Name | Type | Default value | | :------ | :------ | :------ | @@ -43,7 +43,7 @@ An error subclass thrown when a JWT Claim Set member validation fails. Overrides: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L43) +Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L43) ## Properties @@ -53,7 +53,7 @@ Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/u The Claim for which the validation failed. -Defined in: [util/errors.ts:38](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L38) +Defined in: [util/errors.ts:38](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L38) ___ @@ -65,7 +65,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:33](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L33) +Defined in: [util/errors.ts:33](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L33) ___ @@ -75,7 +75,7 @@ ___ Reason code for the validation failure. -Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L43) +Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L43) ___ @@ -87,4 +87,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:31](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L31) +Defined in: [util/errors.ts:31](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L31) diff --git a/docs/classes/util_errors.jwtexpired.md b/docs/classes/util_errors.jwtexpired.md index d653649dfb..0556cf1c3b 100644 --- a/docs/classes/util_errors.jwtexpired.md +++ b/docs/classes/util_errors.jwtexpired.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWT is expired. ## Hierarchy -* [*JWTClaimValidationFailed*](util_errors.jwtclaimvalidationfailed.md) +- [*JWTClaimValidationFailed*](util_errors.jwtclaimvalidationfailed.md) ↳ **JWTExpired** @@ -29,7 +29,7 @@ An error subclass thrown when a JWT is expired. \+ **new JWTExpired**(`message`: *string*, `claim?`: *string*, `reason?`: *string*): [*JWTExpired*](util_errors.jwtexpired.md) -#### Parameters: +#### Parameters | Name | Type | Default value | | :------ | :------ | :------ | @@ -41,7 +41,7 @@ An error subclass thrown when a JWT is expired. Inherited from: [JWTClaimValidationFailed](util_errors.jwtclaimvalidationfailed.md) -Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L43) +Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L43) ## Properties @@ -53,7 +53,7 @@ The Claim for which the validation failed. Inherited from: [JWTClaimValidationFailed](util_errors.jwtclaimvalidationfailed.md).[claim](util_errors.jwtclaimvalidationfailed.md#claim) -Defined in: [util/errors.ts:38](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L38) +Defined in: [util/errors.ts:38](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L38) ___ @@ -65,7 +65,7 @@ A unique error code for the particular error subclass. Overrides: [JWTClaimValidationFailed](util_errors.jwtclaimvalidationfailed.md).[code](util_errors.jwtclaimvalidationfailed.md#code) -Defined in: [util/errors.ts:166](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L166) +Defined in: [util/errors.ts:166](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L166) ___ @@ -77,7 +77,7 @@ Reason code for the validation failure. Inherited from: [JWTClaimValidationFailed](util_errors.jwtclaimvalidationfailed.md).[reason](util_errors.jwtclaimvalidationfailed.md#reason) -Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L43) +Defined in: [util/errors.ts:43](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L43) ___ @@ -89,4 +89,4 @@ A unique error code for the particular error subclass. Overrides: [JWTClaimValidationFailed](util_errors.jwtclaimvalidationfailed.md).[code](util_errors.jwtclaimvalidationfailed.md#code) -Defined in: [util/errors.ts:164](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L164) +Defined in: [util/errors.ts:164](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L164) diff --git a/docs/classes/util_errors.jwtinvalid.md b/docs/classes/util_errors.jwtinvalid.md index d3363cebdb..3470490860 100644 --- a/docs/classes/util_errors.jwtinvalid.md +++ b/docs/classes/util_errors.jwtinvalid.md @@ -6,7 +6,7 @@ An error subclass thrown when a JWT is invalid. ## Hierarchy -* [*JOSEError*](util_errors.joseerror.md) +- [*JOSEError*](util_errors.joseerror.md) ↳ **JWTInvalid** @@ -27,7 +27,7 @@ An error subclass thrown when a JWT is invalid. \+ **new JWTInvalid**(`message?`: *string*): [*JWTInvalid*](util_errors.jwtinvalid.md) -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -37,7 +37,7 @@ An error subclass thrown when a JWT is invalid. Inherited from: [JOSEError](util_errors.joseerror.md) -Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L16) +Defined in: [util/errors.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L16) ## Properties @@ -49,7 +49,7 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:106](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L106) +Defined in: [util/errors.ts:106](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L106) ___ @@ -61,4 +61,4 @@ A unique error code for the particular error subclass. Overrides: [JOSEError](util_errors.joseerror.md).[code](util_errors.joseerror.md#code) -Defined in: [util/errors.ts:104](https://github.com/panva/jose/blob/v3.11.6/src/util/errors.ts#L104) +Defined in: [util/errors.ts:104](https://github.com/panva/jose/blob/v3.12.0/src/util/errors.ts#L104) diff --git a/docs/functions/jwe_compact_decrypt.compactdecrypt.md b/docs/functions/jwe_compact_decrypt.compactdecrypt.md index ef94a6475c..bdaa44543a 100644 --- a/docs/functions/jwe_compact_decrypt.compactdecrypt.md +++ b/docs/functions/jwe_compact_decrypt.compactdecrypt.md @@ -27,7 +27,7 @@ console.log(protectedHeader) console.log(decoder.decode(plaintext)) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -37,4 +37,4 @@ console.log(decoder.decode(plaintext)) **Returns:** *Promise*<[*CompactDecryptResult*](../interfaces/types.compactdecryptresult.md)\> -Defined in: [jwe/compact/decrypt.ts:47](https://github.com/panva/jose/blob/v3.11.6/src/jwe/compact/decrypt.ts#L47) +Defined in: [jwe/compact/decrypt.ts:47](https://github.com/panva/jose/blob/v3.12.0/src/jwe/compact/decrypt.ts#L47) diff --git a/docs/functions/jwe_flattened_decrypt.flatteneddecrypt.md b/docs/functions/jwe_flattened_decrypt.flatteneddecrypt.md index 54a4802a8c..89c8f7ee16 100644 --- a/docs/functions/jwe_flattened_decrypt.flatteneddecrypt.md +++ b/docs/functions/jwe_flattened_decrypt.flatteneddecrypt.md @@ -39,7 +39,7 @@ console.log(decoder.decode(plaintext)) console.log(decoder.decode(additionalAuthenticatedData)) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -49,4 +49,4 @@ console.log(decoder.decode(additionalAuthenticatedData)) **Returns:** *Promise*<[*FlattenedDecryptResult*](../interfaces/types.flatteneddecryptresult.md)\> -Defined in: [jwe/flattened/decrypt.ts:76](https://github.com/panva/jose/blob/v3.11.6/src/jwe/flattened/decrypt.ts#L76) +Defined in: [jwe/flattened/decrypt.ts:76](https://github.com/panva/jose/blob/v3.12.0/src/jwe/flattened/decrypt.ts#L76) diff --git a/docs/functions/jwe_general_decrypt.generaldecrypt.md b/docs/functions/jwe_general_decrypt.generaldecrypt.md index b74d670afd..2906dc513a 100644 --- a/docs/functions/jwe_general_decrypt.generaldecrypt.md +++ b/docs/functions/jwe_general_decrypt.generaldecrypt.md @@ -43,7 +43,7 @@ console.log(decoder.decode(plaintext)) console.log(decoder.decode(additionalAuthenticatedData)) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -53,4 +53,4 @@ console.log(decoder.decode(additionalAuthenticatedData)) **Returns:** *Promise*<[*GeneralDecryptResult*](../interfaces/types.generaldecryptresult.md)\> -Defined in: [jwe/general/decrypt.ts:64](https://github.com/panva/jose/blob/v3.11.6/src/jwe/general/decrypt.ts#L64) +Defined in: [jwe/general/decrypt.ts:64](https://github.com/panva/jose/blob/v3.12.0/src/jwe/general/decrypt.ts#L64) diff --git a/docs/functions/jwk_embedded.embeddedjwk.md b/docs/functions/jwk_embedded.embeddedjwk.md index 0da7ad2a04..8a614a807b 100644 --- a/docs/functions/jwk_embedded.embeddedjwk.md +++ b/docs/functions/jwk_embedded.embeddedjwk.md @@ -35,7 +35,7 @@ console.log(protectedHeader) console.log(payload) ``` -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -44,4 +44,4 @@ console.log(payload) **Returns:** *Promise* -Defined in: [jwk/embedded.ts:40](https://github.com/panva/jose/blob/v3.11.6/src/jwk/embedded.ts#L40) +Defined in: [jwk/embedded.ts:40](https://github.com/panva/jose/blob/v3.12.0/src/jwk/embedded.ts#L40) diff --git a/docs/functions/jwk_from_key_like.fromkeylike.md b/docs/functions/jwk_from_key_like.fromkeylike.md index f9ffd9c906..758dbd74cf 100644 --- a/docs/functions/jwk_from_key_like.fromkeylike.md +++ b/docs/functions/jwk_from_key_like.fromkeylike.md @@ -25,7 +25,7 @@ console.log(privateJwk) console.log(publicJwk) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -33,4 +33,4 @@ console.log(publicJwk) **Returns:** *Promise*<[*JWK*](../interfaces/types.jwk.md)\> -Defined in: [jwk/from_key_like.ts:29](https://github.com/panva/jose/blob/v3.11.6/src/jwk/from_key_like.ts#L29) +Defined in: [jwk/from_key_like.ts:29](https://github.com/panva/jose/blob/v3.12.0/src/jwk/from_key_like.ts#L29) diff --git a/docs/functions/jwk_parse.parsejwk.md b/docs/functions/jwk_parse.parsejwk.md index 77ccd6a421..041dce7614 100644 --- a/docs/functions/jwk_parse.parsejwk.md +++ b/docs/functions/jwk_parse.parsejwk.md @@ -35,7 +35,7 @@ const rsaPublicKey = await parseJwk({ }, 'PS256') ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -45,4 +45,4 @@ const rsaPublicKey = await parseJwk({ **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [jwk/parse.ts:45](https://github.com/panva/jose/blob/v3.11.6/src/jwk/parse.ts#L45) +Defined in: [jwk/parse.ts:45](https://github.com/panva/jose/blob/v3.12.0/src/jwk/parse.ts#L45) diff --git a/docs/functions/jwk_thumbprint.calculatethumbprint.md b/docs/functions/jwk_thumbprint.calculatethumbprint.md index e17aadc658..cd4288002e 100644 --- a/docs/functions/jwk_thumbprint.calculatethumbprint.md +++ b/docs/functions/jwk_thumbprint.calculatethumbprint.md @@ -28,7 +28,7 @@ const thumbprint = await calculateThumbprint({ console.log(thumbprint) ``` -#### Parameters: +#### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | @@ -37,4 +37,4 @@ console.log(thumbprint) **Returns:** *Promise* -Defined in: [jwk/thumbprint.ts:44](https://github.com/panva/jose/blob/v3.11.6/src/jwk/thumbprint.ts#L44) +Defined in: [jwk/thumbprint.ts:44](https://github.com/panva/jose/blob/v3.12.0/src/jwk/thumbprint.ts#L44) diff --git a/docs/functions/jwks_remote.createremotejwkset.md b/docs/functions/jwks_remote.createremotejwkset.md index 0cd0b52db3..a7f1255946 100644 --- a/docs/functions/jwks_remote.createremotejwkset.md +++ b/docs/functions/jwks_remote.createremotejwkset.md @@ -33,7 +33,7 @@ console.log(protectedHeader) console.log(payload) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -42,4 +42,4 @@ console.log(payload) **Returns:** [*GetKeyFunction*](../interfaces/types.getkeyfunction.md)<[*JWSHeaderParameters*](../interfaces/types.jwsheaderparameters.md), [*FlattenedJWSInput*](../interfaces/types.flattenedjwsinput.md)\> -Defined in: [jwks/remote.ts:248](https://github.com/panva/jose/blob/v3.11.6/src/jwks/remote.ts#L248) +Defined in: [jwks/remote.ts:248](https://github.com/panva/jose/blob/v3.12.0/src/jwks/remote.ts#L248) diff --git a/docs/functions/jws_compact_verify.compactverify.md b/docs/functions/jws_compact_verify.compactverify.md index 5c1ca56832..a9331a760b 100644 --- a/docs/functions/jws_compact_verify.compactverify.md +++ b/docs/functions/jws_compact_verify.compactverify.md @@ -27,7 +27,7 @@ console.log(protectedHeader) console.log(decoder.decode(payload)) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -37,4 +37,4 @@ console.log(decoder.decode(payload)) **Returns:** *Promise*<[*CompactVerifyResult*](../interfaces/types.compactverifyresult.md)\> -Defined in: [jws/compact/verify.ts:51](https://github.com/panva/jose/blob/v3.11.6/src/jws/compact/verify.ts#L51) +Defined in: [jws/compact/verify.ts:51](https://github.com/panva/jose/blob/v3.12.0/src/jws/compact/verify.ts#L51) diff --git a/docs/functions/jws_flattened_verify.flattenedverify.md b/docs/functions/jws_flattened_verify.flattenedverify.md index 3201538093..c37540ed93 100644 --- a/docs/functions/jws_flattened_verify.flattenedverify.md +++ b/docs/functions/jws_flattened_verify.flattenedverify.md @@ -31,7 +31,7 @@ console.log(protectedHeader) console.log(decoder.decode(payload)) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -41,4 +41,4 @@ console.log(decoder.decode(payload)) **Returns:** *Promise*<[*FlattenedVerifyResult*](../interfaces/types.flattenedverifyresult.md)\> -Defined in: [jws/flattened/verify.ts:66](https://github.com/panva/jose/blob/v3.11.6/src/jws/flattened/verify.ts#L66) +Defined in: [jws/flattened/verify.ts:66](https://github.com/panva/jose/blob/v3.12.0/src/jws/flattened/verify.ts#L66) diff --git a/docs/functions/jws_general_verify.generalverify.md b/docs/functions/jws_general_verify.generalverify.md index 39459dd90f..11601e003a 100644 --- a/docs/functions/jws_general_verify.generalverify.md +++ b/docs/functions/jws_general_verify.generalverify.md @@ -35,7 +35,7 @@ console.log(protectedHeader) console.log(decoder.decode(payload)) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -45,4 +45,4 @@ console.log(decoder.decode(payload)) **Returns:** *Promise*<[*GeneralVerifyResult*](../interfaces/types.generalverifyresult.md)\> -Defined in: [jws/general/verify.ts:60](https://github.com/panva/jose/blob/v3.11.6/src/jws/general/verify.ts#L60) +Defined in: [jws/general/verify.ts:60](https://github.com/panva/jose/blob/v3.12.0/src/jws/general/verify.ts#L60) diff --git a/docs/functions/jwt_decrypt.jwtdecrypt.md b/docs/functions/jwt_decrypt.jwtdecrypt.md index 9ef9d0691d..9a997a8d01 100644 --- a/docs/functions/jwt_decrypt.jwtdecrypt.md +++ b/docs/functions/jwt_decrypt.jwtdecrypt.md @@ -29,7 +29,7 @@ console.log(protectedHeader) console.log(payload) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -39,4 +39,4 @@ console.log(payload) **Returns:** *Promise*<[*JWTDecryptResult*](../interfaces/types.jwtdecryptresult.md)\> -Defined in: [jwt/decrypt.ts:56](https://github.com/panva/jose/blob/v3.11.6/src/jwt/decrypt.ts#L56) +Defined in: [jwt/decrypt.ts:56](https://github.com/panva/jose/blob/v3.12.0/src/jwt/decrypt.ts#L56) diff --git a/docs/functions/jwt_verify.jwtverify.md b/docs/functions/jwt_verify.jwtverify.md index 4f2a7f1b67..3b5aeb41fa 100644 --- a/docs/functions/jwt_verify.jwtverify.md +++ b/docs/functions/jwt_verify.jwtverify.md @@ -29,7 +29,7 @@ console.log(protectedHeader) console.log(payload) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -39,4 +39,4 @@ console.log(payload) **Returns:** *Promise*<[*JWTVerifyResult*](../interfaces/types.jwtverifyresult.md)\> -Defined in: [jwt/verify.ts:59](https://github.com/panva/jose/blob/v3.11.6/src/jwt/verify.ts#L59) +Defined in: [jwt/verify.ts:59](https://github.com/panva/jose/blob/v3.12.0/src/jwt/verify.ts#L59) diff --git a/docs/functions/util_base64url.decode.md b/docs/functions/util_base64url.decode.md index 7eee8f1104..592d689f17 100644 --- a/docs/functions/util_base64url.decode.md +++ b/docs/functions/util_base64url.decode.md @@ -2,9 +2,9 @@ [util/base64url](../modules/util_base64url.md).decode -▸ `Const`**decode**(`input`: *string* \| *Uint8Array*): *Uint8Array* +▸ `Const` **decode**(`input`: *string* \| *Uint8Array*): *Uint8Array* -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -12,4 +12,4 @@ **Returns:** *Uint8Array* -Defined in: [util/base64url.ts:23](https://github.com/panva/jose/blob/v3.11.6/src/util/base64url.ts#L23) +Defined in: [util/base64url.ts:23](https://github.com/panva/jose/blob/v3.12.0/src/util/base64url.ts#L23) diff --git a/docs/functions/util_base64url.encode.md b/docs/functions/util_base64url.encode.md index e9679a46cf..adef48965f 100644 --- a/docs/functions/util_base64url.encode.md +++ b/docs/functions/util_base64url.encode.md @@ -2,9 +2,9 @@ [util/base64url](../modules/util_base64url.md).encode -▸ `Const`**encode**(`input`: *string* \| *Uint8Array*): *string* +▸ `Const` **encode**(`input`: *string* \| *Uint8Array*): *string* -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -12,4 +12,4 @@ **Returns:** *string* -Defined in: [util/base64url.ts:22](https://github.com/panva/jose/blob/v3.11.6/src/util/base64url.ts#L22) +Defined in: [util/base64url.ts:22](https://github.com/panva/jose/blob/v3.12.0/src/util/base64url.ts#L22) diff --git a/docs/functions/util_decode_protected_header.decodeprotectedheader.md b/docs/functions/util_decode_protected_header.decodeprotectedheader.md index 5868d63de4..cb883de2fa 100644 --- a/docs/functions/util_decode_protected_header.decodeprotectedheader.md +++ b/docs/functions/util_decode_protected_header.decodeprotectedheader.md @@ -22,7 +22,7 @@ const protectedHeader = decodeProtectedHeader(token) console.log(protectedHeader) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -30,4 +30,4 @@ console.log(protectedHeader) **Returns:** [*ProtectedHeaderParameters*](../types/util_decode_protected_header.protectedheaderparameters.md) -Defined in: [util/decode_protected_header.ts:31](https://github.com/panva/jose/blob/v3.11.6/src/util/decode_protected_header.ts#L31) +Defined in: [util/decode_protected_header.ts:31](https://github.com/panva/jose/blob/v3.12.0/src/util/decode_protected_header.ts#L31) diff --git a/docs/functions/util_generate_key_pair.generatekeypair.md b/docs/functions/util_generate_key_pair.generatekeypair.md index e137adccbc..a3cfccea88 100644 --- a/docs/functions/util_generate_key_pair.generatekeypair.md +++ b/docs/functions/util_generate_key_pair.generatekeypair.md @@ -8,6 +8,9 @@ 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 `generateSecret` function. +Note: Under Web Cryptography API runtime the `privateKey` is generated with +`extractable` set to `false` by default. + **`example`** ESM import ```js import { generateKeyPair } from 'jose/util/generate_key_pair' @@ -25,7 +28,7 @@ console.log(publicKey) console.log(privateKey) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -34,4 +37,4 @@ console.log(privateKey) **Returns:** *Promise*<{ `privateKey`: [*KeyLike*](../types/types.keylike.md) ; `publicKey`: [*KeyLike*](../types/types.keylike.md) }\> -Defined in: [util/generate_key_pair.ts:44](https://github.com/panva/jose/blob/v3.11.6/src/util/generate_key_pair.ts#L44) +Defined in: [util/generate_key_pair.ts:54](https://github.com/panva/jose/blob/v3.12.0/src/util/generate_key_pair.ts#L54) diff --git a/docs/functions/util_generate_secret.generatesecret.md b/docs/functions/util_generate_secret.generatesecret.md index 5d3cbed526..12013d013c 100644 --- a/docs/functions/util_generate_secret.generatesecret.md +++ b/docs/functions/util_generate_secret.generatesecret.md @@ -2,10 +2,13 @@ [util/generate_secret](../modules/util_generate_secret.md).generateSecret -▸ **generateSecret**(`alg`: *string*): *Promise*<[*KeyLike*](../types/types.keylike.md)\> +▸ **generateSecret**(`alg`: *string*, `options?`: [*GenerateSecretOptions*](../interfaces/util_generate_secret.generatesecretoptions.md)): *Promise*<[*KeyLike*](../types/types.keylike.md)\> Generates a symmetric secret key for a given JWA algorithm identifier. +Note: Under Web Cryptography API runtime the secret key is generated with +`extractable` set to `false` by default. + **`example`** ESM import ```js import { generateSecret } from 'jose/util/generate_secret' @@ -22,12 +25,13 @@ const secret = await generateSecret('HS256') console.log(secret) ``` -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `alg` | *string* | JWA Algorithm Identifier to be used with the generated secret. | +| `options?` | [*GenerateSecretOptions*](../interfaces/util_generate_secret.generatesecretoptions.md) | Additional options passed down to the secret generation. | **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [util/generate_secret.ts:25](https://github.com/panva/jose/blob/v3.11.6/src/util/generate_secret.ts#L25) +Defined in: [util/generate_secret.ts:38](https://github.com/panva/jose/blob/v3.12.0/src/util/generate_secret.ts#L38) diff --git a/docs/functions/util_random.random.md b/docs/functions/util_random.random.md index 38d72fe4e3..cfe4752150 100644 --- a/docs/functions/util_random.random.md +++ b/docs/functions/util_random.random.md @@ -2,9 +2,9 @@ [util/random](../modules/util_random.md).random -▸ `Const`**random**(`array`: *Uint8Array*): *Uint8Array* +▸ `Const` **random**(`array`: *Uint8Array*): *Uint8Array* -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -12,4 +12,4 @@ **Returns:** *Uint8Array* -Defined in: [util/random.ts:7](https://github.com/panva/jose/blob/v3.11.6/src/util/random.ts#L7) +Defined in: [util/random.ts:7](https://github.com/panva/jose/blob/v3.12.0/src/util/random.ts#L7) diff --git a/docs/interfaces/jwe_compact_decrypt.compactdecryptgetkey.md b/docs/interfaces/jwe_compact_decrypt.compactdecryptgetkey.md index 34107ac014..3fe44ddba3 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. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md), [*FlattenedJWE*](types.flattenedjwe.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md), [*FlattenedJWE*](types.flattenedjwe.md)\> ↳ **CompactDecryptGetKey** @@ -18,7 +18,7 @@ No token components have been verified at the time of this function call. Interface for Compact JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -27,4 +27,4 @@ No token components have been verified at the time of this function call. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jwe_flattened_decrypt.flatteneddecryptgetkey.md b/docs/interfaces/jwe_flattened_decrypt.flatteneddecryptgetkey.md index cd31190780..9fed93efe5 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. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md) \| undefined, [*FlattenedJWE*](types.flattenedjwe.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md) \| undefined, [*FlattenedJWE*](types.flattenedjwe.md)\> ↳ **FlattenedDecryptGetKey** @@ -18,7 +18,7 @@ No token components have been verified at the time of this function call. Interface for Flattened JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -27,4 +27,4 @@ No token components have been verified at the time of this function call. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jwe_general_decrypt.generaldecryptgetkey.md b/docs/interfaces/jwe_general_decrypt.generaldecryptgetkey.md index 7626c4c64c..10fd6a9af2 100644 --- a/docs/interfaces/jwe_general_decrypt.generaldecryptgetkey.md +++ b/docs/interfaces/jwe_general_decrypt.generaldecryptgetkey.md @@ -7,7 +7,7 @@ No token components have been verified at the time of this function call. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md), [*FlattenedJWE*](types.flattenedjwe.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md), [*FlattenedJWE*](types.flattenedjwe.md)\> ↳ **GeneralDecryptGetKey** @@ -18,7 +18,7 @@ No token components have been verified at the time of this function call. Interface for General JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -27,4 +27,4 @@ No token components have been verified at the time of this function call. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jwks_remote.remotejwksetoptions.md b/docs/interfaces/jwks_remote.remotejwksetoptions.md index e057488081..3789e28ba2 100644 --- a/docs/interfaces/jwks_remote.remotejwksetoptions.md +++ b/docs/interfaces/jwks_remote.remotejwksetoptions.md @@ -23,7 +23,7 @@ https.get method options. Use when behind an http(s) proxy. This is a Node.js runtime specific option, it is ignored when used outside of Node.js runtime. -Defined in: [jwks/remote.ts:56](https://github.com/panva/jose/blob/v3.11.6/src/jwks/remote.ts#L56) +Defined in: [jwks/remote.ts:56](https://github.com/panva/jose/blob/v3.12.0/src/jwks/remote.ts#L56) ___ @@ -34,7 +34,7 @@ ___ Duration for which no more HTTP requests will be triggered after a previous successful fetch. Default is 30000. -Defined in: [jwks/remote.ts:48](https://github.com/panva/jose/blob/v3.11.6/src/jwks/remote.ts#L48) +Defined in: [jwks/remote.ts:48](https://github.com/panva/jose/blob/v3.12.0/src/jwks/remote.ts#L48) ___ @@ -45,4 +45,4 @@ ___ Timeout for the HTTP request. When reached the request will be aborted and the verification will fail. Default is 5000. -Defined in: [jwks/remote.ts:42](https://github.com/panva/jose/blob/v3.11.6/src/jwks/remote.ts#L42) +Defined in: [jwks/remote.ts:42](https://github.com/panva/jose/blob/v3.12.0/src/jwks/remote.ts#L42) diff --git a/docs/interfaces/jws_compact_verify.compactverifygetkey.md b/docs/interfaces/jws_compact_verify.compactverifygetkey.md index f0a4b521b4..bb503273e6 100644 --- a/docs/interfaces/jws_compact_verify.compactverifygetkey.md +++ b/docs/interfaces/jws_compact_verify.compactverifygetkey.md @@ -10,7 +10,7 @@ to verify using a remote JSON Web Key Set. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md), [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md), [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> ↳ **CompactVerifyGetKey** @@ -24,7 +24,7 @@ No token components have been verified at the time of this function call. See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset) to verify using a remote JSON Web Key Set. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -33,4 +33,4 @@ to verify using a remote JSON Web Key Set. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jws_flattened_verify.flattenedverifygetkey.md b/docs/interfaces/jws_flattened_verify.flattenedverifygetkey.md index dbb13c1e55..8a90dfd8e2 100644 --- a/docs/interfaces/jws_flattened_verify.flattenedverifygetkey.md +++ b/docs/interfaces/jws_flattened_verify.flattenedverifygetkey.md @@ -10,7 +10,7 @@ to verify using a remote JSON Web Key Set. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md) \| undefined, [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md) \| undefined, [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> ↳ **FlattenedVerifyGetKey** @@ -24,7 +24,7 @@ No token components have been verified at the time of this function call. See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset) to verify using a remote JSON Web Key Set. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -33,4 +33,4 @@ to verify using a remote JSON Web Key Set. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jws_general_sign.signature.md b/docs/interfaces/jws_general_sign.signature.md index 1c094e1b9b..76416ab9ca 100644 --- a/docs/interfaces/jws_general_sign.signature.md +++ b/docs/interfaces/jws_general_sign.signature.md @@ -17,7 +17,7 @@ Sets the JWS Protected Header on the Signature object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -25,7 +25,7 @@ Sets the JWS Protected Header on the Signature object. **Returns:** [*Signature*](jws_general_sign.signature.md) -Defined in: [jws/general/sign.ts:13](https://github.com/panva/jose/blob/v3.11.6/src/jws/general/sign.ts#L13) +Defined in: [jws/general/sign.ts:13](https://github.com/panva/jose/blob/v3.12.0/src/jws/general/sign.ts#L13) ___ @@ -35,7 +35,7 @@ ___ Sets the JWS Unprotected Header on the Signature object. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -43,4 +43,4 @@ Sets the JWS Unprotected Header on the Signature object. **Returns:** [*Signature*](jws_general_sign.signature.md) -Defined in: [jws/general/sign.ts:20](https://github.com/panva/jose/blob/v3.11.6/src/jws/general/sign.ts#L20) +Defined in: [jws/general/sign.ts:20](https://github.com/panva/jose/blob/v3.12.0/src/jws/general/sign.ts#L20) diff --git a/docs/interfaces/jws_general_verify.generalverifygetkey.md b/docs/interfaces/jws_general_verify.generalverifygetkey.md index 92a01ecb12..c78e8831e7 100644 --- a/docs/interfaces/jws_general_verify.generalverifygetkey.md +++ b/docs/interfaces/jws_general_verify.generalverifygetkey.md @@ -10,7 +10,7 @@ to verify using a remote JSON Web Key Set. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md), [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md), [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> ↳ **GeneralVerifyGetKey** @@ -24,7 +24,7 @@ No token components have been verified at the time of this function call. See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset) to verify using a remote JSON Web Key Set. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -33,4 +33,4 @@ to verify using a remote JSON Web Key Set. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jwt_decrypt.jwtdecryptgetkey.md b/docs/interfaces/jwt_decrypt.jwtdecryptgetkey.md index dfaa262e8c..23d50435a0 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. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md), [*FlattenedJWE*](types.flattenedjwe.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md), [*FlattenedJWE*](types.flattenedjwe.md)\> ↳ **JWTDecryptGetKey** @@ -18,7 +18,7 @@ No token components have been verified at the time of this function call. Interface for JWT Decryption dynamic key resolution. No token components have been verified at the time of this function call. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -27,4 +27,4 @@ No token components have been verified at the time of this function call. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jwt_decrypt.jwtdecryptoptions.md b/docs/interfaces/jwt_decrypt.jwtdecryptoptions.md index f59c5de2fa..08e882481b 100644 --- a/docs/interfaces/jwt_decrypt.jwtdecryptoptions.md +++ b/docs/interfaces/jwt_decrypt.jwtdecryptoptions.md @@ -6,9 +6,9 @@ Combination of JWE Decryption options and JWT Claims Set verification options. ## Hierarchy -* [*DecryptOptions*](types.decryptoptions.md) +- [*DecryptOptions*](types.decryptoptions.md) -* [*JWTClaimVerificationOptions*](types.jwtclaimverificationoptions.md) +- [*JWTClaimVerificationOptions*](types.jwtclaimverificationoptions.md) ↳ **JWTDecryptOptions** @@ -38,7 +38,7 @@ Expected JWT "aud" (Audience) Claim value(s). Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[audience](types.jwtclaimverificationoptions.md#audience) -Defined in: [types.d.ts:476](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L476) +Defined in: [types.d.ts:480](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L480) ___ @@ -52,7 +52,7 @@ Expected clock tolerance Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[clockTolerance](types.jwtclaimverificationoptions.md#clocktolerance) -Defined in: [types.d.ts:483](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L483) +Defined in: [types.d.ts:487](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L487) ___ @@ -66,7 +66,7 @@ key/secret are allowed. Inherited from: [DecryptOptions](types.decryptoptions.md).[contentEncryptionAlgorithms](types.decryptoptions.md#contentencryptionalgorithms) -Defined in: [types.d.ts:449](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L449) +Defined in: [types.d.ts:453](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L453) ___ @@ -93,11 +93,11 @@ The JWS extension Header Parameter `b64` is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available. -#### Type declaration: +#### Type declaration Inherited from: [DecryptOptions](types.decryptoptions.md).[crit](types.decryptoptions.md#crit) -Defined in: [types.d.ts:430](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L430) +Defined in: [types.d.ts:434](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L434) ___ @@ -109,7 +109,7 @@ Date to use when comparing NumericDate claims, defaults to `new Date()`. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[currentDate](types.jwtclaimverificationoptions.md#currentdate) -Defined in: [types.d.ts:510](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L510) +Defined in: [types.d.ts:514](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L514) ___ @@ -122,7 +122,7 @@ when you expect JWEs with compressed plaintext. Inherited from: [DecryptOptions](types.decryptoptions.md).[inflateRaw](types.decryptoptions.md#inflateraw) -Defined in: [types.d.ts:455](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L455) +Defined in: [types.d.ts:459](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L459) ___ @@ -134,7 +134,7 @@ Expected JWT "iss" (Issuer) Claim value(s). Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[issuer](types.jwtclaimverificationoptions.md#issuer) -Defined in: [types.d.ts:488](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L488) +Defined in: [types.d.ts:492](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L492) ___ @@ -146,7 +146,7 @@ A list of accepted JWE "alg" (Algorithm) Header Parameter values. Inherited from: [DecryptOptions](types.decryptoptions.md).[keyManagementAlgorithms](types.decryptoptions.md#keymanagementalgorithms) -Defined in: [types.d.ts:442](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L442) +Defined in: [types.d.ts:446](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L446) ___ @@ -160,7 +160,7 @@ Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[maxTokenAge](types.jwtclaimverificationoptions.md#maxtokenage) -Defined in: [types.d.ts:495](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L495) +Defined in: [types.d.ts:499](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L499) ___ @@ -172,7 +172,7 @@ Expected JWT "sub" (Subject) Claim value. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[subject](types.jwtclaimverificationoptions.md#subject) -Defined in: [types.d.ts:500](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L500) +Defined in: [types.d.ts:504](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L504) ___ @@ -184,4 +184,4 @@ Expected JWT "typ" (Type) Header Parameter value. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[typ](types.jwtclaimverificationoptions.md#typ) -Defined in: [types.d.ts:505](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L505) +Defined in: [types.d.ts:509](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L509) diff --git a/docs/interfaces/jwt_verify.jwtverifygetkey.md b/docs/interfaces/jwt_verify.jwtverifygetkey.md index 5e9b388b6d..48911170eb 100644 --- a/docs/interfaces/jwt_verify.jwtverifygetkey.md +++ b/docs/interfaces/jwt_verify.jwtverifygetkey.md @@ -10,7 +10,7 @@ to verify using a remote JSON Web Key Set. ## Hierarchy -* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md), [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> +- [*GetKeyFunction*](types.getkeyfunction.md)<[*JWSHeaderParameters*](types.jwsheaderparameters.md), [*FlattenedJWSInput*](types.flattenedjwsinput.md)\> ↳ **JWTVerifyGetKey** @@ -24,7 +24,7 @@ No token components have been verified at the time of this function call. See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset) to verify using a remote JSON Web Key Set. -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -33,4 +33,4 @@ to verify using a remote JSON Web Key Set. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/jwt_verify.jwtverifyoptions.md b/docs/interfaces/jwt_verify.jwtverifyoptions.md index 0ed1646253..d3e674b47e 100644 --- a/docs/interfaces/jwt_verify.jwtverifyoptions.md +++ b/docs/interfaces/jwt_verify.jwtverifyoptions.md @@ -6,9 +6,9 @@ Combination of JWS Verification options and JWT Claims Set verification options. ## Hierarchy -* [*VerifyOptions*](types.verifyoptions.md) +- [*VerifyOptions*](types.verifyoptions.md) -* [*JWTClaimVerificationOptions*](types.jwtclaimverificationoptions.md) +- [*JWTClaimVerificationOptions*](types.jwtclaimverificationoptions.md) ↳ **JWTVerifyOptions** @@ -38,7 +38,7 @@ key/secret are allowed. Note: "none" is never accepted. Inherited from: [VerifyOptions](types.verifyoptions.md).[algorithms](types.verifyoptions.md#algorithms) -Defined in: [types.d.ts:522](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L522) +Defined in: [types.d.ts:526](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L526) ___ @@ -50,7 +50,7 @@ Expected JWT "aud" (Audience) Claim value(s). Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[audience](types.jwtclaimverificationoptions.md#audience) -Defined in: [types.d.ts:476](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L476) +Defined in: [types.d.ts:480](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L480) ___ @@ -64,7 +64,7 @@ Expected clock tolerance Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[clockTolerance](types.jwtclaimverificationoptions.md#clocktolerance) -Defined in: [types.d.ts:483](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L483) +Defined in: [types.d.ts:487](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L487) ___ @@ -91,11 +91,11 @@ The JWS extension Header Parameter `b64` is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available. -#### Type declaration: +#### Type declaration Inherited from: [VerifyOptions](types.verifyoptions.md).[crit](types.verifyoptions.md#crit) -Defined in: [types.d.ts:430](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L430) +Defined in: [types.d.ts:434](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L434) ___ @@ -107,7 +107,7 @@ Date to use when comparing NumericDate claims, defaults to `new Date()`. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[currentDate](types.jwtclaimverificationoptions.md#currentdate) -Defined in: [types.d.ts:510](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L510) +Defined in: [types.d.ts:514](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L514) ___ @@ -119,7 +119,7 @@ Expected JWT "iss" (Issuer) Claim value(s). Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[issuer](types.jwtclaimverificationoptions.md#issuer) -Defined in: [types.d.ts:488](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L488) +Defined in: [types.d.ts:492](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L492) ___ @@ -133,7 +133,7 @@ Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[maxTokenAge](types.jwtclaimverificationoptions.md#maxtokenage) -Defined in: [types.d.ts:495](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L495) +Defined in: [types.d.ts:499](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L499) ___ @@ -145,7 +145,7 @@ Expected JWT "sub" (Subject) Claim value. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[subject](types.jwtclaimverificationoptions.md#subject) -Defined in: [types.d.ts:500](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L500) +Defined in: [types.d.ts:504](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L504) ___ @@ -157,4 +157,4 @@ Expected JWT "typ" (Type) Header Parameter value. Inherited from: [JWTClaimVerificationOptions](types.jwtclaimverificationoptions.md).[typ](types.jwtclaimverificationoptions.md#typ) -Defined in: [types.d.ts:505](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L505) +Defined in: [types.d.ts:509](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L509) diff --git a/docs/interfaces/types.compactdecryptresult.md b/docs/interfaces/types.compactdecryptresult.md index b9b7e165d1..4ef5c2260a 100644 --- a/docs/interfaces/types.compactdecryptresult.md +++ b/docs/interfaces/types.compactdecryptresult.md @@ -17,7 +17,7 @@ Plaintext. -Defined in: [types.d.ts:623](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L623) +Defined in: [types.d.ts:627](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L627) ___ @@ -27,4 +27,4 @@ ___ JWE Protected Header. -Defined in: [types.d.ts:628](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L628) +Defined in: [types.d.ts:632](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L632) diff --git a/docs/interfaces/types.compactverifyresult.md b/docs/interfaces/types.compactverifyresult.md index c6b9e22e6b..a27865a601 100644 --- a/docs/interfaces/types.compactverifyresult.md +++ b/docs/interfaces/types.compactverifyresult.md @@ -17,7 +17,7 @@ JWS Payload. -Defined in: [types.d.ts:654](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L654) +Defined in: [types.d.ts:658](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L658) ___ @@ -27,4 +27,4 @@ ___ JWS Protected Header. -Defined in: [types.d.ts:659](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L659) +Defined in: [types.d.ts:663](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L663) diff --git a/docs/interfaces/types.critoption.md b/docs/interfaces/types.critoption.md index 496dc8ce99..2eda94c5bf 100644 --- a/docs/interfaces/types.critoption.md +++ b/docs/interfaces/types.critoption.md @@ -6,7 +6,7 @@ Shared Interface with a "crit" property for all sign and verify operations. ## Hierarchy -* **CritOption** +- **CritOption** ↳ [*DecryptOptions*](types.decryptoptions.md) @@ -47,6 +47,6 @@ The JWS extension Header Parameter `b64` is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available. -#### Type declaration: +#### Type declaration -Defined in: [types.d.ts:430](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L430) +Defined in: [types.d.ts:434](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L434) diff --git a/docs/interfaces/types.decryptoptions.md b/docs/interfaces/types.decryptoptions.md index 583fd7bde2..0169f6178d 100644 --- a/docs/interfaces/types.decryptoptions.md +++ b/docs/interfaces/types.decryptoptions.md @@ -6,7 +6,7 @@ JWE Decryption options. ## Hierarchy -* [*CritOption*](types.critoption.md) +- [*CritOption*](types.critoption.md) ↳ **DecryptOptions** @@ -31,7 +31,7 @@ A list of accepted JWE "enc" (Encryption Algorithm) Header Parameter values. By default all "enc" (Encryption Algorithm) values applicable for the used key/secret are allowed. -Defined in: [types.d.ts:449](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L449) +Defined in: [types.d.ts:453](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L453) ___ @@ -58,11 +58,11 @@ The JWS extension Header Parameter `b64` is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available. -#### Type declaration: +#### Type declaration Inherited from: [CritOption](types.critoption.md).[crit](types.critoption.md#crit) -Defined in: [types.d.ts:430](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L430) +Defined in: [types.d.ts:434](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L434) ___ @@ -73,7 +73,7 @@ ___ In a browser runtime you have to provide an implementation for Inflate Raw when you expect JWEs with compressed plaintext. -Defined in: [types.d.ts:455](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L455) +Defined in: [types.d.ts:459](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L459) ___ @@ -83,4 +83,4 @@ ___ A list of accepted JWE "alg" (Algorithm) Header Parameter values. -Defined in: [types.d.ts:442](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L442) +Defined in: [types.d.ts:446](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L446) diff --git a/docs/interfaces/types.deflatefunction.md b/docs/interfaces/types.deflatefunction.md index 8a67092ab9..e11ee75e65 100644 --- a/docs/interfaces/types.deflatefunction.md +++ b/docs/interfaces/types.deflatefunction.md @@ -10,7 +10,7 @@ Deflate Raw implementation, e.g. promisified [zlib.deflateRaw](https://nodejs.or Deflate Raw implementation, e.g. promisified [zlib.deflateRaw](https://nodejs.org/api/zlib.html#zlib_zlib_deflateraw_buffer_options_callback). -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -18,4 +18,4 @@ Deflate Raw implementation, e.g. promisified [zlib.deflateRaw](https://nodejs.or **Returns:** *Promise* -Defined in: [types.d.ts:579](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L579) +Defined in: [types.d.ts:583](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L583) diff --git a/docs/interfaces/types.encryptoptions.md b/docs/interfaces/types.encryptoptions.md index f2cf34c15d..c7a2918816 100644 --- a/docs/interfaces/types.encryptoptions.md +++ b/docs/interfaces/types.encryptoptions.md @@ -6,7 +6,7 @@ JWE Encryption options. ## Hierarchy -* [*CritOption*](types.critoption.md) +- [*CritOption*](types.critoption.md) ↳ **EncryptOptions** @@ -42,11 +42,11 @@ The JWS extension Header Parameter `b64` is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available. -#### Type declaration: +#### Type declaration Inherited from: [CritOption](types.critoption.md).[crit](types.critoption.md#crit) -Defined in: [types.d.ts:430](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L430) +Defined in: [types.d.ts:434](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L434) ___ @@ -57,4 +57,4 @@ ___ In a browser runtime you have to provide an implementation for Deflate Raw when you will be producing JWEs with compressed plaintext. -Defined in: [types.d.ts:466](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L466) +Defined in: [types.d.ts:470](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L470) diff --git a/docs/interfaces/types.flatteneddecryptresult.md b/docs/interfaces/types.flatteneddecryptresult.md index 66ea5e146d..32b87a92d5 100644 --- a/docs/interfaces/types.flatteneddecryptresult.md +++ b/docs/interfaces/types.flatteneddecryptresult.md @@ -4,7 +4,7 @@ ## Hierarchy -* **FlattenedDecryptResult** +- **FlattenedDecryptResult** ↳ [*GeneralDecryptResult*](types.generaldecryptresult.md) @@ -26,7 +26,7 @@ JWE AAD. -Defined in: [types.d.ts:594](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L594) +Defined in: [types.d.ts:598](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L598) ___ @@ -36,7 +36,7 @@ ___ Plaintext. -Defined in: [types.d.ts:599](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L599) +Defined in: [types.d.ts:603](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L603) ___ @@ -46,7 +46,7 @@ ___ JWE Protected Header. -Defined in: [types.d.ts:604](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L604) +Defined in: [types.d.ts:608](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L608) ___ @@ -56,7 +56,7 @@ ___ JWE Shared Unprotected Header. -Defined in: [types.d.ts:609](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L609) +Defined in: [types.d.ts:613](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L613) ___ @@ -66,4 +66,4 @@ ___ JWE Per-Recipient Unprotected Header. -Defined in: [types.d.ts:614](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L614) +Defined in: [types.d.ts:618](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L618) diff --git a/docs/interfaces/types.flattenedjwe.md b/docs/interfaces/types.flattenedjwe.md index 4c9be98978..4a6d32e416 100644 --- a/docs/interfaces/types.flattenedjwe.md +++ b/docs/interfaces/types.flattenedjwe.md @@ -29,7 +29,7 @@ otherwise, it MUST be absent. A JWE AAD value can be included to supply a base64url-encoded value to be integrity protected but not encrypted. -Defined in: [types.d.ts:314](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L314) +Defined in: [types.d.ts:318](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L318) ___ @@ -40,7 +40,7 @@ ___ The "ciphertext" member MUST be present and contain the value BASE64URL(JWE Ciphertext). -Defined in: [types.d.ts:320](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L320) +Defined in: [types.d.ts:324](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L324) ___ @@ -52,7 +52,7 @@ The "encrypted_key" member MUST be present and contain the value BASE64URL(JWE Encrypted Key) when the JWE Encrypted Key value is non-empty; otherwise, it MUST be absent. -Defined in: [types.d.ts:327](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L327) +Defined in: [types.d.ts:331](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L331) ___ @@ -67,7 +67,7 @@ absent. This value is represented as an unencoded JSON object, rather than as a string. These Header Parameter values are not integrity protected. -Defined in: [types.d.ts:337](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L337) +Defined in: [types.d.ts:341](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L341) ___ @@ -79,7 +79,7 @@ The "iv" member MUST be present and contain the value BASE64URL(JWE Initialization Vector) when the JWE Initialization Vector value is non-empty; otherwise, it MUST be absent. -Defined in: [types.d.ts:344](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L344) +Defined in: [types.d.ts:348](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L348) ___ @@ -92,7 +92,7 @@ BASE64URL(UTF8(JWE Protected Header)) when the JWE Protected Header value is non-empty; otherwise, it MUST be absent. These Header Parameter values are integrity protected. -Defined in: [types.d.ts:352](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L352) +Defined in: [types.d.ts:356](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L356) ___ @@ -104,7 +104,7 @@ The "tag" member MUST be present and contain the value BASE64URL(JWE Authentication Tag) when the JWE Authentication Tag value is non-empty; otherwise, it MUST be absent. -Defined in: [types.d.ts:359](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L359) +Defined in: [types.d.ts:363](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L363) ___ @@ -118,4 +118,4 @@ value is non-empty; otherwise, it MUST be absent. This value is represented as an unencoded JSON object, rather than as a string. These Header Parameter values are not integrity protected. -Defined in: [types.d.ts:368](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L368) +Defined in: [types.d.ts:372](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L372) diff --git a/docs/interfaces/types.flattenedjws.md b/docs/interfaces/types.flattenedjws.md index 7a1f3d7c0d..33d5481e96 100644 --- a/docs/interfaces/types.flattenedjws.md +++ b/docs/interfaces/types.flattenedjws.md @@ -8,7 +8,7 @@ is not returned when JWS Unencoded Payload Option ## Hierarchy -* *Partial*<[*FlattenedJWSInput*](types.flattenedjwsinput.md)\> +- *Partial*<[*FlattenedJWSInput*](types.flattenedjwsinput.md)\> ↳ **FlattenedJWS** @@ -35,7 +35,7 @@ Parameter values are not integrity protected. Inherited from: Partial.header -Defined in: [types.d.ts:162](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L162) +Defined in: [types.d.ts:166](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L166) ___ @@ -45,7 +45,7 @@ ___ Overrides: Partial.payload -Defined in: [types.d.ts:212](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L212) +Defined in: [types.d.ts:216](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L216) ___ @@ -60,7 +60,7 @@ Header Parameter values are integrity protected. Inherited from: Partial.protected -Defined in: [types.d.ts:177](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L177) +Defined in: [types.d.ts:181](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L181) ___ @@ -70,4 +70,4 @@ ___ Overrides: Partial.signature -Defined in: [types.d.ts:213](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L213) +Defined in: [types.d.ts:217](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L217) diff --git a/docs/interfaces/types.flattenedjwsinput.md b/docs/interfaces/types.flattenedjwsinput.md index c867703a7a..3fb5270a68 100644 --- a/docs/interfaces/types.flattenedjwsinput.md +++ b/docs/interfaces/types.flattenedjwsinput.md @@ -26,7 +26,7 @@ empty; otherwise, it MUST be absent. This value is represented as an unencoded JSON object, rather than as a string. These Header Parameter values are not integrity protected. -Defined in: [types.d.ts:162](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L162) +Defined in: [types.d.ts:166](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L166) ___ @@ -38,7 +38,7 @@ The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When RFC7797 "b64": false is used the value passed may also be a Uint8Array. -Defined in: [types.d.ts:169](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L169) +Defined in: [types.d.ts:173](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L173) ___ @@ -51,7 +51,7 @@ BASE64URL(UTF8(JWS Protected Header)) when the JWS Protected Header value is non-empty; otherwise, it MUST be absent. These Header Parameter values are integrity protected. -Defined in: [types.d.ts:177](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L177) +Defined in: [types.d.ts:181](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L181) ___ @@ -62,4 +62,4 @@ ___ The "signature" member MUST be present and contain the value BASE64URL(JWS Signature). -Defined in: [types.d.ts:183](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L183) +Defined in: [types.d.ts:187](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L187) diff --git a/docs/interfaces/types.flattenedverifyresult.md b/docs/interfaces/types.flattenedverifyresult.md index 7dbd317357..c98e652269 100644 --- a/docs/interfaces/types.flattenedverifyresult.md +++ b/docs/interfaces/types.flattenedverifyresult.md @@ -4,7 +4,7 @@ ## Hierarchy -* **FlattenedVerifyResult** +- **FlattenedVerifyResult** ↳ [*GeneralVerifyResult*](types.generalverifyresult.md) @@ -24,7 +24,7 @@ JWS Payload. -Defined in: [types.d.ts:635](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L635) +Defined in: [types.d.ts:639](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L639) ___ @@ -34,7 +34,7 @@ ___ JWS Protected Header. -Defined in: [types.d.ts:640](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L640) +Defined in: [types.d.ts:644](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L644) ___ @@ -44,4 +44,4 @@ ___ JWS Unprotected Header. -Defined in: [types.d.ts:645](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L645) +Defined in: [types.d.ts:649](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L649) diff --git a/docs/interfaces/types.generaldecryptresult.md b/docs/interfaces/types.generaldecryptresult.md index 73c57d36b2..117ff4e2ca 100644 --- a/docs/interfaces/types.generaldecryptresult.md +++ b/docs/interfaces/types.generaldecryptresult.md @@ -4,7 +4,7 @@ ## Hierarchy -* [*FlattenedDecryptResult*](types.flatteneddecryptresult.md) +- [*FlattenedDecryptResult*](types.flatteneddecryptresult.md) ↳ **GeneralDecryptResult** @@ -28,7 +28,7 @@ JWE AAD. Inherited from: [FlattenedDecryptResult](types.flatteneddecryptresult.md).[additionalAuthenticatedData](types.flatteneddecryptresult.md#additionalauthenticateddata) -Defined in: [types.d.ts:594](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L594) +Defined in: [types.d.ts:598](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L598) ___ @@ -40,7 +40,7 @@ Plaintext. Inherited from: [FlattenedDecryptResult](types.flatteneddecryptresult.md).[plaintext](types.flatteneddecryptresult.md#plaintext) -Defined in: [types.d.ts:599](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L599) +Defined in: [types.d.ts:603](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L603) ___ @@ -52,7 +52,7 @@ JWE Protected Header. Inherited from: [FlattenedDecryptResult](types.flatteneddecryptresult.md).[protectedHeader](types.flatteneddecryptresult.md#protectedheader) -Defined in: [types.d.ts:604](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L604) +Defined in: [types.d.ts:608](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L608) ___ @@ -64,7 +64,7 @@ JWE Shared Unprotected Header. Inherited from: [FlattenedDecryptResult](types.flatteneddecryptresult.md).[sharedUnprotectedHeader](types.flatteneddecryptresult.md#sharedunprotectedheader) -Defined in: [types.d.ts:609](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L609) +Defined in: [types.d.ts:613](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L613) ___ @@ -76,4 +76,4 @@ JWE Per-Recipient Unprotected Header. Inherited from: [FlattenedDecryptResult](types.flatteneddecryptresult.md).[unprotectedHeader](types.flatteneddecryptresult.md#unprotectedheader) -Defined in: [types.d.ts:614](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L614) +Defined in: [types.d.ts:618](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L618) diff --git a/docs/interfaces/types.generaljwe.md b/docs/interfaces/types.generaljwe.md index d20a0a74e0..62e35580b2 100644 --- a/docs/interfaces/types.generaljwe.md +++ b/docs/interfaces/types.generaljwe.md @@ -4,7 +4,7 @@ ## Hierarchy -* *Omit*<[*FlattenedJWE*](types.flattenedjwe.md), ``"encrypted_key"`` \| ``"header"``\> +- *Omit*<[*FlattenedJWE*](types.flattenedjwe.md), ``"encrypted_key"`` \| ``"header"``\> ↳ **GeneralJWE** @@ -34,7 +34,7 @@ encrypted. Inherited from: Omit.aad -Defined in: [types.d.ts:314](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L314) +Defined in: [types.d.ts:318](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L318) ___ @@ -47,7 +47,7 @@ BASE64URL(JWE Ciphertext). Inherited from: Omit.ciphertext -Defined in: [types.d.ts:320](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L320) +Defined in: [types.d.ts:324](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L324) ___ @@ -61,7 +61,7 @@ Vector value is non-empty; otherwise, it MUST be absent. Inherited from: Omit.iv -Defined in: [types.d.ts:344](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L344) +Defined in: [types.d.ts:348](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L348) ___ @@ -76,7 +76,7 @@ Header Parameter values are integrity protected. Inherited from: Omit.protected -Defined in: [types.d.ts:352](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L352) +Defined in: [types.d.ts:356](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L356) ___ @@ -84,7 +84,7 @@ ___ • **recipients**: *Pick*<[*FlattenedJWE*](types.flattenedjwe.md), ``"header"`` \| ``"encrypted_key"``\>[] -Defined in: [types.d.ts:372](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L372) +Defined in: [types.d.ts:376](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L376) ___ @@ -98,7 +98,7 @@ value is non-empty; otherwise, it MUST be absent. Inherited from: Omit.tag -Defined in: [types.d.ts:359](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L359) +Defined in: [types.d.ts:363](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L363) ___ @@ -114,4 +114,4 @@ These Header Parameter values are not integrity protected. Inherited from: Omit.unprotected -Defined in: [types.d.ts:368](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L368) +Defined in: [types.d.ts:372](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L372) diff --git a/docs/interfaces/types.generaljws.md b/docs/interfaces/types.generaljws.md index 6d3bfaeb53..140bdb0c72 100644 --- a/docs/interfaces/types.generaljws.md +++ b/docs/interfaces/types.generaljws.md @@ -19,7 +19,7 @@ is not returned when JWS Unencoded Payload Option • `Optional` **payload**: *string* -Defined in: [types.d.ts:222](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L222) +Defined in: [types.d.ts:226](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L226) ___ @@ -27,4 +27,4 @@ ___ • **signatures**: *Omit*<[*FlattenedJWSInput*](types.flattenedjwsinput.md), ``"payload"``\>[] -Defined in: [types.d.ts:223](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L223) +Defined in: [types.d.ts:227](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L227) diff --git a/docs/interfaces/types.generaljwsinput.md b/docs/interfaces/types.generaljwsinput.md index 95b903d610..d0e7a2e65a 100644 --- a/docs/interfaces/types.generaljwsinput.md +++ b/docs/interfaces/types.generaljwsinput.md @@ -22,7 +22,7 @@ The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When RFC7797 "b64": false is used the value passed may also be a Uint8Array. -Defined in: [types.d.ts:196](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L196) +Defined in: [types.d.ts:200](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L200) ___ @@ -34,4 +34,4 @@ The "signatures" member value MUST be an array of JSON objects. Each object represents a signature or MAC over the JWS Payload and the JWS Protected Header. -Defined in: [types.d.ts:203](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L203) +Defined in: [types.d.ts:207](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L207) diff --git a/docs/interfaces/types.generalverifyresult.md b/docs/interfaces/types.generalverifyresult.md index 7312659a41..14af213e76 100644 --- a/docs/interfaces/types.generalverifyresult.md +++ b/docs/interfaces/types.generalverifyresult.md @@ -4,7 +4,7 @@ ## Hierarchy -* [*FlattenedVerifyResult*](types.flattenedverifyresult.md) +- [*FlattenedVerifyResult*](types.flattenedverifyresult.md) ↳ **GeneralVerifyResult** @@ -26,7 +26,7 @@ JWS Payload. Inherited from: [FlattenedVerifyResult](types.flattenedverifyresult.md).[payload](types.flattenedverifyresult.md#payload) -Defined in: [types.d.ts:635](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L635) +Defined in: [types.d.ts:639](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L639) ___ @@ -38,7 +38,7 @@ JWS Protected Header. Inherited from: [FlattenedVerifyResult](types.flattenedverifyresult.md).[protectedHeader](types.flattenedverifyresult.md#protectedheader) -Defined in: [types.d.ts:640](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L640) +Defined in: [types.d.ts:644](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L644) ___ @@ -50,4 +50,4 @@ JWS Unprotected Header. Inherited from: [FlattenedVerifyResult](types.flattenedverifyresult.md).[unprotectedHeader](types.flattenedverifyresult.md#unprotectedheader) -Defined in: [types.d.ts:645](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L645) +Defined in: [types.d.ts:649](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L649) diff --git a/docs/interfaces/types.getkeyfunction.md b/docs/interfaces/types.getkeyfunction.md index 664bea3f1c..ed64eda607 100644 --- a/docs/interfaces/types.getkeyfunction.md +++ b/docs/interfaces/types.getkeyfunction.md @@ -16,7 +16,7 @@ If you cannot match a key suitable for the token, throw an error instead. ## Hierarchy -* **GetKeyFunction** +- **GetKeyFunction** ↳ [*JWTDecryptGetKey*](jwt_decrypt.jwtdecryptgetkey.md) @@ -43,7 +43,7 @@ No token components have been verified at the time of this function call. If you cannot match a key suitable for the token, throw an error instead. -#### Parameters: +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | @@ -52,4 +52,4 @@ If you cannot match a key suitable for the token, throw an error instead. **Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\> -Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L78) +Defined in: [types.d.ts:78](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L78) diff --git a/docs/interfaces/types.inflatefunction.md b/docs/interfaces/types.inflatefunction.md index c92a4ed542..e8305b74ae 100644 --- a/docs/interfaces/types.inflatefunction.md +++ b/docs/interfaces/types.inflatefunction.md @@ -10,7 +10,7 @@ Inflate Raw implementation, e.g. promisified [zlib.inflateRaw](https://nodejs.or Inflate Raw implementation, e.g. promisified [zlib.inflateRaw](https://nodejs.org/api/zlib.html#zlib_zlib_inflateraw_buffer_options_callback). -#### Parameters: +#### Parameters | Name | Type | | :------ | :------ | @@ -18,4 +18,4 @@ Inflate Raw implementation, e.g. promisified [zlib.inflateRaw](https://nodejs.or **Returns:** *Promise* -Defined in: [types.d.ts:586](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L586) +Defined in: [types.d.ts:590](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L590) diff --git a/docs/interfaces/types.joseheaderparameters.md b/docs/interfaces/types.joseheaderparameters.md index cd42498b2a..dd66923a92 100644 --- a/docs/interfaces/types.joseheaderparameters.md +++ b/docs/interfaces/types.joseheaderparameters.md @@ -4,7 +4,7 @@ ## Hierarchy -* **JoseHeaderParameters** +- **JoseHeaderParameters** ↳ [*JWSHeaderParameters*](types.jwsheaderparameters.md) @@ -30,7 +30,7 @@ "cty" (Content Type) Header Parameter. -Defined in: [types.d.ts:260](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L260) +Defined in: [types.d.ts:264](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L264) ___ @@ -40,7 +40,7 @@ ___ "jwk" (JSON Web Key) Header Parameter. -Defined in: [types.d.ts:250](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L250) +Defined in: [types.d.ts:254](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L254) ___ @@ -50,7 +50,7 @@ ___ "kid" (Key ID) Header Parameter. -Defined in: [types.d.ts:230](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L230) +Defined in: [types.d.ts:234](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L234) ___ @@ -60,7 +60,7 @@ ___ "typ" (Type) Header Parameter. -Defined in: [types.d.ts:255](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L255) +Defined in: [types.d.ts:259](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L259) ___ @@ -70,7 +70,7 @@ ___ "x5c" (X.509 Certificate Chain) Header Parameter. -Defined in: [types.d.ts:240](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L240) +Defined in: [types.d.ts:244](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L244) ___ @@ -80,7 +80,7 @@ ___ "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. -Defined in: [types.d.ts:235](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L235) +Defined in: [types.d.ts:239](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L239) ___ @@ -90,4 +90,4 @@ ___ "x5u" (X.509 URL) Header Parameter. -Defined in: [types.d.ts:245](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L245) +Defined in: [types.d.ts:249](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L249) diff --git a/docs/interfaces/types.jweheaderparameters.md b/docs/interfaces/types.jweheaderparameters.md index 6800d2044c..78196256ae 100644 --- a/docs/interfaces/types.jweheaderparameters.md +++ b/docs/interfaces/types.jweheaderparameters.md @@ -7,7 +7,7 @@ may also be present. ## Hierarchy -* [*JoseHeaderParameters*](types.joseheaderparameters.md) +- [*JoseHeaderParameters*](types.joseheaderparameters.md) ↳ **JWEHeaderParameters** @@ -41,7 +41,7 @@ Any other JWE Header member. JWE "alg" (Algorithm) Header Parameter. -Defined in: [types.d.ts:383](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L383) +Defined in: [types.d.ts:387](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L387) ___ @@ -51,7 +51,7 @@ ___ JWE "crit" (Critical) Header Parameter. -Defined in: [types.d.ts:393](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L393) +Defined in: [types.d.ts:397](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L397) ___ @@ -63,7 +63,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[cty](types.joseheaderparameters.md#cty) -Defined in: [types.d.ts:260](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L260) +Defined in: [types.d.ts:264](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L264) ___ @@ -73,7 +73,7 @@ ___ JWE "enc" (Encryption Algorithm) Header Parameter. -Defined in: [types.d.ts:388](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L388) +Defined in: [types.d.ts:392](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L392) ___ @@ -85,7 +85,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[jwk](types.joseheaderparameters.md#jwk) -Defined in: [types.d.ts:250](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L250) +Defined in: [types.d.ts:254](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L254) ___ @@ -97,7 +97,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[kid](types.joseheaderparameters.md#kid) -Defined in: [types.d.ts:230](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L230) +Defined in: [types.d.ts:234](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L234) ___ @@ -109,7 +109,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[typ](types.joseheaderparameters.md#typ) -Defined in: [types.d.ts:255](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L255) +Defined in: [types.d.ts:259](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L259) ___ @@ -121,7 +121,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[x5c](types.joseheaderparameters.md#x5c) -Defined in: [types.d.ts:240](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L240) +Defined in: [types.d.ts:244](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L244) ___ @@ -133,7 +133,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[x5t](types.joseheaderparameters.md#x5t) -Defined in: [types.d.ts:235](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L235) +Defined in: [types.d.ts:239](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L239) ___ @@ -145,7 +145,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[x5u](types.joseheaderparameters.md#x5u) -Defined in: [types.d.ts:245](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L245) +Defined in: [types.d.ts:249](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L249) ___ @@ -155,4 +155,4 @@ ___ JWE "zip" (Compression Algorithm) Header Parameter. -Defined in: [types.d.ts:398](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L398) +Defined in: [types.d.ts:402](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L402) diff --git a/docs/interfaces/types.jwekeymanagementheaderparameters.md b/docs/interfaces/types.jwekeymanagementheaderparameters.md index 72e6c91ad9..994c2ffda6 100644 --- a/docs/interfaces/types.jwekeymanagementheaderparameters.md +++ b/docs/interfaces/types.jwekeymanagementheaderparameters.md @@ -21,7 +21,7 @@ Recognized JWE Key Management-related Header Parameters. • `Optional` **apu**: *Uint8Array* -Defined in: [types.d.ts:295](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L295) +Defined in: [types.d.ts:299](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L299) ___ @@ -29,7 +29,7 @@ ___ • `Optional` **apv**: *Uint8Array* -Defined in: [types.d.ts:296](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L296) +Defined in: [types.d.ts:300](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L300) ___ @@ -37,7 +37,7 @@ ___ • `Optional` **epk**: [*KeyLike*](../types/types.keylike.md) -Defined in: [types.d.ts:297](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L297) +Defined in: [types.d.ts:301](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L301) ___ @@ -45,7 +45,7 @@ ___ • `Optional` **iv**: *Uint8Array* -Defined in: [types.d.ts:298](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L298) +Defined in: [types.d.ts:302](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L302) ___ @@ -53,7 +53,7 @@ ___ • `Optional` **p2c**: *number* -Defined in: [types.d.ts:299](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L299) +Defined in: [types.d.ts:303](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L303) ___ @@ -61,4 +61,4 @@ ___ • `Optional` **p2s**: *Uint8Array* -Defined in: [types.d.ts:300](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L300) +Defined in: [types.d.ts:304](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L304) diff --git a/docs/interfaces/types.jwk.md b/docs/interfaces/types.jwk.md index 15a4342c9c..ddd4af946c 100644 --- a/docs/interfaces/types.jwk.md +++ b/docs/interfaces/types.jwk.md @@ -41,7 +41,7 @@ JSON Web Key ([JWK](https://tools.ietf.org/html/rfc7517)). JWK "alg" (Algorithm) Parameter. -Defined in: [types.d.ts:13](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L13) +Defined in: [types.d.ts:13](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L13) ___ @@ -49,7 +49,7 @@ ___ • `Optional` **crv**: *string* -Defined in: [types.d.ts:14](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L14) +Defined in: [types.d.ts:14](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L14) ___ @@ -57,7 +57,7 @@ ___ • `Optional` **d**: *string* -Defined in: [types.d.ts:15](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L15) +Defined in: [types.d.ts:15](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L15) ___ @@ -65,7 +65,7 @@ ___ • `Optional` **dp**: *string* -Defined in: [types.d.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L16) +Defined in: [types.d.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L16) ___ @@ -73,7 +73,7 @@ ___ • `Optional` **dq**: *string* -Defined in: [types.d.ts:17](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L17) +Defined in: [types.d.ts:17](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L17) ___ @@ -81,7 +81,7 @@ ___ • `Optional` **e**: *string* -Defined in: [types.d.ts:18](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L18) +Defined in: [types.d.ts:18](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L18) ___ @@ -91,7 +91,7 @@ ___ JWK "ext" (Extractable) Parameter. -Defined in: [types.d.ts:22](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L22) +Defined in: [types.d.ts:22](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L22) ___ @@ -99,7 +99,7 @@ ___ • `Optional` **k**: *string* -Defined in: [types.d.ts:23](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L23) +Defined in: [types.d.ts:23](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L23) ___ @@ -109,7 +109,7 @@ ___ JWK "key_ops" (Key Operations) Parameter. -Defined in: [types.d.ts:27](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L27) +Defined in: [types.d.ts:27](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L27) ___ @@ -119,7 +119,7 @@ ___ JWK "kid" (Key ID) Parameter. -Defined in: [types.d.ts:31](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L31) +Defined in: [types.d.ts:31](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L31) ___ @@ -129,7 +129,7 @@ ___ JWK "kty" (Key Type) Parameter. -Defined in: [types.d.ts:35](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L35) +Defined in: [types.d.ts:35](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L35) ___ @@ -137,7 +137,7 @@ ___ • `Optional` **n**: *string* -Defined in: [types.d.ts:36](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L36) +Defined in: [types.d.ts:36](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L36) ___ @@ -145,7 +145,7 @@ ___ • `Optional` **oth**: { `d?`: *string* ; `r?`: *string* ; `t?`: *string* }[] -Defined in: [types.d.ts:37](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L37) +Defined in: [types.d.ts:37](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L37) ___ @@ -153,7 +153,7 @@ ___ • `Optional` **p**: *string* -Defined in: [types.d.ts:42](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L42) +Defined in: [types.d.ts:42](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L42) ___ @@ -161,7 +161,7 @@ ___ • `Optional` **q**: *string* -Defined in: [types.d.ts:43](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L43) +Defined in: [types.d.ts:43](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L43) ___ @@ -169,7 +169,7 @@ ___ • `Optional` **qi**: *string* -Defined in: [types.d.ts:44](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L44) +Defined in: [types.d.ts:44](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L44) ___ @@ -179,7 +179,7 @@ ___ JWK "use" (Public Key Use) Parameter. -Defined in: [types.d.ts:48](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L48) +Defined in: [types.d.ts:48](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L48) ___ @@ -187,7 +187,7 @@ ___ • `Optional` **x**: *string* -Defined in: [types.d.ts:49](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L49) +Defined in: [types.d.ts:49](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L49) ___ @@ -197,7 +197,7 @@ ___ JWK "x5c" (X.509 Certificate Chain) Parameter. -Defined in: [types.d.ts:54](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L54) +Defined in: [types.d.ts:54](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L54) ___ @@ -207,7 +207,7 @@ ___ JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. -Defined in: [types.d.ts:58](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L58) +Defined in: [types.d.ts:58](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L58) ___ @@ -217,7 +217,7 @@ ___ "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. -Defined in: [types.d.ts:58](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L58) +Defined in: [types.d.ts:58](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L58) ___ @@ -227,7 +227,7 @@ ___ JWK "x5u" (X.509 URL) Parameter. -Defined in: [types.d.ts:66](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L66) +Defined in: [types.d.ts:66](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L66) ___ @@ -235,4 +235,4 @@ ___ • `Optional` **y**: *string* -Defined in: [types.d.ts:50](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L50) +Defined in: [types.d.ts:50](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L50) diff --git a/docs/interfaces/types.jwsheaderparameters.md b/docs/interfaces/types.jwsheaderparameters.md index 71d8dee04a..f9798f1081 100644 --- a/docs/interfaces/types.jwsheaderparameters.md +++ b/docs/interfaces/types.jwsheaderparameters.md @@ -7,7 +7,7 @@ may also be present. ## Hierarchy -* [*JoseHeaderParameters*](types.joseheaderparameters.md) +- [*JoseHeaderParameters*](types.joseheaderparameters.md) ↳ **JWSHeaderParameters** @@ -40,7 +40,7 @@ Any other JWS Header member. JWS "alg" (Algorithm) Header Parameter. -Defined in: [types.d.ts:271](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L271) +Defined in: [types.d.ts:275](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L275) ___ @@ -52,7 +52,7 @@ This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing Input computation as per [RFC7797](https://tools.ietf.org/html/rfc7797). -Defined in: [types.d.ts:278](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L278) +Defined in: [types.d.ts:282](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L282) ___ @@ -62,7 +62,7 @@ ___ JWS "crit" (Critical) Header Parameter. -Defined in: [types.d.ts:283](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L283) +Defined in: [types.d.ts:287](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L287) ___ @@ -74,7 +74,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[cty](types.joseheaderparameters.md#cty) -Defined in: [types.d.ts:260](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L260) +Defined in: [types.d.ts:264](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L264) ___ @@ -86,7 +86,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[jwk](types.joseheaderparameters.md#jwk) -Defined in: [types.d.ts:250](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L250) +Defined in: [types.d.ts:254](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L254) ___ @@ -98,7 +98,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[kid](types.joseheaderparameters.md#kid) -Defined in: [types.d.ts:230](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L230) +Defined in: [types.d.ts:234](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L234) ___ @@ -110,7 +110,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[typ](types.joseheaderparameters.md#typ) -Defined in: [types.d.ts:255](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L255) +Defined in: [types.d.ts:259](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L259) ___ @@ -122,7 +122,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[x5c](types.joseheaderparameters.md#x5c) -Defined in: [types.d.ts:240](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L240) +Defined in: [types.d.ts:244](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L244) ___ @@ -134,7 +134,7 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[x5t](types.joseheaderparameters.md#x5t) -Defined in: [types.d.ts:235](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L235) +Defined in: [types.d.ts:239](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L239) ___ @@ -146,4 +146,4 @@ ___ Inherited from: [JoseHeaderParameters](types.joseheaderparameters.md).[x5u](types.joseheaderparameters.md#x5u) -Defined in: [types.d.ts:245](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L245) +Defined in: [types.d.ts:249](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L249) diff --git a/docs/interfaces/types.jwtclaimverificationoptions.md b/docs/interfaces/types.jwtclaimverificationoptions.md index 85adba6a22..eaddecad11 100644 --- a/docs/interfaces/types.jwtclaimverificationoptions.md +++ b/docs/interfaces/types.jwtclaimverificationoptions.md @@ -6,7 +6,7 @@ JWT Claims Set verification options. ## Hierarchy -* **JWTClaimVerificationOptions** +- **JWTClaimVerificationOptions** ↳ [*JWTDecryptOptions*](jwt_decrypt.jwtdecryptoptions.md) @@ -32,7 +32,7 @@ JWT Claims Set verification options. Expected JWT "aud" (Audience) Claim value(s). -Defined in: [types.d.ts:476](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L476) +Defined in: [types.d.ts:480](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L480) ___ @@ -44,7 +44,7 @@ Expected clock tolerance - in seconds when number (e.g. 5) - parsed as seconds when a string (e.g. "5 seconds", "10 minutes", "2 hours"). -Defined in: [types.d.ts:483](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L483) +Defined in: [types.d.ts:487](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L487) ___ @@ -54,7 +54,7 @@ ___ Date to use when comparing NumericDate claims, defaults to `new Date()`. -Defined in: [types.d.ts:510](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L510) +Defined in: [types.d.ts:514](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L514) ___ @@ -64,7 +64,7 @@ ___ Expected JWT "iss" (Issuer) Claim value(s). -Defined in: [types.d.ts:488](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L488) +Defined in: [types.d.ts:492](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L492) ___ @@ -76,7 +76,7 @@ Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value. - in seconds when number (e.g. 5) - parsed as seconds when a string (e.g. "5 seconds", "10 minutes", "2 hours"). -Defined in: [types.d.ts:495](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L495) +Defined in: [types.d.ts:499](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L499) ___ @@ -86,7 +86,7 @@ ___ Expected JWT "sub" (Subject) Claim value. -Defined in: [types.d.ts:500](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L500) +Defined in: [types.d.ts:504](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L504) ___ @@ -96,4 +96,4 @@ ___ Expected JWT "typ" (Type) Header Parameter value. -Defined in: [types.d.ts:505](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L505) +Defined in: [types.d.ts:509](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L509) diff --git a/docs/interfaces/types.jwtdecryptresult.md b/docs/interfaces/types.jwtdecryptresult.md index 57ab2fd9eb..7a91bf20a3 100644 --- a/docs/interfaces/types.jwtdecryptresult.md +++ b/docs/interfaces/types.jwtdecryptresult.md @@ -17,7 +17,7 @@ JWT Claims Set. -Defined in: [types.d.ts:678](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L678) +Defined in: [types.d.ts:682](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L682) ___ @@ -27,4 +27,4 @@ ___ JWE Protected Header. -Defined in: [types.d.ts:683](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L683) +Defined in: [types.d.ts:687](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L687) diff --git a/docs/interfaces/types.jwtpayload.md b/docs/interfaces/types.jwtpayload.md index a139cbb5fe..9452649706 100644 --- a/docs/interfaces/types.jwtpayload.md +++ b/docs/interfaces/types.jwtpayload.md @@ -31,7 +31,7 @@ Any other JWT Claim Set member. JWT Audience [RFC7519#section-4.1.3](https://tools.ietf.org/html/rfc7519#section-4.1.3). -Defined in: [types.d.ts:548](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L548) +Defined in: [types.d.ts:552](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L552) ___ @@ -41,7 +41,7 @@ ___ JWT Expiration Time - [RFC7519#section-4.1.4](https://tools.ietf.org/html/rfc7519#section-4.1.4). -Defined in: [types.d.ts:563](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L563) +Defined in: [types.d.ts:567](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L567) ___ @@ -51,7 +51,7 @@ ___ JWT Issued At - [RFC7519#section-4.1.6](https://tools.ietf.org/html/rfc7519#section-4.1.6). -Defined in: [types.d.ts:568](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L568) +Defined in: [types.d.ts:572](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L572) ___ @@ -61,7 +61,7 @@ ___ JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1). -Defined in: [types.d.ts:538](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L538) +Defined in: [types.d.ts:542](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L542) ___ @@ -71,7 +71,7 @@ ___ JWT ID - [RFC7519#section-4.1.7](https://tools.ietf.org/html/rfc7519#section-4.1.7). -Defined in: [types.d.ts:553](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L553) +Defined in: [types.d.ts:557](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L557) ___ @@ -81,7 +81,7 @@ ___ JWT Not Before - [RFC7519#section-4.1.5](https://tools.ietf.org/html/rfc7519#section-4.1.5). -Defined in: [types.d.ts:558](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L558) +Defined in: [types.d.ts:562](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L562) ___ @@ -91,4 +91,4 @@ ___ JWT Subject - [RFC7519#section-4.1.2](https://tools.ietf.org/html/rfc7519#section-4.1.2). -Defined in: [types.d.ts:543](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L543) +Defined in: [types.d.ts:547](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L547) diff --git a/docs/interfaces/types.jwtverifyresult.md b/docs/interfaces/types.jwtverifyresult.md index 79ac51cceb..1b04d7d245 100644 --- a/docs/interfaces/types.jwtverifyresult.md +++ b/docs/interfaces/types.jwtverifyresult.md @@ -17,7 +17,7 @@ JWT Claims Set. -Defined in: [types.d.ts:666](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L666) +Defined in: [types.d.ts:670](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L670) ___ @@ -27,4 +27,4 @@ ___ JWS Protected Header. -Defined in: [types.d.ts:671](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L671) +Defined in: [types.d.ts:675](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L675) diff --git a/docs/interfaces/types.signoptions.md b/docs/interfaces/types.signoptions.md index cdc9d8902b..eea493f600 100644 --- a/docs/interfaces/types.signoptions.md +++ b/docs/interfaces/types.signoptions.md @@ -6,7 +6,7 @@ JWS Signing options. ## Hierarchy -* [*CritOption*](types.critoption.md) +- [*CritOption*](types.critoption.md) ↳ **SignOptions** @@ -41,8 +41,8 @@ The JWS extension Header Parameter `b64` is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available. -#### Type declaration: +#### Type declaration Inherited from: [CritOption](types.critoption.md).[crit](types.critoption.md#crit) -Defined in: [types.d.ts:430](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L430) +Defined in: [types.d.ts:434](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L434) diff --git a/docs/interfaces/types.verifyoptions.md b/docs/interfaces/types.verifyoptions.md index c6ab26e84d..9fa0e9cfa7 100644 --- a/docs/interfaces/types.verifyoptions.md +++ b/docs/interfaces/types.verifyoptions.md @@ -6,7 +6,7 @@ JWS Verification options. ## Hierarchy -* [*CritOption*](types.critoption.md) +- [*CritOption*](types.critoption.md) ↳ **VerifyOptions** @@ -29,7 +29,7 @@ A list of accepted JWS "alg" (Algorithm) Header Parameter values. By default all "alg" (Algorithm) values applicable for the used key/secret are allowed. Note: "none" is never accepted. -Defined in: [types.d.ts:522](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L522) +Defined in: [types.d.ts:526](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L526) ___ @@ -56,8 +56,8 @@ The JWS extension Header Parameter `b64` is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available. -#### Type declaration: +#### Type declaration Inherited from: [CritOption](types.critoption.md).[crit](types.critoption.md#crit) -Defined in: [types.d.ts:430](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L430) +Defined in: [types.d.ts:434](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L434) diff --git a/docs/interfaces/util_generate_key_pair.generatekeypairoptions.md b/docs/interfaces/util_generate_key_pair.generatekeypairoptions.md index 64707a0934..b852b9f6d7 100644 --- a/docs/interfaces/util_generate_key_pair.generatekeypairoptions.md +++ b/docs/interfaces/util_generate_key_pair.generatekeypairoptions.md @@ -7,6 +7,7 @@ ### Properties - [crv](util_generate_key_pair.generatekeypairoptions.md#crv) +- [extractable](util_generate_key_pair.generatekeypairoptions.md#extractable) - [modulusLength](util_generate_key_pair.generatekeypairoptions.md#moduluslength) ## Properties @@ -19,7 +20,19 @@ 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 the given JWA algorithm identifier. -Defined in: [util/generate_key_pair.ts:10](https://github.com/panva/jose/blob/v3.11.6/src/util/generate_key_pair.ts#L10) +Defined in: [util/generate_key_pair.ts:10](https://github.com/panva/jose/blob/v3.12.0/src/util/generate_key_pair.ts#L10) + +___ + +### extractable + +• `Optional` **extractable**: *boolean* + +(Web Cryptography API specific) The value to use as +[SubtleCrypto.generateKey()](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/generateKey) +`extractable` argument. Default is false. + +Defined in: [util/generate_key_pair.ts:23](https://github.com/panva/jose/blob/v3.12.0/src/util/generate_key_pair.ts#L23) ___ @@ -30,4 +43,4 @@ ___ A hint for RSA algorithms to generate an RSA key of a given `modulusLength` (Key size in bits). JOSE requires 2048 bits or larger. Default is 2048. -Defined in: [util/generate_key_pair.ts:16](https://github.com/panva/jose/blob/v3.11.6/src/util/generate_key_pair.ts#L16) +Defined in: [util/generate_key_pair.ts:16](https://github.com/panva/jose/blob/v3.12.0/src/util/generate_key_pair.ts#L16) diff --git a/docs/interfaces/util_generate_secret.generatesecretoptions.md b/docs/interfaces/util_generate_secret.generatesecretoptions.md new file mode 100644 index 0000000000..b233534328 --- /dev/null +++ b/docs/interfaces/util_generate_secret.generatesecretoptions.md @@ -0,0 +1,21 @@ +# Interface: GenerateSecretOptions + +[util/generate_secret](../modules/util_generate_secret.md).GenerateSecretOptions + +## Table of contents + +### Properties + +- [extractable](util_generate_secret.generatesecretoptions.md#extractable) + +## Properties + +### extractable + +• `Optional` **extractable**: *boolean* + +(Web Cryptography API specific) The value to use as +[SubtleCrypto.generateKey()](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/generateKey) +`extractable` argument. Default is false. + +Defined in: [util/generate_secret.ts:10](https://github.com/panva/jose/blob/v3.12.0/src/util/generate_secret.ts#L10) diff --git a/docs/modules/util_generate_secret.md b/docs/modules/util_generate_secret.md index db9c767bf3..d5cf87b9cb 100644 --- a/docs/modules/util_generate_secret.md +++ b/docs/modules/util_generate_secret.md @@ -6,6 +6,10 @@ - [default](util_generate_secret.md#default) +### Interfaces + +- [GenerateSecretOptions](../interfaces/util_generate_secret.generatesecretoptions.md) + ### Functions - [generateSecret](../functions/util_generate_secret.generatesecret.md) diff --git a/docs/types/types.keylike.md b/docs/types/types.keylike.md index 653fdd2964..f86c01059c 100644 --- a/docs/types/types.keylike.md +++ b/docs/types/types.keylike.md @@ -71,4 +71,4 @@ const rsaPublicKey = await parseJwk({ }, 'PS256') ``` -Defined in: [types.d.ts:147](https://github.com/panva/jose/blob/v3.11.6/src/types.d.ts#L147) +Defined in: [types.d.ts:151](https://github.com/panva/jose/blob/v3.12.0/src/types.d.ts#L151) diff --git a/docs/types/util_decode_protected_header.protectedheaderparameters.md b/docs/types/util_decode_protected_header.protectedheaderparameters.md index fe2672171c..1d900c9f82 100644 --- a/docs/types/util_decode_protected_header.protectedheaderparameters.md +++ b/docs/types/util_decode_protected_header.protectedheaderparameters.md @@ -4,4 +4,4 @@ Ƭ **ProtectedHeaderParameters**: [*JWSHeaderParameters*](../interfaces/types.jwsheaderparameters.md) & [*JWEHeaderParameters*](../interfaces/types.jweheaderparameters.md) -Defined in: [util/decode_protected_header.ts:8](https://github.com/panva/jose/blob/v3.11.6/src/util/decode_protected_header.ts#L8) +Defined in: [util/decode_protected_header.ts:8](https://github.com/panva/jose/blob/v3.12.0/src/util/decode_protected_header.ts#L8) diff --git a/package.json b/package.json index 780ac01bf2..4f8dddb988 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jose", - "version": "3.11.6", + "version": "3.12.0", "description": "Universal 'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK with no dependencies", "keywords": [ "browser",