makoto/at.asitplus.attestation

Package-level declarations

Types

Pairs an Apple AppAttest assertion with the referenced clientData value

sealed class AttestationException : Throwable

Provides additional details on why an attestation attempt failed, indicating which platform was being attested. Although many reasons exist why an attestation may fail, all of them can be put into two categories:

AttestationObject

data class AttestationObject(val fmt: String, val attStmt: AttestationObject.AttestationStatement, val authData: ByteArray)

AttestationResult

sealed class AttestationResult

Attestation result class. Successful results contain attested data. Typically contained within a KeyAttestation object.

AttestationService

abstract class AttestationService

BuildNumber

class BuildNumber : Comparable<BuildNumber>

iOS build number. As per TidBITS.com:

FixedTimeClock

class FixedTimeClock(epochMilliseconds: Long) : Clock

InstantLongSerializer

class InstantLongSerializer : KSerializer<Instant>

IOSAttestationConfiguration

typealias ~~IOSAttestationConfiguration~~ = IosAttestationConfiguration

IosAttestationConfiguration

@Serializable

data class IosAttestationConfiguration @JvmOverloads constructor(val applications: List<IosAttestationConfiguration.AppData>, val iosVersion: IosAttestationConfiguration.OsVersions? = null, val attestationStatementValiditySeconds: Long = 5 * 60)

Configuration class for Apple App Attestation

IosAttestationException

class IosAttestationException(msg: String? = null, cause: Throwable? = null, val reason: IosAttestationException.Reason) : Throwable

KeyAttestation

data class KeyAttestation<T : PublicKey>

Result type returned by AttestationService.verifyKeyAttestation. attestedPublicKey contains an attested public key if attestation was successful (null otherwise) details contains the detailed attestation result (see AttestationResult for more details)

Makoto

typealias Makoto = Warden

NoopAttestationService

object NoopAttestationService : AttestationService

NOOP attestation service. Useful during unit tests for disabling attestation integrated into service endpoints. Simply forwards inputs but performs no attestation whatsoever.

ParsedVersions

typealias ParsedVersions = Pair<SemVer?, BuildNumber?>

Platform

enum Platform : Enum<Platform>

Indicated the platform an attestation check failed for.

Warden

class Warden(androidAttestationConfiguration: AndroidAttestationConfiguration, iosAttestationConfiguration: IosAttestationConfiguration, clock: <Error class: unknown class> = Clock.System, verificationTimeOffset: Duration = Duration.ZERO) : AttestationService

Default, functional Android and Apple App and Key Attestation in all its glory.

WardenDebugAttestationStatement

@Serializable

data class WardenDebugAttestationStatement

Functions

parseToCertificate

fun ByteArray.parseToCertificate(): X509Certificate?

parseToPublicKey

fun ByteArray.parseToPublicKey(): PublicKey

toKotlinClock

fun Clock.toKotlinClock(): Clock