Skip to content

Commit

Permalink
feat: allow JWK objects as "key" input to sign and verify
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Sep 13, 2024
1 parent 0c93b0c commit c6302ea
Show file tree
Hide file tree
Showing 62 changed files with 1,747 additions and 188 deletions.
2 changes: 1 addition & 1 deletion docs/classes/jws_compact_sign.CompactSign.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Signs and resolves the value of the Compact JWS string.

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Private Key or Secret to sign the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Private Key or Secret to sign the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`SignOptions`](../interfaces/types.SignOptions.md) | JWS Sign options. |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/jws_flattened_sign.FlattenedSign.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Signs and resolves the value of the Flattened JWS object.

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Private Key or Secret to sign the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Private Key or Secret to sign the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`SignOptions`](../interfaces/types.SignOptions.md) | JWS Sign options. |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/jws_general_sign.GeneralSign.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Adds an additional signature for the General JWS object.

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Private Key or Secret to sign the individual JWS signature with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Private Key or Secret to sign the individual JWS signature with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`SignOptions`](../interfaces/types.SignOptions.md) | JWS Sign options. |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/jwt_sign.SignJWT.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ Signs and returns the JWT.

| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Private Key or Secret to sign the JWT with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Private Key or Secret to sign the JWT with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`SignOptions`](../interfaces/types.SignOptions.md) | JWT Sign options. |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/jws_compact_verify.compactVerify.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ as from its subpath export `'jose/jws/compact/verify'`.
| Name | Type | Description |
| :------ | :------ | :------ |
| `jws` | `string` \| [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) | Compact JWS. |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Key to verify the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Key to verify the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`VerifyOptions`](../interfaces/types.VerifyOptions.md) | JWS Verify options. |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/jws_flattened_verify.flattenedVerify.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ as from its subpath export `'jose/jws/flattened/verify'`.
| Name | Type | Description |
| :------ | :------ | :------ |
| `jws` | [`FlattenedJWSInput`](../interfaces/types.FlattenedJWSInput.md) | Flattened JWS. |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Key to verify the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Key to verify the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`VerifyOptions`](../interfaces/types.VerifyOptions.md) | JWS Verify options. |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/jws_general_verify.generalVerify.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ as from its subpath export `'jose/jws/general/verify'`.
| Name | Type | Description |
| :------ | :------ | :------ |
| `jws` | [`GeneralJWSInput`](../interfaces/types.GeneralJWSInput.md) | General JWS. |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Key to verify the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Key to verify the JWS with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`VerifyOptions`](../interfaces/types.VerifyOptions.md) | JWS Verify options. |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/jwt_verify.jwtVerify.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ as from its subpath export `'jose/jwt/verify'`.
| Name | Type | Description |
| :------ | :------ | :------ |
| `jwt` | `string` \| [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) | JSON Web Token value (encoded as JWS). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) | Key to verify the JWT with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `key` | [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](../interfaces/types.JWK.md) | Key to verify the JWT with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). |
| `options?` | [`JWTVerifyOptions`](../interfaces/jwt_verify.JWTVerifyOptions.md) | JWT Decryption and JWT Claims Set validation options. |

#### Returns
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/jws_compact_verify.CompactVerifyGetKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ verified at the time of this function call.

### CompactVerifyGetKey

**CompactVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
**CompactVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>

Dynamic key resolution function. No token components have been verified at the time of this
function call.
Expand All @@ -33,4 +33,4 @@ If you cannot match a key suitable for the token, throw an error instead.

#### Returns

[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>
4 changes: 2 additions & 2 deletions docs/interfaces/jws_flattened_verify.FlattenedVerifyGetKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ verified at the time of this function call.

### FlattenedVerifyGetKey

**FlattenedVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
**FlattenedVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>

Dynamic key resolution function. No token components have been verified at the time of this
function call.
Expand All @@ -33,4 +33,4 @@ If you cannot match a key suitable for the token, throw an error instead.

#### Returns

[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>
2 changes: 1 addition & 1 deletion docs/interfaces/jws_general_sign.Signature.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ A shorthand for calling addSignature() on the enclosing GeneralSign instance

| Name | Type |
| :------ | :------ |
| `...args` | [key: Uint8Array \| KeyLike, options?: SignOptions] |
| `...args` | [key: Uint8Array \| KeyLike \| JWK, options?: SignOptions] |

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/jws_general_verify.GeneralVerifyGetKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ verified at the time of this function call.

### GeneralVerifyGetKey

**GeneralVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
**GeneralVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>

Dynamic key resolution function. No token components have been verified at the time of this
function call.
Expand All @@ -33,4 +33,4 @@ If you cannot match a key suitable for the token, throw an error instead.

#### Returns

[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>
4 changes: 2 additions & 2 deletions docs/interfaces/jwt_verify.JWTVerifyGetKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ the time of this function call.

### JWTVerifyGetKey

**JWTVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
**JWTVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>

Dynamic key resolution function. No token components have been verified at the time of this
function call.
Expand All @@ -33,4 +33,4 @@ If you cannot match a key suitable for the token, throw an error instead.

#### Returns

[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md) \| [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )\<[`Uint8Array`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`JWK`](types.JWK.md)\>
2 changes: 1 addition & 1 deletion docs/interfaces/types.CompactJWEHeaderParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ ___

### jwk

`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"crv"`` \| ``"e"`` \| ``"kty"`` \| ``"n"``\>
`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"crv"`` \| ``"e"`` \| ``"n"`` \| ``"kty"``\>

"jwk" (JSON Web Key) Header Parameter.

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/types.CompactJWSHeaderParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ ___

### jwk

`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"crv"`` \| ``"e"`` \| ``"kty"`` \| ``"n"``\>
`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"crv"`` \| ``"e"`` \| ``"n"`` \| ``"kty"``\>

"jwk" (JSON Web Key) Header Parameter.

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/types.JWEHeaderParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ ___

### jwk

`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"crv"`` \| ``"e"`` \| ``"kty"`` \| ``"n"``\>
`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"crv"`` \| ``"e"`` \| ``"n"`` \| ``"kty"``\>

"jwk" (JSON Web Key) Header Parameter.

Expand Down
48 changes: 39 additions & 9 deletions docs/interfaces/types.JWK.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ key types are supported.

### Properties

- [kty](types.JWK.md#kty)
- [alg](types.JWK.md#alg)
- [crv](types.JWK.md#crv)
- [d](types.JWK.md#d)
Expand All @@ -23,7 +24,6 @@ key types are supported.
- [k](types.JWK.md#k)
- [key\_ops](types.JWK.md#key_ops)
- [kid](types.JWK.md#kid)
- [kty](types.JWK.md#kty)
- [n](types.JWK.md#n)
- [oth](types.JWK.md#oth)
- [p](types.JWK.md#p)
Expand All @@ -39,6 +39,14 @@ key types are supported.

## Properties

### kty

**kty**: `string`

JWK "kty" (Key Type) Parameter.

___

### alg

`Optional` **alg**: `string`
Expand All @@ -51,30 +59,43 @@ ___

`Optional` **crv**: `string`

- (EC) Curve
- (OKP) The Subtype of Key Pair

___

### d

`Optional` **d**: `string`

- (Private RSA) Private Exponent
- (Private EC) ECC Private Key
- (Private OKP) The Private Key

___

### dp

`Optional` **dp**: `string`

(Private RSA) First Factor CRT Exponent

___

### dq

`Optional` **dq**: `string`

(Private RSA) Second Factor CRT Exponent

___

### e

`Optional` **e**: `string`

(RSA) Exponent

___

### ext
Expand All @@ -89,6 +110,8 @@ ___

`Optional` **k**: `string`

(oct) Key Value

___

### key\_ops
Expand All @@ -107,42 +130,44 @@ JWK "kid" (Key ID) Parameter.

___

### kty

`Optional` **kty**: `string`

JWK "kty" (Key Type) Parameter.

___

### n

`Optional` **n**: `string`

(RSA) Modulus

___

### oth

`Optional` **oth**: \{ `d?`: `string` ; `r?`: `string` ; `t?`: `string` }[]

(Private RSA) Other Primes Info. This parameter is not supported.

___

### p

`Optional` **p**: `string`

(Private RSA) First Prime Factor

___

### q

`Optional` **q**: `string`

(Private RSA) Second Prime Factor

___

### qi

`Optional` **qi**: `string`

(Private RSA) First CRT Coefficient

___

### use
Expand All @@ -157,6 +182,9 @@ ___

`Optional` **x**: `string`

- (EC) X Coordinate
- (OKP) The public key

___

### x5c
Expand Down Expand Up @@ -194,3 +222,5 @@ ___
### y

`Optional` **y**: `string`

(EC) Y Coordinate
Loading

0 comments on commit c6302ea

Please sign in to comment.