Google is committed to advancing racial equity for Black communities. See how.

CryptoObject

open class CryptoObject
kotlin.Any
   ↳ androidx.biometric.BiometricPrompt.CryptoObject

A wrapper class for the crypto objects supported by BiometricPrompt. Currently, the framework supports Signature, Cipher, and Mac objects.

Summary

Public constructors
<init>(@NonNull signature: Signature)

Creates a CryptoObject that wraps the given Signature object.
<init>(@NonNull cipher: Cipher)

Creates a CryptoObject that wraps the given Cipher object.
<init>(@NonNull mac: Mac)

Creates a CryptoObject that wraps the given Mac object.

Public methods
open Cipher?

Gets the Cipher object associated with this crypto object.
open Mac?

Gets the Mac object associated with this crypto object.
open Signature?

Gets the Signature object associated with this crypto object.

Public constructors

<init>

CryptoObject(@NonNull signature: Signature)

Creates a CryptoObject that wraps the given Signature object.

Parameters
signature Signature: The Signature to be associated with this CryptoObject.

<init>

CryptoObject(@NonNull cipher: Cipher)

Creates a CryptoObject that wraps the given Cipher object.

Parameters
cipher Cipher: The Cipher to be associated with this CryptoObject.

<init>

CryptoObject(@NonNull mac: Mac)

Creates a CryptoObject that wraps the given Mac object.

Parameters
mac Mac: The Mac to be associated with this CryptoObject.

Public methods

getCipher

@Nullable open fun getCipher(): Cipher?

Gets the Cipher object associated with this crypto object.

Return
Cipher? The Cipher, or null if none is associated with this object.

getMac

@Nullable open fun getMac(): Mac?

Gets the Mac object associated with this crypto object.

Return
Mac? The Mac, or null if none is associated with this object.

getSignature

@Nullable open fun getSignature(): Signature?

Gets the Signature object associated with this crypto object.

Return
Signature? The Signature, or null if none is associated with this object.