Don't panic on reading invalid seed file

Author: tnull

bindings/ldk_node.udl

@@ -120,6 +120,7 @@ enum NodeError {
 [Error]
 enum BuildError {
 	"InvalidSeedBytes",
+	"InvalidSeedFile",
 	"InvalidSystemTime",
 	"ReadFailed",
 	"WriteFailed",

src/builder.rs

@@ -72,8 +72,10 @@ enum GossipSourceConfig {
 /// [`Node`]: crate::Node
 #[derive(Debug, Clone)]
 pub enum BuildError {
-	/// The given seed bytes are invalid, e.g, are of invalid length.
+	/// The given seed bytes are invalid, e.g., have invalid length.
 	InvalidSeedBytes,
+	/// The given seed file is invalid, e.g., has invalid length, or could not be read.
+	InvalidSeedFile,
 	/// The current system time is invalid, clocks might have gone backwards.
 	InvalidSystemTime,
 	/// We failed to read data from the [`KVStore`].
@@ -92,6 +94,7 @@ impl fmt::Display for BuildError {
 	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 		match *self {
 			Self::InvalidSeedBytes => write!(f, "Given seed bytes are invalid."),
+			Self::InvalidSeedFile => write!(f, "Given seed file is invalid or could not be read."),
 			Self::InvalidSystemTime => {
 				write!(f, "System time is invalid. Clocks might have gone back in time.")
 			}
@@ -389,7 +392,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 	let seed_bytes = match entropy_source_config {
 		Some(EntropySourceConfig::SeedBytes(bytes)) => bytes.clone(),
 		Some(EntropySourceConfig::SeedFile(seed_path)) => {
-			io::utils::read_or_generate_seed_file(seed_path)
+			io::utils::read_or_generate_seed_file(seed_path, Arc::clone(&logger))
+				.map_err(|_| BuildError::InvalidSeedFile)?
 		}
 		Some(EntropySourceConfig::Bip39Mnemonic { mnemonic, passphrase }) => match passphrase {
 			Some(passphrase) => mnemonic.to_seed(passphrase),
@@ -398,7 +402,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 		None => {
 			// Default to read or generate from the default location generate a seed file.
 			let seed_path = format!("{}/keys_seed", config.storage_dir_path);
-			io::utils::read_or_generate_seed_file(&seed_path)
+			io::utils::read_or_generate_seed_file(&seed_path, Arc::clone(&logger))
+				.map_err(|_| BuildError::InvalidSeedFile)?
 		}
 	};
 

src/io/utils.rs

@@ -39,25 +39,53 @@ pub fn generate_entropy_mnemonic() -> Mnemonic {
 	Mnemonic::from_entropy(&entropy).unwrap()
 }
 
-pub(crate) fn read_or_generate_seed_file(keys_seed_path: &str) -> [u8; WALLET_KEYS_SEED_LEN] {
+pub(crate) fn read_or_generate_seed_file<L: Deref>(
+	keys_seed_path: &str, logger: L,
+) -> std::io::Result<[u8; WALLET_KEYS_SEED_LEN]>
+where
+	L::Target: Logger,
+{
 	if Path::new(&keys_seed_path).exists() {
-		let seed = fs::read(keys_seed_path).expect("Failed to read keys seed file");
-		assert_eq!(
-			seed.len(),
-			WALLET_KEYS_SEED_LEN,
-			"Failed to read keys seed file: unexpected length"
-		);
+		let seed = fs::read(keys_seed_path).map_err(|e| {
+			log_error!(logger, "Failed to read keys seed file: {}", keys_seed_path);
+			e
+		})?;
+
+		if seed.len() != WALLET_KEYS_SEED_LEN {
+			log_error!(
+				logger,
+				"Failed to read keys seed file due to invalid length: {}",
+				keys_seed_path
+			);
+			return Err(std::io::Error::new(
+				std::io::ErrorKind::InvalidData,
+				"Failed to read keys seed file due to invalid length",
+			));
+		}
+
 		let mut key = [0; WALLET_KEYS_SEED_LEN];
 		key.copy_from_slice(&seed);
-		key
+		Ok(key)
 	} else {
 		let mut key = [0; WALLET_KEYS_SEED_LEN];
 		thread_rng().fill_bytes(&mut key);
 
-		let mut f = fs::File::create(keys_seed_path).expect("Failed to create keys seed file");
-		f.write_all(&key).expect("Failed to write node keys seed to disk");
-		f.sync_all().expect("Failed to sync node keys seed to disk");
-		key
+		let mut f = fs::File::create(keys_seed_path).map_err(|e| {
+			log_error!(logger, "Failed to create keys seed file: {}", keys_seed_path);
+			e
+		})?;
+
+		f.write_all(&key).map_err(|e| {
+			log_error!(logger, "Failed to write node keys seed to disk: {}", keys_seed_path);
+			e
+		})?;
+
+		f.sync_all().map_err(|e| {
+			log_error!(logger, "Failed to sync node keys seed to disk: {}", keys_seed_path);
+			e
+		})?;
+
+		Ok(key)
 	}
 }