multipaz-provisioning-api/org.multipaz.provisioning.evidence

Package-level declarations

Types

data class DirectAccessDocumentConfiguration(val docType: String, val staticData: NameSpacedData)

A request for evidence by the issuer.

data class EvidenceRequestCompletionMessage(val messageTitle: String, val message: String, val assets: Map<String, ByteString>, val acceptButtonText: String, val rejectButtonText: String?) : EvidenceRequest

Message shown after completing the Evidence-gathering steps for Provisioning a document.

EvidenceRequestCreatePassphrase

data class EvidenceRequestCreatePassphrase(val passphraseConstraints: PassphraseConstraints, val message: String, val verifyMessage: String, val assets: Map<String, ByteString>) : EvidenceRequest

Evidence type for asking the user to create a PIN/passphrase.

EvidenceRequestCredentialOffer

class EvidenceRequestCredentialOffer : EvidenceRequest

Request pre-authorized code from the client. Pre-authorized code is given to a wallet app as a part of an OpenId4VCI credential offer.

EvidenceRequestIcaoNfcTunnel

data class EvidenceRequestIcaoNfcTunnel(val requestType: EvidenceRequestIcaoNfcTunnelType, val passThrough: Boolean, val progressPercent: Int, val message: ByteString) : EvidenceRequest

Evidence type for extracting data from an NFC-enabled passport or ID card through a tunneled NFC connection.

EvidenceRequestIcaoNfcTunnelType

enum EvidenceRequestIcaoNfcTunnelType : Enum<EvidenceRequestIcaoNfcTunnelType>

Types of EvidenceRequestIcaoTunnel messages.

EvidenceRequestIcaoPassiveAuthentication

data class EvidenceRequestIcaoPassiveAuthentication(val requestedDataGroups: List<Int>) : EvidenceRequest

Evidence type for the lowest authentication level of an NFC-enabled passport or ID card.

EvidenceRequestMessage

data class EvidenceRequestMessage(val message: String, val assets: Map<String, ByteString>, val acceptButtonText: String, val rejectButtonText: String?) : EvidenceRequest

Rich-text message presented to the user.

EvidenceRequestNotificationPermission

data class EvidenceRequestNotificationPermission(val permissionNotGrantedMessage: String, val assets: Map<String, ByteString>, val grantPermissionButtonText: String, val continueWithoutPermissionButtonText: String) : EvidenceRequest

A request to the user for permission to send notifications to them.

EvidenceRequestOpenid4Vp

class EvidenceRequestOpenid4Vp(val originUri: String, val request: String, val cancelText: String? = null) : EvidenceRequest

EvidenceRequestQuestionMultipleChoice

data class EvidenceRequestQuestionMultipleChoice(val message: String, val assets: Map<String, ByteString>, val possibleValues: Map<String, String>, val acceptButtonText: String) : EvidenceRequest

Evidence type for asking a question to the user and collecting an answer from a predefined list.

EvidenceRequestQuestionString

data class EvidenceRequestQuestionString(val message: String, val assets: Map<String, ByteString>, val defaultValue: String, val acceptButtonText: String) : EvidenceRequest

Evidence type for asking a question to the user and collecting a textual response.

EvidenceRequestSelfieVideo

data class EvidenceRequestSelfieVideo(val poseSequence: List<EvidenceRequestSelfieVideo.Poses>) : EvidenceRequest

EvidenceRequestSetupCloudSecureArea

data class EvidenceRequestSetupCloudSecureArea(val cloudSecureAreaIdentifier: String, val passphraseConstraints: PassphraseConstraints, val message: String, val verifyMessage: String, val assets: Map<String, ByteString>) : EvidenceRequest

Evidence type for asking the user to select a PIN/passphrase for a Cloud Secure Area.

EvidenceRequestWeb

data class EvidenceRequestWeb(val url: String, val redirectUri: String) : EvidenceRequest

Launch a browser using the given URL.

EvidenceResponse

sealed class EvidenceResponse

A response to an evidence request.

EvidenceResponseCreatePassphrase

data class EvidenceResponseCreatePassphrase(val passphrase: String) : EvidenceResponse

EvidenceResponseCredentialOffer

data class EvidenceResponseCredentialOffer(val credentialOffer: Openid4VciCredentialOffer) : EvidenceResponse

Provides OpenId4VCI credential offer data.

EvidenceResponseIcaoNfcTunnel

data class EvidenceResponseIcaoNfcTunnel(val response: ByteString) : EvidenceResponse

Response for EvidenceRequestIcaoNfcTunnel

EvidenceResponseIcaoNfcTunnelResult

data class EvidenceResponseIcaoNfcTunnelResult(val advancedAuthenticationType: EvidenceResponseIcaoNfcTunnelResult.AdvancedAuthenticationType, val dataGroups: Map<Int, ByteString>, val securityObject: ByteString) : EvidenceResponse

Evidence type for that represents the result of communicating through the tunnel implemented by EvidenceRequestIcaoNfcTunnel requests and responses.

EvidenceResponseIcaoPassiveAuthentication

data class EvidenceResponseIcaoPassiveAuthentication(val dataGroups: Map<Int, ByteString>, val securityObject: ByteString) : EvidenceResponse

EvidenceResponseMessage

data class EvidenceResponseMessage(val acknowledged: Boolean) : EvidenceResponse

EvidenceResponseNotificationPermission

data class EvidenceResponseNotificationPermission(val permissionGranted: Boolean) : EvidenceResponse

EvidenceResponseOpenid4Vp

class EvidenceResponseOpenid4Vp(val response: String) : EvidenceResponse

EvidenceResponseQuestionMultipleChoice

data class EvidenceResponseQuestionMultipleChoice(val answerId: String) : EvidenceResponse

EvidenceResponseQuestionString

data class EvidenceResponseQuestionString(val answer: String) : EvidenceResponse

EvidenceResponseSelfieVideo

data class EvidenceResponseSelfieVideo(val selfieImage: ByteArray) : EvidenceResponse

EvidenceResponseSetupCloudSecureArea

data class EvidenceResponseSetupCloudSecureArea(val cloudSecureAreaIdentifier: String) : EvidenceResponse

EvidenceResponseWeb

data class EvidenceResponseWeb(val response: String) : EvidenceResponse

Openid4VciCredentialOffer

sealed class Openid4VciCredentialOffer

Credential offer as described in OpenId4Vci spec: https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-offer-parameters

Openid4VciCredentialOfferAuthorizationCode

data class Openid4VciCredentialOfferAuthorizationCode(val issuerUri: String, val configurationId: String, val authorizationServer: String?, val issuerState: String?) : Openid4VciCredentialOffer

Credential offer with Grant Type authorization_code.

Openid4VciCredentialOfferGrantless

data class Openid4VciCredentialOfferGrantless(val issuerUri: String, val configurationId: String) : Openid4VciCredentialOffer

Credential offer that does not contain grants.

Openid4VciCredentialOfferPreauthorizedCode

data class Openid4VciCredentialOfferPreauthorizedCode(val issuerUri: String, val configurationId: String, val authorizationServer: String?, val preauthorizedCode: String, val txCode: Openid4VciTxCode?) : Openid4VciCredentialOffer

Credential offer with Grant Type urn:ietf:params:oauth:grant-type:pre-authorized_code.

Openid4VciTxCode

data class Openid4VciTxCode(val description: String, val isNumeric: Boolean, val length: Int)

Describes tx_code parameter (see OpenId4Vci spec referenced above).