# Print output for @column tags ?> BiometricPrompt.CryptoObject - Android SDK | Android Developers

Most visited

Recently visited

BiometricPrompt.CryptoObject

public static final class BiometricPrompt.CryptoObject
extends Object

java.lang.Object
   ↳ android.hardware.biometrics.BiometricPrompt.CryptoObject


A wrapper class for the cryptographic operations supported by BiometricPrompt.

Currently the framework supports Signature, Cipher, Mac, and IdentityCredential.

Cryptographic operations in Android can be split into two categories: auth-per-use and time-based. This is specified during key creation via the timeout parameter of the KeyGenParameterSpec.Builder#setUserAuthenticationParameters(int, int) API.

CryptoObjects are used to unlock auth-per-use keys via BiometricPrompt#authenticate(CryptoObject, CancellationSignal, Executor, AuthenticationCallback), whereas time-based keys are unlocked for their specified duration any time the user authenticates with the specified authenticators (e.g. unlocking keyguard). If a time-based key is not available for use (i.e. none of the allowed authenticators have been unlocked recently), applications can prompt the user to authenticate via BiometricPrompt#authenticate(CancellationSignal, Executor, AuthenticationCallback)

See also:

Summary

Public constructors

CryptoObject(Signature signature)
CryptoObject(Cipher cipher)
CryptoObject(Mac mac)
CryptoObject(IdentityCredential credential)

Public methods

Cipher getCipher()

Get Cipher object.

IdentityCredential getIdentityCredential()

Get IdentityCredential object.

Mac getMac()

Get Mac object.

Signature getSignature()

Get Signature object.

Inherited methods

Public constructors

CryptoObject

public CryptoObject (Signature signature)

Parameters
signature Signature: This value cannot be null.

CryptoObject

public CryptoObject (Cipher cipher)

Parameters
cipher Cipher: This value cannot be null.

CryptoObject

public CryptoObject (Mac mac)

Parameters
mac Mac: This value cannot be null.

CryptoObject

public CryptoObject (IdentityCredential credential)

Parameters
credential IdentityCredential: This value cannot be null.

Public methods

getCipher

public Cipher getCipher ()

Get Cipher object.

Returns
Cipher Cipher object or null if this doesn't contain one.

getIdentityCredential

public IdentityCredential getIdentityCredential ()

Get IdentityCredential object.

Returns
IdentityCredential IdentityCredential object or null if this doesn't contain one.

getMac

public Mac getMac ()

Get Mac object.

Returns
Mac Mac object or null if this doesn't contain one.

getSignature

public Signature getSignature ()

Get Signature object.

Returns
Signature Signature object or null if this doesn't contain one.