feat: improve more debug impls

dignifiedquire · dignifiedquire · commit 3d73320131ad · 2024-07-08T11:14:15.000+02:00
diff --git a/src/composed/message/decrypt.rs b/src/composed/message/decrypt.rs
@@ -21,16 +21,19 @@ where
 }
 
 /// Decrypted session key.
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(derive_more::Debug, Clone, PartialEq, Eq)]
 pub enum PlainSessionKey {
     V4 {
         sym_alg: SymmetricKeyAlgorithm,
+        #[debug("..")]
         key: Vec<u8>,
     },
     V5 {
+        #[debug("..")]
         key: Vec<u8>,
     },
     V6 {
+        #[debug("..")]
         key: Vec<u8>,
     },
 }
diff --git a/src/crypto/rsa.rs b/src/crypto/rsa.rs
@@ -25,8 +25,8 @@ use crate::types::{Mpi, PlainSecretParams, PublicParams};
 const MAX_KEY_SIZE: usize = 16384;
 
 /// Private Key for RSA.
-#[derive(Debug, ZeroizeOnDrop)]
-pub struct PrivateKey(pub(crate) RsaPrivateKey);
+#[derive(derive_more::Debug, ZeroizeOnDrop)]
+pub struct PrivateKey(#[debug("..")] pub(crate) RsaPrivateKey);
 
 impl Deref for PrivateKey {
     type Target = RsaPrivateKey;
diff --git a/src/packet/mod_detection_code.rs b/src/packet/mod_detection_code.rs
@@ -7,10 +7,11 @@ use crate::types::{Tag, Version};
 
 /// Modification Detection Code Packet
 /// https://tools.ietf.org/html/rfc4880.html#section-5.14
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(derive_more::Debug, Clone, PartialEq, Eq)]
 pub struct ModDetectionCode {
     packet_version: Version,
     /// 20 byte SHA1 hash of the preceding plaintext data.
+    #[debug("{}", hex::encode(hash))]
     hash: [u8; 20],
 }
 
diff --git a/src/packet/padding.rs b/src/packet/padding.rs
@@ -10,10 +10,11 @@ use crate::types::{Tag, Version};
 /// Padding Packet
 ///
 /// https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-13.html#name-padding-packet-type-id-21
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(derive_more::Debug, Clone, PartialEq, Eq)]
 pub struct Padding {
     packet_version: Version,
     /// Random data.
+    #[debug("{}", hex::encode(data))]
     data: Vec<u8>,
 }
 
diff --git a/src/packet/signature/types.rs b/src/packet/signature/types.rs
@@ -790,7 +790,7 @@ impl Subpacket {
     }
 }
 
-#[derive(Debug, PartialEq, Eq, Clone)]
+#[derive(derive_more::Debug, PartialEq, Eq, Clone)]
 pub enum SubpacketData {
     /// The time the signature was made.
     SignatureCreationTime(DateTime<Utc>),
@@ -806,9 +806,9 @@ pub enum SubpacketData {
     PreferredHashAlgorithms(SmallVec<[HashAlgorithm; 8]>),
     /// List of compression algorithms that indicate which algorithms the key holder prefers to use.
     PreferredCompressionAlgorithms(SmallVec<[CompressionAlgorithm; 8]>),
-    KeyServerPreferences(SmallVec<[u8; 4]>),
-    KeyFlags(SmallVec<[u8; 1]>),
-    Features(SmallVec<[u8; 1]>),
+    KeyServerPreferences(#[debug("{}", hex::encode(_0))] SmallVec<[u8; 4]>),
+    KeyFlags(#[debug("{}", hex::encode(_0))] SmallVec<[u8; 1]>),
+    Features(#[debug("{}", hex::encode(_0))] SmallVec<[u8; 1]>),
     RevocationReason(RevocationCode, BString),
     IsPrimary(bool),
     Revocable(bool),
@@ -822,11 +822,18 @@ pub enum SubpacketData {
     TrustSignature(u8, u8),
     RegularExpression(BString),
     ExportableCertification(bool),
-    IssuerFingerprint(KeyVersion, SmallVec<[u8; 20]>),
+    IssuerFingerprint(
+        KeyVersion,
+        #[debug("{}", hex::encode(_1))] SmallVec<[u8; 20]>,
+    ),
     PreferredAeadAlgorithms(SmallVec<[AeadAlgorithm; 2]>),
-    Experimental(u8, SmallVec<[u8; 2]>),
-    Other(u8, Vec<u8>),
-    SignatureTarget(PublicKeyAlgorithm, HashAlgorithm, Vec<u8>),
+    Experimental(u8, #[debug("{}", hex::encode(_1))] SmallVec<[u8; 2]>),
+    Other(u8, #[debug("{}", hex::encode(_1))] Vec<u8>),
+    SignatureTarget(
+        PublicKeyAlgorithm,
+        HashAlgorithm,
+        #[debug("{}", hex::encode(_2))] Vec<u8>,
+    ),
 }
 
 bitfield! {
diff --git a/src/packet/sym_key_encrypted_session_key.rs b/src/packet/sym_key_encrypted_session_key.rs
@@ -17,30 +17,37 @@ use crate::PlainSessionKey;
 
 /// Symmetric-Key Encrypted Session Key Packet
 /// https://tools.ietf.org/html/rfc4880.html#section-5.3
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(derive_more::Debug, Clone, PartialEq, Eq)]
 pub enum SymKeyEncryptedSessionKey {
     V4 {
         packet_version: Version,
         sym_algorithm: SymmetricKeyAlgorithm,
         s2k: StringToKey,
+        #[debug("{:?}", encrypted_key.as_ref().map(hex::encode))]
         encrypted_key: Option<Vec<u8>>,
     },
     V5 {
         packet_version: Version,
         sym_algorithm: SymmetricKeyAlgorithm,
         s2k: StringToKey,
         aead: AeadAlgorithm,
+        #[debug("{}", hex::encode(iv))]
         iv: Vec<u8>,
+        #[debug("{}", hex::encode(auth_tag))]
         auth_tag: Vec<u8>,
+        #[debug("{}", hex::encode(encrypted_key))]
         encrypted_key: Vec<u8>,
     },
     V6 {
         packet_version: Version,
         sym_algorithm: SymmetricKeyAlgorithm,
         s2k: StringToKey,
         aead: AeadAlgorithm,
+        #[debug("{}", hex::encode(iv))]
         iv: Vec<u8>,
+        #[debug("{}", hex::encode(auth_tag))]
         auth_tag: Vec<u8>,
+        #[debug("{}", hex::encode(encrypted_key))]
         encrypted_key: Vec<u8>,
     },
 }
diff --git a/src/types/revocation_key.rs b/src/types/revocation_key.rs
@@ -3,10 +3,11 @@ use smallvec::SmallVec;
 
 use crate::crypto::public_key::PublicKeyAlgorithm;
 
-#[derive(Debug, PartialEq, Eq, Clone)]
+#[derive(derive_more::Debug, PartialEq, Eq, Clone)]
 pub struct RevocationKey {
     pub class: RevocationKeyClass,
     pub algorithm: PublicKeyAlgorithm,
+    #[debug("{}", hex::encode(fingerprint))]
     pub fingerprint: SmallVec<[u8; 20]>,
 }
 
diff --git a/src/types/s2k.rs b/src/types/s2k.rs
@@ -31,27 +31,31 @@ pub enum S2kUsage {
     MalleableCfb,
 }
 
-#[derive(Debug, PartialEq, Eq, Clone)]
+#[derive(derive_more::Debug, PartialEq, Eq, Clone)]
 pub enum S2kParams {
     Unprotected,
     LegacyCfb {
         sym_alg: SymmetricKeyAlgorithm,
+        #[debug("{}", hex::encode(iv))]
         iv: Vec<u8>,
     },
     Aead {
         sym_alg: SymmetricKeyAlgorithm,
         aead_mode: AeadAlgorithm,
         s2k: StringToKey,
+        #[debug("{}", hex::encode(nonce))]
         nonce: Vec<u8>,
     },
     Cfb {
         sym_alg: SymmetricKeyAlgorithm,
         s2k: StringToKey,
+        #[debug("{}", hex::encode(iv))]
         iv: Vec<u8>,
     },
     MaleableCfb {
         sym_alg: SymmetricKeyAlgorithm,
         s2k: StringToKey,
+        #[debug("{}", hex::encode(iv))]
         iv: Vec<u8>,
     },
 }
@@ -101,7 +105,7 @@ impl From<u8> for S2kUsage {
     }
 }
 
-#[derive(Debug, PartialEq, Eq, Clone)]
+#[derive(derive_more::Debug, PartialEq, Eq, Clone)]
 pub enum StringToKey {
     // Type ID 0
     Simple {
@@ -111,23 +115,27 @@ pub enum StringToKey {
     // Type ID 1
     Salted {
         hash_alg: HashAlgorithm,
+        #[debug("{}", hex::encode(salt))]
         salt: [u8; 8],
     },
 
     // Type ID 2
     Reserved {
+        #[debug("{}", hex::encode(unknown))]
         unknown: Vec<u8>,
     },
 
     // Type ID 3
     IteratedAndSalted {
         hash_alg: HashAlgorithm,
+        #[debug("{}", hex::encode(salt))]
         salt: [u8; 8],
         count: u8,
     },
 
     // Type ID 4
     Argon2 {
+        #[debug("{}", hex::encode(salt))]
         salt: [u8; 16],
         t: u8,     // one-octet number of passes t
         p: u8,     // one-octet degree of parallelism p
@@ -137,11 +145,13 @@ pub enum StringToKey {
     // Private/Experimental S2K: 100-110
     Private {
         typ: u8,
+        #[debug("{}", hex::encode(unknown))]
         unknown: Vec<u8>,
     },
 
     Other {
         typ: u8,
+        #[debug("{}", hex::encode(unknown))]
         unknown: Vec<u8>,
     },
 }
