CDPotion.Domain.WebAuthn (cdpotion v0.1.0)
Summary
Functions
Adds the credential to the specified authenticator.
Creates and adds a virtual authenticator.
Clears all the credentials from the specified device.
Disable the WebAuthn domain.
Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.
Returns a single credential stored in the given virtual authenticator that matches the credential ID.
Returns all the credentials stored in the given virtual authenticator.
Removes a credential from the authenticator.
Removes the given authenticator.
Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator. The default is true.
Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
Sets whether User Verification succeeds or fails for an authenticator. The default is true.
Functions
add_credential(authenticator_id, credential)
Adds the credential to the specified authenticator.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(credential:Credential
: description not provided :(
add_virtual_authenticator(options)
Creates and adds a virtual authenticator.
Parameters:
options:VirtualAuthenticatorOptions
: description not provided :(
clear_credentials(authenticator_id)
Clears all the credentials from the specified device.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(
disable()
Disable the WebAuthn domain.
enable(enable_ui \\ nil)
Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.
Parameters:
enableUI:boolean
: (Optional) Whether to enable the WebAuthn user interface. Enabling the UI is recommended for debugging and demo purposes, as it is closer to the real experience. Disabling the UI is recommended for automated testing. Supported at the embedder's discretion if UI is available. Defaults to false.
get_credential(authenticator_id, credential_id)
Returns a single credential stored in the given virtual authenticator that matches the credential ID.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(credentialId:string
: description not provided :(
get_credentials(authenticator_id)
Returns all the credentials stored in the given virtual authenticator.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(
remove_credential(authenticator_id, credential_id)
Removes a credential from the authenticator.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(credentialId:string
: description not provided :(
remove_virtual_authenticator(authenticator_id)
Removes the given authenticator.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(
set_automatic_presence_simulation(authenticator_id, enabled)
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
: description not provided :(enabled:boolean
: description not provided :(
set_response_override_bits(authenticator_id, is_bogus_signature \\ nil, is_bad_uv \\ nil, is_bad_up \\ nil)
Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(isBogusSignature:boolean
: (Optional) If isBogusSignature is set, overrides the signature in the authenticator response to be zero. Defaults to false.isBadUV:boolean
: (Optional) If isBadUV is set, overrides the UV bit in the flags in the authenticator response to be zero. Defaults to false.isBadUP:boolean
: (Optional) If isBadUP is set, overrides the UP bit in the flags in the authenticator response to be zero. Defaults to false.
set_user_verified(authenticator_id, is_user_verified)
Sets whether User Verification succeeds or fails for an authenticator. The default is true.
Parameters:
authenticatorId:AuthenticatorId
: description not provided :(isUserVerified:boolean
: description not provided :(