MultipazProject

wallet/org.multipaz.android.direct_access/DirectAccess

DirectAccess

@RequiresApi(value = 28)

object DirectAccess

A class which handles common operations related to the DirectAccess applet.

Properties

isDirectAccessSupported

val isDirectAccessSupported: Boolean

Returns true if direct access is supported on the device, false otherwise.

maximumCredentialSize

val maximumCredentialSize: Long

Returns the maximum size, in bytes, of credentialData which can be used in credentials.

val transport: DirectAccessOmapiTransport

Functions

allocateDocumentSlot

fun allocateDocumentSlot(docType: String): Int

Allocates space (a slot) in the Direct Access applet for a document to be provisioned to.

certifyCredential

fun certifyCredential(documentSlot: Int, credentialData: ByteArray, encryptedPresentationData: ByteArray): ByteArray

Certifies the credential with the given encryptedPresentationData and returns the updated encryptedPresentationData.

clearCredentialUsageCount

fun clearCredentialUsageCount(documentSlot: Int)

Resets the usage count of the credential in the slot to 0.

clearDocumentSlot

fun clearDocumentSlot(documentSlot: Int): Boolean

Clears a slot.

createCredential

fun createCredential(documentSlot: Int): Pair<X509CertChain, ByteArray>

Creates a credential at the given slot.

enumerateAllocatedSlots

fun enumerateAllocatedSlots(): List<Int>

Enumerates slots which have already been allocated.

getCredentialUsageCount

fun getCredentialUsageCount(documentSlot: Int): Int

Returns the number of times the credential in the slot has been used in a presentation since it was set as the active credential or since the usage count was reset with clearCredentialUsageCount.

setActiveCredential

fun setActiveCredential(documentSlot: Int, encryptedPresentationData: ByteArray?)

Sets the credential represented by the encryptedPresentationData as the active credential in the slot (ie. it would be the one used during presentation). If encryptedPresentationData is null, clears active credential.

warmupTransport

fun warmupTransport()

Use this function to ensure the transport is initialized (since Kotlin singletons are initialized on first access) so that the app can begin connecting to the applet in the background.