diff --git a/docs/interfaces/types.CompactJWEHeaderParameters.md b/docs/interfaces/types.CompactJWEHeaderParameters.md index c2589c526e..73b7a306e3 100644 --- a/docs/interfaces/types.CompactJWEHeaderParameters.md +++ b/docs/interfaces/types.CompactJWEHeaderParameters.md @@ -33,6 +33,10 @@ Recognized Compact JWE Header Parameters, any other Header Members may also be p JWE "alg" (Algorithm) Header Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg) + ___ ### enc @@ -41,6 +45,10 @@ ___ JWE "enc" (Encryption Algorithm) Header Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg) + ___ ### crit diff --git a/docs/interfaces/types.CompactJWSHeaderParameters.md b/docs/interfaces/types.CompactJWSHeaderParameters.md index 5b989fd597..aaee961162 100644 --- a/docs/interfaces/types.CompactJWSHeaderParameters.md +++ b/docs/interfaces/types.CompactJWSHeaderParameters.md @@ -32,6 +32,10 @@ Recognized Compact JWS Header Parameters, any other Header Members may also be p JWS "alg" (Algorithm) Header Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). + ___ ### b64 diff --git a/docs/interfaces/types.JWEHeaderParameters.md b/docs/interfaces/types.JWEHeaderParameters.md index b55f3b2f47..40d582a07e 100644 --- a/docs/interfaces/types.JWEHeaderParameters.md +++ b/docs/interfaces/types.JWEHeaderParameters.md @@ -33,6 +33,10 @@ Recognized JWE Header Parameters, any other Header members may also be present. JWE "alg" (Algorithm) Header Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg) + ___ ### crit @@ -57,6 +61,10 @@ ___ JWE "enc" (Encryption Algorithm) Header Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg) + ___ ### jku diff --git a/docs/interfaces/types.JWK.md b/docs/interfaces/types.JWK.md index 578158d980..a8f7a8d617 100644 --- a/docs/interfaces/types.JWK.md +++ b/docs/interfaces/types.JWK.md @@ -63,6 +63,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### crv diff --git a/docs/interfaces/types.JWKParameters.md b/docs/interfaces/types.JWKParameters.md index 6d9c0d63d8..7caed195b8 100644 --- a/docs/interfaces/types.JWKParameters.md +++ b/docs/interfaces/types.JWKParameters.md @@ -39,6 +39,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWK_EC_Private.md b/docs/interfaces/types.JWK_EC_Private.md index 2c5cdd937e..9c4d4ced37 100644 --- a/docs/interfaces/types.JWK_EC_Private.md +++ b/docs/interfaces/types.JWK_EC_Private.md @@ -75,6 +75,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWK_EC_Public.md b/docs/interfaces/types.JWK_EC_Public.md index 3c1349ca28..f4ff98eb79 100644 --- a/docs/interfaces/types.JWK_EC_Public.md +++ b/docs/interfaces/types.JWK_EC_Public.md @@ -66,6 +66,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWK_OKP_Private.md b/docs/interfaces/types.JWK_OKP_Private.md index b6ceb9f6d7..b62f2c340b 100644 --- a/docs/interfaces/types.JWK_OKP_Private.md +++ b/docs/interfaces/types.JWK_OKP_Private.md @@ -66,6 +66,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWK_OKP_Public.md b/docs/interfaces/types.JWK_OKP_Public.md index b4be08c0ca..03c25b004e 100644 --- a/docs/interfaces/types.JWK_OKP_Public.md +++ b/docs/interfaces/types.JWK_OKP_Public.md @@ -57,6 +57,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWK_RSA_Private.md b/docs/interfaces/types.JWK_RSA_Private.md index f8b7a98441..46d693d74c 100644 --- a/docs/interfaces/types.JWK_RSA_Private.md +++ b/docs/interfaces/types.JWK_RSA_Private.md @@ -112,6 +112,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWK_RSA_Public.md b/docs/interfaces/types.JWK_RSA_Public.md index 6ef011b9af..0d3e0b0ce2 100644 --- a/docs/interfaces/types.JWK_RSA_Public.md +++ b/docs/interfaces/types.JWK_RSA_Public.md @@ -57,6 +57,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWK_oct.md b/docs/interfaces/types.JWK_oct.md index 8043aea62e..40e6d14e7f 100644 --- a/docs/interfaces/types.JWK_oct.md +++ b/docs/interfaces/types.JWK_oct.md @@ -48,6 +48,10 @@ ___ JWK "alg" (Algorithm) Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210) + ___ ### ext diff --git a/docs/interfaces/types.JWSHeaderParameters.md b/docs/interfaces/types.JWSHeaderParameters.md index 46bdb15028..c04a371314 100644 --- a/docs/interfaces/types.JWSHeaderParameters.md +++ b/docs/interfaces/types.JWSHeaderParameters.md @@ -32,6 +32,10 @@ Recognized JWS Header Parameters, any other Header Members may also be present. JWS "alg" (Algorithm) Header Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). + ___ ### b64 diff --git a/docs/interfaces/types.JWTHeaderParameters.md b/docs/interfaces/types.JWTHeaderParameters.md index cb97dc18d8..ffbb0243e0 100644 --- a/docs/interfaces/types.JWTHeaderParameters.md +++ b/docs/interfaces/types.JWTHeaderParameters.md @@ -32,6 +32,10 @@ Recognized Signed JWT Header Parameters, any other Header Members may also be pr JWS "alg" (Algorithm) Header Parameter +**`See`** + +[Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). + ___ ### b64 diff --git a/src/types.d.ts b/src/types.d.ts index beddcdb768..49143ab8a5 100644 --- a/src/types.d.ts +++ b/src/types.d.ts @@ -103,7 +103,11 @@ export type KeyLike = { type: string } export interface JWKParameters { /** JWK "kty" (Key Type) Parameter */ kty: string - /** JWK "alg" (Algorithm) Parameter */ + /** + * JWK "alg" (Algorithm) Parameter + * + * @see {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements} + */ alg?: string /** JWK "key_ops" (Key Operations) Parameter */ key_ops?: string[] @@ -374,7 +378,11 @@ export interface JoseHeaderParameters { /** 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 + * + * @see {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}. + */ alg?: string /** @@ -476,10 +484,18 @@ export interface GeneralJWE extends Omit