DeviceResponse

Top-level device response in ISO 18013-5.

To construct an instance use buildDeviceResponse.

For a response received from a remote mdoc use DeviceResponse.Companion.fromDataItem. Note that you have to manually call verify before accessing the documents field for instances created this way.

Types

class Builder(sessionTranscript: DataItem, status: Int, eReaderKey: EcPublicKey? = null, version: String? = null)

A builder for DeviceResponse.

a list of returned errors.

a list of returned and verified documents.

a list of returned encrypted documents.

a list of returned documents in other formats, such as SD-JWT VC.

the status field containing for example STATUS_OK or STATUS_GENERAL_ERROR.

the version of the device response, e.g. 1.0 or 1.1.

a list of returned documents with ZKP.

Generates CBOR compliant with the CDDL for DeviceResponse according to ISO 18013-5.

suspend fun verify(sessionTranscript: DataItem, eReaderKey: AsymmetricKey? = null, deviceRequest: DeviceRequest? = null, documentTypeRepository: DocumentTypeRepository? = null, atTime: Instant = Clock.System.now())

Verifies the integrity of the returned documents, according to ISO/IEC 18013-5.

suspend fun verifySingleDoc(sessionTranscript: DataItem, transactionData: List<TransactionData>, atTime: Instant = Clock.System.now())

Variant of verify that is intended for use with DeviceResponse data embedded in non-ISO/IEC-18013 verification response (such as OpenID4VP).