forgerock-auth

4.4.0

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

ApplicationPinDeviceAuthenticator

open class ApplicationPinDeviceAuthenticator(val pinCollector: PinCollector = DefaultPinCollector()) : CryptoAware, DeviceAuthenticator, KeyStoreRepository

Device Authenticator which use Application PIN to secure device cryptography keys

Constructors

ApplicationPinDeviceAuthenticator

constructor(pinCollector: PinCollector = DefaultPinCollector())

Properties

appPinAuthenticator

internal lateinit var appPinAuthenticator: AppPinAuthenticator

private lateinit var cryptoKey: CryptoKey

private lateinit var keyStore: KeyStoreRepository

private val pinCollector: PinCollector

internal val pinRef: AtomicReference<CharArray>

protected lateinit var prompt: Prompt

private val worker: ScheduledExecutorService

Functions

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

Authenticate the user to access the

open override fun delete(context: Context)

open override fun deleteKeys(context: Context)

open override fun exist(context: Context): Boolean

open suspend override 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 override fun getInputStream(context: Context): InputStream

open fun getIssueTime(): Date

Get the token signed issue time.

getKeystoreType

open override fun getKeystoreType(): String

getNotBeforeTime

open fun getNotBeforeTime(): Date

Get the token not before time.

getOutputStream

open override fun getOutputStream(context: Context): OutputStream

private fun getPrivateKey(context: Context, pin: CharArray): DeviceBindingStatus

Retrieve the Keystore Type, default to KeyStore.getDefaultType

fun DeviceAuthenticator.initialize(userId: String): DeviceAuthenticator

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

open override fun isSupported(context: Context, attestation: Attestation): Boolean

check if supported device binding

open override fun prompt(prompt: Prompt)

Set the Authentication Prompt

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

override fun type(): DeviceBindingAuthenticationType

validateCustomClaims

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

Validate custom claims