binding/com.pingidentity.device.binding.journey/DeviceBindingConfig

DeviceBindingConfig

Configuration class for customizing device binding operations.

This DSL-enabled configuration class allows fine-grained control over various aspects of the device binding process, including authentication methods, storage configuration, JWT signing parameters, and user interface behavior.

The configuration supports:

Multiple authentication types (biometric, PIN, none)
Customizable storage backends for user key metadata
JWT signing algorithm and timing configuration
Device identification and naming
Custom claims for verification
User key selection strategies

Example usage:

deviceBindingCallback.bind {
    deviceName = "My Custom Device"
    signingAlgorithm = "RS256"
    userKeyStorage {
        fileName = "my_keys.json"
    }
    biometricAuthenticatorConfig {
        promptInfo = {
            setTitle("Authenticate for Device Binding")
        }
    }
}

Constructors

DeviceBindingConfig

constructor()

Properties

deviceAuthenticator

lateinit var deviceAuthenticator: (DeviceBindingAuthenticationType) -> DeviceAuthenticator

Factory function for creating device authenticators based on authentication type.

deviceIdentifier

var deviceIdentifier: DeviceIdentifier

The device identifier used to generate unique device IDs for binding. Defaults to DefaultDeviceIdentifier which uses Android device properties.

deviceName

var deviceName: String

The human-readable name for the device that will be displayed in user interfaces. Defaults to the device model (Build.MODEL).

expirationTime

var expirationTime: (Int) -> Instant

Function that calculates the JWT expiration time based on timeout seconds. Takes the timeout in seconds and returns an Instant representing when the JWT expires. Defaults to current time plus the timeout in seconds.

issueTime

var issueTime: () -> Instant

Function that provides the current time for JWT "iat" (issued at) claim. Defaults to the current system time when the JWT is created.

logger

var logger: Logger

The logger instance used for debugging and monitoring device binding operations. Defaults to the global Logger.logger instance.

notBeforeTime

var notBeforeTime: () -> Instant

Function that provides the "nbf" (not before) time for JWT validation. Defaults to the current system time, meaning the JWT is valid immediately.

signingAlgorithm

var signingAlgorithm: String

The cryptographic algorithm used for signing JWTs during device binding. Must be a valid JWS algorithm identifier. Defaults to "RS512". Common values: "RS256", "RS384", "RS512"