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