This repository has been archived by the owner on Jan 1, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2b8502b
commit 57b6dff
Showing
1 changed file
with
78 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,90 @@ | ||
| # @pluto-encrypted/leveldb | ||
| This package contains a RXDB compatible wrapper over leveldb and can be used as database engine inside @pluto-encrypted package with secure database encryption. | ||
|
|
||
| ### Documentation | ||
| [@Pluto-encrypted REFERENCE](https://github.com/elribonazo/pluto-encrypted/blob/master/docs/README.md) | ||
| ## Overview | ||
|
|
||
| ### How to use | ||
| `@pluto-encrypted/leveldb` provides a secure, encrypted storage solution for RxDB using LevelDB. By integrating encryption middleware, this package ensures data security and confidentiality while leveraging LevelDB's persistence features. It is ideal for applications that require robust and secure storage capabilities. | ||
|
|
||
| Creating a levelDB compatible storage is very simple. | ||
| This package uses `@pluto-encrypted/encryption` to wrap LevelDB with encryption, allowing for seamless integration with RxDB-based applications. | ||
|
|
||
| ## Installation | ||
|
|
||
| To install the `@pluto-encrypted/leveldb` package, use npm or yarn: | ||
|
|
||
| ```bash | ||
| npm install @pluto-encrypted/leveldb | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ```bash | ||
| yarn add @pluto-encrypted/leveldb | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Initialization | ||
|
|
||
| To use `@pluto-encrypted/leveldb` with RxDB, you need to create an encrypted LevelDB storage instance. Below is an example of how to set it up: | ||
|
|
||
| ```typescript | ||
| import { createLevelDBStorage } from "@pluto-encrypted/leveldb"; | ||
| import { Database } from "@pluto-encrypted/database"; | ||
| //default password must be 32 bytes long | ||
| import { createLevelDBStorage } from '@pluto-encrypted/leveldb'; | ||
| import { Database } from '@pluto-encrypted/database'; | ||
|
|
||
| // Ensure the default password is 32 bytes long | ||
| const defaultPassword = new Uint8Array(32).fill(1); | ||
| const database = db = await Database.createEncrypted( | ||
| { | ||
| name: `my-db`, | ||
| encryptionKey: defaultPassword, | ||
| storage: createLevelDBStorage({ | ||
| dbName: "demo", | ||
| dbPath: "/tmp/demo" | ||
| }), | ||
| } | ||
| ); | ||
|
|
||
| const database = await Database.createEncrypted({ | ||
| name: 'my-db', | ||
| encryptionKey: defaultPassword, | ||
| storage: createLevelDBStorage({ | ||
| dbName: 'demo', | ||
| dbPath: '/tmp/demo' // Adjust the path as needed | ||
| }) | ||
| }); | ||
| ``` | ||
|
|
||
| ### Using with Atala Prism Wallet SDK | ||
|
|
||
| Here’s how to integrate `@pluto-encrypted/leveldb` with the Atala Prism Wallet SDK: | ||
|
|
||
| ```typescript | ||
| import { Agent, Domain, Store, Apollo, Pluto } from '@atala/prism-wallet-sdk'; | ||
| import { createLevelDBStorage } from '@pluto-encrypted/leveldb'; | ||
|
|
||
| const mediatorDIDString = 'your-mediator-did-string'; // Replace with your actual mediator DID string | ||
| const mediatorDID = Domain.DID.fromString(mediatorDIDString); | ||
|
|
||
| const store = new Store({ | ||
| name: 'my-app-db', | ||
| storage: createLevelDBStorage({ | ||
| dbName: 'my-app-db', | ||
| dbPath: '/path/to/db' | ||
| }), | ||
| password: 'something secure 1235!' // Use a secure password | ||
| }); | ||
| const apollo = new Apollo(); | ||
| const pluto = new Pluto(store, apollo); | ||
|
|
||
| const agent = Agent.initialize({ mediatorDID, pluto, apollo }); | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions! Please read our [Contributing Guide](https://github.com/atala-community-projects/pluto-encrypted/blob/master/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full terms and conditions. | ||
|
|
||
| ## Support | ||
|
|
||
| If you have any questions or need help, feel free to open an issue on our [GitHub repository](https://github.com/atala-community-projects/pluto-encrypted/issues). | ||
|
|
||
| --- | ||
|
|
||
| ## QA & Documentation | ||
| | Statements | Branches | Functions | Lines | | ||
| | --------------------------- | ----------------------- | ------------------------- | ----------------- | | ||
| |  |  |  |  | | ||
| |  |  |  |  | | ||
|
|
||
| --- |