mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-06 21:05:37 +00:00
19251f27ce
`= {}` can now be used to indicate that an optional dictionary should have the default value of 'default-initialized dictionary' Differential Revision: https://phabricator.services.mozilla.com/D36504 --HG-- extra : moz-landing-system : lando
181 lines
5.9 KiB
Plaintext
181 lines
5.9 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://w3c.github.io/webauthn/
|
|
*/
|
|
|
|
/***** Interfaces to Data *****/
|
|
|
|
[SecureContext, Pref="security.webauth.webauthn"]
|
|
interface PublicKeyCredential : Credential {
|
|
[SameObject] readonly attribute ArrayBuffer rawId;
|
|
[SameObject] readonly attribute AuthenticatorResponse response;
|
|
AuthenticationExtensionsClientOutputs getClientExtensionResults();
|
|
};
|
|
|
|
[SecureContext]
|
|
partial interface PublicKeyCredential {
|
|
static Promise<boolean> isUserVerifyingPlatformAuthenticatorAvailable();
|
|
// isExternalCTAP2SecurityKeySupported is non-standard; see Bug 1526023
|
|
static Promise<boolean> isExternalCTAP2SecurityKeySupported();
|
|
};
|
|
|
|
[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;
|
|
};
|
|
|
|
[SecureContext, Pref="security.webauth.webauthn"]
|
|
interface AuthenticatorAssertionResponse : AuthenticatorResponse {
|
|
[SameObject] readonly attribute ArrayBuffer authenticatorData;
|
|
[SameObject] readonly attribute ArrayBuffer signature;
|
|
[SameObject] readonly attribute ArrayBuffer? userHandle;
|
|
};
|
|
|
|
dictionary PublicKeyCredentialParameters {
|
|
required PublicKeyCredentialType type;
|
|
required COSEAlgorithmIdentifier alg;
|
|
};
|
|
|
|
dictionary PublicKeyCredentialCreationOptions {
|
|
required PublicKeyCredentialRpEntity rp;
|
|
required PublicKeyCredentialUserEntity user;
|
|
|
|
required BufferSource challenge;
|
|
required sequence<PublicKeyCredentialParameters> pubKeyCredParams;
|
|
|
|
unsigned long timeout;
|
|
sequence<PublicKeyCredentialDescriptor> excludeCredentials = [];
|
|
// FIXME: bug 1493860: should this "= {}" be here?
|
|
AuthenticatorSelectionCriteria authenticatorSelection = {};
|
|
AttestationConveyancePreference attestation = "none";
|
|
// FIXME: bug 1493860: should this "= {}" be here?
|
|
AuthenticationExtensionsClientInputs extensions = {};
|
|
};
|
|
|
|
dictionary PublicKeyCredentialEntity {
|
|
required DOMString name;
|
|
USVString icon;
|
|
};
|
|
|
|
dictionary PublicKeyCredentialRpEntity : PublicKeyCredentialEntity {
|
|
DOMString id;
|
|
};
|
|
|
|
dictionary PublicKeyCredentialUserEntity : PublicKeyCredentialEntity {
|
|
required BufferSource id;
|
|
required DOMString displayName;
|
|
};
|
|
|
|
dictionary AuthenticatorSelectionCriteria {
|
|
AuthenticatorAttachment authenticatorAttachment;
|
|
boolean requireResidentKey = false;
|
|
UserVerificationRequirement userVerification = "preferred";
|
|
};
|
|
|
|
enum AuthenticatorAttachment {
|
|
"platform", // Platform attachment
|
|
"cross-platform" // Cross-platform attachment
|
|
};
|
|
|
|
enum AttestationConveyancePreference {
|
|
"none",
|
|
"indirect",
|
|
"direct"
|
|
};
|
|
|
|
enum UserVerificationRequirement {
|
|
"required",
|
|
"preferred",
|
|
"discouraged"
|
|
};
|
|
|
|
dictionary PublicKeyCredentialRequestOptions {
|
|
required BufferSource challenge;
|
|
unsigned long timeout;
|
|
USVString rpId;
|
|
sequence<PublicKeyCredentialDescriptor> allowCredentials = [];
|
|
UserVerificationRequirement userVerification = "preferred";
|
|
// FIXME: bug 1493860: should this "= {}" be here?
|
|
AuthenticationExtensionsClientInputs extensions = {};
|
|
};
|
|
|
|
// TODO - Use partial dictionaries when bug 1436329 is fixed.
|
|
dictionary AuthenticationExtensionsClientInputs {
|
|
// FIDO AppID Extension (appid)
|
|
// <https://w3c.github.io/webauthn/#sctn-appid-extension>
|
|
USVString appid;
|
|
|
|
// hmac-secret
|
|
// <https://fidoalliance.org/specs/fido-v2.0-ps-20190130/fido-client-to-authenticator-protocol-v2.0-ps-20190130.html#sctn-hmac-secret-extension>
|
|
boolean hmacCreateSecret;
|
|
};
|
|
|
|
// TODO - Use partial dictionaries when bug 1436329 is fixed.
|
|
dictionary AuthenticationExtensionsClientOutputs {
|
|
// FIDO AppID Extension (appid)
|
|
// <https://w3c.github.io/webauthn/#sctn-appid-extension>
|
|
boolean appid;
|
|
|
|
// <https://fidoalliance.org/specs/fido-v2.0-ps-20190130/fido-client-to-authenticator-protocol-v2.0-ps-20190130.html#sctn-hmac-secret-extension>
|
|
boolean hmacCreateSecret;
|
|
};
|
|
|
|
typedef record<DOMString, DOMString> AuthenticationExtensionsAuthenticatorInputs;
|
|
|
|
dictionary CollectedClientData {
|
|
required DOMString type;
|
|
required DOMString challenge;
|
|
required DOMString origin;
|
|
required DOMString hashAlgorithm;
|
|
DOMString tokenBindingId;
|
|
// FIXME: bug 1493860: should this "= {}" be here?
|
|
AuthenticationExtensionsClientInputs clientExtensions = {};
|
|
AuthenticationExtensionsAuthenticatorInputs authenticatorExtensions;
|
|
};
|
|
|
|
enum PublicKeyCredentialType {
|
|
"public-key"
|
|
};
|
|
|
|
dictionary PublicKeyCredentialDescriptor {
|
|
required PublicKeyCredentialType type;
|
|
required BufferSource id;
|
|
sequence<AuthenticatorTransport> transports;
|
|
};
|
|
|
|
enum AuthenticatorTransport {
|
|
"usb",
|
|
"nfc",
|
|
"ble",
|
|
"internal"
|
|
};
|
|
|
|
typedef long COSEAlgorithmIdentifier;
|
|
|
|
typedef sequence<AAGUID> AuthenticatorSelectionList;
|
|
|
|
typedef BufferSource AAGUID;
|
|
|
|
/*
|
|
// FIDO AppID Extension (appid)
|
|
// <https://w3c.github.io/webauthn/#sctn-appid-extension>
|
|
partial dictionary AuthenticationExtensionsClientInputs {
|
|
USVString appid;
|
|
};
|
|
|
|
// FIDO AppID Extension (appid)
|
|
// <https://w3c.github.io/webauthn/#sctn-appid-extension>
|
|
partial dictionary AuthenticationExtensionsClientOutputs {
|
|
boolean appid;
|
|
};
|
|
*/
|