webauthn-client-ktor/dev.webauthn.network/KtorPasskeyContractCodec

KtorPasskeyContractCodec

interface KtorPasskeyContractCodec<RegistrationInput, RegistrationState, RegistrationOutput, AuthenticationInput, AuthenticationState, AuthenticationOutput>

Serialization contract for a Ktor-backed passkey backend.

The transport has no serialization implementation dependency. The state returned from each start decoder is passed unchanged to the corresponding finish encoder.

Functions

decodeAuthenticationFinish

abstract fun decodeAuthenticationFinish(body: String): AuthenticationOutput

decodeAuthenticationStart

abstract fun decodeAuthenticationStart(body: String): ValidationResult<CeremonyStart<AuthenticationState, PublicKeyCredentialRequestOptions>>

decodeError

abstract fun decodeError(body: String): String?

Returns a safe backend error message when available, otherwise null.

decodeRegistrationFinish

abstract fun decodeRegistrationFinish(body: String): RegistrationOutput

decodeRegistrationStart

abstract fun decodeRegistrationStart(body: String): ValidationResult<CeremonyStart<RegistrationState, PublicKeyCredentialCreationOptions>>

encodeAuthenticationFinish

abstract fun encodeAuthenticationFinish(state: AuthenticationState, response: RawAuthenticationResponse): String

encodeAuthenticationStart

abstract fun encodeAuthenticationStart(input: AuthenticationInput): String

encodeRegistrationFinish

abstract fun encodeRegistrationFinish(state: RegistrationState, response: RawRegistrationResponse): String

encodeRegistrationStart

abstract fun encodeRegistrationStart(input: RegistrationInput): String