auth-migration/com.pingidentity.auth.migration

Package-level declarations

Types

AuthenticationMigrationInitializer

class AuthenticationMigrationInitializer : Initializer<Unit>

Initializes authenticator migration during app startup.

AuthMigration

object AuthMigration

Entry point for FR Authenticator data migration.

DefaultStorageClientProvider

class DefaultStorageClientProvider(context: Context, storageClient: StorageClient = DefaultStorageClient(context)) : StorageClientProvider

A StorageClientProvider that reads data from the default DefaultStorageClient used by the ForgeRock Authenticator SDK.

LegacyAccount

@Serializable

data class LegacyAccount(val id: String, val issuer: String, val displayIssuer: String? = null, val accountName: String, val displayAccountName: String? = null, val imageURL: String? = null, val backgroundColor: String? = null, val timeAdded: Long? = null, val policies: String? = null, val lockingPolicy: String? = null, val lock: Boolean = false)

Legacy account data nested within mechanisms.

LegacyAuthenticationConfig

class LegacyAuthenticationConfig(context: Context)

Configuration for the legacy FR Authenticator data migration.

LegacyDataConverter

object LegacyDataConverter

Utility functions for converting custom storage data to migration-ready JSON format.

LegacyExportedData

@Serializable

data class LegacyExportedData(val mechanisms: List<LegacyMechanism>, val metadata: LegacyExportMetadata)

Exported authenticator data from Legacy SDK. This represents the complete migration payload with mechanisms containing nested account data.

LegacyExportMetadata

@Serializable

data class LegacyExportMetadata(val totalMechanisms: Int, val exportedAt: Long = System.currentTimeMillis())

Metadata about exported authenticator data.

LegacyMechanism

@Serializable

data class LegacyMechanism(val id: String, val issuer: String, val accountName: String, val mechanismUID: String, val secret: String, val type: String, val oathType: String? = null, val algorithm: String? = null, val digits: Int? = null, val period: Int? = null, val counter: Long? = null, val registrationEndpoint: String? = null, val authenticationEndpoint: String? = null, val platform: String? = null, val uid: String? = null, val resourceId: String? = null, val timeAdded: Long? = null, val account: LegacyAccount)

Legacy mechanism with nested account data. Supports both OATH and Push mechanisms.

LegacyStorageProvider

interface LegacyStorageProvider

Defines how the migration pipeline sources and cleans up legacy authenticator data.

StorageClientProvider

open class StorageClientProvider(context: Context, storageClient: StorageClient = DefaultStorageClient(context)) : LegacyStorageProvider

LegacyStorageProvider implementation that sources and cleans up legacy authenticator data via a ForgeRock StorageClient.

Properties

legacyJson

val legacyJson: Json

JSON serializer for legacy data with lenient parsing.

migrateMechanismsStep

val migrateMechanismsStep: <Error class: unknown class>

The second migration step, which converts legacy LegacyMechanism entries (loaded by startMigrationStep) into modern OATH and Push credentials and persists them to SQLite.

Functions

cleanupLegacyDataStep

fun cleanupLegacyDataStep(provider: LegacyStorageProvider, backup: (context: Context) -> Unit = {}): <Error class: unknown class>

Creates the third and final migration step, which removes legacy authenticator data via the provided LegacyStorageProvider and closes the SQLite storage connections.

startMigrationStep

fun startMigrationStep(provider: LegacyStorageProvider): <Error class: unknown class>

Creates the first migration step, which imports legacy authenticator data through the provided LegacyStorageProvider.