BiometricPrompt.CryptoObject

Added in 1.0.0

Kotlin |Java

public class BiometricPrompt.CryptoObject

A wrapper class for the crypto objects supported by BiometricPrompt.

Summary

Public constructors
`CryptoObject(@NonNull Cipher cipher)` Creates a crypto object that wraps the given cipher object.
`@RequiresApi(value = Build.VERSION_CODES.R) CryptoObject(@NonNull IdentityCredential identityCredential)` Creates a crypto object that wraps the given identity credential object.
`CryptoObject(@NonNull Mac mac)` Creates a crypto object that wraps the given MAC object.
`@RequiresApi(value = Build.VERSION_CODES.VANILLA_ICE_CREAM) CryptoObject(long operationHandle)` Create from an operation handle.
`@RequiresApi(value = Build.VERSION_CODES.TIRAMISU) CryptoObject(@NonNull PresentationSession presentationSession)` Creates a crypto object that wraps the given presentation session object.
`CryptoObject(@NonNull Signature signature)` Creates a crypto object that wraps the given signature object.

Public methods
`@Nullable Cipher`	`getCipher()` Gets the cipher object associated with this crypto object.
`@Nullable IdentityCredential`	`@RequiresApi(value = Build.VERSION_CODES.R) getIdentityCredential()` Gets the identity credential object associated with this crypto object.
`@Nullable 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.
`@Nullable PresentationSession`	`@RequiresApi(value = Build.VERSION_CODES.TIRAMISU) getPresentationSession()` Gets the presentation session object associated with this crypto object.
`@Nullable Signature`	`getSignature()` Gets the signature object associated with this crypto object.

Public constructors

CryptoObject

Added in 1.0.0

public CryptoObject(@NonNull Cipher cipher)

Creates a crypto object that wraps the given cipher object.

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

CryptoObject

Added in 1.1.0

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

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

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

CryptoObject

Added in 1.0.0

public CryptoObject(@NonNull Mac mac)

Creates a crypto object that wraps the given MAC object.

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

CryptoObject

Added in 1.4.0-alpha01

@RequiresApi(value = Build.VERSION_CODES.VANILLA_ICE_CREAM)
public CryptoObject(long operationHandle)

Create from an operation handle.

Parameters
`long operationHandle`	the operation handle associated with this object.

See also
`getOperationHandle`

CryptoObject

Added in 1.4.0-alpha01

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

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

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

CryptoObject

Added in 1.0.0

public CryptoObject(@NonNull Signature signature)

Creates a crypto object that wraps the given signature object.

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

Public methods

getCipher

Added in 1.0.0

public @Nullable Cipher getCipher()

Gets the cipher object associated with this crypto object.

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

getIdentityCredential

Added in 1.1.0

@RequiresApi(value = Build.VERSION_CODES.R)
public @Nullable IdentityCredential getIdentityCredential()

Gets the identity credential object associated with this crypto object.

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

getMac

Added in 1.0.0

public @Nullable Mac getMac()

Gets the MAC object associated with this crypto object.

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

getOperationHandle

Added in 1.4.0-alpha01

@RequiresApi(value = Build.VERSION_CODES.VANILLA_ICE_CREAM)
public long getOperationHandle()

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-alpha01

@RequiresApi(value = Build.VERSION_CODES.TIRAMISU)
public @Nullable PresentationSession getPresentationSession()

Gets the presentation session object associated with this crypto object.

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

getSignature

Added in 1.0.0

public @Nullable Signature getSignature()

Gets the signature object associated with this crypto object.

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