logic/com.wire.kalium.logic.feature.backup

Package-level declarations

Types

internal interface ApplyCryptoStateUseCase

Applies crypto state (MLS and Proteus keystores) from extracted backup files. This replaces the existing keystores with the ones from the backup and updates the database passphrases in storage.

ApplyCryptoStateUseCaseImpl

internal class ApplyCryptoStateUseCaseImpl(userId: UserId, rootPathsProvider: RootPathsProvider, kaliumFileSystem: KaliumFileSystem, securityHelper: SecurityHelper, clientRepository: ClientRepository, eventRepository: EventRepository, dispatcher: KaliumDispatcher = KaliumDispatcherImpl) : ApplyCryptoStateUseCase

BackupAndUploadCryptoStateResult

sealed class BackupAndUploadCryptoStateResult

BackupAndUploadCryptoStateUseCase

interface BackupAndUploadCryptoStateUseCase

Creates a crypto state backup and uploads it to the remote endpoint.

BackupAndUploadCryptoStateUseCaseImpl

internal class BackupAndUploadCryptoStateUseCaseImpl(backupCryptoDBUseCase: BackupCryptoDBUseCase, cryptoStateBackupRemoteRepository: CryptoStateBackupRemoteRepository, kaliumFileSystem: KaliumFileSystem, currentClientIdProvider: CurrentClientIdProvider, executionMutex: Mutex = Mutex()) : BackupAndUploadCryptoStateUseCase

BackupConstants

internal object BackupConstants

BackupCryptoDBResult

sealed interface BackupCryptoDBResult

BackupCryptoDBUseCase

interface BackupCryptoDBUseCase

Performs the backup of the cryptographic database by exporting it, creating a metadata file, and packaging them into a ZIP file.

BackupCryptoDBUseCaseImpl

internal class BackupCryptoDBUseCaseImpl(userId: UserId, cryptoTransactionProvider: CryptoTransactionProvider, eventRepository: EventRepository, kaliumFileSystem: KaliumFileSystem, dispatchers: KaliumDispatcher = KaliumDispatcherImpl) : BackupCryptoDBUseCase

BackupFileFormat

enum BackupFileFormat : Enum<BackupFileFormat>

BackupMetadata

@Serializable

internal data class BackupMetadata(val platform: String, val version: String, val userId: String, val creationTime: String, val clientId: String?)

BackupScope

class BackupScope(userId: UserId, clientIdProvider: CurrentClientIdProvider, userRepository: UserRepository, clientRepository: ClientRepository, eventRepository: EventRepository, upgradeCurrentSession: UpgradeCurrentSessionUseCase, kaliumFileSystem: KaliumFileSystem, userStorage: UserStorage, cryptoTransactionProvider: CryptoTransactionProvider, val globalPreferences: GlobalPrefProvider, cryptoStateBackupRemoteRepository: CryptoStateBackupRemoteRepository, rootPathsProvider: RootPathsProvider)

CreateBackupResult

sealed class CreateBackupResult

CreateBackupUseCase

interface CreateBackupUseCase

CreateBackupUseCaseImpl

internal class CreateBackupUseCaseImpl(userId: UserId, clientIdProvider: CurrentClientIdProvider, userRepository: UserRepository, kaliumFileSystem: KaliumFileSystem, databaseExporter: DatabaseExporter, securityHelper: SecurityHelper, dispatchers: KaliumDispatcher = KaliumDispatcherImpl, idMapper: IdMapper = MapperProvider.idMapper()) : CreateBackupUseCase

CreateMPBackupUseCase

interface CreateMPBackupUseCase

CreateMPBackupUseCaseImpl

internal class CreateMPBackupUseCaseImpl(backupRepository: BackupRepository, userRepository: UserRepository, kaliumFileSystem: KaliumFileSystem, fileSystem: FileSystem = FileSystem.SYSTEM, exporterProvider: MPBackupExporterProvider = MPBackupExporterProviderImpl(), dispatchers: KaliumDispatcher = KaliumDispatcherImpl) : CreateMPBackupUseCase

CreateObfuscatedCopyUseCase

class CreateObfuscatedCopyUseCase(userId: UserId, clientIdProvider: CurrentClientIdProvider, userRepository: UserRepository, kaliumFileSystem: KaliumFileSystem, obfuscatedCopyExporter: ObfuscatedCopyExporter, dispatchers: KaliumDispatcher = KaliumDispatcherImpl, idMapper: IdMapper = MapperProvider.idMapper())

Creates an obfuscated copy of the user's data. TO BE USED FOR DEBUGGING PURPOSES ONLY.

CryptoStateBackupMetadata

@Serializable

data class CryptoStateBackupMetadata(val version: String, val clientId: String, val lastProcessedEventId: String, val mlsDbPassphrase: String, val proteusDbPassphrase: String)

DownloadCryptoStateResult

sealed class DownloadCryptoStateResult

DownloadCryptoStateUseCase

internal interface DownloadCryptoStateUseCase

Downloads the crypto state backup from the remote endpoint.

DownloadCryptoStateUseCaseImpl

internal class DownloadCryptoStateUseCaseImpl(userId: UserId, cryptoStateBackupRemoteRepository: CryptoStateBackupRemoteRepository, kaliumFileSystem: KaliumFileSystem, dispatchers: KaliumDispatcher = KaliumDispatcherImpl) : DownloadCryptoStateUseCase

ExtractCryptoStateResult

sealed class ExtractCryptoStateResult

ExtractCryptoStateUseCase

internal interface ExtractCryptoStateUseCase

Extracts the crypto state backup from a downloaded zip file.

ExtractCryptoStateUseCaseImpl

internal class ExtractCryptoStateUseCaseImpl(kaliumFileSystem: KaliumFileSystem, kaliumDispatcher: KaliumDispatcher = KaliumDispatcherImpl) : ExtractCryptoStateUseCase

MultiPlatformBackupScope

class MultiPlatformBackupScope(selfUserId: UserId, kaliumFileSystem: KaliumFileSystem, backupRepository: BackupRepository, userRepository: UserRepository)

RestoreBackupResult

sealed class RestoreBackupResult

RestoreBackupUseCase

interface RestoreBackupUseCase

RestoreBackupUseCaseImpl

internal class RestoreBackupUseCaseImpl(databaseImporter: DatabaseImporter, kaliumFileSystem: KaliumFileSystem, userId: UserId, userRepository: UserRepository, currentClientIdProvider: CurrentClientIdProvider, dispatchers: KaliumDispatcher = KaliumDispatcherImpl, idMapper: IdMapper = MapperProvider.idMapper()) : RestoreBackupUseCase

RestoreCryptoStateResult

sealed interface RestoreCryptoStateResult

RestoreCryptoStateUseCase

interface RestoreCryptoStateUseCase

RestoreCryptoStateUseCaseImpl

internal class RestoreCryptoStateUseCaseImpl(downloadCryptoState: DownloadCryptoStateUseCase, extractCryptoState: ExtractCryptoStateUseCase, setLastDeviceId: SetLastDeviceIdUseCase, applyCryptoState: ApplyCryptoStateUseCase, clientRepository: ClientRepository, upgradeCurrentSession: UpgradeCurrentSessionUseCase) : RestoreCryptoStateUseCase

RestoreMPBackupUseCase

interface RestoreMPBackupUseCase

RestoreMPBackupUseCaseImpl

internal class RestoreMPBackupUseCaseImpl(selfUserId: UserId, backupRepository: BackupRepository, kaliumFileSystem: KaliumFileSystem, backupImporterProvider: MPBackupImporterProvider = MPBackupImporterProviderImpl(), dispatchers: KaliumDispatcher = KaliumDispatcherImpl, progressDispatcher: CoroutineDispatcher? = null) : RestoreMPBackupUseCase

SetLastDeviceIdResult

sealed class SetLastDeviceIdResult

SetLastDeviceIdUseCase

interface SetLastDeviceIdUseCase

Sets the last device ID used for crypto state backup on the remote server. This is used to track which device last uploaded the crypto state.

SetLastDeviceIdUseCaseImpl

internal class SetLastDeviceIdUseCaseImpl(cryptoStateBackupRemoteRepository: CryptoStateBackupRemoteRepository) : SetLastDeviceIdUseCase

VerifyBackupResult

sealed class VerifyBackupResult

VerifyBackupUseCase

interface VerifyBackupUseCase

VerifyBackupUseCaseImpl

internal class VerifyBackupUseCaseImpl(userId: UserId, kaliumFileSystem: KaliumFileSystem, fileSystem: FileSystem = FileSystem.SYSTEM, backupImporterProvider: MPBackupImporterProvider = MPBackupImporterProviderImpl(fileSystem), dispatchers: KaliumDispatcher = KaliumDispatcherImpl) : VerifyBackupUseCase

Functions

isWebBackup

internal fun BackupMetadata.isWebBackup(): Boolean