Merge branch 'release/0.27.8/master'

Author: stefanceriu

CHANGES.md

@@ -1,3 +1,11 @@
+## Changes in 0.27.8 (2024-05-29)
+
+🙌 Improvements
+
+- When sorting room list alphabetically, sort it case-insensitive. ([#1851](https://github.com/matrix-org/matrix-ios-sdk/pull/1851))
+- Crypto: Update crypto SDK to 0.4.1 ([#1853](https://github.com/matrix-org/matrix-ios-sdk/pull/1853))
+
+
 ## Changes in 0.27.7 (2024-05-01)
 
 No significant changes.

MatrixSDK.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "MatrixSDK"
-  s.version      = "0.27.7"
+  s.version      = "0.27.8"
   s.summary      = "The iOS SDK to build apps compatible with Matrix (https://www.matrix.org)"
 
   s.description  = <<-DESC
@@ -45,7 +45,7 @@ Pod::Spec.new do |s|
       ss.dependency 'OLMKit', '~> 3.2.5'
       ss.dependency 'Realm', '10.27.0'
       ss.dependency 'libbase58', '~> 0.1.4'
-      ss.dependency 'MatrixSDKCrypto', '0.3.13', :configurations => ["DEBUG", "RELEASE"], :inhibit_warnings => true
+      ss.dependency 'MatrixSDKCrypto', '0.4.2', :configurations => ["DEBUG", "RELEASE"], :inhibit_warnings => true
   end
 
   s.subspec 'JingleCallStack' do |ss|

MatrixSDK/Crypto/Algorithms/RoomEvent/MXRoomEventDecryption.swift

@@ -227,12 +227,13 @@ actor MXRoomEventDecryption: MXRoomEventDecrypting {
             ])
             return trackedDecryptionResult(for: event, error: error)
 
-        case .MissingRoomKey(let message):
+        case .MissingRoomKey(let message, let withheldCode):
             if undecryptedEvents[sessionId] == nil {
                 log.error("Failed to decrypt event(s) due to missing room keys", context: [
                     "session_id": sessionId,
                     "message": message,
                     "error": error,
+                    "withheldCode": withheldCode ?? "N/A",
                     "details": "further errors for the same key will be supressed",
                 ])
             }

MatrixSDK/Crypto/CryptoMachine/MXCryptoMachine.swift

@@ -116,6 +116,10 @@ class MXCryptoMachine {
         }
     }
 
+    func invalidateCache() async {
+        await machine.clearCryptoCache()
+    }
+    
     // MARK: - Private
 
     private static func createMachine(userId: String, deviceId: String, log: MXNamedLog) throws -> OlmMachine {
@@ -591,9 +595,14 @@ extension MXCryptoMachine: MXCryptoCrossSigning {
 
     func bootstrapCrossSigning(authParams: [AnyHashable: Any]) async throws {
         let result = try machine.bootstrapCrossSigning()
+        // If this is called before the device keys have been uploaded there will be a
+        // request to upload them, do that first.
+        if let optionalKeyRequest = result.uploadKeysRequest {
+            try await handleRequest(optionalKeyRequest)
+        }
         let _ = try await [
             requests.uploadSigningKeys(request: result.uploadSigningKeysRequest, authParams: authParams),
-            requests.uploadSignatures(request: result.signatureRequest)
+            requests.uploadSignatures(request: result.uploadSignatureRequest)
         ]
     }
 
@@ -833,7 +842,7 @@ extension MXCryptoMachine: MXCryptoBackup {
         guard let message = MXCryptoTools.canonicalJSONString(forJSON: object) else {
             throw Error.cannotSerialize
         }
-        return machine.sign(message: message)
+        return try machine.sign(message: message)
     }
 
     func backupRoomKeys() async throws {

MatrixSDK/Crypto/Dehydration/DehydrationService.swift

@@ -68,7 +68,7 @@ public class DehydrationService: NSObject {
             // Convert it back to Data
             let pickleKeyData = MXBase64Tools.data(fromBase64: base64PickleKey)
 
-            let rehydrationResult = await rehydrateDevice(pickleKeyData: [UInt8](pickleKeyData))
+            let rehydrationResult = await rehydrateDevice(pickleKeyData: pickleKeyData)
             switch rehydrationResult {
             case .success((let deviceId, let rehydratedDevice)):
                 // Fetch and process the to device events available on the dehydrated device
@@ -86,14 +86,15 @@ public class DehydrationService: NSObject {
             }
 
             // Finally, create a new dehydrated device with the same pickle key
-            try await dehydrateDevice(pickleKeyData: [UInt8](pickleKeyData))
+            try await dehydrateDevice(pickleKeyData: pickleKeyData)
         } else { // Otherwise, generate a new dehydration pickle key, store it and dehydrate a device
             // Generate a new dehydration pickle key
-            var pickleKeyData = [UInt8](repeating: 0, count: 32)
-            _ = SecRandomCopyBytes(kSecRandomDefault, 32, &pickleKeyData)
+            var pickleKeyRaw = [UInt8](repeating: 0, count: 32)
+            _ = SecRandomCopyBytes(kSecRandomDefault, 32, &pickleKeyRaw)
+            let pickleKeyData = Data(bytes: pickleKeyRaw, count: 32)
 
             // Convert it to unpadded base 64
-            let base64PickleKey = MXBase64Tools.unpaddedBase64(from: Data(bytes: pickleKeyData, count: 32))
+            let base64PickleKey = MXBase64Tools.unpaddedBase64(from: pickleKeyData)
 
             // Store it on the backend
             try await storeSecret(base64PickleKey, secretId: secretId, secretStorageKeys: [secretStorageKeyId: privateKeyData])
@@ -131,10 +132,10 @@ public class DehydrationService: NSObject {
 
     // MARK: - Device dehydration
 
-    private func dehydrateDevice(pickleKeyData: [UInt8]) async throws {
-        let dehydratedDevice = dehydratedDevices.create()
+    private func dehydrateDevice(pickleKeyData: Data) async throws {
+        let dehydratedDevice = try dehydratedDevices.create()
 
-        let requestDetails = try dehydratedDevice.keysForUpload(deviceDisplayName: deviceDisplayName, pickleKey: [UInt8](pickleKeyData))
+        let requestDetails = try dehydratedDevice.keysForUpload(deviceDisplayName: deviceDisplayName, pickleKey: pickleKeyData)
 
         let parameters = MXDehydratedDeviceCreationParameters()
         parameters.body = requestDetails.body
@@ -150,7 +151,7 @@ public class DehydrationService: NSObject {
         }
     }
 
-    private func rehydrateDevice(pickleKeyData: [UInt8]) async -> Result<(deviceId: String, rehydratedDevice: RehydratedDeviceProtocol), DehydrationServiceError>  {
+    private func rehydrateDevice(pickleKeyData: Data) async -> Result<(deviceId: String, rehydratedDevice: RehydratedDeviceProtocol), DehydrationServiceError>  {
         await withCheckedContinuation { continuation in
             self.restClient.retrieveDehydratedDevice { [weak self] dehydratedDevice in
                 guard let self else { return }
@@ -163,7 +164,7 @@ public class DehydrationService: NSObject {
                 }
 
                 do {
-                    let rehydratedDevice = try self.dehydratedDevices.rehydrate(pickleKey: [UInt8](pickleKeyData), deviceId: dehydratedDevice.deviceId, deviceData: deviceDataJSON)
+                    let rehydratedDevice = try self.dehydratedDevices.rehydrate(pickleKey: pickleKeyData, deviceId: dehydratedDevice.deviceId, deviceData: deviceDataJSON)
                     continuation.resume(returning: .success((dehydratedDevice.deviceId, rehydratedDevice)))
                 } catch {
                     continuation.resume(returning: .failure(DehydrationServiceError.failedRehydration(error)))

MatrixSDK/Crypto/MXCrypto.h

@@ -378,6 +378,8 @@ extern NSString *const MXDeviceListDidUpdateUsersDevicesNotification;
  */
 - (void)setBlacklistUnverifiedDevicesInRoom:(NSString *)roomId blacklist:(BOOL)blacklist;
 
+- (void) invalidateCache:(void (^)(void))done;
+
 @end
 
 NS_ASSUME_NONNULL_END

MatrixSDK/Crypto/MXCryptoV2.swift

@@ -20,6 +20,7 @@ import MatrixSDKCrypto
 /// An implementation of `MXCrypto` which uses [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk/tree/main/crates/matrix-sdk-crypto)
 /// under the hood.
 class MXCryptoV2: NSObject, MXCrypto {
+
     enum Error: Swift.Error {
         case cannotUnsetTrust
         case backupNotEnabled
@@ -720,4 +721,13 @@ class MXCryptoV2: NSObject, MXCrypto {
                 return dict[info.userId] = info
             }
     }
-}
+    
+    func invalidateCache(_ done: @escaping () -> Void) {
+        Task {
+            log.debug("Invalidating Olm Machine crypto store cache.")
+            await machine.invalidateCache()
+            await MainActor.run {
+                done()
+            }
+        }
+    }}

MatrixSDK/Crypto/Migration/Data/MXCryptoMigrationStore.swift

@@ -54,7 +54,7 @@ struct MXCryptoMigrationStore {
             account: try pickledAccount(pickleKey: pickleKey),
             sessions: [], // Sessions are extracted in batches separately
             inboundGroupSessions: [], // Group sessions are extracted in batches separately
-            pickleKey: [UInt8](pickleKey),
+            pickleKey: pickleKey,
             backupVersion: legacyStore.backupVersion,
             backupRecoveryKey: backupRecoveryKey(),
             crossSigning: crossSigning(),
@@ -194,7 +194,7 @@ private extension PickledAccount {
 private extension PickledSession {
     init(session: MXOlmSession, pickleKey: Data) throws {
         let pickle = try session.session.serializeData(withKey: pickleKey)
-        let time = "\(Int(session.lastReceivedMessageTs))"
+        let time = UInt64(session.lastReceivedMessageTs)
 
         self.init(
             pickle: pickle,

MatrixSDK/Data/RoomList/Common/MXRoomListDataSortable.swift

@@ -52,7 +52,7 @@ extension MXRoomListDataSortable {
 //        }
 
         if sortOptions.alphabetical {
-            result.append(NSSortDescriptor(keyPath: \MXRoomSummaryProtocol.displayName, ascending: true))
+            result.append(NSSortDescriptor(key: "displayName", ascending: true, selector: #selector(NSString.localizedStandardCompare(_:))))
         }
 
         if sortOptions.invitesFirst {

MatrixSDK/Data/RoomList/CoreData/MXCoreDataRoomListDataFetcher.swift

@@ -250,7 +250,7 @@ extension MXCoreDataRoomListDataFetcher: MXRoomListDataSortable {
         var result: [NSSortDescriptor] = []
 
         if sortOptions.alphabetical {
-            result.append(NSSortDescriptor(keyPath: \MXRoomSummaryMO.s_displayName, ascending: true))
+            result.append(NSSortDescriptor(key: "s_displayName", ascending: true, selector: #selector(NSString.localizedStandardCompare(_:))))
         }
 
         if sortOptions.invitesFirst {