AMT-Cheif
/
drift
mirror of https://github.com/AMT-Cheif/drift.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve docs on encryption

This commit is contained in:
Simon Binder 2021-02-15 19:57:53 +01:00
parent b0887a9fec
commit b8b72a1570
No known key found for this signature in database
GPG Key ID: 7891917E4147B8C0
1 changed files with 26 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/content/en/docs/Other engines/encryption.md
View File

@ -3,10 +3,17 @@ title: Encryption
description: Use moor on encrypted databases description: Use moor on encrypted databases
--- ---
There are two ways to use moor on encrypted databases.
The `encrypted_moor` package is similar to `moor_flutter` and uses a platform plugin written in
Java.
Alternatively, you can use the ffi-based implementation with the `sqlcipher_flutter_libs` package.
## Using `encrypted_moor`
Starting from 1.7, we have a version of moor that can work with encrypted databases by using the Starting from 1.7, we have a version of moor that can work with encrypted databases by using the
[sqflite_sqlcipher](https://pub.dev/packages/sqflite_sqlcipher) library [sqflite_sqlcipher](https://pub.dev/packages/sqflite_sqlcipher) library
by [@davidmartos96](https://github.com/davidmartos96). To use it, you need to by [@davidmartos96](https://github.com/davidmartos96). To use it, you need to
remove the dependency on `moor_flutter` and `moor_ffi` from your `pubspec.yaml` and replace it remove the dependency on `moor_flutter` from your `pubspec.yaml` and replace it
with this: with this:
```yaml ```yaml
dependencies: dependencies:
@ -17,12 +24,12 @@ dependencies:
path: extras/encryption path: extras/encryption
``` ```
Instead of importing `package:moor_flutter/moor_flutter` in your apps, you would then import Instead of importing `package:moor_flutter/moor_flutter` (or `package:moor/ffi.dart`) in your apps,
both `package:moor/moor.dart` and `package:encrypted_moor/encrypted_moor.dart`. you would then import both `package:moor/moor.dart` and `package:encrypted_moor/encrypted_moor.dart`.
Finally, you can replace `FlutterQueryExecutor` with an `EncryptedExecutor`. Finally, you can replace `FlutterQueryExecutor` (or an `VmDatabase`) with an `EncryptedExecutor`.
## Extra setup on Android and iOS ### Extra setup on Android and iOS
Some extra steps may have to be taken in your project so that SQLCipher works correctly. For example, the ProGuard configuration on Android for apps built for release. Some extra steps may have to be taken in your project so that SQLCipher works correctly. For example, the ProGuard configuration on Android for apps built for release.
@ -50,4 +57,17 @@ VmDatabase(
rawDb.execute("PRAGMA key = 'passphrase';"); rawDb.execute("PRAGMA key = 'passphrase';");
} }
); );
``` ```
On Android, you also need to adapt the opening behavior of the `sqlite3` package to use the encrypted library instead
of the regular `libsqlite3.so`:
```dart
import 'package:sqlite3/open.dart';
// call this method before using moor
void setupSqlcipher() {
open.overrideFor(
OperatingSystem.android, () => DynamicLibrary.open('libsqlcipher.so'));
}
```