multipaz/org.multipaz.mdoc.request/DeviceRequest

DeviceRequest

data class DeviceRequest

Top-level request in ISO 18013-5.

To construct an instance use buildDeviceRequest.

For a request received from a remote mdoc reader use the DeviceRequest.Companion.fromDataItem method. Note that you will need to manually call verifyReaderAuthentication before accessing the readerAuthAll or DocRequest.readerAuth fields for instances created this way.

Types

class Builder(sessionTranscript: DataItem, deviceRequestInfo: DeviceRequestInfo? = null, version: String? = null)

A builder for DeviceRequest.

object Companion

Properties

deviceRequestInfo

val deviceRequestInfo: DeviceRequestInfo?

a DeviceRequestInfo or null.

val docRequests: List<DocRequest>

the document requests embedded in the request.

val readerAuthAll: List<CoseSign1>

the ReaderAuthAll for the device request or empty if ReaderAuthAll is not used.

val version: String

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

Functions

suspend fun execute(presentmentSource: PresentmentSource, keyAgreementPossible: List<EcCurve> = emptyList()): CredentialQueryResult

Executes the ISO 18013-5 request against a PresentmentSource.

getRequesterIdentities

fun getRequesterIdentities(): List<RequesterIdentity>

Get the list of identities used to sign this request, one for each signature.

fun toDataItem(): DataItem

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

fun toDcql(): JsonObject

Converts the credential query part of a ISO/IEC 18013-5 DeviceRequest to a DCQL query.

verifyReaderAuthentication

suspend fun verifyReaderAuthentication(sessionTranscript: DataItem)

Verifies reader authentication.