]> git.bitcoin.ninja Git - rust-lightning/blob - lightning-persister/src/lib.rs
Merge pull request #2226 from alecchendev/2023-04-persist-network-graph-on-rgs
[rust-lightning] / lightning-persister / src / lib.rs
1 //! Utilities that handle persisting Rust-Lightning data to disk via standard filesystem APIs.
2
3 // Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
4 #![deny(broken_intra_doc_links)]
5 #![deny(private_intra_doc_links)]
6
7 #![deny(missing_docs)]
8
9 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
10
11 #![cfg_attr(all(test, feature = "_bench_unstable"), feature(test))]
12 #[cfg(all(test, feature = "_bench_unstable"))] extern crate test;
13
14 mod util;
15
16 extern crate lightning;
17 extern crate bitcoin;
18 extern crate libc;
19
20 use bitcoin::hash_types::{BlockHash, Txid};
21 use bitcoin::hashes::hex::FromHex;
22 use lightning::chain::channelmonitor::ChannelMonitor;
23 use lightning::sign::{EntropySource, SignerProvider};
24 use lightning::util::ser::{ReadableArgs, Writeable};
25 use lightning::util::persist::KVStorePersister;
26 use std::fs;
27 use std::io::Cursor;
28 use std::ops::Deref;
29 use std::path::{Path, PathBuf};
30
31 /// FilesystemPersister persists channel data on disk, where each channel's
32 /// data is stored in a file named after its funding outpoint.
33 ///
34 /// Warning: this module does the best it can with calls to persist data, but it
35 /// can only guarantee that the data is passed to the drive. It is up to the
36 /// drive manufacturers to do the actual persistence properly, which they often
37 /// don't (especially on consumer-grade hardware). Therefore, it is up to the
38 /// user to validate their entire storage stack, to ensure the writes are
39 /// persistent.
40 /// Corollary: especially when dealing with larger amounts of money, it is best
41 /// practice to have multiple channel data backups and not rely only on one
42 /// FilesystemPersister.
43 pub struct FilesystemPersister {
44         path_to_channel_data: String,
45 }
46
47 impl FilesystemPersister {
48         /// Initialize a new FilesystemPersister and set the path to the individual channels'
49         /// files.
50         pub fn new(path_to_channel_data: String) -> Self {
51                 Self {
52                         path_to_channel_data,
53                 }
54         }
55
56         /// Get the directory which was provided when this persister was initialized.
57         pub fn get_data_dir(&self) -> String {
58                 self.path_to_channel_data.clone()
59         }
60
61         /// Read `ChannelMonitor`s from disk.
62         pub fn read_channelmonitors<ES: Deref, SP: Deref> (
63                 &self, entropy_source: ES, signer_provider: SP
64         ) -> std::io::Result<Vec<(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>>
65                 where
66                         ES::Target: EntropySource + Sized,
67                         SP::Target: SignerProvider + Sized
68         {
69                 let mut path = PathBuf::from(&self.path_to_channel_data);
70                 path.push("monitors");
71                 if !Path::new(&path).exists() {
72                         return Ok(Vec::new());
73                 }
74                 let mut res = Vec::new();
75                 for file_option in fs::read_dir(path)? {
76                         let file = file_option.unwrap();
77                         let owned_file_name = file.file_name();
78                         let filename = owned_file_name.to_str()
79                                 .ok_or_else(|| std::io::Error::new(std::io::ErrorKind::InvalidData,
80                                         "File name is not a valid utf8 string"))?;
81                         if !filename.is_ascii() || filename.len() < 65 {
82                                 return Err(std::io::Error::new(
83                                         std::io::ErrorKind::InvalidData,
84                                         "Invalid ChannelMonitor file name",
85                                 ));
86                         }
87                         if filename.ends_with(".tmp") {
88                                 // If we were in the middle of committing an new update and crashed, it should be
89                                 // safe to ignore the update - we should never have returned to the caller and
90                                 // irrevocably committed to the new state in any way.
91                                 continue;
92                         }
93
94                         let txid = Txid::from_hex(filename.split_at(64).0)
95                                 .map_err(|_| std::io::Error::new(
96                                         std::io::ErrorKind::InvalidData,
97                                         "Invalid tx ID in filename",
98                                 ))?;
99
100                         let index = filename.split_at(65).1.parse()
101                                 .map_err(|_| std::io::Error::new(
102                                         std::io::ErrorKind::InvalidData,
103                                         "Invalid tx index in filename",
104                                 ))?;
105
106                         let contents = fs::read(&file.path())?;
107                         let mut buffer = Cursor::new(&contents);
108                         match <(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>::read(&mut buffer, (&*entropy_source, &*signer_provider)) {
109                                 Ok((blockhash, channel_monitor)) => {
110                                         if channel_monitor.get_funding_txo().0.txid != txid || channel_monitor.get_funding_txo().0.index != index {
111                                                 return Err(std::io::Error::new(std::io::ErrorKind::InvalidData,
112                                                                                "ChannelMonitor was stored in the wrong file"));
113                                         }
114                                         res.push((blockhash, channel_monitor));
115                                 }
116                                 Err(e) => return Err(std::io::Error::new(
117                                         std::io::ErrorKind::InvalidData,
118                                         format!("Failed to deserialize ChannelMonitor: {}", e),
119                                 ))
120                         }
121                 }
122                 Ok(res)
123         }
124 }
125
126 impl KVStorePersister for FilesystemPersister {
127         fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
128                 let mut dest_file = PathBuf::from(self.path_to_channel_data.clone());
129                 dest_file.push(key);
130                 util::write_to_file(dest_file, object)
131         }
132 }
133
134 #[cfg(test)]
135 mod tests {
136         extern crate lightning;
137         extern crate bitcoin;
138         use crate::FilesystemPersister;
139         use bitcoin::hashes::hex::FromHex;
140         use bitcoin::Txid;
141         use lightning::chain::ChannelMonitorUpdateStatus;
142         use lightning::chain::chainmonitor::Persist;
143         use lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID;
144         use lightning::chain::transaction::OutPoint;
145         use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
146         use lightning::events::{ClosureReason, MessageSendEventsProvider};
147         use lightning::ln::functional_test_utils::*;
148         use lightning::util::test_utils;
149         use std::fs;
150         #[cfg(target_os = "windows")]
151         use {
152                 lightning::get_event_msg,
153                 lightning::ln::msgs::ChannelMessageHandler,
154         };
155
156         impl Drop for FilesystemPersister {
157                 fn drop(&mut self) {
158                         // We test for invalid directory names, so it's OK if directory removal
159                         // fails.
160                         match fs::remove_dir_all(&self.path_to_channel_data) {
161                                 Err(e) => println!("Failed to remove test persister directory: {}", e),
162                                 _ => {}
163                         }
164                 }
165         }
166
167         #[test]
168         fn test_if_monitors_is_not_dir() {
169                 let persister = FilesystemPersister::new("test_monitors_is_not_dir".to_string());
170
171                 fs::create_dir_all(&persister.path_to_channel_data).unwrap();
172                 let mut path = std::path::PathBuf::from(&persister.path_to_channel_data);
173                 path.push("monitors");
174                 fs::File::create(path).unwrap();
175
176                 let chanmon_cfgs = create_chanmon_cfgs(1);
177                 let mut node_cfgs = create_node_cfgs(1, &chanmon_cfgs);
178                 let chain_mon_0 = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &persister, node_cfgs[0].keys_manager);
179                 node_cfgs[0].chain_monitor = chain_mon_0;
180                 let node_chanmgrs = create_node_chanmgrs(1, &node_cfgs, &[None]);
181                 let nodes = create_network(1, &node_cfgs, &node_chanmgrs);
182
183                 // Check that read_channelmonitors() returns error if monitors/ is not a
184                 // directory.
185                 assert!(persister.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).is_err());
186         }
187
188         // Integration-test the FilesystemPersister. Test relaying a few payments
189         // and check that the persisted data is updated the appropriate number of
190         // times.
191         #[test]
192         fn test_filesystem_persister() {
193                 // Create the nodes, giving them FilesystemPersisters for data persisters.
194                 let persister_0 = FilesystemPersister::new("test_filesystem_persister_0".to_string());
195                 let persister_1 = FilesystemPersister::new("test_filesystem_persister_1".to_string());
196                 let chanmon_cfgs = create_chanmon_cfgs(2);
197                 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
198                 let chain_mon_0 = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &persister_0, node_cfgs[0].keys_manager);
199                 let chain_mon_1 = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[1].chain_source), &chanmon_cfgs[1].tx_broadcaster, &chanmon_cfgs[1].logger, &chanmon_cfgs[1].fee_estimator, &persister_1, node_cfgs[1].keys_manager);
200                 node_cfgs[0].chain_monitor = chain_mon_0;
201                 node_cfgs[1].chain_monitor = chain_mon_1;
202                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
203                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
204
205                 // Check that the persisted channel data is empty before any channels are
206                 // open.
207                 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
208                 assert_eq!(persisted_chan_data_0.len(), 0);
209                 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
210                 assert_eq!(persisted_chan_data_1.len(), 0);
211
212                 // Helper to make sure the channel is on the expected update ID.
213                 macro_rules! check_persisted_data {
214                         ($expected_update_id: expr) => {
215                                 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
216                                 assert_eq!(persisted_chan_data_0.len(), 1);
217                                 for (_, mon) in persisted_chan_data_0.iter() {
218                                         assert_eq!(mon.get_latest_update_id(), $expected_update_id);
219                                 }
220                                 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
221                                 assert_eq!(persisted_chan_data_1.len(), 1);
222                                 for (_, mon) in persisted_chan_data_1.iter() {
223                                         assert_eq!(mon.get_latest_update_id(), $expected_update_id);
224                                 }
225                         }
226                 }
227
228                 // Create some initial channel and check that a channel was persisted.
229                 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
230                 check_persisted_data!(0);
231
232                 // Send a few payments and make sure the monitors are updated to the latest.
233                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
234                 check_persisted_data!(5);
235                 send_payment(&nodes[1], &vec!(&nodes[0])[..], 4000000);
236                 check_persisted_data!(10);
237
238                 // Force close because cooperative close doesn't result in any persisted
239                 // updates.
240                 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
241                 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
242                 check_closed_broadcast!(nodes[0], true);
243                 check_added_monitors!(nodes[0], 1);
244
245                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
246                 assert_eq!(node_txn.len(), 1);
247
248                 connect_block(&nodes[1], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![node_txn[0].clone(), node_txn[0].clone()]));
249                 check_closed_broadcast!(nodes[1], true);
250                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
251                 check_added_monitors!(nodes[1], 1);
252
253                 // Make sure everything is persisted as expected after close.
254                 check_persisted_data!(CLOSED_CHANNEL_UPDATE_ID);
255         }
256
257         // Test that if the persister's path to channel data is read-only, writing a
258         // monitor to it results in the persister returning a PermanentFailure.
259         // Windows ignores the read-only flag for folders, so this test is Unix-only.
260         #[cfg(not(target_os = "windows"))]
261         #[test]
262         fn test_readonly_dir_perm_failure() {
263                 let persister = FilesystemPersister::new("test_readonly_dir_perm_failure".to_string());
264                 fs::create_dir_all(&persister.path_to_channel_data).unwrap();
265
266                 // Set up a dummy channel and force close. This will produce a monitor
267                 // that we can then use to test persistence.
268                 let chanmon_cfgs = create_chanmon_cfgs(2);
269                 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
270                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
271                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
272                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
273                 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
274                 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
275                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
276                 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
277                 let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
278
279                 // Set the persister's directory to read-only, which should result in
280                 // returning a permanent failure when we then attempt to persist a
281                 // channel update.
282                 let path = &persister.path_to_channel_data;
283                 let mut perms = fs::metadata(path).unwrap().permissions();
284                 perms.set_readonly(true);
285                 fs::set_permissions(path, perms).unwrap();
286
287                 let test_txo = OutPoint {
288                         txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
289                         index: 0
290                 };
291                 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
292                         ChannelMonitorUpdateStatus::PermanentFailure => {},
293                         _ => panic!("unexpected result from persisting new channel")
294                 }
295
296                 nodes[1].node.get_and_clear_pending_msg_events();
297                 added_monitors.clear();
298         }
299
300         // Test that if a persister's directory name is invalid, monitor persistence
301         // will fail.
302         #[cfg(target_os = "windows")]
303         #[test]
304         fn test_fail_on_open() {
305                 // Set up a dummy channel and force close. This will produce a monitor
306                 // that we can then use to test persistence.
307                 let chanmon_cfgs = create_chanmon_cfgs(2);
308                 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
309                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
310                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
311                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
312                 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
313                 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
314                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
315                 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
316                 let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
317
318                 // Create the persister with an invalid directory name and test that the
319                 // channel fails to open because the directories fail to be created. There
320                 // don't seem to be invalid filename characters on Unix that Rust doesn't
321                 // handle, hence why the test is Windows-only.
322                 let persister = FilesystemPersister::new(":<>/".to_string());
323
324                 let test_txo = OutPoint {
325                         txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
326                         index: 0
327                 };
328                 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
329                         ChannelMonitorUpdateStatus::PermanentFailure => {},
330                         _ => panic!("unexpected result from persisting new channel")
331                 }
332
333                 nodes[1].node.get_and_clear_pending_msg_events();
334                 added_monitors.clear();
335         }
336 }
337
338 #[cfg(all(test, feature = "_bench_unstable"))]
339 pub mod bench {
340         use test::Bencher;
341
342         #[bench]
343         fn bench_sends(bench: &mut Bencher) {
344                 let persister_a = super::FilesystemPersister::new("bench_filesystem_persister_a".to_string());
345                 let persister_b = super::FilesystemPersister::new("bench_filesystem_persister_b".to_string());
346                 lightning::ln::channelmanager::bench::bench_two_sends(bench, persister_a, persister_b);
347         }
348 }