BiometricPrompt.CryptoObject

public CryptoObject(@NonNull Cipher cipher)

Creates a crypto object that wraps the given cipher object.

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

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

public CryptoObject(@NonNull Mac mac)

Creates a crypto object that wraps the given MAC object.

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

Create from an operation handle.

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

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

public CryptoObject(@NonNull Signature signature)

Creates a crypto object that wraps the given signature object.

public @Nullable Cipher getCipher()

Gets the cipher object associated with this crypto object.

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

Gets the identity credential object associated with this crypto object.

public @Nullable Mac getMac()

Gets the MAC object associated with this crypto object.

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

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

Gets the presentation session object associated with this crypto object.

public @Nullable Signature getSignature()

Gets the signature object associated with this crypto object.