Skip to content

Commit 9cad205

Browse files
acoburnpchampin
andauthored
Link terminology to definitions (#164)
* Link terminology to definitions * Update lws10-authn-openid/index.html Co-authored-by: Pierre-Antoine Champin <pierre-antoine@w3.org> * Add local proxy definitions to authentication documents and simplified term references * Use LWS10-CORE as a localBiblio name, as suggested * link terminology from access requests section --------- Co-authored-by: Pierre-Antoine Champin <pierre-antoine@w3.org>
1 parent 5f03543 commit 9cad205

21 files changed

Lines changed: 170 additions & 170 deletions

lws10-authn-openid/index.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
xref: ["web-platform"],
2727
group: "lws",
2828
localBiblio: {
29-
"LWS-PROTOCOL": {
30-
title: "LWS Protocol",
31-
href: "https://www.w3.org/TR/lws-core/",
29+
"LWS10-CORE": {
30+
title: "Linked Web Storage Protocol 1.0",
31+
href: "https://www.w3.org/TR/lws10-core/",
3232
publisher: "W3C",
3333
status: "FPWD",
3434
},
@@ -84,7 +84,7 @@ <h2>Terminology</h2>
8484
</p>
8585

8686
<p>
87-
The terms "authentication credential" and "authentication suite" are defined by Linked Web Storage Protocol [[!LWS-PROTOCOL]]
87+
The terms "<dfn data-cite="LWS10-CORE#dfn-agent">agent</dfn>", "<dfn data-cite="LWS10-CORE#dfn-authentication-credential">authentication credential</dfn>", and "<dfn data-cite="LWS10-CORE#dfn-authentication-suite">authentication suite</dfn>" are defined by Linked Web Storage Protocol [[!LWS10-CORE]]
8888
</p>
8989
</section>
9090

@@ -93,7 +93,7 @@ <h2>Authentication Credential Serialization</h2>
9393

9494
<p>
9595
OpenID Connect defines a protocol for producing signed ID Tokens, which are used to describe an end-user.
96-
An ID Token is serialized as a signed JSON Web Token (JWT). In order to use an ID Token as an LWS authentication credential,
96+
An ID Token is serialized as a signed JSON Web Token (JWT). In order to use an ID Token as an LWS <a>authentication credential</a>,
9797
the following additional requirements apply.
9898
</p>
9999

@@ -122,7 +122,7 @@ <h2>Authentication Credential Serialization</h2>
122122
</ul>
123123

124124
<p>
125-
An example ID Token that is also an LWS authentication credential is included below.
125+
An example ID Token that is also an LWS <a>authentication credential</a> is included below.
126126
</p>
127127

128128
<pre id="example-id-token" class="example">
@@ -151,24 +151,24 @@ <h2>Authentication Credential Serialization</h2>
151151
<h2>Authentication Credential Validation</h2>
152152

153153
<p>
154-
For an ID Token to validate as an LWS authentication credential,
154+
For an ID Token to validate as an LWS <a>authentication credential</a>,
155155
there must be a trust relationship between the verifier and the issuing party.
156156
</p>
157157

158158
<p>
159-
In the absence of a pre-existing trust relationship, the validator MUST dereference the <code>sub</code> (subject) claim in the authentication credential.
159+
In the absence of a pre-existing trust relationship, the validator MUST dereference the <code>sub</code> (subject) claim in the <a>authentication credential</a>.
160160
The resulting resource MUST be formatted as a valid controlled identifier document [[!CID-1.0]] with an <code>id</code> value equal to the subject identifier.
161161
</p>
162162

163163
<p>
164164
The verifier MUST use the subject's controlled identifier document to locate a service object whose <code>serviceEndpoint</code> value
165-
is equal to the value of the <code>iss</code> claim from the authentication credential, and whose <code>type</code> value is equal to <code>https://www.w3.org/ns/lws#OpenIdProvider</code>.
166-
The verifier MUST perform OpenID Connect Discovery to locate the public portion of the JSON Web Key (JWK) used to sign the authentication credential.
165+
is equal to the value of the <code>iss</code> claim from the <a>authentication credential</a>, and whose <code>type</code> value is equal to <code>https://www.w3.org/ns/lws#OpenIdProvider</code>.
166+
The verifier MUST perform OpenID Connect Discovery to locate the public portion of the JSON Web Key (JWK) used to sign the <a>authentication credential</a>.
167167
The JWT MUST be validated as described by OpenID Connect Core Section 3.1.3.7 [[!OPENID-CONNECT-CORE]].
168168
</p>
169169

170170
<p>
171-
An example Controlled Identifier Document for an agent using OpenID Connect is included below.
171+
An example Controlled Identifier Document for an <a>agent</a> using OpenID Connect is included below.
172172
</p>
173173

174174
<pre id="example-cid" class="example">
@@ -189,7 +189,7 @@ <h2>Authentication Credential Validation</h2>
189189
<h2>Token Type Identifier</h2>
190190

191191
<p>
192-
An ID Token used as an authentication credential MUST use the <code>urn:ietf:params:oauth:token-type:id_token</code> URI when interacting with an authorization server.
192+
An ID Token used as an <a>authentication credential</a> MUST use the <code>urn:ietf:params:oauth:token-type:id_token</code> URI when interacting with an authorization server.
193193
</p>
194194

195195
</section>
@@ -202,9 +202,9 @@ <h2>Security Considerations</h2>
202202
</p>
203203

204204
<p>
205-
An OpenID provider should support a mechanism to restrict the audience of an authentication credential to a limited set of entities, including an authorization server.
205+
An OpenID provider should support a mechanism to restrict the audience of an <a>authentication credential</a> to a limited set of entities, including an authorization server.
206206
One mechanism for achieving this is to use Resource Indicators for OAuth 2.0 [[RFC8707]].
207-
A client in possession of an authentication credential with no audience restrictions should exchange this token for an equivalent audience-restricted token by using, for example, OAuth 2.0 Token Exchange [[RFC8693]].
207+
A client in possession of an <a>authentication credential</a> with no audience restrictions should exchange this token for an equivalent audience-restricted token by using, for example, OAuth 2.0 Token Exchange [[RFC8693]].
208208
</p>
209209

210210
<p>
@@ -216,7 +216,7 @@ <h2>Security Considerations</h2>
216216
</p>
217217

218218
<p>
219-
The issuer of an authentication credential is responsible for validating the client identifier.
219+
The issuer of an <a>authentication credential</a> is responsible for validating the client identifier.
220220
The issuer may use mechanisms such as an OAuth Client ID Metadata Document, an OAuth 2.0 Client ID Prefix, or OpenID Federation.
221221
</p>
222222

lws10-authn-saml/index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
xref: ["web-platform"],
2727
group: "lws",
2828
localBiblio: {
29-
"LWS-PROTOCOL": {
30-
title: "LWS Protocol",
31-
href: "https://www.w3.org/TR/lws-core/",
29+
"LWS10-CORE": {
30+
title: "Linked Web Storage Protocol 1.0",
31+
href: "https://www.w3.org/TR/lws10-core/",
3232
publisher: "W3C",
3333
status: "FPWD",
3434
},
@@ -70,15 +70,15 @@ <h2>Terminology</h2>
7070
</p>
7171

7272
<p>
73-
The terms "authentication credential" and "authentication suite" are defined by Linked Web Storage Protocol [[!LWS-PROTOCOL]]
73+
The terms "<dfn data-cite="LWS10-CORE#dfn-authentication-credential">authentication credential</dfn>" and "<dfn data-cite="LWS10-CORE#dfn-authentication-suite">authentication suite</dfn>" are defined by Linked Web Storage Protocol [[!LWS10-CORE]]
7474
</p>
7575
</section>
7676

7777
<section id="serialization">
7878
<h2>Authentication Credential Serialization</h2>
7979

8080
<p>
81-
SAML tokens used as authentication credentials MUST be signed. In addition, a valid SAML token MUST include the following assertions:
81+
SAML tokens used as <a>authentication credentials</a> MUST be signed. In addition, a valid SAML token MUST include the following assertions:
8282
</p>
8383

8484
<p>
@@ -148,7 +148,7 @@ <h2>Authentication Credential Serialization</h2>
148148
<h2>Authentication Credential Validation</h2>
149149

150150
<p>
151-
In order to validate a SAML authentication credential, there must be a trust relationship with the issuing identity provider.
151+
In order to validate a SAML <a>authentication credential</a>, there must be a trust relationship with the issuing identity provider.
152152
This specification does not define how a validating entity establishes a trust relationship with an identity provider,
153153
expecting these relationships to be established out-of-band.
154154
</p>
@@ -162,7 +162,7 @@ <h2>Authentication Credential Validation</h2>
162162
<h2>Token Type Identifier</h2>
163163

164164
<p>
165-
A SAML 2.0 assertion used as an authentication credential MUST use the <code>urn:ietf:params:oauth:token-type:saml2</code> URI when interacting with an authorization server.
165+
A SAML 2.0 assertion used as an <a>authentication credential</a> MUST use the <code>urn:ietf:params:oauth:token-type:saml2</code> URI when interacting with an authorization server.
166166
</p>
167167
</section>
168168

@@ -174,8 +174,8 @@ <h2>Security Considerations</h2>
174174
</p>
175175

176176
<p>
177-
A SAML identity provider should support a mechanism to restrict the audience of an authentication credential to a limited set of entities,
178-
including an authorization server. A client in possession of an authentication credential with no audience restrictions
177+
A SAML identity provider should support a mechanism to restrict the audience of an <a>authentication credential</a> to a limited set of entities,
178+
including an authorization server. A client in possession of an <a>authentication credential</a> with no audience restrictions
179179
should exchange this token for an equivalent audience-restricted token by using, for example, OAuth 2.0 Token Exchange [[RFC8693]].
180180
</p>
181181
</section>

lws10-authn-ssi-cid/index.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
xref: ["web-platform"],
2727
group: "lws",
2828
localBiblio: {
29-
"LWS-PROTOCOL": {
30-
title: "LWS Protocol",
31-
href: "https://www.w3.org/TR/lws-core/",
29+
"LWS10-CORE": {
30+
title: "Linked Web Storage Protocol 1.0",
31+
href: "https://www.w3.org/TR/lws10-core/",
3232
publisher: "W3C",
3333
status: "FPWD",
3434
},
@@ -52,8 +52,8 @@
5252
<h2>Introduction</h2>
5353
<p>
5454
Self-issued identity is important for cases where applications act on their own behalf. This includes autonomous bots as well as server-side scripts, among others.
55-
In these cases, the agent is able to securely manage the private portion of a keypair, which it uses to generate signed JSON Web Tokens (JWT).
56-
This specification describes how this class of agents can generate authentication credentials that can be used with a Linked Web Storage.
55+
In these cases, the <a>agent</a> is able to securely manage the private portion of a keypair, which it uses to generate signed JSON Web Tokens (JWT).
56+
This specification describes how this class of <a>agents</a> can generate <a>authentication credentials</a> that can be used with a Linked Web Storage.
5757
</p>
5858
</section>
5959
<section id="conformance"></section>
@@ -74,15 +74,15 @@ <h2>Terminology</h2>
7474
</p>
7575

7676
<p>
77-
The terms "authentication credential" and "authentication suite" are defined by Linked Web Storage Protocol [[!LWS-PROTOCOL]]
77+
The terms "<dfn data-cite="LWS10-CORE#dfn-agent">agent</dfn>", "<dfn data-cite="LWS10-CORE#dfn-authentication-credential">authentication credential</dfn>", and "<dfn data-cite="LWS10-CORE#dfn-authentication-suite">authentication suite</dfn>" are defined by Linked Web Storage Protocol [[!LWS10-CORE]]
7878
</p>
7979
</section>
8080

8181
<section id="serialization">
8282
<h2>Authentication Credential Serialization</h2>
8383

8484
<p>
85-
A self-issued authentication credential is serialized as a signed JSON Web Token (JWT). In order to use a JWT as an LWS authentication credential, the following additional requirements apply.
85+
A self-issued <a>authentication credential</a> is serialized as a signed JSON Web Token (JWT). In order to use a JWT as an LWS <a>authentication credential</a>, the following additional requirements apply.
8686
</p>
8787

8888
<p>
@@ -118,7 +118,7 @@ <h2>Authentication Credential Serialization</h2>
118118
</p>
119119

120120
<p>
121-
An example JWT that is also an LWS authentication credential is included below.
121+
An example JWT that is also an LWS <a>authentication credential</a> is included below.
122122
</p>
123123

124124
<pre id="example-authentication-token" class="example">
@@ -147,11 +147,11 @@ <h2>Authentication Credential Serialization</h2>
147147
<h2>Authentication Credential Validation</h2>
148148

149149
<p>
150-
In order to validate a JWT as an LWS authentication credential, there must be a trust relationship between the verifier and the issuing party.
150+
In order to validate a JWT as an LWS <a>authentication credential</a>, there must be a trust relationship between the verifier and the issuing party.
151151
</p>
152152

153153
<p>
154-
In the absence of a pre-existing trust relationship, the verifier MUST dereference the <code>sub</code> (subject) claim in the authentication credential.
154+
In the absence of a pre-existing trust relationship, the verifier MUST dereference the <code>sub</code> (subject) claim in the <a>authentication credential</a>.
155155
The resulting resource MUST be formatted as a valid controlled identifier document [[!CID-1.0]] with an <code>id</code> value equal to the subject identifier.
156156
</p>
157157

@@ -160,7 +160,7 @@ <h2>Authentication Credential Validation</h2>
160160
</p>
161161

162162
<p>
163-
A verifier MUST validate all claims described by the authentication credential data model.
163+
A verifier MUST validate all claims described by the <a>authentication credential</a> data model.
164164
</p>
165165

166166
<p>
@@ -203,7 +203,7 @@ <h2>Authentication Credential Validation</h2>
203203
<h2>Token Type Identifier</h2>
204204

205205
<p>
206-
A self-issued JSON Web Token used as an authentication credential MUST use the <code>urn:ietf:params:oauth:token-type:jwt</code> URI when interacting with an authorization server.
206+
A self-issued JSON Web Token used as an <a>authentication credential</a> MUST use the <code>urn:ietf:params:oauth:token-type:jwt</code> URI when interacting with an authorization server.
207207
</p>
208208

209209
</section>

lws10-authn-ssi-did-key/index.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
href: "https://w3c-ccg.github.io/did-key-spec/",
3232
publisher: "W3C",
3333
},
34-
"LWS-PROTOCOL": {
35-
title: "LWS Protocol",
36-
href: "https://www.w3.org/TR/lws-core/",
34+
"LWS10-CORE": {
35+
title: "Linked Web Storage Protocol 1.0",
36+
href: "https://www.w3.org/TR/lws10-core/",
3737
publisher: "W3C",
3838
status: "FPWD",
3939
},
@@ -58,8 +58,8 @@ <h2>Introduction</h2>
5858
<p>
5959
Self-issued identity is important for cases where applications act on their own behalf.
6060
This includes autonomous bots as well as server-side scripts, among others.
61-
In these cases, the agent is able to securely manage the private portion of a keypair, which it uses to generate signed JSON Web Tokens (JWT).
62-
This specification describes how this class of agents can generate authentication credentials that can be used with a Linked Web Storage while using agent identifiers with the `did:key:` method.
61+
In these cases, the <a>agent</a> is able to securely manage the private portion of a keypair, which it uses to generate signed JSON Web Tokens (JWT).
62+
This specification describes how this class of <a>agents</a> can generate <a>authentication credentials</a> that can be used with a Linked Web Storage while using <a>agent</a> identifiers with the `did:key:` method.
6363
</p>
6464
</section>
6565

@@ -77,15 +77,15 @@ <h2>Terminology</h2>
7777
</p>
7878

7979
<p>
80-
The terms "authentication credential" and "authentication suite" are defined by Linked Web Storage Protocol [[!LWS-PROTOCOL]]
80+
The terms "<dfn data-cite="LWS10-CORE#dfn-agent">agent</dfn>", "<dfn data-cite="LWS10-CORE#dfn-authentication-credential">authentication credential</dfn>", and "<dfn data-cite="LWS10-CORE#dfn-authentication-suite">authentication suite</dfn>" are defined by Linked Web Storage Protocol [[!LWS10-CORE]]
8181
</p>
8282
</section>
8383

8484
<section id="serialization">
8585
<h2>Authentication Credential Serialization</h2>
8686

8787
<p>
88-
A self-issued authentication credential is serialized as a signed JSON Web Token (JWT). In order to use a JWT as an LWS authentication credential, the following additional requirements apply.
88+
A self-issued <a>authentication credential</a> is serialized as a signed JSON Web Token (JWT). In order to use a JWT as an LWS <a>authentication credential</a>, the following additional requirements apply.
8989
</p>
9090

9191
<ul>
@@ -123,7 +123,7 @@ <h2>Authentication Credential Serialization</h2>
123123
</ul>
124124

125125
<p>
126-
An example JWT that is also an LWS authentication credential is included below.
126+
An example JWT that is also an LWS <a>authentication credential</a> is included below.
127127
</p>
128128

129129
<pre id="example-authentication-token" class="example">
@@ -155,7 +155,7 @@ <h2>Authentication Credential Validation</h2>
155155
</p>
156156

157157
<p>
158-
A verifier MUST validate all claims described by the authentication credential data model.
158+
A verifier MUST validate all claims described by the <a>authentication credential</a> data model.
159159
</p>
160160

161161
<p>
@@ -167,7 +167,7 @@ <h2>Authentication Credential Validation</h2>
167167
<h2>Token Type Identifier</h2>
168168

169169
<p>
170-
A self-issued JSON Web Token used as an authentication credential MUST use the <code>urn:ietf:params:oauth:token-type:jwt</code> URI when interacting with an authorization server.
170+
A self-issued JSON Web Token used as an <a>authentication credential</a> MUST use the <code>urn:ietf:params:oauth:token-type:jwt</code> URI when interacting with an authorization server.
171171
</p>
172172
</section>
173173

lws10-core/Authentication.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p>
2-
This section defines a mechanism for identifying agents and end users that interact
2+
This section defines a mechanism for identifying <a>agents</a> and end users that interact
33
with a linked web storage server. This specification does not mandate a particular
44
format for an <a>authentication credential</a>, though it does describe how existing identity systems
55
can be used in conjunction with the linked web storage authorization framework.

lws10-core/Authorization.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p>
22
Linked Web Storage describes a mechanism for persisting and managing protected data on the Web. Authorization is the mechanism
3-
by which agents request and present access tokens in order to access this protected data.
3+
by which <a>agents</a> request and present access tokens in order to access this protected data.
44
</p>
55

66
<section id="authorization-roles">
@@ -139,7 +139,7 @@ <h5>Request</h5>
139139
<li>The <code>resource</code> parameter is REQUIRED. The value of this parameter MUST be a URI and will be used to populate the
140140
<code>aud</code> (audience) claim in the resulting access token. The supplied value will be the same as the
141141
<code>realm</code> parameter response in a <code>WWW-Authenticate</code> challenge. The authorization server
142-
MUST reject any request in which the resource parameter identifies an unknown or untrusted storage.
142+
MUST reject any request in which the resource parameter identifies an unknown or untrusted <a>storage</a>.
143143
</li>
144144

145145
<li>
@@ -183,7 +183,7 @@ <h5>Response</h5>
183183

184184
<ul>
185185
<li>
186-
<code>sub</code> (subject) — <strong>REQUIRED</strong>. This claim MUST be a URI identifying the agent performing the operation
186+
<code>sub</code> (subject) — <strong>REQUIRED</strong>. This claim MUST be a URI identifying the <a>agent</a> performing the operation
187187
</li>
188188
<li>
189189
<code>iss</code> (issuer) — <strong>REQUIRED</strong>. This claim MUST be the URI of the authorization server

0 commit comments

Comments
 (0)