Skip to content

Commit 4d6690b

Browse files
authored
Mention web encryption (#135)
* Mention web encryption * Add encryption to SDK sidebars * Reword
1 parent 0f943b2 commit 4d6690b

File tree

6 files changed

+36
-6
lines changed

6 files changed

+36
-6
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Encryption
3+
url: /usage/use-case-examples/data-encryption
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Encryption
3+
url: /usage/use-case-examples/data-encryption
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Encryption
3+
url: /usage/use-case-examples/data-encryption
4+
---

mint.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,7 @@
290290
"client-sdk-references/flutter/flutter-orm-support",
291291
"client-sdk-references/flutter/usage-examples",
292292
"client-sdk-references/flutter/unit-testing",
293+
"client-sdk-references/flutter/encryption",
293294
"client-sdk-references/flutter/api-reference"
294295
]
295296
},
@@ -301,6 +302,7 @@
301302
"client-sdk-references/react-native-and-expo/react-native-web-support",
302303
"client-sdk-references/react-native-and-expo/javascript-orm-support",
303304
"client-sdk-references/react-native-and-expo/usage-examples",
305+
"client-sdk-references/react-native-and-expo/encryption",
304306
"client-sdk-references/react-native-and-expo/api-reference"
305307
]
306308
},
@@ -319,6 +321,7 @@
319321
},
320322
"client-sdk-references/javascript-web/javascript-spa-frameworks",
321323
"client-sdk-references/javascript-web/usage-examples",
324+
"client-sdk-references/javascript-web/encryption",
322325
"client-sdk-references/javascript-web/api-reference"
323326
]
324327
},

resources/demo-apps-example-projects.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ Example projects are listed under backend they use, but you can easily wire up y
6363
* [example-nextjs](https://github.com/powersync-ja/powersync-js/blob/main/demos/example-nextjs/README.md): A minimal example demonstrating setup with [Next.js](https://nextjs.org/).
6464
* [example-webpack](https://github.com/powersync-ja/powersync-js/blob/main/demos/example-webpack/README.md): A minimal example demonstrating bundling with [Webpack](https://webpack.js.org/).
6565
* [example-vite](https://github.com/powersync-ja/powersync-js/blob/main/demos/example-vite/README.md): A minimal example demonstrating bundling with [Vite](https://vitejs.dev/).
66+
67+
#### Other
68+
* [example-vite-encryption](https://github.com/powersync-ja/powersync-js/blob/main/demos/example-vite-encryption/README.md): A minimal example demonstrating encryption of the web database.
6669
</Accordion>
6770

6871
<Accordion title="Node.js (alpha)" icon="node-js">

usage/use-case-examples/data-encryption.mdx

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@ Data is always encrypted in transit using TLS — both between the client and Po
88

99
### At Rest Encryption
1010

11-
The client-side database can be encrypted at rest using [SQLCipher](https://www.zetetic.net/sqlcipher/).
12-
13-
This is currently available for:
11+
The client-side database can be encrypted at rest. This is currently available for:
1412

1513
<Accordion title="Flutter" icon="flutter">
16-
SQLCipher support is available for Flutter through the `powersync_sqlcipher` SDK. See usage details in the package README:
14+
[SQLCipher](https://www.zetetic.net/sqlcipher/) support is available for Flutter through the `powersync_sqlcipher` SDK. See usage details in the package README:
1715

1816
<Card
1917
title="powersync_sqlcipher"
@@ -24,7 +22,7 @@ SQLCipher support is available for Flutter through the `powersync_sqlcipher` SDK
2422
</Accordion>
2523

2624
<Accordion title="React Native & Expo" icon="react">
27-
SQLCipher support is available for React Native through the `@powersync/op-sqlite` package. See usage details in the package README:
25+
[SQLCipher](https://www.zetetic.net/sqlcipher/) support is available for PowerSync's React Native SDK through the `@powersync/op-sqlite` package. See usage details in the package README:
2826

2927
<Card
3028
title="npm: @powersync/op-sqlite"
@@ -34,9 +32,23 @@ SQLCipher support is available for Flutter through the `powersync_sqlcipher` SDK
3432
/>
3533
</Accordion>
3634

35+
<Accordion title="JavaScript Web" icon="js">
36+
The Web SDK uses the [ChaCha20 cipher algorithm by default](https://utelle.github.io/SQLite3MultipleCiphers/docs/ciphers/cipher_chacha20/). See usage details in the package README:
37+
38+
<Card
39+
title="npm: @powersync/web"
40+
icon="npm"
41+
href="https://www.npmjs.com/package/@powersync/web"
42+
horizontal
43+
/>
44+
Additionally, a minimal example demonstrating encryption of the web database is available [here](https://github.com/powersync-ja/powersync-js/tree/main/demos/example-vite-encryption).
45+
</Accordion>
46+
47+
<Note>
48+
Support for encryption on other platforms is planned. In the meantime, let us know your needs and use cases on [Discord](https://discord.gg/powersync).
49+
</Note>
3750

3851

39-
Support for SQLCipher on other platforms is planned. In the meantime, let us know with your needs and use cases on [Discord](https://discord.gg/powersync).
4052

4153
### End-to-end Encryption
4254

0 commit comments

Comments
 (0)