forked from w3c/webauthn
-
Notifications
You must be signed in to change notification settings - Fork 0
/
draft-hodges-webauthn-registries.txt
560 lines (366 loc) · 19.7 KB
/
draft-hodges-webauthn-registries.txt
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
W3C WebAuthn Working Group J. Hodges
Internet-Draft Google
Intended status: Informational G. Mandyam
Expires: December 3, 2020 Qualcomm Technologies Inc.
M. Jones
Microsoft
June 1, 2020
Registries for Web Authentication (WebAuthn)
draft-hodges-webauthn-registries-10
Abstract
This specification defines IANA registries for W3C Web Authentication
attestation statement format identifiers and extension identifiers.
Note to Readers
_RFC EDITOR: please remove this section before publication_
This is a work-in-progress.
The issues list can be found at https://github.com/w3c/webauthn/
issues?q=is%3Aopen+is%3Aissue+label%3Aspec%3Awebauthn-registries [1].
The most recent _published_ draft revision is at
https://tools.ietf.org/html/draft-hodges-webauthn-registries [2].
The editors' draft is at https://github.com/w3c/webauthn/blob/master/
draft-hodges-webauthn-registries.txt [3]
Changes in the editors' draft, both proposed and incorporated, are
listed at https://github.com/w3c/webauthn/
pulls?q=is%3Apr+label%3Aspec%3Awebauthn-registries [4]
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
Hodges, et al. Expires December 3, 2020 [Page 1]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 3, 2020.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Notation and Conventions . . . . . . . . . . 3
2. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 3
2.1. WebAuthn Attestation Statement Format Identifier Registry 3
2.1.1. Registering Attestation Statement Format Identifiers 4
2.1.2. Registration Request Processing . . . . . . . . . . . 5
2.1.3. Initial WebAuthn Attestation Statement Format
Identifier Registry Values . . . . . . . . . . . . . 5
2.2. WebAuthn Extension Identifier Registry . . . . . . . . . 5
2.2.1. Registering Extension Identifiers . . . . . . . . . . 6
2.2.2. Registration Request Processing . . . . . . . . . . . 6
2.2.3. Initial WebAuthn Extension Identifier Registry Values 7
3. Security Considerations . . . . . . . . . . . . . . . . . . . 7
4. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7
5. Document History . . . . . . . . . . . . . . . . . . . . . . 7
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
6.1. Normative References . . . . . . . . . . . . . . . . . . 9
6.2. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10
1. Introduction
This specification establishes IANA registries for W3C Web
Authentication [WebAuthn] attestation statement format identifiers
and extension identifiers. The initial values for these registries
Hodges, et al. Expires December 3, 2020 [Page 2]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
are in the IANA Considerations section of the [WebAuthn]
specification.
1.1. Requirements Notation and Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
2. IANA Considerations
This specification establishes two registries:
o the "WebAuthn Attestation Statement Format Identifier" registry;
see Section 2.1.
o the "WebAuthn Extension Identifier" registry; see Section 2.2.
[[ Per discussions in an email thread between the authors and IANA (
"[IANA #1154148]" ), it is requested that the registries be located
at <https://www.iana.org/assignments/webauthn>. RFC Editor - please
delete this request after the registries have been created. ]]
Any additional processes established by the expert(s) after the
publication of this document will be recorded on the registry Web
page at the expert(s)' discretion.
2.1. WebAuthn Attestation Statement Format Identifier Registry
WebAuthn attestation statement format identifiers are strings whose
semantic, syntactic, and string-matching criteria are specified in
[WebAuthn] "Attestation Statement Format Identifiers" [5], along with
the concepts of attestation and attestation statement formats.
Registered attestation statement format identifiers are those that
have been added to the registry by following the procedure in
Section 2.1.1.
Each attestation statement format identifier added to this registry
MUST be unique amongst the set of registered attestation statement
format identifiers.
Registered attestation statement format identifiers MUST be a maximum
of 32 octets in length and MUST consist only of printable ASCII
[RFC20] characters, excluding backslash and doublequote, i.e., VCHAR
as defined in [RFC5234] but without %x22 and %x5c. Attestation
statement format identifiers are case sensitive and may not match
Hodges, et al. Expires December 3, 2020 [Page 3]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
other registered identifiers in a case-insensitive manner unless the
Designated Experts determine that there is a compelling reason to
allow an exception.
2.1.1. Registering Attestation Statement Format Identifiers
WebAuthn attestation statement format identifiers are registered
using the Specification Required policy (see Section 4.6 of
[RFC8126]).
The WebAuthn attestation statement format identifiers registry is
located at https://www.iana.org/assignments/webauthn [6].
Registration requests can be made by following the instructions
located there, or by sending an e-mail to the webauthn-reg-
review@ietf.org mailing list.
Registration requests consist of at least the following information:
o WebAuthn Attestation Statement Format Identifier:
An identifier meeting the requirements given above in Section 2.1.
o Description:
A relatively short description of the attestation format.
o Specification Document(s):
Reference to the document or documents that specify the
attestation statement format.
o Change Controller:
For Standards Track RFCs, list the "IETF". For others, give the
name of the responsible party. Other details (e.g., postal
address, email address, home page URI) may also be included.
o Notes:
[optional]
Registrations MUST reference a freely available, stable
specification, e.g., as described in Section 4.6 of [RFC8126]. This
specification MUST include security and privacy considerations
relevant to the attestation statement format.
Note that WebAuthn attestation statement format identifiers can be
registered by third parties (including the expert(s) themselves), if
the expert(s) determine that an unregistered attestation statement
format is widely deployed and not likely to be registered in a timely
manner otherwise. Such registrations still are subject to the
requirements defined, including the need to reference a
specification.
Hodges, et al. Expires December 3, 2020 [Page 4]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
2.1.2. Registration Request Processing
As noted in Section 2.1.1, WebAuthn attestation statement format
identifiers are registered using the Specification Required policy.
The expert(s) will clearly identify any issues that cause a
registration to be refused, such as an incompletely specified
attestation format.
When a request is approved, the expert(s) will inform IANA, and the
registration will be processed. The IESG is the arbiter of any
objection.
2.1.3. Initial WebAuthn Attestation Statement Format Identifier
Registry Values
The initial values for the WebAuthn Attestation Statement Format
Identifier Registry are to be populated from the values listed in
"WebAuthn Attestation Statement Format Identifier Registrations" [7]
of [WebAuthn]. Also, the Change Controller entry to be used for each
of those registrations is:
o Change Controller: W3C Web Authentication Working Group -
public-webauthn@w3.org
2.2. WebAuthn Extension Identifier Registry
WebAuthn extension identifiers are strings whose semantic, syntactic,
and string-matching criteria are specified in [WebAuthn] "Extension
Identifiers" [8].
Registered extension identifiers are those that have been added to
the registry by following the procedure in Section 2.2.1.
Each extension identifier added to this registry MUST be unique
amongst the set of registered extension identifiers.
Registered extension identifiers MUST be a maximum of 32 octets in
length and MUST consist only of printable ASCII characters, excluding
backslash and doublequote, i.e., VCHAR as defined in [RFC5234] but
without %x22 and %x5c. Extension identifiers are case sensitive and
may not match other registered identifiers in a case-insensitive
manner unless the Designated Experts determine that there is a
compelling reason to allow an exception.
Hodges, et al. Expires December 3, 2020 [Page 5]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
2.2.1. Registering Extension Identifiers
WebAuthn extension identifiers registry are registered using the
Specification Required policy (see Section 4.6 of [RFC8126]).
The WebAuthn extension identifiers registry is located at
https://www.iana.org/assignments/webauthn. Registration requests can
be made by following the instructions located there, or by sending an
e-mail to the webauthn-reg-review@ietf.org mailing list.
Registration requests consist of at least the following information:
o WebAuthn Extension Identifier:
An identifier meeting the requirements given above in Section 2.2.
o Description:
A relatively short description of the extension.
o Specification Document(s):
Reference to the document or documents that specify the extension.
o Change Controller:
For Standards Track RFCs, list the "IETF". For others, give the
name of the responsible party. Other details (e.g., postal
address, email address, home page URI) may also be included.
o Notes:
[optional]
Registrations MUST reference a freely available, stable
specification, e.g., as described in Section 4.6 of [RFC8126]. This
specification MUST include security and privacy considerations
relevant to the extension.
Note that WebAuthn extensions can be registered by third parties
(including the expert(s) themselves), if the expert(s) determine that
an unregistered extension is widely deployed and not likely to be
registered in a timely manner otherwise. Such registrations still
are subject to the requirements defined, including the need to
reference a specification.
2.2.2. Registration Request Processing
As noted in Section 2.2.1, WebAuthn extension identifiers are
registered using the Specification Required policy.
The expert(s) will clearly identify any issues that cause a
registration to be refused, such as an incompletely specified
extension.
Hodges, et al. Expires December 3, 2020 [Page 6]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
When a request is approved, the expert(s) will inform IANA, and the
registration will be processed. The IESG is the arbiter of any
objection.
2.2.3. Initial WebAuthn Extension Identifier Registry Values
The initial values for the WebAuthn Extension Identifier Registry are
to be populated from the values listed in "WebAuthn Extension
Identifier Registrations" [9] of [WebAuthn]. Also, the Change
Controller entry to be used for each of those registrations is:
o Change Controller: W3C Web Authentication Working Group -
public-webauthn@w3.org
3. Security Considerations
See [WebAuthn] for relevant security considerations.
4. Acknowledgements
Thanks to Mark Nottingham for valuable comments and suggestions.
Thanks to Kathleen Moriarty and Benjamin Kaduk for their Area
Director sponsorship of this specification. Thanks to Amanda Baber,
Sarah Banks, Alissa Cooper, Roman Danyliw, Murray Kucherawy, Paul
Kyzivat, Barry Leiba, Hilarie Orman, Magnus Westerlund, and Robert
Wilton for their reviews.
5. Document History
[[ to be removed by the RFC Editor before publication as an RFC ]]
-10
o Changed IESG to IETF in Change Controller instructions, per
suggestion by Magnus Westerlund.
-09
o Added Change Controller fields to registries, per suggestion by
Magnus Westerlund.
o Applied editorial suggestions by Amanda Baber, Murray Kucherawy,
and Barry Leiba.
-08
o Addressed review feedback by Murray Kucherawy.
o Added BCP 14 Requirements Notation and Conventions section.
o Referenced RFC 20, which defines ASCII characters.
Hodges, et al. Expires December 3, 2020 [Page 7]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
o Applied editorial cleanups.
-07
o Removed a duplicate URI listing pointed out by Hilarie Orman.
-06
o Addressed Gen-Art review comments by Paul Kyzivat by deleting text
about designated experts defining additional registry fields.
o Addressed Ops-Dir review comments by Sarah Banks by deleting text
that duplicated requirements already specified in RFC 8126.
o Addressed Security review comments by Hilarie Orman by deleting
unnecessary text about attestation statement formats lacking
complete specifications.
o Replaced uses of the URL https://www.w3.org/TR/webauthn/ with
https://www.w3.org/TR/2019/REC-webauthn-1-20190304/ so that the
reference remains stable after the level 2 WebAuthn specification
is published.
-05
o Updated to address the solicited IANA review comments, per
discussions in an email thread between the authors and IANA (
"[IANA #1154148]" ).
-04
o Update per Benjamin Kaduk's further AD review: Remove 'final' wrt
IESG arbitrating objections; Add explicit requirement for
extension or attestation specs to include security and privacy
considerations.
o Update per IANA review: Move "IANA considerations section up in
doc to encompass (former) sections 2 and 3.
-03
o Update per Benjamin Kaduk's AD review. Align with RFC 8288,
rather than draft-nottingham-rfc5988bis.
-02
o Refresh now that the WebAuthn spec is at Recommendation (REC)
maturity level.
-01
Hodges, et al. Expires December 3, 2020 [Page 8]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
o Refresh now that the WebAuthn Committee Recommendation (CR) draft
is pending.
-00
o Initial version, based on draft-nottingham-rfc5988bis.
6. References
6.1. Normative References
[RFC20] Cerf, V., "ASCII format for Network Interchange", STD 80,
RFC 20, October 1969,
<http://www.rfc-editor.org/info/rfc20>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, RFC 5234,
DOI 10.17487/RFC5234, January 2008,
<https://www.rfc-editor.org/info/rfc5234>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/info/rfc8126>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[WebAuthn]
Balfanz, D., Czeskis, A., Hodges, J., Jones, J., Jones,
M., Kumar, A., Liao, A., Lindemann, R., and E. Lundberg,
"Web Authentication: An API for accessing Public Key
Credentials", World Wide Web Consortium
(W3C) Recommendation, March 2019,
<https://www.w3.org/TR/2019/REC-webauthn-1-20190304/>.
6.2. URIs
[1] https://github.com/w3c/webauthn/
issues?q=is%3Aopen+is%3Aissue+label%3Aspec%3Awebauthn-registries
[2] https://tools.ietf.org/html/draft-hodges-webauthn-registries
Hodges, et al. Expires December 3, 2020 [Page 9]
Internet-DraftRegistries for Web Authentication (WebAuthn) June 2020
[3] https://github.com/w3c/webauthn/blob/master/draft-hodges-
webauthn-registries.txt
[4] https://github.com/w3c/webauthn/
pulls?q=is%3Apr+label%3Aspec%3Awebauthn-registries
[5] https://www.w3.org/TR/2019/REC-webauthn-1-20190304/#sctn-attstn-
fmt-ids
[6] https://www.iana.org/assignments/webauthn
[7] https://www.w3.org/TR/2019/REC-webauthn-1-20190304/#sctn-att-fmt-
reg
[8] https://www.w3.org/TR/2019/REC-webauthn-1-20190304/#sctn-
extension-id
[9] https://www.w3.org/TR/2019/REC-webauthn-1-20190304/#sctn-
extensions-reg
Authors' Addresses
Jeff Hodges
Google
1600 Amphitheater Parkway
Mountain View, California 94043
US
Email: jdhodges@google.com
URI: https://kingsmountain.com/people/Jeff.Hodges/
Giridhar Mandyam
Qualcomm Technologies Inc.
5775 Morehouse Drive
San Diego, California 92121
USA
Phone: +1 858 651 7200
Email: mandyam@qti.qualcomm.com
Michael B. Jones
Microsoft
Email: mbj@microsoft.com
URI: https://self-issued.info/
Hodges, et al. Expires December 3, 2020 [Page 10]