ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-02 21:33:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add tests for loading Classic accounts.

Browse Source 
Tidy up warnings and fix a few bugs that were revealed.
This commit is contained in:
Doug
2026-03-10 13:54:14 +00:00
committed by Doug
parent 06c6ed3b2d
commit b5f571bfe4
9 changed files with 156 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/Application/AppCoordinator.swift
+2 -15
View File
@@ -605,7 +605,7 @@ class AppCoordinator: AppCoordinatorProtocol, AuthenticationFlowCoordinatorDeleg
private func startAuthentication() {
let encryptionKeyProvider = EncryptionKeyProvider()
let classicAppManager = makeClassicAppManager()
let classicAppManager = ClassicAppManager()
let authenticationService = AuthenticationService(userSessionStore: userSessionStore,
encryptionKeyProvider: encryptionKeyProvider,
classicAppManager: classicAppManager,
@@ -630,19 +630,6 @@ class AppCoordinator: AppCoordinatorProtocol, AuthenticationFlowCoordinatorDeleg
}
}
private func makeClassicAppManager() -> ClassicAppManagerProtocol? {
guard let classicAppGroupIdentifier = InfoPlistReader.main.classicAppGroupIdentifier,
let classicAppKeychainServiceIdentifier = InfoPlistReader.main.classicAppKeychainServiceIdentifier,
let classicAppKeychainAccessGroupIdentifier = InfoPlistReader.main.classicAppKeychainAccessGroupIdentifier else {
MXLog.info("Classic App IDs not set, manager disabled.")
return nil
}
return ClassicAppManager(classicAppGroupIdentifier: classicAppGroupIdentifier,
classicAppKeychainServiceIdentifier: classicAppKeychainServiceIdentifier,
classicAppKeychainAccessGroupIdentifier: classicAppKeychainAccessGroupIdentifier)
}
private func runPostSessionSetupTasks() async {
guard let userSession, let userSessionFlowCoordinator else {
fatalError("User session not setup")
@@ -675,7 +662,7 @@ class AppCoordinator: AppCoordinatorProtocol, AuthenticationFlowCoordinatorDeleg
let authenticationService = AuthenticationService(userSessionStore: userSessionStore,
encryptionKeyProvider: EncryptionKeyProvider(),
classicAppManager: makeClassicAppManager(),
classicAppManager: ClassicAppManager(),
appSettings: appSettings,
appHooks: appHooks)
_ = await authenticationService.configure(for: userSession.clientProxy.homeserver, flow: .login)
ElementX/Sources/Services/Authentication/ClassicApp/ClassicAppAccountManager.swift
+21 -11
View File
@@ -25,16 +25,16 @@ class ClassicAppAccountManager {
func loadAccounts() {
MXLog.info("Loading accounts from Classic app.")
// First we need to load the accounts file, which contains an array of MXKAccounts (a super class of MXAccount).
let accountFile = accountFile()
if FileManager.default.fileExists(atPath: accountFile.path(percentEncoded: false)) {
let startDate = Date()
do {
let fileContent = try Data(contentsOf: accountFile, options: [.alwaysMapped, .uncached])
// Decrypt data if encryption method is provided
let unciphered = try ClassicAppAES.decrypt(fileContent, aesKey: aesKey, iv: iv)
let decoder = NSKeyedUnarchiver(forReadingWith: unciphered)
let decoder = try NSKeyedUnarchiver(forReadingFrom: unciphered)
decoder.requiresSecureCoding = false
decoder.setClass(ClassicAppMXAccount.self, forClassName: "MXKAccount")
guard let mxAccounts = decoder.decodeObject(forKey: "mxAccounts") as? [ClassicAppMXAccount] else {
@@ -44,6 +44,8 @@ class ClassicAppAccountManager {
MXLog.info("\(mxAccounts.count) accounts loaded in \(Date().timeIntervalSince(startDate) * 1000)ms.")
// Only consider active accounts using the same logic as Element Classic and then
// combine the MXAccount data with its profile and crypto store details.
accounts = mxAccounts
.filter(\.isActive)
.compactMap(makeAccount)
@@ -57,9 +59,10 @@ class ClassicAppAccountManager {
// MARK: - Private
/// Combines an MXAccount with its profile and crypto store details.
private func makeAccount(for mxAccount: ClassicAppMXAccount) -> ClassicAppAccount? {
let userID = mxAccount.userID
let user = loadUser(for: mxAccount)
let user = loadUser(for: mxAccount) // We need an MXUser for the profile as MXAccount doesn't contain that data.
guard let serverName = serverName(for: userID) else { return nil }
@@ -72,13 +75,21 @@ class ClassicAppAccountManager {
}
private func loadUser(for mxAccount: ClassicAppMXAccount) -> ClassicAppMXUser? {
// Users are stored across multiple files, so first find the right file for this particular user.
let userID = mxAccount.userID
let groupID = String(userID.hash % 100)
let groupFile = storeUsersPath(for: userID).appendingPathComponent(groupID)
let groupID = String(UInt(bitPattern: userID.hash) % 100) // Swift's .hash is Int whereas Objective-C's is UInt.
let groupFile = storeUsersPath(for: userID).appending(component: groupID)
guard FileManager.default.fileExists(atPath: groupFile.path(percentEncoded: false)) else {
MXLog.warning("Missing users group \(groupID) file for \(mxAccount.userID).")
return nil
}
do {
// And then load that file and find the user within its data.
let fileContent = try Data(contentsOf: groupFile)
let decoder = NSKeyedUnarchiver(forReadingWith: fileContent)
let decoder = try NSKeyedUnarchiver(forReadingFrom: fileContent)
decoder.requiresSecureCoding = false
decoder.setClass(ClassicAppMXUser.self, forClassName: "MXUser")
decoder.setClass(ClassicAppMXUser.self, forClassName: "MXMyUser")
@@ -92,7 +103,6 @@ class ClassicAppAccountManager {
/// The server name extracted from the user's ID.
private func serverName(for userID: String) -> String? {
#warning("Expose a serverName method for this from the SDK?")
let components = userID.components(separatedBy: ":")
guard components.count > 1 else { return nil }
return components[1] // Directly use [1] as .last may be the port number.
@@ -107,17 +117,17 @@ class ClassicAppAccountManager {
private static let kMXFileStoreUsersFolder = "users"
/// The file URL that contains the app's `MXAccounts` array.
private func accountFile() -> URL {
func accountFile() -> URL {
cacheFolder.appending(component: Self.matrixKitFolder).appending(component: Self.kMXKAccountsKey)
}
/// The database file URL as defined in `MXCryptoMachineStore`.
private func cryptoStoreURL(for userID: String) -> URL {
func cryptoStoreURL(for userID: String) -> URL {
cacheFolder.appending(component: Self.cryptoStoreFolder).appending(component: userID)
}
/// This store contains all of the users known to the specific user ID.
private func storeUsersPath(for userID: String) -> URL {
func storeUsersPath(for userID: String) -> URL {
storePath(for: userID).appending(component: Self.kMXFileStoreUsersFolder)
}
ElementX/Sources/Services/Authentication/ClassicApp/ClassicAppMXAccount.swift
+3 -3
View File
@@ -7,7 +7,7 @@
import Foundation
struct ClassicAppAccount {
struct ClassicAppAccount: Equatable {
let userID: String
let displayName: String?
let avatarURL: URL?
@@ -18,7 +18,7 @@ struct ClassicAppAccount {
// MARK: NSCoding Types
class ClassicAppMXAccount: NSObject, NSCoding {
final class ClassicAppMXAccount: NSObject, NSCoding {
/// The obtained user ID.
var userID: String
/// The homeserver url (ex: "https://matrix.org").
@@ -83,7 +83,7 @@ class ClassicAppMXAccount: NSObject, NSCoding {
}
/// `MXUser` represents a user in Matrix.
class ClassicAppMXUser: NSObject, NSCoding {
final class ClassicAppMXUser: NSObject, NSCoding {
/// The user id.
let userID: String
/// The user display name.
ElementX/Sources/Services/Authentication/ClassicApp/ClassicAppManager.swift
+14 -1
View File
@@ -19,6 +19,7 @@ enum ClassicAppManagerError: Error {
case missingCryptoStorePassphrase
}
/// Reads accounts from Element Classic's shared storage.
final class ClassicAppManager: ClassicAppManagerProtocol {
private enum KeychainKeys: String {
case cryptoSDKStoreKey
@@ -29,16 +30,28 @@ final class ClassicAppManager: ClassicAppManagerProtocol {
private let classicAppGroupIdentifier: String
private let keychain: Keychain
init(classicAppGroupIdentifier: String, classicAppKeychainServiceIdentifier: String, classicAppKeychainAccessGroupIdentifier: String) {
/// Creates an instance using the Classic app identifiers specified in the `Info.plist` file.
/// Returns `nil` when a Classic app has not been configured in the project.
init?(classicAppGroupIdentifier: String? = InfoPlistReader.main.classicAppGroupIdentifier,
classicAppKeychainServiceIdentifier: String? = InfoPlistReader.main.classicAppKeychainServiceIdentifier,
classicAppKeychainAccessGroupIdentifier: String? = InfoPlistReader.main.classicAppKeychainAccessGroupIdentifier) {
guard let classicAppGroupIdentifier, let classicAppKeychainServiceIdentifier, let classicAppKeychainAccessGroupIdentifier else {
MXLog.info("Classic App IDs not available, skipping initialisation.")
return nil
}
self.classicAppGroupIdentifier = classicAppGroupIdentifier
keychain = Keychain(service: classicAppKeychainServiceIdentifier, accessGroup: classicAppKeychainAccessGroupIdentifier)
}
/// Loads all of the active accounts from the Classic app.
func loadAccounts() throws -> [ClassicAppAccount] {
// The account data is stored in the App Group container.
guard let url = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: classicAppGroupIdentifier) else {
throw ClassicAppManagerError.invalidAppGroupIdentifier(classicAppGroupIdentifier)
}
// And the data is encrypted with keys that are stored in the Keychain.
guard let accountIV = try keychain.getData(KeychainKeys.accountIV.rawValue),
let accountAESKey = try keychain.getData(KeychainKeys.accountAESKey.rawValue) else {
throw ClassicAppManagerError.missingAccountKeys