Skip to content

Document SQLCipher for Dart #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
simolus3 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document SQLCipher for Dart #513

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions client-sdks/advanced/data-encryption.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@

<Accordion title="Dart/Flutter" icon="flutter">

The PowerSync SDK supports [SQLite3MultipleCiphers](https://utelle.github.io/SQLite3MultipleCiphers)
on all native platforms and the web, which can be used to encrypt databases.
The PowerSync Dart SDK provides multiple options for client-side encryption:

1. [SQLite3MultipleCiphers](https://utelle.github.io/SQLite3MultipleCiphers), which is available both on native platforms and the web.
2. [SQLCipher Community Edition](https://www.zetetic.net/sqlcipher/), available on native platforms only.

<Note>Setting up encryption has changed in version 2.0 of the PowerSync SDK. When upgrading, follow these steps and remove dependencies on `powersync_sqlcipher`.</Note>

Check warning on line 21 in client-sdks/advanced/data-encryption.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdks/advanced/data-encryption.mdx#L21 

Did you really mean 'powersync_sqlcipher'?

To enable encryption, pass an instance of `EncryptionOptions` to a `PowerSyncDatabase` constructor:

Expand All @@ -38,10 +40,18 @@
user_defines:
sqlite3:
# Bundle and load SQLite3MultipleCiphers instead of SQLite for encryption.
source: sqlite3mc
source: sqlite3mc # alternatively, pass sqlcipher instead.
```

<Warning>If you're using [pub workspaces](https://dart.dev/tools/pub/workspaces), this needs to be added to the root `pubspec.yaml`, not the one for your app.</Warning>
<Warning>
If you're using [pub workspaces](https://dart.dev/tools/pub/workspaces), this needs to be added to the root `pubspec.yaml`, not the one for your app.

Not sure whether to use SQLCipher or SQLite3MultipleCiphers? Consider this:

1. SQLite3MultipleCiphers is the only option on the web, using it for native targets ensures consistency.
2. SQLCipher can be more performant because it links OpenSSL / `Security.framework` on Apple targets instead of using a builtin implementation.
Using operating system libraries also makes it easier to comply with [export regulations](https://developer.apple.com/documentation/security/complying-with-encryption-export-regulations).
</Warning>

On the web, enabling encryption requires SQLite3MultipleCiphers as well. [PowerSync releases](https://github.com/powersync-ja/powersync.dart/releases)
have a `sqlite3mc.wasm` file attached to them, which can be downloaded to `web/sqlite3.wasm` to add encryption
Expand Down