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