multipaz-android-legacy/com.android.identity.android.mdoc.deviceretrieval/VerificationHelper

VerificationHelper

Helper used for engaging with and receiving documents from a remote mdoc verifier device.

This class implements the interface between an mdoc and mdoc verifier using the connection setup and device retrieval interfaces defined in ISO/IEC 18013-5:2021.

Reverse engagement as per drafts of 18013-7 and 23220-4 is supported. These protocols are not finalized so should only be used for testing.

Types

Builder

class Builder(context: Context, listener: VerificationHelper.Listener, executor: Executor)

Builder for VerificationHelper.

Companion

object Companion

EngagementMethod

enum EngagementMethod : Enum<VerificationHelper.EngagementMethod>

Listener

interface Listener

Interface for listening to messages from the remote mdoc device.

Properties

engagementMethod

var engagementMethod: VerificationHelper.EngagementMethod

engagementToRequestDurationMillis

val engagementToRequestDurationMillis: Long

The amount of time from when Engagement has been received until the request was sent.

eReaderKey

val eReaderKey: EcPrivateKey

The ephemeral key used by the reader for session encryption.

isTransportSpecificTerminationSupported

val isTransportSpecificTerminationSupported: Boolean

requestToResponseDurationMillis

val requestToResponseDurationMillis: Long

The amount of time from when the request was sent until the response was received.

scanningTimeMillis

val scanningTimeMillis: Long

The amount of time spent BLE scanning or 0 if no scanning occurred.

sessionTranscript

val sessionTranscript: ByteArray

The session transcript.

tapToEngagementDurationMillis

val tapToEngagementDurationMillis: Long

The amount of time from first NFC interaction until Engagement has been received.

Functions

connect

fun connect(connectionMethod: MdocConnectionMethod)

Establishes connection to remote mdoc using the given MdocConnectionMethod.

disconnect

fun disconnect()

Ends the session with the remote device.

nfcProcessOnTagDiscovered

fun nfcProcessOnTagDiscovered(tag: Tag)

Processes a Tag received when in NFC reader mode.

reportDeviceConnected

fun reportDeviceConnected()

reportDeviceDisconnected

fun reportDeviceDisconnected(transportSpecificTermination: Boolean)

reportDeviceEngagementReceived

fun reportDeviceEngagementReceived(connectionMethods: List<MdocConnectionMethod>)

reportError

fun reportError(error: Throwable)

reportMoveIntoNfcField

fun reportMoveIntoNfcField()

reportReaderEngagementReady

fun reportReaderEngagementReady(readerEngagement: ByteArray)

reportResponseReceived

fun reportResponseReceived(deviceResponseBytes: ByteArray)

reverseEngagementPeerHasConnected

fun reverseEngagementPeerHasConnected(transport: DataTransport)

reverseEngagementPeerIsConnecting

fun reverseEngagementPeerIsConnecting()

sendRequest

fun sendRequest(deviceRequestBytes: ByteArray)

Sends a request to the remote mdoc device.

setDeviceEngagementFromQrCode

fun setDeviceEngagementFromQrCode(qrDeviceEngagement: String)

Set device engagement received via QR code.

setSendSessionTerminationMessage

fun setSendSessionTerminationMessage(sendSessionTerminationMessage: Boolean)

Sets whether to send session termination message.

setUseTransportSpecificSessionTermination

fun setUseTransportSpecificSessionTermination(useTransportSpecificSessionTermination: Boolean)

Sets whether to use transport-specific session termination.