ResultData

const val STATUS_NOT_IN_REQUEST_MESSAGE = 3: Int

Requested entry wasn't in the request message.

const val STATUS_NOT_REQUESTED = 2: Int

Requested entry was not requested.

const val STATUS_NO_ACCESS_CONTROL_PROFILES = 6: Int

The requested entry was not retrieved because it was configured without any access control profile.

const val STATUS_NO_SUCH_ENTRY = 1: Int

Requested entry does not exist.

const val STATUS_OK = 0: Int

Value was successfully retrieved.

const val STATUS_READER_AUTHENTICATION_FAILED = 5: Int

The requested entry was not retrieved because reader authentication wasn't performed.

const val STATUS_USER_AUTHENTICATION_FAILED = 4: Int

The requested entry was not retrieved because user authentication wasn't performed.

abstract fun getAuthenticatedData(): ByteArray<Byte>

Returns a CBOR structure containing the retrieved data.

This structure - along with the session transcript - may be cryptographically authenticated to prove to the reader that the data is from a trusted credential and getMessageAuthenticationCode can be used to get a MAC.

The CBOR structure which is cryptographically authenticated is the DeviceAuthenticationBytes structure according to the following CDDL schema:

  DeviceAuthentication = [
    "DeviceAuthentication",
    SessionTranscript,
    DocType,
    DeviceNameSpacesBytes
  ]

  DocType = tstr
  SessionTranscript = any
  DeviceNameSpacesBytes = #6.24(bstr .cbor DeviceNameSpaces)
  DeviceAuthenticationBytes = #6.24(bstr .cbor DeviceAuthentication)

where

  DeviceNameSpaces = {
    * NameSpace => DeviceSignedItems
  }

  DeviceSignedItems = {
    + DataItemName => DataItemValue
  }

  NameSpace = tstr
  DataItemName = tstr
  DataItemValue = any

The returned data is the binary encoding of the DeviceNameSpaces structure as defined above.

abstract fun getEcdsaSignature(): ByteArray<Byte>?

Returns a digital signature over the DeviceAuthenticationBytes CBOR specified in getAuthenticatedData, to prove to the reader that the data is from a trusted credential. The signature will be made with one of the provisioned dynamic authentication keys. At most one of getMessageAuthenticationCode or getEcdsaSignature is implemented.

abstract fun getEntry(namespaceName: String, name: String): ByteArray<Byte>?

Gets the raw CBOR data for the value of an entry. This should only be called on an entry for which the getStatus method returns STATUS_OK.

fun getEntryBoolean(namespaceName: String, name: String): Boolean

Gets the value of an entry. This should only be called on an entry for which the getStatus method returns STATUS_OK.

fun getEntryBytestring(namespaceName: String, name: String): ByteArray<Byte>?

Gets the value of an entry. This should only be called on an entry for which the getStatus method returns STATUS_OK.

fun getEntryCalendar(namespaceName: String, name: String): Calendar?

Gets the value of an entry. This should only be called on an entry for which the getStatus method returns STATUS_OK.

fun getEntryInteger(namespaceName: String, name: String): Long

Gets the value of an entry. This should only be called on an entry for which the getStatus method returns STATUS_OK.

abstract fun getEntryNames(namespaceName: String): (Mutable)Collection<String!>?

Get the names of all entries. This includes the name of entries that wasn't successfully retrieved.

fun getEntryString(namespaceName: String, name: String): String?

Gets the value of an entry. This should only be called on an entry for which the getStatus method returns STATUS_OK.

abstract fun getMessageAuthenticationCode(): ByteArray<Byte>?

Returns a message authentication code over the DeviceAuthenticationBytes CBOR specified in getAuthenticatedData, to prove to the reader that the data is from a trusted credential.

The MAC proves to the reader that the data is from a trusted credential. This code is produced by using the key agreement and key derivation function from the ciphersuite with the authentication private key and the reader ephemeral public key to compute a shared message authentication code (MAC) key, then using the MAC function from the ciphersuite to compute a MAC of the authenticated data. See section 9.2.3.5 of ISO/IEC 18013-5 for details of this operation.

If the sessionTranscript parameter passed to getEntries was null or the reader ephmeral public key was never set using setReaderEphemeralPublicKey, no message authencation code will be produced and this method will return null. At most one of getMessageAuthenticationCode or getEcdsaSignature is implemented.

abstract fun getNamespaces(): (Mutable)Collection<String!>

Gets the names of namespaces with retrieved entries.

abstract fun getRetrievedEntryNames(namespaceName: String): (Mutable)Collection<String!>?

Get the names of all entries that was successfully retrieved. This only return entries for which getStatus will return STATUS_OK.

abstract fun getStaticAuthenticationData(): ByteArray<Byte>

Returns the static authentication data associated with the dynamic authentication key used to sign or MAC the data returned by getAuthenticatedData.

abstract fun getStatus(namespaceName: String, name: String): Int

Gets the status of an entry. This returns STATUS_OK if the value was retrieved, STATUS_NO_SUCH_ENTRY if the given entry wasn't retrieved, STATUS_NOT_REQUESTED if it wasn't requested, STATUS_NOT_IN_REQUEST_MESSAGE if the request message was set but the entry wasn't present in the request message, STATUS_USER_AUTHENTICATION_FAILED if the value wasn't retrieved because the necessary user authentication wasn't performed, STATUS_READER_AUTHENTICATION_FAILED if the supplied reader certificate chain didn't match the set of certificates the entry was provisioned with, or STATUS_NO_ACCESS_CONTROL_PROFILES if the entry was configured without any access control profiles.