abstract class PresentmentSource(val documentStore: DocumentStore, val documentTypeRepository: DocumentTypeRepository, val zkSystemRepository: ZkSystemRepository? = null, val eventLogger: EventLogger? = null)

The source of truth used for credential presentment.

Thrown when timing out waiting for the reader to connect.

Value that conveys a request for a key in a SecureArea be unlocked in order to present a Credential to a Relying Party.

class SimplePresentmentSource(val documentStore: DocumentStore, val documentTypeRepository: DocumentTypeRepository, val zkSystemRepository: ZkSystemRepository? = null, val eventLogger: EventLogger? = null, resolveTrustFn: suspend (requester: Requester) -> TrustMetadata? = { requester -> null }, showConsentPromptFn: ShowConsentPromptFn = ::promptModelRequestConsent, val preferSignatureToKeyAgreement: Boolean = true, val domainsMdocSignature: List<String> = emptyList(), val domainsMdocKeyAgreement: List<String> = emptyList(), val domainsKeylessSdJwt: List<String> = emptyList(), val domainsKeyBoundSdJwt: List<String> = emptyList()) : PresentmentSource

An implementation of PresentmentSource for when using ISO mdoc and IETF SD-JWT VC credentials.

An abstract object that describes transaction data item.

TransactionData in CBOR format as used in ISO/IEC 18013-5:2021.

class TransactionDataJson(type: TransactionType, val base64UrlEncodedJson: String, val data: JsonObject = Json.parseToJsonElement(base64UrlEncodedJson.fromBase64Url().decodeToString()).jsonObject) : TransactionData

TransactionData in JSON format as used in OpenID4VP.

Functions

suspend fun digitalCredentialsPresentment(protocol: String, data: String, appId: String?, origin: String, preselectedDocuments: List<Document>, source: PresentmentSource, onDocumentsInFocus: (documents: List<Document>) -> Unit = {}): String

suspend fun digitalCredentialsPresentment(protocol: String, data: JsonObject, appId: String?, origin: String, preselectedDocuments: List<Document>, source: PresentmentSource, onDocumentsInFocus: (documents: List<Document>) -> Unit = {}): JsonObject

Present credentials according to the W3C Digital Credentials API.

suspend fun Iso18013Presentment(transport: MdocTransport, eDeviceKey: EcPrivateKey, deviceEngagement: DataItem, handover: DataItem, source: PresentmentSource, keyAgreementPossible: List<EcCurve>, timeout: Duration? = 10.seconds, timeoutSubsequentRequests: Duration? = 30.seconds, onWaitingForRequest: () -> Unit = {}, onWaitingForUserInput: () -> Unit = {}, onDocumentsInFocus: (documents: List<Document>) -> Unit = {}, onSendingResponse: () -> Unit = {})

Performs proximity presentment according to ISO/IEC 18013-5:2021.

suspend fun mdocPresentment(deviceRequest: DeviceRequest, eReaderKey: EcPublicKey?, sessionTranscript: DataItem, source: PresentmentSource, keyAgreementPossible: List<EcCurve>, requesterAppId: String?, requesterOrigin: String?, preselectedDocuments: List<Document> = emptyList(), onWaitingForUserInput: () -> Unit = {}, onDocumentsInFocus: (documents: List<Document>) -> Unit): MdocResponse

Present ISO mdoc credentials according to ISO/IEC 18013-5:2021.

suspend fun uriSchemePresentment(source: PresentmentSource, uri: String, appId: String?, origin: String?, httpClientEngineFactory: HttpClientEngineFactory<*>, onDocumentsInFocus: (documents: List<Document>) -> Unit = {}): String?

Present credentials according to OpenID4VP 1.0 w/ URI schemes.