PublicKeyCredentialRequestOptions

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

PublicKeyCredentialRequestOptions dictionary of the Web 身份验证 API holds the options passed to navigator.credentials.get() in order to fetch a given PublicKeyCredential .

特性

PublicKeyCredentialRequestOptions.challenge
A BufferSource , emitted by the relying party's server and used as a cryptographic challenge . This value will be signed by the authenticator and the signature will be sent back as part of AuthenticatorAssertionResponse.signature .
PublicKeyCredentialRequestOptions.timeout 可选
A numerical hint, in milliseconds, which indicates the time the caller is willing to wait for the retrieval operation to complete. This hint may be overridden by the browser.
PublicKeyCredentialRequestOptions.rpId 可选
A USVString which indicates the relying party's identifier (ex. "login.example.org" ). If this option is not provided, the client will use the current origin's domain.
PublicKeyCredentialRequestOptions.allowCredentials 可选
An Array of credentials descriptor which restricts the acceptable existing credentials for retrieval.
PublicKeyCredentialRequestOptions.userVerification 可选
A string qualifying how the user verification should be part of the authentication process.
PublicKeyCredentialRequestOptions.extensions 可选
An object with several client extensions' inputs. Those extensions are used to request additional processing (e.g. dealing with legacy FIDO APIs credentials, prompting a specific text on the authenticator, etc.).

方法

None.

范例

var options = {
  challenge: new Uint8Array([/* bytes sent from the server */]),
  rpId: "example.com", /* will only work if the current domain
                         is something like foo.example.com */
  userVerification: "preferred",
  timeout: 60000,     // Wait for a minute
  allowCredentials: [
    {
      transports: "usb",
      type: "public-key",
      id: new Uint8Array(26) // actually provided by the server
    },
    {
      transports: "internal",
      type: "public-key",
      id: new Uint8Array(26) // actually provided by the server
    }
  ],
  extensions: {
    uvm: true,  // RP wants to know how the user was verified
    loc: false,
    txAuthSimple: "Could you please verify yourself?"
  }
};
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);
});
					

规范

规范 状态 Comment
Web Authentication: An API for accessing Public Key Credentials Level 1
The definition of 'PublicKeyCredentialRequestOptions dictionary' in that specification.
Recommendation 初始定义。

浏览器兼容性

更新 GitHub 上的兼容性数据
Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet
PublicKeyCredentialRequestOptions
Chrome 67 Edge ≤79 Firefox 60 IE ? Opera Yes Safari 13 WebView Android 67 Chrome Android 67 Firefox Android ? Opera Android Yes Safari iOS 13.3 Samsung Internet Android No
allowCredentials
Chrome 67 Edge ≤79 Firefox 60 IE ? Opera Yes Safari 13 WebView Android 67 Chrome Android 67 Firefox Android ? Opera Android Yes Safari iOS 13.3 Samsung Internet Android No
challenge
Chrome 67 Edge ≤79 Firefox 60 IE ? Opera Yes Safari 13 WebView Android 67 Chrome Android 67 Firefox Android ? Opera Android Yes Safari iOS 13.3 Samsung Internet Android No
extensions
Chrome 67 Edge ≤79 Firefox 60 IE ? Opera Yes Safari 13 WebView Android 67 Chrome Android 67 Firefox Android ? Opera Android Yes Safari iOS 13.3 Samsung Internet Android No
rpId
Chrome 67 Edge ≤79 Firefox 60 IE ? Opera Yes Safari 13 WebView Android 67 Chrome Android 67 Firefox Android ? Opera Android Yes Safari iOS 13.3 Samsung Internet Android No
timeout
Chrome 67 Edge ≤79 Firefox 60 IE ? Opera Yes Safari 13 WebView Android 67 Chrome Android 67 Firefox Android ? Opera Android Yes Safari iOS 13.3 Samsung Internet Android No
userVerification
Chrome 67 Edge ≤79 Firefox 60 IE ? Opera Yes Safari 13 WebView Android 67 Chrome Android 67 Firefox Android ? Opera Android Yes Safari iOS 13.3 Samsung Internet Android No

图例

完整支持
完整支持
不支持
不支持
兼容性未知
兼容性未知
实验。期望将来行为有所改变。
实验。期望将来行为有所改变。

另请参阅