multipaz/org.multipaz.mdoc.request

Package-level declarations

Types

data class AlternativeDataElementSet(val requestedElement: ElementReference, val alternativeElementSets: List<List<ElementReference>>)

An alternative data element set.

Top-level request in ISO 18013-5.

class ~~DeviceRequestGenerator~~(val encodedSessionTranscript: ByteArray)

Helper class for building DeviceRequest CBOR as specified in ISO/IEC 18013-5:2021 section 8.3 Device Retrieval.

data class DeviceRequestInfo(val dataItem: DataItem)

Device request info according to ISO 18013-5 Second Edition.

class ~~DeviceRequestParser~~(encodedDeviceRequest: ByteArray, encodedSessionTranscript: ByteArray)

Helper class for parsing the bytes of DeviceRequest CBOR as specified in ISO/IEC 18013-5:2021 section 8.3 Device Retrieval.

data class DocRequest

Document request according to ISO 18013-5.

data class DocRequestInfo(val alternativeDataElements: List<AlternativeDataElementSet> = emptyList(), val issuerIdentifiers: List<ByteString> = emptyList(), val uniqueDocSetRequired: Boolean? = null, val maximumResponseSize: Long? = null, val zkRequest: ZkRequest? = null, val docResponseEncryption: EncryptionParameters? = null, val docFormat: String? = null, val dataElementIdentifierMapping: Map<String, JsonArray> = emptyMap(), val transactionData: TransactionsInfo? = null, val otherInfo: Map<String, DataItem> = emptyMap())

Document request info according to ISO 18013-5.

data class DocumentSet(val docRequestIds: List<Int>)

A document set according to ISO 18013-5.

data class ElementReference(val namespace: String, val dataElement: String)

A reference to a data element.

Parameters to use when requesting to encrypt a document response.

Data structure that describes transactions in a ISO/IEC 18013 request (transactions array in requestInfo).

data class UseCase(val mandatory: Boolean, val documentSets: List<DocumentSet>, val purposeHints: Map<String, Int>)

Use-cases according to ISO 18013-5.

data class ZkRequest(val systemSpecs: List<ZkSystemSpec>, val zkRequired: Boolean)

inline fun buildDeviceRequest(sessionTranscript: DataItem, deviceRequestInfo: DeviceRequestInfo? = null, version: String? = null, builderAction: DeviceRequest.Builder.() -> Unit): DeviceRequest

inline fun buildDeviceRequestFromDcql(sessionTranscript: DataItem, dcqlString: String, otherInfo: Map<String, DataItem> = emptyMap(), transactions: Map<String, TransactionsInfo> = emptyMap(), defaultIntentToRetain: Boolean = false, version: String? = null, builderAction: DeviceRequest.Builder.() -> Unit = {}): DeviceRequest

inline fun buildDeviceRequestFromDcql(sessionTranscript: DataItem, dcql: JsonObject, otherInfo: Map<String, DataItem> = emptyMap(), transactions: Map<String, TransactionsInfo> = emptyMap(), defaultIntentToRetain: Boolean = false, version: String? = null, builderAction: DeviceRequest.Builder.() -> Unit = {}): DeviceRequest