PublicKeyCredentialRequestOptions.extensions - Web APIs 编辑

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

extensions, an optional property of the PublicKeyCredentialRequestOptions dictionary, is an object providing the client extensions and their input values.

Extensions are values requesting additional processing by the client and by the authenticator. For instance, extensions may be used for:

• backward compatibility with the legacy FIDO JS API,
• knowing the user verification process,
• etc.

Note: An analogous option exists for the creation operation (navigators.credentials.create()), see PublicKeyCredentialCreationOptions.extensions.

Syntax

extensions = publicKeyCredentialRequestOptions.extensions

Value

An object with various keys and values.

Here is the current (as of March 2019) list of potential extensions which may be used during the registration operation.

Warning! As of June 2020, only appid is supported by Chrome and Edge. Firefox does not seem to support any extension. Also Chrome doesn't plan to support any other extension in future

Note: Extensions are optional and different browsers may recognize different extensions. All extensions are optional for the client to process them: if a browser does not know a given extension, that will not cause any failure, the extension will not be processed.

Examples

var options = {
  extensions: {
    uvm: true,
    loc: false,
    txAuthSimple: "Could you please verify yourself?"
  },
  challenge: new Uint8Array([/* bytes sent from the server */])
};

navigator.credentials.get({ "publicKey": options })
    .then(function (credentialInfoAssertion) {
    // send assertion response back to the server
    // to proceed with the control of the credential
}).catch(function (err) {
     console.error(err);
});

Specifications

Browser compatibility

BCD tables only load in the browser

See also

• PublicKeyCredential.getClientExtensionResults()
• The list of all of the extensions defined in the specification
• PublicKeyCredentialCreationOptions.extensions, the analogous option property used when creating a credential