frodo-kem: enable and fix workspace-level lints

...or ignore them for now! This one's kind of on the backburner.

Enables the workspace-level lint config added in #232

Author: tarcieri

dhkem/src/lib.rs

@@ -5,7 +5,6 @@
     html_logo_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg",
     html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg"
 )]
-#![warn(missing_docs)]
 
 //! # Diffie-Hellman (DH) based Key Encapsulation Mechanisms (KEM)
 //!

frodo-kem/Cargo.toml

@@ -101,6 +101,9 @@ features = [
 ]
 rustdoc-args = ["--cfg", "docsrs"]
 
+[lints]
+workspace = true
+
 [[bench]]
 name = "frodo"
 harness = false

frodo-kem/benches/frodo.rs

@@ -1,3 +1,8 @@
+//! `FrodoKEM` benchmarks.
+
+#![allow(missing_docs, reason = "benchmarks")]
+#![allow(clippy::unwrap_used, reason = "benchmarks")]
+
 use criterion::{
     BenchmarkGroup, Criterion, criterion_group, criterion_main, measurement::Measurement,
 };

frodo-kem/src/error.rs

@@ -1,6 +1,6 @@
 use thiserror::Error;
 
-/// The errors that can occur for FrodoKEM
+/// The errors that can occur for `FrodoKEM`
 #[derive(Error, Copy, Clone, Debug)]
 pub enum Error {
     /// The secret key length is invalid
@@ -23,5 +23,5 @@ pub enum Error {
     UnsupportedAlgorithm,
 }
 
-/// The result type for FrodoKEM
+/// The result type for `FrodoKEM`
 pub type FrodoResult<T> = Result<T, Error>;

frodo-kem/src/hazmat.rs

@@ -1,28 +1,28 @@
-//! ⚠️ Low-level "hazmat" FrodoKEM and eFrodoKEM functions.
+//! ⚠️ Low-level "hazmat" `FrodoKEM` and eFrodoKEM functions.
 //!
 //! # ☢️️ WARNING: HAZARDOUS API ☢️
 //!
-//! This module contains the low-level API for the FrodoKEM algorithm.
+//! This module contains the low-level API for the `FrodoKEM` algorithm.
 //! Only use if you know what you're doing.
 //!
-//! This layer provides several traits for mixing and matching FrodoKEM components:
+//! This layer provides several traits for mixing and matching `FrodoKEM` components:
 //!
-//! [`Params`] for specifying the constant parameters of the FrodoKEM algorithm.
+//! [`Params`] for specifying the constant parameters of the `FrodoKEM` algorithm.
 //! [`Expanded`] for specifying the expand seed A method.
 //! [`Sample`] for specifying the noise sampling method.
-//! [`Kem`] encompasses the entire FrodoKEM algorithm and each function can be overridden.
+//! [`Kem`] encompasses the entire `FrodoKEM` algorithm and each function can be overridden.
 //!
-//! There are default implementations for each of these traits that can be used to create a FrodoKEM instance.
+//! There are default implementations for each of these traits that can be used to create a `FrodoKEM` instance.
 //!
 //! There are:
-//! [`Frodo640`], [`Frodo976`], and [`Frodo1344`] for the FrodoKEM parameter sets.
+//! [`Frodo640`], [`Frodo976`], and [`Frodo1344`] for the `FrodoKEM` parameter sets.
 //! [`FrodoAes`] and [`FrodoShake`] for the expand seed A methods.
 //! [`FrodoCdfSample`] for the noise sampling method.
 //!
-//! [`FrodoKem`] is the default implementation of the FrodoKEM algorithm that combines
+//! [`FrodoKem`] is the default implementation of the `FrodoKEM` algorithm that combines
 //! all of the above traits using generics.
 //!
-//! There are also type aliases for each standardized FrodoKEM algorithm:
+//! There are also type aliases for each standardized `FrodoKEM` algorithm:
 //!
 //! [`FrodoKem640Aes`], [`FrodoKem976Aes`], and [`FrodoKem1344Aes`] for the FrodoKEM-AES algorithms.
 //! [`FrodoKem640Shake`], [`FrodoKem976Shake`], and [`FrodoKem1344Shake`] for the FrodoKEM-SHAKE algorithms.
@@ -32,76 +32,80 @@
 mod models;
 mod traits;
 
-pub use models::*;
-pub use traits::*;
+pub(crate) use models::*;
+pub(crate) use traits::*;
 
 #[cfg(feature = "frodo640aes")]
 /// The FrodoKEM-640-AES algorithm
-pub type FrodoKem640Aes = FrodoKem<Frodo640, FrodoAes<Frodo640>, FrodoCdfSample<Frodo640>>;
+pub(crate) type FrodoKem640Aes = FrodoKem<Frodo640, FrodoAes<Frodo640>, FrodoCdfSample<Frodo640>>;
 
 #[cfg(feature = "frodo976aes")]
 /// The FrodoKEM-976-AES algorithm
-pub type FrodoKem976Aes = FrodoKem<Frodo976, FrodoAes<Frodo976>, FrodoCdfSample<Frodo976>>;
+pub(crate) type FrodoKem976Aes = FrodoKem<Frodo976, FrodoAes<Frodo976>, FrodoCdfSample<Frodo976>>;
 
 #[cfg(feature = "frodo1344aes")]
 /// The FrodoKEM-1344-AES algorithm
-pub type FrodoKem1344Aes = FrodoKem<Frodo1344, FrodoAes<Frodo1344>, FrodoCdfSample<Frodo1344>>;
+pub(crate) type FrodoKem1344Aes =
+    FrodoKem<Frodo1344, FrodoAes<Frodo1344>, FrodoCdfSample<Frodo1344>>;
 
 #[cfg(feature = "frodo640shake")]
 /// The FrodoKEM-640-SHAKE algorithm
-pub type FrodoKem640Shake = FrodoKem<Frodo640, FrodoShake<Frodo640>, FrodoCdfSample<Frodo640>>;
+pub(crate) type FrodoKem640Shake =
+    FrodoKem<Frodo640, FrodoShake<Frodo640>, FrodoCdfSample<Frodo640>>;
 
 #[cfg(feature = "frodo976shake")]
 /// The FrodoKEM-976-SHAKE algorithm
-pub type FrodoKem976Shake = FrodoKem<Frodo976, FrodoShake<Frodo976>, FrodoCdfSample<Frodo976>>;
+pub(crate) type FrodoKem976Shake =
+    FrodoKem<Frodo976, FrodoShake<Frodo976>, FrodoCdfSample<Frodo976>>;
 
 #[cfg(feature = "frodo1344shake")]
 /// The FrodoKEM-1344-SHAKE algorithm
-pub type FrodoKem1344Shake = FrodoKem<Frodo1344, FrodoShake<Frodo1344>, FrodoCdfSample<Frodo1344>>;
+pub(crate) type FrodoKem1344Shake =
+    FrodoKem<Frodo1344, FrodoShake<Frodo1344>, FrodoCdfSample<Frodo1344>>;
 
 #[cfg(feature = "efrodo640aes")]
 /// The eFrodoKEM-640-AES algorithm
-pub type EphemeralFrodoKem640Aes = EphemeralFrodoKem<
+pub(crate) type EphemeralFrodoKem640Aes = EphemeralFrodoKem<
     EphemeralFrodo640,
     FrodoAes<EphemeralFrodo640>,
     FrodoCdfSample<EphemeralFrodo640>,
 >;
 
 #[cfg(feature = "efrodo976aes")]
 /// The eFrodoKEM-976-AES algorithm
-pub type EphemeralFrodoKem976Aes = EphemeralFrodoKem<
+pub(crate) type EphemeralFrodoKem976Aes = EphemeralFrodoKem<
     EphemeralFrodo976,
     FrodoAes<EphemeralFrodo976>,
     FrodoCdfSample<EphemeralFrodo976>,
 >;
 
 #[cfg(feature = "efrodo1344aes")]
 /// The eFrodoKEM-1344-AES algorithm
-pub type EphemeralFrodoKem1344Aes = EphemeralFrodoKem<
+pub(crate) type EphemeralFrodoKem1344Aes = EphemeralFrodoKem<
     EphemeralFrodo1344,
     FrodoAes<EphemeralFrodo1344>,
     FrodoCdfSample<EphemeralFrodo1344>,
 >;
 
 #[cfg(feature = "efrodo640shake")]
 /// The eFrodoKEM-640-SHAKE algorithm
-pub type EphemeralFrodoKem640Shake = EphemeralFrodoKem<
+pub(crate) type EphemeralFrodoKem640Shake = EphemeralFrodoKem<
     EphemeralFrodo640,
     FrodoShake<EphemeralFrodo640>,
     FrodoCdfSample<EphemeralFrodo640>,
 >;
 
 #[cfg(feature = "efrodo976shake")]
 /// The eFrodoKEM-976-SHAKE algorithm
-pub type EphemeralFrodoKem976Shake = EphemeralFrodoKem<
+pub(crate) type EphemeralFrodoKem976Shake = EphemeralFrodoKem<
     EphemeralFrodo976,
     FrodoShake<EphemeralFrodo976>,
     FrodoCdfSample<EphemeralFrodo976>,
 >;
 
 #[cfg(feature = "efrodo1344shake")]
 /// The eFrodoKEM-1344-SHAKE algorithm
-pub type EphemeralFrodoKem1344Shake = EphemeralFrodoKem<
+pub(crate) type EphemeralFrodoKem1344Shake = EphemeralFrodoKem<
     EphemeralFrodo1344,
     FrodoShake<EphemeralFrodo1344>,
     FrodoCdfSample<EphemeralFrodo1344>,