Merge pull request #1676 from TheOneWithTheBraid/braid/sqflite-encryption-helper

feat: add SQfLite encryption helper

lib/matrix.dart

@@ -26,6 +26,7 @@ export 'src/database/database_api.dart';
 export 'src/database/hive_database.dart';
 export 'src/database/matrix_sdk_database.dart';
 export 'src/database/hive_collections_database.dart';
+export 'src/database/sqflite_encryption_helper.dart';
 export 'src/event.dart';
 export 'src/presence.dart';
 export 'src/event_status.dart';

lib/src/database/sqflite_encryption_helper.dart

@@ -0,0 +1,2 @@
+export 'sqflite_encryption_helper/stub.dart'
+    if (dart.library.io) 'sqflite_encryption_helper/io.dart';

lib/src/database/sqflite_encryption_helper/io.dart

@@ -0,0 +1,220 @@
+import 'dart:ffi';
+import 'dart:io';
+import 'dart:math' show max;
+
+import 'package:sqflite_common/sqlite_api.dart';
+import 'package:sqlite3/open.dart';
+
+import 'package:matrix/matrix.dart';
+
+/// A helper utility for SQfLite related encryption operations
+///
+/// * helps loading the required dynamic libraries - even on cursed systems
+/// * migrates unencrypted SQLite databases to SQLCipher
+/// * applies the PRAGMA key to a database and ensure it is properly loading
+class SQfLiteEncryptionHelper {
+  /// the factory to use for all SQfLite operations
+  final DatabaseFactory factory;
+
+  /// the path of the database
+  final String path;
+
+  /// the (supposed) PRAGMA key of the database
+  final String cipher;
+
+  const SQfLiteEncryptionHelper({
+    required this.factory,
+    required this.path,
+    required this.cipher,
+  });
+
+  /// Loads the correct [DynamicLibrary] required for SQLCipher
+  ///
+  /// To be used with `package:sqlite3/open.dart`:
+  /// ```dart
+  /// void main() {
+  ///   final factory = createDatabaseFactoryFfi(
+  ///     ffiInit: SQfLiteEncryptionHelper.ffiInit,
+  ///   );
+  /// }
+  /// ```
+  static void ffiInit() =>
+      () => open.overrideForAll(_loadSQLCipherDynamicLibrary);
+
+  static DynamicLibrary _loadSQLCipherDynamicLibrary() {
+    // Taken from https://github.com/simolus3/sqlite3.dart/blob/e66702c5bec7faec2bf71d374c008d5273ef2b3b/sqlite3/lib/src/load_library.dart#L24
+    if (Platform.isAndroid) {
+      try {
+        return DynamicLibrary.open('libsqlcipher.so');
+      } catch (_) {
+        // On some (especially old) Android devices, we somehow can't dlopen
+        // libraries shipped with the apk. We need to find the full path of the
+        // library (/data/data/<id>/lib/libsqlcipher.so) and open that one.
+        // For details, see https://github.com/simolus3/moor/issues/420
+        final appIdAsBytes = File('/proc/self/cmdline').readAsBytesSync();
+
+        // app id ends with the first \0 character in here.
+        final endOfAppId = max(appIdAsBytes.indexOf(0), 0);
+        final appId = String.fromCharCodes(appIdAsBytes.sublist(0, endOfAppId));
+
+        return DynamicLibrary.open('/data/data/$appId/lib/libsqlcipher.so');
+      }
+    }
+    if (Platform.isLinux) {
+      // *not my fault grumble*
+      //
+      // On many Linux systems, I encountered issues opening the system provided
+      // libsqlcipher.so. I hence decided to ship an own one - statically linked
+      // against a patched version of OpenSSL compiled with the correct options.
+      //
+      // This was the only way I reached to run on particular Fedora and Arch
+      // systems.
+      //
+      // Hours wasted : 12
+      try {
+        return DynamicLibrary.open('libsqlcipher_flutter_libs_plugin.so');
+      } catch (_) {
+        return DynamicLibrary.open('libsqlcipher.so');
+      }
+    }
+    if (Platform.isIOS) {
+      return DynamicLibrary.process();
+    }
+    if (Platform.isMacOS) {
+      return DynamicLibrary.open(
+          '/usr/lib/libsqlcipher_flutter_libs_plugin.dylib');
+    }
+    if (Platform.isWindows) {
+      return DynamicLibrary.open('libsqlcipher.dll');
+    }
+
+    throw UnsupportedError('Unsupported platform: ${Platform.operatingSystem}');
+  }
+
+  /// checks whether the database exists and is encrypted
+  ///
+  /// In case it is not encrypted, the file is being migrated
+  /// to SQLCipher and encrypted using the given cipher and checks
+  /// whether that operation was successful
+  Future<void> ensureDatabaseFileEncrypted() async {
+    final file = File(path);
+
+    // in case the file does not exist there is no need to migrate
+    if (!await file.exists()) {
+      return;
+    }
+
+    // no work to do in case the DB is already encrypted
+    if (!await _isPlainText(file)) {
+      return;
+    }
+
+    Logs().d(
+        'Warning: Found unencrypted sqlite database. Encrypting using SQLCipher.');
+
+    // hell, it's unencrypted. This should not happen. Time to encrypt it.
+    final plainDb = await factory.openDatabase(path);
+
+    final encryptedPath = '$path.encrypted';
+
+    await plainDb.execute(
+        "ATTACH DATABASE '$encryptedPath' AS encrypted KEY '$cipher';");
+    await plainDb.execute("SELECT sqlcipher_export('encrypted');");
+    // ignore: prefer_single_quotes
+    await plainDb.execute("DETACH DATABASE encrypted;");
+    await plainDb.close();
+
+    Logs().d('Migrated data to temporary database. Checking integrity.');
+
+    final encryptedFile = File(encryptedPath);
+    // we should now have a second file - which is encrypted
+    assert(await encryptedFile.exists());
+    assert(!await _isPlainText(encryptedFile));
+
+    Logs().d('New file encrypted. Deleting plain text database.');
+
+    // deleting the plain file and replacing it with the new one
+    await file.delete();
+    await encryptedFile.copy(path);
+    // delete the temporary encrypted file
+    await encryptedFile.delete();
+
+    Logs().d('Migration done.');
+  }
+
+  /// safely applies the PRAGMA key to a [Database]
+  ///
+  /// To be directly used as [OpenDatabaseOptions.onConfigure].
+  ///
+  /// * ensures PRAGMA is supported by the given [database]
+  /// * applies [cipher] as PRAGMA key
+  /// * checks whether this operation was successful
+  Future<void> applyPragmaKey(Database database) async {
+    final cipherVersion = await database.rawQuery('PRAGMA cipher_version;');
+    if (cipherVersion.isEmpty) {
+      // Make sure that we're actually using SQLCipher, since the pragma
+      // used to encrypt databases just fails silently with regular
+      // sqlite3
+      // (meaning that we'd accidentally use plaintext databases).
+      throw StateError(
+        'SQLCipher library is not available, '
+        'please check your dependencies!',
+      );
+    } else {
+      final version = cipherVersion.singleOrNull?['cipher_version'];
+      Logs().d(
+          'PRAGMA supported by bundled SQLite. Encryption supported. SQLCipher version: $version.');
+    }
+
+    final result = await database.rawQuery("PRAGMA KEY='$cipher';");
+    assert(result.single['ok'] == 'ok');
+  }
+
+  /// checks whether a File has a plain text SQLite header
+  Future<bool> _isPlainText(File file) async {
+    final raf = await file.open();
+    final bytes = await raf.read(15);
+    await raf.close();
+
+    const header = [
+      83,
+      81,
+      76,
+      105,
+      116,
+      101,
+      32,
+      102,
+      111,
+      114,
+      109,
+      97,
+      116,
+      32,
+      51,
+    ];
+
+    return _listEquals(bytes, header);
+  }
+
+  /// Taken from `package:flutter/foundation.dart`;
+  ///
+  /// Compares two lists for element-by-element equality.
+  bool _listEquals<T>(List<T>? a, List<T>? b) {
+    if (a == null) {
+      return b == null;
+    }
+    if (b == null || a.length != b.length) {
+      return false;
+    }
+    if (identical(a, b)) {
+      return true;
+    }
+    for (int index = 0; index < a.length; index += 1) {
+      if (a[index] != b[index]) {
+        return false;
+      }
+    }
+    return true;
+  }
+}

lib/src/database/sqflite_encryption_helper/stub.dart

@@ -0,0 +1,53 @@
+import 'package:sqflite_common/sqlite_api.dart';
+
+/// A helper utility for SQfLite related encryption operations
+///
+/// * helps loading the required dynamic libraries - even on cursed systems
+/// * migrates unencrypted SQLite databases to SQLCipher
+/// * applies the PRAGMA key to a database and ensure it is properly loading
+class SQfLiteEncryptionHelper {
+  /// the factory to use for all SQfLite operations
+  final DatabaseFactory factory;
+
+  /// the path of the database
+  final String path;
+
+  /// the (supposed) PRAGMA key of the database
+  final String cipher;
+
+  const SQfLiteEncryptionHelper({
+    required this.factory,
+    required this.path,
+    required this.cipher,
+  });
+
+  /// Loads the correct [DynamicLibrary] required for SQLCipher
+  ///
+  /// To be used with `package:sqlite3/open.dart`:
+  /// ```dart
+  /// void main() {
+  ///   final factory = createDatabaseFactoryFfi(
+  ///     ffiInit: SQfLiteEncryptionHelper.ffiInit,
+  ///   );
+  /// }
+  /// ```
+  static void ffiInit() => throw UnimplementedError();
+
+  /// checks whether the database exists and is encrypted
+  ///
+  /// In case it is not encrypted, the file is being migrated
+  /// to SQLCipher and encrypted using the given cipher and checks
+  /// whether that operation was successful
+  Future<void> ensureDatabaseFileEncrypted() async =>
+      throw UnimplementedError();
+
+  /// safely applies the PRAGMA key to a [Database]
+  ///
+  /// To be directly used as [OpenDatabaseOptions.onConfigure].
+  ///
+  /// * ensures PRAGMA is supported by the given [database]
+  /// * applies [cipher] as PRAGMA key
+  /// * checks whether this operation was successful
+  Future<void> applyPragmaKey(Database database) async =>
+      throw UnimplementedError();
+}

pubspec.yaml

@@ -30,6 +30,7 @@ dependencies:
   sdp_transform: ^0.3.2
   slugify: ^2.0.0
   sqflite_common: ^2.4.5
+  sqlite3: ^2.1.0
   typed_data: ^1.3.2
   webrtc_interface: ^1.0.13