Merge pull request #2236 from input-output-hk/jpraynaud/fix-trailing-whitespace-genesis-signature

Fix: support trailing whitespace in protocol key files

Author: jpraynaud

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.6.14"
+version = "0.6.15"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -240,7 +240,8 @@ impl CompressedArchiveSnapshotter {
     #[cfg(test)]
     /// Allow to use a custom temporary directory to avoid conflicts during the snapshot verification.
     pub fn set_sub_temp_dir<P: AsRef<Path>>(&mut self, sub_dir: P) {
-        self.temp_dir = std::env::temp_dir().join(sub_dir);
+        self.temp_dir =
+            mithril_common::test_utils::TempDir::create("snapshotter", "temp_dir").join(sub_dir);
     }
 
     fn snapshot<T: TarAppender>(&self, filepath: &Path, appender: T) -> StdResult<OngoingSnapshot> {

mithril-aggregator/src/snapshotter.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.4.105"
+version = "0.4.106"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }

mithril-common/Cargo.toml

@@ -44,7 +44,7 @@ pub fn key_decode_hex<T>(from: HexEncodedKeySlice) -> Result<T, CodecError>
 where
     T: DeserializeOwned,
 {
-    let from_vec = Vec::from_hex(from).map_err(|e| {
+    let from_vec = Vec::from_hex(from.trim()).map_err(|e| {
         CodecError::new(
             "Key decode hex: can not turn hexadecimal value into bytes",
             e.into(),
@@ -91,6 +91,18 @@ mod tests {
         assert_eq!(test_to_serialize, test_to_serialize_restored);
     }
 
+    #[test]
+    fn test_key_decode_hex_with_leading_and_trailing_whitespace() {
+        let test_to_serialize = TestSerialize {
+            inner_string: "my inner string".to_string(),
+        };
+        let test_to_serialize_hex =
+            key_encode_hex(&test_to_serialize).expect("unexpected hex encoding error");
+        let test_to_serialize_restored = key_decode_hex(&format!(" \r{test_to_serialize_hex} \n"))
+            .expect("unexpected hex decoding error");
+        assert_eq!(test_to_serialize, test_to_serialize_restored);
+    }
+
     #[test]
     fn test_bech32_encode() {
         let hrp = "pool";

mithril-common/src/crypto_helper/codec.rs

@@ -2,7 +2,7 @@
 use super::{genesis::*, types::*, OpCert, SerDeShelleyFileFormat};
 use crate::{
     entities::{Certificate, ProtocolMessage, ProtocolMessagePartKey, SignerWithStake, Stake},
-    test_utils::{CertificateChainBuilder, SignerFixture},
+    test_utils::{CertificateChainBuilder, SignerFixture, TempDir},
 };
 
 use rand_chacha::ChaCha20Rng;
@@ -14,9 +14,10 @@ pub fn setup_temp_directory_for_signer(
     party_id: &ProtocolPartyId,
     auto_create: bool,
 ) -> Option<PathBuf> {
-    let temp_dir = std::env::temp_dir()
-        .join("mithril_crypto_helper_material")
+    let temp_dir = TempDir::new("tests_setup", "mithril_crypto_helper_material")
+        .build_path()
         .join(party_id);
+
     if auto_create {
         fs::create_dir_all(&temp_dir).expect("temp dir creation should not fail");
     }

mithril-common/src/crypto_helper/tests_setup.rs

@@ -218,7 +218,10 @@ macro_rules! impl_codec_and_type_conversions_for_protocol_key {
 
 #[cfg(test)]
 mod test {
-    use crate::{crypto_helper::ProtocolKey, test_utils::fake_keys};
+    use crate::{
+        crypto_helper::ProtocolKey,
+        test_utils::{fake_keys, TempDir},
+    };
     use mithril_stm::stm::StmVerificationKeyPoP;
     use serde::{Deserialize, Serialize};
 
@@ -275,7 +278,11 @@ mod test {
     #[test]
     fn can_read_and_write_to_file_a_verification_key() {
         let expected_key: ProtocolKey<StmVerificationKeyPoP> = VERIFICATION_KEY.try_into().unwrap();
-        let key_path = std::env::temp_dir().join("can_read_and_write_to_file_a_verification_key");
+        let key_path = TempDir::create(
+            "protocol_key",
+            "can_read_and_write_to_file_a_verification_key",
+        )
+        .join("key.out");
 
         expected_key
             .write_json_hex_to_file(&key_path)