_ Git - rust-lightning/blob - lightning/src/ln/onion_route_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests of the onion error messages/codes which are returned when routing a payment fails.
  11 //! These tests work by standing up full nodes and route payments across the network, checking the
  12 //! returned errors decode to the correct thing.
  13
  14 use chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
  15 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  16 use ln::channelmanager::{HTLCForwardInfo, CLTV_FAR_FAR_AWAY};
  17 use ln::onion_utils;
  18 use routing::router::{Route, get_route};
  19 use routing::network_graph::NetworkUpdate;
  20 use ln::features::{InitFeatures, InvoiceFeatures};
  21 use ln::msgs;
  22 use ln::msgs::{ChannelMessageHandler, ChannelUpdate, OptionalField};
  23 use util::test_utils;
  24 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
  25 use util::ser::{Writeable, Writer};
  26 use util::config::UserConfig;
  27
  28 use bitcoin::hash_types::BlockHash;
  29
  30 use bitcoin::hashes::sha256::Hash as Sha256;
  31 use bitcoin::hashes::Hash;
  32
  33 use bitcoin::secp256k1;
  34 use bitcoin::secp256k1::Secp256k1;
  35 use bitcoin::secp256k1::key::SecretKey;
  36
  37 use io;
  38 use prelude::*;
  39 use core::default::Default;
  40
  41 use ln::functional_test_utils::*;
  42
  43 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<NetworkUpdate>)
  44         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
  45                                 F2: FnMut(),
  46 {
  47         run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, payment_secret, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
  48 }
  49
  50 // test_case
  51 // 0: node1 fails backward
  52 // 1: final node fails backward
  53 // 2: payment completed but the user rejects the payment
  54 // 3: final node fails backward (but tamper onion payloads from node0)
  55 // 100: trigger error in the intermediate node and tamper returning fail_htlc
  56 // 200: trigger error in the final node and tamper returning fail_htlc
  57 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<NetworkUpdate>)
  58         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
  59                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
  60                                 F3: FnMut(),
  61 {
  62         macro_rules! expect_event {
  63                 ($node: expr, $event_type: path) => {{
  64                         let events = $node.node.get_and_clear_pending_events();
  65                         assert_eq!(events.len(), 1);
  66                         match events[0] {
  67                                 $event_type { .. } => {},
  68                                 _ => panic!("Unexpected event"),
  69                         }
  70                 }}
  71         }
  72
  73         macro_rules! expect_htlc_forward {
  74                 ($node: expr) => {{
  75                         expect_event!($node, Event::PendingHTLCsForwardable);
  76                         $node.node.process_pending_htlc_forwards();
  77                 }}
  78         }
  79
  80         // 0 ~~> 2 send payment
  81         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(*payment_secret)).unwrap();
  82         check_added_monitors!(nodes[0], 1);
  83         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
  84         // temper update_add (0 => 1)
  85         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
  86         if test_case == 0 || test_case == 3 || test_case == 100 {
  87                 callback_msg(&mut update_add_0);
  88                 callback_node();
  89         }
  90         // 0 => 1 update_add & CS
  91         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
  92         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
  93
  94         let update_1_0 = match test_case {
  95                 0|100 => { // intermediate node failure; fail backward to 0
  96                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
  97                         assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
  98                         update_1_0
  99                 },
 100                 1|2|3|200 => { // final node failure; forwarding to 2
 101                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 102                         // forwarding on 1
 103                         if test_case != 200 {
 104                                 callback_node();
 105                         }
 106                         expect_htlc_forward!(&nodes[1]);
 107
 108                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
 109                         check_added_monitors!(&nodes[1], 1);
 110                         assert_eq!(update_1.update_add_htlcs.len(), 1);
 111                         // tamper update_add (1 => 2)
 112                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
 113                         if test_case != 3 && test_case != 200 {
 114                                 callback_msg(&mut update_add_1);
 115                         }
 116
 117                         // 1 => 2
 118                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
 119                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
 120
 121                         if test_case == 2 || test_case == 200 {
 122                                 expect_htlc_forward!(&nodes[2]);
 123                                 expect_event!(&nodes[2], Event::PaymentReceived);
 124                                 callback_node();
 125                                 let events = nodes[2].node.get_and_clear_pending_events();
 126                                 expect_pending_htlcs_forwardable!(nodes[2], events);
 127                         }
 128
 129                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 130                         if test_case == 2 || test_case == 200 {
 131                                 check_added_monitors!(&nodes[2], 1);
 132                         }
 133                         assert!(update_2_1.update_fail_htlcs.len() == 1);
 134
 135                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
 136                         if test_case == 200 {
 137                                 callback_fail(&mut fail_msg);
 138                         }
 139
 140                         // 2 => 1
 141                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
 142                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
 143
 144                         // backward fail on 1
 145                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 146                         assert!(update_1_0.update_fail_htlcs.len() == 1);
 147                         update_1_0
 148                 },
 149                 _ => unreachable!(),
 150         };
 151
 152         // 1 => 0 commitment_signed_dance
 153         if update_1_0.update_fail_htlcs.len() > 0 {
 154                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
 155                 if test_case == 100 {
 156                         callback_fail(&mut fail_msg);
 157                 }
 158                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
 159         } else {
 160                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
 161         };
 162
 163         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
 164
 165         let events = nodes[0].node.get_and_clear_pending_events();
 166         assert_eq!(events.len(), 1);
 167         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref network_update, ref error_code, error_data: _, ref all_paths_failed } = &events[0] {
 168                 assert_eq!(*rejected_by_dest, !expected_retryable);
 169                 assert_eq!(*all_paths_failed, true);
 170                 assert_eq!(*error_code, expected_error_code);
 171                 if expected_channel_update.is_some() {
 172                         match network_update {
 173                                 Some(update) => match update {
 174                                         &NetworkUpdate::ChannelUpdateMessage { .. } => {
 175                                                 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
 176                                                         panic!("channel_update not found!");
 177                                                 }
 178                                         },
 179                                         &NetworkUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
 180                                                 if let NetworkUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
 181                                                         assert!(*short_channel_id == *expected_short_channel_id);
 182                                                         assert!(*is_permanent == *expected_is_permanent);
 183                                                 } else {
 184                                                         panic!("Unexpected message event");
 185                                                 }
 186                                         },
 187                                         &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
 188                                                 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
 189                                                         assert!(*node_id == *expected_node_id);
 190                                                         assert!(*is_permanent == *expected_is_permanent);
 191                                                 } else {
 192                                                         panic!("Unexpected message event");
 193                                                 }
 194                                         },
 195                                 }
 196                                 None => panic!("Expected channel update"),
 197                         }
 198                 } else {
 199                         assert!(network_update.is_none());
 200                 }
 201         } else {
 202                 panic!("Unexpected event");
 203         }
 204 }
 205
 206 impl msgs::ChannelUpdate {
 207         fn dummy() -> msgs::ChannelUpdate {
 208                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
 209                 use bitcoin::secp256k1::Signature;
 210                 msgs::ChannelUpdate {
 211                         signature: Signature::from(unsafe { FFISignature::new() }),
 212                         contents: msgs::UnsignedChannelUpdate {
 213                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
 214                                 short_channel_id: 0,
 215                                 timestamp: 0,
 216                                 flags: 0,
 217                                 cltv_expiry_delta: 0,
 218                                 htlc_minimum_msat: 0,
 219                                 htlc_maximum_msat: OptionalField::Absent,
 220                                 fee_base_msat: 0,
 221                                 fee_proportional_millionths: 0,
 222                                 excess_data: vec![],
 223                         }
 224                 }
 225         }
 226 }
 227
 228 struct BogusOnionHopData {
 229         data: Vec<u8>
 230 }
 231 impl BogusOnionHopData {
 232         fn new(orig: msgs::OnionHopData) -> Self {
 233                 Self { data: orig.encode() }
 234         }
 235 }
 236 impl Writeable for BogusOnionHopData {
 237         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 238                 writer.write_all(&self.data[..])
 239         }
 240 }
 241
 242 const BADONION: u16 = 0x8000;
 243 const PERM: u16 = 0x4000;
 244 const NODE: u16 = 0x2000;
 245 const UPDATE: u16 = 0x1000;
 246
 247 #[test]
 248 fn test_fee_failures() {
 249         // Tests that the fee required when forwarding remains consistent over time. This was
 250         // previously broken, with forwarding fees floating based on the fee estimator at the time of
 251         // forwarding.
 252         //
 253         // When this test was written, the default base fee floated based on the HTLC count.
 254         // It is now fixed, so we simply set the fee to the expected value here.
 255         let mut config = test_default_channel_config();
 256         config.channel_options.forwarding_fee_base_msat = 196;
 257
 258         let chanmon_cfgs = create_chanmon_cfgs(3);
 259         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 260         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
 261         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 262         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
 263         let logger = test_utils::TestLogger::new();
 264         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40_000, TEST_FINAL_CLTV, &logger).unwrap();
 265
 266         // positive case
 267         let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
 268         nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
 269         check_added_monitors!(nodes[0], 1);
 270         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
 271         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
 272
 273         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 274         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 275                 msg.amount_msat -= 1;
 276         }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
 277
 278         // In an earlier version, we spuriously failed to forward payments if the expected feerate
 279         // changed between the channel open and the payment.
 280         {
 281                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
 282                 *feerate_lock *= 2;
 283         }
 284
 285         let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
 286         nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
 287         check_added_monitors!(nodes[0], 1);
 288         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
 289         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
 290 }
 291
 292 #[test]
 293 fn test_onion_failure() {
 294         // When we check for amount_below_minimum below, we want to test that we're using the *right*
 295         // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
 296         // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
 297         // This exposed a previous bug because we were using the wrong value all the way down in
 298         // Channel::get_counterparty_htlc_minimum_msat().
 299         let mut node_2_cfg: UserConfig = Default::default();
 300         node_2_cfg.own_channel_config.our_htlc_minimum_msat = 2000;
 301         node_2_cfg.channel_options.announced_channel = true;
 302         node_2_cfg.peer_channel_config_limits.force_announced_channel_preference = false;
 303
 304         // When this test was written, the default base fee floated based on the HTLC count.
 305         // It is now fixed, so we simply set the fee to the expected value here.
 306         let mut config = test_default_channel_config();
 307         config.channel_options.forwarding_fee_base_msat = 196;
 308
 309         let chanmon_cfgs = create_chanmon_cfgs(3);
 310         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 311         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
 312         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 313         for node in nodes.iter() {
 314                 *node.keys_manager.override_session_priv.lock().unwrap() = Some([3; 32]);
 315         }
 316         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
 317         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 318         let logger = test_utils::TestLogger::new();
 319         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
 320         // positve case
 321         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
 322
 323         // intermediate node failure
 324         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 325                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 326                 let cur_height = nodes[0].best_block_info().1 + 1;
 327                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 328                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 329                 let mut new_payloads = Vec::new();
 330                 for payload in onion_payloads.drain(..) {
 331                         new_payloads.push(BogusOnionHopData::new(payload));
 332                 }
 333                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
 334                 // describing a length-1 TLV payload, which is obviously bogus.
 335                 new_payloads[0].data[0] = 1;
 336                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
 337         }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
 338
 339         // final node failure
 340         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 341                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 342                 let cur_height = nodes[0].best_block_info().1 + 1;
 343                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 344                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 345                 let mut new_payloads = Vec::new();
 346                 for payload in onion_payloads.drain(..) {
 347                         new_payloads.push(BogusOnionHopData::new(payload));
 348                 }
 349                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
 350                 // length-1 TLV payload, which is obviously bogus.
 351                 new_payloads[1].data[0] = 1;
 352                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
 353         }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
 354
 355         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
 356         // receiving simulated fail messages
 357         // intermediate node failure
 358         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 359                 // trigger error
 360                 msg.amount_msat -= 1;
 361         }, |msg| {
 362                 // and tamper returning error message
 363                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 364                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 365                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
 366         }, ||{}, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
 367
 368         // final node failure
 369         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 370                 // and tamper returning error message
 371                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 372                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 373                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
 374         }, ||{
 375                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 376         }, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
 377         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 378
 379         // intermediate node failure
 380         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 381                 msg.amount_msat -= 1;
 382         }, |msg| {
 383                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 384                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 385                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
 386         }, ||{}, true, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
 387
 388         // final node failure
 389         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 390                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 391                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 392                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
 393         }, ||{
 394                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 395         }, false, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
 396         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 397
 398         // intermediate node failure
 399         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 400                 msg.amount_msat -= 1;
 401         }, |msg| {
 402                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 403                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 404                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
 405         }, ||{
 406                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 407         }, true, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
 408
 409         // final node failure
 410         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 411                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 412                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 413                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
 414         }, ||{
 415                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 416         }, false, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
 417         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 418
 419         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
 420                 Some(BADONION|PERM|4), None);
 421
 422         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
 423                 Some(BADONION|PERM|5), None);
 424
 425         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
 426                 Some(BADONION|PERM|6), None);
 427
 428         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 429                 msg.amount_msat -= 1;
 430         }, |msg| {
 431                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 432                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 433                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
 434         }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
 435
 436         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 437                 msg.amount_msat -= 1;
 438         }, |msg| {
 439                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 440                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 441                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
 442                 // short_channel_id from the processing node
 443         }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
 444
 445         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 446                 msg.amount_msat -= 1;
 447         }, |msg| {
 448                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 449                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 450                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
 451                 // short_channel_id from the processing node
 452         }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
 453
 454         let mut bogus_route = route.clone();
 455         bogus_route.paths[0][1].short_channel_id -= 1;
 456         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
 457           Some(NetworkUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
 458
 459         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_counterparty_htlc_minimum_msat() - 1;
 460         let mut bogus_route = route.clone();
 461         let route_len = bogus_route.paths[0].len();
 462         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
 463         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(UPDATE|11), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
 464
 465         // Test a positive test-case with one extra msat, meeting the minimum.
 466         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
 467         let (preimage, _, _) = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1);
 468         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
 469
 470         //TODO: with new config API, we will be able to generate both valid and
 471         //invalid channel_update cases.
 472         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 473                 msg.amount_msat -= 1;
 474         }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
 475
 476         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 477                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
 478                 msg.cltv_expiry -= 1;
 479         }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
 480
 481         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 482                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
 483                 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
 484                 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
 485                 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
 486         }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
 487
 488         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 489                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 490         }, false, Some(PERM|15), None);
 491         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 492
 493         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 494                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
 495                 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
 496                 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
 497                 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
 498         }, || {}, true, Some(17), None);
 499
 500         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 501                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
 502                         for f in pending_forwards.iter_mut() {
 503                                 match f {
 504                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
 505                                                 forward_info.outgoing_cltv_value += 1,
 506                                         _ => {},
 507                                 }
 508                         }
 509                 }
 510         }, true, Some(18), None);
 511
 512         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 513                 // violate amt_to_forward > msg.amount_msat
 514                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
 515                         for f in pending_forwards.iter_mut() {
 516                                 match f {
 517                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
 518                                                 forward_info.amt_to_forward -= 1,
 519                                         _ => {},
 520                                 }
 521                         }
 522                 }
 523         }, true, Some(19), None);
 524
 525         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 526                 // disconnect event to the channel between nodes[1] ~ nodes[2]
 527                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
 528                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 529         }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
 530         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
 531
 532         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 533                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 534                 let mut route = route.clone();
 535                 let height = nodes[2].best_block_info().1;
 536                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
 537                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 538                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height, &None).unwrap();
 539                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
 540                 msg.cltv_expiry = htlc_cltv;
 541                 msg.onion_routing_packet = onion_packet;
 542         }, ||{}, true, Some(21), None);
 543 }
 544
 545