blockchain-kit-sdk/com.cramium.blockchain.kit.passkey

Package-level declarations

Types

@Serializable

data class AuthenticatorSelection(val authenticatorAttachment: String? = null, val residentKey: String = "required", val requireResidentKey: Boolean = true, val userVerification: String = "required")

Authenticator selection criteria for registration.

AuthResult

@Serializable

data class AuthResult(val credentialId: String, val accessToken: String, val refreshToken: String)

Result of a successful authentication. Flutter-facing DTO - exposed via code generation.

AuthSession

@Serializable

data class AuthSession(val accessToken: String, val refreshToken: String?, val sessionId: String?)

Session data returned after successful WebAuthn authentication or registration.

CannotDeleteLastCredentialException

class CannotDeleteLastCredentialException : Exception

Exception thrown when attempting to delete the last active credential.

CreateCredentialResult

@Serializable

data class CreateCredentialResult(val credentialId: String, val rawId: String, val type: String = "public-key", val authenticatorAttachment: String? = null, val clientDataJSON: String, val attestationObject: String, val transports: List<String>? = null, val publicKey: String? = null, val publicKeyAlgorithm: Long? = null)

Result from PasskeyClient.createCredential(). Contains the raw WebAuthn response data from registration.

CredentialDescriptor

@Serializable

data class CredentialDescriptor(val type: String = "public-key", val id: String, val transports: List<String>? = null)

Credential descriptor for allowCredentials/excludeCredentials.

CredentialInfo

@Serializable

data class CredentialInfo(val id: String, val displayName: String, val type: CredentialType, val prfCapable: Boolean, val createdAt: Long, val lastUsedAt: Long, val status: CredentialStatus)

Information about a registered credential. Flutter-facing DTO - exposed via code generation.

CredentialNotFoundException

class CredentialNotFoundException(val credentialId: String) : Exception

Exception thrown when a credential is not found.

CredentialRevokedException

class CredentialRevokedException(val credentialId: String) : Exception

Exception thrown when attempting to use a revoked credential.

CredentialService

class CredentialService

Flutter submodule for credential registry management.

CredentialServiceAndroid

class CredentialServiceAndroid(binaryMessenger: BinaryMessenger, parentModule: BlockchainKitSdkAndroid) : MethodChannel, MethodChannel.MethodCallHandler

CredentialStatus

@Serializable

enum CredentialStatus : Enum<CredentialStatus>

Status of a credential in the registry.

CredentialType

@Serializable

enum CredentialType : Enum<CredentialType>

Type of WebAuthn credential.

GetAssertionResult

@Serializable

data class GetAssertionResult(val credentialId: String, val rawId: String, val type: String = "public-key", val authenticatorAttachment: String? = null, val clientDataJSON: String, val authenticatorData: String, val signature: String, val userHandle: String? = null)

Result from PasskeyClient.getAssertion(). Contains the raw WebAuthn assertion data from authentication.

GetAssertionWithPrfResult

@Serializable

data class GetAssertionWithPrfResult(val assertion: GetAssertionResult, val prfOutput: String?)

Result from PasskeyClient.getAssertionWithPrf(). Contains assertion data plus PRF output for key derivation.

PasskeyAssertion

@Serializable

data class PasskeyAssertion(val credentialId: ByteArray, val authenticatorData: ByteArray, val signature: ByteArray, val clientDataJSON: ByteArray, val userHandle: ByteArray?)

Represents a WebAuthn passkey assertion created during authentication.

PasskeyCancelledException

class PasskeyCancelledException(message: String = "Passkey operation was cancelled by user") : Exception

Exception thrown when a passkey operation is cancelled by the user.

PasskeyClientOperations

interface PasskeyClientOperations

Interface for passkey client operations.

PasskeyCredential

@Serializable

data class PasskeyCredential(val credentialId: ByteArray, val publicKey: ByteArray, val authenticatorData: ByteArray, val clientDataJSON: ByteArray, val attestationObject: ByteArray? = null)

Represents a WebAuthn passkey credential created during registration.

PasskeyDetails

@Serializable

data class PasskeyDetails(val credentialId: String, val credentialPublicKey: String, val aaguid: String? = null, val attestationObject: String? = null, val counter: Int? = null, val credentialBackedUp: Boolean? = null, val credentialDeviceType: String? = null, val extensionResults: String? = null, val fmt: String? = null, val nickname: String? = null, val origin: String? = null, val passkeyProvider: String? = null, val prfSupported: Boolean? = null, val rpId: String? = null, val transports: List<String>? = null, val userVerified: Boolean? = null)

Represents the passkey credential details stored locally after registration.

PasskeyException

class PasskeyException(message: String?, cause: Throwable? = null) : Exception

Exception thrown when a passkey operation fails.

PasskeyMismatchException

class PasskeyMismatchException(message: String) : Exception

Exception thrown when a passkey credential ID doesn't match the backup's stored credential. This prevents users from logging in with a different passkey than the one used to encrypt their backup.

PasskeyResult

sealed class PasskeyResult<out T>

Represents the result of a passkey operation.

PasskeyService

class PasskeyService

Flutter submodule for WebAuthn passkey operations.

PasskeyServiceAndroid

class PasskeyServiceAndroid(binaryMessenger: BinaryMessenger, parentModule: BlockchainKitSdkAndroid) : MethodChannel, MethodChannel.MethodCallHandler

PrfEvalInput

@Serializable

data class PrfEvalInput(val first: String, val second: String? = null)

PRF evaluation input containing the salt(s).

PrfExtensionInput

@Serializable

data class PrfExtensionInput(val eval: PrfEvalInput? = null)

PRF extension input for key derivation. The PRF (Pseudo-Random Function) extension allows deriving cryptographic keys from passkey authentication.

PubKeyCredParam

@Serializable

data class PubKeyCredParam(val type: String = "public-key", val alg: Int)

Public key credential algorithm parameter.

PublicKeyCredentialCreationOptions

@Serializable

data class PublicKeyCredentialCreationOptions(val challenge: String, val rpId: String, val rpName: String, val userId: String, val userName: String, val userDisplayName: String, val timeout: Long = 60000, val attestation: String = "none", val authenticatorSelection: AuthenticatorSelection? = null, val pubKeyCredParams: List<PubKeyCredParam> = listOf( PubKeyCredParam(type = "public-key", alg = -7) // ES256 ), val excludeCredentials: List<CredentialDescriptor> = emptyList())

WebAuthn credential creation options for passkey registration. Matches the WebAuthn PublicKeyCredentialCreationOptions structure.

PublicKeyCredentialRequestOptions

@Serializable

data class PublicKeyCredentialRequestOptions(val challenge: String, val rpId: String, val timeout: Long = 60000, val userVerification: String = "required", val allowCredentials: List<CredentialDescriptor> = emptyList(), val extensions: WebAuthnExtensions? = null)

WebAuthn credential request options for passkey authentication. Matches the WebAuthn PublicKeyCredentialRequestOptions structure.

WebAuthnExtensions

@Serializable

data class WebAuthnExtensions(val prf: PrfExtensionInput? = null)

WebAuthn extensions container for authentication requests.

Functions

isPrfSupportedPlatform

actual fun isPrfSupportedPlatform(): Boolean

Android implementation of PRF support check.

expect fun isPrfSupportedPlatform(): Boolean

Check if the current platform supports WebAuthn PRF extension.

toCreatePasskeyRequest

fun PasskeyDetails.toCreatePasskeyRequest(): ERROR CLASS: Symbol not found for WalletsCreatePasskeyRequest

Converts PasskeyDetails to WalletsCreatePasskeyRequest.