forgerock-auth

4.4.0

forgerock-auth/org.forgerock.android.auth.callback/DeviceBindingCallback

DeviceBindingCallback

open class DeviceBindingCallback : AbstractCallback, Binding

Callback to collect the device binding information

Constructors

DeviceBindingCallback

constructor(jsonObject: JSONObject, index: Int)

constructor()

Properties

protected var _id: Int

lateinit var attestation: Attestation

Enable Attestation

lateinit var challenge: String

The challenge received from server

protected var content: String

lateinit var description: String

The description to be displayed in biometric prompt

deviceAuthenticatorIdentifier

open val deviceAuthenticatorIdentifier: (type: DeviceBindingAuthenticationType) -> DeviceAuthenticator

Default function to identify DeviceAuthenticator

deviceBindingAuthenticationType

lateinit var deviceBindingAuthenticationType: DeviceBindingAuthenticationType

The authentication type of the journey

lateinit var subtitle: String

The subtitle to be displayed in biometric prompt

var timeout: Int?

The timeout to be to expire the biometric authentication

lateinit var title: String

The title to be displayed in biometric prompt

lateinit var userId: String

The userId received from server

lateinit var userName: String

The userName received from server

Functions

open suspend fun bind(context: Context, prompt: Prompt? = null, deviceAuthenticator: (type: DeviceBindingAuthenticationType) -> DeviceAuthenticator = deviceAuthenticatorIdentifier)

open fun bind(context: Context, deviceAuthenticator: (type: DeviceBindingAuthenticationType) -> DeviceAuthenticator = deviceAuthenticatorIdentifier, listener: FRListener<Void?>, prompt: Prompt? = null)

Bind the device. Calling the bind function, the existing bounded keys will be removed. If don't want to replace or remove existing keys, please use FRUserKeys to check existing keys before calling this method

private fun clearKeys(context: Context, deviceAuthenticator: DeviceAuthenticator)

For now we don't support multiple keys, so before we create new keys, we clean existing keys.

internal suspend fun execute(context: Context, deviceAuthenticator: DeviceAuthenticator = getDeviceAuthenticator( deviceBindingAuthenticationType), deviceBindingRepository: DeviceBindingRepository = LocalDeviceBindingRepository( context), deviceId: String = DeviceIdentifier.builder().context(context) .build().identifier, prompt: Prompt? = null)

Helper method to execute binding , signing, show biometric prompt.

open override fun get_id(): Int

Return the unique id for this callback. The id only available with Callback that using PageCallback

open override fun getContent(): String

Return the raw content of the Callback.

getContentAsJson

protected open fun getContentAsJson(): JSONObject

open fun getCryptoKey(): CryptoKey

getDeviceAuthenticator

open fun getDeviceAuthenticator(type: DeviceBindingAuthenticationType): DeviceAuthenticator

Create the interface for the Authentication type(Biometric, Biometric_Fallback, none)

open fun getDuration(timeout: Int?): Duration

Convert timeout in seconds to Duration

open fun getExpiration(timeout: Int?): Date

Get Expiration date for the signed token, claim "exp" will be set to the JWS.

private open fun getInput(content: JSONObject, index: Int): JSONObject

open fun getInputValue(): Any

Get the first value for input

open fun getInputValue(index: Int): Any

Get the value for input

protected open fun getName(jsonObject: JSONObject): String

open override fun getType(): String

Return the type of the Callback, the type name should align with the Callback type returned from AM

handleException

open fun handleException(e: Throwable)

Handle all the errors for the device binding.

protected override fun setAttribute(name: String, value: Any)

open override fun setClientError(value: String?)

Input the Client Error to the server

protected open fun setContent(jsonObject: JSONObject)

Sets the value of the Callback

fun setDeviceId(value: String?)

Input the Device Id to the server

fun setDeviceName(value: String?)

Input the Device Name to the server

fun setJws(value: String?)

Input the JWS key to the server

protected open fun setValue(value: Any)

Set the first value for input

protected open fun setValue(value: Any, index: Int)

Set the value for the input.