_ Git - rust-lightning/blob - fuzz/src/chanmon_consistency.rs

   1 //! Test that monitor update failures don't get our channel state out of sync.
   2 //! One of the biggest concern with the monitor update failure handling code is that messages
   3 //! resent after monitor updating is restored are delivered out-of-order, resulting in
   4 //! commitment_signed messages having "invalid signatures".
   5 //! To test this we stand up a network of three nodes and read bytes from the fuzz input to denote
   6 //! actions such as sending payments, handling events, or changing monitor update return values on
   7 //! a per-node basis. This should allow it to find any cases where the ordering of actions results
   8 //! in us getting out of sync with ourselves, and, assuming at least one of our recieve- or
   9 //! send-side handling is correct, other peers. We consider it a failure if any action results in a
  10 //! channel being force-closed.
  11
  12 use bitcoin::BitcoinHash;
  13 use bitcoin::blockdata::block::BlockHeader;
  14 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  15 use bitcoin::blockdata::script::{Builder, Script};
  16 use bitcoin::blockdata::opcodes;
  17 use bitcoin::network::constants::Network;
  18
  19 use bitcoin_hashes::Hash as TraitImport;
  20 use bitcoin_hashes::hash160::Hash as Hash160;
  21 use bitcoin_hashes::sha256::Hash as Sha256;
  22 use bitcoin_hashes::sha256d::Hash as Sha256d;
  23
  24 use lightning::chain::chaininterface;
  25 use lightning::chain::transaction::OutPoint;
  26 use lightning::chain::chaininterface::{BroadcasterInterface,ConfirmationTarget,ChainListener,FeeEstimator,ChainWatchInterfaceUtil};
  27 use lightning::chain::keysinterface::{KeysInterface, InMemoryChannelKeys};
  28 use lightning::ln::channelmonitor;
  29 use lightning::ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, HTLCUpdate};
  30 use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, ChannelManagerReadArgs};
  31 use lightning::ln::router::{Route, RouteHop};
  32 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, ErrorAction, LightningError, UpdateAddHTLC, LocalFeatures};
  33 use lightning::util::enforcing_trait_impls::EnforcingChannelKeys;
  34 use lightning::util::events;
  35 use lightning::util::logger::Logger;
  36 use lightning::util::config::UserConfig;
  37 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
  38 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
  39
  40 use utils::test_logger;
  41
  42 use secp256k1::key::{PublicKey,SecretKey};
  43 use secp256k1::Secp256k1;
  44
  45 use std::mem;
  46 use std::cmp::Ordering;
  47 use std::collections::{HashSet, hash_map, HashMap};
  48 use std::sync::{Arc,Mutex};
  49 use std::sync::atomic;
  50 use std::io::Cursor;
  51
  52 struct FuzzEstimator {}
  53 impl FeeEstimator for FuzzEstimator {
  54         fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
  55                 253
  56         }
  57 }
  58
  59 pub struct TestBroadcaster {}
  60 impl BroadcasterInterface for TestBroadcaster {
  61         fn broadcast_transaction(&self, _tx: &Transaction) { }
  62 }
  63
  64 pub struct VecWriter(pub Vec<u8>);
  65 impl Writer for VecWriter {
  66         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
  67                 self.0.extend_from_slice(buf);
  68                 Ok(())
  69         }
  70         fn size_hint(&mut self, size: usize) {
  71                 self.0.reserve_exact(size);
  72         }
  73 }
  74
  75 static mut IN_RESTORE: bool = false;
  76 pub struct TestChannelMonitor {
  77         pub simple_monitor: Arc<channelmonitor::SimpleManyChannelMonitor<OutPoint>>,
  78         pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
  79         pub latest_good_update: Mutex<HashMap<OutPoint, Vec<u8>>>,
  80         pub latest_update_good: Mutex<HashMap<OutPoint, bool>>,
  81         pub latest_updates_good_at_last_ser: Mutex<HashMap<OutPoint, bool>>,
  82         pub should_update_manager: atomic::AtomicBool,
  83 }
  84 impl TestChannelMonitor {
  85         pub fn new(chain_monitor: Arc<dyn chaininterface::ChainWatchInterface>, broadcaster: Arc<dyn chaininterface::BroadcasterInterface>, logger: Arc<dyn Logger>, feeest: Arc<dyn chaininterface::FeeEstimator>) -> Self {
  86                 Self {
  87                         simple_monitor: channelmonitor::SimpleManyChannelMonitor::new(chain_monitor, broadcaster, logger, feeest),
  88                         update_ret: Mutex::new(Ok(())),
  89                         latest_good_update: Mutex::new(HashMap::new()),
  90                         latest_update_good: Mutex::new(HashMap::new()),
  91                         latest_updates_good_at_last_ser: Mutex::new(HashMap::new()),
  92                         should_update_manager: atomic::AtomicBool::new(false),
  93                 }
  94         }
  95 }
  96 impl channelmonitor::ManyChannelMonitor for TestChannelMonitor {
  97         fn add_update_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
  98                 let ret = self.update_ret.lock().unwrap().clone();
  99                 if let Ok(()) = ret {
 100                         let mut ser = VecWriter(Vec::new());
 101                         monitor.write_for_disk(&mut ser).unwrap();
 102                         self.latest_good_update.lock().unwrap().insert(funding_txo, ser.0);
 103                         match self.latest_update_good.lock().unwrap().entry(funding_txo) {
 104                                 hash_map::Entry::Vacant(e) => { e.insert(true); },
 105                                 hash_map::Entry::Occupied(mut e) => {
 106                                         if !e.get() && unsafe { IN_RESTORE } {
 107                                                 // Technically we can't consider an update to be "good" unless we're doing
 108                                                 // it in response to a test_restore_channel_monitor as the channel may
 109                                                 // still be waiting on such a call, so only set us to good if we're in the
 110                                                 // middle of a restore call.
 111                                                 e.insert(true);
 112                                         }
 113                                 },
 114                         }
 115                         self.should_update_manager.store(true, atomic::Ordering::Relaxed);
 116                 } else {
 117                         self.latest_update_good.lock().unwrap().insert(funding_txo, false);
 118                 }
 119                 assert!(self.simple_monitor.add_update_monitor(funding_txo, monitor).is_ok());
 120                 ret
 121         }
 122
 123         fn fetch_pending_htlc_updated(&self) -> Vec<HTLCUpdate> {
 124                 return self.simple_monitor.fetch_pending_htlc_updated();
 125         }
 126 }
 127
 128 struct KeyProvider {
 129         node_id: u8,
 130         session_id: atomic::AtomicU8,
 131         channel_id: atomic::AtomicU8,
 132 }
 133 impl KeysInterface for KeyProvider {
 134         type ChanKeySigner = EnforcingChannelKeys;
 135
 136         fn get_node_secret(&self) -> SecretKey {
 137                 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_id]).unwrap()
 138         }
 139
 140         fn get_destination_script(&self) -> Script {
 141                 let secp_ctx = Secp256k1::signing_only();
 142                 let channel_monitor_claim_key = SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, self.node_id]).unwrap();
 143                 let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
 144                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
 145         }
 146
 147         fn get_shutdown_pubkey(&self) -> PublicKey {
 148                 let secp_ctx = Secp256k1::signing_only();
 149                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, self.node_id]).unwrap())
 150         }
 151
 152         fn get_channel_keys(&self, _inbound: bool) -> EnforcingChannelKeys {
 153                 EnforcingChannelKeys::new(InMemoryChannelKeys {
 154                         funding_key:               SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, self.node_id]).unwrap(),
 155                         revocation_base_key:       SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, self.node_id]).unwrap(),
 156                         payment_base_key:          SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, self.node_id]).unwrap(),
 157                         delayed_payment_base_key:  SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, self.node_id]).unwrap(),
 158                         htlc_base_key:             SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8, self.node_id]).unwrap(),
 159                         commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9, self.node_id],
 160                 })
 161         }
 162
 163         fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
 164                 let id = self.session_id.fetch_add(1, atomic::Ordering::Relaxed);
 165                 (SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, id, 10, self.node_id]).unwrap(),
 166                 [0; 32])
 167         }
 168
 169         fn get_channel_id(&self) -> [u8; 32] {
 170                 let id = self.channel_id.fetch_add(1, atomic::Ordering::Relaxed);
 171                 [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, id, 11, self.node_id]
 172         }
 173 }
 174
 175 #[inline]
 176 pub fn do_test(data: &[u8]) {
 177         let fee_est = Arc::new(FuzzEstimator{});
 178         let broadcast = Arc::new(TestBroadcaster{});
 179
 180         macro_rules! make_node {
 181                 ($node_id: expr) => { {
 182                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
 183                         let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
 184                         let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
 185
 186                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
 187                         let mut config = UserConfig::default();
 188                         config.channel_options.fee_proportional_millionths = 0;
 189                         config.channel_options.announced_channel = true;
 190                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
 191                         (ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0).unwrap(),
 192                         monitor)
 193                 } }
 194         }
 195
 196         macro_rules! reload_node {
 197                 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
 198                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
 199                         let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
 200                         let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
 201
 202                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
 203                         let mut config = UserConfig::default();
 204                         config.channel_options.fee_proportional_millionths = 0;
 205                         config.channel_options.announced_channel = true;
 206                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
 207
 208                         let mut monitors = HashMap::new();
 209                         let mut old_monitors = $old_monitors.latest_good_update.lock().unwrap();
 210                         for (outpoint, monitor_ser) in old_monitors.drain() {
 211                                 monitors.insert(outpoint, <(Sha256d, ChannelMonitor)>::read(&mut Cursor::new(&monitor_ser), Arc::clone(&logger)).expect("Failed to read monitor").1);
 212                                 monitor.latest_good_update.lock().unwrap().insert(outpoint, monitor_ser);
 213                         }
 214                         let mut monitor_refs = HashMap::new();
 215                         for (outpoint, monitor) in monitors.iter_mut() {
 216                                 monitor_refs.insert(*outpoint, monitor);
 217                         }
 218
 219                         let read_args = ChannelManagerReadArgs {
 220                                 keys_manager,
 221                                 fee_estimator: fee_est.clone(),
 222                                 monitor: monitor.clone(),
 223                                 tx_broadcaster: broadcast.clone(),
 224                                 logger,
 225                                 default_config: config,
 226                                 channel_monitors: &mut monitor_refs,
 227                         };
 228
 229                         let res = (<(Sha256d, ChannelManager<EnforcingChannelKeys>)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, monitor);
 230                         for (_, was_good) in $old_monitors.latest_updates_good_at_last_ser.lock().unwrap().iter() {
 231                                 if !was_good {
 232                                         // If the last time we updated a monitor we didn't successfully update (and we
 233                                         // have sense updated our serialized copy of the ChannelManager) we may
 234                                         // force-close the channel on our counterparty cause we know we're missing
 235                                         // something. Thus, we just return here since we can't continue to test.
 236                                         return;
 237                                 }
 238                         }
 239                         res
 240                 } }
 241         }
 242
 243         let mut channel_txn = Vec::new();
 244         macro_rules! make_channel {
 245                 ($source: expr, $dest: expr, $chan_id: expr) => { {
 246                         $source.create_channel($dest.get_our_node_id(), 10000000, 42, 0).unwrap();
 247                         let open_channel = {
 248                                 let events = $source.get_and_clear_pending_msg_events();
 249                                 assert_eq!(events.len(), 1);
 250                                 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
 251                                         msg.clone()
 252                                 } else { panic!("Wrong event type"); }
 253                         };
 254
 255                         $dest.handle_open_channel(&$source.get_our_node_id(), LocalFeatures::new(), &open_channel).unwrap();
 256                         let accept_channel = {
 257                                 let events = $dest.get_and_clear_pending_msg_events();
 258                                 assert_eq!(events.len(), 1);
 259                                 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
 260                                         msg.clone()
 261                                 } else { panic!("Wrong event type"); }
 262                         };
 263
 264                         $source.handle_accept_channel(&$dest.get_our_node_id(), LocalFeatures::new(), &accept_channel).unwrap();
 265                         {
 266                                 let events = $source.get_and_clear_pending_events();
 267                                 assert_eq!(events.len(), 1);
 268                                 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
 269                                         let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 270                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 271                                         }]};
 272                                         let funding_output = OutPoint::new(tx.txid(), 0);
 273                                         $source.funding_transaction_generated(&temporary_channel_id, funding_output);
 274                                         channel_txn.push(tx);
 275                                 } else { panic!("Wrong event type"); }
 276                         }
 277
 278                         let funding_created = {
 279                                 let events = $source.get_and_clear_pending_msg_events();
 280                                 assert_eq!(events.len(), 1);
 281                                 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
 282                                         msg.clone()
 283                                 } else { panic!("Wrong event type"); }
 284                         };
 285                         $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created).unwrap();
 286
 287                         let funding_signed = {
 288                                 let events = $dest.get_and_clear_pending_msg_events();
 289                                 assert_eq!(events.len(), 1);
 290                                 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
 291                                         msg.clone()
 292                                 } else { panic!("Wrong event type"); }
 293                         };
 294                         $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed).unwrap();
 295
 296                         {
 297                                 let events = $source.get_and_clear_pending_events();
 298                                 assert_eq!(events.len(), 1);
 299                                 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
 300                                 } else { panic!("Wrong event type"); }
 301                         }
 302                 } }
 303         }
 304
 305         macro_rules! confirm_txn {
 306                 ($node: expr) => { {
 307                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 308                         let mut txn = Vec::with_capacity(channel_txn.len());
 309                         let mut posn = Vec::with_capacity(channel_txn.len());
 310                         for i in 0..channel_txn.len() {
 311                                 txn.push(&channel_txn[i]);
 312                                 posn.push(i as u32 + 1);
 313                         }
 314                         $node.block_connected(&header, 1, &txn, &posn);
 315                         for i in 2..100 {
 316                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 317                                 $node.block_connected(&header, i, &Vec::new(), &[0; 0]);
 318                         }
 319                 } }
 320         }
 321
 322         macro_rules! lock_fundings {
 323                 ($nodes: expr) => { {
 324                         let mut node_events = Vec::new();
 325                         for node in $nodes.iter() {
 326                                 node_events.push(node.get_and_clear_pending_msg_events());
 327                         }
 328                         for (idx, node_event) in node_events.iter().enumerate() {
 329                                 for event in node_event {
 330                                         if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
 331                                                 for node in $nodes.iter() {
 332                                                         if node.get_our_node_id() == *node_id {
 333                                                                 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg).unwrap();
 334                                                         }
 335                                                 }
 336                                         } else { panic!("Wrong event type"); }
 337                                 }
 338                         }
 339
 340                         for node in $nodes.iter() {
 341                                 let events = node.get_and_clear_pending_msg_events();
 342                                 for event in events {
 343                                         if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
 344                                         } else { panic!("Wrong event type"); }
 345                                 }
 346                         }
 347                 } }
 348         }
 349
 350         // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
 351         // forwarding.
 352         let (mut node_a, mut monitor_a) = make_node!(0);
 353         let (mut node_b, mut monitor_b) = make_node!(1);
 354         let (mut node_c, mut monitor_c) = make_node!(2);
 355
 356         let mut nodes = [node_a, node_b, node_c];
 357
 358         make_channel!(nodes[0], nodes[1], 0);
 359         make_channel!(nodes[1], nodes[2], 1);
 360
 361         for node in nodes.iter() {
 362                 confirm_txn!(node);
 363         }
 364
 365         lock_fundings!(nodes);
 366
 367         let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
 368         let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
 369
 370         let mut payment_id = 0;
 371
 372         let mut chan_a_disconnected = false;
 373         let mut chan_b_disconnected = false;
 374         let mut ba_events = Vec::new();
 375         let mut bc_events = Vec::new();
 376
 377         let mut node_a_ser = VecWriter(Vec::new());
 378         nodes[0].write(&mut node_a_ser).unwrap();
 379         let mut node_b_ser = VecWriter(Vec::new());
 380         nodes[1].write(&mut node_b_ser).unwrap();
 381         let mut node_c_ser = VecWriter(Vec::new());
 382         nodes[2].write(&mut node_c_ser).unwrap();
 383
 384         macro_rules! test_err {
 385                 ($res: expr) => {
 386                         match $res {
 387                                 Ok(()) => {},
 388                                 Err(LightningError { action: ErrorAction::IgnoreError, .. }) => { },
 389                                 _ => { $res.unwrap() },
 390                         }
 391                 }
 392         }
 393
 394         macro_rules! test_return {
 395                 () => { {
 396                         assert_eq!(nodes[0].list_channels().len(), 1);
 397                         assert_eq!(nodes[1].list_channels().len(), 2);
 398                         assert_eq!(nodes[2].list_channels().len(), 1);
 399                         return;
 400                 } }
 401         }
 402
 403         let mut read_pos = 0;
 404         macro_rules! get_slice {
 405                 ($len: expr) => {
 406                         {
 407                                 let slice_len = $len as usize;
 408                                 if data.len() < read_pos + slice_len {
 409                                         test_return!();
 410                                 }
 411                                 read_pos += slice_len;
 412                                 &data[read_pos - slice_len..read_pos]
 413                         }
 414                 }
 415         }
 416
 417         loop {
 418                 macro_rules! send_payment {
 419                         ($source: expr, $dest: expr) => { {
 420                                 let payment_hash = Sha256::hash(&[payment_id; 1]);
 421                                 payment_id = payment_id.wrapping_add(1);
 422                                 if let Err(_) = $source.send_payment(Route {
 423                                         hops: vec![RouteHop {
 424                                                 pubkey: $dest.0.get_our_node_id(),
 425                                                 short_channel_id: $dest.1,
 426                                                 fee_msat: 5000000,
 427                                                 cltv_expiry_delta: 200,
 428                                         }],
 429                                 }, PaymentHash(payment_hash.into_inner())) {
 430                                         // Probably ran out of funds
 431                                         test_return!();
 432                                 }
 433                         } };
 434                         ($source: expr, $middle: expr, $dest: expr) => { {
 435                                 let payment_hash = Sha256::hash(&[payment_id; 1]);
 436                                 payment_id = payment_id.wrapping_add(1);
 437                                 if let Err(_) = $source.send_payment(Route {
 438                                         hops: vec![RouteHop {
 439                                                 pubkey: $middle.0.get_our_node_id(),
 440                                                 short_channel_id: $middle.1,
 441                                                 fee_msat: 50000,
 442                                                 cltv_expiry_delta: 100,
 443                                         },RouteHop {
 444                                                 pubkey: $dest.0.get_our_node_id(),
 445                                                 short_channel_id: $dest.1,
 446                                                 fee_msat: 5000000,
 447                                                 cltv_expiry_delta: 200,
 448                                         }],
 449                                 }, PaymentHash(payment_hash.into_inner())) {
 450                                         // Probably ran out of funds
 451                                         test_return!();
 452                                 }
 453                         } }
 454                 }
 455
 456                 macro_rules! process_msg_events {
 457                         ($node: expr, $corrupt_forward: expr) => { {
 458                                 let events = if $node == 1 {
 459                                         let mut new_events = Vec::new();
 460                                         mem::swap(&mut new_events, &mut ba_events);
 461                                         new_events.extend_from_slice(&bc_events[..]);
 462                                         bc_events.clear();
 463                                         new_events
 464                                 } else { Vec::new() };
 465                                 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
 466                                         match event {
 467                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, updates: CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
 468                                                         for dest in nodes.iter() {
 469                                                                 if dest.get_our_node_id() == *node_id {
 470                                                                         assert!(update_fee.is_none());
 471                                                                         for update_add in update_add_htlcs {
 472                                                                                 if !$corrupt_forward {
 473                                                                                         test_err!(dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add));
 474                                                                                 } else {
 475                                                                                         // Corrupt the update_add_htlc message so that its HMAC
 476                                                                                         // check will fail and we generate a
 477                                                                                         // update_fail_malformed_htlc instead of an
 478                                                                                         // update_fail_htlc as we do when we reject a payment.
 479                                                                                         let mut msg_ser = update_add.encode();
 480                                                                                         msg_ser[1000] ^= 0xff;
 481                                                                                         let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
 482                                                                                         test_err!(dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg));
 483                                                                                 }
 484                                                                         }
 485                                                                         for update_fulfill in update_fulfill_htlcs {
 486                                                                                 test_err!(dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill));
 487                                                                         }
 488                                                                         for update_fail in update_fail_htlcs {
 489                                                                                 test_err!(dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail));
 490                                                                         }
 491                                                                         for update_fail_malformed in update_fail_malformed_htlcs {
 492                                                                                 test_err!(dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed));
 493                                                                         }
 494                                                                         test_err!(dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed));
 495                                                                 }
 496                                                         }
 497                                                 },
 498                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 499                                                         for dest in nodes.iter() {
 500                                                                 if dest.get_our_node_id() == *node_id {
 501                                                                         test_err!(dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg));
 502                                                                 }
 503                                                         }
 504                                                 },
 505                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 506                                                         for dest in nodes.iter() {
 507                                                                 if dest.get_our_node_id() == *node_id {
 508                                                                         test_err!(dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg));
 509                                                                 }
 510                                                         }
 511                                                 },
 512                                                 events::MessageSendEvent::SendFundingLocked { .. } => {
 513                                                         // Can be generated as a reestablish response
 514                                                 },
 515                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
 516                                                         // Can be generated due to a payment forward being rejected due to a
 517                                                         // channel having previously failed a monitor update
 518                                                 },
 519                                                 _ => panic!("Unhandled message event"),
 520                                         }
 521                                 }
 522                         } }
 523                 }
 524
 525                 macro_rules! drain_msg_events_on_disconnect {
 526                         ($counterparty_id: expr) => { {
 527                                 if $counterparty_id == 0 {
 528                                         for event in nodes[0].get_and_clear_pending_msg_events() {
 529                                                 match event {
 530                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
 531                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
 532                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
 533                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
 534                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
 535                                                         _ => panic!("Unhandled message event"),
 536                                                 }
 537                                         }
 538                                         ba_events.clear();
 539                                 } else {
 540                                         for event in nodes[2].get_and_clear_pending_msg_events() {
 541                                                 match event {
 542                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
 543                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
 544                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
 545                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
 546                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
 547                                                         _ => panic!("Unhandled message event"),
 548                                                 }
 549                                         }
 550                                         bc_events.clear();
 551                                 }
 552                                 let mut events = nodes[1].get_and_clear_pending_msg_events();
 553                                 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
 554                                 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
 555                                 for event in events.drain(..) {
 556                                         let push = match event {
 557                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
 558                                                         if *node_id != drop_node_id { true } else { false }
 559                                                 },
 560                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
 561                                                         if *node_id != drop_node_id { true } else { false }
 562                                                 },
 563                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
 564                                                         if *node_id != drop_node_id { true } else { false }
 565                                                 },
 566                                                 events::MessageSendEvent::SendFundingLocked { .. } => false,
 567                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
 568                                                 _ => panic!("Unhandled message event"),
 569                                         };
 570                                         if push { msg_sink.push(event); }
 571                                 }
 572                         } }
 573                 }
 574
 575                 macro_rules! process_events {
 576                         ($node: expr, $fail: expr) => { {
 577                                 // In case we get 256 payments we may have a hash collision, resulting in the
 578                                 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
 579                                 // deduplicate the calls here.
 580                                 let mut claim_set = HashSet::new();
 581                                 let mut events = nodes[$node].get_and_clear_pending_events();
 582                                 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
 583                                 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
 584                                 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
 585                                 // PaymentReceived event for the second HTLC in our pending_events (and breaking
 586                                 // our claim_set deduplication).
 587                                 events.sort_by(|a, b| {
 588                                         if let events::Event::PaymentReceived { .. } = a {
 589                                                 if let events::Event::PendingHTLCsForwardable { .. } = b {
 590                                                         Ordering::Less
 591                                                 } else { Ordering::Equal }
 592                                         } else if let events::Event::PendingHTLCsForwardable { .. } = a {
 593                                                 if let events::Event::PaymentReceived { .. } = b {
 594                                                         Ordering::Greater
 595                                                 } else { Ordering::Equal }
 596                                         } else { Ordering::Equal }
 597                                 });
 598                                 for event in events.drain(..) {
 599                                         match event {
 600                                                 events::Event::PaymentReceived { payment_hash, .. } => {
 601                                                         if claim_set.insert(payment_hash.0) {
 602                                                                 if $fail {
 603                                                                         assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
 604                                                                 } else {
 605                                                                         assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), 5_000_000));
 606                                                                 }
 607                                                         }
 608                                                 },
 609                                                 events::Event::PaymentSent { .. } => {},
 610                                                 events::Event::PaymentFailed { .. } => {},
 611                                                 events::Event::PendingHTLCsForwardable { .. } => {
 612                                                         nodes[$node].process_pending_htlc_forwards();
 613                                                 },
 614                                                 _ => panic!("Unhandled event"),
 615                                         }
 616                                 }
 617                         } }
 618                 }
 619
 620                 match get_slice!(1)[0] {
 621                         0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 622                         0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 623                         0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 624                         0x03 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
 625                         0x04 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
 626                         0x05 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
 627                         0x06 => { unsafe { IN_RESTORE = true }; nodes[0].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
 628                         0x07 => { unsafe { IN_RESTORE = true }; nodes[1].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
 629                         0x08 => { unsafe { IN_RESTORE = true }; nodes[2].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
 630                         0x09 => send_payment!(nodes[0], (&nodes[1], chan_a)),
 631                         0x0a => send_payment!(nodes[1], (&nodes[0], chan_a)),
 632                         0x0b => send_payment!(nodes[1], (&nodes[2], chan_b)),
 633                         0x0c => send_payment!(nodes[2], (&nodes[1], chan_b)),
 634                         0x0d => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)),
 635                         0x0e => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)),
 636                         0x0f => {
 637                                 if !chan_a_disconnected {
 638                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
 639                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
 640                                         chan_a_disconnected = true;
 641                                         drain_msg_events_on_disconnect!(0);
 642                                 }
 643                         },
 644                         0x10 => {
 645                                 if !chan_b_disconnected {
 646                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
 647                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
 648                                         chan_b_disconnected = true;
 649                                         drain_msg_events_on_disconnect!(2);
 650                                 }
 651                         },
 652                         0x11 => {
 653                                 if chan_a_disconnected {
 654                                         nodes[0].peer_connected(&nodes[1].get_our_node_id());
 655                                         nodes[1].peer_connected(&nodes[0].get_our_node_id());
 656                                         chan_a_disconnected = false;
 657                                 }
 658                         },
 659                         0x12 => {
 660                                 if chan_b_disconnected {
 661                                         nodes[1].peer_connected(&nodes[2].get_our_node_id());
 662                                         nodes[2].peer_connected(&nodes[1].get_our_node_id());
 663                                         chan_b_disconnected = false;
 664                                 }
 665                         },
 666                         0x13 => process_msg_events!(0, true),
 667                         0x14 => process_msg_events!(0, false),
 668                         0x15 => process_events!(0, true),
 669                         0x16 => process_events!(0, false),
 670                         0x17 => process_msg_events!(1, true),
 671                         0x18 => process_msg_events!(1, false),
 672                         0x19 => process_events!(1, true),
 673                         0x1a => process_events!(1, false),
 674                         0x1b => process_msg_events!(2, true),
 675                         0x1c => process_msg_events!(2, false),
 676                         0x1d => process_events!(2, true),
 677                         0x1e => process_events!(2, false),
 678                         0x1f => {
 679                                 if !chan_a_disconnected {
 680                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
 681                                         chan_a_disconnected = true;
 682                                         drain_msg_events_on_disconnect!(0);
 683                                 }
 684                                 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
 685                                 node_a = Arc::new(new_node_a);
 686                                 nodes[0] = node_a.clone();
 687                                 monitor_a = new_monitor_a;
 688                         },
 689                         0x20 => {
 690                                 if !chan_a_disconnected {
 691                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
 692                                         chan_a_disconnected = true;
 693                                         nodes[0].get_and_clear_pending_msg_events();
 694                                         ba_events.clear();
 695                                 }
 696                                 if !chan_b_disconnected {
 697                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
 698                                         chan_b_disconnected = true;
 699                                         nodes[2].get_and_clear_pending_msg_events();
 700                                         bc_events.clear();
 701                                 }
 702                                 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
 703                                 node_b = Arc::new(new_node_b);
 704                                 nodes[1] = node_b.clone();
 705                                 monitor_b = new_monitor_b;
 706                         },
 707                         0x21 => {
 708                                 if !chan_b_disconnected {
 709                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
 710                                         chan_b_disconnected = true;
 711                                         drain_msg_events_on_disconnect!(2);
 712                                 }
 713                                 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
 714                                 node_c = Arc::new(new_node_c);
 715                                 nodes[2] = node_c.clone();
 716                                 monitor_c = new_monitor_c;
 717                         },
 718                         _ => test_return!(),
 719                 }
 720
 721                 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
 722                         node_a_ser.0.clear();
 723                         nodes[0].write(&mut node_a_ser).unwrap();
 724                         monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
 725                         *monitor_a.latest_updates_good_at_last_ser.lock().unwrap() = monitor_a.latest_update_good.lock().unwrap().clone();
 726                 }
 727                 if monitor_b.should_update_manager.load(atomic::Ordering::Relaxed) {
 728                         node_b_ser.0.clear();
 729                         nodes[1].write(&mut node_b_ser).unwrap();
 730                         monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
 731                         *monitor_b.latest_updates_good_at_last_ser.lock().unwrap() = monitor_b.latest_update_good.lock().unwrap().clone();
 732                 }
 733                 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
 734                         node_c_ser.0.clear();
 735                         nodes[2].write(&mut node_c_ser).unwrap();
 736                         monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
 737                         *monitor_c.latest_updates_good_at_last_ser.lock().unwrap() = monitor_c.latest_update_good.lock().unwrap().clone();
 738                 }
 739         }
 740 }
 741
 742 #[no_mangle]
 743 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
 744         do_test(unsafe { std::slice::from_raw_parts(data, datalen) });
 745 }
 746
 747 #[cfg(test)]
 748 mod tests {
 749         #[test]
 750         fn duplicate_crash() {
 751                 super::do_test(&::hex::decode("00").unwrap());
 752         }
 753 }