Skip to content

Add authenticator attachment used during authentication to assertion payload #1668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Oct 7, 2021
19 changes: 18 additions & 1 deletion index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -1370,6 +1370,7 @@ that are returned to the caller when a new credential is created, or a new asser
interface PublicKeyCredential : Credential {
[SameObject] readonly attribute ArrayBuffer rawId;
[SameObject] readonly attribute AuthenticatorResponse response;
[SameObject] readonly attribute DOMString? authenticatorAttachment;
AuthenticationExtensionsClientOutputs getClientExtensionResults();
};
</xmp>
Expand All @@ -1388,6 +1389,11 @@ that are returned to the caller when a new credential is created, or a new asser
{{CredentialsContainer/create()}}, this attribute's value will be an {{AuthenticatorAttestationResponse}}, otherwise,
the {{PublicKeyCredential}} was created in response to {{CredentialsContainer/get()}}, and this attribute's value
will be an {{AuthenticatorAssertionResponse}}.

: <dfn>authenticatorAttachment</dfn>
:: The value SHOULD be a member of {{AuthenticatorAttachment}} used to communicate to the [=authenticator=], and Relying Parties SHOULD treat unknown values as if the value were null.
This attribute may be used by RPs in conjunction with {{isUserVerifyingPlatformAuthenticatorAvailable}} to prompt user to register a platform authenticator if it is available and the user is currently being authenticated
with a cross-platform attachment. See [[#sctn-authenticator-attachment-modality]].

: {{PublicKeyCredential/getClientExtensionResults()}}
:: This operation returns the value of {{PublicKeyCredential/[[clientExtensionsResults]]}}, which is a [=map=] containing
Expand Down Expand Up @@ -1857,6 +1863,12 @@ a numbered step. If outdented, it (today) is rendered either as a bullet in the
: {{PublicKeyCredential/[[identifier]]}}
:: |id|

: {{PublicKeyCredential/authenticatorAttachment}}
:: The value of the authenticator attachment type used to communicate to the [=authenticator=].
Values SHOULD be members of the {{AuthenticatorAttachment}} enum based on the transport returned
by authenticator following successful registration. If the user agent does not
have any authenticator attachment information, set the value to null.

: {{PublicKeyCredential/response}}
:: A new {{AuthenticatorAttestationResponse}} object associated with |global| whose fields are:

Expand Down Expand Up @@ -2223,10 +2235,15 @@ When this method is invoked, the user agent MUST execute the following algorithm
1. Let |pubKeyCred| be a new {{PublicKeyCredential}} object associated with |global| whose fields are:

: {{PublicKeyCredential/[[identifier]]}}

:: A new {{ArrayBuffer}}, created using |global|'s [=%ArrayBuffer%=], containing the bytes of
<code>|assertionCreationData|.[=credentialIdResult=]</code>.

: {{PublicKeyCredential/authenticatorAttachment}}
:: The value of the authenticator attachment type used to communicate to the [=authenticator=].
Values SHOULD be members of the {{AuthenticatorAttachment}} enum based on the transport returned
by authenticator following successful authentication. If the user agent does not
have any authenticator attachment information, set the value to null.

: {{PublicKeyCredential/response}}
:: A new {{AuthenticatorAssertionResponse}} object associated with |global| whose fields are:

Expand Down