WebAuthn Domain
This domain allows configuring virtual authenticators to test the WebAuthn API.
Methods
Types
Methods
WebAuthn.addCredential #
Adds the credential to the specified authenticator.
parameters
- authenticatorId
-
AuthenticatorId
- credential
-
Credential
WebAuthn.addVirtualAuthenticator #
Creates and adds a virtual authenticator.
parameters
- options
-
VirtualAuthenticatorOptions
Return Object
- authenticatorId
-
AuthenticatorId
WebAuthn.clearCredentials #
Clears all the credentials from the specified device.
parameters
- authenticatorId
-
AuthenticatorId
WebAuthn.disable #
Disable the WebAuthn domain.
WebAuthn.enable #
Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.
WebAuthn.getCredential #
Returns a single credential stored in the given virtual authenticator that matches the credential ID.
parameters
- authenticatorId
-
AuthenticatorId
- credentialId
-
string
Return Object
- credential
-
Credential
WebAuthn.getCredentials #
Returns all the credentials stored in the given virtual authenticator.
parameters
- authenticatorId
-
AuthenticatorId
Return Object
- credentials
-
array[ Credential ]
WebAuthn.removeCredential #
Removes a credential from the authenticator.
parameters
- authenticatorId
-
AuthenticatorId
- credentialId
-
string
WebAuthn.removeVirtualAuthenticator #
Removes the given authenticator.
parameters
- authenticatorId
-
AuthenticatorId
WebAuthn.setAutomaticPresenceSimulation #
Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator. The default is true.
parameters
- authenticatorId
-
AuthenticatorId
- enabled
-
boolean
WebAuthn.setUserVerified #
Sets whether User Verification succeeds or fails for an authenticator. The default is true.
parameters
- authenticatorId
-
AuthenticatorId
- isUserVerified
-
boolean
Types
WebAuthn.Credential #
Type: object
properties
- credentialId
-
string
- isResidentCredential
-
boolean
- rpId
-
string
Relying Party ID the credential is scoped to. Must be set when adding a credential.
- privateKey
-
string
The ECDSA P-256 private key in PKCS#8 format. (Encoded as a base64 string when passed over JSON)
- userHandle
-
string
An opaque byte sequence with a maximum size of 64 bytes mapping the credential to a specific user. (Encoded as a base64 string when passed over JSON)
- signCount
-
integer
Signature counter. This is incremented by one for each successful assertion. See https://w3c.github.io/webauthn/#signature-counter
- largeBlob
-
string
The large blob associated with the credential. See https://w3c.github.io/webauthn/#sctn-large-blob-extension (Encoded as a base64 string when passed over JSON)
WebAuthn.VirtualAuthenticatorOptions #
Type: object
properties
- protocol
-
AuthenticatorProtocol
- ctap2Version
-
Ctap2Version
Defaults to ctap2_0. Ignored if |protocol| == u2f.
- transport
-
AuthenticatorTransport
- hasResidentKey
-
boolean
Defaults to false.
- hasUserVerification
-
boolean
Defaults to false.
- hasLargeBlob
-
boolean
If set to true, the authenticator will support the largeBlob extension. https://w3c.github.io/webauthn#largeBlob Defaults to false.
- automaticPresenceSimulation
-
boolean
If set to true, tests of user presence will succeed immediately. Otherwise, they will not be resolved. Defaults to true.
- isUserVerified
-
boolean
Sets whether User Verification succeeds or fails for an authenticator. Defaults to false.