BiometricPrompt.CryptoObject

Added in 1.0.0

Kotlin |Java

class BiometricPrompt.CryptoObject

A wrapper class for the crypto objects supported by BiometricPrompt.

Summary

Public constructors
`CryptoObject(cipher: Cipher)` Creates a crypto object that wraps the given cipher object.
`@RequiresApi(value = Build.VERSION_CODES.R) CryptoObject(identityCredential: IdentityCredential)` This function is deprecated. Use `CryptoObject` instead.
`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.

Public functions
`Cipher?`	`getCipher()` Gets the cipher object associated with this crypto object.
`IdentityCredential?`	`@RequiresApi(value = Build.VERSION_CODES.R) getIdentityCredential()` This function is deprecated. Use `PresentationSession` instead of `IdentityCredential`.
`Mac?`	`getMac()` Gets the MAC object associated with this crypto object.
`Long`	`@RequiresApi(value = Build.VERSION_CODES.VANILLA_ICE_CREAM) getOperationHandle()` Returns the `operationHandle` associated with this object or 0 if none.
`PresentationSession?`	`@RequiresApi(value = Build.VERSION_CODES.TIRAMISU) getPresentationSession()` Gets the presentation session object associated with this crypto object.
`Signature?`	`getSignature()` Gets the signature object associated with this crypto object.

Public constructors

CryptoObject

Added in 1.0.0

CryptoObject(cipher: Cipher)

Creates a crypto object that wraps the given cipher object.

Parameters
`cipher: Cipher`	The cipher to be associated with this crypto object.

CryptoObject

Added in 1.1.0

Deprecated in 1.4.0-alpha04

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

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

Parameters
`identityCredential: IdentityCredential`	The identity credential to be associated with this crypto object.

CryptoObject

Added in 1.0.0

CryptoObject(mac: Mac)

Creates a crypto object that wraps the given MAC object.

Parameters
`mac: Mac`	The MAC to be associated with this crypto object.

CryptoObject

Added in 1.4.0-alpha04

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

Create from an operation handle.

Parameters
`operationHandle: Long`	the operation handle associated with this object.

See also
`getOperationHandle`

CryptoObject

Added in 1.4.0-alpha04

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

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

Parameters
`presentationSession: PresentationSession`	The presentation session to be associated with this crypto object.

CryptoObject

Added in 1.0.0

CryptoObject(signature: Signature)

Creates a crypto object that wraps the given signature object.

Parameters
`signature: Signature`	The signature to be associated with this crypto object.

Public functions

getCipher

Added in 1.0.0

fun getCipher(): Cipher?

Gets the cipher object associated with this crypto object.

Returns
`Cipher?`	The cipher, or `null` if none is associated with this object.

getIdentityCredential

Added in 1.1.0

Deprecated in 1.4.0-alpha04

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

Gets the identity credential object associated with this crypto object.

Returns
`IdentityCredential?`	The identity credential, or `null` if none is associated with this object.

getMac

Added in 1.0.0

fun getMac(): Mac?

Gets the MAC object associated with this crypto object.

Returns
`Mac?`	The MAC, or `null` if none is associated with this object.

getOperationHandle

Added in 1.4.0-alpha04

@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.

getPresentationSession

Added in 1.4.0-alpha04

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

Gets the presentation session object associated with this crypto object.

Returns
`PresentationSession?`	The presentation session, or `null` if none is associated with this object.

getSignature

Added in 1.0.0

fun getSignature(): Signature?

Gets the signature object associated with this crypto object.

Returns
`Signature?`	The signature, or `null` if none is associated with this object.