BiometricPrompt.CryptoObject

CryptoObject(cipher: Cipher)

Creates a crypto object that wraps the given cipher object.

@RequiresApi(value = Build.VERSION_CODES.R)
CryptoObject(identityCredential: IdentityCredential)

Creates a crypto object that wraps the given identity credential object.

CryptoObject(mac: Mac)

Creates a crypto object that wraps the given MAC object.

@RequiresApi(value = Build.VERSION_CODES.VANILLA_ICE_CREAM)
CryptoObject(operationHandle: Long)

Create from an operation handle.

@RequiresApi(value = Build.VERSION_CODES.TIRAMISU)
CryptoObject(presentationSession: PresentationSession)

Creates a crypto object that wraps the given presentation session object.

CryptoObject(signature: Signature)

Creates a crypto object that wraps the given signature object.

fun getCipher(): Cipher?

Gets the cipher object associated with this crypto object.

@RequiresApi(value = Build.VERSION_CODES.R)
fun getIdentityCredential(): IdentityCredential?

Gets the identity credential object associated with this crypto object.

fun getMac(): Mac?

Gets the MAC object associated with this crypto object.

@RequiresApi(value = Build.VERSION_CODES.VANILLA_ICE_CREAM)
fun getOperationHandle(): Long

Returns the operationHandle associated with this object or 0 if none. The operationHandle is the underlying identifier associated with the CryptoObject.

The operationHandle can be used to reconstruct a CryptoObject instance. This is useful for any cross-process communication as the CryptoObject class is not android.os.Parcelable. Hence, if the CryptoObject is constructed in one process, and needs to be propagated to another process, before calling the authenticate() API in the second process, the recommendation is to retrieve the operationHandle using this API, and then reconstruct the CryptoObjectusing the constructor that takes in an operationHandle, and pass that in to the authenticate API mentioned above.

@RequiresApi(value = Build.VERSION_CODES.TIRAMISU)
fun getPresentationSession(): PresentationSession?

Gets the presentation session object associated with this crypto object.

fun getSignature(): Signature?

Gets the signature object associated with this crypto object.