Skip to content

Commit

Permalink
fix: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
elribonazo committed Dec 23, 2024
1 parent e366d5d commit 8537f21
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,28 @@
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
</p>


### Security
We take security very seriously and have implemented robust measures to ensure data protection. Below are the specifications for our security features:

| Feature | Description |
|--------------------------------|-----------------------------------------------------------------------------|
| **Password Hashing** | We use PBKDF2 (Password-Based Key Derivation Function 2) with HMAC-SHA3-256 for password hashing. This method involves multiple iterations to enhance security against brute-force attacks. [Learn more about PBKDF2](https://tools.ietf.org/html/rfc8018#section-5.2) |
| **Encryption** | Data is encrypted using AES-256-GCM (Advanced Encryption Standard with Galois/Counter Mode), which provides both confidentiality and integrity. [Learn more about AES-GCM](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf) |
| **Integrity** | We ensure data integrity by hashing data with SHA3-512 and comparing it with the stored hash to detect any tampering. [Learn more about SHA-3](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf) |

### Supported features
By default RIDB is bundled with a default InMemory storage with support for write, create, update, fetch one, remove, find and count operations.

| Feature | Description |
|--------------------------------|-----------------------------------------------------------------------------|
| **Schemas** | Creation of declarative schemas with required fields, default and encrypted fields |
| **Validation** | Implement validation across all the flows extracting properties and required fields when needed |
| **Primary Key Management** | Primary key and index management |
| **Plugin Engine** | Extend the functionality of your Database implementation with wasm or Javascript plugins |
| **Data Encryption Plugin** | Secure data with encryption plugins |
| **Migration Plugin** | Support for data migrations |
| **Integrity Plugin** | Support for data has not been tampered with |
| **IndexDB Storage** | Robust type safe replacement for Dexie

## Install
In order to install simply run the following command
Expand Down

0 comments on commit 8537f21

Please sign in to comment.