Fail launch when unavailable crypto

MatrixSDK/Crypto/MXCrypto.h

@@ -396,17 +396,20 @@ MX_ASSUME_MISSING_NULLABILITY_BEGIN
  Create a new crypto instance and data for the given user.
 
  @param mxSession the session on which to enable crypto.
+ @param error pointer to error that is non-nil if crypto failed to be created
  @return the fresh crypto instance.
  */
-+ (id<MXCrypto>)createCryptoWithMatrixSession:(MXSession*)mxSession;
++ (id<MXCrypto>)createCryptoWithMatrixSession:(MXSession*)mxSession
+                                        error:(NSError **)error;
 
 /**
  Check if the user has previously enabled crypto.
  If yes, init the crypto module.
 
  @param complete a block called in any case when the operation completes.
  */
-+ (void)checkCryptoWithMatrixSession:(MXSession*)mxSession complete:(void (^)(id<MXCrypto> crypto))complete;
++ (void)checkCryptoWithMatrixSession:(MXSession*)mxSession
+                            complete:(void (^)(id<MXCrypto> crypto, NSError *error))complete;
 
 /**
  Stores the exportedOlmDevice related to the credentials into the store.

MatrixSDK/Crypto/MXCrypto.m

@@ -151,15 +151,16 @@ @implementation MXLegacyCrypto
 @synthesize recoveryService = _recoveryService;
 
 + (id<MXCrypto>)createCryptoWithMatrixSession:(MXSession *)mxSession
+                                        error:(NSError **)error
 {
     __block id<MXCrypto> crypto;
 
 #ifdef MX_CRYPTO
 
     #if DEBUG
-    id<MXCrypto> cryptoV2 = [self createCryptoV2IfAvailableWithSession:mxSession];
-    if (cryptoV2) {
-        return cryptoV2;
+    if (MXSDKOptions.sharedInstance.enableCryptoV2)
+    {
+        return [self createCryptoV2WithSession:mxSession error:error];
     }
     #endif
 
@@ -176,14 +177,16 @@ @implementation MXLegacyCrypto
     return crypto;
 }
 
-+ (void)checkCryptoWithMatrixSession:(MXSession*)mxSession complete:(void (^)(id<MXCrypto> crypto))complete
++ (void)checkCryptoWithMatrixSession:(MXSession *)mxSession
+                            complete:(void (^)(id<MXCrypto> crypto, NSError *error))complete
 {
 #ifdef MX_CRYPTO
     #if DEBUG
-    id<MXCrypto> cryptoV2 = [self createCryptoV2IfAvailableWithSession:mxSession];
-    if (cryptoV2)
+    if (MXSDKOptions.sharedInstance.enableCryptoV2)
     {
-        complete(cryptoV2);
+        NSError *error;
+        id<MXCrypto> crypto = [self createCryptoV2WithSession:mxSession error:&error];
+        complete(crypto, error);
         return;
     }
     #endif
@@ -194,7 +197,7 @@ + (void)checkCryptoWithMatrixSession:(MXSession*)mxSession complete:(void (^)(id
 #endif
 }
 
-+ (void)checkLegacyCryptoWithMatrixSession:(MXSession*)mxSession complete:(void (^)(id<MXCrypto> crypto))complete
++ (void)checkLegacyCryptoWithMatrixSession:(MXSession*)mxSession complete:(void (^)(id<MXCrypto> crypto, NSError *error))complete
 {
 #ifdef MX_CRYPTO
 
@@ -220,15 +223,15 @@ + (void)checkLegacyCryptoWithMatrixSession:(MXSession*)mxSession complete:(void
                 id<MXCrypto> crypto = [[MXLegacyCrypto alloc] initWithMatrixSession:mxSession cryptoQueue:cryptoQueue andStore:cryptoStore];
 
                 dispatch_async(dispatch_get_main_queue(), ^{
-                    complete(crypto);
+                    complete(crypto, nil);
                 });
 
             } failure:^(NSError *error) {
 
                 MXLogDebug(@"[MXCrypto] checkCryptoWithMatrixSession: Crypto store failed to open. Error: %@", error);
 
                 dispatch_async(dispatch_get_main_queue(), ^{
-                    complete(nil);
+                    complete(nil, error);
                 });
             }];
         }
@@ -244,21 +247,21 @@ + (void)checkLegacyCryptoWithMatrixSession:(MXSession*)mxSession complete:(void
             id<MXCrypto> crypto = [[MXLegacyCrypto alloc] initWithMatrixSession:mxSession cryptoQueue:cryptoQueue andStore:cryptoStore];
 
             dispatch_async(dispatch_get_main_queue(), ^{
-                complete(crypto);
+                complete(crypto, nil);
             });
         }
         else
         {
             // Else do not enable crypto
             dispatch_async(dispatch_get_main_queue(), ^{
-                complete(nil);
+                complete(nil, nil);
             });
         }
 
     });
 
 #else
-    complete(nil);
+    complete(nil, nil);
 #endif
 }
 

MatrixSDK/Crypto/MXCryptoV2.swift

@@ -18,28 +18,28 @@ import Foundation
 
 #if DEBUG
 public extension MXLegacyCrypto {
-    /// Create a Rust-based work-in-progress implementation of `MXCrypto`
-    ///
-    /// The experimental crypto module is created only if:
-    /// - using DEBUG build
-    /// - enabling `enableCryptoV2` feature flag
-    @objc static func createCryptoV2IfAvailable(session: MXSession!) -> MXCrypto? {
-        let log = MXNamedLog(name: "MXCryptoV2")
+    enum CryptoError: Swift.Error, LocalizedError {
+        case cryptoNotAvailable
 
-        guard MXSDKOptions.sharedInstance().enableCryptoV2 else {
-            return nil
+        public var errorDescription: String? {
+            return "Encryption not available, please restart the app"
         }
-
+    }
+
+    /// Create a Rust-based work-in-progress implementation of `MXCrypto`
+    @objc static func createCryptoV2(session: MXSession!) throws -> MXCrypto {
+        let log = MXNamedLog(name: "MXCryptoV2")
+
         guard let session = session else {
             log.failure("Cannot create crypto V2, missing session")
-            return nil
+            throw CryptoError.cryptoNotAvailable
         }
-        
+
         do {
             return try MXCryptoV2(session: session)
         } catch {
             log.failure("Error creating crypto V2", context: error)
-            return nil
+            throw CryptoError.cryptoNotAvailable
         }
     }
 }

MatrixSDK/MXSession.m

@@ -121,7 +121,7 @@ The list of global events listeners (`MXSessionEventListener`).
      */
     NSMutableArray *globalEventListeners;
 
-    /** 
+    /**
      The block to call when MSSession resume is complete.
      */
     MXOnResumeDone onResumeDone;
@@ -398,9 +398,18 @@ -(void)setStore:(id<MXStore>)store success:(void (^)(void))onStoreDataReady fail
 
         // Check if the user has enabled crypto
         MXWeakify(self);
-        [MXLegacyCrypto checkCryptoWithMatrixSession:self complete:^(id<MXCrypto> crypto) {
+        [MXLegacyCrypto checkCryptoWithMatrixSession:self complete:^(id<MXCrypto> crypto, NSError *error) {
             MXStrongifyAndReturnIfNil(self);
 
+            if (!crypto && error)
+            {
+                if (failure)
+                {
+                    failure(error);
+                }
+                return;
+            }
+
             self->_crypto = crypto;
 
             // Sanity check: The session may be closed before the end of this operation.
@@ -966,6 +975,7 @@ - (void)_startWithSyncFilterId:(NSString *)syncFilterId onServerSyncDone:(void (
             MXLogDebug(@"[MXSession] Crypto has been started");
         }  failure:^(NSError *error) {
             MXLogDebug(@"[MXSession] Crypto failed to start. Error: %@", error);
+            failure(error);
         }];
     }
     else
@@ -2267,11 +2277,20 @@ - (void)enableCrypto:(BOOL)enableCrypto success:(void (^)(void))success failure:
 
     if (enableCrypto && !_crypto)
     {
-        _crypto = [MXLegacyCrypto createCryptoWithMatrixSession:self];
+        NSError *error;
+        _crypto = [MXLegacyCrypto createCryptoWithMatrixSession:self error:&error];
+        if (!_crypto && error)
+        {
+            if (failure)
+            {
+                failure(error);
+            }
+            return;
+        }
 
         if (_state == MXSessionStateRunning)
         {
-            [_crypto start:success failure:failure];
+            [self startCrypto:success failure:failure];
         }
         else
         {

changelog.d/pr-1646.change

@@ -0,0 +1 @@
+Crypto: Fail launch when unavailable crypto