ResultData

STATUS_NOT_IN_REQUEST_MESSAGE

public static final int STATUS_NOT_IN_REQUEST_MESSAGE

The entry wasn't in the request message.

Constant Value: 3 (0x00000003)

STATUS_NOT_REQUESTED

public static final int STATUS_NOT_REQUESTED

The entry was not requested.

Constant Value: 2 (0x00000002)

STATUS_NO_ACCESS_CONTROL_PROFILES

public static final int STATUS_NO_ACCESS_CONTROL_PROFILES

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

Constant Value: 6 (0x00000006)

STATUS_NO_SUCH_ENTRY

public static final int STATUS_NO_SUCH_ENTRY

The entry does not exist.

Constant Value: 1 (0x00000001)

STATUS_OK

public static final int STATUS_OK

Value was successfully retrieved.

Constant Value: 0 (0x00000000)

STATUS_READER_AUTHENTICATION_FAILED

public static final int STATUS_READER_AUTHENTICATION_FAILED

The entry was not retrieved because reader authentication failed.

Constant Value: 5 (0x00000005)

STATUS_USER_AUTHENTICATION_FAILED

public static final int STATUS_USER_AUTHENTICATION_FAILED

The entry was not retrieved because user authentication failed.

Constant Value: 4 (0x00000004)

getAuthenticatedData

public abstract byte[] getAuthenticatedData ()

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.

getEntry

public abstract byte[] getEntry (String namespaceName, 
                String name)

Gets the raw CBOR data for the value of an entry.

This should only be called on an entry for which the getStatus(java.lang.String, java.lang.String) method returns STATUS_OK.

getEntryNames

public abstract Collection<String> getEntryNames (String namespaceName)

Get the names of all entries.

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

getMessageAuthenticationCode

public abstract byte[] getMessageAuthenticationCode ()

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 IdentityCredential.getEntries(byte[], Map, byte[], byte[]) was null or the reader ephmeral public key was never set using IdentityCredential.setReaderEphemeralPublicKey(PublicKey), no message authencation code will be produced and this method will return null.

getNamespaces

public abstract Collection<String> getNamespaces ()

Gets the names of namespaces with retrieved entries.

getRetrievedEntryNames

public abstract Collection<String> getRetrievedEntryNames (String namespaceName)

Get the names of all entries that was successfully retrieved.

This only return entries for which getStatus(java.lang.String, java.lang.String) will return STATUS_OK.

getStaticAuthenticationData

public abstract byte[] getStaticAuthenticationData ()

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

getStatus

public abstract int getStatus (String namespaceName, 
                String name)

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.