diff --git a/docs/interfaces/types.CompactJWEHeaderParameters.md b/docs/interfaces/types.CompactJWEHeaderParameters.md index 466c082d45..c2589c526e 100644 --- a/docs/interfaces/types.CompactJWEHeaderParameters.md +++ b/docs/interfaces/types.CompactJWEHeaderParameters.md @@ -31,7 +31,7 @@ Recognized Compact JWE Header Parameters, any other Header Members may also be p • **alg**: `string` -JWE "alg" (Algorithm) Header Parameter. +JWE "alg" (Algorithm) Header Parameter ___ @@ -39,7 +39,7 @@ ___ • **enc**: `string` -JWE "enc" (Encryption Algorithm) Header Parameter. +JWE "enc" (Encryption Algorithm) Header Parameter ___ @@ -47,7 +47,7 @@ ___ • `Optional` **crit**: `string`[] -JWE "crit" (Critical) Header Parameter. +JWE "crit" (Critical) Header Parameter ___ @@ -55,7 +55,7 @@ ___ • `Optional` **cty**: `string` -"cty" (Content Type) Header Parameter. +"cty" (Content Type) Header Parameter ___ @@ -63,7 +63,7 @@ ___ • `Optional` **jku**: `string` -"jku" (JWK Set URL) Header Parameter. +"jku" (JWK Set URL) Header Parameter ___ @@ -71,7 +71,7 @@ ___ • `Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\> -"jwk" (JSON Web Key) Header Parameter. +"jwk" (JSON Web Key) Header Parameter ___ @@ -79,7 +79,7 @@ ___ • `Optional` **kid**: `string` -"kid" (Key ID) Header Parameter. +"kid" (Key ID) Header Parameter ___ @@ -87,7 +87,7 @@ ___ • `Optional` **typ**: `string` -"typ" (Type) Header Parameter. +"typ" (Type) Header Parameter ___ @@ -95,7 +95,7 @@ ___ • `Optional` **x5c**: `string`[] -"x5c" (X.509 Certificate Chain) Header Parameter. +"x5c" (X.509 Certificate Chain) Header Parameter ___ @@ -103,7 +103,7 @@ ___ • `Optional` **x5t**: `string` -"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. +"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter ___ @@ -111,7 +111,7 @@ ___ • `Optional` **x5u**: `string` -"x5u" (X.509 URL) Header Parameter. +"x5u" (X.509 URL) Header Parameter ___ diff --git a/docs/interfaces/types.CompactJWSHeaderParameters.md b/docs/interfaces/types.CompactJWSHeaderParameters.md index 3aff524711..5b989fd597 100644 --- a/docs/interfaces/types.CompactJWSHeaderParameters.md +++ b/docs/interfaces/types.CompactJWSHeaderParameters.md @@ -30,7 +30,7 @@ Recognized Compact JWS Header Parameters, any other Header Members may also be p • **alg**: `string` -JWS "alg" (Algorithm) Header Parameter. +JWS "alg" (Algorithm) Header Parameter ___ @@ -47,7 +47,7 @@ ___ • `Optional` **crit**: `string`[] -JWS "crit" (Critical) Header Parameter. +JWS "crit" (Critical) Header Parameter ___ @@ -55,7 +55,7 @@ ___ • `Optional` **cty**: `string` -"cty" (Content Type) Header Parameter. +"cty" (Content Type) Header Parameter ___ @@ -63,7 +63,7 @@ ___ • `Optional` **jku**: `string` -"jku" (JWK Set URL) Header Parameter. +"jku" (JWK Set URL) Header Parameter ___ @@ -71,7 +71,7 @@ ___ • `Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\> -"jwk" (JSON Web Key) Header Parameter. +"jwk" (JSON Web Key) Header Parameter ___ @@ -79,7 +79,7 @@ ___ • `Optional` **kid**: `string` -"kid" (Key ID) Header Parameter. +"kid" (Key ID) Header Parameter ___ @@ -87,7 +87,7 @@ ___ • `Optional` **typ**: `string` -"typ" (Type) Header Parameter. +"typ" (Type) Header Parameter ___ @@ -95,7 +95,7 @@ ___ • `Optional` **x5c**: `string`[] -"x5c" (X.509 Certificate Chain) Header Parameter. +"x5c" (X.509 Certificate Chain) Header Parameter ___ @@ -103,7 +103,7 @@ ___ • `Optional` **x5t**: `string` -"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. +"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter ___ @@ -111,4 +111,4 @@ ___ • `Optional` **x5u**: `string` -"x5u" (X.509 URL) Header Parameter. +"x5u" (X.509 URL) Header Parameter diff --git a/docs/interfaces/types.JWEHeaderParameters.md b/docs/interfaces/types.JWEHeaderParameters.md index f3c886d254..b55f3b2f47 100644 --- a/docs/interfaces/types.JWEHeaderParameters.md +++ b/docs/interfaces/types.JWEHeaderParameters.md @@ -31,7 +31,7 @@ Recognized JWE Header Parameters, any other Header members may also be present. • `Optional` **alg**: `string` -JWE "alg" (Algorithm) Header Parameter. +JWE "alg" (Algorithm) Header Parameter ___ @@ -39,7 +39,7 @@ ___ • `Optional` **crit**: `string`[] -JWE "crit" (Critical) Header Parameter. +JWE "crit" (Critical) Header Parameter ___ @@ -47,7 +47,7 @@ ___ • `Optional` **cty**: `string` -"cty" (Content Type) Header Parameter. +"cty" (Content Type) Header Parameter ___ @@ -55,7 +55,7 @@ ___ • `Optional` **enc**: `string` -JWE "enc" (Encryption Algorithm) Header Parameter. +JWE "enc" (Encryption Algorithm) Header Parameter ___ @@ -63,7 +63,7 @@ ___ • `Optional` **jku**: `string` -"jku" (JWK Set URL) Header Parameter. +"jku" (JWK Set URL) Header Parameter ___ @@ -71,7 +71,7 @@ ___ • `Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\> -"jwk" (JSON Web Key) Header Parameter. +"jwk" (JSON Web Key) Header Parameter ___ @@ -79,7 +79,7 @@ ___ • `Optional` **kid**: `string` -"kid" (Key ID) Header Parameter. +"kid" (Key ID) Header Parameter ___ @@ -87,7 +87,7 @@ ___ • `Optional` **typ**: `string` -"typ" (Type) Header Parameter. +"typ" (Type) Header Parameter ___ @@ -95,7 +95,7 @@ ___ • `Optional` **x5c**: `string`[] -"x5c" (X.509 Certificate Chain) Header Parameter. +"x5c" (X.509 Certificate Chain) Header Parameter ___ @@ -103,7 +103,7 @@ ___ • `Optional` **x5t**: `string` -"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. +"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter ___ @@ -111,7 +111,7 @@ ___ • `Optional` **x5u**: `string` -"x5u" (X.509 URL) Header Parameter. +"x5u" (X.509 URL) Header Parameter ___ diff --git a/docs/interfaces/types.JWK.md b/docs/interfaces/types.JWK.md index df067ef9ac..578158d980 100644 --- a/docs/interfaces/types.JWK.md +++ b/docs/interfaces/types.JWK.md @@ -53,7 +53,7 @@ key types are supported. • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -61,7 +61,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -69,8 +69,8 @@ ___ • `Optional` **crv**: `string` -- (EC) Curve -- (OKP) The Subtype of Key Pair +- EC JWK "crv" (Curve) Parameter +- OKP JWK "crv" (The Subtype of Key Pair) Parameter ___ @@ -78,9 +78,9 @@ ___ • `Optional` **d**: `string` -- (Private RSA) Private Exponent -- (Private EC) ECC Private Key -- (Private OKP) The Private Key +- Private RSA JWK "d" (Private Exponent) Parameter +- Private EC JWK "d" (ECC Private Key) Parameter +- Private OKP JWK "d" (The Private Key) Parameter ___ @@ -88,7 +88,7 @@ ___ • `Optional` **dp**: `string` -(Private RSA) First Factor CRT Exponent +Private RSA JWK "dp" (First Factor CRT Exponent) Parameter ___ @@ -96,7 +96,7 @@ ___ • `Optional` **dq**: `string` -(Private RSA) Second Factor CRT Exponent +Private RSA JWK "dq" (Second Factor CRT Exponent) Parameter ___ @@ -104,7 +104,7 @@ ___ • `Optional` **e**: `string` -(RSA) Exponent +RSA JWK "e" (Exponent) Parameter ___ @@ -112,7 +112,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -120,7 +120,7 @@ ___ • `Optional` **k**: `string` -(oct) Key Value +Oct JWK "k" (Key Value) Parameter ___ @@ -128,7 +128,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -136,7 +136,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -144,7 +144,7 @@ ___ • `Optional` **n**: `string` -(RSA) Modulus +RSA JWK "n" (Modulus) Parameter ___ @@ -152,7 +152,9 @@ ___ • `Optional` **oth**: \{ `d?`: `string` ; `r?`: `string` ; `t?`: `string` }[] -(Private RSA) Other Primes Info. This parameter is not supported. +Private RSA JWK "oth" (Other Primes Info) Parameter + +This parameter is not supported ___ @@ -160,7 +162,7 @@ ___ • `Optional` **p**: `string` -(Private RSA) First Prime Factor +Private RSA JWK "p" (First Prime Factor) Parameter ___ @@ -168,7 +170,7 @@ ___ • `Optional` **q**: `string` -(Private RSA) Second Prime Factor +Private RSA JWK "q" (Second Prime Factor) Parameter ___ @@ -176,7 +178,7 @@ ___ • `Optional` **qi**: `string` -(Private RSA) First CRT Coefficient +Private RSA JWK "qi" (First CRT Coefficient) Parameter ___ @@ -184,7 +186,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -192,8 +194,8 @@ ___ • `Optional` **x**: `string` -- (EC) X Coordinate -- (OKP) The public key +- EC JWK "x" (X Coordinate) Parameter +- OKP JWK "x" (The public key) Parameter ___ @@ -201,7 +203,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -209,7 +211,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -217,7 +219,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -225,7 +227,7 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter ___ @@ -233,4 +235,4 @@ ___ • `Optional` **y**: `string` -(EC) Y Coordinate +EC JWK "y" (Y Coordinate) Parameter diff --git a/docs/interfaces/types.JWKParameters.md b/docs/interfaces/types.JWKParameters.md index c03415b30e..6d9c0d63d8 100644 --- a/docs/interfaces/types.JWKParameters.md +++ b/docs/interfaces/types.JWKParameters.md @@ -29,7 +29,7 @@ Generic JSON Web Key Parameters. • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -37,7 +37,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -45,7 +45,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -53,7 +53,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -61,7 +61,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -69,7 +69,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -77,7 +77,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -85,7 +85,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -93,7 +93,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -101,4 +101,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWK_EC_Private.md b/docs/interfaces/types.JWK_EC_Private.md index 2947f9f7c8..2c5cdd937e 100644 --- a/docs/interfaces/types.JWK_EC_Private.md +++ b/docs/interfaces/types.JWK_EC_Private.md @@ -33,7 +33,7 @@ Convenience interface for Private EC JSON Web Keys • **crv**: `string` -Curve +EC JWK "crv" (Curve) Parameter ___ @@ -41,7 +41,7 @@ ___ • **d**: `string` -ECC Private Key +EC JWK "d" (ECC Private Key) Parameter ___ @@ -49,7 +49,7 @@ ___ • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -57,7 +57,7 @@ ___ • **x**: `string` -X Coordinate +EC JWK "x" (X Coordinate) Parameter ___ @@ -65,7 +65,7 @@ ___ • **y**: `string` -Y Coordinate +EC JWK "y" (Y Coordinate) Parameter ___ @@ -73,7 +73,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -81,7 +81,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -89,7 +89,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -97,7 +97,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -105,7 +105,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -113,7 +113,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -121,7 +121,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -129,7 +129,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -137,4 +137,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWK_EC_Public.md b/docs/interfaces/types.JWK_EC_Public.md index e154527001..3c1349ca28 100644 --- a/docs/interfaces/types.JWK_EC_Public.md +++ b/docs/interfaces/types.JWK_EC_Public.md @@ -32,7 +32,7 @@ Convenience interface for Public EC JSON Web Keys • **crv**: `string` -Curve +EC JWK "crv" (Curve) Parameter ___ @@ -40,7 +40,7 @@ ___ • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -48,7 +48,7 @@ ___ • **x**: `string` -X Coordinate +EC JWK "x" (X Coordinate) Parameter ___ @@ -56,7 +56,7 @@ ___ • **y**: `string` -Y Coordinate +EC JWK "y" (Y Coordinate) Parameter ___ @@ -64,7 +64,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -72,7 +72,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -80,7 +80,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -88,7 +88,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -96,7 +96,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -104,7 +104,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -112,7 +112,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -120,7 +120,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -128,4 +128,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWK_OKP_Private.md b/docs/interfaces/types.JWK_OKP_Private.md index 533ec9097b..b6ceb9f6d7 100644 --- a/docs/interfaces/types.JWK_OKP_Private.md +++ b/docs/interfaces/types.JWK_OKP_Private.md @@ -32,7 +32,7 @@ Convenience interface for Private OKP JSON Web Keys • **crv**: `string` -The Subtype of Key Pair +OKP JWK "crv" (The Subtype of Key Pair) Parameter ___ @@ -40,7 +40,7 @@ ___ • **d**: `string` -The Private Key +OKP JWK "d" (The Private Key) Parameter ___ @@ -48,7 +48,7 @@ ___ • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -56,7 +56,7 @@ ___ • **x**: `string` -The public key +OKP JWK "x" (The public key) Parameter ___ @@ -64,7 +64,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -72,7 +72,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -80,7 +80,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -88,7 +88,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -96,7 +96,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -104,7 +104,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -112,7 +112,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -120,7 +120,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -128,4 +128,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWK_OKP_Public.md b/docs/interfaces/types.JWK_OKP_Public.md index fbefba90d4..b4be08c0ca 100644 --- a/docs/interfaces/types.JWK_OKP_Public.md +++ b/docs/interfaces/types.JWK_OKP_Public.md @@ -31,7 +31,7 @@ Convenience interface for Public OKP JSON Web Keys • **crv**: `string` -The Subtype of Key Pair +OKP JWK "crv" (The Subtype of Key Pair) Parameter ___ @@ -39,7 +39,7 @@ ___ • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -47,7 +47,7 @@ ___ • **x**: `string` -The public key +OKP JWK "x" (The public key) Parameter ___ @@ -55,7 +55,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -63,7 +63,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -71,7 +71,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -79,7 +79,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -87,7 +87,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -95,7 +95,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -103,7 +103,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -111,7 +111,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -119,4 +119,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWK_RSA_Private.md b/docs/interfaces/types.JWK_RSA_Private.md index e0d8e5625d..f8b7a98441 100644 --- a/docs/interfaces/types.JWK_RSA_Private.md +++ b/docs/interfaces/types.JWK_RSA_Private.md @@ -38,7 +38,7 @@ Convenience interface for Private RSA JSON Web Keys • **d**: `string` -Private Exponent +RSA JWK "d" (Private Exponent) Parameter ___ @@ -46,7 +46,7 @@ ___ • **dp**: `string` -First Factor CRT Exponent +RSA JWK "dp" (First Factor CRT Exponent) Parameter ___ @@ -54,7 +54,7 @@ ___ • **dq**: `string` -Second Factor CRT Exponent +RSA JWK "dq" (Second Factor CRT Exponent) Parameter ___ @@ -62,7 +62,7 @@ ___ • **e**: `string` -Exponent +RSA JWK "e" (Exponent) Parameter ___ @@ -70,7 +70,7 @@ ___ • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -78,7 +78,7 @@ ___ • **n**: `string` -Modulus +RSA JWK "n" (Modulus) Parameter ___ @@ -86,7 +86,7 @@ ___ • **p**: `string` -First Prime Factor +RSA JWK "p" (First Prime Factor) Parameter ___ @@ -94,7 +94,7 @@ ___ • **q**: `string` -Second Prime Factor +RSA JWK "q" (Second Prime Factor) Parameter ___ @@ -102,7 +102,7 @@ ___ • **qi**: `string` -First CRT Coefficient +RSA JWK "qi" (First CRT Coefficient) Parameter ___ @@ -110,7 +110,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -118,7 +118,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -126,7 +126,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -134,7 +134,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -142,7 +142,9 @@ ___ • `Optional` **oth**: \{ `d?`: `string` ; `r?`: `string` ; `t?`: `string` }[] -Other Primes Info. This parameter is not supported. +RSA JWK "oth" (Other Primes Info) Parameter + +This parameter is not supported ___ @@ -150,7 +152,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -158,7 +160,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -166,7 +168,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -174,7 +176,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -182,4 +184,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWK_RSA_Public.md b/docs/interfaces/types.JWK_RSA_Public.md index ed6dcb1c57..6ef011b9af 100644 --- a/docs/interfaces/types.JWK_RSA_Public.md +++ b/docs/interfaces/types.JWK_RSA_Public.md @@ -31,7 +31,7 @@ Convenience interface for Public RSA JSON Web Keys • **e**: `string` -Exponent +RSA JWK "e" (Exponent) Parameter ___ @@ -39,7 +39,7 @@ ___ • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -47,7 +47,7 @@ ___ • **n**: `string` -Modulus +RSA JWK "n" (Modulus) Parameter ___ @@ -55,7 +55,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -63,7 +63,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -71,7 +71,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -79,7 +79,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -87,7 +87,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -95,7 +95,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -103,7 +103,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -111,7 +111,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -119,4 +119,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWK_oct.md b/docs/interfaces/types.JWK_oct.md index eb5ebcf8b8..8043aea62e 100644 --- a/docs/interfaces/types.JWK_oct.md +++ b/docs/interfaces/types.JWK_oct.md @@ -30,7 +30,7 @@ Convenience interface for oct JSON Web Keys • **k**: `string` -Key Value +Oct JWK "k" (Key Value) Parameter ___ @@ -38,7 +38,7 @@ ___ • **kty**: `string` -JWK "kty" (Key Type) Parameter. +JWK "kty" (Key Type) Parameter ___ @@ -46,7 +46,7 @@ ___ • `Optional` **alg**: `string` -JWK "alg" (Algorithm) Parameter. +JWK "alg" (Algorithm) Parameter ___ @@ -54,7 +54,7 @@ ___ • `Optional` **ext**: `boolean` -JWK "ext" (Extractable) Parameter. +JWK "ext" (Extractable) Parameter ___ @@ -62,7 +62,7 @@ ___ • `Optional` **key\_ops**: `string`[] -JWK "key_ops" (Key Operations) Parameter. +JWK "key_ops" (Key Operations) Parameter ___ @@ -70,7 +70,7 @@ ___ • `Optional` **kid**: `string` -JWK "kid" (Key ID) Parameter. +JWK "kid" (Key ID) Parameter ___ @@ -78,7 +78,7 @@ ___ • `Optional` **use**: `string` -JWK "use" (Public Key Use) Parameter. +JWK "use" (Public Key Use) Parameter ___ @@ -86,7 +86,7 @@ ___ • `Optional` **x5c**: `string`[] -JWK "x5c" (X.509 Certificate Chain) Parameter. +JWK "x5c" (X.509 Certificate Chain) Parameter ___ @@ -94,7 +94,7 @@ ___ • `Optional` **x5t**: `string` -JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. +JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter ___ @@ -102,7 +102,7 @@ ___ • `Optional` **x5t#S256**: `string` -"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. +JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter ___ @@ -110,4 +110,4 @@ ___ • `Optional` **x5u**: `string` -JWK "x5u" (X.509 URL) Parameter. +JWK "x5u" (X.509 URL) Parameter diff --git a/docs/interfaces/types.JWSHeaderParameters.md b/docs/interfaces/types.JWSHeaderParameters.md index 5e0e9c5fe5..46bdb15028 100644 --- a/docs/interfaces/types.JWSHeaderParameters.md +++ b/docs/interfaces/types.JWSHeaderParameters.md @@ -30,7 +30,7 @@ Recognized JWS Header Parameters, any other Header Members may also be present. • `Optional` **alg**: `string` -JWS "alg" (Algorithm) Header Parameter. +JWS "alg" (Algorithm) Header Parameter ___ @@ -47,7 +47,7 @@ ___ • `Optional` **crit**: `string`[] -JWS "crit" (Critical) Header Parameter. +JWS "crit" (Critical) Header Parameter ___ @@ -55,7 +55,7 @@ ___ • `Optional` **cty**: `string` -"cty" (Content Type) Header Parameter. +"cty" (Content Type) Header Parameter ___ @@ -63,7 +63,7 @@ ___ • `Optional` **jku**: `string` -"jku" (JWK Set URL) Header Parameter. +"jku" (JWK Set URL) Header Parameter ___ @@ -71,7 +71,7 @@ ___ • `Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\> -"jwk" (JSON Web Key) Header Parameter. +"jwk" (JSON Web Key) Header Parameter ___ @@ -79,7 +79,7 @@ ___ • `Optional` **kid**: `string` -"kid" (Key ID) Header Parameter. +"kid" (Key ID) Header Parameter ___ @@ -87,7 +87,7 @@ ___ • `Optional` **typ**: `string` -"typ" (Type) Header Parameter. +"typ" (Type) Header Parameter ___ @@ -95,7 +95,7 @@ ___ • `Optional` **x5c**: `string`[] -"x5c" (X.509 Certificate Chain) Header Parameter. +"x5c" (X.509 Certificate Chain) Header Parameter ___ @@ -103,7 +103,7 @@ ___ • `Optional` **x5t**: `string` -"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. +"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter ___ @@ -111,4 +111,4 @@ ___ • `Optional` **x5u**: `string` -"x5u" (X.509 URL) Header Parameter. +"x5u" (X.509 URL) Header Parameter diff --git a/docs/interfaces/types.JWTHeaderParameters.md b/docs/interfaces/types.JWTHeaderParameters.md index 2a3fa8cf7a..cb97dc18d8 100644 --- a/docs/interfaces/types.JWTHeaderParameters.md +++ b/docs/interfaces/types.JWTHeaderParameters.md @@ -30,7 +30,7 @@ Recognized Signed JWT Header Parameters, any other Header Members may also be pr • **alg**: `string` -JWS "alg" (Algorithm) Header Parameter. +JWS "alg" (Algorithm) Header Parameter ___ @@ -47,7 +47,7 @@ ___ • `Optional` **crit**: `string`[] -JWS "crit" (Critical) Header Parameter. +JWS "crit" (Critical) Header Parameter ___ @@ -55,7 +55,7 @@ ___ • `Optional` **cty**: `string` -"cty" (Content Type) Header Parameter. +"cty" (Content Type) Header Parameter ___ @@ -63,7 +63,7 @@ ___ • `Optional` **jku**: `string` -"jku" (JWK Set URL) Header Parameter. +"jku" (JWK Set URL) Header Parameter ___ @@ -71,7 +71,7 @@ ___ • `Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\> -"jwk" (JSON Web Key) Header Parameter. +"jwk" (JSON Web Key) Header Parameter ___ @@ -79,7 +79,7 @@ ___ • `Optional` **kid**: `string` -"kid" (Key ID) Header Parameter. +"kid" (Key ID) Header Parameter ___ @@ -87,7 +87,7 @@ ___ • `Optional` **typ**: `string` -"typ" (Type) Header Parameter. +"typ" (Type) Header Parameter ___ @@ -95,7 +95,7 @@ ___ • `Optional` **x5c**: `string`[] -"x5c" (X.509 Certificate Chain) Header Parameter. +"x5c" (X.509 Certificate Chain) Header Parameter ___ @@ -103,7 +103,7 @@ ___ • `Optional` **x5t**: `string` -"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. +"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter ___ @@ -111,4 +111,4 @@ ___ • `Optional` **x5u**: `string` -"x5u" (X.509 URL) Header Parameter. +"x5u" (X.509 URL) Header Parameter diff --git a/docs/interfaces/types.JoseHeaderParameters.md b/docs/interfaces/types.JoseHeaderParameters.md index c8dead422d..1071816d0b 100644 --- a/docs/interfaces/types.JoseHeaderParameters.md +++ b/docs/interfaces/types.JoseHeaderParameters.md @@ -25,7 +25,7 @@ Support from the community to continue maintaining and improving this module is • `Optional` **cty**: `string` -"cty" (Content Type) Header Parameter. +"cty" (Content Type) Header Parameter ___ @@ -33,7 +33,7 @@ ___ • `Optional` **jku**: `string` -"jku" (JWK Set URL) Header Parameter. +"jku" (JWK Set URL) Header Parameter ___ @@ -41,7 +41,7 @@ ___ • `Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\> -"jwk" (JSON Web Key) Header Parameter. +"jwk" (JSON Web Key) Header Parameter ___ @@ -49,7 +49,7 @@ ___ • `Optional` **kid**: `string` -"kid" (Key ID) Header Parameter. +"kid" (Key ID) Header Parameter ___ @@ -57,7 +57,7 @@ ___ • `Optional` **typ**: `string` -"typ" (Type) Header Parameter. +"typ" (Type) Header Parameter ___ @@ -65,7 +65,7 @@ ___ • `Optional` **x5c**: `string`[] -"x5c" (X.509 Certificate Chain) Header Parameter. +"x5c" (X.509 Certificate Chain) Header Parameter ___ @@ -73,7 +73,7 @@ ___ • `Optional` **x5t**: `string` -"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. +"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter ___ @@ -81,4 +81,4 @@ ___ • `Optional` **x5u**: `string` -"x5u" (X.509 URL) Header Parameter. +"x5u" (X.509 URL) Header Parameter diff --git a/src/types.d.ts b/src/types.d.ts index 36d660c2df..beddcdb768 100644 --- a/src/types.d.ts +++ b/src/types.d.ts @@ -101,91 +101,95 @@ export type KeyLike = { type: string } /** Generic JSON Web Key Parameters. */ export interface JWKParameters { - /** JWK "kty" (Key Type) Parameter. */ + /** JWK "kty" (Key Type) Parameter */ kty: string - /** JWK "alg" (Algorithm) Parameter. */ + /** JWK "alg" (Algorithm) Parameter */ alg?: string - /** JWK "key_ops" (Key Operations) Parameter. */ + /** JWK "key_ops" (Key Operations) Parameter */ key_ops?: string[] - /** JWK "ext" (Extractable) Parameter. */ + /** JWK "ext" (Extractable) Parameter */ ext?: boolean - /** JWK "use" (Public Key Use) Parameter. */ + /** JWK "use" (Public Key Use) Parameter */ use?: string - /** JWK "x5c" (X.509 Certificate Chain) Parameter. */ + /** JWK "x5c" (X.509 Certificate Chain) Parameter */ x5c?: string[] - /** JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. */ + /** JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter */ x5t?: string - /** "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. */ + /** JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter */ 'x5t#S256'?: string - /** JWK "x5u" (X.509 URL) Parameter. */ + /** JWK "x5u" (X.509 URL) Parameter */ x5u?: string - /** JWK "kid" (Key ID) Parameter. */ + /** JWK "kid" (Key ID) Parameter */ kid?: string } /** Convenience interface for Public OKP JSON Web Keys */ export interface JWK_OKP_Public extends JWKParameters { - /** The Subtype of Key Pair */ + /** OKP JWK "crv" (The Subtype of Key Pair) Parameter */ crv: string - /** The public key */ + /** OKP JWK "x" (The public key) Parameter */ x: string } /** Convenience interface for Private OKP JSON Web Keys */ export interface JWK_OKP_Private extends JWK_OKP_Public, JWKParameters { - /** The Private Key */ + /** OKP JWK "d" (The Private Key) Parameter */ d: string } /** Convenience interface for Public EC JSON Web Keys */ export interface JWK_EC_Public extends JWKParameters { - /** Curve */ + /** EC JWK "crv" (Curve) Parameter */ crv: string - /** X Coordinate */ + /** EC JWK "x" (X Coordinate) Parameter */ x: string - /** Y Coordinate */ + /** EC JWK "y" (Y Coordinate) Parameter */ y: string } /** Convenience interface for Private EC JSON Web Keys */ export interface JWK_EC_Private extends JWK_EC_Public, JWKParameters { - /** ECC Private Key */ + /** EC JWK "d" (ECC Private Key) Parameter */ d: string } /** Convenience interface for Public RSA JSON Web Keys */ export interface JWK_RSA_Public extends JWKParameters { - /** Exponent */ + /** RSA JWK "e" (Exponent) Parameter */ e: string - /** Modulus */ + /** RSA JWK "n" (Modulus) Parameter */ n: string } /** Convenience interface for Private RSA JSON Web Keys */ export interface JWK_RSA_Private extends JWK_RSA_Public, JWKParameters { - /** Private Exponent */ + /** RSA JWK "d" (Private Exponent) Parameter */ d: string - /** First Factor CRT Exponent */ + /** RSA JWK "dp" (First Factor CRT Exponent) Parameter */ dp: string - /** Second Factor CRT Exponent */ + /** RSA JWK "dq" (Second Factor CRT Exponent) Parameter */ dq: string - /** Other Primes Info. This parameter is not supported. */ + /** + * RSA JWK "oth" (Other Primes Info) Parameter + * + * This parameter is not supported + */ oth?: Array<{ d?: string r?: string t?: string }> - /** First Prime Factor */ + /** RSA JWK "p" (First Prime Factor) Parameter */ p: string - /** Second Prime Factor */ + /** RSA JWK "q" (Second Prime Factor) Parameter */ q: string - /** First CRT Coefficient */ + /** RSA JWK "qi" (First CRT Coefficient) Parameter */ qi: string } /** Convenience interface for oct JSON Web Keys */ export interface JWK_oct extends JWKParameters { - /** Key Value */ + /** Oct JWK "k" (Key Value) Parameter */ k: string } @@ -203,44 +207,48 @@ export interface JWK_oct extends JWKParameters { */ export interface JWK extends JWKParameters { /** - * - (EC) Curve - * - (OKP) The Subtype of Key Pair + * - EC JWK "crv" (Curve) Parameter + * - OKP JWK "crv" (The Subtype of Key Pair) Parameter */ crv?: string /** - * - (Private RSA) Private Exponent - * - (Private EC) ECC Private Key - * - (Private OKP) The Private Key + * - Private RSA JWK "d" (Private Exponent) Parameter + * - Private EC JWK "d" (ECC Private Key) Parameter + * - Private OKP JWK "d" (The Private Key) Parameter */ d?: string - /** (Private RSA) First Factor CRT Exponent */ + /** Private RSA JWK "dp" (First Factor CRT Exponent) Parameter */ dp?: string - /** (Private RSA) Second Factor CRT Exponent */ + /** Private RSA JWK "dq" (Second Factor CRT Exponent) Parameter */ dq?: string - /** (RSA) Exponent */ + /** RSA JWK "e" (Exponent) Parameter */ e?: string - /** (oct) Key Value */ + /** Oct JWK "k" (Key Value) Parameter */ k?: string - /** (RSA) Modulus */ + /** RSA JWK "n" (Modulus) Parameter */ n?: string - /** (Private RSA) Other Primes Info. This parameter is not supported. */ + /** + * Private RSA JWK "oth" (Other Primes Info) Parameter + * + * This parameter is not supported + */ oth?: Array<{ d?: string r?: string t?: string }> - /** (Private RSA) First Prime Factor */ + /** Private RSA JWK "p" (First Prime Factor) Parameter */ p?: string - /** (Private RSA) Second Prime Factor */ + /** Private RSA JWK "q" (Second Prime Factor) Parameter */ q?: string - /** (Private RSA) First CRT Coefficient */ + /** Private RSA JWK "qi" (First CRT Coefficient) Parameter */ qi?: string /** - * - (EC) X Coordinate - * - (OKP) The public key + * - EC JWK "x" (X Coordinate) Parameter + * - OKP JWK "x" (The public key) Parameter */ x?: string - /** (EC) Y Coordinate */ + /** EC JWK "y" (Y Coordinate) Parameter */ y?: string } @@ -339,34 +347,34 @@ export interface GeneralJWS { } export interface JoseHeaderParameters { - /** "kid" (Key ID) Header Parameter. */ + /** "kid" (Key ID) Header Parameter */ kid?: string - /** "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. */ + /** "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter */ x5t?: string - /** "x5c" (X.509 Certificate Chain) Header Parameter. */ + /** "x5c" (X.509 Certificate Chain) Header Parameter */ x5c?: string[] - /** "x5u" (X.509 URL) Header Parameter. */ + /** "x5u" (X.509 URL) Header Parameter */ x5u?: string - /** "jku" (JWK Set URL) Header Parameter. */ + /** "jku" (JWK Set URL) Header Parameter */ jku?: string - /** "jwk" (JSON Web Key) Header Parameter. */ + /** "jwk" (JSON Web Key) Header Parameter */ jwk?: Pick - /** "typ" (Type) Header Parameter. */ + /** "typ" (Type) Header Parameter */ typ?: string - /** "cty" (Content Type) Header Parameter. */ + /** "cty" (Content Type) Header Parameter */ cty?: string } /** Recognized JWS Header Parameters, any other Header Members may also be present. */ export interface JWSHeaderParameters extends JoseHeaderParameters { - /** JWS "alg" (Algorithm) Header Parameter. */ + /** JWS "alg" (Algorithm) Header Parameter */ alg?: string /** @@ -375,7 +383,7 @@ export interface JWSHeaderParameters extends JoseHeaderParameters { */ b64?: boolean - /** JWS "crit" (Critical) Header Parameter. */ + /** JWS "crit" (Critical) Header Parameter */ crit?: string[] /** Any other JWS Header member. */ @@ -468,13 +476,13 @@ export interface GeneralJWE extends Omit