multipaz/org.multipaz.mdoc.nfc/MdocNfcEngagementHelper

MdocNfcEngagementHelper

class MdocNfcEngagementHelper(val eDeviceKey: EcPublicKey, val onHandoverComplete: (connectionMethods: List<MdocConnectionMethod>, encodedDeviceEngagement: ByteString, handover: DataItem) -> Unit, val onError: (error: Exception) -> Unit, val staticHandoverMethods: List<MdocConnectionMethod>? = null, val negotiatedHandoverPicker: (connectionMethods: List<MdocConnectionMethod>) -> MdocConnectionMethod? = null, val capabilities: Map<Capability, DataItem> = mapOf( Capability.READER_AUTH_ALL_SUPPORT to true.toDataItem(), Capability.EXTENDED_REQUEST_SUPPORT to true.toDataItem() ))

Helper used for NFC engagement on the mdoc side.

This implements NFC engagement according to ISO/IEC 18013-5:2021.

APDUs received from the NFC tag reader should be passed to the processApdu method and deactivation events to processDeactivated. Once handover is deemed to be complete or an error is detected, either onHandoverComplete or onError is called.

Parameters

eDeviceKey

EDeviceKey as per ISO/IEC 18013-5:2021.

onHandoverComplete

the function to call when handover is complete.

onError

the function to call if an error occurs.

staticHandoverMethods

list of connection methods to offer the mdoc reader, must contain at least one element, or null to not use NFC static handover.

negotiatedHandoverPicker

a function to choose one of the connection methods from the mdoc reader or null to not use NFC negotiated handover.

Constructors

MdocNfcEngagementHelper

constructor(eDeviceKey: EcPublicKey, onHandoverComplete: (connectionMethods: List<MdocConnectionMethod>, encodedDeviceEngagement: ByteString, handover: DataItem) -> Unit, onError: (error: Exception) -> Unit, staticHandoverMethods: List<MdocConnectionMethod>? = null, negotiatedHandoverPicker: (connectionMethods: List<MdocConnectionMethod>) -> MdocConnectionMethod? = null, capabilities: Map<Capability, DataItem> = mapOf( Capability.READER_AUTH_ALL_SUPPORT to true.toDataItem(), Capability.EXTENDED_REQUEST_SUPPORT to true.toDataItem() ))