forked from WICG/digital-credentials
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
309 lines (309 loc) · 9.15 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>
Digital Credentials
</title>
<script src="https://www.w3.org/Tools/respec/respec-w3c" class=
"remove"></script>
<script class="remove">
"use strict";
// See https://github.com/w3c/respec/wiki/ for how to configure ReSpec
var respecConfig = {
github: "WICG/digital-credentials",
editors: [
{
name: "Marcos Caceres",
email: "[email protected]",
company: "Apple Inc.",
companyURL: "https://apple.com",
},
{
name: "Sam Goto",
email: "[email protected]",
company: "Google Inc.",
companyURL: "https://google.com",
},
// Add additional editors here.
// https://github.com/w3c/respec/wiki/editors
],
shortName: "digital-identity",
specStatus: "CG-DRAFT",
group: "wicg",
localBiblio: {},
xref: {
profile: "web-platform",
},
};
</script>
</head>
<body data-cite="credential-management-1">
<section id="abstract">
<p>
This document specifies an API to enable [=user agents=] to mediate
access to, and presentation of, digital credentials such as a driver's
license, government-issued identification card, and/or [=credential
type examples|other types of digital credential=]. The API builds on
[[[credential-management-1]]] as a means by which to request a digital
credential from a user agent or underlying platform.
</p>
</section>
<section id="sotd">
<p>
This is an unofficial proposal.
</p>
</section>
<h2>
Introduction
</h2>
<p>
TBW
</p>
<p id="credential-type-examples">
There are many types of digital credential that can be conveyed using
this API. <dfn data-lt="credential type examples">Examples of these
types</dfn> include:
</p>
<ul>
<li>a driver's license or identity card issued by a government
institution
</li>
<li>TBW: other credential types
</li>
</ul>
<h2>
Model
</h2>
<p class="note" title="Definitions under discussion">
The goal of the definitions in this section is to reuse or establish
terminology that is common across a variety of digital credential formats
and protocols. Discussions surrounding these definitions are active and
the definitions are likely to change over the next several months.
</p>
<dl class="definitions" data-sort="" data-cite="vc-data-model-2.0">
<dt>
<dfn>Digital credential</dfn>
</dt>
<dd>
A cryptographically signed digital document containing one or more
[=claims=] made by an [=issuer=] about one or more [=subjects=].
<p class="note" title="Focus on digital credentials about people">
This specification is currently focused on digital credentials
pertaining to people.
</p>
</dd>
<dt>
<dfn data-dfn-for="digital credential">query</dfn>
</dt>
<dd>
A format that [=verifier=] software or a [=user agent=] uses, via an
[=digital credential/exchange protocol=], to request a [=digital
credential=] from a [=holder=].
</dd>
<dt>
<dfn>Presentation response</dfn>
</dt>
<dd>
A format that a [=holder|holder's=] software, such as a digital wallet,
uses, via an [=digital credential/exchange protocol=], to respond to a
[=digital credential/query=] by a [=verifier=].
</dd>
<dt>
<dfn data-dfn-for="digital credential">Exchange protocol</dfn>
</dt>
<dd>
A protocol used for exchanging a [=digital credential=] between a
[=holder=] and a [=verifier=]. See section [[[#protocol-registry]]].
</dd>
</dl>
<h2>
Scope
</h2>
<p>
The following items are within the scope of this specification:
</p>
<ul>
<li>Requesting a [=digital credential=], including mechanisms for secure
presentation.
</li>
</ul>
<p>
The following items are out of scope:
</p>
<ul>
<li>Issuance process for establishing a [=digital credential=].
</li>
<li>UI/UX considerations, with the exception of privacy considerations,
which are addressed to ensure the protection of user data during the
request process.
</li>
</ul>
<h2>
Extensions to the `Navigator` interface
</h2>
<pre class="idl">
partial interface Navigator {
[SecureContext, SameObject] readonly attribute CredentialsContainer identity;
};
</pre>
<h3>
The `identity` attribute
</h3>
<p data-dfn-for="Navigator">
The <dfn>identity</dfn> attribute provides access to the the underlying
{{CredentialsContainer}} for managing [=digital credentials=].
</p>
<h3>
Extensions to Credential Management API
</h3>
<aside class="issue" data-number="65"></aside>
<h2>
Extensions to `CredentialRequestOptions` dictionary
</h2>
<pre class="idl">
partial dictionary CredentialRequestOptions {
DigitalCredentialRequestOptions digital;
};
</pre>
<h3>
The `digital` member
</h3>
<p>
The <dfn data-dfn-for="CredentialRequestOptions">digital</dfn> member
allows for options to configure the request for a [=digital credential=].
</p>
<h2>
The `DigitalCredentialRequestOptions` dictionary
</h2>
<pre class="idl">
dictionary DigitalCredentialRequestOptions {
sequence<IdentityRequestProvider> providers;
};
</pre>
<h3>
The `providers` member
</h3>
<p>
The <dfn data-dfn-for="DigitalCredentialRequestOptions">providers</dfn>
specify an [=digital credential/exchange protocol=] and [=digital
credential/query=], which the user agent MAY match against a holder's
software, such as a digital wallet.
</p>
<h2>
The `IdentityRequestProvider` dictionary
</h2>
<p>
The {{IdentityRequestProvider}} dictionary is used to specify an
[=digital credential/exchange protocol=] and a [=digital
credential/query=], which the user agent MAY match against software used
by a holder, such as a digital wallet.
</p>
<pre class="idl">
dictionary IdentityRequestProvider {
required DOMString protocol;
required DOMString request;
};
</pre>
<h3>
The `protocol` member
</h3>
<p>
The <dfn data-dfn-for="IdentityRequestProvider">protocol</dfn> member
denotes the [=digital credential/exchange protocol=] when requesting an
identify credential.
</p>
<p>
The {{IdentityRequestProvider/protocol}} member's value is be one of the
well-defined keys defined in [[[#protocol-registry]]] or any other custom
one.
</p>
<h3>
The `request` member
</h3>
<p>
The <dfn data-dfn-for="IdentityRequestProvider">request</dfn> member is
the request to be handled by the holder's software, such as a digital
wallet.
</p>
<h2>
The `DigitalCredential` interface
</h2>
<p>
The <dfn>DigitalCredential</dfn> interface represents a conceptual
[=digital credential=].
</p>
<pre class="idl">
[Exposed=Window, SecureContext]
interface DigitalCredential : Credential {
readonly attribute DOMString protocol;
readonly attribute DOMString data;
};
</pre>
<h3>
The `protocol` member
</h3>
<p>
The <dfn data-dfn-for="DigitalCredential">protocol</dfn> member is the
[=digital credential/exchange protocol=] that was used to request the
[=digital credential=].
</p>
<h3>
The `data` member
</h3>
<p>
The <dfn data-dfn-for="DigitalCredential">data</dfn> member is the
credential's encrypted data.
</p>
<h2 id="protocol-registry">
Registry of protocols for requesting digital credential
</h2>
<p>
The following is the registry of [=digital credential/exchange
protocols=] that are supported by this specification.
</p>
<p class="note" title="Official Registry" data-cite="w3c-process">
It is expected that this registry will be become a [=W3C registry=] in
the future.
</p>
<h3>
Inclusion criteria
</h3>
<p>
To be included in the registry...
</p>
<aside class="issue" data-number="58"></aside>
<p>
[=User agents=] MUST support the following [=digital credential/exchange
protocols=]:
</p>
<table class="data">
<caption>
Table of officially registered [=digital credential/exchange
protocols=].
</caption>
<thead>
<tr>
<th>
Protocol identifier
</th>
<th>
Description
</th>
<th>
Specification
</th>
</tr>
</thead>
<tbody>
<tr>
<td colspan="3">
Coming soon...
</td>
</tr>
</tbody>
</table>
<section id="idl-index"></section>
<section id="conformance"></section>
</body>
</html>