Skip to content

Commit 4019eb2

Browse files
committed
docs
1 parent 1722155 commit 4019eb2

3 files changed

Lines changed: 6 additions & 10 deletions

File tree

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rencrypt"
3-
version = "1.0.0"
3+
version = "1.0.1"
44
edition = "2021"
55

66
[lib]

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -335,10 +335,6 @@ If you can directly collect the data to that buffer, like `BufferedReader.read_i
335335

336336
On each encrypt operation (`seal_in_place*()`) it will generate a cryptographically secure random nonce using `ChaCha20`. You can also provide your own nonce, there is an example below.
337337

338-
## Encryption provider
339-
340-
You will notice in the examples we initiate the `Cipher` from something like this `cipher_meta = CipherMeta.Ring(RingAlgorithm.Aes256Gcm)`. The first part `CipherMeta.Ring` is the encryption provider, for now it's only one but in the future we will add more. The last part is the algorithm for that provider, in this case `Aes256Gcm`. Each provier might expose specific algorithms.
341-
342338
# Security
343339

344340
- **The total number of invocations of the encryption functions (`seal_in_place*()`) shall not exceed `2^32`, including all nonce lengths and all instances of `Cipher` with the given key. Following this guideline, only `4,294,967,296` messages with random nonces can be encrypted under a given key. While this bound is high, it's possible to encounter in practice, and systems which might reach it should consider alternatives to purely random nonces, like a counter or a combination of a random nonce + counter.**
@@ -349,11 +345,11 @@ You will notice in the examples we initiate the `Cipher` from something like thi
349345

350346
In the examples below you will see how to do it.
351347

352-
# Providers and Algorithms (Ciphes)
348+
# Encryption providers and algorithms (ciphes)
353349

354-
## Availbale providers and algorithms
350+
You will notice in the examples we initiate the `Cipher` from something like this `cipher_meta = CipherMeta.Ring(RingAlgorithm.Aes256Gcm)`. The first part `CipherMeta.Ring` is the encryption provider. The last part is the algorithm for that provider, in this case `Aes256Gcm`. Each provier might expose specific algorithms.
355351

356-
### Providers
352+
## Providers
357353

358354
```rust
359355
enum CipherMeta {
@@ -373,7 +369,7 @@ enum CipherMeta {
373369
[Sodium](https://github.com/jedisct1/libsodium) is a portable, cross-compilable, installable, packageable fork of NaCl (based on the latest released upstream version nacl-20110221), with a compatible API.
374370
- `Orion`: Based on [orion](https://crates.io/crates/orion) crate. Written in pure Rust, it aims to provide easy and usable crypto while trying to minimize the use of unsafe code. You can read more about Orion in the [wiki](https://github.com/orion-rs/orion/wiki).
375371

376-
### Algorithms
372+
## Algorithms
377373

378374
```rust
379375
enum RingAlgorithm {

0 commit comments

Comments
 (0)