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