|
10 | 10 | //! with support for [**Post Quantum (PQ) extensions**](https://doi.org/10.1145/3548606.3560577) as presented by |
11 | 11 | //! Yawning Angel, Benjamin Dowling, Andreas Hülsing, Peter Schwabe, and Fiona Johanna Weber. |
12 | 12 | //! |
| 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 | +//! |
13 | 19 | //! From user perspective, everything in this crate is built around three types: |
14 | 20 | //! |
15 | 21 | //! * [`NqHandshake`] - Classical, non-post-quantum Noise handshake |
|
28 | 34 | //! Handshake messages are exchanged by the peers until the handshake is completed. |
29 | 35 | //! After completion, [`Handshaker::finalize`] is called and the handshake state machine |
30 | 36 | //! 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. |
32 | 38 | //! |
33 | 39 | //! ## Handshake Patterns |
34 | 40 | //! |
|
37 | 43 | //! |
38 | 44 | //! ## Crypto Vendors |
39 | 45 | //! |
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. |
42 | 48 | //! |
43 | 49 | //! Concrete implementations of the crypto algorithms are in the [`crypto`] module and it is even |
44 | 50 | //! possible to use custom implementations using the definitions in the [`traits`] module. |
|
0 commit comments