srp: expand lints (#244)

Adds a substantial number of lints and corrects the failures

Author: tarcieri

srp/src/client.rs

@@ -1,9 +1,3 @@
-use alloc::vec::Vec;
-use core::marker::PhantomData;
-use crypto_bigint::{BoxedUint, ConcatenatingMul, Odd, Resize, modular::BoxedMontyForm};
-use digest::{Digest, Output};
-use subtle::ConstantTimeEq;
-
 use crate::{
     Group,
     errors::AuthError,
@@ -12,6 +6,11 @@ use crate::{
         monty_form,
     },
 };
+use alloc::vec::Vec;
+use core::marker::PhantomData;
+use crypto_bigint::{BoxedUint, ConcatenatingMul, Odd, Resize, modular::BoxedMontyForm};
+use digest::{Digest, Output};
+use subtle::ConstantTimeEq;
 
 /// SRP client implementation.
 ///
@@ -112,6 +111,7 @@ use crate::{
 /// let pwd_verifier = client.compute_verifier(username, password, salt);
 /// send_registration_data(username, salt, &pwd_verifier);
 /// ```
+#[derive(Debug)]
 pub struct Client<G: Group, D: Digest> {
     g: BoxedMontyForm,
     username_in_x: bool,
@@ -331,6 +331,7 @@ impl<G: Group, D: Digest> Default for Client<G, D> {
 /// [RFC5054]-compatible SRP client state after handshake with the server.
 ///
 /// [RFC5054]: https://datatracker.ietf.org/doc/html/rfc5054
+#[derive(Debug)]
 pub struct ClientVerifier<D: Digest> {
     m1: Output<D>,
     m2: Output<D>,
@@ -363,6 +364,7 @@ impl<D: Digest> ClientVerifier<D> {
 
 /// Legacy SRP client state after handshake with the server, compatible with `srp` v0.6 and earlier.
 #[deprecated(since = "0.7.0", note = "please switch to `ClientVerifierRfc5054`")]
+#[derive(Debug)]
 pub struct LegacyClientVerifier<D: Digest> {
     m1: Output<D>,
     m2: Output<D>,

srp/src/errors.rs

@@ -3,7 +3,7 @@
 use core::{error, fmt};
 
 /// SRP authentication error.
-#[derive(Debug, Clone, Eq, PartialEq)]
+#[derive(Clone, Copy, Debug, Eq, PartialEq)]
 pub enum AuthError {
     /// Parameter with the given `name` is illegal.
     IllegalParameter {

srp/src/groups.rs

@@ -4,6 +4,10 @@
 //! groups. Additionally, it is not recommended to use `G1024` and `G_1536`,
 //! they are provided only for compatibility with the legacy software.
 
+use core::{
+    any,
+    fmt::{self, Debug},
+};
 use crypto_bigint::{
     BoxedUint, Odd, Resize,
     modular::{BoxedMontyForm, BoxedMontyParams},
@@ -29,12 +33,32 @@ pub trait Group {
 macro_rules! define_group {
     ($name:ident, $g:expr, $n:expr, $doc:expr) => {
         #[doc = $doc]
+        #[derive(Clone, Copy)]
         pub struct $name;
 
         impl Group for $name {
             const G: u64 = $g;
             const N: &'static [u8] = include_bytes!("groups/1024.bin");
         }
+
+        impl Debug for $name {
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                let name = any::type_name::<$name>();
+                let name = name.split("::").last().unwrap_or(name);
+
+                write!(f, "{} {{ G: {}, N: 0x", name, Self::G)?;
+                for byte in Self::N {
+                    write!(f, "{byte:02X}")?;
+                }
+                write!(f, " }}")
+            }
+        }
+
+        impl<Rhs: Group> PartialEq<Rhs> for $name {
+            fn eq(&self, _other: &Rhs) -> bool {
+                Self::G == Rhs::G && Self::N == Rhs::N
+            }
+        }
     };
 }
 

srp/src/lib.rs

@@ -6,7 +6,24 @@
 )]
 #![allow(clippy::many_single_char_names)]
 #![forbid(unsafe_code)]
-#![warn(missing_docs, rust_2018_idioms, unused_qualifications)]
+#![warn(
+    clippy::checked_conversions,
+    clippy::integer_division_remainder_used,
+    clippy::mod_module_files,
+    clippy::panic,
+    clippy::panic_in_result_fn,
+    clippy::std_instead_of_alloc,
+    clippy::std_instead_of_core,
+    clippy::unwrap_used,
+    missing_copy_implementations,
+    missing_debug_implementations,
+    missing_docs,
+    rust_2018_idioms,
+    trivial_casts,
+    trivial_numeric_casts,
+    unused_lifetimes,
+    unused_qualifications
+)]
 
 //! # Usage
 //! See [`Client`] and [`Server`] types for usage information.

srp/src/server.rs

@@ -1,9 +1,3 @@
-use alloc::vec::Vec;
-use core::marker::PhantomData;
-use crypto_bigint::{BoxedUint, Odd, Resize, modular::BoxedMontyForm};
-use digest::{Digest, Output};
-use subtle::ConstantTimeEq;
-
 use crate::{
     Group,
     errors::AuthError,
@@ -12,6 +6,11 @@ use crate::{
         monty_form,
     },
 };
+use alloc::vec::Vec;
+use core::marker::PhantomData;
+use crypto_bigint::{BoxedUint, Odd, Resize, modular::BoxedMontyForm};
+use digest::{Digest, Output};
+use subtle::ConstantTimeEq;
 
 /// SRP server implementation.
 ///
@@ -90,6 +89,7 @@ use crate::{
 /// let session_key = verifier.verify_client(&client_proof).unwrap();
 /// send_proof(verifier.proof());
 /// ```
+#[derive(Debug)]
 pub struct Server<G: Group, D: Digest> {
     g: BoxedMontyForm,
     d: PhantomData<(G, D)>,
@@ -267,6 +267,7 @@ impl<G: Group, D: Digest> Default for Server<G, D> {
 /// [RFC5054] SRP server state after handshake with the client.
 ///
 /// [RFC5054]: https://datatracker.ietf.org/doc/html/rfc5054
+#[derive(Debug)]
 pub struct ServerVerifier<D: Digest> {
     m1: Output<D>,
     m2: Output<D>,
@@ -299,6 +300,7 @@ impl<D: Digest> ServerVerifier<D> {
 
 /// Legacy SRP server state after handshake with the client, compatible with `srp` v0.6 and earlier.
 #[deprecated(since = "0.7.0", note = "please switch to `ServerVerifierRfc5054`")]
+#[derive(Debug)]
 pub struct LegacyServerVerifier<D: Digest> {
     m1: Output<D>,
     m2: Output<D>,