mirror of
https://github.com/hanzoai/jose.git
synced 2026-09-24 17:00:01 +00:00
chore: update references to the new RFC editor
This commit is contained in:
Filip Skokan
@@ -124,19 +124,19 @@ Please note that certain algorithms may not be available depending on the runtim
|
||||
<details>
|
||||
<summary>Details</summary>
|
||||
|
||||
- JSON Web Signature (JWS) - [RFC7515](https://www.rfc-editor.org/rfc/rfc7515)
|
||||
- JSON Web Encryption (JWE) - [RFC7516](https://www.rfc-editor.org/rfc/rfc7516)
|
||||
- JSON Web Key (JWK) - [RFC7517](https://www.rfc-editor.org/rfc/rfc7517)
|
||||
- JSON Web Algorithms (JWA) - [RFC7518](https://www.rfc-editor.org/rfc/rfc7518)
|
||||
- JSON Web Token (JWT) - [RFC7519](https://www.rfc-editor.org/rfc/rfc7519)
|
||||
- JSON Web Key Thumbprint - [RFC7638](https://www.rfc-editor.org/rfc/rfc7638)
|
||||
- JSON Web Key Thumbprint URI - [RFC9278](https://www.rfc-editor.org/rfc/rfc9278)
|
||||
- JWS Unencoded Payload Option - [RFC7797](https://www.rfc-editor.org/rfc/rfc7797)
|
||||
- CFRG Elliptic Curve ECDH and Signatures - [RFC8037](https://www.rfc-editor.org/rfc/rfc8037)
|
||||
- Fully-Specified Algorithms for JOSE - [RFC9864](https://www.rfc-editor.org/rfc/rfc9864.html)
|
||||
- ML-DSA for JOSE - [RFC9964](https://www.rfc-editor.org/rfc/rfc9964.html)
|
||||
- JSON Web Signature (JWS) - [RFC7515](https://www.rfc-editor.org/info/rfc7515/)
|
||||
- JSON Web Encryption (JWE) - [RFC7516](https://www.rfc-editor.org/info/rfc7516/)
|
||||
- JSON Web Key (JWK) - [RFC7517](https://www.rfc-editor.org/info/rfc7517/)
|
||||
- JSON Web Algorithms (JWA) - [RFC7518](https://www.rfc-editor.org/info/rfc7518/)
|
||||
- JSON Web Token (JWT) - [RFC7519](https://www.rfc-editor.org/info/rfc7519/)
|
||||
- JSON Web Key Thumbprint - [RFC7638](https://www.rfc-editor.org/info/rfc7638/)
|
||||
- JSON Web Key Thumbprint URI - [RFC9278](https://www.rfc-editor.org/info/rfc9278/)
|
||||
- JWS Unencoded Payload Option - [RFC7797](https://www.rfc-editor.org/info/rfc7797/)
|
||||
- CFRG Elliptic Curve ECDH and Signatures - [RFC8037](https://www.rfc-editor.org/info/rfc8037/)
|
||||
- Fully-Specified Algorithms for JOSE - [RFC9864](https://www.rfc-editor.org/info/rfc9864/)
|
||||
- ML-DSA for JOSE - [RFC9964](https://www.rfc-editor.org/info/rfc9964/)
|
||||
|
||||
The algorithm implementations in `jose` have been tested using test vectors from their respective specifications as well as [RFC7520](https://www.rfc-editor.org/rfc/rfc7520).
|
||||
The algorithm implementations in `jose` have been tested using test vectors from their respective specifications as well as [RFC7520](https://www.rfc-editor.org/info/rfc7520/).
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
+2
-2
@@ -22,7 +22,7 @@ If the maintainers reject a report through the project's documented channel, tha
|
||||
|
||||
## Threat Model
|
||||
|
||||
This section documents the threat model for `jose`, a JavaScript implementation of JSON Object Signing and Encryption standards including [JSON Web Token (JWT) - RFC 7519](https://www.rfc-editor.org/rfc/rfc7519), [JSON Web Signature (JWS) - RFC 7515](https://www.rfc-editor.org/rfc/rfc7515), [JSON Web Encryption (JWE) - RFC 7516](https://www.rfc-editor.org/rfc/rfc7516), [JSON Web Key (JWK) - RFC 7517](https://www.rfc-editor.org/rfc/rfc7517), and [JSON Web Algorithms (JWA) - RFC 7518](https://www.rfc-editor.org/rfc/rfc7518).
|
||||
This section documents the threat model for `jose`, a JavaScript implementation of JSON Object Signing and Encryption standards including [JSON Web Token (JWT) - RFC 7519](https://www.rfc-editor.org/info/rfc7519/), [JSON Web Signature (JWS) - RFC 7515](https://www.rfc-editor.org/info/rfc7515/), [JSON Web Encryption (JWE) - RFC 7516](https://www.rfc-editor.org/info/rfc7516/), [JSON Web Key (JWK) - RFC 7517](https://www.rfc-editor.org/info/rfc7517/), and [JSON Web Algorithms (JWA) - RFC 7518](https://www.rfc-editor.org/info/rfc7518/).
|
||||
|
||||
### Purpose and Intended Users
|
||||
|
||||
@@ -100,7 +100,7 @@ This library does not guarantee that key material or other sensitive data is cle
|
||||
|
||||
### Threat Actors and Security Properties
|
||||
|
||||
This library aims to provide the security properties defined by the JOSE specifications. For detailed security considerations, refer to the Security Considerations sections in [RFC 7515 (JWS)](https://www.rfc-editor.org/rfc/rfc7515#section-10), [RFC 7516 (JWE)](https://www.rfc-editor.org/rfc/rfc7516#section-11), [RFC 7517 (JWK)](https://www.rfc-editor.org/rfc/rfc7517#section-9), [RFC 7518 (JWA)](https://www.rfc-editor.org/rfc/rfc7518#section-8), and [RFC 7519 (JWT)](https://www.rfc-editor.org/rfc/rfc7519#section-8).
|
||||
This library aims to provide the security properties defined by the JOSE specifications. For detailed security considerations, refer to the Security Considerations sections in [RFC 7515 (JWS)](https://www.rfc-editor.org/info/rfc7515/#section-10), [RFC 7516 (JWE)](https://www.rfc-editor.org/info/rfc7516/#section-11), [RFC 7517 (JWK)](https://www.rfc-editor.org/info/rfc7517/#section-9), [RFC 7518 (JWA)](https://www.rfc-editor.org/info/rfc7518/#section-8), and [RFC 7519 (JWT)](https://www.rfc-editor.org/info/rfc7519/#section-8).
|
||||
|
||||
The primary in-scope threat actor is able to provide arbitrary JOSE objects, JWTs, JWSs, JWEs, JWKs, JWKS responses, key identifiers, and JOSE Header Parameters to application code using this library. This threat model assumes application-controlled keys, validation options, trusted URLs, runtime behavior, network configuration, and cache storage have not been compromised.
|
||||
|
||||
|
||||
+11
-11
@@ -1,7 +1,7 @@
|
||||
export default [
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.2 - Key Encryption using RSA-OAEP with AES-GCM',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.2 - Key Encryption using RSA-OAEP with AES-GCM',
|
||||
input: {
|
||||
plaintext:
|
||||
'You can trust us to stick with you through thick and thin–to the bitter end. And you can trust us to keep any secret of yours–closer than you keep it yourself. But you cannot trust us to let you face trouble alone, and go off without a word. We are your friends, Frodo.',
|
||||
@@ -66,7 +66,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.3 - Key Wrap using PBES2-AES-KeyWrap with AES-CBC-HMAC-SHA2',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.3 - Key Wrap using PBES2-AES-KeyWrap with AES-CBC-HMAC-SHA2',
|
||||
deterministic: true,
|
||||
input: {
|
||||
plaintext:
|
||||
@@ -121,7 +121,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.4 - Key Agreement with Key Wrapping using ECDH-ES and AES-KeyWrap with AES-GCM',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.4 - Key Agreement with Key Wrapping using ECDH-ES and AES-KeyWrap with AES-GCM',
|
||||
input: {
|
||||
plaintext:
|
||||
'You can trust us to stick with you through thick and thin–to the bitter end. And you can trust us to keep any secret of yours–closer than you keep it yourself. But you cannot trust us to let you face trouble alone, and go off without a word. We are your friends, Frodo.',
|
||||
@@ -193,7 +193,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.5 - Key Agreement using ECDH-ES with AES-CBC-HMAC-SHA2',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.5 - Key Agreement using ECDH-ES with AES-CBC-HMAC-SHA2',
|
||||
input: {
|
||||
plaintext:
|
||||
'You can trust us to stick with you through thick and thin–to the bitter end. And you can trust us to keep any secret of yours–closer than you keep it yourself. But you cannot trust us to let you face trouble alone, and go off without a word. We are your friends, Frodo.',
|
||||
@@ -259,7 +259,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.6 - Direction Encryption using AES-GCM',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.6 - Direction Encryption using AES-GCM',
|
||||
deterministic: true,
|
||||
input: {
|
||||
plaintext:
|
||||
@@ -308,7 +308,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.6 - Key Wrap using AES-GCM KeyWrap with AES-CBC-HMAC-SHA2',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.6 - Key Wrap using AES-GCM KeyWrap with AES-CBC-HMAC-SHA2',
|
||||
deterministic: true,
|
||||
input: {
|
||||
plaintext:
|
||||
@@ -370,7 +370,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.8 - Key Wrap using AES-KeyWrap with AES-GCM',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.8 - Key Wrap using AES-KeyWrap with AES-GCM',
|
||||
deterministic: true,
|
||||
input: {
|
||||
plaintext:
|
||||
@@ -426,7 +426,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-5.9 - Compressed Content',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7520/#section-5.9 - Compressed Content',
|
||||
deterministic: false, // https://www.rfc-editor.org/errata/eid7680
|
||||
input: {
|
||||
plaintext:
|
||||
@@ -487,7 +487,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.10 - Including Additional Authenticated Data',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.10 - Including Additional Authenticated Data',
|
||||
deterministic: true,
|
||||
input: {
|
||||
plaintext:
|
||||
@@ -547,7 +547,7 @@ export default [
|
||||
},
|
||||
{
|
||||
title:
|
||||
'https://www.rfc-editor.org/rfc/rfc7520#section-5.11 - Protecting Specific Header Fields',
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-5.11 - Protecting Specific Header Fields',
|
||||
deterministic: true,
|
||||
input: {
|
||||
plaintext:
|
||||
@@ -609,7 +609,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-5.12 - Protecting Content Only',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7520/#section-5.12 - Protecting Content Only',
|
||||
deterministic: true,
|
||||
input: {
|
||||
plaintext:
|
||||
|
||||
+9
-8
@@ -1,6 +1,6 @@
|
||||
export default [
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-4.1 - RSA v1.5 Signature',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7520/#section-4.1 - RSA v1.5 Signature',
|
||||
deterministic: true,
|
||||
input: {
|
||||
payload:
|
||||
@@ -51,7 +51,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc8037#appendix-A.4 - Ed25519 Signing',
|
||||
title: 'https://www.rfc-editor.org/info/rfc8037/#appendix-A.4 - Ed25519 Signing',
|
||||
deterministic: false, // https://github.com/WICG/webcrypto-secure-curves/issues/28
|
||||
input: {
|
||||
payload: 'Example of Ed25519 signing',
|
||||
@@ -91,7 +91,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-4.2 - RSA-PSS Signature',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7520/#section-4.2 - RSA-PSS Signature',
|
||||
input: {
|
||||
payload:
|
||||
"It’s a dangerous business, Frodo, going out your door. You step onto the road, and if you don't keep your feet, there’s no knowing where you might be swept off to.",
|
||||
@@ -141,7 +141,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-4.3 - ECDSA Signature',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7520/#section-4.3 - ECDSA Signature',
|
||||
input: {
|
||||
payload:
|
||||
"It’s a dangerous business, Frodo, going out your door. You step onto the road, and if you don't keep your feet, there’s no knowing where you might be swept off to.",
|
||||
@@ -187,7 +187,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-4.4 - HMAC-SHA2 Integrity Protection',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7520/#section-4.4 - HMAC-SHA2 Integrity Protection',
|
||||
deterministic: true,
|
||||
input: {
|
||||
payload:
|
||||
@@ -232,7 +232,8 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-4.6 - Protecting Specific Header Fields',
|
||||
title:
|
||||
'https://www.rfc-editor.org/info/rfc7520/#section-4.6 - Protecting Specific Header Fields',
|
||||
deterministic: true,
|
||||
input: {
|
||||
payload:
|
||||
@@ -281,7 +282,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7520#section-4.7 - Protecting Content Only',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7520/#section-4.7 - Protecting Content Only',
|
||||
deterministic: true,
|
||||
input: {
|
||||
payload:
|
||||
@@ -328,7 +329,7 @@ export default [
|
||||
},
|
||||
},
|
||||
{
|
||||
title: 'https://www.rfc-editor.org/rfc/rfc7797#section-4.1 - { "b64": false } JSON only',
|
||||
title: 'https://www.rfc-editor.org/info/rfc7797/#section-4.1 - { "b64": false } JSON only',
|
||||
deterministic: true,
|
||||
input: {
|
||||
payload: '$.02',
|
||||
|
||||
@@ -38,4 +38,4 @@ console.log(thumbprint)
|
||||
|
||||
## See
|
||||
|
||||
[RFC7638](https://www.rfc-editor.org/rfc/rfc7638)
|
||||
[RFC7638](https://www.rfc-editor.org/info/rfc7638/)
|
||||
|
||||
@@ -38,4 +38,4 @@ console.log(thumbprintUri)
|
||||
|
||||
## See
|
||||
|
||||
[RFC9278](https://www.rfc-editor.org/rfc/rfc9278)
|
||||
[RFC9278](https://www.rfc-editor.org/info/rfc9278/)
|
||||
|
||||
@@ -75,7 +75,7 @@ Replicates the "aud" (Audience) Claim as a JWE Protected Header Parameter.
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
|
||||
[RFC7519#section-5.3](https://www.rfc-editor.org/info/rfc7519/#section-5.3)
|
||||
|
||||
***
|
||||
|
||||
@@ -91,7 +91,7 @@ Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter.
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
|
||||
[RFC7519#section-5.3](https://www.rfc-editor.org/info/rfc7519/#section-5.3)
|
||||
|
||||
***
|
||||
|
||||
@@ -107,7 +107,7 @@ Replicates the "sub" (Subject) Claim as a JWE Protected Header Parameter.
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
|
||||
[RFC7519#section-5.3](https://www.rfc-editor.org/info/rfc7519/#section-5.3)
|
||||
|
||||
***
|
||||
|
||||
|
||||
@@ -121,4 +121,4 @@ The only supported value is `"DEF"` (DEFLATE). Requires the `CompressionStream`
|
||||
|
||||
#### See
|
||||
|
||||
[JWE "zip" Header Parameter](https://www.rfc-editor.org/rfc/rfc7516#section-4.1.3)
|
||||
[JWE "zip" Header Parameter](https://www.rfc-editor.org/info/rfc7516/#section-4.1.3)
|
||||
|
||||
@@ -31,7 +31,7 @@ JWS "alg" (Algorithm) Header Parameter
|
||||
• `optional` **b64?**: `boolean`
|
||||
|
||||
This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing
|
||||
Input computation as per [RFC7797](https://www.rfc-editor.org/rfc/rfc7797).
|
||||
Input computation as per [RFC7797](https://www.rfc-editor.org/info/rfc7797/).
|
||||
|
||||
***
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
|
||||
|
||||
Flattened JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS
|
||||
Unencoded Payload ([RFC7797](https://www.rfc-editor.org/rfc/rfc7797)) is used.
|
||||
Unencoded Payload ([RFC7797](https://www.rfc-editor.org/info/rfc7797/)) is used.
|
||||
|
||||
## Properties
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
|
||||
|
||||
General JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS
|
||||
Unencoded Payload ([RFC7797](https://www.rfc-editor.org/rfc/rfc7797)) is used.
|
||||
Unencoded Payload ([RFC7797](https://www.rfc-editor.org/info/rfc7797/)) is used.
|
||||
|
||||
## Properties
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ detached signature validation.
|
||||
• **payload**: `string` \| [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
|
||||
|
||||
The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When when
|
||||
JWS Unencoded Payload ([RFC7797](https://www.rfc-editor.org/rfc/rfc7797)) "b64": false is
|
||||
JWS Unencoded Payload ([RFC7797](https://www.rfc-editor.org/info/rfc7797/)) "b64": false is
|
||||
used the value passed may also be a [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array).
|
||||
|
||||
***
|
||||
|
||||
@@ -121,4 +121,4 @@ The only supported value is `"DEF"` (DEFLATE). Requires the `CompressionStream`
|
||||
|
||||
#### See
|
||||
|
||||
[JWE "zip" Header Parameter](https://www.rfc-editor.org/rfc/rfc7516#section-4.1.3)
|
||||
[JWE "zip" Header Parameter](https://www.rfc-editor.org/info/rfc7516/#section-4.1.3)
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
|
||||
Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
|
||||
|
||||
JSON Web Key ([JWK](https://www.rfc-editor.org/rfc/rfc7517)). "RSA", "EC", "OKP", "AKP", and
|
||||
"oct" key types are supported.
|
||||
JSON Web Key ([JWK](https://www.rfc-editor.org/info/rfc7517/)). "RSA", "EC", "OKP", "AKP",
|
||||
and "oct" key types are supported.
|
||||
|
||||
## See
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ JWS "alg" (Algorithm) Header Parameter
|
||||
• `optional` **b64?**: `boolean`
|
||||
|
||||
This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing
|
||||
Input computation as per [RFC7797](https://www.rfc-editor.org/rfc/rfc7797).
|
||||
Input computation as per [RFC7797](https://www.rfc-editor.org/info/rfc7797/).
|
||||
|
||||
***
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ JWS "alg" (Algorithm) Header Parameter
|
||||
• `optional` **b64?**: `true`
|
||||
|
||||
This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing
|
||||
Input computation as per [RFC7797](https://www.rfc-editor.org/rfc/rfc7797).
|
||||
Input computation as per [RFC7797](https://www.rfc-editor.org/info/rfc7797/).
|
||||
|
||||
***
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ JWT Audience
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
|
||||
[RFC7519#section-4.1.3](https://www.rfc-editor.org/info/rfc7519/#section-4.1.3)
|
||||
|
||||
***
|
||||
|
||||
@@ -34,7 +34,7 @@ JWT Expiration Time
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
|
||||
[RFC7519#section-4.1.4](https://www.rfc-editor.org/info/rfc7519/#section-4.1.4)
|
||||
|
||||
***
|
||||
|
||||
@@ -46,7 +46,7 @@ JWT Issued At
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
|
||||
[RFC7519#section-4.1.6](https://www.rfc-editor.org/info/rfc7519/#section-4.1.6)
|
||||
|
||||
***
|
||||
|
||||
@@ -58,7 +58,7 @@ JWT Issuer
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
|
||||
[RFC7519#section-4.1.1](https://www.rfc-editor.org/info/rfc7519/#section-4.1.1)
|
||||
|
||||
***
|
||||
|
||||
@@ -70,7 +70,7 @@ JWT ID
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-4.1.7](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7)
|
||||
[RFC7519#section-4.1.7](https://www.rfc-editor.org/info/rfc7519/#section-4.1.7)
|
||||
|
||||
***
|
||||
|
||||
@@ -82,7 +82,7 @@ JWT Not Before
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
|
||||
[RFC7519#section-4.1.5](https://www.rfc-editor.org/info/rfc7519/#section-4.1.5)
|
||||
|
||||
***
|
||||
|
||||
@@ -94,4 +94,4 @@ JWT Subject
|
||||
|
||||
#### See
|
||||
|
||||
[RFC7519#section-4.1.2](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.2)
|
||||
[RFC7519#section-4.1.2](https://www.rfc-editor.org/info/rfc7519/#section-4.1.2)
|
||||
|
||||
@@ -205,7 +205,7 @@ export async function flattenedDecrypt(
|
||||
if (err instanceof TypeError || err instanceof JWEInvalid || err instanceof JOSENotSupported) {
|
||||
throw err
|
||||
}
|
||||
// https://www.rfc-editor.org/rfc/rfc7516#section-11.5
|
||||
// https://www.rfc-editor.org/info/rfc7516/#section-11.5
|
||||
// To mitigate the attacks described in RFC 3218, the
|
||||
// recipient MUST NOT distinguish between format, padding, and length
|
||||
// errors of encrypted keys. It is strongly recommended, in the event
|
||||
|
||||
@@ -45,7 +45,7 @@ const check = (value: unknown, description: string) => {
|
||||
* @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is
|
||||
* "sha256".
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7638 RFC7638}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7638/ RFC7638}
|
||||
*/
|
||||
export async function calculateJwkThumbprint(
|
||||
key: types.JWK | types.CryptoKey | types.KeyObject,
|
||||
@@ -129,7 +129,7 @@ export async function calculateJwkThumbprint(
|
||||
* @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is
|
||||
* "sha256".
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc9278 RFC9278}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc9278/ RFC9278}
|
||||
*/
|
||||
export async function calculateJwkThumbprintUri(
|
||||
key: types.CryptoKey | types.KeyObject | types.JWK,
|
||||
|
||||
+3
-3
@@ -150,7 +150,7 @@ export class EncryptJWT implements types.ProduceJWT {
|
||||
/**
|
||||
* Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter.
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-5.3 RFC7519#section-5.3}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-5.3 RFC7519#section-5.3}
|
||||
*/
|
||||
replicateIssuerAsHeader(): this {
|
||||
this.#replicateIssuerAsHeader = true
|
||||
@@ -160,7 +160,7 @@ export class EncryptJWT implements types.ProduceJWT {
|
||||
/**
|
||||
* Replicates the "sub" (Subject) Claim as a JWE Protected Header Parameter.
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-5.3 RFC7519#section-5.3}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-5.3 RFC7519#section-5.3}
|
||||
*/
|
||||
replicateSubjectAsHeader(): this {
|
||||
this.#replicateSubjectAsHeader = true
|
||||
@@ -170,7 +170,7 @@ export class EncryptJWT implements types.ProduceJWT {
|
||||
/**
|
||||
* Replicates the "aud" (Audience) Claim as a JWE Protected Header Parameter.
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-5.3 RFC7519#section-5.3}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-5.3 RFC7519#section-5.3}
|
||||
*/
|
||||
replicateAudienceAsHeader(): this {
|
||||
this.#replicateAudienceAsHeader = true
|
||||
|
||||
Vendored
+14
-14
@@ -101,8 +101,8 @@ export interface JWK_oct extends JWKParameters {
|
||||
}
|
||||
|
||||
/**
|
||||
* JSON Web Key ({@link https://www.rfc-editor.org/rfc/rfc7517 JWK}). "RSA", "EC", "OKP", "AKP", and
|
||||
* "oct" key types are supported.
|
||||
* JSON Web Key ({@link https://www.rfc-editor.org/info/rfc7517/ JWK}). "RSA", "EC", "OKP", "AKP",
|
||||
* and "oct" key types are supported.
|
||||
*
|
||||
* @see {@link JWK_AKP_Public}
|
||||
* @see {@link JWK_AKP_Private}
|
||||
@@ -222,7 +222,7 @@ export interface FlattenedJWSInput {
|
||||
export interface GeneralJWSInput {
|
||||
/**
|
||||
* The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When when
|
||||
* JWS Unencoded Payload ({@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}) "b64": false is
|
||||
* JWS Unencoded Payload ({@link https://www.rfc-editor.org/info/rfc7797/ RFC7797}) "b64": false is
|
||||
* used the value passed may also be a {@link !Uint8Array}.
|
||||
*/
|
||||
payload: string | Uint8Array
|
||||
@@ -236,7 +236,7 @@ export interface GeneralJWSInput {
|
||||
|
||||
/**
|
||||
* Flattened JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS
|
||||
* Unencoded Payload ({@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}) is used.
|
||||
* Unencoded Payload ({@link https://www.rfc-editor.org/info/rfc7797/ RFC7797}) is used.
|
||||
*/
|
||||
export interface FlattenedJWS extends Partial<FlattenedJWSInput> {
|
||||
payload: string
|
||||
@@ -245,7 +245,7 @@ export interface FlattenedJWS extends Partial<FlattenedJWSInput> {
|
||||
|
||||
/**
|
||||
* General JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS
|
||||
* Unencoded Payload ({@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}) is used.
|
||||
* Unencoded Payload ({@link https://www.rfc-editor.org/info/rfc7797/ RFC7797}) is used.
|
||||
*/
|
||||
export interface GeneralJWS {
|
||||
payload: string
|
||||
@@ -290,7 +290,7 @@ export interface JWSHeaderParameters extends JoseHeaderParameters {
|
||||
|
||||
/**
|
||||
* This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing
|
||||
* Input computation as per {@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}.
|
||||
* Input computation as per {@link https://www.rfc-editor.org/info/rfc7797/ RFC7797}.
|
||||
*/
|
||||
b64?: boolean
|
||||
|
||||
@@ -420,7 +420,7 @@ export interface JWEHeaderParameters extends JoseHeaderParameters {
|
||||
* The only supported value is `"DEF"` (DEFLATE). Requires the `CompressionStream` /
|
||||
* `DecompressionStream` APIs to be available in the runtime.
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7516#section-4.1.3 JWE "zip" Header Parameter}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7516/#section-4.1.3 JWE "zip" Header Parameter}
|
||||
*/
|
||||
zip?: string
|
||||
|
||||
@@ -575,49 +575,49 @@ export interface JWTPayload {
|
||||
/**
|
||||
* JWT Issuer
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1 RFC7519#section-4.1.1}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-4.1.1 RFC7519#section-4.1.1}
|
||||
*/
|
||||
iss?: string
|
||||
|
||||
/**
|
||||
* JWT Subject
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.2 RFC7519#section-4.1.2}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-4.1.2 RFC7519#section-4.1.2}
|
||||
*/
|
||||
sub?: string
|
||||
|
||||
/**
|
||||
* JWT Audience
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3 RFC7519#section-4.1.3}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-4.1.3 RFC7519#section-4.1.3}
|
||||
*/
|
||||
aud?: string | string[]
|
||||
|
||||
/**
|
||||
* JWT ID
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7 RFC7519#section-4.1.7}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-4.1.7 RFC7519#section-4.1.7}
|
||||
*/
|
||||
jti?: string
|
||||
|
||||
/**
|
||||
* JWT Not Before
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5 RFC7519#section-4.1.5}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-4.1.5 RFC7519#section-4.1.5}
|
||||
*/
|
||||
nbf?: number
|
||||
|
||||
/**
|
||||
* JWT Expiration Time
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4 RFC7519#section-4.1.4}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-4.1.4 RFC7519#section-4.1.4}
|
||||
*/
|
||||
exp?: number
|
||||
|
||||
/**
|
||||
* JWT Issued At
|
||||
*
|
||||
* @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6 RFC7519#section-4.1.6}
|
||||
* @see {@link https://www.rfc-editor.org/info/rfc7519/#section-4.1.6 RFC7519#section-4.1.6}
|
||||
*/
|
||||
iat?: number
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ const jwk = {
|
||||
alg: 'RS256',
|
||||
}
|
||||
|
||||
test('https://www.rfc-editor.org/rfc/rfc7638#section-3.1', async (t) => {
|
||||
test('https://www.rfc-editor.org/info/rfc7638/#section-3.1', async (t) => {
|
||||
t.is(await calculateJwkThumbprint(jwk), 'NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs')
|
||||
t.is(await calculateJwkThumbprint(jwk, 'sha256'), 'NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs')
|
||||
t.is(
|
||||
@@ -22,7 +22,7 @@ test('https://www.rfc-editor.org/rfc/rfc7638#section-3.1', async (t) => {
|
||||
)
|
||||
})
|
||||
|
||||
test('https://www.rfc-editor.org/rfc/rfc9278', async (t) => {
|
||||
test('https://www.rfc-editor.org/info/rfc9278/', async (t) => {
|
||||
t.is(
|
||||
await calculateJwkThumbprintUri(jwk),
|
||||
'urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs',
|
||||
|
||||
Reference in New Issue
Block a user