Registries for Web Authentication (WebAuthn)
draft-hodges-webauthn-registries-08

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 .

The most recent _published_ draft revision is at https://tools.ietf.org/html/draft-hodges-webauthn-registries.

The editors' draft is at https://github.com/w3c/webauthn/blob/master/draft-hodges-webauthn-registries.txt

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

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 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 November 20, 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
• 1.1. Requirements Notation and Conventions
• 2. IANA Considerations
• 2.1. WebAuthn Attestation Statement Format Identifier Registry
• 2.1.1. Registering Attestation Statement Format Identifiers
• 2.1.2. Registration Request Processing
• 2.1.3. Initial WebAuthn Attestation Statement Format Identifier Registry Values
• 2.2. WebAuthn Extension Identifier Registry
• 2.2.1. Registering Extension Identifiers
• 2.2.2. Registration Request Processing
• 2.2.3. Initial WebAuthn Extension Identifier Registry Values
• 3. Security Considerations
• 4. Acknowledgements
• 5. Document History
• 6. Normative References
• Authors' Addresses

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 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:

• the "WebAuthn Attestation Statement Format Identifier" registry; see Section 2.1.
• 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. ]]

For both registries, the expert(s) and IANA will interact as follows. IANA will direct any incoming requests regarding either of these registries to this document and, if defined, the processes established by the expert(s); typically, this will mean referring them to the registry Web page.

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", 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. Attestation statement format identifiers 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.

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. 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:

WebAuthn Attestation Statement Format Identifier

An identifier meeting the requirements given above in Section 2.1.

Description

A relatively short description of the attestation format.

Reference

Reference to the specification of the attestation statement format.

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.

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 which cause a registration to be refused.

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" of [WebAuthn].

2.2. WebAuthn Extension Identifier Registry

WebAuthn extension identifiers are strings whose semantic, syntactic, and string-matching criteria are specified in [WebAuthn] "Extension Identifiers" .

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. Extension identifiers may not match other registered names in a case-insensitive manner unless the Designated Experts determine that there is a compelling reason to allow an exception.

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:

WebAuthn Extension Identifier

An identifier meeting the requirements given above in Section 2.2.

Description

A relatively short description of the extension.

Reference

Reference to the specification of the extension.

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 which cause a registration to be refused.

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" of [WebAuthn].

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 Sarah Banks, Murray Kucherawy, Paul Kyzivat, and Hilarie Orman for their reviews.

5. Document History

[[ to be removed by the RFC Editor before publication as an RFC ]]

-08

• Addressed review feedback by Murray Kucherawy.
• Added BCP 14 Requirements Notation and Conventions section.
• Referenced RFC 20, which defines ASCII characters.
• Applied editorial cleanups.

-07

• Removed a duplicate URI listing pointed out by Hilarie Orman.

-06

• Addressed Gen-Art review comments by Paul Kyzivat by deleting text about designated experts defining additional registry fields.
• Addressed Ops-Dir review comments by Sarah Banks by deleting text that duplicated requirements already specified in RFC 8126.
• Addressed Security review comments by Hilarie Orman by deleting unnecessary text about attestation statement formats lacking complete specifications.
• 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

• Updated to address the solicited IANA review comments, per discussions in an email thread between the authors and IANA ( "[IANA #1154148]" ).

-04

• 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.
• Update per IANA review: Move "IANA considerations section up in doc to encompass (former) sections 2 and 3.

-03

• Update per Benjamin Kaduk's AD review. Align with RFC 8288, rather than draft-nottingham-rfc5988bis.

-02

• Refresh now that the WebAuthn spec is at Recommendation (REC) maturity level.

-01

• Refresh now that the WebAuthn Committee Recommendation (CR) draft is pending.

-00

• Initial version, based on draft-nottingham-rfc5988bis.

6. Normative References

Authors' Addresses