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