redbx 3.2.0

Rust Embedded DataBase with AES Encryption - Fork of redb
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

# redbx

[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)](https://crates.io/crates/redbx)

A simple, portable, high-performance, ACID, embedded key-value store with built-in AES encryption.

redbx is a fork of [redb](https://github.com/cberner/redb) that provides transparent encryption for all user data. It's written in pure Rust
and is loosely inspired by [lmdb](http://www.lmdb.tech/doc/). Data is stored in a collection of copy-on-write
B-trees with AES-256-GCM encryption. For more details, see the [design doc](docs/redbx-design.md)

## Key Features

- **Built-in AES-256-GCM encryption** for all user data
- **PBKDF2-SHA256 key derivation** with 100,000 iterations
- **Transparent encryption/decryption** at the storage layer
- Zero-copy, thread-safe, `BTreeMap` based API
- Fully ACID-compliant transactions
- MVCC support for concurrent readers & writers, without blocking
- Crash-safe by default
- Savepoints and rollbacks

```rust
use redbx::{Database, Error, ReadableDatabase, TableDefinition};

const TABLE: TableDefinition<&str, u64> = TableDefinition::new("my_data");

fn main() -> Result<(), Error> {
    // Create an encrypted database with a password
    let db = Database::create("my_db.redbx", "my_secure_password")?;
    let write_txn = db.begin_write()?;
    {
        let mut table = write_txn.open_table(TABLE)?;
        table.insert("my_key", &123)?;
    }
    write_txn.commit()?;

    drop(db);

    // Open the encrypted database with the same password
    let db = Database::open("my_db.redbx", "my_secure_password")?;
    let read_txn = db.begin_read()?;
    let table = read_txn.open_table(TABLE)?;
    println!("{:?}",table.get("my_key")?.unwrap().value());

    Ok(())
}
```

## Features
* Zero-copy, thread-safe, `BTreeMap` based API
* Fully ACID-compliant transactions
* MVCC support for concurrent readers & writer, without blocking
* Crash-safe by default
* Savepoints and rollbacks
* **Built-in AES-256-GCM encryption** for all user data
* **PBKDF2-SHA256 key derivation** with 100,000 iterations
* **Transparent encryption/decryption** at the storage layer

## Development
To run all the tests and benchmarks a few extra dependencies are required:

```bash
# Install dependencies
sudo apt-get install libclang-dev

# Run tests
cargo test

# Run benchmarks
cd crates/redbx-bench
cargo bench --bench encryption_overhead_benchmark
```

## Known problem

- lack of performance, work in progress.

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Security

redbx uses industry-standard cryptographic algorithms:
- **AES-256-GCM** for authenticated encryption
- **PBKDF2-SHA256** with 100,000 iterations for key derivation
- **Cryptographically secure random** salt generation

All user data is encrypted at rest, while metadata remains unencrypted for performance and debugging purposes.

## Migration from redb

redbx is designed to be a drop-in replacement for redb with the addition of password-based encryption:

```rust
// redb (unencrypted)
let db = Database::create("db.redb")?;

// redbx (encrypted)
let db = Database::create("db.redbx", "password")?;
```

The API is otherwise identical, making migration straightforward.