Skip to content

Commit 076ee58

Browse files
committed
docs: update spec links
1 parent c6c01f1 commit 076ee58

File tree

5 files changed

+41
-42
lines changed

5 files changed

+41
-42
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,17 +131,17 @@ actions and i.e. emit metrics that react to specific triggers. See the list of a
131131
[npm-url]: https://www.npmjs.com/package/oidc-provider
132132
[openid-certified-link]: https://openid.net/certification/
133133
[openid-connect]: https://openid.net/connect/
134-
[core]: https://openid.net/specs/openid-connect-core-1_0.html
135-
[discovery]: https://openid.net/specs/openid-connect-discovery-1_0.html
134+
[core]: https://openid.net/specs/openid-connect-core-1_0-errata2.html
135+
[discovery]: https://openid.net/specs/openid-connect-discovery-1_0-errata2.html
136136
[oauth2-registration]: https://www.rfc-editor.org/rfc/rfc7591.html
137-
[registration]: https://openid.net/specs/openid-connect-registration-1_0.html
137+
[registration]: https://openid.net/specs/openid-connect-registration-1_0-errata2.html
138138
[oauth2]: https://www.rfc-editor.org/rfc/rfc6749.html
139139
[oauth2-bearer]: https://www.rfc-editor.org/rfc/rfc6750.html
140140
[revocation]: https://www.rfc-editor.org/rfc/rfc7009.html
141141
[introspection]: https://www.rfc-editor.org/rfc/rfc7662.html
142142
[pkce]: https://www.rfc-editor.org/rfc/rfc7636.html
143143
[example-repo]: https://github.com/panva/node-oidc-provider-example
144-
[backchannel-logout]: https://openid.net/specs/openid-connect-backchannel-1_0-final.html
144+
[backchannel-logout]: https://openid.net/specs/openid-connect-backchannel-1_0-errata1.html
145145
[registration-management]: https://www.rfc-editor.org/rfc/rfc7592.html
146146
[oauth-native-apps]: https://www.rfc-editor.org/rfc/rfc8252.html
147147
[jar]: https://www.rfc-editor.org/rfc/rfc9101.html
@@ -151,13 +151,13 @@ actions and i.e. emit metrics that react to specific triggers. See the list of a
151151
[mtls]: https://www.rfc-editor.org/rfc/rfc8705.html
152152
[dpop]: https://www.rfc-editor.org/rfc/rfc9449.html
153153
[resource-indicators]: https://www.rfc-editor.org/rfc/rfc8707.html
154-
[jarm]: https://openid.net/specs/oauth-v2-jarm.html
154+
[jarm]: https://openid.net/specs/oauth-v2-jarm-final.html
155155
[jwt-at]: https://www.rfc-editor.org/rfc/rfc9068.html
156156
[support-sponsor]: https://github.com/sponsors/panva
157157
[par]: https://www.rfc-editor.org/rfc/rfc9126.html
158158
[rpinitiated-logout]: https://openid.net/specs/openid-connect-rpinitiated-1_0-final.html
159159
[iss-auth-resp]: https://www.rfc-editor.org/rfc/rfc9207.html
160-
[fapi]: https://openid.net/specs/openid-financial-api-part-2-1_0.html
160+
[fapi]: https://openid.net/specs/openid-financial-api-part-2-1_0-final.html
161161
[ciba]: https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0-final.html
162162
[fapi-ciba]: https://openid.net/specs/openid-financial-api-ciba-ID1.html
163163
[fapi2sp-id2]: https://openid.net/specs/fapi-2_0-security-profile-ID2.html

docs/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ koaApp.use(mount('/oidc', oidc.app))
392392
Note: when the issuer identifier does not include the path prefix you should take care of rewriting
393393
your `${root}/.well-known/openid-configuration` to `${root}${prefix}/.well-known/openid-configuration`
394394
so that your deployment remains conform to the
395-
[Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationRequest)
395+
[Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0-errata2.html#ProviderConfigurationRequest)
396396
specification.
397397

398398
## Trusting TLS offloading proxies
@@ -849,7 +849,7 @@ async function verifyUserCode(ctx, account, userCode) {
849849

850850
### features.claimsParameter
851851

852-
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter) - Requesting Claims using the "claims" Request Parameter
852+
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0-errata2.html#ClaimsParameter) - Requesting Claims using the "claims" Request Parameter
853853

854854
Enables the use and validations of `claims` parameter as described in the specification.
855855

@@ -1175,7 +1175,7 @@ _**default value**_:
11751175

11761176
The specific profile of `FAPI` to enable. Supported values are:
11771177
- '2.0' (Experimental) Enables behaviours from [FAPI 2.0 Security Profile - Implementer's Draft 02](https://openid.net/specs/fapi-2_0-security-profile-ID2.html)
1178-
- '1.0 Final' Enables behaviours from [Financial-grade API Security Profile 1.0 - Part 2: Advanced](https://openid.net/specs/openid-financial-api-part-2-1_0.html)
1178+
- '1.0 Final' Enables behaviours from [Financial-grade API Security Profile 1.0 - Part 2: Advanced](https://openid.net/specs/openid-financial-api-part-2-1_0-final.html)
11791179
- '1.0 ID2' Enables behaviours from [Financial-grade API - Part 2: Read and Write API Security Profile - Implementer's Draft 02](https://openid.net/specs/openid-financial-api-part-2-ID2.html)
11801180
- Function returning one of the other supported values, or undefined if `FAPI` behaviours are to be ignored. The function is invoked with two arguments `(ctx, client)` and serves the purpose of allowing the used profile to be context-specific.
11811181

@@ -1243,7 +1243,7 @@ _**default value**_:
12431243

12441244
### features.jwtResponseModes
12451245

1246-
[JWT Secured Authorization Response Mode (`JARM`)](https://openid.net/specs/oauth-v2-jarm.html)
1246+
[JWT Secured Authorization Response Mode (`JARM`)](https://openid.net/specs/oauth-v2-jarm-final.html)
12471247

12481248
Enables JWT Secured Authorization Responses
12491249

@@ -1257,7 +1257,7 @@ _**default value**_:
12571257

12581258
### features.jwtUserinfo
12591259

1260-
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo) - JWT UserInfo Endpoint Responses
1260+
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0-errata2.html#UserInfo) - JWT UserInfo Endpoint Responses
12611261

12621262
Enables the userinfo to optionally return signed and/or encrypted JWTs, also enables the relevant client metadata for setting up signing and/or encryption.
12631263

@@ -1404,7 +1404,7 @@ false
14041404

14051405
### features.registration
14061406

1407-
[`Dynamic Client Registration 1.0`](https://openid.net/specs/openid-connect-registration-1_0.html) and [`RFC7591` - OAuth 2.0 Dynamic Client Registration Protocol](https://www.rfc-editor.org/rfc/rfc7591.html)
1407+
[`Dynamic Client Registration 1.0`](https://openid.net/specs/openid-connect-registration-1_0-errata2.html) and [`RFC7591` - OAuth 2.0 Dynamic Client Registration Protocol](https://www.rfc-editor.org/rfc/rfc7591.html)
14081408

14091409
Enables Dynamic Client Registration.
14101410

@@ -1604,7 +1604,7 @@ true
16041604

16051605
### features.requestObjects
16061606

1607-
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0.html#RequestObject) and [JWT Secured Authorization Request (`JAR`)](https://www.rfc-editor.org/rfc/rfc9101.html) - Request Object
1607+
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0-errata2.html#RequestObject) and [JWT Secured Authorization Request (`JAR`)](https://www.rfc-editor.org/rfc/rfc9101.html) - Request Object
16081608

16091609
Enables the use and validations of the `request` and/or `request_uri` parameters.
16101610

@@ -2137,7 +2137,7 @@ async function postLogoutSuccessSource(ctx) {
21372137

21382138
### features.userinfo
21392139

2140-
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo) - UserInfo Endpoint
2140+
[`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0-errata2.html#UserInfo) - UserInfo Endpoint
21412141

21422142
Enables the userinfo endpoint. Its use requires an opaque Access Token with at least `openid` scope that's without a Resource Server audience.
21432143

@@ -2333,7 +2333,7 @@ _**default value**_:
23332333

23342334
ID Token only contains End-User claims when the requested `response_type` is `id_token`
23352335

2336-
[`OIDC Core 1.0` - Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) defines that claims requested using the `scope` parameter are only returned from the UserInfo Endpoint unless the `response_type` is `id_token`.
2336+
[`OIDC Core 1.0` - Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0-errata2.html#ScopeClaims) defines that claims requested using the `scope` parameter are only returned from the UserInfo Endpoint unless the `response_type` is `id_token`.
23372337
Despite of this configuration the ID Token always includes claims requested using the `scope` parameter when the userinfo endpoint is disabled, or when issuing an Access Token not applicable for access to the userinfo endpoint.
23382338

23392339

@@ -2992,7 +2992,7 @@ async function loadExistingGrant(ctx) {
29922992
29932993
### pairwiseIdentifier
29942994
2995-
Function used by the authorization server when resolving pairwise ID Token and Userinfo sub claim values. See [`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg)
2995+
Function used by the authorization server when resolving pairwise ID Token and Userinfo sub claim values. See [`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0-errata2.html#PairwiseAlg)
29962996
29972997
_**recommendation**_: Since this might be called several times in one request with the same arguments consider using memoization or otherwise caching the result based on account and client ids.
29982998
@@ -3046,15 +3046,15 @@ function pkceRequired(ctx, client) {
30463046
case fapiProfile === '2.0':
30473047
return true;
30483048
// FAPI 1.0 Advanced as per
3049-
// https://openid.net/specs/openid-financial-api-part-2-1_0.html#authorization-server
3049+
// https://openid.net/specs/openid-financial-api-part-2-1_0-final.html#authorization-server
30503050
case fapiProfile === '1.0 Final' && ctx.oidc.route === 'pushed_authorization_request':
30513051
return true;
30523052
// All Public clients as per
3053-
// https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics-22#section-2.1.1-2.1.1
3053+
// https://www.rfc-editor.org/rfc/rfc9700.html#section-2.1.1-2.1
30543054
case client.clientAuthMethod === 'none':
30553055
return true;
30563056
// All other cases RECOMMENDED as per
3057-
// https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics-22#section-2.1.1-2.2.1
3057+
// https://www.rfc-editor.org/rfc/rfc9700.html#section-2.1.1-2.2
30583058
default:
30593059
return true;
30603060
}
@@ -3088,7 +3088,7 @@ async function renderError(ctx, out, error) {
30883088
30893089
### responseTypes
30903090
3091-
Array of response_type values that the authorization server supports. The default omits all response types that result in access tokens being issued by the authorization endpoint directly as per [OAuth 2.0 Security Best Current Practice](https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.1.2) You can still enable them if you need to.
3091+
Array of response_type values that the authorization server supports. The default omits all response types that result in access tokens being issued by the authorization endpoint directly as per [`RFC9700 - Best Current Practice for OAuth 2.0 Security`](https://www.rfc-editor.org/rfc/rfc9700.html#section-2.1.2) You can still enable them if you need to.
30923092
30933093
30943094
@@ -3104,7 +3104,7 @@ _**default value**_:
31043104
<a id="response-types-supported-values-list"></a><details><summary>(Click to expand) Supported values list</summary><br>
31053105
31063106
3107-
These are values defined in [`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0.html#Authentication) and [OAuth 2.0 Multiple Response Type Encoding Practices](https://openid.net/specs/oauth-v2-multiple-response-types-1_0.html)
3107+
These are values defined in [`OIDC Core 1.0`](https://openid.net/specs/openid-connect-core-1_0-errata2.html#Authentication) and [OAuth 2.0 Multiple Response Type Encoding Practices](https://openid.net/specs/oauth-v2-multiple-response-types-1_0-final.html)
31083108
31093109
31103110
```js
@@ -3237,7 +3237,7 @@ description: Expirations for various token and session types. The value can be a
32373237
32383238
_**recommendation**_: Do not set token TTLs longer then they absolutely have to be, the shorter the TTL, the better.
32393239
3240-
_**recommendation**_: Rather than setting crazy high Refresh Token TTL look into `rotateRefreshToken` configuration option which is set up in way that when refresh tokens are regularly used they will have their TTL refreshed (via rotation). This is inline with the [OAuth 2.0 Security Best Current Practice](https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13)
3240+
_**recommendation**_: Rather than setting crazy high Refresh Token TTL look into `rotateRefreshToken` configuration option which is set up in way that when refresh tokens are regularly used they will have their TTL refreshed (via rotation).
32413241
32423242
32433243
_**default value**_:
@@ -3806,7 +3806,7 @@ _**default value**_:
38063806
38073807
Only response types that do not end up with an access_token (so, response_type=id_token) have
38083808
end-user claims other than `sub` in their ID Tokens. This is the
3809-
[Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) spec behaviour. Read
3809+
[Core 1.0](https://openid.net/specs/openid-connect-core-1_0-errata2.html#ScopeClaims) spec behaviour. Read
38103810
it you'll see requesting claims through the scope parameter only adds these claims to userinfo
38113811
unless the response_type is `id_token` in which case they're added there. All other response types
38123812
have access to the userinfo endpoint which returns these scope-requested claims. The other option is

0 commit comments

Comments
 (0)