multipaz/org.multipaz.eventlogger

Package-level declarations

Types

Event

sealed class Event

Base class for events recorded in the EventLogger.

EventLogger

interface EventLogger

An interface for a persistent logger for recording events.

EventPresentment

sealed class EventPresentment : Event

Base class for events recorded in EventLogger related to credential presentment.

EventPresentmentData

data class EventPresentmentData(val requesterName: String?, val requesterCertChain: X509CertChain?, val trustMetadata: TrustMetadata?, val requestedDocuments: List<EventPresentmentDataDocument>)

High-level data involved in a presentment event.

EventPresentmentDataDocument

data class EventPresentmentDataDocument(val documentId: String, val documentName: String?, val claims: Map<RequestedClaim, Claim>)

A document requested in a presentment event.

EventPresentmentDigitalCredentialsMdocApi

data class EventPresentmentDigitalCredentialsMdocApi(val identifier: String = "", val timestamp: Instant = Instant.DISTANT_PAST, val appData: Map<String, DataItem> = emptyMap(), val presentmentData: EventPresentmentData, val appId: String?, val origin: String, val protocol: String, val requestJson: String, val responseJson: String, val deviceResponse: DataItem) : EventPresentment

An event representing an ISO/IEC 18013-7 Annex C presentment requested via Digital Credentials API.

EventPresentmentDigitalCredentialsOpenID4VP

data class EventPresentmentDigitalCredentialsOpenID4VP(val identifier: String = "", val timestamp: Instant = Instant.DISTANT_PAST, val appData: Map<String, DataItem> = emptyMap(), val presentmentData: EventPresentmentData, val appId: String?, val origin: String, val protocol: String, val requestJson: String, val responseJson: String, val vpToken: String, val state: String?) : EventPresentment

An event representing an OpenID4VP presentment requested via Digital Credentials API.

EventPresentmentIso18013AnnexA

data class EventPresentmentIso18013AnnexA(val identifier: String = "", val timestamp: Instant = Instant.DISTANT_PAST, val appData: Map<String, DataItem> = emptyMap(), val presentmentData: EventPresentmentData, val uri: String, val request: DataItem, val response: DataItem, val sessionTranscript: DataItem, val appId: String?, val origin: String?, val readerEngagement: DataItem) : EventPresentment

An event representing an ISO/IEC 18013-5 presentment according to 18013-7 Annex A.

EventPresentmentIso18013Proximity

data class EventPresentmentIso18013Proximity(val identifier: String = "", val timestamp: Instant = Instant.DISTANT_PAST, val appData: Map<String, DataItem> = emptyMap(), val presentmentData: EventPresentmentData, val request: DataItem, val response: DataItem, val sessionTranscript: DataItem) : EventPresentment

An event representing an ISO/IEC 18013-5 presentment for proximity.

EventPresentmentUriSchemeOpenID4VP

data class EventPresentmentUriSchemeOpenID4VP(val identifier: String = "", val timestamp: Instant = Instant.DISTANT_PAST, val appData: Map<String, DataItem> = emptyMap(), val presentmentData: EventPresentmentData, val uri: String, val appId: String?, val origin: String?, val requestJwt: String, val vpToken: String, val redirectUri: String?, val state: String?) : EventPresentment

An event representing an OpenID4VP presentment initiated via a URI scheme.

EventProvisioning

data class EventProvisioning(val identifier: String = "", val timestamp: Instant = Instant.DISTANT_PAST, val appData: Map<String, DataItem> = emptyMap(), val issuerData: EventProvisioningIssuerData, val initialProvisioning: Boolean, val documentId: String, val documentName: String?, val display: Display?, val credentialsFetched: Map<String, List<EventProvisioningCredentialData>>) : Event

An event recorded when a document is provisioned.

EventProvisioningCredentialData

data class EventProvisioningCredentialData(val issuerProvidedData: ByteString)

Data for a credential fetched during provisioning.

EventProvisioningIssuerData

sealed class EventProvisioningIssuerData

Base class for data about the issuer in a provisioning event.

EventProvisioningIssuerDataOpenID4VCI

data class EventProvisioningIssuerDataOpenID4VCI(val display: Display, val url: String, val credentialId: String) : EventProvisioningIssuerData

Issuer data for provisioning via OpenID4VCI.

EventSimple

data class EventSimple(val identifier: String = "", val timestamp: Instant = Instant.DISTANT_PAST, val appData: Map<String, DataItem> = emptyMap(), val data: ByteString) : Event

A simple event which can be used by applications for custom events.

SimpleEventLogger

class SimpleEventLogger(storage: Storage, partitionId: String = "default", expireAfter: Duration = 60.days, clock: Clock = Clock.System, onAddEvent: suspend (event: Event) -> Map<String, DataItem>? = { _ -> emptyMap() }, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)) : EventLogger

An implementation of EventLogger backed by a Storage implementation.