Merge pull request #77 from lightningdevkit/debug-seed-rm

Redact seed debug output

Author: benthecarman

orange-sdk/src/ffi/orange/config.rs

@@ -1,4 +1,5 @@
 use std::collections::HashMap;
+use std::fmt;
 use std::ops::Deref;
 use std::path::PathBuf;
 use std::str::FromStr;
@@ -22,7 +23,7 @@ use crate::logging::LoggerType;
 use crate::trusted_wallet::ExtraConfig as OrangeExtraConfig;
 use crate::{impl_from_core_type, impl_into_core_type};
 
-#[derive(Debug, Clone, uniffi::Enum)]
+#[derive(Clone, uniffi::Enum)]
 pub enum Seed {
 	/// A BIP 39 mnemonic seed.
 	MnemonicSeed {
@@ -35,6 +36,19 @@ pub enum Seed {
 	Seed64(Vec<u8>),
 }
 
+impl fmt::Debug for Seed {
+	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+		match self {
+			Seed::MnemonicSeed { .. } => f
+				.debug_struct("MnemonicSeed")
+				.field("mnemonic", &"<redacted>")
+				.field("passphrase", &"<redacted>")
+				.finish(),
+			Seed::Seed64(_) => f.debug_tuple("Seed64").field(&"<redacted>").finish(),
+		}
+	}
+}
+
 impl TryInto<OrangeSeed> for Seed {
 	type Error = ConfigError;
 	fn try_into(self) -> Result<OrangeSeed, Self::Error> {
@@ -310,3 +324,29 @@ impl TryFrom<WalletConfig> for OrangeWalletConfig {
 		})
 	}
 }
+
+#[cfg(test)]
+mod tests {
+	use super::*;
+	use crate::ffi::ldk_node::Mnemonic;
+
+	#[test]
+	fn ffi_seed_debug_redacts_seed64_bytes() {
+		let seed = Seed::Seed64(vec![42; 64]);
+
+		assert_eq!(format!("{seed:?}"), "Seed64(\"<redacted>\")");
+	}
+
+	#[test]
+	fn ffi_seed_debug_redacts_mnemonic_and_passphrase() {
+		let mnemonic = Arc::new(
+			Mnemonic::from_entropy(vec![0; 16]).expect("static test entropy should be valid"),
+		);
+		let seed = Seed::MnemonicSeed { mnemonic, passphrase: Some("test passphrase".to_owned()) };
+		let debug = format!("{seed:?}");
+
+		assert_eq!(debug, "MnemonicSeed { mnemonic: \"<redacted>\", passphrase: \"<redacted>\" }");
+		assert!(!debug.contains("abandon"));
+		assert!(!debug.contains("test passphrase"));
+	}
+}

orange-sdk/src/lib.rs

@@ -143,7 +143,7 @@ pub struct Wallet {
 }
 
 /// Represents the seed used for wallet generation.
-#[derive(Debug, Clone)]
+#[derive(Clone)]
 pub enum Seed {
 	/// A BIP 39 mnemonic seed.
 	Mnemonic {
@@ -156,6 +156,19 @@ pub enum Seed {
 	Seed64([u8; 64]),
 }
 
+impl Debug for Seed {
+	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+		match self {
+			Seed::Mnemonic { .. } => f
+				.debug_struct("Mnemonic")
+				.field("mnemonic", &"<redacted>")
+				.field("passphrase", &"<redacted>")
+				.finish(),
+			Seed::Seed64(_) => f.debug_tuple("Seed64").field(&"<redacted>").finish(),
+		}
+	}
+}
+
 impl Seed {
 	pub(crate) fn to_node_entropy(&self) -> NodeEntropy {
 		match self {
@@ -1497,3 +1510,28 @@ impl Wallet {
 		Ok(())
 	}
 }
+
+#[cfg(test)]
+mod tests {
+	use super::*;
+	use ldk_node::bip39::Mnemonic;
+
+	#[test]
+	fn seed_debug_redacts_seed64_bytes() {
+		let seed = Seed::Seed64([42; 64]);
+
+		assert_eq!(format!("{seed:?}"), "Seed64(\"<redacted>\")");
+	}
+
+	#[test]
+	fn seed_debug_redacts_mnemonic_and_passphrase() {
+		let mnemonic =
+			Mnemonic::from_entropy(&[0; 16]).expect("static test entropy should be valid");
+		let seed = Seed::Mnemonic { mnemonic, passphrase: Some("test passphrase".to_owned()) };
+		let debug = format!("{seed:?}");
+
+		assert_eq!(debug, "Mnemonic { mnemonic: \"<redacted>\", passphrase: \"<redacted>\" }");
+		assert!(!debug.contains("abandon"));
+		assert!(!debug.contains("test passphrase"));
+	}
+}