Skip to content

Commit 7aae51a

Browse files
committed
v2.0.0 preparation
1 parent 5c1fdf1 commit 7aae51a

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

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 = "clatter"
3-
version = "2.0.0-rc.3"
3+
version = "2.0.0"
44
edition = "2021"
55
rust-version = "1.81.0"
66
license = "MIT"

src/lib.rs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010
//! with support for [**Post Quantum (PQ) extensions**](https://doi.org/10.1145/3548606.3560577) as presented by
1111
//! Yawning Angel, Benjamin Dowling, Andreas Hülsing, Peter Schwabe, and Fiona Johanna Weber.
1212
//!
13+
//! ⚠️ **Warning** ⚠️
14+
//!
15+
//! Clatter is a low-level crate that does not provide much guidance on the security aspects of the protocol(s)
16+
//! you develop using it. Clatter itself is safe and sound but can easily be used in many unreliable ways.
17+
//! Solid understanding of cryptography is required.
18+
//!
1319
//! From user perspective, everything in this crate is built around three types:
1420
//!
1521
//! * [`NqHandshake`] - Classical, non-post-quantum Noise handshake
@@ -28,7 +34,7 @@
2834
//! Handshake messages are exchanged by the peers until the handshake is completed.
2935
//! After completion, [`Handshaker::finalize`] is called and the handshake state machine
3036
//! is consumed into a [`transportstate::TransportState`] instance, which can be used
31-
//! to decrypt and encrypt communication between the peers.
37+
//! to encrypt and decrypt communication between the peers.
3238
//!
3339
//! ## Handshake Patterns
3440
//!
@@ -37,8 +43,8 @@
3743
//!
3844
//! ## Crypto Vendors
3945
//!
40-
//! Currently Clatter has frozen the vendor selection for DH, Cipher and Hash algorithms, but users
41-
//! can select from multiple KEM vendors.
46+
//! Currently Clatter has frozen the available selection of DH, Cipher and Hash algorithms, but users
47+
//! of Clatter can select from multiple KEM vendors.
4248
//!
4349
//! Concrete implementations of the crypto algorithms are in the [`crypto`] module and it is even
4450
//! possible to use custom implementations using the definitions in the [`traits`] module.

0 commit comments

Comments
 (0)