Package com.android.identity

Class DeviceResponseParser

java.lang.Object

com.android.identity.DeviceResponseParser

public final class DeviceResponseParser
extends java.lang.Object

Helper class for parsing the bytes of DeviceResponse CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviceResponseParser.DeviceResponse	An object used to represent data parsed from DeviceResponse CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
static class	DeviceResponseParser.Document	An object used to represent data parsed from the Document CBOR (part of DeviceResponse) as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.

Constructor Summary

Constructors

Constructor	Description
DeviceResponseParser()	Constructs a DeviceResponseParser.

Method Summary

Modifier and Type	Method	Description
DeviceResponseParser.DeviceResponse	parse()	Parses the device response.
DeviceResponseParser	setDeviceResponse(byte[] encodedDeviceResponse)	Sets the bytes of the DeviceResponse CBOR.
DeviceResponseParser	setEphemeralReaderKey(java.security.PrivateKey eReaderKey)	Sets the private part of the ephemeral key used in the session where the DeviceResponse was obtained.
DeviceResponseParser	setSessionTranscript(byte[] encodedSessionTranscript)	Sets the bytes of the SessionTranscript CBOR.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceResponseParser

public DeviceResponseParser()

Constructs a DeviceResponseParser.

Method Detail

setDeviceResponse

@NonNull
public DeviceResponseParser setDeviceResponse(@NonNull
                                              byte[] encodedDeviceResponse)

Sets the bytes of the DeviceResponse CBOR.

Parameters:

encodedDeviceResponse - the bytes of DeviceResponse.

Returns:

the DeviceResponseParser.

setSessionTranscript

@NonNull
public DeviceResponseParser setSessionTranscript(@NonNull
                                                 byte[] encodedSessionTranscript)

Sets the bytes of the SessionTranscript CBOR.

Parameters:

encodedSessionTranscript - the bytes of SessionTranscript.

Returns:

the DeviceResponseParser.

setEphemeralReaderKey

@NonNull
public DeviceResponseParser setEphemeralReaderKey(@NonNull
                                                  java.security.PrivateKey eReaderKey)

Sets the private part of the ephemeral key used in the session where the DeviceResponse was obtained.

This is only required if the DeviceResponse is using the MAC method for device authentication.

Parameters:

eReaderKey - the private part of the reader ephemeral key.

Returns:

the DeviceResponseParser.

parse

@NonNull
public DeviceResponseParser.DeviceResponse parse()

Parses the device response.

It's mandatory to call setDeviceResponse(byte[]), setSessionTranscript(byte[]) before this call. If the response is using MAC for device authentication, setEphemeralReaderKey(PrivateKey) must also have been called.

This parser will successfully parse responses where issuer-signed data elements fails the digest check against the MSO, where DeviceSigned authentication checks fail, and where IssuerSigned authentication checks fail. The methods DeviceResponseParser.Document.getIssuerEntryDigestMatch(String, String), DeviceResponseParser.Document.getDeviceSignedAuthenticated(), and DeviceResponseParser.Document.getIssuerSignedAuthenticated() can be used to get additional information about this.

Returns:

a DeviceResponseParser.DeviceResponse with the parsed data.

Throws:

java.lang.IllegalArgumentException - if the given data isn't valid CBOR or not conforming to the CDDL for its type.

java.lang.IllegalStateException - if required data hasn't been set using the setter methods on this class.