ncrypt-me 0.1.22

Dead simple encryption library
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

# ncrypt_me - Secure Data Encryption


## How the Data is Encrypted

Given some `Credentials` (username and password):

- **Hashing**: Both the password and username are hashed using **Argon2**.
  - The resulting hash of the **password** is used as the **key** for the **XChaCha20Poly1305** cipher.
  - The resulting hash of the **username** is used as the **Additional Authenticated Data (AAD)** for the cipher.

- **Encryption**: With the key and AAD set, the data is encrypted using the **XChaCha20Poly1305** cipher.

- **Output**: The encrypted data is then returned.

### Example


```rust
use ncrypt_me::{encrypt_data, decrypt_data, Credentials, Argon2, secure_types::{SecureString, SecureBytes}};

let exposed_data: Vec<u8> = vec![1, 2, 3, 4];
let credentials = Credentials::new(
 SecureString::from("username"),
 SecureString::from("password"),
 SecureString::from("password"),
 );

let argon_params = Argon2::very_fast();
let secure_data = SecureBytes::from_vec(exposed_data.clone()).unwrap();
let encrypted_data = encrypt_data(argon_params, secure_data, credentials.clone()).unwrap();

let decrypted_data = decrypt_data(encrypted_data, credentials).unwrap();

decrypted_data.slice_scope(|decrypted_slice| {
  assert_eq!(exposed_data, decrypted_slice);
});
```


### Extracting the Encrypted Info (if needed)

The Encrypted Info contains the following information:
- Password Salt used for the password hashing
- Username Salt used for the username hashing
- Cipher Nonce used for the XChaCha20Poly1305 cipher
- Argon2 Parameters used for the username & password hashing

```rust
use ncrypt_me::EncryptedInfo;

let info = EncryptedInfo::from_encrypted_data(&encrypted_data).unwrap();

```