webauthn-model/dev.webauthn.model

Package-level declarations

Types

Aaguid

@JvmInline

value class Aaguid

W3C WebAuthn L3: §6.5 AAGUID value in attested credential data.

AttestationConveyancePreference

enum AttestationConveyancePreference : Enum<AttestationConveyancePreference>

W3C WebAuthn L3: §5.4.7 AttestationConveyancePreference enumeration.

AttestedCredentialData

data class AttestedCredentialData(val aaguid: Aaguid, val credentialId: CredentialId, val cosePublicKey: CosePublicKey)

W3C WebAuthn L3: §6.5. Attested Credential Data

AuthenticationExtensionsClientInputs

data class AuthenticationExtensionsClientInputs(val prf: PrfExtensionInput? = null, val largeBlob: LargeBlobExtensionInput? = null, val relatedOrigins: List<String>? = null)

W3C WebAuthn L3: §9.1. WebAuthn Extensions

AuthenticationExtensionsClientOutputs

data class AuthenticationExtensionsClientOutputs(val prf: PrfExtensionOutput? = null, val largeBlob: LargeBlobExtensionOutput? = null)

W3C WebAuthn L3: §9.1. WebAuthn Extensions Output

AuthenticationExtensionsPRFValues

data class AuthenticationExtensionsPRFValues(val first: Base64UrlBytes, val second: Base64UrlBytes? = null)

W3C WebAuthn L3: §9.2.1. AuthenticationExtensionsPRFValues dictionary

AuthenticationResponse

data class AuthenticationResponse(val credentialId: CredentialId, val clientDataJson: Base64UrlBytes, val rawAuthenticatorData: Base64UrlBytes, val authenticatorData: AuthenticatorData, val signature: Base64UrlBytes, val userHandle: UserHandle? = null, val authenticatorAttachment: AuthenticatorAttachment? = null, val extensions: AuthenticationExtensionsClientOutputs? = null)

W3C WebAuthn L3: §5.2.1. AuthenticatorAssertionResponse Interface

AuthenticatorAttachment

enum AuthenticatorAttachment : Enum<AuthenticatorAttachment>

W3C WebAuthn L3: §5.4.5 AuthenticatorAttachment enumeration.

AuthenticatorData

data class AuthenticatorData(val rpIdHash: RpIdHash, val flags: Int, val signCount: Long)

W3C WebAuthn L3: §6.1. Authenticator Data

AuthenticatorTransport

enum AuthenticatorTransport : Enum<AuthenticatorTransport>

W3C WebAuthn L3: §5.8.4 AuthenticatorTransport enumeration.

Base64UrlBytes

@JvmInline

value class Base64UrlBytes

RFC 4648 §5 base64url bytes without padding, as required by WebAuthn JSON fields.

Challenge

@JvmInline

value class Challenge

W3C WebAuthn L3: §13.4.3 challenge requirements (minimum entropy/length).

ClientDataHash

@JvmInline

value class ClientDataHash

W3C WebAuthn L3: §5.8.1 hash(clientDataJSON) carried in signature verification inputs.

CollectedClientData

data class CollectedClientData(val type: String, val challenge: Challenge, val origin: Origin, val crossOrigin: Boolean? = null)

W3C WebAuthn L3: §5.8.1. Client Data Used in WebAuthn Signatures (CollectedClientData)

CosePublicKey

@JvmInline

value class CosePublicKey

W3C WebAuthn L3: §6.5.1 credentialPublicKey (COSE_Key) bytes.

CredentialId

@JvmInline

value class CredentialId

W3C WebAuthn L3: §5.1 credential identifier type.

ExperimentalWebAuthnL3Api

@RequiresOptIn(message = "This API depends on WebAuthn Level 3 features that may evolve before broader stabilization.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class ExperimentalWebAuthnL3Api

Marker for APIs that depend on WebAuthn Level 3 features and may evolve with spec updates.

LargeBlobExtensionInput

data class LargeBlobExtensionInput(val support: LargeBlobExtensionInput.LargeBlobSupport? = null, val read: Boolean? = null, val write: Base64UrlBytes? = null)

W3C WebAuthn L3: §9.2.2. Large blob storage extension (largeBlob)

LargeBlobExtensionOutput

data class LargeBlobExtensionOutput(val supported: Boolean? = null, val blob: Base64UrlBytes? = null, val written: Boolean? = null)

W3C WebAuthn L3: §9.2.2. Large blob storage extension (largeBlob) Output

Origin

@JvmInline

value class Origin

W3C WebAuthn L3: §5.8.1 / §7 origin validation input.

PrfExtensionInput

data class PrfExtensionInput(val eval: AuthenticationExtensionsPRFValues? = null, val evalByCredential: Map<String, AuthenticationExtensionsPRFValues>? = null)

W3C WebAuthn L3: §9.2.1. HMAC Secret Extension (prf)

PrfExtensionOutput

data class PrfExtensionOutput(val enabled: Boolean? = null, val results: AuthenticationExtensionsPRFValues? = null)

W3C WebAuthn L3: §9.2.1. HMAC Secret Extension (prf) Output

PublicKeyCredentialCreationOptions

data class PublicKeyCredentialCreationOptions(val rp: PublicKeyCredentialRpEntity, val user: PublicKeyCredentialUserEntity, val challenge: Challenge, val pubKeyCredParams: List<PublicKeyCredentialParameters>, val timeoutMs: Long? = null, val excludeCredentials: List<PublicKeyCredentialDescriptor> = [], val authenticatorAttachment: AuthenticatorAttachment? = null, val residentKey: ResidentKeyRequirement = ResidentKeyRequirement.PREFERRED, val userVerification: UserVerificationRequirement = UserVerificationRequirement.PREFERRED, val attestation: AttestationConveyancePreference? = null, val extensions: AuthenticationExtensionsClientInputs? = null)

W3C WebAuthn L3: §5.4. Options for Credential Creation (PublicKeyCredentialCreationOptions)

PublicKeyCredentialDescriptor

data class PublicKeyCredentialDescriptor(val type: PublicKeyCredentialType, val id: CredentialId, val transports: List<AuthenticatorTransport> = [])

W3C WebAuthn L3: §5.10.3. PublicKeyCredentialDescriptor Dictionary

PublicKeyCredentialParameters

data class PublicKeyCredentialParameters(val type: PublicKeyCredentialType, val alg: Int)

W3C WebAuthn L3: §5.4.4. PublicKeyCredentialParameters Dictionary

PublicKeyCredentialRequestOptions

data class PublicKeyCredentialRequestOptions(val challenge: Challenge, val rpId: RpId? = null, val timeoutMs: Long? = null, val allowCredentials: List<PublicKeyCredentialDescriptor> = [], val userVerification: UserVerificationRequirement = UserVerificationRequirement.PREFERRED, val extensions: AuthenticationExtensionsClientInputs? = null)

W3C WebAuthn L3: §5.5. Options for Assertion Generation (PublicKeyCredentialRequestOptions)

PublicKeyCredentialRpEntity

data class PublicKeyCredentialRpEntity(val id: RpId, val name: String)

W3C WebAuthn L3: §5.4.2. PublicKeyCredentialRpEntity Dictionary

PublicKeyCredentialType

enum PublicKeyCredentialType : Enum<PublicKeyCredentialType>

W3C WebAuthn L3: §5.8 PublicKeyCredential.type values.

PublicKeyCredentialUserEntity

data class PublicKeyCredentialUserEntity(val id: UserHandle, val name: String, val displayName: String)

W3C WebAuthn L3: §5.4.3. PublicKeyCredentialUserEntity Dictionary

RawAuthenticationResponse

data class RawAuthenticationResponse(val credentialId: CredentialId, val clientDataJson: Base64UrlBytes, val authenticatorData: Base64UrlBytes, val signature: Base64UrlBytes, val userHandle: UserHandle? = null, val authenticatorAttachment: AuthenticatorAttachment? = null, val extensions: AuthenticationExtensionsClientOutputs? = null)

Byte-preserving assertion output before protocol interpretation.

RawRegistrationResponse

data class RawRegistrationResponse(val credentialId: CredentialId, val clientDataJson: Base64UrlBytes, val attestationObject: Base64UrlBytes, val authenticatorAttachment: AuthenticatorAttachment? = null, val extensions: AuthenticationExtensionsClientOutputs? = null)

Byte-preserving credential-creation output before protocol interpretation.

RegistrationResponse

data class RegistrationResponse(val credentialId: CredentialId, val clientDataJson: Base64UrlBytes, val attestationObject: Base64UrlBytes, val rawAuthenticatorData: AuthenticatorData, val attestedCredentialData: AttestedCredentialData, val authenticatorAttachment: AuthenticatorAttachment? = null, val extensions: AuthenticationExtensionsClientOutputs? = null)

W3C WebAuthn L3: §5.2. AuthenticatorAttestationResponse Interface

ResidentKeyRequirement

enum ResidentKeyRequirement : Enum<ResidentKeyRequirement>

W3C WebAuthn L3: §5.4.6 ResidentKeyRequirement enumeration.

RpId

@JvmInline

value class RpId

W3C WebAuthn L3: §4 Terminology and RP ID handling rules used by the ceremonies.

RpIdHash

@JvmInline

value class RpIdHash

W3C WebAuthn L3: §6.1 rpIdHash field from authenticator data.

UserHandle

@JvmInline

value class UserHandle

W3C WebAuthn L3: §5.4.3 user handle type.

UserVerificationRequirement

enum UserVerificationRequirement : Enum<UserVerificationRequirement>

W3C WebAuthn L3: §5.4.6 UserVerificationRequirement enumeration.

ValidationResult

sealed interface ValidationResult<out T>

Typed validation result used by WebAuthn model parsing and ceremony validation flows.

WebAuthnExtension

sealed interface WebAuthnExtension

Represents a standard or proprietary extension defined in the W3C WebAuthn specification (or IANA registry).

WebAuthnValidationError

sealed interface WebAuthnValidationError

Structured validation errors used by model parsing and ceremony validation.

Functions

getOrNull

fun <T> ValidationResult<T>.getOrNull(): T?

getOrThrow

fun <T> ValidationResult<T>.getOrThrow(): T