_ 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::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
  15 use chain::keysinterface::{KeysInterface, Recipient};
  16 use ln::{PaymentHash, PaymentSecret};
  17 use ln::channel::EXPIRE_PREV_CONFIG_TICKS;
  18 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, HTLCForwardInfo, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingHTLCInfo, PendingHTLCRouting};
  19 use ln::onion_utils;
  20 use routing::gossip::{NetworkUpdate, RoutingFees, NodeId};
  21 use routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop};
  22 use ln::features::{InitFeatures, InvoiceFeatures, NodeFeatures};
  23 use ln::msgs;
  24 use ln::msgs::{ChannelMessageHandler, ChannelUpdate};
  25 use ln::wire::Encode;
  26 use util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
  27 use util::ser::{ReadableArgs, Writeable, Writer};
  28 use util::{byte_utils, test_utils};
  29 use util::config::{UserConfig, ChannelConfig};
  30 use util::errors::APIError;
  31
  32 use bitcoin::hash_types::BlockHash;
  33
  34 use bitcoin::hashes::Hash;
  35 use bitcoin::hashes::sha256::Hash as Sha256;
  36
  37 use bitcoin::secp256k1;
  38 use bitcoin::secp256k1::Secp256k1;
  39 use bitcoin::secp256k1::{PublicKey, SecretKey};
  40
  41 use io;
  42 use prelude::*;
  43 use core::default::Default;
  44
  45 use ln::functional_test_utils::*;
  46
  47 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>)
  48         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
  49                                 F2: FnMut(),
  50 {
  51         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);
  52 }
  53
  54 // test_case
  55 // 0: node1 fails backward
  56 // 1: final node fails backward
  57 // 2: payment completed but the user rejects the payment
  58 // 3: final node fails backward (but tamper onion payloads from node0)
  59 // 100: trigger error in the intermediate node and tamper returning fail_htlc
  60 // 200: trigger error in the final node and tamper returning fail_htlc
  61 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>)
  62         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
  63                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
  64                                 F3: FnMut(),
  65 {
  66         macro_rules! expect_event {
  67                 ($node: expr, $event_type: path) => {{
  68                         let events = $node.node.get_and_clear_pending_events();
  69                         assert_eq!(events.len(), 1);
  70                         match events[0] {
  71                                 $event_type { .. } => {},
  72                                 _ => panic!("Unexpected event"),
  73                         }
  74                 }}
  75         }
  76
  77         macro_rules! expect_htlc_forward {
  78                 ($node: expr) => {{
  79                         expect_event!($node, Event::PendingHTLCsForwardable);
  80                         $node.node.process_pending_htlc_forwards();
  81                 }}
  82         }
  83
  84         // 0 ~~> 2 send payment
  85         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(*payment_secret)).unwrap();
  86         check_added_monitors!(nodes[0], 1);
  87         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
  88         // temper update_add (0 => 1)
  89         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
  90         if test_case == 0 || test_case == 3 || test_case == 100 {
  91                 callback_msg(&mut update_add_0);
  92                 callback_node();
  93         }
  94         // 0 => 1 update_add & CS
  95         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
  96         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
  97
  98         let update_1_0 = match test_case {
  99                 0|100 => { // intermediate node failure; fail backward to 0
 100                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 101                         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));
 102                         update_1_0
 103                 },
 104                 1|2|3|200 => { // final node failure; forwarding to 2
 105                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 106                         // forwarding on 1
 107                         if test_case != 200 {
 108                                 callback_node();
 109                         }
 110                         expect_htlc_forward!(&nodes[1]);
 111
 112                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
 113                         check_added_monitors!(&nodes[1], 1);
 114                         assert_eq!(update_1.update_add_htlcs.len(), 1);
 115                         // tamper update_add (1 => 2)
 116                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
 117                         if test_case != 3 && test_case != 200 {
 118                                 callback_msg(&mut update_add_1);
 119                         }
 120
 121                         // 1 => 2
 122                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
 123                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
 124
 125                         if test_case == 2 || test_case == 200 {
 126                                 expect_htlc_forward!(&nodes[2]);
 127                                 expect_event!(&nodes[2], Event::PaymentReceived);
 128                                 callback_node();
 129                                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
 130                         }
 131
 132                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 133                         if test_case == 2 || test_case == 200 {
 134                                 check_added_monitors!(&nodes[2], 1);
 135                         }
 136                         assert!(update_2_1.update_fail_htlcs.len() == 1);
 137
 138                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
 139                         if test_case == 200 {
 140                                 callback_fail(&mut fail_msg);
 141                         }
 142
 143                         // 2 => 1
 144                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
 145                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
 146
 147                         // backward fail on 1
 148                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 149                         assert!(update_1_0.update_fail_htlcs.len() == 1);
 150                         update_1_0
 151                 },
 152                 _ => unreachable!(),
 153         };
 154
 155         // 1 => 0 commitment_signed_dance
 156         if update_1_0.update_fail_htlcs.len() > 0 {
 157                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
 158                 if test_case == 100 {
 159                         callback_fail(&mut fail_msg);
 160                 }
 161                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
 162         } else {
 163                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
 164         };
 165
 166         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
 167
 168         let events = nodes[0].node.get_and_clear_pending_events();
 169         assert_eq!(events.len(), 1);
 170         if let &Event::PaymentPathFailed { ref payment_failed_permanently, ref network_update, ref all_paths_failed, ref short_channel_id, ref error_code, .. } = &events[0] {
 171                 assert_eq!(*payment_failed_permanently, !expected_retryable);
 172                 assert_eq!(*all_paths_failed, true);
 173                 assert_eq!(*error_code, expected_error_code);
 174                 if expected_channel_update.is_some() {
 175                         match network_update {
 176                                 Some(update) => match update {
 177                                         &NetworkUpdate::ChannelUpdateMessage { .. } => {
 178                                                 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
 179                                                         panic!("channel_update not found!");
 180                                                 }
 181                                         },
 182                                         &NetworkUpdate::ChannelFailure { ref short_channel_id, ref is_permanent } => {
 183                                                 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
 184                                                         assert!(*short_channel_id == *expected_short_channel_id);
 185                                                         assert!(*is_permanent == *expected_is_permanent);
 186                                                 } else {
 187                                                         panic!("Unexpected message event");
 188                                                 }
 189                                         },
 190                                         &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
 191                                                 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
 192                                                         assert!(*node_id == *expected_node_id);
 193                                                         assert!(*is_permanent == *expected_is_permanent);
 194                                                 } else {
 195                                                         panic!("Unexpected message event");
 196                                                 }
 197                                         },
 198                                 }
 199                                 None => panic!("Expected channel update"),
 200                         }
 201                 } else {
 202                         assert!(network_update.is_none());
 203                 }
 204                 if let Some(expected_short_channel_id) = expected_short_channel_id {
 205                         match short_channel_id {
 206                                 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
 207                                 None => panic!("Expected short channel id"),
 208                         }
 209                 } else {
 210                         assert!(short_channel_id.is_none());
 211                 }
 212         } else {
 213                 panic!("Unexpected event");
 214         }
 215 }
 216
 217 impl msgs::ChannelUpdate {
 218         fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
 219                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
 220                 use bitcoin::secp256k1::ecdsa::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,
 226                                 timestamp: 0,
 227                                 flags: 0,
 228                                 cltv_expiry_delta: 0,
 229                                 htlc_minimum_msat: 0,
 230                                 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
 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 const BADONION: u16 = 0x8000;
 254 const PERM: u16 = 0x4000;
 255 const NODE: u16 = 0x2000;
 256 const UPDATE: u16 = 0x1000;
 257
 258 #[test]
 259 fn test_fee_failures() {
 260         // Tests that the fee required when forwarding remains consistent over time. This was
 261         // previously broken, with forwarding fees floating based on the fee estimator at the time of
 262         // forwarding.
 263         //
 264         // When this test was written, the default base fee floated based on the HTLC count.
 265         // It is now fixed, so we simply set the fee to the expected value here.
 266         let mut config = test_default_channel_config();
 267         config.channel_config.forwarding_fee_base_msat = 196;
 268
 269         let chanmon_cfgs = create_chanmon_cfgs(3);
 270         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 271         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
 272         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 273         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())];
 274
 275         // positive case
 276         let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
 277         nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
 278         check_added_monitors!(nodes[0], 1);
 279         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
 280         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
 281
 282         // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
 283         // malleated the payment before forwarding, taking funds when they shouldn't have.
 284         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 285         let short_channel_id = channels[0].0.contents.short_channel_id;
 286         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 287                 msg.amount_msat -= 1;
 288         }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
 289
 290         // In an earlier version, we spuriously failed to forward payments if the expected feerate
 291         // changed between the channel open and the payment.
 292         {
 293                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
 294                 *feerate_lock *= 2;
 295         }
 296
 297         let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
 298         nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
 299         check_added_monitors!(nodes[0], 1);
 300         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
 301         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
 302 }
 303
 304 #[test]
 305 fn test_onion_failure() {
 306         // When we check for amount_below_minimum below, we want to test that we're using the *right*
 307         // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
 308         // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
 309         // This exposed a previous bug because we were using the wrong value all the way down in
 310         // Channel::get_counterparty_htlc_minimum_msat().
 311         let mut node_2_cfg: UserConfig = Default::default();
 312         node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
 313         node_2_cfg.channel_handshake_config.announced_channel = true;
 314         node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
 315
 316         // When this test was written, the default base fee floated based on the HTLC count.
 317         // It is now fixed, so we simply set the fee to the expected value here.
 318         let mut config = test_default_channel_config();
 319         config.channel_config.forwarding_fee_base_msat = 196;
 320
 321         let chanmon_cfgs = create_chanmon_cfgs(3);
 322         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 323         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
 324         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 325         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())];
 326         for node in nodes.iter() {
 327                 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
 328         }
 329         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
 330         // positive case
 331         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
 332
 333         // intermediate node failure
 334         let short_channel_id = channels[1].0.contents.short_channel_id;
 335         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 336                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 337                 let cur_height = nodes[0].best_block_info().1 + 1;
 338                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 339                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 340                 let mut new_payloads = Vec::new();
 341                 for payload in onion_payloads.drain(..) {
 342                         new_payloads.push(BogusOnionHopData::new(payload));
 343                 }
 344                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
 345                 // describing a length-1 TLV payload, which is obviously bogus.
 346                 new_payloads[0].data[0] = 1;
 347                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
 348         }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 349
 350         // final node failure
 351         let short_channel_id = channels[1].0.contents.short_channel_id;
 352         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 353                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 354                 let cur_height = nodes[0].best_block_info().1 + 1;
 355                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 356                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 357                 let mut new_payloads = Vec::new();
 358                 for payload in onion_payloads.drain(..) {
 359                         new_payloads.push(BogusOnionHopData::new(payload));
 360                 }
 361                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
 362                 // length-1 TLV payload, which is obviously bogus.
 363                 new_payloads[1].data[0] = 1;
 364                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
 365         }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 366
 367         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
 368         // receiving simulated fail messages
 369         // intermediate node failure
 370         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 371                 // trigger error
 372                 msg.amount_msat -= 1;
 373         }, |msg| {
 374                 // and tamper returning error message
 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[0].shared_secret.as_ref(), NODE|2, &[0;0]);
 378         }, ||{}, 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));
 379
 380         // final node failure
 381         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 382                 // and tamper returning error message
 383                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 384                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 385                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
 386         }, ||{
 387                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 388         }, 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));
 389         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 390
 391         // intermediate node failure
 392         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 393                 msg.amount_msat -= 1;
 394         }, |msg| {
 395                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 396                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 397                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
 398         }, ||{}, 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));
 399
 400         // final node failure
 401         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |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[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
 405         }, ||{
 406                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 407         }, 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));
 408         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 409
 410         // intermediate node failure
 411         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 412                 msg.amount_msat -= 1;
 413         }, |msg| {
 414                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 415                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 416                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
 417         }, ||{
 418                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 419         }, 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));
 420
 421         // final node failure
 422         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 423                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 424                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 425                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
 426         }, ||{
 427                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 428         }, 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));
 429         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 430
 431         // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
 432         // the UpdateAddHTLC that we sent.
 433         let short_channel_id = channels[0].0.contents.short_channel_id;
 434         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
 435                 Some(BADONION|PERM|4), None, Some(short_channel_id));
 436
 437         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
 438                 Some(BADONION|PERM|5), None, Some(short_channel_id));
 439
 440         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,
 441                 Some(BADONION|PERM|6), None, Some(short_channel_id));
 442
 443         let short_channel_id = channels[1].0.contents.short_channel_id;
 444         let chan_update = ChannelUpdate::dummy(short_channel_id);
 445
 446         let mut err_data = Vec::new();
 447         err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
 448         err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
 449         err_data.extend_from_slice(&chan_update.encode());
 450         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 451                 msg.amount_msat -= 1;
 452         }, |msg| {
 453                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 454                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 455                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
 456         }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
 457
 458         // Check we can still handle onion failures that include channel updates without a type prefix
 459         let err_data_without_type = chan_update.encode_with_len();
 460         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 461                 msg.amount_msat -= 1;
 462         }, |msg| {
 463                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 464                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 465                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
 466         }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
 467
 468         let short_channel_id = channels[1].0.contents.short_channel_id;
 469         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 470                 msg.amount_msat -= 1;
 471         }, |msg| {
 472                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 473                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 474                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
 475                 // short_channel_id from the processing node
 476         }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 477
 478         let short_channel_id = channels[1].0.contents.short_channel_id;
 479         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 480                 msg.amount_msat -= 1;
 481         }, |msg| {
 482                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 483                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 484                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
 485                 // short_channel_id from the processing node
 486         }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 487
 488         let mut bogus_route = route.clone();
 489         bogus_route.paths[0][1].short_channel_id -= 1;
 490         let short_channel_id = bogus_route.paths[0][1].short_channel_id;
 491         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
 492           Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
 493
 494         let short_channel_id = channels[1].0.contents.short_channel_id;
 495         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_counterparty_htlc_minimum_msat() - 1;
 496         let mut bogus_route = route.clone();
 497         let route_len = bogus_route.paths[0].len();
 498         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
 499         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));
 500
 501         // Clear pending payments so that the following positive test has the correct payment hash.
 502         for node in nodes.iter() {
 503                 node.node.clear_pending_payments();
 504         }
 505
 506         // Test a positive test-case with one extra msat, meeting the minimum.
 507         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
 508         let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
 509         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
 510
 511         let short_channel_id = channels[0].0.contents.short_channel_id;
 512         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 513                 msg.amount_msat -= 1;
 514         }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
 515
 516         let short_channel_id = channels[0].0.contents.short_channel_id;
 517         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 518                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
 519                 msg.cltv_expiry -= 1;
 520         }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
 521
 522         let short_channel_id = channels[1].0.contents.short_channel_id;
 523         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 524                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
 525                 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
 526                 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
 527                 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
 528         }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
 529
 530         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 531                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 532         }, false, Some(PERM|15), None, None);
 533         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 534
 535         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 536                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
 537                 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
 538                 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
 539                 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
 540         }, || {}, true, Some(17), None, None);
 541
 542         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 543                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
 544                         for f in pending_forwards.iter_mut() {
 545                                 match f {
 546                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
 547                                                 forward_info.outgoing_cltv_value += 1,
 548                                         _ => {},
 549                                 }
 550                         }
 551                 }
 552         }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
 553
 554         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 555                 // violate amt_to_forward > msg.amount_msat
 556                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
 557                         for f in pending_forwards.iter_mut() {
 558                                 match f {
 559                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
 560                                                 forward_info.amt_to_forward -= 1,
 561                                         _ => {},
 562                                 }
 563                         }
 564                 }
 565         }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
 566
 567         let short_channel_id = channels[1].0.contents.short_channel_id;
 568         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
 569                 // disconnect event to the channel between nodes[1] ~ nodes[2]
 570                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
 571                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 572         }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
 573         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
 574
 575         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 576                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 577                 let mut route = route.clone();
 578                 let height = nodes[2].best_block_info().1;
 579                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
 580                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 581                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height, &None).unwrap();
 582                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
 583                 msg.cltv_expiry = htlc_cltv;
 584                 msg.onion_routing_packet = onion_packet;
 585         }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
 586
 587         run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 588                 // Tamper returning error message
 589                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 590                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 591                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
 592         }, ||{
 593                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 594         }, true, Some(23), None, None);
 595 }
 596
 597 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
 598         // Create a network of three nodes and two channels connecting them. We'll be updating the
 599         // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
 600         let mut config = UserConfig::default();
 601         config.channel_handshake_config.announced_channel = announced_channel;
 602         config.channel_handshake_limits.force_announced_channel_preference = false;
 603         config.accept_forwards_to_priv_channels = !announced_channel;
 604         let chanmon_cfgs = create_chanmon_cfgs(3);
 605         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 606         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
 607         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 608
 609         let other_channel = create_chan_between_nodes(
 610                 &nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known(),
 611         );
 612         let channel_to_update = if announced_channel {
 613                 let channel = create_announced_chan_between_nodes(
 614                         &nodes, 1, 2, InitFeatures::known(), InitFeatures::known(),
 615                 );
 616                 (channel.2, channel.0.contents.short_channel_id)
 617         } else {
 618                 let channel = create_unannounced_chan_between_nodes_with_value(
 619                         &nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known(),
 620                 );
 621                 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
 622         };
 623         let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
 624
 625         let default_config = ChannelConfig::default();
 626
 627         // A test payment should succeed as the ChannelConfig has not been changed yet.
 628         const PAYMENT_AMT: u64 = 40000;
 629         let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
 630                 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
 631         } else {
 632                 let hop_hints = vec![RouteHint(vec![RouteHintHop {
 633                         src_node_id: nodes[1].node.get_our_node_id(),
 634                         short_channel_id: channel_to_update.1,
 635                         fees: RoutingFees {
 636                                 base_msat: default_config.forwarding_fee_base_msat,
 637                                 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
 638                         },
 639                         cltv_expiry_delta: default_config.cltv_expiry_delta,
 640                         htlc_maximum_msat: None,
 641                         htlc_minimum_msat: None,
 642                 }])];
 643                 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty)
 644                         .with_features(InvoiceFeatures::known())
 645                         .with_route_hints(hop_hints);
 646                 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV)
 647         };
 648         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
 649                 payment_hash, payment_secret);
 650         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 651
 652         // Closure to force expiry of a channel's previous config.
 653         let expire_prev_config = || {
 654                 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
 655                         nodes[1].node.timer_tick_occurred();
 656                 }
 657         };
 658
 659         // Closure to update and retrieve the latest ChannelUpdate.
 660         let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
 661                 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
 662                 nodes[1].node.update_channel_config(
 663                         channel_to_update_counterparty, &[channel_to_update.0], config,
 664                 ).unwrap();
 665                 let events = nodes[1].node.get_and_clear_pending_msg_events();
 666                 assert_eq!(events.len(), expect_new_update as usize);
 667                 if !expect_new_update {
 668                         return None;
 669                 }
 670                 let new_update = match &events[0] {
 671                         MessageSendEvent::BroadcastChannelUpdate { msg } => {
 672                                 assert!(announced_channel);
 673                                 msg.clone()
 674                         },
 675                         MessageSendEvent::SendChannelUpdate { node_id, msg } => {
 676                                 assert_eq!(node_id, channel_to_update_counterparty);
 677                                 assert!(!announced_channel);
 678                                 msg.clone()
 679                         },
 680                         _ => panic!("expected Broadcast/SendChannelUpdate event"),
 681                 };
 682                 if prev_update.is_some() {
 683                         assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
 684                 }
 685                 if should_expire_prev_config {
 686                         expire_prev_config();
 687                 }
 688                 Some(new_update)
 689         };
 690
 691         // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
 692         // lead to onion failures at the first hop once we update the ChannelConfig for the
 693         // second hop.
 694         let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
 695                 let short_channel_id = channel_to_update.1;
 696                 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
 697                 run_onion_failure_test(
 698                         name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
 699                         Some(error_code), Some(network_update), Some(short_channel_id),
 700                 );
 701         };
 702
 703         // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
 704         let mut invalid_config = default_config.clone();
 705         invalid_config.cltv_expiry_delta = 0;
 706         match nodes[1].node.update_channel_config(
 707                 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
 708         ) {
 709                 Err(APIError::APIMisuseError{ .. }) => {},
 710                 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
 711         }
 712
 713         // Increase the base fee which should trigger a new ChannelUpdate.
 714         let mut config = nodes[1].node.list_usable_channels().iter()
 715                 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
 716                 .config.unwrap();
 717         config.forwarding_fee_base_msat = u32::max_value();
 718         let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
 719
 720         // The old policy should still be in effect until a new block is connected.
 721         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
 722                 payment_hash, payment_secret);
 723         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 724
 725         // Connect a block, which should expire the previous config, leading to a failure when
 726         // forwarding the HTLC.
 727         expire_prev_config();
 728         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
 729
 730         // Redundant updates should not trigger a new ChannelUpdate.
 731         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
 732
 733         // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
 734         config.force_close_avoidance_max_fee_satoshis *= 2;
 735         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
 736
 737         // Reset the base fee to the default and increase the proportional fee which should trigger a
 738         // new ChannelUpdate.
 739         config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
 740         config.cltv_expiry_delta = u16::max_value();
 741         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
 742         expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
 743
 744         // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
 745         // ChannelUpdate.
 746         config.cltv_expiry_delta = default_config.cltv_expiry_delta;
 747         config.forwarding_fee_proportional_millionths = u32::max_value();
 748         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
 749         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
 750
 751         // To test persistence of the updated config, we'll re-initialize the ChannelManager.
 752         let config_after_restart = {
 753                 let persister = test_utils::TestPersister::new();
 754                 let chain_monitor = test_utils::TestChainMonitor::new(
 755                         Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger,
 756                         node_cfgs[1].fee_estimator, &persister, nodes[1].keys_manager,
 757                 );
 758
 759                 let mut chanmon_1 = <(_, ChannelMonitor<_>)>::read(
 760                         &mut &get_monitor!(nodes[1], other_channel.3).encode()[..], nodes[1].keys_manager,
 761                 ).unwrap().1;
 762                 let mut chanmon_2 = <(_, ChannelMonitor<_>)>::read(
 763                         &mut &get_monitor!(nodes[1], channel_to_update.0).encode()[..], nodes[1].keys_manager,
 764                 ).unwrap().1;
 765                 let mut channel_monitors = HashMap::new();
 766                 channel_monitors.insert(chanmon_1.get_funding_txo().0, &mut chanmon_1);
 767                 channel_monitors.insert(chanmon_2.get_funding_txo().0, &mut chanmon_2);
 768
 769                 let chanmgr = <(_, ChannelManager<_, _, _, _, _, _>)>::read(
 770                         &mut &nodes[1].node.encode()[..], ChannelManagerReadArgs {
 771                                 default_config: *nodes[1].node.get_current_default_configuration(),
 772                                 keys_manager: nodes[1].keys_manager,
 773                                 fee_estimator: node_cfgs[1].fee_estimator,
 774                                 chain_monitor: &chain_monitor,
 775                                 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
 776                                 logger: nodes[1].logger,
 777                                 channel_monitors: channel_monitors,
 778                         },
 779                 ).unwrap().1;
 780                 chanmgr.list_channels().iter()
 781                         .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
 782                         .config.unwrap()
 783         };
 784         assert_eq!(config, config_after_restart);
 785 }
 786
 787 #[test]
 788 fn test_onion_failure_stale_channel_update() {
 789         do_test_onion_failure_stale_channel_update(false);
 790         do_test_onion_failure_stale_channel_update(true);
 791 }
 792
 793 #[test]
 794 fn test_default_to_onion_payload_tlv_format() {
 795         // Tests that we default to creating tlv format onion payloads when no `NodeAnnouncementInfo`
 796         // `features` for a node in the `network_graph` exists, or when the node isn't in the
 797         // `network_graph`, and no other known `features` for the node exists.
 798         let mut priv_channels_conf = UserConfig::default();
 799         priv_channels_conf.channel_handshake_config.announced_channel = false;
 800         let chanmon_cfgs = create_chanmon_cfgs(5);
 801         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
 802         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, Some(priv_channels_conf)]);
 803         let mut nodes = create_network(5, &node_cfgs, &node_chanmgrs);
 804
 805         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 806         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 807         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
 808         create_unannounced_chan_between_nodes_with_value(&nodes, 3, 4, 100000, 10001, InitFeatures::known(), InitFeatures::known());
 809
 810         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id());
 811         let origin_node = &nodes[0];
 812         let network_graph = origin_node.network_graph;
 813
 814         // Clears all the `NodeAnnouncementInfo` for all nodes of `nodes[0]`'s `network_graph`, so that
 815         // their `features` aren't used when creating the `route`.
 816         network_graph.clear_nodes_announcement_info();
 817
 818         let (announced_route, _, _, _) = get_route_and_payment_hash!(
 819                 origin_node, nodes[3], payment_params, 10_000, TEST_FINAL_CLTV);
 820
 821         let hops = &announced_route.paths[0];
 822         // Assert that the hop between `nodes[1]` and `nodes[2]` defaults to supporting variable length
 823         // onions, as `nodes[0]` has no `NodeAnnouncementInfo` `features` for `node[2]`
 824         assert!(hops[1].node_features.supports_variable_length_onion());
 825         // Assert that the hop between `nodes[2]` and `nodes[3]` defaults to supporting variable length
 826         // onions, as `nodes[0]` has no `NodeAnnouncementInfo` `features` for `node[3]`, and no `InvoiceFeatures`
 827         // for the `payment_params`, which would otherwise have been used.
 828         assert!(hops[2].node_features.supports_variable_length_onion());
 829         // Note that we do not assert that `hops[0]` (the channel between `nodes[0]` and `nodes[1]`)
 830         // supports variable length onions, as the `InitFeatures` exchanged in the init message
 831         // between the nodes will be used when creating the route. We therefore do not default to
 832         // supporting variable length onions for that hop, as the `InitFeatures` in this case are
 833         // `InitFeatures::known()`.
 834
 835         let unannounced_chan = &nodes[4].node.list_usable_channels()[0];
 836
 837         let last_hop = RouteHint(vec![RouteHintHop {
 838                 src_node_id: nodes[3].node.get_our_node_id(),
 839                 short_channel_id: unannounced_chan.short_channel_id.unwrap(),
 840                 fees: RoutingFees {
 841                         base_msat: 0,
 842                         proportional_millionths: 0,
 843                 },
 844                 cltv_expiry_delta: 42,
 845                 htlc_minimum_msat: None,
 846                 htlc_maximum_msat: None,
 847         }]);
 848
 849         let unannounced_chan_params = PaymentParameters::from_node_id(nodes[4].node.get_our_node_id()).with_route_hints(vec![last_hop]);
 850         let (unannounced_route, _, _, _) = get_route_and_payment_hash!(
 851                 origin_node, nodes[4], unannounced_chan_params, 10_000, TEST_FINAL_CLTV);
 852
 853         let unannounced_chan_hop = &unannounced_route.paths[0][3];
 854         // Ensure that `nodes[4]` doesn't exist in `nodes[0]`'s `network_graph`, as it's not public.
 855         assert!(&network_graph.read_only().nodes().get(&NodeId::from_pubkey(&nodes[4].node.get_our_node_id())).is_none());
 856         // Assert that the hop between `nodes[3]` and `nodes[4]` defaults to supporting variable length
 857         // onions, even though `nodes[4]` as `nodes[0]` doesn't exists in `nodes[0]`'s `network_graph`,
 858         // and no `InvoiceFeatures` for the `payment_params` exists, which would otherwise have been
 859         // used.
 860         assert!(unannounced_chan_hop.node_features.supports_variable_length_onion());
 861
 862         let cur_height = nodes[0].best_block_info().1 + 1;
 863         let (announced_route_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&announced_route.paths[0], 40000, &None, cur_height, &None).unwrap();
 864         let (unannounced_route_paylods, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&unannounced_route.paths[0], 40000, &None, cur_height, &None).unwrap();
 865
 866         for onion_payloads in vec![announced_route_payloads, unannounced_route_paylods] {
 867                 for onion_payload in onion_payloads.iter() {
 868                         match onion_payload.format {
 869                                 msgs::OnionHopDataFormat::Legacy {..} => {
 870                                         panic!("Generated a `msgs::OnionHopDataFormat::Legacy` payload, even though that shouldn't have happend.");
 871                                 }
 872                                 _ => {}
 873                         }
 874                 }
 875         }
 876 }
 877
 878 #[test]
 879 fn test_do_not_default_to_onion_payload_tlv_format_when_unsupported() {
 880         // Tests that we do not default to creating tlv onions if either of these types features
 881         // exists, which specifies no support for variable length onions for a specific hop, when
 882         // creating a route:
 883         // 1. `InitFeatures` to the counterparty node exchanged with the init message to the node.
 884         // 2. `NodeFeatures` in the `NodeAnnouncementInfo` of a node in sender node's `network_graph`.
 885         // 3. `InvoiceFeatures` specified by the receiving node, when no `NodeAnnouncementInfo`
 886         // `features` exists for the receiver in the sender's `network_graph`.
 887         let chanmon_cfgs = create_chanmon_cfgs(4);
 888         let mut node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 889
 890         // Set `node[1]` config to `InitFeatures::empty()` which return `false` for
 891         // `supports_variable_length_onion()`
 892         let mut node_1_cfg = &mut node_cfgs[1];
 893         node_1_cfg.features = InitFeatures::empty();
 894
 895         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 896         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 897
 898         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 899         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 900         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
 901
 902         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id())
 903                 .with_features(InvoiceFeatures::empty());
 904         let origin_node = &nodes[0];
 905         let network_graph = origin_node.network_graph;
 906         network_graph.clear_nodes_announcement_info();
 907
 908         // Set `NodeAnnouncementInfo` `features` which do not support variable length onions for
 909         // `nodes[2]` in `nodes[0]`'s `network_graph`.
 910         let nodes_2_unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
 911                 features: NodeFeatures::empty(),
 912                 timestamp: 0,
 913                 node_id: nodes[2].node.get_our_node_id(),
 914                 rgb: [32; 3],
 915                 alias: [16;32],
 916                 addresses: Vec::new(),
 917                 excess_address_data: Vec::new(),
 918                 excess_data: Vec::new(),
 919         };
 920         let _res = network_graph.update_node_from_unsigned_announcement(&nodes_2_unsigned_node_announcement);
 921
 922         let (route, _, _, _) = get_route_and_payment_hash!(
 923                 origin_node, nodes[3], payment_params, 10_000, TEST_FINAL_CLTV);
 924
 925         let hops = &route.paths[0];
 926
 927         // Assert that the hop between `nodes[0]` and `nodes[1]` doesn't support variable length
 928         // onions, as as the `InitFeatures` exchanged (`InitFeatures::empty()`) in the init message
 929         // between the nodes when setting up the channel is used when creating the `route` and that we
 930         // therefore do not default to supporting variable length onions. Despite `nodes[0]` having no
 931         // `NodeAnnouncementInfo` `features` for `node[1]`.
 932         assert!(!hops[0].node_features.supports_variable_length_onion());
 933         // Assert that the hop between `nodes[1]` and `nodes[2]` uses the `features` from
 934         // `nodes_2_unsigned_node_announcement` that doesn't support variable length onions.
 935         assert!(!hops[1].node_features.supports_variable_length_onion());
 936         // Assert that the hop between `nodes[2]` and `nodes[3]` uses the `InvoiceFeatures` set to the
 937         // `payment_params`, that doesn't support variable length onions. We therefore do not end up
 938         // defaulting to supporting variable length onions, despite `nodes[0]` having no
 939         // `NodeAnnouncementInfo` `features` for `node[3]`.
 940         assert!(!hops[2].node_features.supports_variable_length_onion());
 941
 942         let cur_height = nodes[0].best_block_info().1 + 1;
 943         let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 944
 945         for onion_payload in onion_payloads.iter() {
 946                 match onion_payload.format {
 947                         msgs::OnionHopDataFormat::Legacy {..} => {}
 948                         _ => {
 949                                 panic!("Should have only have generated `msgs::OnionHopDataFormat::Legacy` payloads");
 950                         }
 951                 }
 952         }
 953 }
 954
 955 macro_rules! get_phantom_route {
 956         ($nodes: expr, $amt: expr, $channel: expr) => {{
 957                 let secp_ctx = Secp256k1::new();
 958                 let phantom_secret = $nodes[1].keys_manager.get_node_secret(Recipient::PhantomNode).unwrap();
 959                 let phantom_pubkey = PublicKey::from_secret_key(&secp_ctx, &phantom_secret);
 960                 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
 961                 let payment_params = PaymentParameters::from_node_id(phantom_pubkey)
 962                         .with_features(InvoiceFeatures::known())
 963                         .with_route_hints(vec![RouteHint(vec![
 964                                         RouteHintHop {
 965                                                 src_node_id: $nodes[0].node.get_our_node_id(),
 966                                                 short_channel_id: $channel.0.contents.short_channel_id,
 967                                                 fees: RoutingFees {
 968                                                         base_msat: $channel.0.contents.fee_base_msat,
 969                                                         proportional_millionths: $channel.0.contents.fee_proportional_millionths,
 970                                                 },
 971                                                 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
 972                                                 htlc_minimum_msat: None,
 973                                                 htlc_maximum_msat: None,
 974                                         },
 975                                         RouteHintHop {
 976                                                 src_node_id: phantom_route_hint.real_node_pubkey,
 977                                                 short_channel_id: phantom_route_hint.phantom_scid,
 978                                                 fees: RoutingFees {
 979                                                         base_msat: 0,
 980                                                         proportional_millionths: 0,
 981                                                 },
 982                                                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
 983                                                 htlc_minimum_msat: None,
 984                                                 htlc_maximum_msat: None,
 985                                         }
 986                 ])]);
 987                 let scorer = test_utils::TestScorer::with_penalty(0);
 988                 let network_graph = $nodes[0].network_graph.read_only();
 989                 (get_route(
 990                         &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
 991                         Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 992                         $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32]
 993                 ).unwrap(), phantom_route_hint.phantom_scid)
 994         }
 995 }}
 996
 997 #[test]
 998 fn test_phantom_onion_hmac_failure() {
 999         let chanmon_cfgs = create_chanmon_cfgs(2);
1000         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1001         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1002         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1003
1004         let channel = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1005
1006         // Get the route.
1007         let recv_value_msat = 10_000;
1008         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1009         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1010
1011         // Route the HTLC through to the destination.
1012         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1013         check_added_monitors!(nodes[0], 1);
1014         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1015         let mut update_add = update_0.update_add_htlcs[0].clone();
1016
1017         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1018         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1019
1020         // Modify the payload so the phantom hop's HMAC is bogus.
1021         let sha256_of_onion = {
1022                 let mut channel_state = nodes[1].node.channel_state.lock().unwrap();
1023                 let mut pending_forward = channel_state.forward_htlcs.get_mut(&phantom_scid).unwrap();
1024                 match pending_forward[0] {
1025                         HTLCForwardInfo::AddHTLC {
1026                                 forward_info: PendingHTLCInfo {
1027                                         routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1028                                         ..
1029                                 }, ..
1030                         } => {
1031                                 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1032                                 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1033                         },
1034                         _ => panic!("Unexpected forward"),
1035                 }
1036         };
1037         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1038         nodes[1].node.process_pending_htlc_forwards();
1039         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1040         nodes[1].node.process_pending_htlc_forwards();
1041         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1042         check_added_monitors!(&nodes[1], 1);
1043         assert!(update_1.update_fail_htlcs.len() == 1);
1044         let fail_msg = update_1.update_fail_htlcs[0].clone();
1045         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1046         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1047
1048         // Ensure the payment fails with the expected error.
1049         let mut fail_conditions = PaymentFailedConditions::new()
1050                 .blamed_scid(phantom_scid)
1051                 .blamed_chan_closed(true)
1052                 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1053         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1054 }
1055
1056 #[test]
1057 fn test_phantom_invalid_onion_payload() {
1058         let chanmon_cfgs = create_chanmon_cfgs(2);
1059         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1060         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1061         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1062
1063         let channel = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1064
1065         // Get the route.
1066         let recv_value_msat = 10_000;
1067         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1068         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1069
1070         // We'll use the session priv later when constructing an invalid onion packet.
1071         let session_priv = [3; 32];
1072         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1073         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1074         check_added_monitors!(nodes[0], 1);
1075         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1076         let mut update_add = update_0.update_add_htlcs[0].clone();
1077
1078         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1079         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1080
1081         // Modify the onion packet to have an invalid payment amount.
1082         for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
1083                 for f in pending_forwards.iter_mut() {
1084                         match f {
1085                                 &mut HTLCForwardInfo::AddHTLC {
1086                                         forward_info: PendingHTLCInfo {
1087                                                 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1088                                                 ..
1089                                         }, ..
1090                                 } => {
1091                                         // Construct the onion payloads for the entire route and an invalid amount.
1092                                         let height = nodes[0].best_block_info().1;
1093                                         let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1094                                         let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1095                                         let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], msgs::MAX_VALUE_MSAT + 1, &Some(payment_secret), height + 1, &None).unwrap();
1096                                         // We only want to construct the onion packet for the last hop, not the entire route, so
1097                                         // remove the first hop's payload and its keys.
1098                                         onion_keys.remove(0);
1099                                         onion_payloads.remove(0);
1100
1101                                         let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1102                                         onion_packet.hop_data = new_onion_packet.hop_data;
1103                                         onion_packet.hmac = new_onion_packet.hmac;
1104                                 },
1105                                 _ => panic!("Unexpected forward"),
1106                         }
1107                 }
1108         }
1109         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1110         nodes[1].node.process_pending_htlc_forwards();
1111         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1112         nodes[1].node.process_pending_htlc_forwards();
1113         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1114         check_added_monitors!(&nodes[1], 1);
1115         assert!(update_1.update_fail_htlcs.len() == 1);
1116         let fail_msg = update_1.update_fail_htlcs[0].clone();
1117         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1118         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1119
1120         // Ensure the payment fails with the expected error.
1121         let error_data = Vec::new();
1122         let mut fail_conditions = PaymentFailedConditions::new()
1123                 .blamed_scid(phantom_scid)
1124                 .blamed_chan_closed(true)
1125                 .expected_htlc_error_data(0x4000 | 22, &error_data);
1126         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1127 }
1128
1129 #[test]
1130 fn test_phantom_final_incorrect_cltv_expiry() {
1131         let chanmon_cfgs = create_chanmon_cfgs(2);
1132         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1135
1136         let channel = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1137
1138         // Get the route.
1139         let recv_value_msat = 10_000;
1140         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1141         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1142
1143         // Route the HTLC through to the destination.
1144         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1145         check_added_monitors!(nodes[0], 1);
1146         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1147         let mut update_add = update_0.update_add_htlcs[0].clone();
1148
1149         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1150         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1151
1152         // Modify the payload so the phantom hop's HMAC is bogus.
1153         for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
1154                 for f in pending_forwards.iter_mut() {
1155                         match f {
1156                                 &mut HTLCForwardInfo::AddHTLC {
1157                                         forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1158                                 } => {
1159                                         *outgoing_cltv_value += 1;
1160                                 },
1161                                 _ => panic!("Unexpected forward"),
1162                         }
1163                 }
1164         }
1165         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1166         nodes[1].node.process_pending_htlc_forwards();
1167         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1168         nodes[1].node.process_pending_htlc_forwards();
1169         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1170         check_added_monitors!(&nodes[1], 1);
1171         assert!(update_1.update_fail_htlcs.len() == 1);
1172         let fail_msg = update_1.update_fail_htlcs[0].clone();
1173         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1174         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1175
1176         // Ensure the payment fails with the expected error.
1177         let expected_cltv = 82;
1178         let error_data = byte_utils::be32_to_array(expected_cltv).to_vec();
1179         let mut fail_conditions = PaymentFailedConditions::new()
1180                 .blamed_scid(phantom_scid)
1181                 .expected_htlc_error_data(18, &error_data);
1182         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1183 }
1184
1185 #[test]
1186 fn test_phantom_failure_too_low_cltv() {
1187         let chanmon_cfgs = create_chanmon_cfgs(2);
1188         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1189         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1190         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1191
1192         let channel = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1193
1194         // Get the route.
1195         let recv_value_msat = 10_000;
1196         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1197         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1198
1199         // Modify the route to have a too-low cltv.
1200         route.paths[0][1].cltv_expiry_delta = 5;
1201
1202         // Route the HTLC through to the destination.
1203         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1204         check_added_monitors!(nodes[0], 1);
1205         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1206         let mut update_add = update_0.update_add_htlcs[0].clone();
1207
1208         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1209         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1210
1211         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1212         nodes[1].node.process_pending_htlc_forwards();
1213         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1214         nodes[1].node.process_pending_htlc_forwards();
1215         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1216         check_added_monitors!(&nodes[1], 1);
1217         assert!(update_1.update_fail_htlcs.len() == 1);
1218         let fail_msg = update_1.update_fail_htlcs[0].clone();
1219         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1220         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1221
1222         // Ensure the payment fails with the expected error.
1223         let error_data = Vec::new();
1224         let mut fail_conditions = PaymentFailedConditions::new()
1225                 .blamed_scid(phantom_scid)
1226                 .expected_htlc_error_data(17, &error_data);
1227         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1228 }
1229
1230 #[test]
1231 fn test_phantom_failure_too_low_recv_amt() {
1232         let chanmon_cfgs = create_chanmon_cfgs(2);
1233         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1234         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1235         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1236
1237         let channel = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1238
1239         // Get the route with a too-low amount.
1240         let recv_amt_msat = 10_000;
1241         let bad_recv_amt_msat = recv_amt_msat - 10;
1242         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1243         let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1244
1245         // Route the HTLC through to the destination.
1246         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1247         check_added_monitors!(nodes[0], 1);
1248         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1249         let mut update_add = update_0.update_add_htlcs[0].clone();
1250
1251         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1252         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1253
1254         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1255         nodes[1].node.process_pending_htlc_forwards();
1256         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1257         nodes[1].node.process_pending_htlc_forwards();
1258         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1259         nodes[1].node.process_pending_htlc_forwards();
1260         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1261         check_added_monitors!(&nodes[1], 1);
1262         assert!(update_1.update_fail_htlcs.len() == 1);
1263         let fail_msg = update_1.update_fail_htlcs[0].clone();
1264         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1265         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1266
1267         // Ensure the payment fails with the expected error.
1268         let mut error_data = byte_utils::be64_to_array(bad_recv_amt_msat).to_vec();
1269         error_data.extend_from_slice(
1270                 &byte_utils::be32_to_array(nodes[1].node.best_block.read().unwrap().height()),
1271         );
1272         let mut fail_conditions = PaymentFailedConditions::new()
1273                 .blamed_scid(phantom_scid)
1274                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1275         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1276 }
1277
1278 #[test]
1279 fn test_phantom_dust_exposure_failure() {
1280         // Set the max dust exposure to the dust limit.
1281         let max_dust_exposure = 546;
1282         let mut receiver_config = UserConfig::default();
1283         receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1284         receiver_config.channel_handshake_config.announced_channel = true;
1285
1286         let chanmon_cfgs = create_chanmon_cfgs(2);
1287         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1288         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1289         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1290
1291         let channel = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1292
1293         // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1294         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1295         let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1296
1297         // Route the HTLC through to the destination.
1298         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1299         check_added_monitors!(nodes[0], 1);
1300         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1301         let mut update_add = update_0.update_add_htlcs[0].clone();
1302
1303         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1304         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1305
1306         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1307         assert!(update_1.update_fail_htlcs.len() == 1);
1308         let fail_msg = update_1.update_fail_htlcs[0].clone();
1309         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1310         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1311
1312         // Ensure the payment fails with the expected error.
1313         let mut err_data = Vec::new();
1314         err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1315         err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1316         err_data.extend_from_slice(&channel.1.encode());
1317
1318         let mut fail_conditions = PaymentFailedConditions::new()
1319                 .blamed_scid(channel.0.contents.short_channel_id)
1320                 .blamed_chan_closed(false)
1321                 .expected_htlc_error_data(0x1000 | 7, &err_data);
1322                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1323 }
1324
1325 #[test]
1326 fn test_phantom_failure_reject_payment() {
1327         // Test that the user can successfully fail back a phantom node payment.
1328         let chanmon_cfgs = create_chanmon_cfgs(2);
1329         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1330         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1331         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1332
1333         let channel = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1334
1335         // Get the route with a too-low amount.
1336         let recv_amt_msat = 10_000;
1337         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1338         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1339
1340         // Route the HTLC through to the destination.
1341         nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1342         check_added_monitors!(nodes[0], 1);
1343         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1344         let mut update_add = update_0.update_add_htlcs[0].clone();
1345
1346         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1347         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1348
1349         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1350         nodes[1].node.process_pending_htlc_forwards();
1351         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1352         nodes[1].node.process_pending_htlc_forwards();
1353         expect_payment_received!(nodes[1], payment_hash, payment_secret, recv_amt_msat);
1354         nodes[1].node.fail_htlc_backwards(&payment_hash);
1355         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1356         nodes[1].node.process_pending_htlc_forwards();
1357
1358         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1359         check_added_monitors!(&nodes[1], 1);
1360         assert!(update_1.update_fail_htlcs.len() == 1);
1361         let fail_msg = update_1.update_fail_htlcs[0].clone();
1362         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1363         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1364
1365         // Ensure the payment fails with the expected error.
1366         let mut error_data = byte_utils::be64_to_array(recv_amt_msat).to_vec();
1367         error_data.extend_from_slice(
1368                 &byte_utils::be32_to_array(nodes[1].node.best_block.read().unwrap().height()),
1369         );
1370         let mut fail_conditions = PaymentFailedConditions::new()
1371                 .blamed_scid(phantom_scid)
1372                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1373         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1374 }