chore: rename PublicKeyTrait::to_writer_old into serialize_for_hashing

hko-s · hko-s · commit 017be1507bbd · 2024-07-25T15:31:46.000+02:00
diff --git a/src/composed/key/public.rs b/src/composed/key/public.rs
@@ -84,8 +84,8 @@ impl PublicKeyTrait for PublicKey {
         self.primary_key.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {
-        self.primary_key.to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {
+        self.primary_key.serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {
@@ -163,8 +163,8 @@ impl PublicKeyTrait for PublicSubkey {
         self.key.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {
-        self.key.to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {
+        self.key.serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {
diff --git a/src/composed/signed_key/public.rs b/src/composed/signed_key/public.rs
@@ -167,8 +167,8 @@ impl PublicKeyTrait for SignedPublicKey {
         self.primary_key.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {
-        self.primary_key.to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {
+        self.primary_key.serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {
@@ -267,8 +267,8 @@ impl PublicKeyTrait for SignedPublicSubKey {
         self.key.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {
-        self.key.to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {
+        self.key.serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {
diff --git a/src/composed/signed_key/secret.rs b/src/composed/signed_key/secret.rs
@@ -227,8 +227,8 @@ impl PublicKeyTrait for SignedSecretKey {
         self.primary_key.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {
-        self.primary_key.to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {
+        self.primary_key.serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {
@@ -349,8 +349,8 @@ impl PublicKeyTrait for SignedSecretSubKey {
         self.key.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {
-        self.key.to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {
+        self.key.serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {
diff --git a/src/packet/key/public.rs b/src/packet/key/public.rs
@@ -387,7 +387,7 @@ impl PublicKeyTrait for PubKeyInner {
             .collect::<Vec<_>>())
     }
 
-    fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {
+    fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {
         use crate::ser::Serialize;
 
         let mut key_buf = Vec::new();
@@ -426,8 +426,8 @@ impl PublicKeyTrait for PublicKey {
         PublicKeyTrait::encrypt(&self.0, rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {
-        PublicKeyTrait::to_writer_old(&self.0, writer)
+    fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {
+        PublicKeyTrait::serialize_for_hashing(&self.0, writer)
     }
 
     fn public_params(&self) -> &PublicParams {
@@ -472,8 +472,8 @@ impl PublicKeyTrait for PublicSubkey {
         PublicKeyTrait::encrypt(&self.0, rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {
-        PublicKeyTrait::to_writer_old(&self.0, writer)
+    fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {
+        PublicKeyTrait::serialize_for_hashing(&self.0, writer)
     }
 
     fn public_params(&self) -> &PublicParams {
diff --git a/src/packet/key/secret.rs b/src/packet/key/secret.rs
@@ -371,8 +371,8 @@ impl PublicKeyTrait for SecretKey {
         PublicKeyTrait::encrypt(&self.0, rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {
-        PublicKeyTrait::to_writer_old(&self.0, writer)
+    fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {
+        PublicKeyTrait::serialize_for_hashing(&self.0, writer)
     }
 
     fn public_params(&self) -> &PublicParams {
@@ -417,8 +417,8 @@ impl PublicKeyTrait for SecretSubkey {
         PublicKeyTrait::encrypt(&self.0, rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {
-        PublicKeyTrait::to_writer_old(&self.0, writer)
+    fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {
+        PublicKeyTrait::serialize_for_hashing(&self.0, writer)
     }
 
     fn public_params(&self) -> &PublicParams {
@@ -463,7 +463,7 @@ impl<D: PublicKeyTrait + crate::ser::Serialize> PublicKeyTrait for SecretKeyInne
         self.details.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {
+    fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {
         let mut key_buf = Vec::new();
         self.details.to_writer(&mut key_buf)?;
 
diff --git a/src/packet/signature/config.rs b/src/packet/signature/config.rs
@@ -106,7 +106,7 @@ impl SignatureConfig {
 
         let mut hasher = self.hash_alg.new_hasher()?;
 
-        signee.to_writer_old(&mut hasher)?;
+        signee.serialize_for_hashing(&mut hasher)?;
 
         let mut packet_buf = Vec::new();
         id.to_writer(&mut packet_buf)?;
@@ -165,10 +165,10 @@ impl SignatureConfig {
         let mut hasher = self.hash_alg.new_hasher()?;
 
         // Signing Key
-        signing_key.to_writer_old(&mut hasher)?;
+        signing_key.serialize_for_hashing(&mut hasher)?;
 
         // Key being bound
-        key.to_writer_old(&mut hasher)?;
+        key.serialize_for_hashing(&mut hasher)?;
 
         let len = self.hash_signature_data(&mut *hasher)?;
         hasher.update(&self.trailer(len)?);
@@ -194,7 +194,7 @@ impl SignatureConfig {
 
         let mut hasher = self.hash_alg.new_hasher()?;
 
-        key.to_writer_old(&mut hasher)?;
+        key.serialize_for_hashing(&mut hasher)?;
 
         let len = self.hash_signature_data(&mut *hasher)?;
         hasher.update(&self.trailer(len)?);
diff --git a/src/packet/signature/types.rs b/src/packet/signature/types.rs
@@ -7,6 +7,7 @@ use chrono::{DateTime, Duration, Utc};
 use iter_read::IterRead;
 use log::debug;
 use num_enum::{FromPrimitive, IntoPrimitive, TryFromPrimitive};
+use smallvec::{smallvec, SmallVec};
 
 use crate::crypto::aead::AeadAlgorithm;
 use crate::crypto::hash::HashAlgorithm;
@@ -21,7 +22,6 @@ use crate::ser::Serialize;
 use crate::types::{
     self, CompressionAlgorithm, KeyId, KeyVersion, Mpi, PublicKeyTrait, Tag, Version,
 };
-use smallvec::{smallvec, SmallVec};
 
 /// Signature Packet
 /// https://tools.ietf.org/html/rfc4880.html#section-5.2
@@ -173,7 +173,7 @@ impl Signature {
         {
             let mut key_buf = Vec::new();
             // TODO: this is different for V5
-            signee.to_writer_old(&mut key_buf)?;
+            signee.serialize_for_hashing(&mut key_buf)?;
             hasher.update(&key_buf);
         }
 
@@ -267,9 +267,9 @@ impl Signature {
         {
             let mut key_buf = Vec::new();
             if !backsig {
-                signer.to_writer_old(&mut key_buf)?; // primary
+                signer.serialize_for_hashing(&mut key_buf)?; // primary
             } else {
-                signee.to_writer_old(&mut key_buf)?; // primary
+                signee.serialize_for_hashing(&mut key_buf)?; // primary
             }
 
             hasher.update(&key_buf);
@@ -278,9 +278,9 @@ impl Signature {
         {
             let mut key_buf = Vec::new();
             if !backsig {
-                signee.to_writer_old(&mut key_buf)?; // subkey
+                signee.serialize_for_hashing(&mut key_buf)?; // subkey
             } else {
-                signer.to_writer_old(&mut key_buf)?; // subkey
+                signer.serialize_for_hashing(&mut key_buf)?; // subkey
             }
 
             hasher.update(&key_buf);
@@ -313,7 +313,7 @@ impl Signature {
 
         {
             let mut key_buf = Vec::new();
-            key.to_writer_old(&mut key_buf)?;
+            key.serialize_for_hashing(&mut key_buf)?;
 
             hasher.update(&key_buf);
         }
diff --git a/src/types/public_key.rs b/src/types/public_key.rs
@@ -31,7 +31,7 @@ pub trait PublicKeyTrait: std::fmt::Debug {
 
     // TODO: figure out a better place for this
     /// This is the data used for hashing in a signature. Only uses the public portion of the key.
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()>;
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()>;
     fn public_params(&self) -> &PublicParams;
 
     fn is_signing_key(&self) -> bool {
@@ -61,8 +61,8 @@ impl<'a, T: PublicKeyTrait> PublicKeyTrait for &'a T {
         (*self).encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {
-        (*self).to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {
+        (*self).serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {
diff --git a/tests/hsm-test.rs b/tests/hsm-test.rs
@@ -69,8 +69,8 @@ impl PublicKeyTrait for FakeHsm {
         self.public_key.encrypt(rng, plain)
     }
 
-    fn to_writer_old(&self, writer: &mut impl std::io::Write) -> pgp::errors::Result<()> {
-        self.public_key.to_writer_old(writer)
+    fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> pgp::errors::Result<()> {
+        self.public_key.serialize_for_hashing(writer)
     }
 
     fn public_params(&self) -> &PublicParams {

Original file line number	Diff line number	Diff line change
`@@ -84,8 +84,8 @@ impl PublicKeyTrait for PublicKey {`
`84`	`84`	`self.primary_key.encrypt(rng, plain)`
`85`	`85`	`}`
`86`	`86`
`87`		`- fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {`
`88`		`- self.primary_key.to_writer_old(writer)`
	`87`	`+ fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {`
	`88`	`+ self.primary_key.serialize_for_hashing(writer)`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`fn public_params(&self) -> &PublicParams {`
`@@ -163,8 +163,8 @@ impl PublicKeyTrait for PublicSubkey {`
`163`	`163`	`self.key.encrypt(rng, plain)`
`164`	`164`	`}`
`165`	`165`
`166`		`- fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {`
`167`		`- self.key.to_writer_old(writer)`
	`166`	`+ fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {`
	`167`	`+ self.key.serialize_for_hashing(writer)`
`168`	`168`	`}`
`169`	`169`
`170`	`170`	`fn public_params(&self) -> &PublicParams {`
Original file line number	Diff line number	Diff line change
`@@ -167,8 +167,8 @@ impl PublicKeyTrait for SignedPublicKey {`
`167`	`167`	`self.primary_key.encrypt(rng, plain)`
`168`	`168`	`}`
`169`	`169`
`170`		`- fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {`
`171`		`- self.primary_key.to_writer_old(writer)`
	`170`	`+ fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {`
	`171`	`+ self.primary_key.serialize_for_hashing(writer)`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`fn public_params(&self) -> &PublicParams {`
`@@ -267,8 +267,8 @@ impl PublicKeyTrait for SignedPublicSubKey {`
`267`	`267`	`self.key.encrypt(rng, plain)`
`268`	`268`	`}`
`269`	`269`
`270`		`- fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {`
`271`		`- self.key.to_writer_old(writer)`
	`270`	`+ fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {`
	`271`	`+ self.key.serialize_for_hashing(writer)`
`272`	`272`	`}`
`273`	`273`
`274`	`274`	`fn public_params(&self) -> &PublicParams {`
Original file line number	Diff line number	Diff line change
`@@ -227,8 +227,8 @@ impl PublicKeyTrait for SignedSecretKey {`
`227`	`227`	`self.primary_key.encrypt(rng, plain)`
`228`	`228`	`}`
`229`	`229`
`230`		`- fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {`
`231`		`- self.primary_key.to_writer_old(writer)`
	`230`	`+ fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {`
	`231`	`+ self.primary_key.serialize_for_hashing(writer)`
`232`	`232`	`}`
`233`	`233`
`234`	`234`	`fn public_params(&self) -> &PublicParams {`
`@@ -349,8 +349,8 @@ impl PublicKeyTrait for SignedSecretSubKey {`
`349`	`349`	`self.key.encrypt(rng, plain)`
`350`	`350`	`}`
`351`	`351`
`352`		`- fn to_writer_old(&self, writer: &mut impl io::Write) -> Result<()> {`
`353`		`- self.key.to_writer_old(writer)`
	`352`	`+ fn serialize_for_hashing(&self, writer: &mut impl io::Write) -> Result<()> {`
	`353`	`+ self.key.serialize_for_hashing(writer)`
`354`	`354`	`}`
`355`	`355`
`356`	`356`	`fn public_params(&self) -> &PublicParams {`
Original file line number	Diff line number	Diff line change
`@@ -387,7 +387,7 @@ impl PublicKeyTrait for PubKeyInner {`
`387`	`387`	`.collect::<Vec<_>>())`
`388`	`388`	`}`
`389`	`389`
`390`		`- fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {`
	`390`	`+ fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {`
`391`	`391`	`use crate::ser::Serialize;`
`392`	`392`
`393`	`393`	`let mut key_buf = Vec::new();`
`@@ -426,8 +426,8 @@ impl PublicKeyTrait for PublicKey {`
`426`	`426`	`PublicKeyTrait::encrypt(&self.0, rng, plain)`
`427`	`427`	`}`
`428`	`428`
`429`		`- fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {`
`430`		`- PublicKeyTrait::to_writer_old(&self.0, writer)`
	`429`	`+ fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {`
	`430`	`+ PublicKeyTrait::serialize_for_hashing(&self.0, writer)`
`431`	`431`	`}`
`432`	`432`
`433`	`433`	`fn public_params(&self) -> &PublicParams {`
`@@ -472,8 +472,8 @@ impl PublicKeyTrait for PublicSubkey {`
`472`	`472`	`PublicKeyTrait::encrypt(&self.0, rng, plain)`
`473`	`473`	`}`
`474`	`474`
`475`		`- fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {`
`476`		`- PublicKeyTrait::to_writer_old(&self.0, writer)`
	`475`	`+ fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {`
	`476`	`+ PublicKeyTrait::serialize_for_hashing(&self.0, writer)`
`477`	`477`	`}`
`478`	`478`
`479`	`479`	`fn public_params(&self) -> &PublicParams {`
Original file line number	Diff line number	Diff line change
`@@ -371,8 +371,8 @@ impl PublicKeyTrait for SecretKey {`
`371`	`371`	`PublicKeyTrait::encrypt(&self.0, rng, plain)`
`372`	`372`	`}`
`373`	`373`
`374`		`- fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {`
`375`		`- PublicKeyTrait::to_writer_old(&self.0, writer)`
	`374`	`+ fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {`
	`375`	`+ PublicKeyTrait::serialize_for_hashing(&self.0, writer)`
`376`	`376`	`}`
`377`	`377`
`378`	`378`	`fn public_params(&self) -> &PublicParams {`
`@@ -417,8 +417,8 @@ impl PublicKeyTrait for SecretSubkey {`
`417`	`417`	`PublicKeyTrait::encrypt(&self.0, rng, plain)`
`418`	`418`	`}`
`419`	`419`
`420`		`- fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {`
`421`		`- PublicKeyTrait::to_writer_old(&self.0, writer)`
	`420`	`+ fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {`
	`421`	`+ PublicKeyTrait::serialize_for_hashing(&self.0, writer)`
`422`	`422`	`}`
`423`	`423`
`424`	`424`	`fn public_params(&self) -> &PublicParams {`
`@@ -463,7 +463,7 @@ impl<D: PublicKeyTrait + crate::ser::Serialize> PublicKeyTrait for SecretKeyInne`
`463`	`463`	`self.details.encrypt(rng, plain)`
`464`	`464`	`}`
`465`	`465`
`466`		`- fn to_writer_old(&self, writer: &mut impl std::io::Write) -> Result<()> {`
	`466`	`+ fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> Result<()> {`
`467`	`467`	`let mut key_buf = Vec::new();`
`468`	`468`	`self.details.to_writer(&mut key_buf)?;`
`469`	`469`
Original file line number	Diff line number	Diff line change
`@@ -69,8 +69,8 @@ impl PublicKeyTrait for FakeHsm {`
`69`	`69`	`self.public_key.encrypt(rng, plain)`
`70`	`70`	`}`
`71`	`71`
`72`		`- fn to_writer_old(&self, writer: &mut impl std::io::Write) -> pgp::errors::Result<()> {`
`73`		`- self.public_key.to_writer_old(writer)`
	`72`	`+ fn serialize_for_hashing(&self, writer: &mut impl std::io::Write) -> pgp::errors::Result<()> {`
	`73`	`+ self.public_key.serialize_for_hashing(writer)`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`fn public_params(&self) -> &PublicParams {`