openid-data-classes/at.asitplus.iso

Package-level declarations

Types

@Serializable

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

Part of the ISO/IEC 18013-5:2026 standard: Additional document request info (10.2.4)

CborCredentialSerializer

object CborCredentialSerializer

DeviceAuth

@Serializable

data class DeviceAuth(val deviceSignature: CoseSigned<ByteArray>? = null, val deviceMac: CoseMac<ByteArray>? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for mdoc request (8.3.2.1.2.1)

DeviceAuthentication

@Serializable

data class DeviceAuthentication(val type: String, val sessionTranscript: SessionTranscript, val docType: String, val namespaces: ByteStringWrapper<DeviceNameSpaces>)

Part of the ISO/IEC 18013-5:2021 standard: mdoc authentication (9.1.3.4).

DeviceKeyInfo

@Serializable

data class DeviceKeyInfo(val deviceKey: CoseKey, val keyAuthorizations: KeyAuthorization? = null, val keyInfo: Map<Int, String>? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for MSO (9.1.2.4)

DeviceNameSpaces

@Serializable(with = NamespacedDeviceNameSpacesSerializer::class)

data class DeviceNameSpaces(val entries: Map<String, DeviceSignedItemList>)

Convenience class to prevent usage of the type ByteStringWrapper<Map<String, Map<String, Any>>> in DeviceSigned.namespaces.

DeviceRequest

@Serializable

data class DeviceRequest(val parsedVersion: Version, val docRequests: Array<DocRequest>, val deviceRequestInfo: ByteStringWrapper<DeviceRequestInfo>? = null, val readerAuthAll: Array<CoseSigned<ByteArray>>? = null)

Part of the ISO/IEC 18013-5:2026 standard: Mdoc request (10.2)

DeviceRequestBase64UrlSerializer

object DeviceRequestBase64UrlSerializer : TransformingSerializerTemplate<DeviceRequest, String>

DeviceRequestInfo

@Serializable

data class DeviceRequestInfo(val useCases: List<UseCase>? = null)

Part of the ISO/IEC 18013-5:2026 standard: Additional device request info (10.2.5)

DeviceResponse

@Serializable

data class DeviceResponse(val parsedVersion: Version, val documents: Array<Document>? = null, val zkDocuments: Array<ZkDocument>? = null, val encryptedDocuments: Array<EncryptedDocuments>? = null, val documentErrors: Array<Map<String, Int>>? = null, val status: UInt)

Part of the ISO/IEC 18013-5:2026 standard: Mdoc response (10.3)

DeviceSigned

@Serializable

data class DeviceSigned(val namespaces: ByteStringWrapper<DeviceNameSpaces>, val deviceAuth: DeviceAuth)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for mdoc request (8.3.2.1.2.1)

DeviceSignedItem

data class DeviceSignedItem(val key: String, val value: Any)

Convenience class (getting serialized in DeviceSignedItemListSerializer) to prevent usage of the type List<Map<String, Any>> in DeviceSignedItemList.entries.

DeviceSignedItemList

data class DeviceSignedItemList(val entries: List<DeviceSignedItem>)

Convenience class with a custom serializer (DeviceSignedItemListSerializer) to prevent usage of the type Map<String, Map<String, Any>> in DeviceNameSpaces.entries.

DeviceSignedItemListSerializer

open class DeviceSignedItemListSerializer(namespace: String) : KSerializer<DeviceSignedItemList>

Serializes DeviceSignedItemList.entries as an "inline map", having serialized instances of DeviceSignedItem as the values.

DocRequest

@Serializable

data class DocRequest(val itemsRequest: ByteStringWrapper<ItemsRequest>, val readerAuth: CoseSigned<ByteArray>? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for mdoc request (8.3.2.1.2.1)

DocRequestInfo

@Serializable

data class DocRequestInfo(val alternativeDataElements: List<AlternativeDataElementsSet>? = null, val issuerIdentifiers: List<ByteArray>? = null, val uniqueDocSetRequired: Boolean? = null, val maximumResponseSize: UInt? = null, val zkRequest: ZkRequest? = null, val docResponseEncryption: EncryptionParameters? = null, val euWrprc: ByteArray? = null, val euWrpRegistrarInfo: WrpRegistrarInfo? = null)

Part of the ISO/IEC 18013-5:2026 standard: Additional document request info (10.2.4)

Document

@Serializable

data class Document(val docType: String, val issuerSigned: IssuerSigned, val deviceSigned: DeviceSigned, val errors: Map<String, Map<String, Int>>? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for mdoc request (8.3.2.1.2.1)

ElementReference

@Serializable

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

Part of the ISO/IEC 18013-5:2026 standard: Additional document request info (10.2.4)

EncryptedDocuments

@Serializable

data class EncryptedDocuments(val enc: ByteArray, val cipherText: ByteArray, val docRequestId: UInt)

Part of the ISO/IEC 18013-5:2026 standard: Document response encryption (10.3.5)

EncryptedDocumentsPlaintext

@Serializable

data class EncryptedDocumentsPlaintext(val documents: Array<Document>? = null, val zkDocuments: Array<ZkDocument>? = null)

Part of the ISO/IEC 18013-5:2026 standard: Document response encryption (10.3.5)

EncryptionInfo

@Serializable

data class EncryptionInfo(val type: String, val encryptionParameters: EncryptionParameters)

Part of ISO 18013-7 Annex C

EncryptionInfoBase64UrlSerializer

object EncryptionInfoBase64UrlSerializer : TransformingSerializerTemplate<EncryptionInfo, String>

EncryptionParameters

@Serializable

data class EncryptionParameters(val nonce: ByteArray? = null, val recipientPublicKey: CoseKey, val recipientCertificate: List<ByteArray>? = null)

Part of the ISO/IEC 18013-5:2026 standard: Additional document request info (10.2.4)

IsoDigestSerializer

object IsoDigestSerializer : KSerializer<Digest>

Part of the ISO/IEC 18013-5:2021 standard: Message digest function (9.1.2.5)

IsoVersionSerializer

object IsoVersionSerializer : KSerializer<Version>

For Version, but skips patch, i.e. serializes 1.1 instead of 1.1.0

IssuerSigned

@Serializable

data class IssuerSigned

Part of the ISO/IEC 18013-5:2021 standard: Data structure for mdoc request (8.3.2.1.2.1)

IssuerSignedItem

data class IssuerSignedItem(val digestId: UInt, val random: ByteArray, val elementIdentifier: String, val elementValue: Any) : Item

Part of the ISO/IEC 18013-5:2021 standard: Data structure for mdoc request (8.3.2.1.2.1)

IssuerSignedItemSerializer

open class IssuerSignedItemSerializer(namespace: String, elementIdentifier: String) : KSerializer<IssuerSignedItem>

IssuerSignedList

data class IssuerSignedList(val entries: List<ByteStringWrapper<IssuerSignedItem>>)

Convenience class with a custom serializer (IssuerSignedListSerializer) to prevent usage of the type Map<String, List<ByteStringWrapper<IssuerSignedItem>>> in IssuerSigned.namespaces.

IssuerSignedListSerializer

open class IssuerSignedListSerializer(namespace: String) : KSerializer<IssuerSignedList>

Serializes IssuerSignedList.entries as an "inline list", having serialized instances of IssuerSignedItem as the values.

Item

interface Item

ItemsRequest

@Serializable

data class ItemsRequest(val docType: String, val namespaces: Map<String, ItemsRequestList>, val requestInfo: DocRequestInfo? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for mdoc request (8.3.2.1.2.1)

ItemsRequestList

@Serializable(with = ItemsRequestListSerializer::class)

data class ItemsRequestList(val entries: List<SingleItemsRequest>)

Convenience class with a custom serializer (ItemsRequestListSerializer) to prevent usage of the type Map<String, Map<String, Boolean>> in ItemsRequest.namespaces.

ItemsRequestListSerializer

object ItemsRequestListSerializer : KSerializer<ItemsRequestList>

Serializes ItemsRequestList.entries as an "inline map", having SingleItemsRequest.dataElementIdentifier as the map key and SingleItemsRequest.intentToRetain as the map value, for the map represented by ItemsRequestList.

KeyAuthorization

@Serializable

data class KeyAuthorization(val namespaces: Array<String>? = null, val dataElements: Map<String, Array<String>>? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for MSO (9.1.2.4)

MobileSecurityObject

@Serializable

data class MobileSecurityObject(val parsedVersion: Version, val digest: Digest, val valueDigests: Map<String, ValueDigestList>, val deviceKeyInfo: DeviceKeyInfo, val docType: String, val validityInfo: ValidityInfo, val status: RevocationListInfo? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for MSO (9.1.2.4)

NamespacedDeviceNameSpacesSerializer

object NamespacedDeviceNameSpacesSerializer : KSerializer<DeviceNameSpaces>

NamespacedIssuerSignedListSerializer

object NamespacedIssuerSignedListSerializer : KSerializer<Map<String, IssuerSignedList>>

NamespacedZkSignedListSerializer

object NamespacedZkSignedListSerializer : KSerializer<Map<String, ZkSignedList>>

NormalizedX509Serializer

object NormalizedX509Serializer : KSerializer<List<ByteArray>>

Custom serializer for a certificate chain (List<ByteArray>).

OpenId4VpHandover

@Serializable

data class OpenId4VpHandover(val type: String, val hash: ByteArray)

Part of OpenID for Verifiable Presentations 1.0 B.2.6.1

OpenId4VpHandoverInfo

@Serializable

data class OpenId4VpHandoverInfo(val clientId: String?, val nonce: String, val jwkThumbprint: ByteArray?, val responseUrl: String)

Part of OpenID for Verifiable Presentations 1.0 B.2.6.1

ReaderAuthentication

@Serializable

data class ReaderAuthentication(val type: String, val sessionTranscript: SessionTranscript, val itemsRequestBytes: ByteArray)

The detached content signed by a single DocRequest.readerAuth (ISO/IEC 18013-5, 12.5).

ReaderAuthenticationAll

@Serializable(with = ReaderAuthenticationAllSerializer::class)

data class ReaderAuthenticationAll(val type: String, val sessionTranscript: SessionTranscript, val itemsRequestBytesAll: TaggedCborBytesList, val deviceRequestInfoBytes: ByteArray?)

The detached content signed by DeviceRequest.readerAuthAll (ISO/IEC 18013-5, 12.5). deviceRequestInfoBytes is DeviceRequestInfoBytes / null, so only a present value is tagged, see ReaderAuthenticationAllSerializer.

ReaderAuthenticationAllSerializer

object ReaderAuthenticationAllSerializer : KSerializer<ReaderAuthenticationAll>

Encodes a present deviceRequestInfoBytes as a tag-24 byte string and an absent one as plain null. A @ValueTags annotation on a nullable property would tag null as well, i.e. #6.24(null). Decoding reads the untagged shape, as tag 24 is only verified when the descriptor declares it.

ServerItemsRequest

@Serializable

data class ServerItemsRequest(val docType: String, val namespaces: Map<String, Map<String, Boolean>>, val requestInfo: Map<String, String>? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for Server retrieval mdoc request (8.3.2.2.2.1)

ServerRequest

@Serializable

data class ServerRequest(val version: String, val token: String, val docRequests: Array<ServerItemsRequest>)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for Server retrieval mdoc request (8.3.2.2.2.1)

ServerResponse

@Serializable

data class ServerResponse(val version: String, val documentsJws: Array<@Serializable(with = JwsCompactStringSerializer::class) JwsCompact>, val documentErrors: Map<String, Int>? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for Server retrieval mdoc response (8.3.2.2.2.2)

SessionTranscript

@Serializable

data class SessionTranscript

Part of the ISO/IEC 18013-5:2021 standard: Session transcript and cipher suite (9.1.5.1) and ISO/IEC 18013-7:2024 standard: Session Transcript (B.4.4) Must be used with encodeDefaults = false

SingleItemsRequest

data class SingleItemsRequest(val dataElementIdentifier: String, val intentToRetain: Boolean)

Convenience class with a custom serializer (ItemsRequestListSerializer) to prevent usage of the type Map<String, Map<String, Boolean>> in ItemsRequest.namespaces.

TaggedCborBytesList

@Serializable(with = TaggedCborBytesListSerializer::class)

data class TaggedCborBytesList(val values: List<ByteArray>)

TaggedCborBytesListSerializer

object TaggedCborBytesListSerializer : KSerializer<TaggedCborBytesList>

Encodes each original CBOR byte string as a tag-24 byte string, without re-encoding its contents.

UseCase

@Serializable

data class UseCase(val mandatory: Boolean, val documentSets: List<List<UInt>>, val purposeHints: Map<String, Int>? = null)

Part of the ISO/IEC 18013-5:2026 standard: Additional device request info (10.2.5)

ValidityInfo

@Serializable

data class ValidityInfo(val signed: Instant, val validFrom: Instant, val validUntil: Instant, val expectedUpdate: Instant? = null)

Part of the ISO/IEC 18013-5:2021 standard: Data structure for MSO (9.1.2.4)

ValueDigest

data class ValueDigest(val key: UInt, val value: ByteArray)

Convenience class with a custom serializer (ValueDigestListSerializer) to prevent usage of the type Map<String, Map<UInt, ByteArray>> in MobileSecurityObject.valueDigests.

ValueDigestList

@Serializable(with = ValueDigestListSerializer::class)

data class ValueDigestList(val entries: List<ValueDigest>)

Convenience class with a custom serializer (ValueDigestListSerializer) to prevent usage of the type Map<String, Map<UInt, ByteArray>> in MobileSecurityObject.valueDigests.

ValueDigestListSerializer

object ValueDigestListSerializer : KSerializer<ValueDigestList>

Serialized the ValueDigestList.entries as an "inline map", meaning ValueDigest.key is the map key and ValueDigest.value the map value, for the map represented by ValueDigestList

ZkDocument

@Serializable

data class ZkDocument(val zkDocumentDataBytes: ByteStringWrapper<ZkDocumentData>, val proof: ByteArray)

Part of the ISO/IEC 18013-5:2026 standard: ZKP Mdoc response (10.3.4)

ZkDocumentData

@Serializable

data class ZkDocumentData(val docType: String, val zkSystemId: String, val timestamp: Instant, val issuerSigned: Map<String, ZkSignedList>? = null, val deviceSigned: Map<String, ZkSignedList>? = null, val certificateChain: List<ByteArray>? = null)

Part of the ISO/IEC 18013-5:2026 standard: ZKP Mdoc response (10.3.4)

ZkDocumentDataWrapperSerializer

object ZkDocumentDataWrapperSerializer : KSerializer<ByteStringWrapper<ZkDocumentData>>

Custom serializer wrapper for ZkDocumentData that bridges a limitation in kotlinx.serialization regarding RFC 9360, Section 2 polymorphism.

ZkRequest

@Serializable

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

Part of the ISO/IEC 18013-5:2026 standard: ZKP Mdoc request (10.2.4)

ZkSignedItem

data class ZkSignedItem(val elementIdentifier: String, val elementValue: Any) : Item

ZkSignedItemSerializer

open class ZkSignedItemSerializer(namespace: String) : KSerializer<ZkSignedItem>

ZkSignedList

data class ZkSignedList(val entries: List<ZkSignedItem>)

ZkSignedListSerializer

class ZkSignedListSerializer(namespace: String) : KSerializer<ZkSignedList>

ZkSystemParamRegistry

object ZkSystemParamRegistry

Each Zk system should register serializers for its param keys to allow ZkSystemSpec.params to be properly deserialized into a Map

ZkSystemSpec

@Serializable(with = ZkSystemSpecSerializer::class)

data class ZkSystemSpec(val id: String, val system: String, val params: Map<String, Any>)

Represents a configuration and metadata abstraction for a Zero-Knowledge proving system used in ISO mDoc presentation requests.

ZkSystemSpecSerializer

object ZkSystemSpecSerializer : KSerializer<ZkSystemSpec>

Functions

serializeOrigin

fun String.serializeOrigin(): String?

Serializes an authority-based origin string as defined in https://html.spec.whatwg.org/multipage/browsers.html#ascii-serialisation-of-an-origin. Opaque origins, such as Android application origins, cannot be serialized this way.

sha256

fun ByteArray.sha256(): ByteArray

stripCborTag

fun ByteArray.stripCborTag(tag: Byte): ByteArray

toDigest

fun String.toDigest(): Digest

Part of the ISO/IEC 18013-5:2021 standard: Message digest function (9.1.2.5)

toIsoString

fun Digest.toIsoString(): String

Part of the ISO/IEC 18013-5:2021 standard: Message digest function (9.1.2.5)

fun Version.toIsoString(): String

Skips patch if it is 0, i.e. serializes 1.1 instead of 1.1.0

wrapInCborTag

fun ByteArray.wrapInCborTag(tag: Byte): ByteArray