data class Credential(val credentialId: String, val isResidentCredential: Boolean, val rpId: String? = null, val privateKey: String, val userHandle: String? = null, val signCount: Int, val largeBlob: String? = null, val backupEligibility: Boolean? = null, val backupState: Boolean? = null, val userName: String? = null, val userDisplayName: String? = null)

CredentialAddedParameter

@Serializable

data class CredentialAddedParameter(val authenticatorId: String, val credential: WebAuthn.Credential)

Triggered when a credential is added to an authenticator.

CredentialAssertedParameter

@Serializable

data class CredentialAssertedParameter(val authenticatorId: String, val credential: WebAuthn.Credential)

Triggered when a credential is used in a webauthn assertion.

CredentialDeletedParameter

@Serializable

data class CredentialDeletedParameter(val authenticatorId: String, val credentialId: String)

Triggered when a credential is deleted, e.g. through PublicKeyCredential.signalUnknownCredential().

CredentialUpdatedParameter

@Serializable

data class CredentialUpdatedParameter(val authenticatorId: String, val credential: WebAuthn.Credential)

Triggered when a credential is updated, e.g. through PublicKeyCredential.signalCurrentUserDetails().

Ctap2Version

@Serializable

enum Ctap2Version : Enum<WebAuthn.Ctap2Version>

EnableParameter

@Serializable

data class EnableParameter(val enableUI: Boolean? = null)

GetCredentialParameter

@Serializable

data class GetCredentialParameter(val authenticatorId: String, val credentialId: String)

GetCredentialReturn

@Serializable

data class GetCredentialReturn(val credential: WebAuthn.Credential)

GetCredentialsParameter

@Serializable

data class GetCredentialsParameter(val authenticatorId: String)

GetCredentialsReturn

@Serializable

data class GetCredentialsReturn(val credentials: List<WebAuthn.Credential>)

RemoveCredentialParameter

@Serializable

data class RemoveCredentialParameter(val authenticatorId: String, val credentialId: String)

RemoveVirtualAuthenticatorParameter

@Serializable

data class RemoveVirtualAuthenticatorParameter(val authenticatorId: String)

SetAutomaticPresenceSimulationParameter

@Serializable

data class SetAutomaticPresenceSimulationParameter(val authenticatorId: String, val enabled: Boolean)

SetCredentialPropertiesParameter

@Serializable

data class SetCredentialPropertiesParameter(val authenticatorId: String, val credentialId: String, val backupEligibility: Boolean? = null, val backupState: Boolean? = null)

SetResponseOverrideBitsParameter

@Serializable

data class SetResponseOverrideBitsParameter(val authenticatorId: String, val isBogusSignature: Boolean? = null, val isBadUV: Boolean? = null, val isBadUP: Boolean? = null)

SetUserVerifiedParameter

@Serializable

data class SetUserVerifiedParameter(val authenticatorId: String, val isUserVerified: Boolean)

VirtualAuthenticatorOptions

@Serializable

data class VirtualAuthenticatorOptions(val protocol: WebAuthn.AuthenticatorProtocol, val ctap2Version: WebAuthn.Ctap2Version? = null, val transport: WebAuthn.AuthenticatorTransport, val hasResidentKey: Boolean? = null, val hasUserVerification: Boolean? = null, val hasLargeBlob: Boolean? = null, val hasCredBlob: Boolean? = null, val hasMinPinLength: Boolean? = null, val hasPrf: Boolean? = null, val automaticPresenceSimulation: Boolean? = null, val isUserVerified: Boolean? = null, val defaultBackupEligibility: Boolean? = null, val defaultBackupState: Boolean? = null)

Properties

credentialAdded

val credentialAdded: Flow<WebAuthn.CredentialAddedParameter>

Triggered when a credential is added to an authenticator.

credentialAsserted

val credentialAsserted: Flow<WebAuthn.CredentialAssertedParameter>

Triggered when a credential is used in a webauthn assertion.

credentialDeleted

val credentialDeleted: Flow<WebAuthn.CredentialDeletedParameter>

Triggered when a credential is deleted, e.g. through PublicKeyCredential.signalUnknownCredential().

credentialUpdated

val credentialUpdated: Flow<WebAuthn.CredentialUpdatedParameter>

Triggered when a credential is updated, e.g. through PublicKeyCredential.signalCurrentUserDetails().

Functions

addCredential

suspend fun addCredential(args: WebAuthn.AddCredentialParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun addCredential(authenticatorId: String, credential: WebAuthn.Credential)

Adds the credential to the specified authenticator.

addVirtualAuthenticator

suspend fun addVirtualAuthenticator(options: WebAuthn.VirtualAuthenticatorOptions): WebAuthn.AddVirtualAuthenticatorReturn

suspend fun addVirtualAuthenticator(args: WebAuthn.AddVirtualAuthenticatorParameter, mode: CommandMode = CommandMode.DEFAULT): WebAuthn.AddVirtualAuthenticatorReturn

Creates and adds a virtual authenticator.

clearCredentials

suspend fun clearCredentials(authenticatorId: String)

suspend fun clearCredentials(args: WebAuthn.ClearCredentialsParameter, mode: CommandMode = CommandMode.DEFAULT)

Clears all the credentials from the specified device.

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disable the WebAuthn domain.

enable

suspend fun enable(enableUI: Boolean? = null)

suspend fun enable(args: WebAuthn.EnableParameter, mode: CommandMode = CommandMode.DEFAULT)

Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.

getCredential

suspend fun getCredential(args: WebAuthn.GetCredentialParameter, mode: CommandMode = CommandMode.DEFAULT): WebAuthn.GetCredentialReturn

suspend fun getCredential(authenticatorId: String, credentialId: String): WebAuthn.GetCredentialReturn

Returns a single credential stored in the given virtual authenticator that matches the credential ID.

getCredentials

suspend fun getCredentials(authenticatorId: String): WebAuthn.GetCredentialsReturn

suspend fun getCredentials(args: WebAuthn.GetCredentialsParameter, mode: CommandMode = CommandMode.DEFAULT): WebAuthn.GetCredentialsReturn

Returns all the credentials stored in the given virtual authenticator.

removeCredential

suspend fun removeCredential(args: WebAuthn.RemoveCredentialParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun removeCredential(authenticatorId: String, credentialId: String)

Removes a credential from the authenticator.

removeVirtualAuthenticator

suspend fun removeVirtualAuthenticator(authenticatorId: String)

suspend fun removeVirtualAuthenticator(args: WebAuthn.RemoveVirtualAuthenticatorParameter, mode: CommandMode = CommandMode.DEFAULT)

Removes the given authenticator.

setAutomaticPresenceSimulation

suspend fun setAutomaticPresenceSimulation(args: WebAuthn.SetAutomaticPresenceSimulationParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setAutomaticPresenceSimulation(authenticatorId: String, enabled: Boolean)

Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator. The default is true.

setCredentialProperties

suspend fun setCredentialProperties(args: WebAuthn.SetCredentialPropertiesParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setCredentialProperties(authenticatorId: String, credentialId: String, backupEligibility: Boolean? = null, backupState: Boolean? = null)

Allows setting credential properties. https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties

setResponseOverrideBits

suspend fun setResponseOverrideBits(args: WebAuthn.SetResponseOverrideBitsParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setResponseOverrideBits(authenticatorId: String, isBogusSignature: Boolean? = null, isBadUV: Boolean? = null, isBadUP: Boolean? = null)

Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.

setUserVerified

suspend fun setUserVerified(args: WebAuthn.SetUserVerifiedParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setUserVerified(authenticatorId: String, isUserVerified: Boolean)

Sets whether User Verification succeeds or fails for an authenticator. The default is true.