binding/com.pingidentity.device.binding.authenticator

Package-level declarations

Types

AppPinAuthenticator

open class AppPinAuthenticator(config: AppPinConfig) : CryptoKeyAware, DeviceAuthenticator

A PIN-based device authenticator that generates and manages RSA key pairs protected by user PIN.

AppPinConfig

class AppPinConfig

Configuration class for AppPinAuthenticator that defines PIN collection, storage, and security settings.

Attestation

sealed class Attestation(val challenge: ByteArray? = null)

Sealed class hierarchy representing different types of cryptographic attestation for device authentication.

BiometricAuthenticator

abstract class BiometricAuthenticator : CryptoKeyAware, DeviceAuthenticator

Abstract base class for biometric-based device authenticators.

BiometricAuthenticatorConfig

class BiometricAuthenticatorConfig

Configuration class for biometric authenticators that defines UI prompts, key generation, and hardware preferences.

BiometricDeviceCredentialAuthenticator

open class BiometricDeviceCredentialAuthenticator(config: BiometricAuthenticatorConfig) : BiometricAuthenticator

Biometric authenticator with device credential fallback support for enhanced user experience.

BiometricOnlyAuthenticator

open class BiometricOnlyAuthenticator(config: BiometricAuthenticatorConfig) : BiometricAuthenticator

Pure biometric authenticator that requires biometric authentication without fallback options.

BiometricPromptActivity

class BiometricPromptActivity : FragmentActivity

Headless Activity that manages biometric authentication prompts using AndroidX BiometricPrompt.

DeviceAuthenticator

interface DeviceAuthenticator

Interface for device authenticators that handle cryptographic operations for device binding. Implementations provide device-specific authentication mechanisms such as biometric authentication, PIN-based authentication, or hardware security modules.

DeviceBindingAuthenticationType

@Serializable

enum DeviceBindingAuthenticationType : Enum<DeviceBindingAuthenticationType>

Defines the types of authentication methods available for device binding. These authentication types determine how users prove their identity when accessing cryptographic keys stored on the device.

KeyPair

data class KeyPair(val publicKey: RSAPublicKey, val privateKey: PrivateKey, var keyAlias: String)

Represents a cryptographic key pair used for device binding operations.

NoneAuthenticator

open class NoneAuthenticator : CryptoKeyAware, DeviceAuthenticator

A device authenticator implementation that requires no user authentication.

SigningParameters

data class SigningParameters(val context: Context, val algorithm: String, val keyPair: KeyPair, val signature: Signature?, val kid: String, val userId: String, val challenge: String, val issueTime: Instant, val notBeforeTime: Instant, val expiration: Instant, val attestation: Attestation = Attestation.None)

Parameters required for signing a JWT with device binding authentication.

UserKeySigningParameters

data class UserKeySigningParameters(val context: Context, val algorithm: String, val userKey: UserKey, val privateKey: PrivateKey, val signature: Signature?, val challenge: String, val issueTime: Instant, val notBeforeTime: Instant, val expiration: Instant, val customClaims: Map<String, Any> = emptyMap())

Parameters required for signing a JWT using a UserKey with custom claims support.

Functions

authenticateWithBiometric

suspend fun authenticateWithBiometric(context: Context, promptInfo: BiometricPrompt.PromptInfo, privateKey: PrivateKey?): BiometricPrompt.AuthenticationResult

Performs biometric authentication using AndroidX BiometricPrompt with thread-safe operation handling.