forgerock-auth

4.4.0

forgerock-auth/org.forgerock.android.auth.devicebind/BiometricAuthenticator

BiometricAuthenticator

abstract class BiometricAuthenticator : CryptoAware, DeviceAuthenticator

Inheritors

BiometricAndDeviceCredential

Constructors

BiometricAuthenticator

constructor()

Properties

biometricInterface

internal lateinit var biometricInterface: BiometricHandler

internal lateinit var cryptoKey: CryptoKey

internal var isApi30OrAbove: Boolean

Functions

open suspend override fun authenticate(context: Context): DeviceBindingStatus

Display biometric prompt for authentication type

abstract fun authenticate(authenticationCallback: BiometricPrompt.AuthenticationCallback, privateKey: PrivateKey)

Launch the Biometric Prompt.

open override fun deleteKeys(context: Context)

abstract suspend fun generateKeys(context: Context, attestation: Attestation): KeyPair

generate the public and private KeyPair with Challenge

open fun getAlgorithm(): String

The JWS algorithm (alg) parameter. Header Parameter identifies the cryptographic algorithm used to secure the JWS.

getCertificateChain

private fun getCertificateChain(userId: String): List<Base64>

open fun getIssueTime(): Date

Get the token signed issue time.

getNotBeforeTime

open fun getNotBeforeTime(): Date

Get the token not before time.

fun DeviceAuthenticator.initialize(userId: String): DeviceAuthenticator

fun DeviceAuthenticator.initialize(userId: String, prompt: Prompt): DeviceAuthenticator

open fun isSupported(context: Context, attestation: Attestation = Attestation.None): Boolean

check if supported device binding

open fun prompt(prompt: Prompt)

Set the Authentication Prompt

setBiometricHandler

fun setBiometricHandler(biometricHandler: BiometricHandler)

override fun setKey(cryptoKey: CryptoKey)

open fun sign(context: Context, userKey: UserKey, privateKey: PrivateKey, signature: Signature?, challenge: String, expiration: Date, customClaims: Map<String, Any> = emptyMap()): String

open fun sign(context: Context, keyPair: KeyPair, signature: Signature?, kid: String, userId: String, challenge: String, expiration: Date, attestation: Attestation = Attestation.None): String

sign the challenge sent from the server and generate signed JWT

abstract fun type(): DeviceBindingAuthenticationType

validateCustomClaims

open fun validateCustomClaims(customClaims: Map<String, Any>): Boolean

Validate custom claims