Package com.android.identity

Interface Summary

Interface	Description
CredentialDataResult.Entries	A class for representing data elements returned.
DeviceRetrievalHelper.Listener	Interface for listening to messages from the remote verifier device.
NfcEngagementHelper.Listener
QrEngagementHelper.Listener
TransmissionProgressListener	A generic interface for sending progress updates of a data transmission.
VerificationHelper.Listener	Interface for listening to messages from the remote mdoc device.

Class Summary

Class	Description
AccessControlProfile	A class used to specify access controls.
AccessControlProfile.Builder	A builder for AccessControlProfile.
AccessControlProfileId	A class used to wrap an access control profile identifiers.
ConnectionMethod	A class representing the ConnectionMethod structure exchanged between mdoc and mdoc reader.
ConnectionMethodBle	Connection method for BLE.
ConnectionMethodHttp	Connection method for HTTP connections.
ConnectionMethodNfc	Connection method for NFC.
ConnectionMethodWifiAware	Connection method for Wifi Aware.
Constants	Various constants used by other classes.
CredentialDataRequest	An object representing a request for credential data.
CredentialDataRequest.Builder	A builder for CredentialDataRequest.
CredentialDataResult	An object that contains the result of retrieving data from a credential.
DataTransport	Abstraction for data transfer between prover and verifier devices.
DataTransportHttp	HTTP data transport.
DataTransportNfc	NFC data transport
DataTransportOptions	A set of options used when creating a DataTransport derived instance.
DataTransportOptions.Builder	A builder for DataTransportOptions.
DeviceRequestGenerator	Helper class for building DeviceRequest CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
DeviceRequestParser	Helper class for parsing the bytes of DeviceRequest CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
DeviceRequestParser.DeviceRequest	An object used to represent data parsed from DeviceRequest CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
DeviceRequestParser.DocumentRequest	An object used to represent data parsed from the DocRequest CBOR (part of DeviceRequest) as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
DeviceResponseGenerator	Helper class for building DeviceResponse CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
DeviceResponseParser	Helper class for parsing the bytes of DeviceResponse CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
DeviceResponseParser.DeviceResponse	An object used to represent data parsed from DeviceResponse CBOR as specified in ISO/IEC 18013-5 section 8.3 Device Retrieval.
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.
DeviceRetrievalHelper	Helper used for establishing engagement with, interacting with, and presenting credentials to a remote mdoc reader device.
DeviceRetrievalHelper.Builder	Builder for DeviceRetrievalHelper.
EngagementGenerator	Helper to generate DeviceEngagement or ReaderEngagement CBOR.
EngagementParser	Helper for parsing DeviceEngagement or ReaderEngagement CBOR.
HardwarePresentationSession
IdentityCredential	Class used to read data from a previously provisioned credential.
IdentityCredentialStore	An interface to a secure store for user identity documents.
Logger	Class used for logging.
MobileSecurityObjectGenerator	Helper class for building MobileSecurityObject CBOR as specified ISO/IEC 18013-5 section 9.1.2 Issuer data authentication.
MobileSecurityObjectParser	Helper class for parsing the bytes of MobileSecurityObject CBOR as specified in ISO/IEC 18013-5 section 9.1.2 Issuer data authentication.
MobileSecurityObjectParser.MobileSecurityObject	An object used to represent data parsed from MobileSecurityObject CBOR as specified in ISO/IEC 18013-5 section 9.1.2 Issuer data authentication
NfcEngagementHelper
NfcEngagementHelper.Builder
OriginInfo	A class representing the OriginInfo structure exchanged by the mdoc and the mdoc reader.
OriginInfoNfc
OriginInfoQr
OriginInfoWebsite
PersonalizationData	An object that holds personalization data.
PersonalizationData.Builder	A builder for PersonalizationData.
PlatformCredentialDataResult
PresentationSession	Class for presenting multiple documents to a remote verifier.
QrEngagementHelper
ResultData	Deprecated. Use PresentationSession instead.
Timestamp	Represents a single instant in time.
Utility	Miscellaneous utility functions that are useful when building mdoc applications.
VerificationHelper	Helper used for engaging with and receiving documents from a remote mdoc verifier device.
VerificationHelper.Builder	Builder for VerificationHelper.
WritableIdentityCredential	Class used to personalize a new identity credential.

Exception Summary

Exception	Description
AlreadyPersonalizedException	Thrown if trying to create a credential which already exists.
CipherSuiteNotSupportedException	Thrown if trying to use a cipher suite which isn't supported.
CredentialInvalidatedException	Thrown if underlying key material for a credential has been invalidated.
DocTypeNotSupportedException	Thrown if trying to create a credential with an unsupported document type.
EphemeralPublicKeyNotFoundException	Thrown if the ephemeral public key was not found in the session transcript passed to IdentityCredential.getEntries(byte[], Map, byte[]).
IdentityCredentialException	Base class for all Identity Credential exceptions.
InvalidReaderSignatureException	Thrown if the reader signature is invalid, or it doesn't contain a certificate chain, or if the signature failed to validate.
InvalidRequestMessageException	Thrown if message with the request doesn't satisfy the requirements documented in IdentityCredential.getEntries(byte[], Map, byte[]).
MessageDecryptionException	Thrown when failing to decrypt a message from the reader device.
NoAuthenticationKeyAvailableException	Thrown if no dynamic authentication keys are available.
UnknownAuthenticationKeyException	Thrown if trying to certify an unknown dynamic authentication key.