Skip to content

Commit

Permalink
chore(release): 3.12.0
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed May 12, 2021
1 parent 65a16bc commit 77b4654
Show file tree
Hide file tree
Showing 89 changed files with 514 additions and 462 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand Down
24 changes: 12 additions & 12 deletions docs/classes/jwe_compact_encrypt.compactencrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ console.log(jwe)

\+ **new CompactEncrypt**(`plaintext`: *Uint8Array*): [*CompactEncrypt*](jwe_compact_encrypt.compactencrypt.md)

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `plaintext` | *Uint8Array* | Binary representation of the plaintext to encrypt. |

**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

Expand All @@ -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 |
| :------ | :------ | :------ |
Expand All @@ -72,7 +72,7 @@ Encrypts and resolves the value of the Compact JWE string.

**Returns:** *Promise*<string\>

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)

___

Expand All @@ -85,15 +85,15 @@ 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 |
| :------ | :------ | :------ |
| `cek` | *Uint8Array* | JWE Content Encryption Key. |

**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)

___

Expand All @@ -106,15 +106,15 @@ 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 |
| :------ | :------ | :------ |
| `iv` | *Uint8Array* | JWE Initialization Vector. |

**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)

___

Expand All @@ -126,15 +126,15 @@ 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 |
| :------ | :------ | :------ |
| `parameters` | [*JWEKeyManagementHeaderParameters*](../interfaces/types.jwekeymanagementheaderparameters.md) | JWE Key Management parameters. |

**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)

___

Expand All @@ -144,12 +144,12 @@ ___

Sets the JWE Protected Header on the CompactEncrypt object.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `protectedHeader` | [*JWEHeaderParameters*](../interfaces/types.jweheaderparameters.md) | JWE Protected Header 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)
36 changes: 18 additions & 18 deletions docs/classes/jwe_flattened_encrypt.flattenedencrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ console.log(jwe)

\+ **new FlattenedEncrypt**(`plaintext`: *Uint8Array*): [*FlattenedEncrypt*](jwe_flattened_encrypt.flattenedencrypt.md)

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `plaintext` | *Uint8Array* | Binary representation of the plaintext to encrypt. |

**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

Expand All @@ -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 |
| :------ | :------ | :------ |
Expand All @@ -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)

___

Expand All @@ -87,15 +87,15 @@ ___

Sets the Additional Authenticated Data on the FlattenedEncrypt object.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `aad` | *Uint8Array* | Additional Authenticated Data. |

**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)

___

Expand All @@ -108,15 +108,15 @@ 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 |
| :------ | :------ | :------ |
| `cek` | *Uint8Array* | JWE Content Encryption Key. |

**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)

___

Expand All @@ -129,15 +129,15 @@ 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 |
| :------ | :------ | :------ |
| `iv` | *Uint8Array* | JWE Initialization Vector. |

**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)

___

Expand All @@ -150,15 +150,15 @@ 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 |
| :------ | :------ | :------ |
| `parameters` | [*JWEKeyManagementHeaderParameters*](../interfaces/types.jwekeymanagementheaderparameters.md) | JWE Key Management parameters. |

**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)

___

Expand All @@ -168,15 +168,15 @@ ___

Sets the JWE Protected Header on the FlattenedEncrypt object.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `protectedHeader` | [*JWEHeaderParameters*](../interfaces/types.jweheaderparameters.md) | JWE Protected Header. |

**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)

___

Expand All @@ -186,15 +186,15 @@ ___

Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `sharedUnprotectedHeader` | [*JWEHeaderParameters*](../interfaces/types.jweheaderparameters.md) | JWE Shared Unprotected Header. |

**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)

___

Expand All @@ -204,12 +204,12 @@ ___

Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `unprotectedHeader` | [*JWEHeaderParameters*](../interfaces/types.jweheaderparameters.md) | JWE Per-Recipient Unprotected Header. |

**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)
12 changes: 6 additions & 6 deletions docs/classes/jws_compact_sign.compactsign.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ console.log(jws)

\+ **new CompactSign**(`payload`: *Uint8Array*): [*CompactSign*](jws_compact_sign.compactsign.md)

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | *Uint8Array* | Binary representation of the payload to sign. |

**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

Expand All @@ -60,15 +60,15 @@ 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 |
| :------ | :------ | :------ |
| `protectedHeader` | [*JWSHeaderParameters*](../interfaces/types.jwsheaderparameters.md) | JWS Protected Header. |

**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)

___

Expand All @@ -78,7 +78,7 @@ ___

Signs and resolves the value of the Compact JWS string.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
Expand All @@ -87,4 +87,4 @@ Signs and resolves the value of the Compact JWS string.

**Returns:** *Promise*<string\>

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)
16 changes: 8 additions & 8 deletions docs/classes/jws_flattened_sign.flattenedsign.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ console.log(jws)

\+ **new FlattenedSign**(`payload`: *Uint8Array*): [*FlattenedSign*](jws_flattened_sign.flattenedsign.md)

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | *Uint8Array* | Binary representation of the payload to sign. |

**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

Expand All @@ -60,15 +60,15 @@ 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 |
| :------ | :------ | :------ |
| `protectedHeader` | [*JWSHeaderParameters*](../interfaces/types.jwsheaderparameters.md) | JWS Protected Header. |

**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)

___

Expand All @@ -78,15 +78,15 @@ ___

Sets the JWS Unprotected Header on the FlattenedSign object.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `unprotectedHeader` | [*JWSHeaderParameters*](../interfaces/types.jwsheaderparameters.md) | JWS Unprotected Header. |

**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)

___

Expand All @@ -96,7 +96,7 @@ ___

Signs and resolves the value of the Flattened JWS object.

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
Expand All @@ -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)
Loading

0 comments on commit 77b4654

Please sign in to comment.