mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-23 02:05:42 +00:00
24696391df
This covers these renames: * In PublicKeyCredentialParameters, algorithm => alg * MakeCredentialOptions => MakePublicKeyCredentialOptions * PublicKeyCredentialEntity => PublicKeyCredentialRpEntity * Attachment => AuthenticatorAttachment It sets a default excludeList and allowList for the make / get options. It adds the method isPlatformAuthenticatorAvailable which is incomplete and not callable, to be completed in Bug 1406468. Adds type PublicKeyCredentialRpEntity. Adds "userId" to AuthenticatorAssertionResponse. Adds "id" as a buffer source to PublicKeyCredentialUserEntity and as a DOMString to PublicKeyCredentialRpEntity, refactoring out the "id" field from the parent PublicKeyCredentialEntity. It also adds a simple enforcement per spec 4.4.3 "User Account Parameters for Credential Generation" that the new user ID buffer, if set, be no more than 64 bytes long. I mostly added it here so I could adjust the tests all at once in this commit. MozReview-Commit-ID: IHUdGVoWocq --HG-- extra : rebase_source : bc1793f74700b2785d2bf2099c0dba068f717a59
131 lines
4.3 KiB
Plaintext
131 lines
4.3 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* The origin of this IDL file is
|
|
* https://www.w3.org/TR/webauthn/
|
|
*/
|
|
|
|
/***** Interfaces to Data *****/
|
|
|
|
[SecureContext, Pref="security.webauth.webauthn"]
|
|
interface PublicKeyCredential : Credential {
|
|
[SameObject] readonly attribute ArrayBuffer rawId;
|
|
[SameObject] readonly attribute AuthenticatorResponse response;
|
|
// Extensions are not supported yet.
|
|
// [SameObject] readonly attribute AuthenticationExtensions clientExtensionResults; // Add in Bug 1406458
|
|
};
|
|
|
|
[SecureContext]
|
|
partial interface PublicKeyCredential {
|
|
static Promise<boolean> isPlatformAuthenticatorAvailable();
|
|
};
|
|
|
|
[SecureContext, Pref="security.webauth.webauthn"]
|
|
interface AuthenticatorResponse {
|
|
[SameObject] readonly attribute ArrayBuffer clientDataJSON;
|
|
};
|
|
|
|
[SecureContext, Pref="security.webauth.webauthn"]
|
|
interface AuthenticatorAttestationResponse : AuthenticatorResponse {
|
|
[SameObject] readonly attribute ArrayBuffer attestationObject;
|
|
};
|
|
|
|
dictionary PublicKeyCredentialParameters {
|
|
required PublicKeyCredentialType type;
|
|
required WebAuthnAlgorithmID alg; // Switch to COSE in Bug 1381190
|
|
};
|
|
|
|
dictionary PublicKeyCredentialUserEntity : PublicKeyCredentialEntity {
|
|
BufferSource id;
|
|
DOMString displayName;
|
|
};
|
|
|
|
dictionary MakePublicKeyCredentialOptions {
|
|
required PublicKeyCredentialRpEntity rp;
|
|
required PublicKeyCredentialUserEntity user;
|
|
|
|
required BufferSource challenge;
|
|
required sequence<PublicKeyCredentialParameters> parameters;
|
|
|
|
unsigned long timeout;
|
|
sequence<PublicKeyCredentialDescriptor> excludeList = [];
|
|
AuthenticatorSelectionCriteria authenticatorSelection;
|
|
// Extensions are not supported yet.
|
|
// AuthenticationExtensions extensions; // Add in Bug 1406458
|
|
};
|
|
|
|
dictionary PublicKeyCredentialEntity {
|
|
DOMString name;
|
|
USVString icon;
|
|
};
|
|
|
|
dictionary PublicKeyCredentialRpEntity : PublicKeyCredentialEntity {
|
|
DOMString id;
|
|
};
|
|
|
|
dictionary AuthenticatorSelectionCriteria {
|
|
AuthenticatorAttachment authenticatorAttachment;
|
|
boolean requireResidentKey = false;
|
|
boolean requireUserVerification = false;
|
|
};
|
|
|
|
enum AuthenticatorAttachment {
|
|
"platform", // Platform attachment
|
|
"cross-platform" // Cross-platform attachment
|
|
};
|
|
|
|
dictionary PublicKeyCredentialRequestOptions {
|
|
required BufferSource challenge;
|
|
unsigned long timeout;
|
|
USVString rpId;
|
|
sequence<PublicKeyCredentialDescriptor> allowList = [];
|
|
// Extensions are not supported yet.
|
|
// AuthenticationExtensions extensions; // Add in Bug 1406458
|
|
};
|
|
|
|
typedef record<DOMString, any> AuthenticationExtensions;
|
|
|
|
dictionary CollectedClientData {
|
|
required DOMString challenge;
|
|
required DOMString origin;
|
|
required DOMString hashAlg;
|
|
DOMString tokenBinding;
|
|
// Extensions are not supported yet.
|
|
// AuthenticationExtensions clientExtensions; // Add in Bug 1406458
|
|
// AuthenticationExtensions authenticatorExtensions; // Add in Bug 1406458
|
|
};
|
|
|
|
enum PublicKeyCredentialType {
|
|
"public-key"
|
|
};
|
|
|
|
dictionary PublicKeyCredentialDescriptor {
|
|
required PublicKeyCredentialType type;
|
|
required BufferSource id;
|
|
sequence<WebAuthnTransport> transports;
|
|
};
|
|
|
|
typedef (boolean or DOMString) WebAuthnAlgorithmID; // Switch to COSE in Bug 1381190
|
|
|
|
[SecureContext, Pref="security.webauth.webauthn"]
|
|
interface AuthenticatorAssertionResponse : AuthenticatorResponse {
|
|
[SameObject] readonly attribute ArrayBuffer authenticatorData;
|
|
[SameObject] readonly attribute ArrayBuffer signature;
|
|
readonly attribute DOMString userId;
|
|
};
|
|
|
|
// Renamed from "Transport" to avoid a collision with U2F
|
|
enum WebAuthnTransport {
|
|
"usb",
|
|
"nfc",
|
|
"ble"
|
|
};
|
|
|
|
typedef long COSEAlgorithmIdentifier;
|
|
|
|
typedef sequence<AAGUID> AuthenticatorSelectionList;
|
|
|
|
typedef BufferSource AAGUID;
|