CredentialDataRequest


public class CredentialDataRequest
extends Object

java.lang.Object
   ↳ android.security.identity.CredentialDataRequest


An object representing a request for credential data.

Summary

Nested classes

class CredentialDataRequest.Builder

A builder for CredentialDataRequest

Public methods

Map<StringCollection<String>> getDeviceSignedEntriesToRequest()

Gets the device-signed entries to request.

Map<StringCollection<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.

Inherited methods

Public methods

getDeviceSignedEntriesToRequest

Added in API level 33
public Map<StringCollection<String>> getDeviceSignedEntriesToRequest ()

Gets the device-signed entries to request.

Returns
Map<StringCollection<String>> the device-signed entries to request. This value cannot be null.

getIssuerSignedEntriesToRequest

Added in API level 33
public Map<StringCollection<String>> getIssuerSignedEntriesToRequest ()

Gets the issuer-signed entries to request.

Returns
Map<StringCollection<String>> the issuer-signed entries to request. This value cannot be null.

getReaderSignature

Added in API level 33
public byte[] getReaderSignature ()

Gets the reader signature.

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

Returns
byte[] a COSE_Sign1 structure as described above. This value may be null.

getRequestMessage

Added in API level 33
public byte[] getRequestMessage ()

Gets the request message CBOR.

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

Returns
byte[] the request message CBOR as described above. This value may be null.

isAllowUsingExhaustedKeys

Added in API level 33
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
boolean whether to allow using an authentication key which use count has been exceeded if no other key is available.

isAllowUsingExpiredKeys

Added in API level 33
public boolean isAllowUsingExpiredKeys ()

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

By default this is set to false.

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

isIncrementUseCount

Added in API level 33
public boolean isIncrementUseCount ()

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

By default this is set to true.

Returns
boolean whether to increment the use count of the authentication key used.