persistence/com.wire.kalium.persistence.dbPassphrase/KeychainPassphraseStorage

KeychainPassphraseStorage

internal class KeychainPassphraseStorage(delegate: PassphraseStorage, keychainConfig: ApplePersistenceConfig) : PassphraseStorage

PassphraseStorage on the Keychain whose setPassphraseIfAbsent only ever adds an item: the Keychain rejects a second item for the same key, so a passphrase another process or thread stored in between is never replaced.

Parameters

keychainConfig

the attributes delegate uses for the shared Keychain items.

Constructors

KeychainPassphraseStorage

constructor(delegate: PassphraseStorage, keychainConfig: ApplePersistenceConfig)

Functions

clearPassphrase

open override fun clearPassphrase(key: String)

existingCoreCryptoKey

fun PassphraseStorage.existingCoreCryptoKey(alias: String): ByteArray?

Read the current key only. Missing, malformed or legacy keys never trigger generation or migration.

existingUserDatabaseSecret

fun PassphraseStorage.existingUserDatabaseSecret(userId: UserIDEntity): UserDBSecret?

Reads the app's current database key and salt only; never generates or migrates a key.

getPassphrase

open override fun getPassphrase(key: String): String?

setPassphrase

open override fun setPassphrase(key: String, passphrase: String)

setPassphraseIfAbsent

open override fun setPassphraseIfAbsent(key: String, passphrase: String): String

Stores passphrase under key unless a passphrase is stored there already, and returns the stored one.