Fully document crypto/

crypto/ciphersuite/src/dalek.rs

@@ -66,7 +66,7 @@ fn test_ristretto() {
   );
 }
 
-/// Ciphersuite for Ed25519.
+/// Ciphersuite for Ed25519, inspired by RFC-8032.
 ///
 /// hash_to_F is implemented with a naive concatenation of the dst and data, allowing transposition
 /// between the two. This means `dst: b"abc", data: b"def"`, will produce the same scalar as

crypto/ciphersuite/src/ed448.rs

@@ -7,7 +7,7 @@ use digest::{
 use sha3::Shake256;
 
 use group::Group;
-use minimal_ed448::{scalar::Scalar, point::Point};
+use minimal_ed448::{Scalar, Point};
 
 use crate::Ciphersuite;
 
@@ -48,7 +48,7 @@ impl FixedOutput for Shake256_114 {
 }
 impl HashMarker for Shake256_114 {}
 
-/// Ciphersuite for Ed448.
+/// Ciphersuite for Ed448, inspired by RFC-8032. This is not recommended for usage.
 ///
 /// hash_to_F is implemented with a naive concatenation of the dst and data, allowing transposition
 /// between the two. This means `dst: b"abc", data: b"def"`, will produce the same scalar as

crypto/ciphersuite/src/lib.md

@@ -0,0 +1,9 @@
+# Ciphersuite
+
+Ciphersuites for elliptic curves premised on ff/group.
+
+This library, except for the not recommended Ed448 ciphersuite, was
+[audited by Cypher Stack in March 2023](https://github.com/serai-dex/serai/raw/e1bb2c191b7123fd260d008e31656d090d559d21/audits/Cypher%20Stack%20crypto%20March%202023/Audit.pdf),
+culminating in commit
+[669d2dbffc1dafb82a09d9419ea182667115df06](https://github.com/serai-dex/serai/tree/669d2dbffc1dafb82a09d9419ea182667115df06).
+Any subsequent changes have not undergone auditing.

crypto/ciphersuite/src/lib.rs

@@ -1,6 +1,6 @@
-#![cfg_attr(docsrs, feature(doc_cfg))]
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc = include_str!("lib.md")]
 
 use core::fmt::Debug;
 #[cfg(feature = "std")]