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