From 4ae4c83ba073248b098a5c987afaab448776bb21 Mon Sep 17 00:00:00 2001 From: Adam Langley Date: Mon, 20 Nov 2023 20:22:44 +0000 Subject: [PATCH] Merge pull request #1957 from w3c/spk SHA: f8163ea38ba03fb2352b5d6730bac6db1225b30a Reason: push, by nsatragno Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- index.html | 12318 ++++++++++++++++++++------------------------------- 1 file changed, 4863 insertions(+), 7455 deletions(-) diff --git a/index.html b/index.html index 51eb69b09..d84ef2b89 100644 --- a/index.html +++ b/index.html @@ -2,11 +2,11 @@ - Web Authentication: An API for accessing Public Key Credentials - Level + Web Authentication: An API for accessing Public Key Credentials - Level 3 - + - + - - + + - + - + - - - + + - +

Web Authentication:
An API for accessing Public Key Credentials
Level 3

-

Editor’s Draft,

+

Editor’s Draft,

More details about this document
@@ -398,7 +931,7 @@

Web Authentication:
An API for accessing Public Key Credentials
Level
Feedback:
GitHub
Editors: -
(Microsoft) +
(Self-Issued Consulting)
(Microsoft)
(Yubico)
Former Editors: @@ -419,7 +952,8 @@

Web Authentication:
An API for accessing Public Key Credentials
Level
Giridhar Mandyam (Qualcomm)
Matthew Miller (Cisco)
Nina Satragno (Google) -
Nick Steele (Gemini) +
Ki-Eun Shin (SK Telecom) +
Nick Steele (1Password)
Jiewen Tan (Apple)
Shane Weeden (IBM)
Mike West (Google) @@ -430,7 +964,7 @@

Web Authentication:
An API for accessing Public Key Credentials
Level

- +
@@ -461,7 +995,7 @@

Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

-

This document is governed by the 2 November 2021 W3C Process Document.

+

This document is governed by the 03 November 2023 W3C Process Document.

@@ -527,8 +1061,9 @@

Table of Contents

  • 5.1.5 Store an Existing Credential - PublicKeyCredential’s [[Store]](credential, sameOriginWithAncestors) Method
  • 5.1.6 Preventing Silent Access to an Existing Credential - PublicKeyCredential’s [[preventSilentAccess]](credential, sameOriginWithAncestors) Method
  • 5.1.7 Availability of User-Verifying Platform Authenticator - PublicKeyCredential’s isUserVerifyingPlatformAuthenticatorAvailable() Method -
  • 5.1.8 Deserialize Registration ceremony options - PublicKeyCredential’s parseCreationOptionsFromJSON() Method -
  • 5.1.9 Deserialize Authentication ceremony options - PublicKeyCredential’s parseRequestOptionsFromJSON() Methods +
  • 5.1.8 Availability of a passkey platform authenticator - PublicKeyCredential’s isPasskeyPlatformAuthenticatorAvailable() Method +
  • 5.1.9 Deserialize Registration ceremony options - PublicKeyCredential’s parseCreationOptionsFromJSON() Method +
  • 5.1.10 Deserialize Authentication ceremony options - PublicKeyCredential’s parseRequestOptionsFromJSON() Methods
  • 5.2 Authenticator Responses (interface AuthenticatorResponse) @@ -577,6 +1112,7 @@

    Table of Contents

  • 5.8.4 Authenticator Transport Enumeration (enum AuthenticatorTransport)
  • 5.8.5 Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)
  • 5.8.6 User Verification Requirement Enumeration (enum UserVerificationRequirement) +
  • 5.8.7 User-agent Hints Enumeration (enum PublicKeyCredentialHints)
  • 5.9 Permissions Policy integration
  • 5.10 Using Web Authentication within iframe elements @@ -616,15 +1152,16 @@

    Table of Contents

  • 6.5 Attestation
      +
    1. 6.5.1 Attestation in assertions
    2. - 6.5.1 Attested Credential Data + 6.5.2 Attested Credential Data
        -
      1. 6.5.1.1 Examples of credentialPublicKey Values Encoded in COSE_Key Format +
      2. 6.5.2.1 Examples of credentialPublicKey Values Encoded in COSE_Key Format
      -
    3. 6.5.2 Attestation Statement Formats -
    4. 6.5.3 Attestation Types -
    5. 6.5.4 Generating an Attestation Object -
    6. 6.5.5 Signature Formats for Packed Attestation, FIDO U2F Attestation, and Assertion Signatures +
    7. 6.5.3 Attestation Statement Formats +
    8. 6.5.4 Attestation Types +
    9. 6.5.5 Generating an Attestation Object +
    10. 6.5.6 Signature Formats for Packed Attestation, FIDO U2F Attestation, and Assertion Signatures
  • @@ -656,6 +1193,7 @@

    Table of Contents

  • 8.6 FIDO U2F Attestation Statement Format
  • 8.7 None Attestation Statement Format
  • 8.8 Apple Anonymous Attestation Statement Format +
  • 8.9 Compound Attestation Statement Format
  • 9 WebAuthn Extensions @@ -682,6 +1220,23 @@

    Table of Contents

    10.2 Authenticator Extensions
    1. 10.2.1 User Verification Method Extension (uvm) +
    2. + 10.2.2 Supplemental public keys extension (supplementalPubKeys) +
        +
      1. 10.2.2.1 Relying Party Usage +
      2. + 10.2.2.2 Extension Definition +
          +
        1. 10.2.2.2.1 AAGUIDs +
        2. 10.2.2.2.2 Attestation calculations +
        +
      3. + 10.2.2.3 supplementalPubKeys Extension Output Verification Procedures +
          +
        1. 10.2.2.3.1 Registration (create()) +
        2. 10.2.2.3.2 Authentication (get()) +
        +
  • @@ -731,6 +1286,7 @@

    Table of Contents

  • 13.4.6 Credential Loss and Key Mobility
  • 13.4.7 Unprotected account detection
  • 13.4.8 Code injection attacks +
  • 13.4.9 Validating the origin of a credential
  • @@ -760,7 +1316,11 @@

    Table of Contents

  • 14.6.3 Privacy leak via credential IDs -
  • 15 Accessibility Considerations +
  • + 15 Accessibility Considerations +
      +
    1. 15.1 Recommended Range for Ceremony Timeouts +
  • 16 Acknowledgements
  • Index @@ -791,7 +1351,7 @@

    1

    Relying Parties employ the Web Authentication API during two distinct, but related, ceremonies involving a user. The first is Registration, where a public key credential is created on an authenticator, and scoped to a Relying Party with the present user’s account (the account might already exist or might be created at this time). The second is Authentication, where the Relying Party is presented with an Authentication Assertion proving the presence and consent of the user who registered the public key credential. Functionally, the Web Authentication -API comprises a PublicKeyCredential which extends the Credential Management API [CREDENTIAL-MANAGEMENT-1], and +API comprises a PublicKeyCredential which extends the Credential Management API [CREDENTIAL-MANAGEMENT-1], and infrastructure which allows those credentials to be used with navigator.credentials.create() and navigator.credentials.get(). The former is used during Registration, and the latter during Authentication.

    Broadly, compliant authenticators protect public key credentials, and interact with user agents to implement the Web Authentication API. @@ -807,7 +1367,7 @@

    All audiences ought to begin with § 1.2 Use Cases, § 1.3 Sample API Usage Scenarios, and § 4 Terminology, and should also -refer to [WebAuthnAPIGuide] for an overall tutorial. +refer to [WebAuthnAPIGuide] for an overall tutorial. Beyond that, the intended audiences for this document are the following main groups:

    -

    Note: This approach of registering multiple authenticators for an account is also useful in account recovery use cases.

    +

    Note: This approach of registering multiple authenticators for an account is also useful in account recovery use cases.

    -

    Note: Since this computer lacks a platform authenticator, the website may require the user to present their USB security +

    Note: Since this computer lacks a platform authenticator, the website may require the user to present their USB security key from time to time or each time the user interacts with the website. This is at the website’s discretion.

  • Later, on their laptop (which features a platform authenticator):

    @@ -1023,7 +1583,7 @@

    The sample code for generating and registering a new key follows:

    -
    if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }
    +
    if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }
     
     var publicKey = {
       // The challenge is produced by the server; see the Security Considerations
    @@ -1059,7 +1619,7 @@ 

    : "preferred" }, - timeout: 360000, // 6 minutes + timeout: 300000, // 5 minutes excludeCredentials: [ // Don’t re-register any authenticator that has one of these credentials {"id": Uint8Array.from(window.atob("ufJWp8YGlibm1Kd9XQBWN1WAw2jy5In2Xhon9HAqcXE="), c=>c.charCodeAt(0)), "type": "public-key"}, @@ -1167,14 +1727,14 @@

    <

    If the Relying Party script does not have any hints available (e.g., from locally stored data) to help it narrow the list of credentials, then the sample code for performing such an authentication might look like this:

    -
    if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }
    +
    if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }
     
     // credentialId is generated by the authenticator and is an opaque random byte array
     var credentialId = new Uint8Array([183, 148, 245 /* more random bytes previously generated by the authenticator */]);
     var options = {
       // The challenge is produced by the server; see the Security Considerations
       challenge: new Uint8Array([4,101,15 /* 29 more random bytes generated by the server */]),
    -  timeout: 120000,  // 2 minutes
    +  timeout: 300000,  // 5 minutes
       allowCredentials: [{ type: "public-key", id: credentialId }]
     };
     
    @@ -1187,7 +1747,7 @@ 

    <

    On the other hand, if the Relying Party script has some hints to help it narrow the list of credentials, then the sample code for performing such an authentication might look like the following. Note that this sample also demonstrates how to use the Credential Properties Extension.

    -
    if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }
    +
    if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }
     
     var encoder = new TextEncoder();
     var acceptableCredential1 = {
    @@ -1202,7 +1762,7 @@ 

    < var options = { // The challenge is produced by the server; see the Security Considerations challenge: new Uint8Array([8,18,33 /* 29 more random bytes generated by the server */]), - timeout: 120000, // 2 minutes + timeout: 300000, // 5 minutes allowCredentials: [acceptableCredential1, acceptableCredential2], extensions: { 'credProps': true } }; @@ -1294,7 +1854,7 @@

    A conforming User Agent MUST also be a conforming implementation of the IDL fragments of this specification, as described in the -“Web IDL” specification. [WebIDL]

    +“Web IDL” specification. [WebIDL]

    2.1.1. Enumerations as DOMString types

    Enumeration types are not referenced by other parts of the Web IDL because that would preclude other values from being used without updating this specification @@ -1323,53 +1883,53 @@

    Base64url Encoding refers to the base64 encoding using the URL- and filename-safe character set defined -in Section 5 of [RFC4648], with all trailing '=' characters omitted (as permitted by Section 3.2) and without the +in Section 5 of [RFC4648], with all trailing '=' characters omitted (as permitted by Section 3.2) and without the inclusion of any line breaks, whitespace, or other additional characters.

    CBOR
    -

    A number of structures in this specification, including attestation statements and extensions, are encoded using the CTAP2 canonical CBOR encoding form of the Compact Binary Object Representation (CBOR) [RFC8949], -as defined in [FIDO-CTAP].

    +

    A number of structures in this specification, including attestation statements and extensions, are encoded using the CTAP2 canonical CBOR encoding form of the Compact Binary Object Representation (CBOR) [RFC8949], +as defined in [FIDO-CTAP].

    CDDL
    -

    This specification describes the syntax of all CBOR-encoded data using the CBOR Data Definition Language (CDDL) [RFC8610].

    +

    This specification describes the syntax of all CBOR-encoded data using the CBOR Data Definition Language (CDDL) [RFC8610].

    COSE
    -

    CBOR Object Signing and Encryption (COSE) [RFC9052] [RFC9053]. -The IANA COSE Algorithms registry [IANA-COSE-ALGS-REG] originally established by [RFC8152] and updated by these specifications is also used.

    +

    CBOR Object Signing and Encryption (COSE) [RFC9052] [RFC9053]. +The IANA COSE Algorithms registry [IANA-COSE-ALGS-REG] originally established by [RFC8152] and updated by these specifications is also used.

    Credential Management
    -

    The API described in this document is an extension of the Credential concept defined in [CREDENTIAL-MANAGEMENT-1].

    +

    The API described in this document is an extension of the Credential concept defined in [CREDENTIAL-MANAGEMENT-1].

    DOM
    -

    DOMException and the DOMException values used in this specification are defined in [DOM4].

    +

    DOMException and the DOMException values used in this specification are defined in [DOM4].

    ECMAScript
    -

    %ArrayBuffer% is defined in [ECMAScript].

    +

    %ArrayBuffer% is defined in [ECMAScript].

    HTML
    -

    The concepts of browsing context, origin, opaque origin, tuple origin, relevant settings object, same site and is a registrable domain suffix of or is equal to are defined in [HTML].

    +

    The concepts of browsing context, origin, opaque origin, tuple origin, relevant settings object, same site and is a registrable domain suffix of or is equal to are defined in [HTML].

    URL
    -

    The concepts of domain, host, port, scheme, valid domain and valid domain string are defined in [URL].

    +

    The concepts of domain, host, port, scheme, valid domain and valid domain string are defined in [URL].

    Web IDL
    -

    Many of the interface definitions and all of the IDL in this specification depend on [WebIDL]. This updated version of +

    Many of the interface definitions and all of the IDL in this specification depend on [WebIDL]. This updated version of the Web IDL standard adds support for Promises, which are now the preferred mechanism for asynchronous interaction in all new web APIs.

    FIDO AppID

    The algorithms for determining the FacetID of a calling application and determining if a caller’s FacetID is authorized for an AppID (used only in -the AppID extension) are defined by [FIDO-APPID].

    +the AppID extension) are defined by [FIDO-APPID].

    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and -"OPTIONAL" in this document are to be interpreted as described in [RFC2119].

    +"OPTIONAL" in this document are to be interpreted as described in [RFC2119].

    4. Terminology

    Attestation

    Generally, attestation is a statement that serves to bear witness, confirm, or authenticate. In the WebAuthn context, attestation is employed to provide verifiable evidence as to the origin of an authenticator and the data it emits. This includes such things as credential IDs, credential key pairs, signature counters, etc.

    -

    An attestation statement is provided within an attestation object during a registration ceremony. See also § 6.5 Attestation and Figure 6. Whether or how the client conveys the attestation statement and AAGUID portions of the attestation object to the Relying Party is described by attestation conveyance.

    +

    An attestation statement is provided within an attestation object during a registration ceremony. See also § 6.5 Attestation and Figure 6. Whether or how the client conveys the attestation statement and aaguid portions of the attestation object to the Relying Party is described by attestation conveyance.

    Attestation Certificate

    An X.509 Certificate for the attestation key pair used by an authenticator to attest to its manufacture @@ -1391,14 +1951,15 @@

    Assertion

    The cryptographically signed AuthenticatorAssertionResponse object returned by an authenticator as the result of an authenticatorGetAssertion operation.

    -

    This corresponds to the [CREDENTIAL-MANAGEMENT-1] specification’s single-use credentials.

    +

    This corresponds to the [CREDENTIAL-MANAGEMENT-1] specification’s single-use credentials.

    Authenticator
    WebAuthn Authenticator
    -

    A cryptographic entity, existing in hardware or software, that can register a user with a given Relying Party and later assert possession of the registered public key credential, and optionally verify the user, when requested by the Relying Party. Authenticators can report information -regarding their type and security characteristics via attestation during registration.

    +

    A cryptographic entity, existing in hardware or software, that can register a user with a given Relying Party and later assert possession of the registered public key credential, and optionally verify the user to the Relying Party. Authenticators can report information +regarding their type and security characteristics via attestation during registration and assertion.

    A WebAuthn Authenticator could be a roaming authenticator, a dedicated hardware subsystem integrated into the client device, -or a software component of the client or client device.

    +or a software component of the client or client device. A WebAuthn Authenticator is not necessarily confined to operating in +a local context, and can generate or store a credential key pair in a server outside of client-side hardware.

    In general, an authenticator is assumed to have only one user. If multiple natural persons share access to an authenticator, they are considered to represent the same user in the context of that authenticator. @@ -1431,13 +1992,13 @@

    authenticator that implements biometric recognition.

    Biometric Recognition
    -

    The automated recognition of individuals based on their biological and behavioral characteristics [ISOBiometricVocabulary].

    +

    The automated recognition of individuals based on their biological and behavioral characteristics [ISOBiometricVocabulary].

    Bound credential
    "Authenticator contains a credential"
    "Credential created on an authenticator"

    A public key credential source or public key credential is said to be bound to its managing -authenticator. This means that only the managing authenticator can generate assertions for the public key +authenticator. This means that only the managing authenticator can generate assertions for the public key credential sources bound to it.

    This may also be expressed as "the managing authenticator contains the bound credential", or "the bound credential was created on its managing authenticator". @@ -1446,7 +2007,7 @@

    § 6.2.2 Credential Storage Modality.

    Ceremony
    -

    The concept of a ceremony [Ceremony] is an extension of the concept of a network protocol, with human nodes alongside +

    The concept of a ceremony [Ceremony] is an extension of the concept of a network protocol, with human nodes alongside computer nodes and with communication links that include user interface(s), human-to-human communication, and transfers of physical objects that carry data. What is out-of-band to a protocol is in-band to a ceremony. In this specification, Registration and Authentication are ceremonies, and an authorization gesture is often a component of those ceremonies.

    @@ -1480,10 +2041,11 @@

    Client-side discoverable Public Key Credential Source
    Client-side discoverable Credential
    Discoverable Credential +
    Passkey
    [DEPRECATED] Resident Credential
    [DEPRECATED] Resident Key
    -

    Note: Historically, client-side discoverable credentials have been known as resident credentials or resident keys. +

    Note: Historically, client-side discoverable credentials have been known as resident credentials or resident keys. Due to the phrases ResidentKey and residentKey being widely used in both the WebAuthn API and also in the Authenticator Model (e.g., in dictionary member names, algorithm variable names, and operation parameters) the usage of resident within their @@ -1495,9 +2057,9 @@

    discoverable credential capable authenticator can generate an assertion signature for a discoverable credential given only an RP ID, which in turn necessitates that the public key credential source is stored in the authenticator or client platform. This is in contrast to a Server-side Public Key Credential Source, -which requires that the authenticator is given both the RP ID and the credential ID but does not require client-side storage of the public key credential source.

    +which requires that the authenticator is given both the RP ID and the credential ID but does not require client-side storage of the public key credential source.

    See also: client-side credential storage modality and non-discoverable credential.

    -

    Note: Client-side discoverable credentials are also usable in authentication ceremonies where credential IDs are given, +

    Note: Client-side discoverable credentials are also usable in authentication ceremonies where credential IDs are given, i.e., when calling navigator.credentials.get() with a non-empty allowCredentials argument.

    Conforming User Agent
    @@ -1514,23 +2076,24 @@

    public key credential source, without its Credential ID or mutable items, encrypted so only its managing authenticator can decrypt it. This form allows the authenticator to be nearly stateless, by having the Relying Party store any necessary state.

    -

    Note: [FIDO-UAF-AUTHNR-CMDS] includes guidance on encryption techniques under "Security Guidelines".

    +

    Note: [FIDO-UAF-AUTHNR-CMDS] includes guidance on encryption techniques under "Security Guidelines".

    Relying Parties do not need to distinguish these two Credential ID forms.

    Credential Key Pair
    Credential Private Key
    Credential Public Key
    User Public Key +
    User Credential
    -

    A credential key pair is a pair of asymmetric cryptographic keys generated by an authenticator and scoped to a specific WebAuthn Relying Party. It is the central part of a public key credential.

    -

    A credential public key is the public key portion of a credential key pair. +

    A credential key pair is a pair of asymmetric cryptographic keys generated by an authenticator and scoped to a specific WebAuthn Relying Party. It is the central part of a public key credential.

    +

    A credential public key is the public key portion of a credential key pair. The credential public key is returned to the Relying Party during a registration ceremony.

    -

    A credential private key is the private key portion of a credential key pair. +

    A credential private key is the private key portion of a credential key pair. The credential private key is bound to a particular authenticator - its managing authenticator - and is expected to never be exposed to any other party, not even to the owner of the authenticator.

    Note that in the case of self -attestation, the credential key pair is also used as the attestation key pair, see self attestation for details.

    -

    Note: The credential public key is referred to as the user public key in FIDO UAF [UAFProtocol], and in FIDO U2F [FIDO-U2F-Message-Formats] and some parts of this specification that relate to it.

    +attestation, the credential key pair is also used as the attestation key pair, see self attestation for details.

    +

    Note: The credential public key is referred to as the user public key in FIDO UAF [UAFProtocol], and in FIDO U2F [FIDO-U2F-Message-Formats] and some parts of this specification that relate to it.

    Credential Properties

    A credential property is some characteristic property of a public key credential source, such as whether it is a client-side discoverable credential or a server-side credential.

    @@ -1557,81 +2120,102 @@

    transports

    The value returned from getTransports() when the public key credential source was registered.

    -

    Note: Modifying or removing items from the value returned from getTransports() could negatively impact user experience, or even prevent use of the corresponding credential.

    -
    BE +

    Note: Modifying or removing items from the value returned from getTransports() could negatively impact user experience, or even prevent use of the corresponding credential.

    +
    uvInitialized
    -

    The value of the BE flag when the public key credential source was created.

    -
    BS +

    A Boolean value indicating whether any credential from this public key credential source has had the UV flag set.

    +

    When this is true, the Relying Party MAY consider the UV flag as an authentication factor in authentication ceremonies. +For example, a Relying Party might skip a password prompt if uvInitialized is true and the UV flag is set, even when user verification was not required.

    +

    When this is false, including an authentication ceremony where it would be updated to true, +the UV flag MUST NOT be relied upon as an authentication factor. +This is because the first time a public key credential source sets the UV flag to 1, +there is not yet any trust relationship established between the Relying Party and the authenticator's user verification. +Therefore, updating uvInitialized from false to true SHOULD require authorization by an additional authentication factor equivalent to WebAuthn user verification.

    +
    backupEligible
    -

    The latest value of the BS flag in the authenticator data from any ceremony using the public key credential source.

    +

    The value of the BE flag when the public key credential source was created.

    +
    backupState +
    +

    The latest value of the BS flag in the authenticator data from any ceremony using the public key credential source.

    The following items are OPTIONAL:

    attestationObject

    The value of the attestationObject attribute -when the public key credential source was registered. -Storing this enables the Relying Party to reference the credential’s attestation statement at a later time.

    +when the public key credential source was registered. +Storing this enables the Relying Party to reference the credential’s attestation statement at a later time.

    attestationClientDataJSON

    The value of the clientDataJSON attribute -when the public key credential source was registered. -Storing this in combination with the above attestationObject item enables the Relying Party to re-verify the attestation signature at a later time.

    +when the public key credential source was registered. +Storing this in combination with the above attestationObject item enables the Relying Party to re-verify the attestation signature at a later time.

    +
    authenticatorDisplayName +
    +

    A human-palatable description of the public key credential source.

    +

    If used, the Relying Party SHOULD use this to describe the credential record in the user’s account settings. +The Relying Party SHOULD allow the user to choose this value, and MAY allow the user to modify it at will.

    +

    The Credential Properties Extension defines the credential property authenticatorDisplayName which, when available, MAY be offered as a default for this value. +The Relying Party MAY also derive a default value from the authenticator’s attestation statement, if any.

    -

    WebAuthn extensions MAY define additional items needed to process the extension. Relying Parties MAY also include any additional items as needed, +

    WebAuthn extensions MAY define additional items needed to process the extension. Relying Parties MAY also include any additional items as needed, and MAY omit any items not needed for their implementation.

    The credential descriptor for a credential record is a PublicKeyCredentialDescriptor value with the contents:

    type
    -

    The type of the credential record.

    +

    The type of the credential record.

    id
    -

    The id of the credential record.

    +

    The id of the credential record.

    transports
    -

    The transports of the credential record.

    +

    The transports of the credential record.

    +
    Supplemental public key +
    +

    A additional public key, associated with a user credential, that can be obtained (and exercised) with the supplementalPubKeys extension. These public keys provide more specific continuity signals. For example, a supplemental public key with device scope never leaves the device, while a multi-device credential can. Other supplemental public keys might have a broader scope, as described by their attestation.

    +

    Supplemental public keys MUST NOT have a scope that exceeds the scope of their user credential—i.e. they never link two user credentials together. While this specification defines norms around scopes, Relying Parties have to evaluate supplemental public keys in light of their attestation, if any, and assign credibility to claimed scopes accordingly.

    Generating Authenticator

    The Generating Authenticator is the authenticator involved in the authenticatorMakeCredential operation resulting -in the creation of a given public key credential source. The generating authenticator is the same as the managing authenticator for single-device credentials. For multi-device credentials, the generating authenticator may or may not be the same as the +in the creation of a given public key credential source. The generating authenticator is the same as the managing authenticator for single-device credentials. For multi-device credentials, the generating authenticator may or may not be the same as the current managing authenticator participating in a given authentication operation.

    Human Palatability
    -

    An identifier that is human-palatable is intended to be rememberable and reproducible by typical human -users, in contrast to identifiers that are, for example, randomly generated sequences of bits [EduPersonObjectClassSpec].

    +

    An identifier that is human-palatable is intended to be rememberable and reproducible by typical human +users, in contrast to identifiers that are, for example, randomly generated sequences of bits [EduPersonObjectClassSpec].

    Non-Discoverable Credential
    -

    This is a credential whose credential ID must be provided in allowCredentials when calling navigator.credentials.get() because it is not client-side discoverable. See also server-side credentials.

    +

    This is a credential whose credential ID must be provided in allowCredentials when calling navigator.credentials.get() because it is not client-side discoverable. See also server-side credentials.

    Public Key Credential
    -

    Generically, a credential is data one entity presents to another in order to authenticate the former to the latter [RFC4949]. The term public key credential refers to one of: a public key credential source, the -possibly-attested credential public key corresponding to a public key credential source, or an authentication assertion. Which one is generally determined by context.

    +

    Generically, a credential is data one entity presents to another in order to authenticate the former to the latter [RFC4949]. The term public key credential refers to one of: a public key credential source, the +possibly-attested credential public key corresponding to a public key credential source, or an authentication assertion. Which one is generally determined by context.

    - Note: This is a willful violation of [RFC4949]. In English, a "credential" is both a) the thing presented to prove + Note: This is a willful violation of [RFC4949]. In English, a "credential" is both a) the thing presented to prove a statement and b) intended to be used multiple times. It’s impossible to achieve both criteria securely with a single - piece of data in a public key system. [RFC4949] chooses to define a credential as the thing that can be used multiple + piece of data in a public key system. [RFC4949] chooses to define a credential as the thing that can be used multiple times (the public key), while this specification gives "credential" the English term’s flexibility. This specification - uses more specific terms to identify the data related to an [RFC4949] credential: + uses more specific terms to identify the data related to an [RFC4949] credential:
    "Authentication information" (possibly including a private key)
    -

    Public key credential source

    +

    Public key credential source

    "Signed value"

    Authentication assertion

    -
    [RFC4949] "credential" +
    [RFC4949] "credential"

    Credential public key or attestation object

    -

    At registration time, the authenticator creates an asymmetric key pair, and stores its private key portion and information from the Relying Party into a public key credential source. The public key portion is returned to the Relying Party, which then stores it in the active user account. -Subsequently, only that Relying Party, as identified by its RP ID, is able to employ the public key credential in authentication ceremonies, via the get() method. The Relying Party uses its stored +

    At registration time, the authenticator creates an asymmetric key pair, and stores its private key portion and information from the Relying Party into a public key credential source. The public key portion is returned to the Relying Party, which then stores it in the active user account. +Subsequently, only that Relying Party, as identified by its RP ID, is able to employ the public key credential in authentication ceremonies, via the get() method. The Relying Party uses its stored copy of the credential public key to verify the resultant authentication assertion.

    Public Key Credential Source
    -

    A credential source ([CREDENTIAL-MANAGEMENT-1]) used by an authenticator to generate authentication assertions. A public key credential source consists of a struct with the following items:

    +

    A credential source ([CREDENTIAL-MANAGEMENT-1]) used by an authenticator to generate authentication assertions. A public key credential source consists of a struct with the following items:

    type
    @@ -1644,86 +2228,86 @@

    credential private key.

    rpId
    -

    The Relying Party Identifier, for the Relying Party this public key credential source is scoped to. +

    The Relying Party Identifier, for the Relying Party this public key credential source is scoped to. This is determined by the rp.id parameter of the create() operation.

    userHandle
    -

    The user handle associated when this public key credential source was created. This item is -nullable.

    +

    The user handle associated when this public key credential source was created. This item is +nullable, however user handle MUST always be populated for discoverable credentials.

    otherUI
    -

    OPTIONAL other information used by the authenticator to inform its UI. For example, this might include the user’s displayName. otherUI is a mutable item and SHOULD NOT be bound to the public key credential source in a way that prevents otherUI from being updated.

    +

    OPTIONAL other information used by the authenticator to inform its UI. For example, this might include the user’s displayName. otherUI is a mutable item and SHOULD NOT be bound to the public key credential source in a way that prevents otherUI from being updated.

    -

    The authenticatorMakeCredential operation creates a public key credential source bound to a authenticatorMakeCredential operation creates a public key credential source bound to a managing authenticator and returns the credential public key associated with its credential -private key. The Relying Party can use this credential public key to verify the authentication assertions created by -this public key credential source.

    +private key. The Relying Party can use this credential public key to verify the authentication assertions created by +this public key credential source.

    Rate Limiting

    The process (also known as throttling) by which an authenticator implements controls against brute force attacks by limiting the number of consecutive failed authentication attempts within a given period of time. If the limit is reached, the authenticator should impose a delay that increases exponentially with each successive attempt, or disable the current -authentication modality and offer a different authentication factor if available. Rate limiting is often implemented as an -aspect of user verification.

    +authentication modality and offer a different authentication factor if available. Rate limiting is often implemented as an +aspect of user verification.

    Registration
    Registration Ceremony
    -

    The ceremony where a user, a Relying Party, and the user’s client platform (containing or connected to at least one authenticator) work in concert to create a public key credential and associate it with a user account. -Note that this includes employing a test of user presence or user verification. -After a successful registration ceremony, the user can be authenticated by an authentication ceremony.

    +

    The ceremony where a user, a Relying Party, and the user’s client platform (containing or connected to at least one authenticator) work in concert to create a public key credential and associate it with a user account. +Note that this includes employing a test of user presence or user verification. +After a successful registration ceremony, the user can be authenticated by an authentication ceremony.

    The WebAuthn registration ceremony is defined in § 7.1 Registering a New Credential, -and is initiated by the Relying Party invoking a navigator.credentials.create() operation +and is initiated by the Relying Party invoking a navigator.credentials.create() operation with a publicKey argument. See § 5 Web Authentication API for an introductory overview and § 1.3.1 Registration for implementation examples.

    Relying Party
    WebAuthn Relying Party

    The entity whose web application utilizes the Web Authentication API to register and authenticate users.

    -

    A Relying Party implementation typically consists of both some client-side script +

    A Relying Party implementation typically consists of both some client-side script that invokes the Web Authentication API in the client, and a server-side component that executes the Relying Party operations and other application logic. Communication between the two components MUST use HTTPS or equivalent transport security, but is otherwise beyond the scope of this specification.

    -

    Note: While the term Relying Party is also often used in other contexts (e.g., X.509 and OAuth), an entity acting as a Relying Party in one - context is not necessarily a Relying Party in other contexts. In this specification, the term WebAuthn Relying Party is often shortened - to be just Relying Party, and explicitly refers to a Relying Party in the WebAuthn context. Note that in any concrete instantiation +

    Note: While the term Relying Party is also often used in other contexts (e.g., X.509 and OAuth), an entity acting as a Relying Party in one + context is not necessarily a Relying Party in other contexts. In this specification, the term WebAuthn Relying Party is often shortened + to be just Relying Party, and explicitly refers to a Relying Party in the WebAuthn context. Note that in any concrete instantiation a WebAuthn context may be embedded in a broader overall context, e.g., one based on OAuth.

    Relying Party Identifier
    RP ID

    In the context of the WebAuthn API, a relying party identifier is a valid domain string identifying the WebAuthn Relying Party on whose behalf a given registration or authentication ceremony is being performed. A public key credential can only be used for authentication with the same entity (as identified by RP ID) it was registered with.

    By default, the RP ID for a -WebAuthn operation is set to the caller’s origin's effective domain. This default MAY be -overridden by the caller, as long as the caller-specified RP ID value is a registrable domain suffix of or is equal -to the caller’s origin's effective domain. See also § 5.1.3 Create a New Credential - PublicKeyCredential’s [[Create]](origin, options, sameOriginWithAncestors) Method and § 5.1.4 Use an Existing Credential to Make an Assertion - PublicKeyCredential’s [[Get]](options) Method.

    +WebAuthn operation is set to the caller’s origin's effective domain. This default MAY be +overridden by the caller, as long as the caller-specified RP ID value is a registrable domain suffix of or is equal +to the caller’s origin's effective domain. See also § 5.1.3 Create a New Credential - PublicKeyCredential’s [[Create]](origin, options, sameOriginWithAncestors) Method and § 5.1.4 Use an Existing Credential to Make an Assertion - PublicKeyCredential’s [[Get]](options) Method.

    Note: An RP ID is based on a host's domain name. It does not itself include a scheme or port, as an origin does. The RP ID of a public key credential determines its scope. I.e., it determines the set of origins on which the public key credential may be exercised, as follows: -

    For example, given a Relying Party whose origin is https://login.example.com:1337, then the following RP IDs are valid: login.example.com (default) and example.com, but not m.login.example.com and not com.

    -

    This is done in order to match the behavior of pervasively deployed ambient credentials (e.g., cookies, [RFC6265]). +

    For example, given a Relying Party whose origin is https://login.example.com:1337, then the following RP IDs are valid: login.example.com (default) and example.com, but not m.login.example.com and not com.

    +

    This is done in order to match the behavior of pervasively deployed ambient credentials (e.g., cookies, [RFC6265]). Please note that this is a greater relaxation of "same-origin" restrictions than what document.domain's setter provides.

    These restrictions on origin values apply to WebAuthn Clients.

    -

    Other specifications mimicking the WebAuthn API to enable WebAuthn public key credentials on non-Web platforms (e.g. native mobile applications), MAY define different rules for binding a caller to a Relying Party Identifier. Though, the RP ID syntaxes MUST conform to either valid domain strings or URIs [RFC3986] [URL].

    +

    Other specifications mimicking the WebAuthn API to enable WebAuthn public key credentials on non-Web platforms (e.g. native mobile applications), MAY define different rules for binding a caller to a Relying Party Identifier. Though, the RP ID syntaxes MUST conform to either valid domain strings or URIs [RFC3986] [URL].

    Server-side Public Key Credential Source
    Server-side Credential
    [DEPRECATED] Non-Resident Credential
    -

    Note: Historically, server-side credentials have been known as non-resident credentials. +

    Note: Historically, server-side credentials have been known as non-resident credentials. For backwards compatibility purposes, the various WebAuthn API and Authenticator Model components with various forms of resident within their names have not been changed.

    A Server-side Public Key Credential Source, or Server-side Credential for short, -is a public key credential source that is only usable in an authentication ceremony when the Relying Party supplies its credential ID in navigator.credentials.get()'s allowCredentials argument. This means that the Relying Party must +is a public key credential source that is only usable in an authentication ceremony when the Relying Party supplies its credential ID in navigator.credentials.get()'s allowCredentials argument. This means that the Relying Party must manage the credential’s storage and discovery, as well as be able to first identify the user in order to discover the credential IDs to supply in the navigator.credentials.get() call.

    -

    Client-side storage of the public key credential source is not required for a server-side credential. +

    Client-side storage of the public key credential source is not required for a server-side credential. This is in contrast to a client-side discoverable credential, which instead does not require the user to first be identified in order to provide the user’s credential IDs to a navigator.credentials.get() call.

    @@ -1731,34 +2315,35 @@

    Test of User Presence

    A test of user presence is a simple form of authorization gesture and technical process where a user interacts with -an authenticator by (typically) simply touching it (other modalities may also exist), yielding a Boolean result. Note -that this does not constitute user verification because a user presence test, by definition, +an authenticator by (typically) simply touching it (other modalities may also exist), yielding a Boolean result. Note +that this does not constitute user verification because a user presence test, by definition, is not capable of biometric recognition, nor does it involve the presentation of a shared secret such as a password or PIN.

    User Account

    In the context of this specification, -a user account denotes the mapping of a set of credentials [CREDENTIAL-MANAGEMENT-1] to a (sub)set of a Relying Party's resources, as maintained and authorized by the Relying Party. -The Relying Party maps a given public key credential to a user account by assigning a user account-specific value to the credential’s user handle and storing a credential record for the credential in the user account. +a user account denotes the mapping of a set of credentials [CREDENTIAL-MANAGEMENT-1] to a (sub)set of a Relying Party's resources, as maintained and authorized by the Relying Party. +The Relying Party maps a given public key credential to a user account by assigning a user account-specific value to the credential’s user handle and storing a credential record for the credential in the user account. This mapping, the set of credentials, and their authorizations, may evolve over time. A given user account might be accessed by one or more natural persons (also known as "users"), and one natural person might have access to one or more user accounts, -depending on actions of the user(s) and the Relying Party.

    +depending on actions of the user(s) and the Relying Party.

    User Consent

    User consent means the user agrees with what they are being asked, i.e., it encompasses reading and understanding prompts. An authorization gesture is a ceremony component often employed to indicate user consent.

    User Handle
    -

    A user handle is an identifier for a user account, specified by the Relying Party as user.id during registration. Discoverable credentials store this identifier and return it as response.userHandle in authentication ceremonies started with an empty allowCredentials argument.

    -

    The main use of the user handle is to identify the user account in such authentication ceremonies, +

    A user handle is an identifier for a user account, specified by the Relying Party as user.id during registration. Discoverable credentials store this identifier and MUST return it as response.userHandle in authentication ceremonies started with an empty allowCredentials argument.

    +

    The main use of the user handle is to identify the user account in such authentication ceremonies, but the credential ID could be used instead. The main differences are -that the credential ID is chosen by the authenticator and unique for each credential, -while the user handle is chosen by the Relying Party and ought to be the same -for all credentials registered to the same user account.

    -

    Authenticators map pairs of RP ID and user handle to public key credential sources. -As a consequence, an authenticator will store at most one discoverable credential per user handle per Relying Party.

    +that the credential ID is chosen by the authenticator and is unique for each credential, +while the user handle is chosen by the Relying Party and ought to be the same +for all credentials registered to the same user account.

    +

    Authenticators map pairs of RP ID and user handle to public key credential sources. +As a consequence, an authenticator will store at most one discoverable credential per user handle per Relying Party. Therefore +a secondary use of the user handle is to allow authenticators to know when to replace an existing discoverable credential with a new one during the registration ceremony.

    A user handle is an opaque byte sequence with a maximum size of 64 bytes, and is not meant to be displayed to the user. It MUST NOT contain personally identifying information, see § 14.6.1 User Handle Contents.

    User Present @@ -1767,32 +2352,33 @@

    present".

    User Verification
    -

    The technical process by which an authenticator locally authorizes the invocation of the authenticatorMakeCredential and authenticatorGetAssertion operations. User verification MAY be instigated -through various authorization gesture modalities; for example, through a touch plus pin code, password entry, or biometric recognition (e.g., presenting a fingerprint) [ISOBiometricVocabulary]. The intent is to -distinguish individual users.

    -

    Note that user verification does not give the Relying Party a concrete identification of the user, -but when 2 or more ceremonies with user verification have been done with that credential it expresses that it was the same user that performed all of them. +

    The technical process by which an authenticator locally authorizes the invocation of the authenticatorMakeCredential and authenticatorGetAssertion operations. User verification MAY be instigated +through various authorization gesture modalities; for example, through a touch plus pin code, password entry, or biometric recognition (e.g., presenting a fingerprint) [ISOBiometricVocabulary]. The intent is to +distinguish individual users. +See also § 6.2.3 Authentication Factor Capability.

    +

    Note that user verification does not give the Relying Party a concrete identification of the user, +but when 2 or more ceremonies with user verification have been done with that credential it expresses that it was the same user that performed all of them. The same user might not always be the same natural person, however, -if multiple natural persons share access to the same authenticator.

    -

    Note: Distinguishing natural persons depends in significant part upon the client platform's -and authenticator's capabilities. +if multiple natural persons share access to the same authenticator.

    +

    Note: Distinguishing natural persons depends in significant part upon the client platform's +and authenticator's capabilities. For example, some devices are intended to be used by a single individual, yet they may allow multiple natural persons to enroll fingerprints or know the same PIN and thus access the same user account(s) using that device.

    Note: Invocation of the authenticatorMakeCredential and authenticatorGetAssertion operations implies use of key material managed by the authenticator. -

    Also, for security, user verification and use of credential private keys must all occur within the logical security boundary defining the authenticator.

    +

    Also, for security, user verification and use of credential private keys must all occur within the logical security boundary defining the authenticator.

    -

    User verification procedures MAY implement rate limiting as a protection against brute force attacks.

    +

    User verification procedures MAY implement rate limiting as a protection against brute force attacks.

    User Verified
    -

    Upon successful completion of a user verification process, the user is said to be "verified".

    +

    Upon successful completion of a user verification process, the user is said to be "verified".

    5. Web Authentication API

    This section normatively specifies the API for creating and using public key credentials. The basic -idea is that the credentials belong to the user and are managed by a WebAuthn Authenticator, with which the WebAuthn Relying Party interacts through the client platform. Relying Party scripts can (with the user’s consent) request the -browser to create a new credential for future use by the Relying Party. See Figure , below.

    +idea is that the credentials belong to the user and are managed by a WebAuthn Authenticator, with which the WebAuthn Relying Party interacts through the client platform. Relying Party scripts can (with the user’s consent) request the +browser to create a new credential for future use by the Relying Party. See Figure , below.

    Registration Flow
    @@ -1816,41 +2402,25 @@

    5. a different origin, by incorporating the origin in its responses. Specifically, as defined in § 6.3 Authenticator Operations, the full origin of the requester is included, and signed over, in the attestation object produced when a new credential is created as well as in all assertions produced by WebAuthn credentials.

    -

    Additionally, to maintain user privacy and prevent malicious Relying Parties from probing for the presence of public key -credentials belonging to other Relying Parties, each credential is also scoped to a Relying Party -Identifier, or RP ID. This RP ID is provided by the client to the authenticator for all operations, and the authenticator ensures that credentials created by a Relying Party can only be used in operations +

    Additionally, to maintain user privacy and prevent malicious Relying Parties from probing for the presence of public key +credentials belonging to other Relying Parties, each credential is also scoped to a Relying Party +Identifier, or RP ID. This RP ID is provided by the client to the authenticator for all operations, and the authenticator ensures that credentials created by a Relying Party can only be used in operations requested by the same RP ID. Separating the origin from the RP ID in this way allows the API to be used in cases -where a single Relying Party maintains multiple origins.

    -

    The client facilitates these security measures by providing the Relying Party's origin and RP ID to the authenticator for +where a single Relying Party maintains multiple origins.

    +

    The client facilitates these security measures by providing the Relying Party's origin and RP ID to the authenticator for each operation. Since this is an integral part of the WebAuthn security model, user agents only expose this API to callers in secure contexts. For web contexts in particular, this only includes those accessed via a secure transport (e.g., TLS) established without errors.

    The Web Authentication API is defined by the union of the Web IDL fragments presented in the following sections. A combined IDL listing is given in the IDL Index.

    5.1. PublicKeyCredential Interface

    -
    - -
    -

    PublicKeyCredential

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile? -
    -
    -
    -

    The PublicKeyCredential interface inherits from Credential [CREDENTIAL-MANAGEMENT-1], and contains the attributes +

    The PublicKeyCredential interface inherits from Credential [CREDENTIAL-MANAGEMENT-1], and contains the attributes that are returned to the caller when a new credential is created, or a new assertion is requested.

    [SecureContext, Exposed=Window]
     interface PublicKeyCredential : Credential {
         [SameObject] readonly attribute ArrayBuffer              rawId;
         [SameObject] readonly attribute AuthenticatorResponse    response;
    -    [SameObject] readonly attribute DOMString?               authenticatorAttachment;
    +    readonly attribute DOMString?                            authenticatorAttachment;
         AuthenticationExtensionsClientOutputs getClientExtensionResults();
         static Promise<boolean> isConditionalMediationAvailable();
         PublicKeyCredentialJSON toJSON();
    @@ -1861,78 +2431,27 @@ 

    This attribute is inherited from Credential, though PublicKeyCredential overrides Credential's getter, instead returning the base64url encoding of the data contained in the object’s [[identifier]] internal slot.

    -
    -
    - -
    -

    PublicKeyCredential/rawId

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile? -
    -
    -
    -

    rawId

    +
    rawId

    This attribute returns the ArrayBuffer contained in the [[identifier]] internal slot.

    -
    -
    - -
    -

    PublicKeyCredential/response

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile? -
    -
    -
    -

    response, of type AuthenticatorResponse, readonly

    +
    response, of type AuthenticatorResponse, readonly
    -

    This attribute contains the authenticator's response to the client’s request to either create a public key +

    This attribute contains the authenticator's response to the client’s request to either create a public key credential, or generate an authentication assertion. If the PublicKeyCredential is created in response to create(), this attribute’s value will be an AuthenticatorAttestationResponse, otherwise, the PublicKeyCredential was created in response to get(), and this attribute’s value will be an AuthenticatorAssertionResponse.

    authenticatorAttachment, of type DOMString, readonly, nullable

    This attribute reports the authenticator attachment modality in effect at the time the navigator.credentials.create() or navigator.credentials.get() methods successfully complete. -The attribute’s value SHOULD be a member of AuthenticatorAttachment. Relying Parties SHOULD treat unknown values +The attribute’s value SHOULD be a member of AuthenticatorAttachment. Relying Parties SHOULD treat unknown values as if the value were null.

    - Note: If, as the result of a registration or authentication ceremony, authenticatorAttachment's value is "cross-platform" and -concurrently isUserVerifyingPlatformAuthenticatorAvailable returns true, then the user employed a roaming authenticator for this ceremony while there is an available platform authenticator. Thus the Relying Party has the opportunity to prompt the user to register the available platform authenticator, which may enable more streamlined user experience flows. -

    An authenticator’s attachment modality could change over time. + Note: If, as the result of a registration or authentication ceremony, authenticatorAttachment's value is "cross-platform" and +concurrently isUserVerifyingPlatformAuthenticatorAvailable returns true, then the user employed a roaming authenticator for this ceremony while there is an available platform authenticator. Thus the Relying Party has the opportunity to prompt the user to register the available platform authenticator, which may enable more streamlined user experience flows. +

    An authenticator’s attachment modality could change over time. For example, a mobile phone might at one time only support platform attachment but later receive updates to support cross-platform attachment as well.

    -
    -
    - -
    -

    PublicKeyCredential/getClientExtensionResults

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile? -
    -
    -
    -

    getClientExtensionResults()

    +
    getClientExtensionResults()

    This operation returns the value of [[clientExtensionsResults]], which is a map containing extension identifierclient extension output entries produced by the extension’s client extension processing.

    isConditionalMediationAvailable() @@ -1940,51 +2459,67 @@

    PublicKeyCredential overrides this method to indicate availability for conditional mediation. WebAuthn Relying Parties SHOULD verify availability before attempting to set options.mediation to conditional.

    Upon invocation, a promise is returned that resolves with a value of true if conditional user mediation is available, or false otherwise.

    This method has no arguments and returns a promise to a Boolean value.

    -

    Note: If this method is not present, conditional user mediation is not available.

    +

    Note: If this method is not present, conditional user mediation is not available.

    toJSON()

    This operation returns RegistrationResponseJSON or AuthenticationResponseJSON, -which are JSON type representations mirroring PublicKeyCredential, suitable for submission to a Relying Party server as an application/json payload. The client is in charge of serializing values to JSON types as usual, +which are JSON type representations mirroring PublicKeyCredential, suitable for submission to a Relying Party server as an application/json payload. The client is in charge of serializing values to JSON types as usual, but MUST take additional steps to first encode any ArrayBuffer values to DOMString values using base64url encoding.

    The RegistrationResponseJSON.clientExtensionResults or AuthenticationResponseJSON.clientExtensionResults member MUST be set to the output of getClientExtensionResults(), with any ArrayBuffer values encoded to DOMString values using base64url encoding. This MAY include ArrayBuffer values from extensions registered -in the IANA "WebAuthn Extension Identifiers" registry [IANA-WebAuthn-Registries] but not +in the IANA "WebAuthn Extension Identifiers" registry [IANA-WebAuthn-Registries] but not defined in § 9 WebAuthn Extensions.

    The AuthenticatorAttestationResponseJSON.transports member MUST be set to the output of getTransports().

    +

    The AuthenticatorAttestationResponseJSON.publicKey member MUST be set to the output of getPublicKey().

    +

    The AuthenticatorAttestationResponseJSON.publicKeyAlgorithm member MUST be set to the output of getPublicKeyAlgorithm().

    typedef DOMString Base64URLString;
    -typedef (RegistrationResponseJSON or AuthenticationResponseJSON) PublicKeyCredentialJSON;
    +// The structure of this object will be either
    +// RegistrationResponseJSON or AuthenticationResponseJSON
    +typedef object PublicKeyCredentialJSON;
     
     dictionary RegistrationResponseJSON {
    -    Base64URLString id;
    -    Base64URLString rawId;
    -    AuthenticatorAttestationResponseJSON response;
    -    DOMString?  authenticatorAttachment;
    -    AuthenticationExtensionsClientOutputsJSON clientExtensionResults;
    -    DOMString type;
    +    required Base64URLString id;
    +    required Base64URLString rawId;
    +    required AuthenticatorAttestationResponseJSON response;
    +    DOMString authenticatorAttachment;
    +    required AuthenticationExtensionsClientOutputsJSON clientExtensionResults;
    +    required DOMString type;
     };
     
     dictionary AuthenticatorAttestationResponseJSON {
    -    Base64URLString clientDataJSON;
    -    Base64URLString attestationObject;
    -    sequence<DOMString> transports;
    +    required Base64URLString clientDataJSON;
    +    required Base64URLString authenticatorData;
    +    required sequence<DOMString> transports;
    +    // The publicKey field will be missing if pubKeyCredParams was used to
    +    // negotiate a public-key algorithm that the user agent doesn’t
    +    // understand. (See section “Easily accessing credential data” for a
    +    // list of which algorithms user agents must support.) If using such an
    +    // algorithm then the public key must be parsed directly from
    +    // attestationObject or authenticatorData.
    +    Base64URLString publicKey;
    +    required long long publicKeyAlgorithm;
    +    // This value contains copies of some of the fields above. See
    +    // section “Easily accessing credential data”.
    +    required Base64URLString attestationObject;
     };
     
     dictionary AuthenticationResponseJSON {
    -    Base64URLString id;
    -    Base64URLString rawId;
    -    AuthenticatorAssertionResponseJSON response;
    -    DOMString?  authenticatorAttachment;
    -    AuthenticationExtensionsClientOutputsJSON clientExtensionResults;
    -    DOMString type;
    +    required Base64URLString id;
    +    required Base64URLString rawId;
    +    required AuthenticatorAssertionResponseJSON response;
    +    DOMString authenticatorAttachment;
    +    required AuthenticationExtensionsClientOutputsJSON clientExtensionResults;
    +    required DOMString type;
     };
     
     dictionary AuthenticatorAssertionResponseJSON {
    -    Base64URLString clientDataJSON;
    -    Base64URLString authenticatorData;
    -    Base64URLString signature;
    -    Base64URLString? userHandle;
    +    required Base64URLString clientDataJSON;
    +    required Base64URLString authenticatorData;
    +    required Base64URLString signature;
    +    Base64URLString userHandle;
    +    Base64URLString attestationObject;
     };
     
     dictionary AuthenticationExtensionsClientOutputsJSON {
    @@ -1995,7 +2530,7 @@ 

    The PublicKeyCredential interface object's [[type]] internal slot's value is the string "public-key".

    -

    Note: This is reflected via the type attribute getter inherited from Credential.

    +

    Note: This is reflected via the type attribute getter inherited from Credential.

    [[discovery]]

    The PublicKeyCredential interface object's [[discovery]] internal slot's value is @@ -2005,15 +2540,15 @@

    This internal slot contains the credential ID, chosen by the authenticator. The credential ID is used to look up credentials for use, and is therefore expected to be globally unique with high probability across all credentials of the same type, across all authenticators.

    -

    Note: This API does not constrain -the format or length of this identifier, except that it MUST be sufficient for the authenticator to uniquely select a key. +

    Note: This API does not constrain +the format or length of this identifier, except that it MUST be sufficient for the authenticator to uniquely select a key. For example, an authenticator without on-board storage may create identifiers containing a credential private key wrapped with a symmetric key that is burned into the authenticator.

    [[clientExtensionsResults]]
    -

    This internal slot contains the results of processing client extensions requested by the Relying Party upon the Relying Party's invocation of either navigator.credentials.create() or navigator.credentials.get().

    +

    This internal slot contains the results of processing client extensions requested by the Relying Party upon the Relying Party's invocation of either navigator.credentials.create() or navigator.credentials.get().

    -

    PublicKeyCredential's interface object inherits Credential's implementation of [[CollectFromCredentialStore]](origin, options, sameOriginWithAncestors), and defines its own -implementation of [[Create]](origin, options, sameOriginWithAncestors), [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors), and [[Store]](credential, sameOriginWithAncestors).

    +

    PublicKeyCredential's interface object inherits Credential's implementation of [[CollectFromCredentialStore]](origin, options, sameOriginWithAncestors), and defines its own +implementation of each of [[Create]](origin, options, sameOriginWithAncestors), [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors), and [[Store]](credential, sameOriginWithAncestors).

    5.1.1. CredentialCreationOptions Dictionary Extension

    To support registration via navigator.credentials.create(), this document extends the CredentialCreationOptions dictionary as follows:

    @@ -2030,7 +2565,7 @@

    5.1.3. Create a New Credential - PublicKeyCredential’s [[Create]](origin, options, sameOriginWithAncestors) Method

    PublicKeyCredential's interface object's implementation of the [[Create]](origin, -options, sameOriginWithAncestors) internal method [CREDENTIAL-MANAGEMENT-1] allows WebAuthn Relying Party scripts to call navigator.credentials.create() to request the creation of a new public key credential source, bound to an authenticator. This navigator.credentials.create() operation can be aborted by leveraging the AbortController; +options, sameOriginWithAncestors) internal method [CREDENTIAL-MANAGEMENT-1] allows WebAuthn Relying Party scripts to call navigator.credentials.create() to request the creation of a new public key credential source, bound to an authenticator. This navigator.credentials.create() operation can be aborted by leveraging the AbortController; see DOM § 3.3 Using AbortController and AbortSignal objects in APIs for detailed instructions.

    This internal method accepts three arguments:

    @@ -2044,9 +2579,11 @@

    sameOriginWithAncestors

    This argument is a Boolean value which is true if and only if the caller’s environment settings object is same-origin with its ancestors. It is false if caller is cross-origin.

    +

    Note: Invocation of this internal method indicates that it was allowed by permissions policy, which is evaluated at the [CREDENTIAL-MANAGEMENT-1] level. +See § 5.9 Permissions Policy integration.

    -

    Note: This algorithm is synchronous: the Promise resolution/rejection is handled by navigator.credentials.create().

    -

    Note: All BufferSource objects used in this algorithm must be snapshotted when the algorithm begins, to +

    Note: This algorithm is synchronous: the Promise resolution/rejection is handled by navigator.credentials.create().

    +

    Note: All BufferSource objects used in this algorithm must be snapshotted when the algorithm begins, to avoid potential synchronization issues. The algorithm implementations should get a copy of the bytes held by the buffer source and use that copy for relevant portions of the algorithm.

    When this method is invoked, the user agent MUST execute the following algorithm:

    @@ -2054,38 +2591,36 @@

    Assert: options.publicKey is present.

  • -

    If sameOriginWithAncestors is false, throw a "NotAllowedError" DOMException.

    -

    Note: This "sameOriginWithAncestors" restriction aims to address a tracking concern raised in Issue #1336. This may be revised in future versions of this specification.

    +

    If sameOriginWithAncestors is false:

    +
      +
    1. +

      If the relevant global object, as determined by the calling create() implementation, does not have transient activation:

      +
        +
      1. +

        Throw a "NotAllowedError" DOMException.

        +
      +
    2. +

      Consume user activation of the relevant global object.

      +
    +

    NOTE: The client SHOULD make it clear to the user in the case where the origin that is creating a credential is different from the top-level origin of the relevant global object (i.e., is a + different origin than the user can see in the address bar).

  • Let pkOptions be the value of options.publicKey.

  • If pkOptions.timeout is present, check if its value lies within a -reasonable range as defined by the client and if not, correct it to the closest value lying within that range. Set a timer lifetimeTimer to this adjusted value. If pkOptions.timeout is not -present, then set lifetimeTimer to a client-specific default.

    -

    Recommended ranges and defaults for pkOptions.timeout are as follows. - If pkOptions.authenticatorSelection.userVerification

    -
    -
    is set to discouraged -
    -

    Recommended range: 30000 milliseconds to 180000 milliseconds.

    -
    -

    Recommended default value: 120000 milliseconds (2 minutes).

    -
    is set to required or preferred -
    -

    Recommended range: 30000 milliseconds to 600000 milliseconds.

    -
    -

    Recommended default value: 300000 milliseconds (5 minutes).

    -
    -

    Note: The user agent should take cognitive guidelines into considerations regarding timeout for users with special needs.

    +reasonable range as defined by the client and if not, correct it to the closest value lying within that range. Set a timer lifetimeTimer to this adjusted value. If pkOptions.timeout is not +present, then set lifetimeTimer to a client-specific default.

    +

    See the recommended range and default for a WebAuthn ceremony timeout for guidance on deciding a reasonable range and default for pkOptions.timeout.

    +

    Note: The user agent should take cognitive guidelines into considerations regarding timeout for users with special needs.

  • If the length of pkOptions.user.id is not between 1 and 64 bytes (inclusive) then throw a TypeError.

  • Let callerOrigin be origin. If callerOrigin is an opaque origin, throw a "NotAllowedError" DOMException.

  • -

    Let effectiveDomain be the callerOrigin’s effective domain. -If effective domain is not a valid domain, then throw a +

    Let effectiveDomain be the callerOrigin’s effective domain. +If effective domain is not a valid domain, then throw a "SecurityError" DOMException.

    -

    Note: An effective domain may resolve to a host, which can be represented in various manners, +

    Note: An effective domain may resolve to a host, which can be represented in various manners, such as domain, ipv4 address, ipv6 address, opaque host, or empty host. Only the domain format of host is allowed here. This is for simplification and also is in recognition of various issues with using direct IP address identification in concert @@ -2096,14 +2631,14 @@

    is present
    -

    If pkOptions.rp.id is not a +

    If pkOptions.rp.id is not a registrable domain suffix of and is not equal to effectiveDomain, throw a "SecurityError" DOMException.

    Is not present

    Set pkOptions.rp.id to effectiveDomain.

    -

    Note: pkOptions.rp.id represents the - caller’s RP ID. The RP ID defaults to being the caller’s origin's effective domain unless the caller has explicitly set pkOptions.rp.id when calling create().

    +

    Note: pkOptions.rp.id represents the + caller’s RP ID. The RP ID defaults to being the caller’s origin's effective domain unless the caller has explicitly set pkOptions.rp.id when calling create().

  • Let credTypesAndPubKeyAlgs be a new list whose items are pairs of PublicKeyCredentialType and a COSEAlgorithmIdentifier.

    @@ -2135,8 +2670,8 @@

  • Let clientExtensions be a new map and let authenticatorExtensions be a new map.

    -
  • -

    If pkOptions.extensions is present, then for each extensionIdclientExtensionInput of pkOptions.extensions:

    +
  • + If pkOptions.extensions is present, then for each extensionIdclientExtensionInput of pkOptions.extensions:
    1. If extensionId is not supported by this client platform or is not a registration extension, then continue.

      @@ -2160,10 +2695,14 @@

      The base64url encoding of pkOptions.challenge.

      origin
      -

      The serialization of callerOrigin.

      +

      The serialization of callerOrigin.

      +
      topOrigin +
      +

      The serialization of callerOrigin’s top-level origin if +the sameOriginWithAncestors argument passed to this internal method is false, else undefined.

      crossOrigin
      -

      The inverse of the value of the sameOriginWithAncestors argument passed to this internal method.

      +

      The inverse of the value of the sameOriginWithAncestors argument passed to this internal method.

    2. Let clientDataJSON be the JSON-compatible serialization of client data constructed from collectedClientData.

      @@ -2175,14 +2714,16 @@

      Let issuedRequests be a new ordered set.

    3. -

      Let authenticators represent a value which at any given instant is a set of client platform-specific handles, where each item identifies an authenticator presently available on this client platform at that instant.

      -

      Note: What qualifies an authenticator as "available" is intentionally unspecified; this is meant to represent how authenticators can be hot-plugged into (e.g., via USB) -or discovered (e.g., via NFC or Bluetooth) by the client by various mechanisms, or permanently built into the client.

      +

      Let authenticators represent a value which at any given instant is a set of client platform-specific handles, where each item identifies an authenticator presently available on this client platform at that instant.

      +

      Note: What qualifies an authenticator as "available" is intentionally unspecified; this is meant to represent how authenticators can be hot-plugged into (e.g., via USB) +or discovered (e.g., via NFC or Bluetooth) by the client by various mechanisms, or permanently built into the client.

    4. -

      Start lifetimeTimer.

      +

      Consider the value of hints and craft the user interface accordingly, as the user-agent sees fit.

    5. -

      While lifetimeTimer has not expired, perform the following actions depending upon lifetimeTimer, -and the state and response for each authenticator in authenticators:

      +

      Start lifetimeTimer.

      +
    6. + While lifetimeTimer has not expired, perform the following actions depending upon lifetimeTimer, + and the state and response for each authenticator in authenticators:
      If lifetimeTimer expires,
      @@ -2195,18 +2736,18 @@

      For each authenticator in issuedRequests invoke the authenticatorCancel operation on authenticator and remove authenticator from issuedRequests. Then throw the options.signal’s abort reason.

      If an authenticator becomes available on this client device,
      -

      Note: This includes the case where an authenticator was available upon lifetimeTimer initiation.

      +

      Note: This includes the case where an authenticator was available upon lifetimeTimer initiation.

      1. This authenticator is now the candidate authenticator.

      2. -

        If pkOptions.authenticatorSelection is present:

        +

        If pkOptions.authenticatorSelection is present:

        1. -

          If pkOptions.authenticatorSelection.authenticatorAttachment is +

          If pkOptions.authenticatorSelection.authenticatorAttachment is present and its value is not equal to authenticator’s authenticator attachment modality, continue.

        2. -

          If pkOptions.authenticatorSelection.residentKey

          +

          If pkOptions.authenticatorSelection.residentKey

          is present and set to required
          @@ -2217,17 +2758,17 @@

          No effect.

          is not present
          -

          if pkOptions.authenticatorSelection.requireResidentKey is set to true and the authenticator is not capable of storing a client-side discoverable public +

          if pkOptions.authenticatorSelection.requireResidentKey is set to true and the authenticator is not capable of storing a client-side discoverable public key credential source, continue.

        3. -

          If pkOptions.authenticatorSelection.userVerification is -set to required and the authenticator is not capable of performing user +

          If pkOptions.authenticatorSelection.userVerification is +set to required and the authenticator is not capable of performing user verification, continue.

      3. Let requireResidentKey be the effective resident key requirement for credential creation, a Boolean value, as follows:

        -

        If pkOptions.authenticatorSelection.residentKey

        +

        If pkOptions.authenticatorSelection.residentKey

        is present and set to required
        @@ -2239,7 +2780,7 @@

        is capable of client-side credential storage modality

        Let requireResidentKey be true.

        -
        is not capable of client-side credential storage modality, or if the client cannot determine authenticator capability, +
        is not capable of client-side credential storage modality, or if the client cannot determine authenticator capability,

        Let requireResidentKey be false.

        @@ -2248,27 +2789,27 @@

        Let requireResidentKey be false.

        is not present
        -

        Let requireResidentKey be the value of pkOptions.authenticatorSelection.requireResidentKey.

        +

        Let requireResidentKey be the value of pkOptions.authenticatorSelection.requireResidentKey.

    7. Let userVerification be the effective user verification requirement for credential creation, a Boolean value, -as follows. If pkOptions.authenticatorSelection.userVerification

      +as follows. If pkOptions.authenticatorSelection.userVerification

      -
      is set to required +
      is set to required

      Let userVerification be true.

      -
      is set to preferred +
      is set to preferred

      If the authenticator

      -
      is capable of user verification +
      is capable of user verification

      Let userVerification be true.

      -
      is not capable of user verification +
      is not capable of user verification

      Let userVerification be false.

      -
      is set to discouraged +
      is set to discouraged

      Let userVerification be false.

      @@ -2282,6 +2823,15 @@

      Let enterpriseAttestationPossible be false.

      +
    8. +

      Let attestationFormats be a list of strings, initialized to the value of pkOptions.attestationFormats.

      +
    9. +

      If pkOptions.attestation

      +
      +
      is set to none +
      +

      Set attestationFormats be the single-element list containing the string “none”

      +
    10. Let excludeCredentialDescriptorList be a new list.

    11. @@ -2290,15 +2840,15 @@

      If C.transports is not empty, and authenticator is connected over a transport not mentioned in C.transports, the client MAY continue.

      -

      Note: If the client chooses to continue, this could result in -inadvertently registering multiple credentials bound to the same authenticator if the transport hints in C.transports are not accurate. +

      Note: If the client chooses to continue, this could result in +inadvertently registering multiple credentials bound to the same authenticator if the transport hints in C.transports are not accurate. For example, stored transport hints could become inaccurate as a result of software upgrades adding new connectivity options.

    12. Otherwise, Append C to excludeCredentialDescriptorList.

    13. -

      Invoke the authenticatorMakeCredential operation on authenticator with clientDataHash, pkOptions.rp, pkOptions.user, requireResidentKey, userVerification, credTypesAndPubKeyAlgs, excludeCredentialDescriptorList, enterpriseAttestationPossible, +

      Invoke the authenticatorMakeCredential operation on authenticator with clientDataHash, pkOptions.rp, pkOptions.user, requireResidentKey, userVerification, credTypesAndPubKeyAlgs, excludeCredentialDescriptorList, enterpriseAttestationPossible, attestationFormats, and authenticatorExtensions as parameters.

  • @@ -2314,7 +2864,7 @@

    Remove authenticator from issuedRequests.

  • For each remaining authenticator in issuedRequests invoke the authenticatorCancel operation on authenticator and remove it from issuedRequests.

    -

    Note: Authenticators may return an indication of "the user cancelled the entire operation". +

    Note: Authenticators may return an indication of "the user cancelled the entire operation". How a user agent manifests this state to users is unspecified.

    If any authenticator returns an error status equivalent to "InvalidStateError", @@ -2327,12 +2877,12 @@

    Throw an "InvalidStateError" DOMException.

    -

    Note: This error status is handled separately because the authenticator returns it only if excludeCredentialDescriptorList identifies a credential bound to the authenticator and the user has consented to the operation. Given this explicit consent, it is acceptable for this case to be -distinguishable to the Relying Party.

    +

    Note: This error status is handled separately because the authenticator returns it only if excludeCredentialDescriptorList identifies a credential bound to the authenticator and the user has consented to the operation. Given this explicit consent, it is acceptable for this case to be +distinguishable to the Relying Party.

    If any authenticator returns an error status not equivalent to "InvalidStateError",

    Remove authenticator from issuedRequests.

    -

    Note: This case does not imply user consent for the operation, so details about the error are hidden from the Relying Party in order to prevent leak of potentially identifying information. See § 14.5.1 Registration Ceremony Privacy for +

    Note: This case does not imply user consent for the operation, so details about the error are hidden from the Relying Party in order to prevent leak of potentially identifying information. See § 14.5.1 Registration Ceremony Privacy for details.

    If any authenticator indicates success,
    @@ -2345,13 +2895,13 @@

    attestationObjectResult

    whose value is the bytes returned from the successful authenticatorMakeCredential operation.

    -

    Note: this value is attObj, as defined in § 6.5.4 Generating an Attestation Object.

    +

    Note: this value is attObj, as defined in § 6.5.5 Generating an Attestation Object.

    clientDataJSONResult

    whose value is the bytes of clientDataJSON.

    attestationConveyancePreferenceOption
    -

    whose value is the value of pkOptions.attestation.

    +

    whose value is the value of pkOptions.attestation.

    clientExtensionResults

    whose value is an AuthenticationExtensionsClientOutputs object containing extension identifierclient extension output entries. The entries are created by running each extension’s client extension processing algorithm to create the client extension outputs, for each client extension in pkOptions.extensions.

    @@ -2362,29 +2912,29 @@

    If credentialCreationData.attestationConveyancePreferenceOption’s value is

    -
    none +
    none

    Replace potentially uniquely identifying information with non-identifying versions of the same:

    1. -

      If the AAGUID in the attested credential data is 16 zero bytes, credentialCreationData.attestationObjectResult.fmt is "packed", and "x5c" is absent from credentialCreationData.attestationObjectResult, then self attestation is being used and no further action is needed.

      +

      If the aaguid in the attested credential data is 16 zero bytes, credentialCreationData.attestationObjectResult.fmt is "packed", and "x5c" is absent from credentialCreationData.attestationObjectResult, then self attestation is being used and no further action is needed.

    2. Otherwise

      1. -

        Replace the AAGUID in the attested credential data with 16 zero bytes.

        +

        Replace the aaguid in the attested credential data with 16 zero bytes.

      2. -

        Set the value of credentialCreationData.attestationObjectResult.fmt to "none", and set the value of credentialCreationData.attestationObjectResult.attStmt to be an empty CBOR map. (See § 8.7 None Attestation Statement Format and § 6.5.4 Generating an Attestation Object).

        +

        Set the value of credentialCreationData.attestationObjectResult.fmt to "none", and set the value of credentialCreationData.attestationObjectResult.attStmt to be an empty CBOR map. (See § 8.7 None Attestation Statement Format and § 6.5.5 Generating an Attestation Object).

    indirect
    -

    The client MAY replace the AAGUID and attestation statement with a more privacy-friendly +

    The client MAY replace the aaguid and attestation statement with a more privacy-friendly and/or more easily verifiable version of the same data (for example, by employing an Anonymization CA).

    direct or enterprise
    -

    Convey the authenticator's AAGUID and attestation statement, unaltered, to the Relying Party.

    +

    Convey the authenticator's AAGUID and attestation statement, unaltered, to the Relying Party.

  • Let attestationObject be a new ArrayBuffer, created using global’s %ArrayBuffer%, containing the @@ -2413,9 +2963,9 @@

    [[transports]]

    A sequence of zero or more unique DOMStrings, in lexicographical order, that the authenticator is believed to support. The values SHOULD be members of AuthenticatorTransport, but client platforms MUST ignore unknown values.

    -

    If a user agent does not wish to divulge this information it MAY substitute an arbitrary sequence designed to preserve privacy. This sequence MUST still be valid, i.e. lexicographically sorted and free of duplicates. For example, it may use the empty sequence. Either way, in this case the user agent takes the risk that Relying Party behavior may be suboptimal.

    +

    If a user agent does not wish to divulge this information it MAY substitute an arbitrary sequence designed to preserve privacy. This sequence MUST still be valid, i.e. lexicographically sorted and free of duplicates. For example, it may use the empty sequence. Either way, in this case the user agent takes the risk that Relying Party behavior may be suboptimal.

    If the user agent does not have any transport information, it SHOULD set this field to the empty sequence.

    -

    Note: How user agents discover transports supported by a given authenticator is outside the scope of this specification, but may include information from an attestation certificate (for example [FIDO-Transports-Ext]), metadata communicated in an authenticator protocol such as CTAP2, or special-case knowledge about a platform authenticator.

    +

    Note: How user agents discover transports supported by a given authenticator is outside the scope of this specification, but may include information from an attestation certificate (for example [FIDO-Transports-Ext]), metadata communicated in an authenticator protocol such as CTAP2, or special-case knowledge about a platform authenticator.

    [[clientExtensionsResults]]
    @@ -2439,22 +2989,22 @@

    5.1.4. Use an Existing Credential to Make an Assertion - PublicKeyCredential’s [[Get]](options) Method

    WebAuthn Relying Parties call navigator.credentials.get({publicKey:..., ...}) to -discover and use an existing public key credential, with the user’s consent. Relying Party script optionally specifies some criteria -to indicate what public key credential sources are acceptable to it. The client platform locates public key credential sources matching the specified criteria, and guides the user to pick one that the script will be allowed to use. The user may choose to -decline the entire interaction even if a public key credential source is present, for example to maintain privacy. If the user picks a public key credential source, the user agent then uses § 6.3.3 The authenticatorGetAssertion Operation to sign a Relying Party-provided challenge and other collected data into an authentication assertion, which is used as a credential.

    -

    The navigator.credentials.get() implementation [CREDENTIAL-MANAGEMENT-1] calls PublicKeyCredential.[[CollectFromCredentialStore]]() to collect any credentials that +discover and use an existing public key credential, with the user’s consent. Relying Party script optionally specifies some criteria +to indicate what public key credential sources are acceptable to it. The client platform locates public key credential sources matching the specified criteria, and guides the user to pick one that the script will be allowed to use. The user may choose to +decline the entire interaction even if a public key credential source is present, for example to maintain privacy. If the user picks a public key credential source, the user agent then uses § 6.3.3 The authenticatorGetAssertion Operation to sign a Relying Party-provided challenge and other collected data into an authentication assertion, which is used as a credential.

    +

    The navigator.credentials.get() implementation [CREDENTIAL-MANAGEMENT-1] calls PublicKeyCredential.[[CollectFromCredentialStore]]() to collect any credentials that should be available without user mediation (roughly, this specification’s authorization gesture), and if it does not find exactly one of those, it then calls PublicKeyCredential.[[DiscoverFromExternalSource]]() to have -the user select a public key credential source.

    -

    Since this specification requires an authorization gesture to create any assertions, the PublicKeyCredential.[[CollectFromCredentialStore]](origin, options, sameOriginWithAncestors) internal method inherits the default behavior of Credential.[[CollectFromCredentialStore]](), of returning an empty set.

    +the user select a public key credential source.

    +

    Since this specification requires an authorization gesture to create any assertions, the PublicKeyCredential.[[CollectFromCredentialStore]](origin, options, sameOriginWithAncestors) internal method inherits the default behavior of Credential.[[CollectFromCredentialStore]](), of returning an empty set.

    In general, the user agent SHOULD show some UI to the user to guide them in selecting and authorizing an authenticator with which -to complete the operation. By setting options.mediation to conditional, Relying Parties can indicate that a prominent modal UI should not be shown unless credentials are discovered. Relying Party script SHOULD first check that isConditionalMediationAvailable() returns true in order to avoid +to complete the operation. By setting options.mediation to conditional, Relying Parties can indicate that a prominent modal UI should not be shown unless credentials are discovered. Relying Party script SHOULD first check that isConditionalMediationAvailable() returns true in order to avoid the possibility of causing a user-visible error to be returned if the user agent does not support conditional user mediation.

    This navigator.credentials.get() operation can be aborted by leveraging the AbortController; see DOM § 3.3 Using AbortController and AbortSignal objects in APIs for detailed instructions.

    5.1.4.1. PublicKeyCredential’s [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) Method
    -

    This internal method accepts three arguments:

    +

    This internal method accepts three arguments:

    origin
    @@ -2466,11 +3016,11 @@
    sameOriginWithAncestors

    This argument is a Boolean value which is true if and only if the caller’s environment settings object is same-origin with its ancestors. It is false if caller is cross-origin.

    -

    Note: Invocation of this internal method indicates that it was allowed by permissions policy, which is evaluated at the [CREDENTIAL-MANAGEMENT-1] level. +

    Note: Invocation of this internal method indicates that it was allowed by permissions policy, which is evaluated at the [CREDENTIAL-MANAGEMENT-1] level. See § 5.9 Permissions Policy integration.

    -

    Note: This algorithm is synchronous: the Promise resolution/rejection is handled by navigator.credentials.get().

    -

    Note: All BufferSource objects used in this algorithm must be snapshotted when the algorithm begins, to +

    Note: This algorithm is synchronous: the Promise resolution/rejection is handled by navigator.credentials.get().

    +

    Note: All BufferSource objects used in this algorithm must be snapshotted when the algorithm begins, to avoid potential synchronization issues. The algorithm implementations should get a copy of the bytes held by the buffer source and use that copy for relevant portions of the algorithm.

    When this method is invoked, the user agent MUST execute the following algorithm:

    @@ -2486,10 +3036,10 @@
    allowCredentials.

  • Set pkOptions.allowCredentials to empty.

    -

    Note: This prevents non-discoverable credentials from being used during conditional requests.

    +

    Note: This prevents non-discoverable credentials from being used during conditional requests.

  • Set a timer lifetimeTimer to a value of infinity.

    -

    Note: lifetimeTimer is set to a value of infinity so that the user has the entire lifetime of +

    Note: lifetimeTimer is set to a value of infinity so that the user has the entire lifetime of the Document to interact with any input form control tagged with a "webauthn" autofill detail token. For example, upon the user clicking in such an input field, the user agent can render a list of discovered credentials for the user to select from, and perhaps also give the user the option to "try another way".

  • @@ -2499,32 +3049,19 @@
  • 5.2.1.1. Easily accessing credential data
    -

    Every user of the [[Create]](origin, options, sameOriginWithAncestors) method will need to parse and store the returned credential public key in order to verify future authentication assertions. However, the credential public key is in COSE format [RFC9052], inside the credentialPublicKey member of the attestedCredentialData, inside the authenticator data, inside the attestation object conveyed by AuthenticatorAttestationResponse.attestationObject. Relying Parties wishing to use attestation are obliged to do the work of parsing the attestationObject and obtaining the credential public key because that public key copy is the one the authenticator signed. However, many valid WebAuthn use cases do not require attestation. For those uses, user agents can do the work of parsing, expose the authenticator data directly, and translate the credential public key into a more convenient format.

    -

    The getPublicKey() operation thus returns the credential public key as a SubjectPublicKeyInfo. This ArrayBuffer can, for example, be passed to Java’s java.security.spec.X509EncodedKeySpec, .NET’s System.Security.Cryptography.ECDsa.ImportSubjectPublicKeyInfo, or Go’s crypto/x509.ParsePKIXPublicKey.

    -

    Use of getPublicKey() does impose some limitations: by using pubKeyCredParams, a Relying Party can negotiate with the authenticator to use public key algorithms that the user agent may not understand. However, if the Relying Party does so, the user agent will not be able to translate the resulting credential public key into SubjectPublicKeyInfo format and the return value of getPublicKey() will be null.

    -

    User agents MUST be able to return a non-null value for getPublicKey() when the credential public key has a COSEAlgorithmIdentifier value of:

    +

    Every user of the [[Create]](origin, options, sameOriginWithAncestors) method will need to parse and store the returned credential public key in order to verify future authentication assertions. However, the credential public key is in COSE format [RFC9052], inside the credentialPublicKey member of the attestedCredentialData, inside the authenticator data, inside the attestation object conveyed by AuthenticatorAttestationResponse.attestationObject. Relying Parties wishing to use attestation are obliged to do the work of parsing the attestationObject and obtaining the credential public key because that public key copy is the one the authenticator signed. However, many valid WebAuthn use cases do not require attestation. For those uses, user agents can do the work of parsing, expose the authenticator data directly, and translate the credential public key into a more convenient format.

    +

    The getPublicKey() operation thus returns the credential public key as a SubjectPublicKeyInfo. This ArrayBuffer can, for example, be passed to Java’s java.security.spec.X509EncodedKeySpec, .NET’s System.Security.Cryptography.ECDsa.ImportSubjectPublicKeyInfo, or Go’s crypto/x509.ParsePKIXPublicKey.

    +

    Use of getPublicKey() does impose some limitations: by using pubKeyCredParams, a Relying Party can negotiate with the authenticator to use public key algorithms that the user agent may not understand. However, if the Relying Party does so, the user agent will not be able to translate the resulting credential public key into SubjectPublicKeyInfo format and the return value of getPublicKey() will be null.

    +

    User agents MUST be able to return a non-null value for getPublicKey() when the credential public key has a COSEAlgorithmIdentifier value of:

    • -7 (ES256), where kty is 2 (with uncompressed points) and crv is 1 (P-256).

      @@ -3147,35 +3645,20 @@

      -8 (EdDSA), where crv is 6 (Ed25519).

    -

    A SubjectPublicKeyInfo does not include information about the signing algorithm (for example, which hash function to use) that is included in the COSE public key. To provide this, getPublicKeyAlgorithm() returns the COSEAlgorithmIdentifier for the credential public key.

    -

    To remove the need to parse CBOR at all in many cases, getAuthenticatorData() returns the authenticator data from attestationObject. The authenticator data contains other fields that are encoded in a binary format. However, helper functions are not provided to access them because Relying Parties already need to extract those fields when getting an assertion. In contrast to credential creation, where signature verification is optional, Relying Parties should always be verifying signatures from an assertion and thus must extract fields from the signed authenticator data. The same functions used there will also serve during credential creation.

    -

    Note: getPublicKey() and getAuthenticatorData() were only added in level two of this spec. Relying Parties SHOULD use feature detection before using these functions by testing the value of 'getPublicKey' in AuthenticatorAttestationResponse.prototype. Relying Parties that require this function to exist may not interoperate with older user-agents.

    +

    A SubjectPublicKeyInfo does not include information about the signing algorithm (for example, which hash function to use) that is included in the COSE public key. To provide this, getPublicKeyAlgorithm() returns the COSEAlgorithmIdentifier for the credential public key.

    +

    To remove the need to parse CBOR at all in many cases, getAuthenticatorData() returns the authenticator data from attestationObject. The authenticator data contains other fields that are encoded in a binary format. However, helper functions are not provided to access them because Relying Parties already need to extract those fields when getting an assertion. In contrast to credential creation, where signature verification is optional, Relying Parties should always be verifying signatures from an assertion and thus must extract fields from the signed authenticator data. The same functions used there will also serve during credential creation.

    +

    Note: getPublicKey() and getAuthenticatorData() were only added in level two of this spec. Relying Parties SHOULD use feature detection before using these functions by testing the value of 'getPublicKey' in AuthenticatorAttestationResponse.prototype. Relying Parties that require this function to exist may not interoperate with older user-agents.

    5.2.2. Web Authentication Assertion (interface AuthenticatorAssertionResponse)

    -
    - -
    -

    AuthenticatorAssertionResponse

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile48+ -
    -
    -
    -

    The AuthenticatorAssertionResponse interface represents an authenticator's response to a client’s request for -generation of a new authentication assertion given the WebAuthn Relying Party's challenge and OPTIONAL list of credentials it is +

    The AuthenticatorAssertionResponse interface represents an authenticator's response to a client’s request for +generation of a new authentication assertion given the WebAuthn Relying Party's challenge and OPTIONAL list of credentials it is aware of. This response contains a cryptographic signature proving possession of the credential private key, and optionally evidence of user consent to a specific transaction.

    [SecureContext, Exposed=Window]
     interface AuthenticatorAssertionResponse : AuthenticatorResponse {
    -    [SameObject] readonly attribute ArrayBuffer      authenticatorData;
    -    [SameObject] readonly attribute ArrayBuffer      signature;
    -    [SameObject] readonly attribute ArrayBuffer?     userHandle;
    +    [SameObject] readonly attribute ArrayBuffer      authenticatorData;
    +    [SameObject] readonly attribute ArrayBuffer      signature;
    +    [SameObject] readonly attribute ArrayBuffer?     userHandle;
    +    [SameObject] readonly attribute ArrayBuffer?     attestationObject;
     };
     
    @@ -3185,86 +3668,40 @@

    AuthenticatorResponse, contains the JSON-compatible serialization of client data (see § 5.8.1 Client Data Used in WebAuthn Signatures (dictionary CollectedClientData)) passed to the authenticator by the client in order to generate this assertion. The exact JSON serialization MUST be preserved, as the hash of the serialized client data has been computed over it.

    -
    -
    - -
    -

    AuthenticatorAssertionResponse/authenticatorData

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile48+ -
    -
    -
    -

    authenticatorData, of type ArrayBuffer, readonly

    +
    authenticatorData, of type ArrayBuffer, readonly

    This attribute contains the authenticator data returned by the authenticator. See § 6.1 Authenticator Data.

    -
    -
    - -
    -

    AuthenticatorAssertionResponse/signature

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile48+ -
    -
    -
    -

    signature, of type ArrayBuffer, readonly

    +
    signature, of type ArrayBuffer, readonly

    This attribute contains the raw signature returned from the authenticator. See § 6.3.3 The authenticatorGetAssertion Operation.

    -
    -
    - -
    -

    AuthenticatorAssertionResponse/userHandle

    -

    In all current engines.

    -
    - Firefox60+Safari13+Chrome67+ -
    - Opera?Edge79+ -
    - Edge (Legacy)18IENone -
    - Firefox for Android92+iOS Safari?Chrome for Android70+Android WebViewNoneSamsung Internet?Opera Mobile48+ -
    -
    -
    -

    userHandle, of type ArrayBuffer, readonly, nullable

    +
    userHandle, of type ArrayBuffer, readonly, nullable +
    +

    This attribute contains the user handle returned from the authenticator, or null if the authenticator did not return a user handle. See § 6.3.3 The authenticatorGetAssertion Operation. The authenticator MUST always return a user handle if +the allowCredentials option used in the authentication ceremony is empty, +and MAY return one otherwise.

    +
    attestationObject, of type ArrayBuffer, readonly, nullable
    -

    This attribute contains the user handle returned from the authenticator, or null if the authenticator did not return a user handle. See § 6.3.3 The authenticatorGetAssertion Operation.

    +

    This OPTIONAL attribute contains an attestation object, if the authenticator supports attestation in assertions. The attestation object, if present, includes an attestation statement. Unlike the attestationObject in an AuthenticatorAttestationResponse, it does not contain an authData key because the authenticator data is provided directly in an AuthenticatorAssertionResponse structure. For more details on attestation, see § 6.5 Attestation, § 6.5.1 Attestation in assertions, § 6.5.5 Generating an Attestation Object, and Figure 6.

    5.3. Parameters for Credential Generation (dictionary PublicKeyCredentialParameters)

    dictionary PublicKeyCredentialParameters {
    -    required DOMString                    type;
    +    required DOMString                    type;
         required COSEAlgorithmIdentifier      alg;
     };
     
    This dictionary is used to supply additional parameters when creating a new credential.
    -
    type, of type DOMString +
    type, of type DOMString
    -

    This member specifies the type of credential to be created. The value SHOULD be a member of PublicKeyCredentialType but client platforms MUST ignore unknown values, ignoring any PublicKeyCredentialParameters with an unknown type.

    +

    This member specifies the type of credential to be created. The value SHOULD be a member of PublicKeyCredentialType but client platforms MUST ignore unknown values, ignoring any PublicKeyCredentialParameters with an unknown type.

    alg, of type COSEAlgorithmIdentifier

    This member specifies the cryptographic signature algorithm with which the newly generated credential will be used, and thus also the type of asymmetric key pair to be generated, e.g., RSA or Elliptic Curve.

    -

    Note: we use "alg" as the latter member name, rather than spelling-out "algorithm", because it will be serialized into +

    Note: we use "alg" as the latter member name, rather than spelling-out "algorithm", because it will be serialized into a message to the authenticator, which may be sent over a low-bandwidth link.

    5.4. Options for Credential Creation (dictionary PublicKeyCredentialCreationOptions)

    @@ -3273,12 +3710,14 @@

  • @@ -3286,205 +3725,232 @@

    rp, of type PublicKeyCredentialRpEntity
    -

    This member contains a name and an identifier for the Relying Party responsible for the request.

    +

    This member contains a name and an identifier for the Relying Party responsible for the request.

    Its value’s name member is REQUIRED. See § 5.4.1 Public Key Entity Description (dictionary PublicKeyCredentialEntity) for further details.

    Its value’s id member specifies the RP ID the credential should be scoped to. If omitted, its value will be the CredentialsContainer object’s relevant -settings object's origin's effective domain. See § 5.4.2 Relying Party Parameters for Credential Generation (dictionary PublicKeyCredentialRpEntity) for further details.

    +settings object's origin's effective domain. See § 5.4.2 Relying Party Parameters for Credential Generation (dictionary PublicKeyCredentialRpEntity) for further details.

    user, of type PublicKeyCredentialUserEntity

    This member contains names and an identifier for the user account performing the registration.

    -

    Its value’s name, displayName and id members are REQUIRED. id can be returned as the userHandle in some future authentication ceremonies, -and is used to overwrite existing discoverable credentials that have the same rp.id and user.id on the same authenticator. name and displayName MAY be used by the authenticator and client in future authentication ceremonies to help the user select a credential, but are not returned to the Relying Party as a result of future authentication ceremonies

    +

    Its value’s name, displayName and id members are REQUIRED. id can be returned as the userHandle in some future authentication ceremonies, +and is used to overwrite existing discoverable credentials that have the same rp.id and user.id on the same authenticator. name and displayName MAY be used by the authenticator and client in future authentication ceremonies to help the user select a credential, but are not returned to the Relying Party as a result of future authentication ceremonies

    For further details, see § 5.4.1 Public Key Entity Description (dictionary PublicKeyCredentialEntity) and § 5.4.3 User Account Parameters for Credential Generation (dictionary PublicKeyCredentialUserEntity).

    challenge, of type BufferSource
    -

    This member specifies a challenge that the authenticator signs, along with other data, -when producing an attestation object for the newly created credential. +

    This member specifies a challenge that the authenticator signs, along with other data, +when producing an attestation object for the newly created credential. See the § 13.4.3 Cryptographic Challenges security consideration.

    pubKeyCredParams, of type sequence<PublicKeyCredentialParameters>
    -

    This member lists the key types and signature algorithms the Relying Party supports, +

    This member lists the key types and signature algorithms the Relying Party supports, ordered from most preferred to least preferred. -The client and authenticator make a best-effort to create a credential of the most preferred type possible. -If none of the listed types can be created, the create() operation fails.

    +The client and authenticator make a best-effort to create a credential of the most preferred type possible. +If none of the listed types can be created, the create() operation fails.

    +

    Relying Parties that wish to support a wide range of authenticators SHOULD include at least the following COSEAlgorithmIdentifier values:

    +
      +
    • +

      -8 (Ed25519)

      +
    • +

      -7 (ES256)

      +
    • +

      -257 (RS256)

      +
    +

    Additional signature algorithms can be included as needed.

    timeout, of type unsigned long
    -

    This OPTIONAL member specifies a time, in milliseconds, that the Relying Party is willing to wait for the call to complete. This is -treated as a hint, and MAY be overridden by the client.

    +

    This OPTIONAL member specifies a time, in milliseconds, that the Relying Party is willing to wait for the call to complete. This is +treated as a hint, and MAY be overridden by the client.

    excludeCredentials, of type sequence<PublicKeyCredentialDescriptor>, defaulting to []
    -

    The Relying Party SHOULD use this OPTIONAL member to list any existing credentials mapped to this user account (as identified by user.id). -This ensures that the new credential is not created on an authenticator that already contains a credential mapped to this user account. -If it would be, the client is requested to instead guide the user to use a different authenticator, +

    The Relying Party SHOULD use this OPTIONAL member to list any existing credentials mapped to this user account (as identified by user.id). +This ensures that the new credential is not created on an authenticator that already contains a credential mapped to this user account. +If it would be, the client is requested to instead guide the user to use a different authenticator, or return an error if that fails.

    authenticatorSelection, of type AuthenticatorSelectionCriteria
    -

    The Relying Party MAY use this OPTIONAL member to specify capabilities and settings -that the authenticator MUST or SHOULD satisfy to participate in the create() operation. +

    The Relying Party MAY use this OPTIONAL member to specify capabilities and settings +that the authenticator MUST or SHOULD satisfy to participate in the create() operation. See § 5.4.4 Authenticator Selection Criteria (dictionary AuthenticatorSelectionCriteria).

    -
    attestation, of type DOMString, defaulting to "none" +
    hints, of type sequence<DOMString>, defaulting to [] +
    +

    This OPTIONAL member contains zero or more elements from PublicKeyCredentialHints to guide the user agent in interacting with the user. Note that the elements have type DOMString despite being taken from that enumeration. See § 2.1.1 Enumerations as DOMString types.

    +
    attestation, of type DOMString, defaulting to "none"
    -

    The Relying Party MAY use this OPTIONAL member to specify a preference regarding attestation conveyance. -Its value SHOULD be a member of AttestationConveyancePreference. Client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.

    -

    The default value is none.

    +

    The Relying Party MAY use this OPTIONAL member to specify a preference regarding attestation conveyance. +Its value SHOULD be a member of AttestationConveyancePreference. Client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.

    +

    The default value is none.

    +
    attestationFormats, of type sequence<DOMString>, defaulting to [] +
    +

    The Relying Party MAY use this OPTIONAL member to specify a preference regarding the attestation statement format used by the authenticator. +Values SHOULD be taken from the IANA "WebAuthn Attestation Statement Format Identifiers" registry [IANA-WebAuthn-Registries] established by [RFC8809]. +Values are ordered from most preferable to least preferable. +This parameter is advisory and the authenticator MAY use an attestation statement not enumerated in this parameter.

    +

    The default value is the empty list, which indicates no preference.

    extensions, of type AuthenticationExtensionsClientInputs
    -

    The Relying Party MAY use this OPTIONAL member to provide client extension inputs requesting additional processing by the client and authenticator. -For example, the Relying Party may request that the client returns additional information about the credential that was created.

    +

    The Relying Party MAY use this OPTIONAL member to provide client extension inputs requesting additional processing by the client and authenticator. +For example, the Relying Party may request that the client returns additional information about the credential that was created.

    The extensions framework is defined in § 9 WebAuthn Extensions. Some extensions are defined in § 10 Defined Extensions; -consult the IANA "WebAuthn Extension Identifiers" registry [IANA-WebAuthn-Registries] established by [RFC8809] for an up-to-date list +consult the IANA "WebAuthn Extension Identifiers" registry [IANA-WebAuthn-Registries] established by [RFC8809] for an up-to-date list of registered WebAuthn Extensions.

    5.4.1. Public Key Entity Description (dictionary PublicKeyCredentialEntity)

    -

    The PublicKeyCredentialEntity dictionary describes a user account, or a WebAuthn Relying Party, which a public key credential is +

    The PublicKeyCredentialEntity dictionary describes a user account, or a WebAuthn Relying Party, which a public key credential is associated with or scoped to, respectively.

    dictionary PublicKeyCredentialEntity {
    -    required DOMString    name;
    +    required DOMString    name;
     };
     
    -
    name, of type DOMString +
    name, of type DOMString
    -

    A human-palatable name for the entity. Its function depends on what the PublicKeyCredentialEntity represents:

    +

    A human-palatable name for the entity. Its function depends on what the PublicKeyCredentialEntity represents:

    -

    When clients, client platforms, or authenticators display a name's value, they should always use UI elements to provide a clear boundary around the displayed value, and not allow overflow into other elements [css-overflow-3].

    +

    When clients, client platforms, or authenticators display a name's value, they should always use UI elements to provide a clear boundary around the displayed value, and not allow overflow into other elements [css-overflow-3].

    Authenticators MAY truncate a name member’s value so that it fits within 64 bytes, if the authenticator stores the value. See § 6.4.1 String Truncation about truncation and other considerations.

    5.4.2. Relying Party Parameters for Credential Generation (dictionary PublicKeyCredentialRpEntity)

    -

    The PublicKeyCredentialRpEntity dictionary is used to supply additional Relying Party attributes when creating a new credential.

    +

    The PublicKeyCredentialRpEntity dictionary is used to supply additional Relying Party attributes when creating a new credential.

    dictionary PublicKeyCredentialRpEntity : PublicKeyCredentialEntity {
    -    DOMString      id;
    +    DOMString      id;
     };
     
    -
    id, of type DOMString +
    id, of type DOMString
    -

    A unique identifier for the Relying Party entity, which sets the RP ID.

    +

    A unique identifier for the Relying Party entity, which sets the RP ID.

    5.4.3. User Account Parameters for Credential Generation (dictionary PublicKeyCredentialUserEntity)

    -

    The PublicKeyCredentialUserEntity dictionary is used to supply additional user account attributes when creating a new +

    The PublicKeyCredentialUserEntity dictionary is used to supply additional user account attributes when creating a new credential.

    dictionary PublicKeyCredentialUserEntity : PublicKeyCredentialEntity {
         required BufferSource   id;
    -    required DOMString      displayName;
    +    required DOMString      displayName;
     };
     
    id, of type BufferSource
    -

    The user handle of the user account. -A user handle is an opaque byte sequence with a maximum size of 64 bytes, +

    The user handle of the user account. +A user handle is an opaque byte sequence with a maximum size of 64 bytes, and is not meant to be displayed to the user.

    To ensure secure operation, authentication and authorization -decisions MUST be made on the basis of this id member, not the displayName nor name members. See Section 6.1 of [RFC8266].

    -

    The user handle MUST NOT contain personally identifying information about the user, such as a username or e-mail address; -see § 14.6.1 User Handle Contents for details. The user handle MUST NOT be empty.

    -

    Note: the user handle ought not be a constant value across different user accounts, -even for non-discoverable credentials, because some authenticators always create discoverable credentials. -Thus a constant user handle would prevent a user from using such an authenticator -with more than one user account at the Relying Party.

    -
    displayName, of type DOMString +decisions MUST be made on the basis of this id member, not the displayName nor name members. See Section 6.1 of [RFC8266].

    +

    The user handle MUST NOT contain personally identifying information about the user, such as a username or e-mail address; +see § 14.6.1 User Handle Contents for details. The user handle MUST NOT be empty.

    +

    Note: the user handle ought not be a constant value across different user accounts, +even for non-discoverable credentials, because some authenticators always create discoverable credentials. +Thus a constant user handle would prevent a user from using such an authenticator +with more than one user account at the Relying Party.

    +
    displayName, of type DOMString
    -

    A human-palatable name for the user account, intended only for display. For example, "Alex Müller" or "田中倫". The Relying Party SHOULD let the user choose this, and SHOULD NOT restrict the choice more than necessary.

    +

    A human-palatable name for the user account, intended only for +display. The Relying Party SHOULD let the user choose this, and SHOULD NOT restrict the choice +more than necessary. If no suitable or human-palatable name is +available, the Relying Party SHOULD set this value to an empty string.

    +

    Examples of suitable values for this identifier include, "Alex Müller", "Alex Müller (ACME Co.)" or "田中倫".

    -

    When clients, client platforms, or authenticators display a displayName's value, they should always use UI elements to provide a clear boundary around the displayed value, and not allow overflow into other elements [css-overflow-3].

    -

    Authenticators MUST accept and store a 64-byte minimum length for a displayName member’s value. Authenticators MAY truncate a displayName member’s value so that it fits within 64 bytes. See § 6.4.1 String Truncation about truncation and other considerations.

    +

    When clients, client platforms, or authenticators display a displayName's value, they should always use UI elements to provide a clear boundary around the displayed value, and not allow overflow into other elements [css-overflow-3].

    +

    Authenticators MUST accept and store a 64-byte minimum length for a displayName member’s value. Authenticators MAY truncate a displayName member’s value so that it fits within 64 bytes. See § 6.4.1 String Truncation about truncation and other considerations.

    5.4.4. Authenticator Selection Criteria (dictionary AuthenticatorSelectionCriteria)

    -

    WebAuthn Relying Parties may use the AuthenticatorSelectionCriteria dictionary to specify their requirements regarding authenticator +

    WebAuthn Relying Parties may use the AuthenticatorSelectionCriteria dictionary to specify their requirements regarding authenticator attributes.

    dictionary AuthenticatorSelectionCriteria {
    -    DOMString                    authenticatorAttachment;
    -    DOMString                    residentKey;
    -    boolean                      requireResidentKey = false;
    -    DOMString                    userVerification = "preferred";
    +    DOMString                    authenticatorAttachment;
    +    DOMString                    residentKey;
    +    boolean                      requireResidentKey = false;
    +    DOMString                    userVerification = "preferred";
     };
     
    -
    authenticatorAttachment, of type DOMString +
    authenticatorAttachment, of type DOMString
    -

    If this member is present, eligible authenticators are filtered to be only those authenticators attached with the specified authenticator attachment modality (see also § 6.2.1 Authenticator Attachment Modality). +

    If this member is present, eligible authenticators are filtered to be only those authenticators attached with the specified authenticator attachment modality (see also § 6.2.1 Authenticator Attachment Modality). If this member is absent, then any attachment modality is acceptable. -The value SHOULD be a member of AuthenticatorAttachment but client platforms MUST ignore unknown values, +The value SHOULD be a member of AuthenticatorAttachment but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.

    -

    See also the authenticatorAttachment member of PublicKeyCredential, +

    See also the authenticatorAttachment member of PublicKeyCredential, which can tell what authenticator attachment modality was used -in a successful create() or get() operation.

    -
    residentKey, of type DOMString +in a successful create() or get() operation.

    +
    residentKey, of type DOMString
    -

    Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated “resident” terminology. The value SHOULD be a member of ResidentKeyRequirement but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist. If no value is given then the effective value is required if requireResidentKey is true or discouraged if it is false or absent.

    +

    Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated “resident” terminology. The value SHOULD be a member of ResidentKeyRequirement but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist. If no value is given then the effective value is required if requireResidentKey is true or discouraged if it is false or absent.

    See ResidentKeyRequirement for the description of residentKey's values and semantics.

    -
    requireResidentKey, of type boolean, defaulting to false +
    requireResidentKey, of type boolean, defaulting to false
    -

    This member is retained for backwards compatibility with WebAuthn Level 1 and, for historical reasons, its naming retains the deprecated “resident” terminology for discoverable credentials. Relying Parties SHOULD set it to true if, and only if, residentKey is set to required.

    -
    userVerification, of type DOMString, defaulting to "preferred" +

    This member is retained for backwards compatibility with WebAuthn Level 1 and, for historical reasons, its naming retains the deprecated “resident” terminology for discoverable credentials. Relying Parties SHOULD set it to true if, and only if, residentKey is set to required.

    +
    userVerification, of type DOMString, defaulting to "preferred"
    -

    This member specifies the Relying Party's requirements regarding user verification for the create() operation. -The value SHOULD be a member of UserVerificationRequirement but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.

    -

    See UserVerificationRequirement for the description of userVerification's values and semantics.

    +

    This member specifies the Relying Party's requirements regarding user verification for the create() operation. +The value SHOULD be a member of UserVerificationRequirement but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.

    +

    See UserVerificationRequirement for the description of userVerification's values and semantics.

    5.4.5. Authenticator Attachment Enumeration (enum AuthenticatorAttachment)

    -

    This enumeration’s values describe authenticators' attachment modalities. Relying Parties use this to express a preferred authenticator attachment modality when calling navigator.credentials.create() to create a credential, and clients use this to report the authenticator attachment modality used to complete a registration or authentication ceremony.

    +

    This enumeration’s values describe authenticators' attachment modalities. Relying Parties use this to express a preferred authenticator attachment modality when calling navigator.credentials.create() to create a credential, and clients use this to report the authenticator attachment modality used to complete a registration or authentication ceremony.

    enum AuthenticatorAttachment {
         "platform",
         "cross-platform"
     };
     
    -

    Note: The AuthenticatorAttachment enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    +

    Note: The AuthenticatorAttachment enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    platform @@ -3495,10 +3961,10 @@

    This value indicates cross-platform attachment.

    -

    Note: An authenticator attachment modality selection option is available only in the [[Create]](origin, options, -sameOriginWithAncestors) operation. The Relying Party may use it to, for example, ensure the user has a roaming credential for +

    Note: An authenticator attachment modality selection option is available only in the [[Create]](origin, options, +sameOriginWithAncestors) operation. The Relying Party may use it to, for example, ensure the user has a roaming credential for authenticating on another client device; or to specifically register a platform credential for easier reauthentication using a -particular client device. The [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) operation has no authenticator attachment modality selection option, so the Relying Party SHOULD accept any of the user’s registered credentials. The client and user will then use whichever is available and convenient at the time.

    +particular client device. The [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) operation has no authenticator attachment modality selection option, so the Relying Party SHOULD accept any of the user’s registered credentials. The client and user will then use whichever is available and convenient at the time.

    5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement)

    enum ResidentKeyRequirement {
         "discouraged",
    @@ -3506,63 +3972,63 @@ 

    "required" };

    -

    Note: The ResidentKeyRequirement enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    -

    This enumeration’s values describe the Relying Party's requirements for client-side discoverable credentials (formerly known as resident credentials or resident keys):

    +

    Note: The ResidentKeyRequirement enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    +

    This enumeration’s values describe the Relying Party's requirements for client-side discoverable credentials (formerly known as resident credentials or resident keys):

    discouraged
    -

    The Relying Party prefers creating a server-side credential, but will accept a client-side discoverable credential. -The client and authenticator SHOULD create a server-side credential if possible.

    -

    Note: A Relying Party cannot require that a created credential is a server-side credential and the Credential Properties Extension may not return a value for the rk property. Because of this, it may be the case that it does not know if a credential is a server-side credential or not and thus does not know whether creating a second credential with the same user handle will evict the first.

    +

    The Relying Party prefers creating a server-side credential, but will accept a client-side discoverable credential. +The client and authenticator SHOULD create a server-side credential if possible.

    +

    Note: A Relying Party cannot require that a created credential is a server-side credential and the Credential Properties Extension may not return a value for the rk property. Because of this, it may be the case that it does not know if a credential is a server-side credential or not and thus does not know whether creating a second credential with the same user handle will evict the first.

    preferred
    -

    The Relying Party strongly prefers creating a client-side discoverable credential, but will accept a server-side credential. -The client and authenticator SHOULD create a discoverable credential if possible. -For example, the client SHOULD guide the user through setting up user verification if needed to create a discoverable credential. This takes precedence over the setting of userVerification.

    +

    The Relying Party strongly prefers creating a client-side discoverable credential, but will accept a server-side credential. +The client and authenticator SHOULD create a discoverable credential if possible. +For example, the client SHOULD guide the user through setting up user verification if needed to create a discoverable credential. This takes precedence over the setting of userVerification.

    required
    -

    The Relying Party requires a client-side discoverable credential. -The client MUST return an error if a client-side discoverable credential cannot be created.

    +

    The Relying Party requires a client-side discoverable credential. +The client MUST return an error if a client-side discoverable credential cannot be created.

    -

    Note: The Relying Party can seek information on whether or not the authenticator created a client-side discoverable credential using the resident key credential property of the Credential Properties Extension. -This is useful when values of discouraged or preferred are used for options.authenticatorSelection.residentKey, because in those cases it is possible for an authenticator to create either a client-side discoverable credential or a server-side credential.

    +

    Note: The Relying Party can seek information on whether or not the authenticator created a client-side discoverable credential using the resident key credential property of the Credential Properties Extension. +This is useful when values of discouraged or preferred are used for options.authenticatorSelection.residentKey, because in those cases it is possible for an authenticator to create either a client-side discoverable credential or a server-side credential.

    5.4.7. Attestation Conveyance Preference Enumeration (enum AttestationConveyancePreference)

    -

    WebAuthn Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation.

    +

    WebAuthn Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation.

    enum AttestationConveyancePreference {
    -    "none",
    +    "none",
         "indirect",
         "direct",
    -    "enterprise"
    +    "enterprise"
     };
     
    -

    Note: The AttestationConveyancePreference enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    +

    Note: The AttestationConveyancePreference enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    none
    -

    The Relying Party is not interested in authenticator attestation. For example, in order to -potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a +

    The Relying Party is not interested in authenticator attestation. For example, in order to +potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA or Anonymization CA. -If the authenticator generates an attestation statement that is not a self attestation, -the client will replace it with a None attestation statement.

    +If the authenticator generates an attestation statement that is not a self attestation, +the client will replace it with a None attestation statement.

    This is the default, and unknown values fall back to the behavior of this value.

    indirect
    -

    The Relying Party wants to receive a verifiable attestation statement, -but allows the client to decide how to obtain such an attestation statement. -The client MAY replace an authenticator-generated attestation statement with one generated by an Anonymization CA, -in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.

    -

    Note: There is no guarantee that the Relying Party will obtain a verifiable attestation statement in this case. -For example, in the case that the authenticator employs self attestation and the client passes the attestation statement through unmodified.

    +

    The Relying Party wants to receive a verifiable attestation statement, +but allows the client to decide how to obtain such an attestation statement. +The client MAY replace an authenticator-generated attestation statement with one generated by an Anonymization CA, +in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.

    +

    Note: There is no guarantee that the Relying Party will obtain a verifiable attestation statement in this case. +For example, in the case that the authenticator employs self attestation and the client passes the attestation statement through unmodified.

    direct
    -

    The Relying Party wants to receive the attestation statement as generated by the authenticator.

    +

    The Relying Party wants to receive the attestation statement as generated by the authenticator.

    enterprise
    -

    The Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. User agents MUST NOT provide such an attestation unless the user agent or authenticator configuration permits it for the requested RP ID.

    -

    If permitted, the user agent SHOULD signal to the authenticator (at invocation time) that enterprise attestation is requested, and convey the resulting AAGUID and attestation statement, unaltered, to the Relying Party.

    +

    The Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. User agents MUST NOT provide such an attestation unless the user agent or authenticator configuration permits it for the requested RP ID.

    +

    If permitted, the user agent SHOULD signal to the authenticator (at invocation time) that enterprise attestation is requested, and convey the resulting AAGUID and attestation statement, unaltered, to the Relying Party.

    5.5. Options for Assertion Generation (dictionary PublicKeyCredentialRequestOptions)

    @@ -3572,83 +4038,101 @@

    < required BufferSource challenge; unsigned long timeout; USVString rpId; - sequence<PublicKeyCredentialDescriptor> allowCredentials = []; - DOMString userVerification = "preferred"; + sequence<PublicKeyCredentialDescriptor> allowCredentials = []; + DOMString userVerification = "preferred"; + sequence<DOMString> hints = []; + DOMString attestation = "none"; + sequence<DOMString> attestationFormats = []; AuthenticationExtensionsClientInputs extensions; };

    challenge, of type BufferSource
    -

    This member specifies a challenge that the authenticator signs, along with other data, when producing an authentication assertion. See the § 13.4.3 Cryptographic Challenges security consideration.

    +

    This member specifies a challenge that the authenticator signs, along with other data, when producing an authentication assertion. See the § 13.4.3 Cryptographic Challenges security consideration.

    timeout, of type unsigned long
    -

    This OPTIONAL member specifies a time, in milliseconds, that the Relying Party is willing to wait for the call to complete. -The value is treated as a hint, and MAY be overridden by the client.

    +

    This OPTIONAL member specifies a time, in milliseconds, that the Relying Party is willing to wait for the call to complete. +The value is treated as a hint, and MAY be overridden by the client.

    rpId, of type USVString
    -

    This OPTIONAL member specifies the RP ID claimed by the Relying Party. -The client MUST verify that the Relying Party's origin matches the scope of this RP ID. -The authenticator MUST verify -that this RP ID exactly equals the rpId of the credential to be used for the authentication ceremony.

    +

    This OPTIONAL member specifies the RP ID claimed by the Relying Party. +The client MUST verify that the Relying Party's origin matches the scope of this RP ID. +The authenticator MUST verify +that this RP ID exactly equals the rpId of the credential to be used for the authentication ceremony.

    If not specified, its value will -be the CredentialsContainer object’s relevant settings object's origin's effective domain.

    +be the CredentialsContainer object’s relevant settings object's origin's effective domain.

    allowCredentials, of type sequence<PublicKeyCredentialDescriptor>, defaulting to []
    -

    This OPTIONAL member is used by the client to find authenticators eligible for this authentication ceremony. +

    This OPTIONAL member is used by the client to find authenticators eligible for this authentication ceremony. It can be used in two ways:

    If not empty, the client MUST return an error if none of the listed credentials can be used.

    The list is ordered in descending order of preference: the first item in the list is the most preferred credential, and the last is the least preferred.

    -
    userVerification, of type DOMString, defaulting to "preferred" +
    userVerification, of type DOMString, defaulting to "preferred" +
    +

    This OPTIONAL member specifies the Relying Party's requirements regarding user verification for the get() operation. The value SHOULD be a member of UserVerificationRequirement but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist. Eligible authenticators are filtered to only those capable of satisfying this requirement.

    +

    See UserVerificationRequirement for the description of userVerification's values and semantics.

    +
    hints, of type sequence<DOMString>, defaulting to [] +
    +

    This OPTIONAL member contains zero or more elements from PublicKeyCredentialHints to guide the user agent in interacting with the user. Note that the elements have type DOMString despite being taken from that enumeration. See § 2.1.1 Enumerations as DOMString types.

    +
    attestation, of type DOMString, defaulting to "none" +
    +

    The Relying Party MAY use this OPTIONAL member to specify a preference regarding attestation conveyance. +Its value SHOULD be a member of AttestationConveyancePreference. Client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.

    +

    The default value is none.

    +
    attestationFormats, of type sequence<DOMString>, defaulting to []
    -

    This OPTIONAL member specifies the Relying Party's requirements regarding user verification for the get() operation. The value SHOULD be a member of UserVerificationRequirement but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist. Eligible authenticators are filtered to only those capable of satisfying this requirement.

    -

    See UserVerificationRequirement for the description of userVerification's values and semantics.

    +

    The Relying Party MAY use this OPTIONAL member to specify a preference regarding the attestation statement format used by the authenticator. +Values SHOULD be taken from the IANA "WebAuthn Attestation Statement Format Identifiers" registry [IANA-WebAuthn-Registries] established by [RFC8809]. +Values are ordered from most preferable to least preferable. +This parameter is advisory and the authenticator MAY use an attestation statement not enumerated in this parameter.

    +

    The default value is the empty list, which indicates no preference.

    extensions, of type AuthenticationExtensionsClientInputs
    -

    The Relying Party MAY use this OPTIONAL member to provide client extension inputs requesting additional processing by the client and authenticator.

    +

    The Relying Party MAY use this OPTIONAL member to provide client extension inputs requesting additional processing by the client and authenticator.

    The extensions framework is defined in § 9 WebAuthn Extensions. Some extensions are defined in § 10 Defined Extensions; -consult the IANA "WebAuthn Extension Identifiers" registry [IANA-WebAuthn-Registries] established by [RFC8809] for an up-to-date list +consult the IANA "WebAuthn Extension Identifiers" registry [IANA-WebAuthn-Registries] established by [RFC8809] for an up-to-date list of registered WebAuthn Extensions.

    5.6. Abort Operations with AbortSignal

    Developers are encouraged to leverage the AbortController to manage the [[Create]](origin, options, sameOriginWithAncestors) and [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) operations. See DOM § 3.3 Using AbortController and AbortSignal objects in APIs section for detailed instructions.

    -

    Note: DOM § 3.3 Using AbortController and AbortSignal objects in APIs section specifies that web platform APIs integrating with the AbortController must reject the promise immediately once the AbortSignal is aborted. +

    Note: DOM § 3.3 Using AbortController and AbortSignal objects in APIs section specifies that web platform APIs integrating with the AbortController must reject the promise immediately once the AbortSignal is aborted. Given the complex inheritance and parallelization structure of the [[Create]](origin, options, sameOriginWithAncestors) and [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) methods, the algorithms for the two APIs fulfills this - requirement by checking the aborted property in three places. In the case of [[Create]](origin, options, sameOriginWithAncestors), the aborted property is checked first in Credential Management 1 § 2.5.4 Create a Credential immediately before calling [[Create]](origin, options, sameOriginWithAncestors), + requirement by checking the aborted property in three places. In the case of [[Create]](origin, options, sameOriginWithAncestors), the aborted property is checked first in Credential Management 1 § 2.5.4 Create a Credential immediately before calling [[Create]](origin, options, sameOriginWithAncestors), then in § 5.1.3 Create a New Credential - PublicKeyCredential’s [[Create]](origin, options, sameOriginWithAncestors) Method right before authenticator sessions start, and finally during authenticator sessions. The same goes for [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors).

    -

    The visibility and focus state of the Window object determines whether the [[Create]](origin, options, sameOriginWithAncestors) and [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) operations -should continue. When the Window object associated with the Document loses focus, [[Create]](origin, options, sameOriginWithAncestors) and [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) operations +

    The visibility and focus state of the Window object determines whether the [[Create]](origin, options, sameOriginWithAncestors) and [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) operations +should continue. When the Window object associated with the Document loses focus, [[Create]](origin, options, sameOriginWithAncestors) and [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) operations SHOULD be aborted.

    The WHATWG HTML WG is discussing whether to provide a hook when a browsing context gains or loses focuses. If a hook is provided, the above paragraph will be updated to include the hook. See WHATWG HTML WG Issue #2711 for more details.

    5.7. WebAuthn Extensions Inputs and Outputs

    The subsections below define the data types used for conveying WebAuthn extension inputs and outputs.

    -

    Note: Authenticator extension outputs are conveyed as a part of Authenticator data (see Table 1).

    -

    Note: The types defined below — AuthenticationExtensionsClientInputs and AuthenticationExtensionsClientOutputs — are applicable to both registration extensions and authentication extensions. The "Authentication..." portion of their names should be regarded as meaning "WebAuthentication..."

    +

    Note: Authenticator extension outputs are conveyed as a part of authenticator data (see Table 1).

    +

    Note: The types defined below — AuthenticationExtensionsClientInputs and AuthenticationExtensionsClientOutputs — are applicable to both registration extensions and authentication extensions. The "Authentication..." portion of their names should be regarded as meaning "WebAuthentication..."

    5.7.1. Authentication Extensions Client Inputs (dictionary AuthenticationExtensionsClientInputs)

    dictionary AuthenticationExtensionsClientInputs {
     };
    @@ -3667,7 +4151,7 @@ 

    5.7.4. Authentication Extensions Authenticator Outputs (CDDL type AuthenticationExtensionsAuthenticatorOutputs)

    AuthenticationExtensionsAuthenticatorOutputs = {
       * $$extensionOutput .within ( tstr => any )
    @@ -3680,70 +4164,76 @@ 

    5.8.1. Client Data Used in WebAuthn Signatures (dictionary CollectedClientData)

    -

    The client data represents the contextual bindings of both the WebAuthn Relying Party and the client. It is a key-value +

    The client data represents the contextual bindings of both the WebAuthn Relying Party and the client. It is a key-value mapping whose keys are strings. Values can be any type that has a valid encoding in JSON. Its structure is defined by the following Web IDL.

    -

    Note: The CollectedClientData may be extended in the future. Therefore it’s critical when parsing to be tolerant of unknown keys and of any reordering of the keys. See also § 5.8.1.2 Limited Verification Algorithm.

    +

    Note: The CollectedClientData may be extended in the future. Therefore it’s critical when parsing to be tolerant of unknown keys and of any reordering of the keys. See also § 5.8.1.2 Limited Verification Algorithm.

    dictionary CollectedClientData {
    -    required DOMString           type;
    -    required DOMString           challenge;
    -    required DOMString           origin;
    -    boolean                      crossOrigin;
    +    required DOMString           type;
    +    required DOMString           challenge;
    +    required DOMString           origin;
    +    DOMString                    topOrigin;
    +    boolean                      crossOrigin;
     };
     
     dictionary TokenBinding {
    -    required DOMString status;
    -    DOMString id;
    +    required DOMString status;
    +    DOMString id;
     };
     
     enum TokenBindingStatus { "present", "supported" };
     
    -
    type, of type DOMString +
    type, of type DOMString

    This member contains the string "webauthn.create" when creating new credentials, and "webauthn.get" when getting an assertion from an existing credential. The purpose of this member is to prevent certain types of signature confusion attacks (where an attacker substitutes one legitimate signature for another).

    -
    challenge, of type DOMString +
    challenge, of type DOMString
    -

    This member contains the base64url encoding of the challenge provided by the Relying Party. See the § 13.4.3 Cryptographic Challenges security consideration.

    -
    origin, of type DOMString +

    This member contains the base64url encoding of the challenge provided by the Relying Party. See the § 13.4.3 Cryptographic Challenges security consideration.

    +
    origin, of type DOMString
    -

    This member contains the fully qualified origin of the requester, as provided to the authenticator by the client, in -the syntax defined by [RFC6454].

    -
    crossOrigin, of type boolean +

    This member contains the fully qualified origin of the requester, as provided to the authenticator by the client, in +the syntax defined by [RFC6454].

    +
    topOrigin, of type DOMString +
    +

    This OPTIONAL member contains the fully qualified top-level origin of the requester, in the syntax defined +by [RFC6454]. It is set only if the call was made from context that is not same-origin with its +ancestors, i.e. if crossOrigin is true.

    +
    crossOrigin, of type boolean

    This OPTIONAL member contains the inverse of the sameOriginWithAncestors argument value -that was passed into the internal method.

    +that was passed into the internal method.

    [RESERVED] tokenBinding
    -

    This OPTIONAL member contains information about the state of the Token Binding protocol [TokenBinding] used when communicating -with the Relying Party. Its absence indicates that the client doesn’t support token binding

    -

    Note: While Token Binding was present in Level 1 and Level 2 of WebAuthn, its use is not expected in Level 3. The tokenBinding field is reserved so that it will not be reused for a different purpose.

    +

    This OPTIONAL member contains information about the state of the Token Binding protocol [TokenBinding] used when communicating +with the Relying Party. Its absence indicates that the client doesn’t support token binding

    +

    Note: While Token Binding was present in Level 1 and Level 2 of WebAuthn, its use is not expected in Level 3. The tokenBinding field is reserved so that it will not be reused for a different purpose.

    -
    status, of type DOMString +
    status, of type DOMString
    -

    This member SHOULD be a member of TokenBindingStatus but client platforms MUST ignore unknown values, treating an unknown value as if the tokenBinding member does not exist. When known, this member is one of the following:

    +

    This member SHOULD be a member of TokenBindingStatus but client platforms MUST ignore unknown values, treating an unknown value as if the tokenBinding member does not exist. When known, this member is one of the following:

    supported
    -

    Indicates the client supports token binding, but it was not negotiated when communicating with the Relying Party.

    +

    Indicates the client supports token binding, but it was not negotiated when communicating with the Relying Party.

    present
    -

    Indicates token binding was used when communicating with the Relying Party. In this case, the id member MUST be present.

    +

    Indicates token binding was used when communicating with the Relying Party. In this case, the id member MUST be present.

    -

    Note: The TokenBindingStatus enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    -
    id, of type DOMString +

    Note: The TokenBindingStatus enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    +
    id, of type DOMString

    This member MUST be present if status is present, and MUST be a base64url -encoding of the Token Binding ID that was used when communicating with the Relying Party.

    +encoding of the Token Binding ID that was used when communicating with the Relying Party.

    -

    Note: Obtaining a Token Binding ID is a client platform-specific operation.

    +

    Note: Obtaining a Token Binding ID is a client platform-specific operation.

    The CollectedClientData structure is used by the client to compute the following quantities:

    @@ -3756,7 +4246,7 @@

    5.8.1.1. Serialization
    -

    The serialization of the CollectedClientData is a subset of the algorithm for JSON-serializing to bytes. I.e. it produces a valid JSON encoding of the CollectedClientData but also provides additional structure that may be exploited by verifiers to avoid integrating a full JSON parser. While verifiers are recommended to perform standard JSON parsing, they may use the more limited algorithm below in contexts where a full JSON parser is too large. This verification algorithm requires only base64url encoding, appending of bytestrings (which could be implemented by writing into a fixed template), and three conditional checks (assuming that inputs are known not to need escaping).

    +

    The serialization of the CollectedClientData is a subset of the algorithm for JSON-serializing to bytes. I.e. it produces a valid JSON encoding of the CollectedClientData but also provides additional structure that may be exploited by verifiers to avoid integrating a full JSON parser. While verifiers are recommended to perform standard JSON parsing, they may use the more limited algorithm below in contexts where a full JSON parser is too large. This verification algorithm requires only base64url encoding, appending of bytestrings (which could be implemented by writing into a fixed template), and simple conditional checks (assuming that inputs are known not to need escaping).

    The serialization algorithm works by appending successive byte strings to an, initially empty, partial result until the complete result is obtained.

    1. @@ -3776,7 +4266,7 @@
      ) to result.

    2. -

      If crossOrigin is not present, or is false:

      +

      If crossOrigin is not present, or is false:

      1. Append 0x66616c7365 (false) to result.

        @@ -3788,7 +4278,15 @@
        CollectedClientData and remove the fields type, challenge, origin, and crossOrigin (if present).

        +

        If topOrigin is present:

        +
          +
        1. +

          Append 0x2c22746f704f726967696e223a (,"topOrigin":) to result.

          +
        2. +

          Append CCDToString(topOrigin) to result.

          +
        +
      2. +

        Create a temporary copy of the CollectedClientData and remove the fields type, challenge, origin, crossOrigin (if present), and topOrigin (if present).

      3. If no fields remain in the temporary copy then:

          @@ -3861,17 +4359,17 @@
          ) to expected.

        1. -

          Append CCDToString(type) to expected.

          +

          Append CCDToString(type) to expected.

        2. Append 0x2c226368616c6c656e6765223a (,"challenge":) to expected.

        3. Perform base64url encoding on challenge to produce a string, challengeBase64.

        4. -

          Append CCDToString(challengeBase64) to expected.

          +

          Append CCDToString(challengeBase64) to expected.

        5. Append 0x2c226f726967696e223a (,"origin":) to expected.

        6. -

          Append CCDToString(origin) to expected.

          +

          Append CCDToString(origin) to expected.

        7. Append 0x2c2263726f73734f726967696e223a (,"crossOrigin":) to expected.

        8. @@ -3905,14 +4403,14 @@
          5.8.1.3. Future development
          -

          In order to remain compatible with the limited verification algorithm, future versions of this specification must not remove any of the fields type, challenge, origin, or crossOrigin from CollectedClientData. They also must not change the serialization algorithm to change the order in which those fields are serialized.

          -

          If additional fields are added to CollectedClientData then verifiers that employ the limited verification algorithm will not be able to consider them until the two algorithms above are updated to include them. Once such an update occurs then the added fields inherit the same limitations as described in the previous paragraph. Such an algorithm update would have to accomodate serializations produced by previous versions. I.e. the verification algorithm would have to handle the fact that a fifth key–value pair may not appear fifth (or at all) if generated by a user agent working from a previous version.

          +

          In order to remain compatible with the limited verification algorithm, future versions of this specification must not remove any of the fields type, challenge, origin, crossOrigin, or topOrigin from CollectedClientData. They also must not change the serialization algorithm to change the order in which those fields are serialized, or insert new fields between them.

          +

          If additional fields are added to CollectedClientData then verifiers that employ the limited verification algorithm will not be able to consider them until the two algorithms above are updated to include them. Once such an update occurs then the added fields inherit the same limitations as described in the previous paragraph. Such an algorithm update would have to accomodate serializations produced by previous versions. I.e. the verification algorithm would have to handle the fact that a sixth key–value pair may not appear sixth (or at all) if generated by a user agent working from a previous version.

          5.8.2. Credential Type Enumeration (enum PublicKeyCredentialType)

          enum PublicKeyCredentialType {
               "public-key"
           };
           
          -

          Note: The PublicKeyCredentialType enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

          +

          Note: The PublicKeyCredentialType enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

          This enumeration defines the valid credential types. It is an extension point; values can be added to it in the future, as more credential types are defined. The values of this enumeration are used for versioning the Authentication Assertion and @@ -3921,34 +4419,35 @@

          5.8.3. Credential Descriptor (dictionary PublicKeyCredentialDescriptor)

          dictionary PublicKeyCredentialDescriptor {
          -    required DOMString                    type;
          +    required DOMString                    type;
               required BufferSource                 id;
          -    sequence<DOMString>                   transports;
          +    sequence<DOMString>                   transports;
           };
           

          This dictionary identifies a specific public key credential. -It is used in create() to prevent creating duplicate credentials on the same authenticator, -and in get() to determine if and how the credential can currently be reached by the client. -It mirrors some fields of the PublicKeyCredential object returned by create() and get().

          +It is used in create() to prevent creating duplicate credentials on the same authenticator, +and in get() to determine if and how the credential can currently be reached by the client. +It mirrors some fields of the PublicKeyCredential object returned by create() and get().

          -
          type, of type DOMString +
          type, of type DOMString
          -

          This member contains the type of the public key credential the caller is referring to. The value SHOULD be a member of PublicKeyCredentialType but client platforms MUST ignore any PublicKeyCredentialDescriptor with an unknown type.

          -

          This mirrors the type field of PublicKeyCredential.

          +

          This member contains the type of the public key credential the caller is referring to. The value SHOULD be a member of PublicKeyCredentialType but client platforms MUST ignore any PublicKeyCredentialDescriptor with an unknown type.

          +

          This mirrors the type field of PublicKeyCredential.

          +

          Note: If all PublicKeyCredentialDescriptor elements in allowCredentials are ignored then that MUST result in an error since an empty allowCredentials is semantically distinct.

          id, of type BufferSource

          This member contains the credential ID of the public key credential the caller is referring to.

          -

          This mirrors the rawId field of PublicKeyCredential.

          -
          transports, of type sequence<DOMString> +

          This mirrors the rawId field of PublicKeyCredential.

          +
          transports, of type sequence<DOMString>
          -

          This OPTIONAL member contains a hint as to how the client might communicate with the managing authenticator of the public key credential the caller is referring to. The values SHOULD be members of AuthenticatorTransport but client platforms MUST ignore unknown values.

          +

          This OPTIONAL member contains a hint as to how the client might communicate with the managing authenticator of the public key credential the caller is referring to. The values SHOULD be members of AuthenticatorTransport but client platforms MUST ignore unknown values.

          This mirrors the response.getTransports() method -of a PublicKeyCredential structure created by a create() operation. +of a PublicKeyCredential structure created by a create() operation. When registering a new credential, -the Relying Party SHOULD store the value returned from getTransports(). -When creating a PublicKeyCredentialDescriptor for that credential, -the Relying Party SHOULD retrieve that stored value +the Relying Party SHOULD store the value returned from getTransports(). +When creating a PublicKeyCredentialDescriptor for that credential, +the Relying Party SHOULD retrieve that stored value and set it as the value of the transports member.

          @@ -3957,41 +4456,45 @@

          "usb", "nfc", "ble", - "hybrid", + "smart-card", + "hybrid", "internal" };

    -

    Note: The AuthenticatorTransport enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    +

    Note: The AuthenticatorTransport enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    - Authenticators may implement various transports for communicating with clients. This enumeration + Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to how clients might communicate with a particular authenticator in order to obtain an assertion for a - specific credential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may be reached. A Relying Party will typically learn of the supported transports for a public key credential via getTransports(). + specific credential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may be reached. A Relying Party will typically learn of the supported transports for a public key credential via getTransports().
    usb
    -

    Indicates the respective authenticator can be contacted over removable USB.

    +

    Indicates the respective authenticator can be contacted over removable USB.

    nfc
    -

    Indicates the respective authenticator can be contacted over Near Field Communication (NFC).

    +

    Indicates the respective authenticator can be contacted over Near Field Communication (NFC).

    ble
    -

    Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE).

    +

    Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE).

    +
    smart-card +
    +

    Indicates the respective authenticator can be contacted over ISO/IEC 7816 smart card with contacts.

    hybrid
    -

    Indicates the respective authenticator can be contacted using a combination of (often separate) data-transport and proximity mechanisms. This supports, for example, authentication on a desktop computer using a smartphone.

    +

    Indicates the respective authenticator can be contacted using a combination of (often separate) data-transport and proximity mechanisms. This supports, for example, authentication on a desktop computer using a smartphone.

    internal
    -

    Indicates the respective authenticator is contacted using a client device-specific transport, +

    Indicates the respective authenticator is contacted using a client device-specific transport, i.e., it is a platform authenticator. These authenticators are not removable from the client device.

    -

    5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)

    +

    5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)

    typedef long COSEAlgorithmIdentifier;
     
    - A COSEAlgorithmIdentifier's value is a number identifying a cryptographic algorithm. - The algorithm identifiers SHOULD be values registered in the IANA COSE Algorithms registry [IANA-COSE-ALGS-REG], + A COSEAlgorithmIdentifier's value is a number identifying a cryptographic algorithm. + The algorithm identifiers SHOULD be values registered in the IANA COSE Algorithms registry [IANA-COSE-ALGS-REG], for instance, -7 for "ES256" and -257 for "RS256".

    The COSE algorithms registry leaves degrees of freedom to be specified by other parameters in a COSE key. In order to promote interoperability, this specification makes the following additional guarantees of credential public keys:

      @@ -4004,78 +4507,88 @@

      Keys with algorithm EdDSA (-8) MUST specify Ed25519 (6) as the crv parameter. (These always use a compressed form in COSE.)

    -

    These restrictions align with the recommendation in Section 2.1 of [RFC9053].

    +

    These restrictions align with the recommendation in Section 2.1 of [RFC9053].

    -

    Note: There are many checks neccessary to correctly implement signature verification using these algorithms. One of these is that, when processing uncompressed elliptic-curve points, implementations should check that the point is actually on the curve. This check is highlighted because it’s judged to be at particular risk of falling through the gap between a cryptographic library and other code.

    +

    Note: There are many checks neccessary to correctly implement signature verification using these algorithms. One of these is that, when processing uncompressed elliptic-curve points, implementations should check that the point is actually on the curve. This check is highlighted because it’s judged to be at particular risk of falling through the gap between a cryptographic library and other code.

    5.8.6. User Verification Requirement Enumeration (enum UserVerificationRequirement)

    enum UserVerificationRequirement {
    -    "required",
    -    "preferred",
    -    "discouraged"
    +    "required",
    +    "preferred",
    +    "discouraged"
     };
     
    -

    A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its +

    A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs.

    -

    Note: The UserVerificationRequirement enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    +

    Note: The UserVerificationRequirement enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    required
    -

    The Relying Party requires user verification for the operation and will fail the overall ceremony if the -response does not have the UV flag set. -The client MUST return an error if user verification cannot be performed.

    +

    The Relying Party requires user verification for the operation and will fail the overall ceremony if the +response does not have the UV flag set. +The client MUST return an error if user verification cannot be performed.

    preferred
    -

    The Relying Party prefers user verification for the operation if possible, but will not fail the -operation if the response does not have the UV flag set.

    +

    The Relying Party prefers user verification for the operation if possible, but will not fail the +operation if the response does not have the UV flag set.

    discouraged
    -

    The Relying Party does not want user verification employed during the operation (e.g., in the +

    The Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow).

    -

    5.9. Permissions Policy integration

    -
    - -
    -

    Headers/Feature-Policy/publickey-credentials-get

    -

    In only one current engine.

    -
    - FirefoxNoneSafariNoneChrome84+ -
    - OperaNoneEdge84+ -
    - Edge (Legacy)?IENone -
    - Firefox for Android?iOS Safari?Chrome for Android?Android WebView?Samsung Internet?Opera MobileNone -
    -
    -
    -

    This specification defines one policy-controlled feature identified by -the feature-identifier token "publickey-credentials-get". -Its default allowlist is 'self'. [Permissions-Policy]

    -

    A Document's permissions policy determines whether any content in that document is allowed to successfully invoke the Web Authentication API, i.e., via navigator.credentials.get({publicKey:..., ...}). -If disabled in any document, no content in the document will be allowed to use the foregoing methods: attempting to do so will return an error.

    -

    Note: Algorithms specified in [CREDENTIAL-MANAGEMENT-1] perform the actual permissions policy evaluation. This is because such policy evaluation needs to occur when there is access to the current settings object. The [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) internal method does not have such access since it is invoked in parallel by CredentialsContainer's Request a Credential abstract operation [CREDENTIAL-MANAGEMENT-1].

    -

    5.10. Using Web Authentication within iframe elements

    -

    The Web Authentication API is disabled by default in cross-origin iframes. -To override this default policy and indicate that a cross-origin iframe is allowed to invoke the Web Authentication API's [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) method, specify the allow attribute on the iframe element and include the publickey-credentials-get feature-identifier token in the allow attribute’s value.

    -

    Relying Parties utilizing the WebAuthn API in an embedded context should review § 13.4.2 Visibility Considerations for Embedded Usage regarding UI redressing and its possible mitigations.

    +

    5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

    +
    enum PublicKeyCredentialHints {
    +    "security-key",
    +    "client-device",
    +    "hybrid",
    +};
    +
    +

    Note: The PublicKeyCredentialHints enumeration is deliberately not referenced, see § 2.1.1 Enumerations as DOMString types.

    +
    + WebAuthn Relying Parties may use this enumeration to communicate hints to the user-agent about how a request may be best completed. These hints are not requirements, and do not bind the user-agent, but may guide it in providing the best experience by using contextual information that the Relying Party has about the request. Hints are provided in order of decreasing preference so, if two hints are contradictory, the first one controls. Hints may also overlap: if a more-specific hint is defined a Relying Party may still wish to send less specific ones for user-agents that may not recognise the more specific one. In this case the most specific hint should be sent before the less-specific ones. +

    Hints MAY contradict information contained in credential transports and authenticatorAttachment. When this occurs, the hints take precedence. (Note that transports values are not provided when using discoverable credentials, leaving hints as the only avenue for expressing some aspects of such a request.)

    +
    +
    security-key +
    +

    Indicates that the Relying Party believes that users will satisfy this request with a physical security key. For example, an enterprise Relying Party may set this hint if they have issued security keys to their employees and will only accept those authenticators for registration and authentication.

    +

    For compatibility with older user agents, when this hint is used in PublicKeyCredentialCreationOptions, the authenticatorAttachment SHOULD be set to cross-platform.

    +
    client-device +
    +

    Indicates that the Relying Party believes that users will satisfy this request with a platform authenticator attached to the client device.

    +

    For compatibility with older user agents, when this hint is used in PublicKeyCredentialCreationOptions, the authenticatorAttachment SHOULD be set to platform.

    +
    hybrid +
    +

    Indicates that the Relying Party believes that users will satisfy this request with general-purpose authenticators such as smartphones. For example, a consumer Relying Party may believe that only a small fraction of their customers possesses dedicated security keys. This option also implies that the local platform authenticator should not be promoted in the UI.

    +

    For compatibility with older user agents, when this hint is used in PublicKeyCredentialCreationOptions, the authenticatorAttachment SHOULD be set to cross-platform.

    +
    +
    +

    5.9. Permissions Policy integration

    +

    This specification defines two policy-controlled features identified by +the feature-identifier tokens "publickey-credentials-create" +and "publickey-credentials-get". +Their default allowlists are both 'self'. [Permissions-Policy]

    +

    A Document's permissions policy determines whether any content in that document is allowed to successfully invoke the Web Authentication API, i.e., via navigator.credentials.create({publicKey:..., ...}) or navigator.credentials.get({publicKey:..., ...}) If disabled in any document, no content in the document will be allowed to use the foregoing methods: attempting to do so will return an error.

    +

    Note: Algorithms specified in [CREDENTIAL-MANAGEMENT-1] perform the actual permissions policy evaluation. This is because such policy evaluation needs to occur when there is access to the current settings object. The [[Create]](origin, options, sameOriginWithAncestors) and [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) internal methods does not have such access since they are invoked in parallel by CredentialsContainer's Create a Credential and Request a Credential abstract operations [CREDENTIAL-MANAGEMENT-1].

    +

    5.10. Using Web Authentication within iframe elements

    +

    The Web Authentication API is disabled by default in cross-origin iframes. +To override this default policy and indicate that a cross-origin iframe is allowed to invoke the Web Authentication API's [[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors) method, specify the allow attribute on the iframe element and include the publickey-credentials-get feature-identifier token in the allow attribute’s value.

    +

    Relying Parties utilizing the WebAuthn API in an embedded context should review § 13.4.2 Visibility Considerations for Embedded Usage regarding UI redressing and its possible mitigations.

    6. WebAuthn Authenticator Model

    -

    The Web Authentication API implies a specific abstract functional model for a WebAuthn Authenticator. This section +

    The Web Authentication API implies a specific abstract functional model for a WebAuthn Authenticator. This section describes that authenticator model.

    -

    Client platforms MAY implement and expose this abstract model in any way desired. However, the behavior of the client’s Web -Authentication API implementation, when operating on the authenticators supported by that client platform, MUST be indistinguishable +

    Client platforms MAY implement and expose this abstract model in any way desired. However, the behavior of the client’s Web +Authentication API implementation, when operating on the authenticators supported by that client platform, MUST be indistinguishable from the behavior specified in § 5 Web Authentication API.

    -

    Note: [FIDO-CTAP] is an example of a concrete instantiation of this model, but it is one in which there are differences in the data it returns and those expected by the WebAuthn API's algorithms. The CTAP2 response messages are CBOR maps constructed using integer keys rather than the string keys defined in this specification for the same objects. The client is expected to perform any needed transformations on such data. The [FIDO-CTAP] specification details the mapping between CTAP2 integer keys and WebAuthn string keys, in section §6.2. Responses.

    +

    Note: [FIDO-CTAP] is an example of a concrete instantiation of this model, but it is one in which there are differences in the data it returns and those expected by the WebAuthn API's algorithms. The CTAP2 response messages are CBOR maps constructed using integer keys rather than the string keys defined in this specification for the same objects. The client is expected to perform any needed transformations on such data. The [FIDO-CTAP] specification details the mapping between CTAP2 integer keys and WebAuthn string keys, in section §6.2. Responses.

    For authenticators, this model defines the logical operations that they MUST support, and the data formats that they expose to -the client and the WebAuthn Relying Party. However, it does not define the details of how authenticators communicate with the client device, -unless they are necessary for interoperability with Relying Parties. For instance, this abstract model does not define protocols for +the client and the WebAuthn Relying Party. However, it does not define the details of how authenticators communicate with the client device, +unless they are necessary for interoperability with Relying Parties. For instance, this abstract model does not define protocols for connecting authenticators to clients over transports such as USB or NFC. Similarly, this abstract model does not define specific error codes or methods of returning them; however, it does define error behavior in terms of the needs of the client. Therefore, specific error codes are mentioned as a means of showing which error conditions MUST be distinguishable (or not) from each other in order to enable a compliant and secure client implementation.

    -

    Relying Parties may influence authenticator selection, if they deem necessary, by stipulating various authenticator characteristics +

    Relying Parties may influence authenticator selection, if they deem necessary, by stipulating various authenticator characteristics when creating credentials and/or when generating assertions, through use of credential creation options or assertion generation options, respectively. The algorithms underlying the WebAuthn API marshal these options and pass them to the applicable authenticator operations defined below.

    In this abstract model, the authenticator provides key management and cryptographic signatures. It can be embedded in the @@ -4083,29 +4596,30 @@

    -

    Each authenticator stores a credentials map, a map from (rpId, userHandle) to public key credential source.

    -

    Additionally, each authenticator has an AAGUID, which is a 128-bit identifier indicating the type (e.g. make and model) of the -authenticator. The AAGUID MUST be chosen by the manufacturer to be identical across all substantially identical authenticators -made by that manufacturer, and different (with high probability) from the AAGUIDs of all other types of authenticators. -The AAGUID for a given type of authenticator SHOULD be randomly generated to ensure this. The Relying Party MAY use the AAGUID to infer certain -properties of the authenticator, such as certification level and strength of key protection, using information from other sources.

    +

    Each authenticator stores a credentials map, a map from (rpId, userHandle) to public key credential source.

    +

    Additionally, each authenticator has an Authenticator Attestation Globally Unique Identifier or AAGUID, which is a 128-bit identifier +indicating the type (e.g. make and model) of the authenticator. The AAGUID MUST be chosen by its maker to be identical across all substantially identical +authenticators made by that maker, and different (with high probability) from the AAGUIDs of all other types of authenticators. The AAGUID for a given type +of authenticator SHOULD be randomly generated to ensure this. The Relying Party MAY use the AAGUID to infer certain properties of the authenticator, such as +certification level and strength of key protection, using information from other sources. The Relying Party MAY use the AAGUID to attempt to identify the maker of +the authenticator without requesting and verifying attestation, but the AAGUID is not provably authentic without attestation.

    The primary function of the authenticator is to provide WebAuthn signatures, which are bound to various contextual data. These data are observed and added at different levels of the stack as a signature request passes from the server to the authenticator. In verifying a signature, the server checks these bindings against expected values. These contextual bindings -are divided in two: Those added by the Relying Party or the client, referred to as client data; and those added by the authenticator, -referred to as the authenticator data. The authenticator signs over the client data, but is otherwise not interested in +are divided in two: Those added by the Relying Party or the client, referred to as client data; and those added by the authenticator, +referred to as the authenticator data. The authenticator signs over the client data, but is otherwise not interested in its contents. To save bandwidth and processing requirements on the authenticator, the client hashes the client data and -sends only the result to the authenticator. The authenticator signs over the combination of the hash of the serialized client data, and its own authenticator data.

    +sends only the result to the authenticator. The authenticator signs over the combination of the hash of the serialized client data, and its own authenticator data.

    The goals of this design can be summarized as follows.

    • -

      The scheme for generating signatures should accommodate cases where the link between the client device and authenticator +

      The scheme for generating signatures should accommodate cases where the link between the client device and authenticator is very limited, in bandwidth and/or latency. Examples include Bluetooth Low Energy and Near-Field Communication.

    • The data processed by the authenticator should be small and easy to interpret in low-level code. In particular, authenticators should not have to parse high-level encodings such as JSON.

    • -

      Both the client and the authenticator should have the flexibility to add contextual bindings as needed.

      +

      Both the client and the authenticator should have the flexibility to add contextual bindings as needed.

    • The design aims to reuse as much as possible of existing encoding formats in order to aid adoption and implementation.

    @@ -4113,29 +4627,29 @@

  • An attestation signature is produced when a new public key credential is created via an authenticatorMakeCredential operation. An attestation signature provides cryptographic -proof of certain properties of the authenticator and the credential. For instance, an attestation signature asserts the authenticator type (as denoted by its AAGUID) and the credential public key. The attestation -signature is signed by an attestation private key, which is chosen depending on the type of attestation desired. -For more details on attestation, see § 6.5 Attestation.

    +proof of certain properties of the authenticator and the credential. For instance, an attestation signature asserts the authenticator type (as denoted by its AAGUID) and the credential public key. The attestation +signature is signed by an attestation private key, which is chosen depending on the type of attestation desired. +For more details on attestation, see § 6.5 Attestation.

  • An assertion signature is produced when the authenticatorGetAssertion method is invoked. It represents an -assertion by the authenticator that the user has consented to a specific transaction, such as logging -in, or completing a purchase. Thus, an assertion signature asserts that the authenticator possessing a particular credential private key has established, to the best of its ability, that the user requesting this transaction is the +assertion by the authenticator that the user has consented to a specific transaction, such as logging +in, or completing a purchase. Thus, an assertion signature asserts that the authenticator possessing a particular credential private key has established, to the best of its ability, that the user requesting this transaction is the same user who consented to creating that particular public key credential. It also asserts additional information, termed client data, that may be useful to the caller, such as the means by which user consent was -provided, and the prompt shown to the user by the authenticator. The assertion signature format is illustrated in Figure 4, below.

    +provided, and the prompt shown to the user by the authenticator. The assertion signature format is illustrated in Figure 4, below.

    The term WebAuthn signature refers to both attestation signatures and assertion signatures. The formats of these signatures, as well as the procedures for generating them, are specified below.

    6.1. Authenticator Data

    -

    The authenticator data structure encodes contextual bindings made by the authenticator. These bindings are -controlled by the authenticator itself, and derive their trust from the WebAuthn Relying Party's assessment of the security properties of the +

    The authenticator data structure encodes contextual bindings made by the authenticator. These bindings are +controlled by the authenticator itself, and derive their trust from the WebAuthn Relying Party's assessment of the security properties of the authenticator. In one extreme case, the authenticator may be embedded in the client, and its bindings may be no more trustworthy than the client data. At the other extreme, the authenticator may be a discrete entity with high-security hardware and -software, connected to the client over a secure channel. In both cases, the Relying Party receives the authenticator data in the same +software, connected to the client over a secure channel. In both cases, the Relying Party receives the authenticator data in the same format, and uses its knowledge of the authenticator to make trust decisions.

    -

    The authenticator data has a compact but extensible encoding. This is desired since authenticators can be devices with -limited capabilities and low power requirements, with much simpler software stacks than the client platform.

    -

    The authenticator data structure is a byte array of 37 bytes or more, +

    The authenticator data has a compact but extensible encoding. This is desired since authenticators can be devices with +limited capabilities and low power requirements, with much simpler software stacks than the client platform.

    +

    The authenticator data structure is a byte array of 37 bytes or more, laid out as shown in Table .

    @@ -4176,20 +4690,20 @@

    Bit 3: Backup Eligibility (BE).

  • Bit 4: Backup State (BS).

  • -

    Bits 5: Reserved for future use (RFU2).

    +

    Bit 5: Reserved for future use (RFU2).

  • Bit 6: Attested credential data included (AT).

  • @@ -4210,62 +4724,62 @@

    attestedCredentialData variable (if present) - attested credential data (if present). See § 6.5.1 Attested Credential Data for details. Its length depends on + attested credential data (if present). See § 6.5.2 Attested Credential Data for details. Its length depends on the length of the credential ID and credential public key being attested.
    extensions variable (if present) - Extension-defined authenticator data. This is a CBOR [RFC8949] map with extension identifiers as keys, + Extension-defined authenticator data. This is a CBOR [RFC8949] map with extension identifiers as keys, and authenticator extension outputs as values. See § 9 WebAuthn Extensions for details.
    -
    Authenticator data layout. The names in the Name column are only for reference within this document, and are not - present in the actual representation of the authenticator data.
    +
    Authenticator data layout. The names in the Name column are only for reference within this document, and are not + present in the actual representation of the authenticator data.
    -

    The RP ID is originally received from the client when the credential is created, and again when an assertion is generated. +

    The RP ID is originally received from the client when the credential is created, and again when an assertion is generated. However, it differs from other client data in some important ways. First, unlike the client data, the RP ID of a credential does not change between operations but instead remains the same for the lifetime of that credential. Secondly, it is validated by the authenticator during the authenticatorGetAssertion operation, by verifying that the RP ID that -the requested credential is scoped to exactly matches the RP ID supplied by the client.

    -

    Authenticators perform the following steps to generate an authenticator data structure:

    +the requested credential is scoped to exactly matches the RP ID supplied by the client.

    +

    Authenticators perform the following steps to generate an authenticator data structure:

    -

    Figure shows a visual representation of the authenticator data structure.

    +

    Figure shows a visual representation of the authenticator data structure.

    -
    Authenticator data layout.
    +
    Authenticator data layout.
    - Note: authenticator data describes its own length: If the AT and ED flags are not set, it is always 37 bytes long. - The attested credential data (which is only present if the AT flag is set) describes its own length. If the ED flag is set, then the total length is 37 bytes plus the length of the attested credential data (if the AT flag is set), plus the length of the extensions output (a CBOR map) that + Note: authenticator data describes its own length: If the AT and ED flags are not set, it is always 37 bytes long. + The attested credential data (which is only present if the AT flag is set) describes its own length. If the ED flag is set, then the total length is 37 bytes plus the length of the attested credential data (if the AT flag is set), plus the length of the extensions output (a CBOR map) that follows. -

    Determining attested credential data's length, which is variable, involves determining credentialPublicKey’s beginning location given the preceding credentialId’s length, and then determining the credentialPublicKey’s length (see also Section 7 of [RFC9052]).

    +

    Determining attested credential data's length, which is variable, involves determining credentialPublicKey’s beginning location given the preceding credentialId’s length, and then determining the credentialPublicKey’s length (see also Section 7 of [RFC9052]).

    6.1.1. Signature Counter Considerations

    Authenticators SHOULD implement a signature counter feature. These counters are conceptually stored for each credential -by the authenticator, or globally for the authenticator as a whole. The initial value of a credential’s signature counter is specified in the signCount value of the authenticator data returned by authenticatorMakeCredential. The signature counter is incremented for each successful authenticatorGetAssertion operation by some positive value, and subsequent values are returned to the WebAuthn Relying Party within the authenticator data again. The signature counter's purpose is to aid Relying Parties in detecting cloned authenticators. Clone +by the authenticator, or globally for the authenticator as a whole. The initial value of a credential’s signature counter is specified in the signCount value of the authenticator data returned by authenticatorMakeCredential. The signature counter is incremented for each successful authenticatorGetAssertion operation by some positive value, and subsequent values are returned to the WebAuthn Relying Party within the authenticator data again. The signature counter's purpose is to aid Relying Parties in detecting cloned authenticators. Clone detection is more important for authenticators with limited protection measures.

    -

    Authenticators that do not implement a signature counter leave the signCount in the authenticator data constant at zero.

    -

    A Relying Party stores the signature counter of the most recent authenticatorGetAssertion operation. (Or the counter from the authenticatorMakeCredential operation if no authenticatorGetAssertion has ever been performed on a credential.) In subsequent authenticatorGetAssertion operations, the Relying Party compares the stored signature counter value with the new signCount value returned in the assertion’s authenticator data. If either is non-zero, and the new signCount value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.

    -

    Detecting a signature counter mismatch does not indicate whether the current operation was performed by a cloned authenticator or the original authenticator. Relying Parties should address this situation appropriately relative to their individual situations, i.e., their risk tolerance.

    +

    Authenticators that do not implement a signature counter leave the signCount in the authenticator data constant at zero.

    +

    A Relying Party stores the signature counter of the most recent authenticatorGetAssertion operation. (Or the counter from the authenticatorMakeCredential operation if no authenticatorGetAssertion has ever been performed on a credential.) In subsequent authenticatorGetAssertion operations, the Relying Party compares the stored signature counter value with the new signCount value returned in the assertion’s authenticator data. If either is non-zero, and the new signCount value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.

    +

    Detecting a signature counter mismatch does not indicate whether the current operation was performed by a cloned authenticator or the original authenticator. Relying Parties should address this situation appropriately relative to their individual situations, i.e., their risk tolerance.

    Authenticators:

    6.1.2. FIDO U2F Signature Format Compatibility

    -

    The format for assertion signatures, which sign over the concatenation of an authenticator data structure and the hash -of the serialized client data, are compatible with the FIDO U2F authentication signature format (see Section 5.4 of [FIDO-U2F-Message-Formats]).

    -

    This is because the first 37 bytes of the signed data in a FIDO U2F authentication response message constitute a valid authenticator data structure, and the remaining 32 bytes are the hash of the serialized client data. In this authenticator data structure, the rpIdHash is the FIDO U2F application parameter, all flags except UP are always zero, and the attestedCredentialData and extensions are never present. FIDO U2F authentication signatures can therefore be verified by +

    The format for assertion signatures, which sign over the concatenation of an authenticator data structure and the hash +of the serialized client data, are compatible with the FIDO U2F authentication signature format (see Section 5.4 of [FIDO-U2F-Message-Formats]).

    +

    This is because the first 37 bytes of the signed data in a FIDO U2F authentication response message constitute a valid authenticator data structure, and the remaining 32 bytes are the hash of the serialized client data. In this authenticator data structure, the rpIdHash is the FIDO U2F application parameter, all flags except UP are always zero, and the attestedCredentialData and extensions are never present. FIDO U2F authentication signatures can therefore be verified by the same procedure as other assertion signatures generated by the authenticatorGetAssertion operation.

    6.1.3. Credential Backup State

    -

    Credential backup eligibility and current backup state is conveyed by the BE and BS flags in the authenticator data, as +

    Credential backup eligibility and current backup state is conveyed by the BE and BS flags in the authenticator data, as defined in Table .

    -

    The value of the BE flag is set during authenticatorMakeCredential operation and MUST NOT change.

    -

    The value of the BS flag may change over time based on the current state of the public key credential source. Table below defines +

    The value of the BE flag is set during authenticatorMakeCredential operation and MUST NOT change.

    +

    The value of the BS flag may change over time based on the current state of the public key credential source. Table below defines valid combinations and their meaning.

    @@ -4301,65 +4815,65 @@

    1 0 - The credential is a multi-device credential and is not currently backed up. + The credential is a multi-device credential and is not currently backed up.
    1 1 - The credential is a multi-device credential and is currently backed up. + The credential is a multi-device credential and is currently backed up.
    -
    BE and BS flag combinations
    +
    BE and BS flag combinations
    -

    It is RECOMMENDED that Relying Parties store the most recent value of these flags with the user account for future evaluation.

    -

    The following is a non-exhaustive list of how Relying Parties might use these flags:

    +

    It is RECOMMENDED that Relying Parties store the most recent value of these flags with the user account for future evaluation.

    +

    The following is a non-exhaustive list of how Relying Parties might use these flags:

    6.2. Authenticator Taxonomy

    -

    Many use cases are dependent on the capabilities of the authenticator used. +

    Many use cases are dependent on the capabilities of the authenticator used. This section defines some terminology for those capabilities, their most important combinations, and which use cases those combinations enable.

    For example:

    -

    The above examples illustrate the the primary authenticator type characteristics:

    +

    The above examples illustrate the primary authenticator type characteristics:

    @@ -4394,109 +4908,110 @@

    cross-platform Client-side storage Multi-factor capable + + Passkey platform authenticator + platform (transport = internal) or cross-platform (transport = hybrid) + Client-side storage + Multi-factor capable
    Definitions of names for some authenticator types.

  • -

    A second-factor platform authenticator is convenient to use for re-authentication on the same client device, +

    A second-factor platform authenticator is convenient to use for re-authentication on the same client device, and can be used to add an extra layer of security both when initiating a new session and when resuming an existing session. A second-factor roaming authenticator is more likely to be used -to authenticate on a particular client device for the first time, -or on a client device shared between multiple users.

    -

    User-verifying platform authenticators and first-factor roaming authenticators enable passwordless multi-factor authentication. +to authenticate on a particular client device for the first time, +or on a client device shared between multiple users.

    +

    User-verifying platform authenticators and first-factor roaming authenticators enable passwordless multi-factor authentication. In addition to the proof of possession of the credential private key, -these authenticators support user verification as a second authentication factor, +these authenticators support user verification as a second authentication factor, typically a PIN or biometric recognition. -The authenticator can thus act as two kinds of authentication factor, -which enables multi-factor authentication while eliminating the need to share a password with the Relying Party.

    -

    The four combinations not named in Table have less distinguished use cases:

    +The authenticator can thus act as two kinds of authentication factor, +which enables multi-factor authentication while eliminating the need to share a password with the Relying Party.

    +

    The combinations not named in Table have less distinguished use cases:

    -

    The following subsections define the aspects authenticator attachment modality, credential storage modality and authentication factor capability in more depth.

    +

    The following subsections define the aspects authenticator attachment modality, credential storage modality and authentication factor capability in more depth.

    6.2.1. Authenticator Attachment Modality

    -

    Clients can communicate with authenticators using a variety of mechanisms. For example, a client MAY use a client device-specific API to communicate with an authenticator which is physically bound to a client device. On the other hand, a client can use a variety of standardized cross-platform transport protocols such as Bluetooth (see § 5.8.4 Authenticator Transport Enumeration (enum AuthenticatorTransport)) to discover -and communicate with cross-platform attached authenticators. We refer to authenticators that -are part of the client device as platform authenticators, while those that are reachable via cross-platform +

    Clients can communicate with authenticators using a variety of mechanisms. For example, a client MAY use a client device-specific API to communicate with an authenticator which is physically bound to a client device. On the other hand, a client can use a variety of standardized cross-platform transport protocols such as Bluetooth (see § 5.8.4 Authenticator Transport Enumeration (enum AuthenticatorTransport)) to discover +and communicate with cross-platform attached authenticators. We refer to authenticators that +are part of the client device as platform authenticators, while those that are reachable via cross-platform transport protocols are referred to as roaming authenticators.

    -

    Some platform authenticators could possibly also act as roaming authenticators depending on context. For example, a platform authenticator integrated into a mobile device could make itself available as a roaming authenticator via +

    Some platform authenticators could possibly also act as roaming authenticators depending on context. For example, a platform authenticator integrated into a mobile device could make itself available as a roaming authenticator via Bluetooth. -In this case clients running on the mobile device would recognise the authenticator as a platform authenticator, -while clients running on a different client device and communicating with the same authenticator via Bluetooth -would recognize it as a roaming authenticator.

    -

    The primary use case for platform authenticators is to register a particular client device as a "trusted device", -so the client device itself acts as a something you have authentication factor for future authentication. +In this case clients running on the mobile device would recognise the authenticator as a platform authenticator, +while clients running on a different client device and communicating with the same authenticator via Bluetooth +would recognize it as a roaming authenticator.

    +

    The primary use case for platform authenticators is to register a particular client device as a "trusted device", +so the client device itself acts as a something you have authentication factor for future authentication. This gives the user the convenience benefit -of not needing a roaming authenticator for future authentication ceremonies, e.g., the user will not have to dig around in +of not needing a roaming authenticator for future authentication ceremonies, e.g., the user will not have to dig around in their pocket for their key fob or phone.

    -

    Use cases for roaming authenticators include: authenticating on a new client device for the first time, -on rarely used client devices, client devices shared between multiple users, -or client devices that do not include a platform authenticator; -and when policy or preference dictates that the authenticator be kept separate from the client devices it is used with. -A roaming authenticator can also be used to hold -backup credentials in case another authenticator is lost.

    +

    Use cases for roaming authenticators include: authenticating on a new client device for the first time, +on rarely used client devices, client devices shared between multiple users, +or client devices that do not include a platform authenticator; +and when policy or preference dictates that the authenticator be kept separate from the client devices it is used with. +A roaming authenticator can also be used to hold +backup credentials in case another authenticator is lost.

    6.2.2. Credential Storage Modality

    -

    An authenticator can store a public key credential source in one of two ways:

    +

    An authenticator can store a public key credential source in one of two ways:

    1. -

      In persistent storage embedded in the authenticator, client or client device, e.g., in a secure element. +

      In persistent storage embedded in the authenticator, client or client device, e.g., in a secure element. This is a technical requirement for a client-side discoverable public key credential source.

    2. -

      By encrypting (i.e., wrapping) the credential private key such that only this authenticator can decrypt (i.e., unwrap) it and letting the resulting -ciphertext be the credential ID for the public key credential source. The credential ID is stored by the Relying Party and returned to the authenticator via the allowCredentials option of get(), which allows the authenticator to decrypt and use the credential private key.

      -

      This enables the authenticator to have unlimited storage capacity for credential private keys, since the encrypted credential private keys are stored by the Relying Party instead of by the authenticator - but it means that a credential stored in this way must be retrieved from the Relying Party before the authenticator can use it.

      +

      By encrypting (i.e., wrapping) the credential private key such that only this authenticator can decrypt (i.e., unwrap) it and letting the resulting +ciphertext be the credential ID for the public key credential source. The credential ID is stored by the Relying Party and returned to the authenticator via the allowCredentials option of get(), which allows the authenticator to decrypt and use the credential private key.

      +

      This enables the authenticator to have unlimited storage capacity for credential private keys, since the encrypted credential private keys are stored by the Relying Party instead of by the authenticator - but it means that a credential stored in this way must be retrieved from the Relying Party before the authenticator can use it.

    -

    Which of these storage strategies an authenticator supports defines the authenticator's credential storage +

    Which of these storage strategies an authenticator supports defines the authenticator's credential storage modality as follows:

    -

    Note that a discoverable credential capable authenticator MAY support both storage strategies. In this case, the authenticator MAY -at its discretion use different storage strategies for different credentials, though subject to the residentKey or requireResidentKey options of create().

    +

    Note that a discoverable credential capable authenticator MAY support both storage strategies. In this case, the authenticator MAY +at its discretion use different storage strategies for different credentials, though subject to the residentKey or requireResidentKey options of create().

    6.2.3. Authentication Factor Capability

    -

    There are three broad classes of authentication factors that can be used to prove an identity during an authentication -ceremony: something you have, something you know and something you are. Examples include a physical key, a password, +

    There are three broad classes of authentication factors that can be used to prove an identity during an authentication +ceremony: something you have, something you know and something you are. Examples include a physical key, a password, and a fingerprint, respectively.

    -

    All WebAuthn Authenticators belong to the something you have class, but an authenticator that supports user -verification can also act as one or two additional kinds of authentication factor. For example, if the authenticator can -verify a PIN, the PIN is something you know, and a biometric authenticator can verify something you are. Therefore, an authenticator that supports user verification is multi-factor capable. Conversely, an authenticator that is -not multi-factor capable is single-factor capable. Note that a single multi-factor capable authenticator could support several modes of user verification, meaning it could act as all three kinds of authentication factor.

    -

    Although user verification is performed locally on the authenticator and not by the Relying Party, the authenticator indicates if user verification was performed by setting the UV flag in the signed response returned to the Relying Party. -The Relying Party can therefore use the UV flag to verify that additional authentication factors were used in a registration or authentication ceremony. The authenticity of the UV flag can in turn be assessed by inspecting the authenticator's attestation statement.

    +

    All WebAuthn Authenticators belong to the something you have class, but an authenticator that supports user +verification can also act as one or two additional kinds of authentication factor. For example, if the authenticator can +verify a PIN, the PIN is something you know, and a biometric authenticator can verify something you are. Therefore, an authenticator that supports user verification is multi-factor capable. Conversely, an authenticator that is +not multi-factor capable is single-factor capable. Note that a single multi-factor capable authenticator could support several modes of user verification, meaning it could act as all three kinds of authentication factor.

    +

    Although user verification is performed locally on the authenticator and not by the Relying Party, the authenticator indicates if user verification was performed by setting the UV flag in the signed response returned to the Relying Party. +The Relying Party can therefore use the UV flag to verify that additional authentication factors were used in a registration or authentication ceremony. The authenticity of the UV flag can in turn be assessed by inspecting the authenticator's attestation statement.

    6.3. Authenticator Operations

    A WebAuthn Client MUST connect to an authenticator in order to invoke any of the operations of that authenticator. This connection defines an authenticator session. An authenticator must maintain isolation between sessions. It may do this by only allowing one session to exist at any particular time, or by providing more complicated session management.

    The following operations can be invoked by the client in an authenticator session.

    6.3.1. Lookup Credential Source by Credential ID Algorithm

    -

    The result of looking up a credential id credentialId in an authenticator authenticator is the result of the following algorithm:

    +

    The result of looking up a credential id credentialId in an authenticator authenticator is the result of the following algorithm:

    1. -

      If authenticator can decrypt credentialId into a public key credential source credSource:

      +

      If authenticator can decrypt credentialId into a public key credential source credSource:

      1. Set credSource.id to credentialId.

        @@ -4504,7 +5019,7 @@

    -
    supported, of type boolean +
    supported, of type boolean

    true if, and only if, the created credential supports storing large blobs. Only present in registration outputs.

    blob, of type ArrayBuffer

    The opaque byte string that was associated with the credential identified by rawId. Only valid if read was true.

    -
    written, of type boolean +
    written, of type boolean
    -

    A boolean that indicates that the contents of write were successfully stored on the authenticator, associated with the specified credential.

    +

    A boolean that indicates that the contents of write were successfully stored on the authenticator, associated with the specified credential.

    Authenticator extension processing
    -

    This extension directs the user-agent to cause the large blob to be stored on, or retrieved from, the authenticator. It thus does not specify any direct authenticator interaction for Relying Parties.

    +

    This extension directs the user-agent to cause the large blob to be stored on, or retrieved from, the authenticator. It thus does not specify any direct authenticator interaction for Relying Parties.

    10.2. Authenticator Extensions

    This section defines extensions that are both client extensions and authenticator extensions.

    @@ -6638,9 +7313,9 @@

    Registration and Authentication

    Client extension input
    -

    The Boolean value true to indicate that this extension is requested by the Relying Party.

    +

    The Boolean value true to indicate that this extension is requested by the Relying Party.

    partial dictionary AuthenticationExtensionsClientInputs {
    -  boolean uvm;
    +  boolean uvm;
     };
     
    Client extension processing @@ -6649,8 +7324,8 @@

    Client extension output

    Returns a JSON array of 3-element arrays of numbers that encodes the factors in the authenticator extension output.

    -
    typedef sequence<unsigned long> UvmEntry;
    -typedef sequence<UvmEntry> UvmEntries;
    +
    typedef sequence<unsigned long> UvmEntry;
    +typedef sequence<UvmEntry> UvmEntries;
     
     partial dictionary AuthenticationExtensionsClientOutputs {
       UvmEntries uvm;
    @@ -6665,7 +7340,7 @@ 

    Authenticator extension processing
    -

    The authenticator sets the authenticator extension output to be one or more user verification methods indicating the method(s) used +

    The authenticator sets the authenticator extension output to be one or more user verification methods indicating the method(s) used by the user to authorize the operation, as defined below. This extension can be added to attestation objects and assertions.

    Authenticator extension output
    @@ -6685,19 +7360,19 @@

    userVerificationMethod
    -

    The authentication method/factor used by the authenticator to verify the user. Available values are defined in Section 3.1 User Verification Methods of [FIDO-Registry].

    +

    The authentication method/factor used by the authenticator to verify the user. Available values are defined in Section 3.1 User Verification Methods of [FIDO-Registry].

    keyProtectionType

    The method used by the authenticator to protect the FIDO registration private key material. Available values are defined -in Section 3.2 Key Protection Types of [FIDO-Registry].

    +in Section 3.2 Key Protection Types of [FIDO-Registry].

    matcherProtectionType

    The method used by the authenticator to protect the matcher that performs user verification. Available values are defined -in Section 3.3 Matcher Protection Types of [FIDO-Registry].

    +in Section 3.3 Matcher Protection Types of [FIDO-Registry].

    If >3 factors can be used in an authentication instance the authenticator vendor MUST select the 3 factors it believes will be most relevant to the Server to include in the UVM.

    -

    Example for authenticator data containing one UVM extension for a multi-factor authentication instance where 2 factors +

    Example for authenticator data containing one UVM extension for a multi-factor authentication instance where 2 factors were used:

    ...                    -- RP ID hash (32 bytes)
     81                     -- UP and ED set
    @@ -6717,8 +7392,453 @@ 

    +

    10.2.2. Supplemental public keys extension (supplementalPubKeys)

    +

    This authenticator registration extension and authentication extension provides a Relying Party with additional public key(s) for credentials. This is done by creating user credential-specific key pairs on the authenticator, when required key pairs do not already exist for the user credential being created or exercised, and returning these supplemental keys (along with signatures by them) to the Relying Party. This is done each time this supplementalPubKeys extension is included with either a navigator.credentials.create() or navigator.credentials.get() call.

    +

    If the authenticator is incapable of generating a supplemental key pair, or the registration or authentication operation fails for any reason, that key pair is omitted from the output. If no supplemental key pairs remain then this extension is ignored. In this case, there is no supplementalPubKeys extension output generated.

    +

    Supplemental keys are not user credentials and they do not have their own credential IDs. Instead, any returned keys are a contextual attribute of their associated user credential. That is, when that user credential is used—along with the supplementalPubKeys extension—on a particular authenticator, a particular set of supplemental keys are returned by the extension, along with signatures demonstrating proof-of-possession of those keys.

    +

    Supplemental keys never have a scope that is larger than the user credential. That is, they are never shared between any two user credentials and can never be used to link two user credentials together. They only communicate continuity of some property of their associated user credential.

    +
    10.2.2.1. Relying Party Usage
    +

    This extension is intended for use by those Relying Parties employing risk-analysis systems informing their sign-in decisions. This extension signals the continuity of some property when used consistently with both navigator.credentials.create() and navigator.credentials.get() operations. The property being signaled depends on the scope of the supplemental key and its attestation statement, if any. The clearest example of a supplemental key is one that is device-bound. Repeated observation of a device-bound supplemental key indicates that a credential is being used repeatedly from the same device. (Which cannot be otherwise assumed in the case of backup eligible credentials.) But supplemental keys with wider scopes are also defined and the exact properties that they communicate depend on the attestation included along with them.

    +

    When a Relying Party uses the supplementalPubKeys extension with a create() call to create a new user credential, a signature by one or more new supplemental keys may be returned along with the new supplemental public keys themselves. For the sake of example, assume that a single supplemental public key is returned, called “SPK1”. For as long as the user credential is exercised within the scope of the supplemental key, the Relying Party's subsequent get() operations for that credential will likely generate assertions including further signatures by “SPK1”.

    +

    The credential may move beyond the scope of that supplemental key (for example, by being exported and imported elsewhere, if backup eligible) and, if used in this new domain, the get() operation will return a new supplemental key, SPK2, and its signature. Subsequent get() operations may observe either SPK1 or SPK2, depending on the context in which the user credential is being used.

    +

    A usage example is thus:

    +
    +

    A sign-in request is received by a website that, by regulation, must require certain authentication standards. The sign-in is done with a multi-device credential, but also includes a supplemental key with an attestation that states that the supplemental key is only synced after a user has met or exceeded those standards. Since that supplemental key has been seen before, and was initially verified to meet the site’s authentication standards, additional sign-in challenges are not required.

    +
    +

    Another example of supplemental keys:

    +
    +

    Say that a sign-in request appears at a website along with some geolocation signal that has not been seen for this user account before, and is outside of the typical usage hours observed for the account. The risk may be deemed high enough not to allow the request, even with an assertion by a multi-device credential on its own. But if a signature from a supplemental key that is device-bound, and that is well established for this user can also be presented, then that may tip the balance.

    +
    +

    The weight that Relying Parties give to the presence of a signature from a supplemental key may be based on information learned from its optional attestation. An attestation can indicate the level of protection enjoyed by a hardware-bound key, or the policies for other types of supplemental key.

    +
    10.2.2.2. Extension Definition
    +
    +
    Extension identifier +
    +

    supplementalPubKeys

    +
    Operation applicability +
    +

    Registration and authentication

    +
    Client extension input +
    +
    dictionary AuthenticationExtensionsSupplementalPubKeysInputs {
    +    required sequence<DOMString> scopes;
    +    DOMString attestation = "indirect";
    +    sequence<DOMString> attestationFormats = [];
    +};
    +
    +partial dictionary AuthenticationExtensionsClientInputs {
    +    AuthenticationExtensionsSupplementalPubKeysInputs supplementalPubKeys;
    +};
    +
    +
    +
    +
    scopes, of type sequence<DOMString> +
    +

    This required member MUST be non-empty. It specifies the scopes of supplemental public keys that the Relying Party requests. Values are taken from the CDDL below (i.e., currently defined values are provider and device); authenticators silently ignore unrecognized values. Specifying the scopes that a Relying Party can use allows an authenticator to avoid the work of generating superfluous supplemental keys.

    +
    attestation, of type DOMString, defaulting to "indirect" +
    +

    The Relying Party MAY use this OPTIONAL member to specify a preference regarding attestation conveyance. +Its value SHOULD be a member of AttestationConveyancePreference. Client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.

    +

    The default value is indirect.

    +
    attestationFormats, of type sequence<DOMString>, defaulting to [] +
    +

    The Relying Party MAY use this OPTIONAL member to specify a preference regarding the attestation statement format used by the authenticator. +Values SHOULD be taken from the IANA "WebAuthn Attestation Statement Format Identifiers" registry [IANA-WebAuthn-Registries] established by [RFC8809]. +Values are ordered from most preferable to least preferable. +This parameter is advisory and the authenticator MAY use an attestation statement not enumerated in this parameter.

    +

    The default value is the empty list, which indicates no preference.

    +
    +
    +
    Client extension processing +
    +

    If supplementalPubKeys is present, the client creates the authenticator extension input from the client extension input.

    +
    Client extension output +
    +

    A sequence of ArrayBuffers containing the signatures returned as the unsigned extension output.

    +
    dictionary AuthenticationExtensionsSupplementalPubKeysOutputs {
    +    sequence<ArrayBuffer> signatures;
    +};
    +
    +partial dictionary AuthenticationExtensionsClientOutputs {
    +    AuthenticationExtensionsSupplementalPubKeysOutputs supplementalPubKeys;
    +};
    +
    +
    Authenticator extension input +
    +

    A CBOR expression of the client extension input

    +
    supplementalPublicKeyInputs = {
    +  scopes: [+
    +    ; A key that has a broader scope than a single device, but still more
    +    ; limited than a multi-device credential. The precise scope is specified
    +    ; by the attestation of this supplemental public key.
    +    "provider" /
    +
    +    ; A key with "device" scope MUST NOT leave the device on which it is
    +    ; created.
    +    "device"],
    +  attestation: tstr,
    +  attestationFormats: [* tstr],
    +}
    +$$extensionInput //= (
    +  supplementalPubKeys: supplementalPublicKeyInputs,
    +)
    +
    +
    Authenticator extension output +
    +

    The supplemental public key attestation objects, defined by the attObjForSupplementalPubKey type:

    +
    $$extensionOutput //= (
    +    ; This array of supplemental public keys MUST be ordered
    +    ; lexicographically by scope and MUST NOT include more than one element
    +    ; with a given scope.
    +
    +    supplementalPubKeys: [+ attObjForSupplementalPubKey],
    +)
    +
    +; This object conveys an attested supplemental public key and is analogous
    +; to \`attObj\`.
    +attObjForSupplementalPubKey = {
    +    aaguid:  bstr,  ; AAGUID (16 bytes fixed-length)
    +                    ; https://www.w3.org/TR/webauthn/#aaguid
    +
    +    spk:     bstr,  ; The public key (self-describing variable length,
    +                    ; COSE_Key format, CBOR-encoded)).
    +
    +    ; See the definition of `scopes` in `supplementalPublicKeyInputs`.
    +
    +    scope: "provider" / "device",
    +
    +    ; An authenticator-generated random nonce for inclusion in the attestation
    +    ; signature. If the authenticator chooses to not generate a nonce, it sets this
    +    ; to a zero-length byte string. See the note below about "randomNonce" for a
    +    ; discussion on the nonce’s purpose.
    +
    +    nonce: bstr .size (0..32),
    +
    +    ; See https://www.w3.org/TR/webauthn/#sctn-generating-an-attestation-object
    +    ;
    +    ; Attestation statement formats define the \`fmt\` and \`attStmt\` members of
    +    ; $$attStmtType.
    +    ; Note that \`fmt\` and \`attStmt\` are top-level members of
    +    ; \`attObjForSupplementalPubKey\`.
    +    ;
    +    ; In summary, the \`attStmt\` will (typically) contain:
    +    ;   (1) a SIGNATURE value calculated (using the attestation private key)
    +    ;       over (prefix || aaguid || spk || nonce) where \`prefix\` is
    +    ;       h’737570706c656d656e74616c5075624b657973206174746573746174696f6e2e
    +    ;         00ffffffff'.
    +    ;       (See the attestation calculations section, below, for a discussion
    +    ;       about the purpose of this \`prefix\` value.)
    +    ;   (2) the attestation certificate or public key, and supporting certificates,
    +    ;       if any.
    +    ;
    +    ; Note that there are details dependent upon the particular attestation
    +    ; statement format.
    +    ; See https://www.w3.org/TR/webauthn/#sctn-defined-attestation-formats.
    +
    +    $$attStmtType,
    +
    +    ; An optional boolean that indicates whether the attestation statement
    +    ; contains uniquely identifying information. This can only be true
    +    ; when the \`attestation\` field of the extension input is "enterprise"
    +    ; and either the user-agent or the authenticator permits uniquely
    +    ; identifying attestation for the requested RP ID.
    +
    +    ? epAtt: bool .default false,
    +}
    +
    +
    +
    Unsigned extension output +
    +

    A non-empty CBOR array of byte strings containing the signatures generated with the supplemental private keys, in the same order as in the authenticator extension output.

    +
    supplementalPublicKeyOutputs = [+ bstr]
    +
    +$$unsignedExtensionOutputs //= (
    +  supplementalPubKeys: supplementalPublicKeyOutputs,
    +)
    +
    +
    Authenticator extension processing +
    +

    For both authenticatorMakeCredential and authenticatorGetAssertion operations:

    +
      +
    1. +

      Create or select the public key credential source as usual (see § 6.3.2 The authenticatorMakeCredential Operation, or § 6.3.3 The authenticatorGetAssertion Operation as appropriate).

      +
    2. +

      Let scopes be the set of all supplemental public key scopes that the authenticator supports. Update scopes to be the intersection of itself and scopes. If scopes is empty, terminate these processing steps with no extension output.

      +
    3. +

      Let spks and spkSigs be empty arrays.

      +
    4. +

      Sort scopes lexicographically.

      +
    5. +

      For each scope in scopes:

      +
        +
      1. +

        If a supplemental key with scope scope does not already exist for this {Credential ID, RP ID, userHandle} tuple on the authenticator, create it using the same public key algorithm as that used by the user credential's credential key pair, otherwise locate the existing supplemental key.

        +
      2. +

        Let attFormat be the chosen attestation statement format, and attAaguid be a 16-byte value, based on the value of attestation in the extension input:

        +
        +
        none +
        +

        attFormat is "none" or "self", at the authenticator’s discretion, and attAaguid is 16 zero bytes. (Note that, since the supplemental public key is already exercised during navigator.credentials.create() calls, the proof-of-possession property provided by "self" attestation is superfluous in that context.)

        +
        indirect, direct +
        +

        attFormat is an attestation statement format appropriate for this authenticator based on attestationFormats, and attAaguid is the corresponding AAGUID, which MAY be the authenticator’s AAGUID. (Since the supplemental public key's scope is different from the user credential, it will often have a different attestation. For example, the attestation for a supplemental public key with “device” scope can be tied to hardware roots of trust, although it does not have to be.)

        +
        enterprise +
        +

        The Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. Authenticators MUST NOT provide such an attestation unless the user agent or authenticator configuration expressly permits it for the requested RP ID. If not permitted, then follow the steps for direct attestation. Otherwise attFormat is an attestation statement format appropriate for this authenticator based on attestationFormats, and attAaguid is the corresponding AAGUID, which MAY be the authenticator’s AAGUID.

        +

        Note: CTAP2 does not currently provide for an enterpriseAttestation signal during an authenticatorGetAssertion call. Until that is changed, platform-managed enterprise attestation will not work in that context with CTAP2 authenticators.

        +
        +
      3. +

        Let spk be the newly created or existing supplemental public key, in COSE_Key format in the same fashion as for the user credential’s credentialPublicKey when the latter is conveyed in attested credential data.

        +
      4. +

        Let supplementalPrivateKey be the newly created or existing private key corresponding to spk.

        +
      5. +

        Let randomNonce be a fresh randomly-generated byte string of 32 bytes maximum length, or a zero length byte string if the authenticator chooses to not generate a nonce.

        +

        Note: randomNonce’s purpose is to randomize the attestation signature value for supplemental public keys. If this is not done, then an attestation signature value remains constant for all such signatures issued on behalf of this user credential, possibly exposing the authenticator's attestation private key to side-channel attacks. The randomness-generation mechanism should be carefully chosen by the authenticator implementer.

        +
      6. +

        Let supplementalPubKey be a CBOR map as defined by attObjForSupplementalPubKey above, with keys and values as follows:

        +

        Note: as with all CBOR structures used in this specification, the CTAP2 canonical CBOR encoding form MUST be used.

        +
          +
        1. +

          Set a key and value for the scope group based on the value of scope.

          +
        2. +

          Let the aaguid key’s value be attAaguid.

          +
        3. +

          Let the spk key’s value be spk.

          +
        4. +

          Let the nonce key’s value be randomNonce.

          +
        5. +

          Let the values of the $$attStmtType group socket be the result of generating an attestation statement with the attestation statement format, attFormat. See § 10.2.2.2.2 Attestation calculations.

          +

          Note: The details of the $$attStmtType values are dependent upon the particular attestation statement format. See § 6.5.3 Attestation Statement Formats.

          +
        6. +

          If the $$attStmtType group socket contains uniquely identifying information then let epAtt be true. Otherwise omit the epAtt field. (This field can only be true when the attestation field of the extension input is "enterprise" and either the user-agent or the authenticator permits uniquely identifying attestation for the requested RP ID.)

          +
        +
      7. +

        Append supplementalPubKey to spks.

        +
      8. +

        Let spkSig be the result of signing the assertion signature input with supplementalPrivateKey.

        +

        Note: the assertion signature input, and thus spkSig, covers the Relying Party's challenge because it includes the hash of the serialized client data. Thus the Relying Party knows that spkSig is a fresh signature.

        +
      9. +

        Append spkSig to spkSigs.

        +
      +
    6. +

      Let the supplementalPubKeys authenticator extension output value be the CBOR array spks.

      +
    7. +

      Let the CBOR encoding of spkSigs be the extension’s unsigned extension output.

      +

      Note: spkSigs cannot be included in the authenticator extension output because it is returned inside the authenticator data and that would imply that the signature signs over itself.

      +
    +
    +
    10.2.2.2.1. AAGUIDs
    +

    Any non-zero AAGUIDs included in the supplementalPubKeys extension output aid a Relying Party in validating the attestation statement of the supplemental public key. The interpretation of each AAGUID depends on the scope of the corresponding key. Some or all may differ from the aaguid in the attested credential data of a multi-device credential. Thus the AAGUID of a supplemental public key MAY be different in a single response and either, or both, may be zero depending on the options requested and authenticator behaviour.

    +
    10.2.2.2.2. Attestation calculations
    +

    When computing attestations, the process in § 6.5.5 Generating an Attestation Object takes two inputs: authData and hash. When calculating an attestation for a supplemental public key, the typical value for authData contains the attestation signature itself, which is impossible. Also the attestation of a supplemental public key is potentially used repeatedly, thus may want to be cached. But signing over values that include Relying Party-chosen nonces, like the hash of the serialized client data, makes that impossible.

    +

    Therefore when calculating an attestation for a supplemental public key, the inputs are:

    +
      +
    • +

      For authData, substitute the concatenation of the byte string h’737570706c656d656e74616c5075624b657973206174746573746174696f6e2e00ffffffff' and the value of aaguid from the extension output.

      +
    • +

      For hash, substitute the concatenation of the spk and nonce fields from the extension output. (The nonce MAY be empty.)

      +
    +

    The attestation signature is thus typically calculated over the bytes of (h’737570706c656d656e74616c5075624b657973206174746573746174696f6e2e00ffffffff' || aaguid || spk || nonce). The 37-byte prefix ensures domain separation: it takes the place of the RP ID hash, flags, and signature counter fields in those messages and ensures that no attestation signature for a supplemental public key can be confused with a signature for a user credential.

    +

    Note that when nonce is empty, then the (signed) authenticator extension output MAY be constant. However, the (unsigned) spkSig output is always unique and prevents replay of the (signed) extension output without knowledge of the supplemental private key.

    +
    10.2.2.3. supplementalPubKeys Extension Output Verification Procedures
    +

    Verifying the supplementalPubKeys extension output is performed by the Relying Party whenever a supplemental public key is returned within the extension output.

    +

    The supplementalPubKeys extension adds the following item to credential records:

    +
    +
    supplementalPubKeys +
    +

    An initially empty set of supplemental public key records associated with this public key credential source.

    +

    A supplemental public key record is an abstract representation of a registered supplemental public key. +It is a struct with the following items:

    +
    +
    aaguid +
    +

    The AAGUID included with the supplemental public key. +This MAY be different from the aaguid in the attestationObject, if any, of the containing credential record.

    +
    spk +
    +

    The public key portion of the supplemental public key.

    +
    scope +
    +

    The scope of the supplemental public key. See § 10.2.2.2 Extension Definition for details.

    +
    fmt +
    +

    The attestation statement format of the supplemental public key’s attestation statement.

    +
    attStmt +
    +

    The supplemental public key’s attestation statement.

    +
    +
    +
    10.2.2.3.1. Registration (create())
    +

    If the Relying Party requested the supplementalPubKeys extension in a navigator.credentials.create() call, +then the below verification steps are performed in the context of step 19 of § 7.1 Registering a New Credential using these variables established therein: credential, clientExtensionResults, authData, and hash. Relying Party policy may specify whether a response without a supplementalPubKeys extension output is acceptable.

    +
      +
    1. +

      Verify that the supplementalPubKeys member of clientExtensionResults exists, and contains the signatures field. Let signatures be the value of that field.

      +
    2. +

      Let attObjsForSupplementalPublicKey be the value of the supplementalPubKeys member of the authenticator extension output from authData.

      +
    3. +

      If the size of attObjsForSupplementalPublicKey is not equal to the size of signatures then abort the registration process with an error.

      +
    4. +

      Iterate over the indices of attObjsForSupplementalPublicKey (which, after the check in the previous step, must also be the indices of signatures). Then, for each (attObjForSupplementalPubKey, signature) from the two lists:

      +
        +
      1. +

        Extract the contained fields from attObjForSupplementalPubKey: aaguid, spk, nonce, fmt and attStmt. Also let scope reflect the scope, specified by the member of the scope group that is present.

        +

        Note: The latter attObjForSupplementalPubKey fields are referenced exclusively in the below steps and are not to be confused with other fields with the same names in other portions of the top-level attestation object.

        +
      2. +

        Verify that signature is a valid signature over the assertion signature input (i.e. authData and hash) by the supplemental public key spk. (The signature algorithm is the same as for the user credential.)

        +
      3. +

        Optionally, if attestation was requested and the Relying Party wishes to verify it, verify that attStmt is a correct attestation statement, conveying a valid attestation signature, by using the attestation statement format fmt’s verification procedure given attStmt. See § 10.2.2.2.2 Attestation calculations. Relying Party policy may specifiy which attestations are acceptable.

        +

        Note: If fmt’s value is "none" there is no attestation signature to verify.

        +
      4. +

        Create a new supplemental public key record with the contents:

        +
        +
        aaguid +
        +

        The value of aaguid.

        +
        spk +
        +

        The value of spk.

        +
        scope +
        +

        The value of scope.

        +
        fmt +
        +

        The value of fmt.

        +
        attStmt +
        +

        The value of attStmt.

        +
        +

        In step 26 of § 7.1 Registering a New Credential, +add this supplemental public key record to the supplementalPubKeys member of the new credential record.

        +
      +
    +

    See also § 10.2.2.1 Relying Party Usage for further details.

    +
    10.2.2.3.2. Authentication (get())
    +

    If the Relying Party requested the supplementalPubKeys extension in a navigator.credentials.get() call, +then the below verification steps are performed in the context of step 17 of § 7.2 Verifying an Authentication Assertion using these variables established therein: credential, clientExtensionResults, authData, hash, and credentialRecord. Relying Party policy may specify whether a response without a supplementalPubKeys extension output is acceptable.

    +
      +
    1. +

      Let recognizedSpks be a new empty set.

      +
    2. +

      Verify that the supplementalPubKeys member of clientExtensionResults exists, and contains the signatures field. Let signatures be the value of that field.

      +
    3. +

      Let attObjsForSupplementalPubKeys be the value of the supplementalPubKeys member of the authenticator extension output from authData.

      +
    4. +

      If the size of attObjsForSupplementalPubKeys is not equal to the size of signatures then abort the authentication process with an error.

      +
    5. +

      Iterate over the indices of attObjsForSupplementalPubKeys (which, after the check in the previous step, must also be the indices of signatures). Then, for each (attObjForSupplementalPubKey, signature) from the two lists:

      +
        +
      1. +

        Extract the contained fields from attObjForSupplementalPubKey: aaguid, spk, nonce, fmt, attStmt. Also let scope reflect the scope, specified by the member of the scope group that is present.

        +

        Note: The latter attObjForSupplementalPubKey fields are referenced exclusively in the below steps and are not to be confused with other fields with the same names in other portions of authenticator data.

        +
      2. +

        Verify that signature is a valid signature over the assertion signature input (i.e. authData and hash) by the supplemental public key spk. (The signature algorithm is the same as for the user credential.)

        +
      3. +

        Let matchedSpkRecords be a new empty set. For each spkRecord in credentialRecord.supplementalPubKeys:

        +
          +
        1. +

          If spkRecord.aaguid equals aaguid, spkRecord.spk equals spk, + and spkRecord.scope equals scope:

          +
            +
          1. +

            Append spkRecord to matchedSpkRecords.

            +
          +
        +
      4. +

        If matchedSpkRecords

        +
        +
        has size greater than one: +
        +

        Some form of error has occurred: credentialRecord invariants have been broken. Terminate these verification steps.

        +
        has size equal to one: +
        +

        This is a known supplemental public key

        +

        If fmt’s value is "none" then there is no attestation signature to verify and this is a known supplemental public key with a valid signature. Append spkRecord to recognizedSpks and continue to the next iteration, if any.

        +

        Otherwise, let spkRecord be matchedSpkRecords[0]. If the attStmt in attObjForSupplementalPubKey:

        +
        +
        equals spkRecord.attStmt by binary equality: +
        +

        This is a known supplemental public key with a valid signature and valid attestation. Append spkRecord to recognizedSpks and continue to the next iteration, if any.

        +

        Note: This authenticator is not generating a fresh per-response random nonce.

        +
        does not equal spkRecord.attStmt by binary equality: +
        +

        Optionally, if attestation was requested and the RP wishes to verify it, verify that attStmt is a correct attestation statement, conveying a valid attestation signature, by using the attestation statement format fmt’s verification procedure given attStmt. See § 10.2.2.2.2 Attestation calculations. Relying Party policy may specifiy which attestations are acceptable.

        +

        If the result is:

        +
        +
        successful +
        +

        This is a known supplemental public key with a valid signature and valid attestation. Append spkRecord to recognizedSpks and continue to the next iteration, if any.

        +
        unsuccessful +
        +

        Some form of error has occurred. It is indeterminate whether this is a valid supplemental public key. Either terminate these verification steps with an error or continue to the next iteration, if any, to ignore this key.

        +
        +
        +
        is empty: +
        +

        This is possibly a new supplemental public key.

        +
          +
        1. +

          Let matchedSpkKeys be a new empty set. For each spkRecord in credentialRecord.supplementalPubKeys:

          +
            +
          1. +

            If spkRecord.spk equals spk:

            +
              +
            1. +

              Append spkRecord to matchedSpkKeys.

              +
            +
          +
        2. +

          If matchedSpkKeys is empty:

          +
          +
          If fmt’s value is "none": +
          +

          There is no attestation signature to verify and this is a new supplemental key. Unless Relying Party policy specifies that this attestation is unacceptable, Create a new supplemental public key record and then continue to the next iteration, if any.

          +
          Otherwise: +
          +

          Optionally, if attestation was requested and the RP wishes to verify it, verify that attStmt is a correct attestation statement, conveying a valid attestation signature, by using the attestation statement format fmt’s verification procedure given attStmt. See § 10.2.2.2.2 Attestation calculations. Relying Party policy may specifiy which attestations are acceptable.

          +

          If the result is:

          +
          +
          successful +
          +

          This is a new supplemental public key. Create a new supplemental public key record then continue to the next iteration, if any.

          +
          unsuccessful +
          +

          Some form of error has occurred and a supplemental public key record cannot be created. Either terminate these verification steps with an error or continue to the next iteration, if any, to ignore this supplemental public key.

          +
          +
          +
        3. +

          Otherwise there is some form of error: we recieved a known spk value, but one or more of the accompanying aaguid or scope values did not match what the Relying Party has stored along with that spk value. Terminate these verification steps.

          +
        +
        +
      +
    +

    At the end of these steps, recognizedSpks contains zero or more supplemental public keys that were previously known for this user credential. These keys make claims about the continuity of certain factors between this authentication attempt and previous ones. The Relying Party should judge those claims in light of the attestations provided, if any, and evaluate the risk of this authentication in light of this information.

    +

    See also § 10.2.2.1 Relying Party Usage.

    +

    To Create a new supplemental public key record, perform the following steps:

    +
      +
    1. +

      Create a new supplemental public key record with the contents:

      +
      +
      aaguid +
      +

      The value of aaguid.

      +
      spk +
      +

      The value of spk.

      +
      scope +
      +

      The value of scope.

      +
      fmt +
      +

      The value of fmt.

      +
      attStmt +
      +

      The value of attStmt.

      +
      +

      In step 22 of § 7.2 Verifying an Authentication Assertion, append this supplemental public key record to credentialRecord.supplementalPubKeys.

      +

    11. User Agent Automation

    -

    For the purposes of user agent automation and web application testing, this document defines a number of [WebDriver] extension commands.

    +

    For the purposes of user agent automation and web application testing, this document defines a number of [WebDriver] extension commands.

    11.1. WebAuthn WebDriver Extension Capability

    In order to advertise the availability of the extension commands defined below, a new extension capability is defined.

    @@ -6753,7 +7873,7 @@

    11.1.1. Authenticator Extension Capabilities

    -

    Additionally, extension capabilities are defined for every authenticator extension (i.e. those defining authenticator extension processing) defined in this specification:

    +

    Additionally, extension capabilities are defined for every authenticator extension (i.e. those defining authenticator extension processing) defined in this specification:

    @@ -6782,7 +7902,7 @@

    boolean - Indicates whether the endpoint node WebAuthn WebDriver implementation supports the credBlob extension defined in [FIDO-CTAP]. + Indicates whether the endpoint node WebAuthn WebDriver implementation supports the credBlob extension defined in [FIDO-CTAP].

    When validating capabilities, the extension-specific substeps to validate an authenticator extension capability key with value are the following:

    @@ -6795,48 +7915,48 @@

    11.2. Virtual Authenticators

    These WebDriver extension commands create and interact with Virtual Authenticators: software implementations of the Authenticator Model. Virtual Authenticators are stored in a Virtual Authenticator Database. Each stored virtual authenticator has the following properties:

    authenticatorId
    -

    An non-null string made using up to 48 characters from the unreserved production defined in Appendix A of [RFC3986] that uniquely identifies the Virtual Authenticator.

    +

    An non-null string made using up to 48 characters from the unreserved production defined in Appendix A of [RFC3986] that uniquely identifies the Virtual Authenticator.

    protocol
    -

    The protocol the Virtual Authenticator speaks: one of "ctap1/u2f", "ctap2" or "ctap2_1" [FIDO-CTAP].

    +

    The protocol the Virtual Authenticator speaks: one of "ctap1/u2f", "ctap2" or "ctap2_1" [FIDO-CTAP].

    transport
    -

    The AuthenticatorTransport simulated. If the transport is set to internal, the -authenticator simulates platform attachment. Otherwise, it simulates cross-platform attachment.

    +

    The AuthenticatorTransport simulated. If the transport is set to internal, the +authenticator simulates platform attachment. Otherwise, it simulates cross-platform attachment.

    hasResidentKey

    If set to true the authenticator will support client-side discoverable credentials.

    hasUserVerification
    -

    If set to true, the authenticator supports user verification.

    +

    If set to true, the authenticator supports user verification.

    isUserConsenting
    -

    Determines the result of all user consent authorization gestures, and by extension, any test of user presence performed on the Virtual Authenticator. If set to true, a user consent will always be granted. If set to false, it will not be granted.

    +

    Determines the result of all user consent authorization gestures, and by extension, any test of user presence performed on the Virtual Authenticator. If set to true, a user consent will always be granted. If set to false, it will not be granted.

    isUserVerified
    -

    Determines the result of User Verification performed on the Virtual Authenticator. If set to true, User Verification will always succeed. If set to false, it will fail.

    -

    Note: This property has no effect if hasUserVerification is set to false.

    +

    Determines the result of User Verification performed on the Virtual Authenticator. If set to true, User Verification will always succeed. If set to false, it will fail.

    +

    Note: This property has no effect if hasUserVerification is set to false.

    extensions
    -

    A string array containing the extension identifiers supported by the Virtual Authenticator.

    -

    A Virtual authenticator MUST support all authenticator extensions present in its extensions array. -It MUST NOT support any authenticator extension not present in its extensions array.

    +

    A string array containing the extension identifiers supported by the Virtual Authenticator.

    +

    A Virtual authenticator MUST support all authenticator extensions present in its extensions array. +It MUST NOT support any authenticator extension not present in its extensions array.

    uvm
    -

    A UvmEntries array to be set as the authenticator extension output when processing the User Verification Method extension.

    -

    Note: This property has no effect if the Virtual Authenticator does not support the User Verification Method extension.

    +

    A UvmEntries array to be set as the authenticator extension output when processing the User Verification Method extension.

    +

    Note: This property has no effect if the Virtual Authenticator does not support the User Verification Method extension.

    11.3. Add Virtual Authenticator

    The Add Virtual Authenticator WebDriver extension command creates a software Virtual Authenticator. It is @@ -6871,7 +7991,7 @@

    AuthenticatorTransport values + AuthenticatorTransport values None hasResidentKey @@ -6896,7 +8016,7 @@