Implement Debug

Author: thomwiggers

implementations.yaml

@@ -5,7 +5,7 @@ traits_version: 0.3.5
 
 kems:
   mlkem:
-    version: 0.1.0
+    version: 0.1.1
     x86_avx2_guard: 'target_arch == "x86_64" && avx2_enabled && !is_windows && !is_macos'
     implementations: [clean, avx2, aarch64]
     schemes:
@@ -16,7 +16,7 @@ kems:
       - name: ml-kem-1024
         implementations: [clean, avx2, aarch64]
   classicmceliece:
-    version: 0.2.0
+    version: 0.2.1
     notes: |
       This implementation requires a lot of stack space.
       You need to specify ``RUST_MIN_STACK=800000000``, probably.
@@ -50,7 +50,7 @@ kems:
         implementations: [clean, avx2]
         doctest: no
   hqc:
-    version: 0.2.1
+    version: 0.2.2
     implementations: [clean]
     schemes:
       - name: hqc-128
@@ -63,7 +63,7 @@ kems:
 
 signs:
   mldsa:
-    version: 0.1.1
+    version: 0.1.2
     x86_avx2_guard: 'target_arch == "x86_64" && avx2_enabled && !is_windows'
     implementations: [clean, avx2, aarch64]
     supports_context: true
@@ -75,7 +75,7 @@ signs:
       - name: ml-dsa-87
         implementations: [clean, avx2, aarch64]
   falcon:
-    version: 0.4.0
+    version: 0.4.1
     implementations: [clean, avx2, aarch64]
     schemes:
       - name: falcon-512
@@ -87,7 +87,7 @@ signs:
       - name: falcon-padded-1024
         implementations: [clean, avx2, aarch64]
   sphincsplus:
-    version: 0.7.1
+    version: 0.7.2
     implementations: [clean, avx2]
     schemes:
       - name: sphincs-shake-128f-simple

pqcrypto-classicmceliece/Cargo.toml

@@ -2,7 +2,7 @@
 name = "pqcrypto-classicmceliece"
 description = "Post-Quantum Key-Encapsulation Mechanism classicmceliece"
 readme = "README.md"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["Thom Wiggers <[email protected]>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"

pqcrypto-classicmceliece/src/mceliece348864.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }
 

pqcrypto-classicmceliece/src/mceliece348864f.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }
 

pqcrypto-classicmceliece/src/mceliece460896.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }
 

pqcrypto-classicmceliece/src/mceliece460896f.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }
 

pqcrypto-classicmceliece/src/mceliece6688128.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }
 

pqcrypto-classicmceliece/src/mceliece6688128f.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }
 

pqcrypto-classicmceliece/src/mceliece6960119.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }
 

pqcrypto-classicmceliece/src/mceliece6960119f.rs

@@ -27,6 +27,9 @@ use crate::ffi;
 use pqcrypto_traits::kem as primitive;
 use pqcrypto_traits::{Error, Result};
 
+#[cfg(feature = "std")]
+use std::fmt;
+
 macro_rules! simple_struct {
     ($type: ident, $size: expr) => {
         #[derive(Clone, Copy)]
@@ -79,6 +82,14 @@ macro_rules! simple_struct {
                     .is_ok()
             }
         }
+
+        #[cfg(feature = "std")]
+        impl fmt::Debug for $type {
+            /// Add a debug implementation that won't leak private values
+            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+                write!(f, "{} ({} bytes)", stringify!($type), self.0.len())
+            }
+        }
     };
 }