Package com.android.identity

Class CredentialDataRequest

java.lang.Object

com.android.identity.CredentialDataRequest

public final class CredentialDataRequest
extends java.lang.Object

An object representing a request for credential data.

This is used in PresentationSession.getCredentialData(String, CredentialDataRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CredentialDataRequest.Builder	A builder for CredentialDataRequest.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getDeviceSignedEntriesToRequest()	Gets the device-signed entries to request.
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getIssuerSignedEntriesToRequest()	Gets the issuer-signed entries to request.
byte[]	getReaderSignature()	Gets the reader signature.
byte[]	getRequestMessage()	Gets the request message CBOR.
boolean	isAllowUsingExhaustedKeys()	Gets whether to allow using an authentication key which use count has been exceeded.
boolean	isAllowUsingExpiredKeys()	Gets whether to allow using an authentication key which is expired.
boolean	isIncrementUseCount()	Gets whether to increment the use-count for the authentication key used.

Methods inherited from class java.lang.Object

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

Method Detail

getDeviceSignedEntriesToRequest

@NonNull
public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getDeviceSignedEntriesToRequest()

Gets the device-signed entries to request.

Returns:

the device-signed entries to request.

getIssuerSignedEntriesToRequest

@NonNull
public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getIssuerSignedEntriesToRequest()

Gets the issuer-signed entries to request.

Returns:

the issuer-signed entries to request.

isAllowUsingExhaustedKeys

public boolean isAllowUsingExhaustedKeys()

Gets whether to allow using an authentication key which use count has been exceeded.

By default this is set to true.

Returns:

whether to allow using an authentication key which use count has been exceeded if no other key is available.

isAllowUsingExpiredKeys

public boolean isAllowUsingExpiredKeys()

Gets whether to allow using an authentication key which is expired.

By default this is set to false.

Returns:

whether to allow using an authentication key which is expired if no other key is available.

isIncrementUseCount

public boolean isIncrementUseCount()

Gets whether to increment the use-count for the authentication key used.

By default this is set to true.

Returns:

whether to increment the user count of the authentication key used.

getRequestMessage

@Nullable
public byte[] getRequestMessage()

Gets the request message CBOR.

This data structure is described in the documentation for the PresentationSession.getCredentialData(String, CredentialDataRequest) method.

Returns:

the request message CBOR as described above.

getReaderSignature

@Nullable
public byte[] getReaderSignature()

Gets the reader signature.

This data structure is described in the documentation for the PresentationSession.getCredentialData(String, CredentialDataRequest) method.

Returns:

a COSE_Sign1 structure as described above.