Revision control
Copy as Markdown
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
import Foundation
class KeyChainAccountStorage {
var useRustKeychainForFxA: Bool
var legacyKeychainWrapper: MZKeychainWrapper
var keychainWrapper: FxAKeychain
static var keychainKey: String = "accountJSON"
static var legacyAccessibility: MZKeychainItemAccessibility = .afterFirstUnlock
static var accessibility: FxAKeychainItemAccessibility = .afterFirstUnlock
init(keychainAccessGroup: String?, useRustKeychainForFxA: Bool = false) {
self.useRustKeychainForFxA = useRustKeychainForFxA
keychainWrapper = FxAKeychain.sharedAppContainerKeychainForFxA(keychainAccessGroup: keychainAccessGroup)
legacyKeychainWrapper = MZKeychainWrapper.sharedAppContainerKeychain(keychainAccessGroup: keychainAccessGroup)
}
func read() -> PersistedFirefoxAccount? {
// Firefox iOS v25.0 shipped with the default accessibility, which breaks Send Tab when the screen is locked.
// This method migrates the existing keychains to the correct accessibility.
if useRustKeychainForFxA {
keychainWrapper.ensureStringItemAccessibility(KeyChainAccountStorage.accessibility,
forKey: KeyChainAccountStorage.keychainKey)
if let json = keychainWrapper
.getKeyValue(key: KeyChainAccountStorage.keychainKey,
accessibility: KeyChainAccountStorage.accessibility)
{
do {
return try PersistedFirefoxAccount.fromJSON(data: json)
} catch {
FxALog.error("FxAccount internal state de-serialization failed: \(error).")
return nil
}
}
} else {
legacyKeychainWrapper.ensureStringItemAccessibility(
KeyChainAccountStorage.legacyAccessibility,
forKey: KeyChainAccountStorage.keychainKey
)
if let json = legacyKeychainWrapper.string(
forKey: KeyChainAccountStorage.keychainKey,
withAccessibility: KeyChainAccountStorage.legacyAccessibility
) {
do {
return try PersistedFirefoxAccount.fromJSON(data: json)
} catch {
FxALog.error("FxAccount internal state de-serialization failed: \(error).")
return nil
}
}
}
return nil
}
func write(_ json: String) {
if useRustKeychainForFxA {
if !keychainWrapper.setKeyValue(
json,
key: KeyChainAccountStorage.keychainKey,
accessibility: KeyChainAccountStorage.accessibility
) {
FxALog.error("Could not write account state.")
}
} else {
if !legacyKeychainWrapper.set(
json,
forKey: KeyChainAccountStorage.keychainKey,
withAccessibility: KeyChainAccountStorage.legacyAccessibility
) {
FxALog.error("Could not write account state.")
}
}
}
func clear() {
if useRustKeychainForFxA {
if !keychainWrapper.removeObject(
key: KeyChainAccountStorage.keychainKey,
accessibility: KeyChainAccountStorage.accessibility
) {
FxALog.error("Could not clear account state.")
}
} else {
if !legacyKeychainWrapper.removeObject(
forKey: KeyChainAccountStorage.keychainKey,
withAccessibility: KeyChainAccountStorage.legacyAccessibility
) {
FxALog.error("Could not clear account state.")
}
}
}
}
public extension MZKeychainWrapper {
func ensureStringItemAccessibility(
_ accessibility: MZKeychainItemAccessibility,
forKey key: String
) {
if hasValue(forKey: key) {
if accessibilityOfKey(key) != accessibility {
FxALog.info("ensureStringItemAccessibility: updating item \(key) with \(accessibility)")
guard let value = string(forKey: key) else {
FxALog.error("ensureStringItemAccessibility: failed to get item \(key)")
return
}
if !removeObject(forKey: key) {
FxALog.error("ensureStringItemAccessibility: failed to remove item \(key)")
}
if !set(value, forKey: key, withAccessibility: accessibility) {
FxALog.error("ensureStringItemAccessibility: failed to update item \(key)")
}
}
}
}
}