_ 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::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
  15 use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
  16 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
  17 use crate::ln::{PaymentHash, PaymentSecret};
  18 use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
  19 use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
  20 use crate::ln::onion_utils;
  21 use crate::routing::gossip::{NetworkUpdate, RoutingFees};
  22 use crate::routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop};
  23 use crate::ln::features::{InitFeatures, InvoiceFeatures};
  24 use crate::ln::msgs;
  25 use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate};
  26 use crate::ln::wire::Encode;
  27 use crate::util::ser::{Writeable, Writer};
  28 use crate::util::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, SecretKey};
  39
  40 use crate::io;
  41 use crate::prelude::*;
  42 use core::default::Default;
  43
  44 use crate::ln::functional_test_utils::*;
  45
  46 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>)
  47         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
  48                                 F2: FnMut(),
  49 {
  50         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);
  51 }
  52
  53 // test_case
  54 // 0: node1 fails backward
  55 // 1: final node fails backward
  56 // 2: payment completed but the user rejects the payment
  57 // 3: final node fails backward (but tamper onion payloads from node0)
  58 // 100: trigger error in the intermediate node and tamper returning fail_htlc
  59 // 200: trigger error in the final node and tamper returning fail_htlc
  60 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>)
  61         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
  62                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
  63                                 F3: FnMut(),
  64 {
  65         macro_rules! expect_event {
  66                 ($node: expr, $event_type: path) => {{
  67                         let events = $node.node.get_and_clear_pending_events();
  68                         assert_eq!(events.len(), 1);
  69                         match events[0] {
  70                                 $event_type { .. } => {},
  71                                 _ => panic!("Unexpected event"),
  72                         }
  73                 }}
  74         }
  75
  76         macro_rules! expect_htlc_forward {
  77                 ($node: expr) => {{
  78                         expect_event!($node, Event::PendingHTLCsForwardable);
  79                         $node.node.process_pending_htlc_forwards();
  80                 }}
  81         }
  82
  83         // 0 ~~> 2 send payment
  84         let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
  85         nodes[0].node.send_payment_with_route(&route, *payment_hash,
  86                 RecipientOnionFields::secret_only(*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::PaymentClaimable);
 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(), 2);
 171         if let &Event::PaymentPathFailed { ref payment_failed_permanently, ref short_channel_id, ref error_code, failure: PathFailure::OnPath { ref network_update }, .. } = &events[0] {
 172                 assert_eq!(*payment_failed_permanently, !expected_retryable);
 173                 assert_eq!(*error_code, expected_error_code);
 174                 if expected_channel_update.is_some() {
 175                         match network_update {
 176                                 Some(update) => match update {
 177                                         &NetworkUpdate::ChannelUpdateMessage { .. } => {
 178                                                 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
 179                                                         panic!("channel_update not found!");
 180                                                 }
 181                                         },
 182                                         &NetworkUpdate::ChannelFailure { ref short_channel_id, ref is_permanent } => {
 183                                                 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
 184                                                         assert!(*short_channel_id == *expected_short_channel_id);
 185                                                         assert!(*is_permanent == *expected_is_permanent);
 186                                                 } else {
 187                                                         panic!("Unexpected message event");
 188                                                 }
 189                                         },
 190                                         &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
 191                                                 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
 192                                                         assert!(*node_id == *expected_node_id);
 193                                                         assert!(*is_permanent == *expected_is_permanent);
 194                                                 } else {
 195                                                         panic!("Unexpected message event");
 196                                                 }
 197                                         },
 198                                 }
 199                                 None => panic!("Expected channel update"),
 200                         }
 201                 } else {
 202                         assert!(network_update.is_none());
 203                 }
 204                 if let Some(expected_short_channel_id) = expected_short_channel_id {
 205                         match short_channel_id {
 206                                 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
 207                                 None => panic!("Expected short channel id"),
 208                         }
 209                 } else {
 210                         assert!(short_channel_id.is_none());
 211                 }
 212         } else {
 213                 panic!("Unexpected event");
 214         }
 215         match events[1] {
 216                 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 217                         assert_eq!(*payment_hash, ev_payment_hash);
 218                         assert_eq!(payment_id, ev_payment_id);
 219                 }
 220                 _ => panic!("Unexpected second event"),
 221         }
 222 }
 223
 224 impl msgs::ChannelUpdate {
 225         fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
 226                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
 227                 use bitcoin::secp256k1::ecdsa::Signature;
 228                 msgs::ChannelUpdate {
 229                         signature: Signature::from(unsafe { FFISignature::new() }),
 230                         contents: msgs::UnsignedChannelUpdate {
 231                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
 232                                 short_channel_id,
 233                                 timestamp: 0,
 234                                 flags: 0,
 235                                 cltv_expiry_delta: 0,
 236                                 htlc_minimum_msat: 0,
 237                                 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
 238                                 fee_base_msat: 0,
 239                                 fee_proportional_millionths: 0,
 240                                 excess_data: vec![],
 241                         }
 242                 }
 243         }
 244 }
 245
 246 struct BogusOnionHopData {
 247         data: Vec<u8>
 248 }
 249 impl BogusOnionHopData {
 250         fn new(orig: msgs::OnionHopData) -> Self {
 251                 Self { data: orig.encode() }
 252         }
 253 }
 254 impl Writeable for BogusOnionHopData {
 255         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 256                 writer.write_all(&self.data[..])
 257         }
 258 }
 259
 260 const BADONION: u16 = 0x8000;
 261 const PERM: u16 = 0x4000;
 262 const NODE: u16 = 0x2000;
 263 const UPDATE: u16 = 0x1000;
 264
 265 #[test]
 266 fn test_fee_failures() {
 267         // Tests that the fee required when forwarding remains consistent over time. This was
 268         // previously broken, with forwarding fees floating based on the fee estimator at the time of
 269         // forwarding.
 270         //
 271         // When this test was written, the default base fee floated based on the HTLC count.
 272         // It is now fixed, so we simply set the fee to the expected value here.
 273         let mut config = test_default_channel_config();
 274         config.channel_config.forwarding_fee_base_msat = 196;
 275
 276         let chanmon_cfgs = create_chanmon_cfgs(3);
 277         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 278         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
 279         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 280         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
 281
 282         // positive case
 283         let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
 284         nodes[0].node.send_payment_with_route(&route, payment_hash_success,
 285                 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
 286         check_added_monitors!(nodes[0], 1);
 287         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
 288         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
 289
 290         // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
 291         // malleated the payment before forwarding, taking funds when they shouldn't have.
 292         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 293         let short_channel_id = channels[0].0.contents.short_channel_id;
 294         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 295                 msg.amount_msat -= 1;
 296         }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
 297
 298         // In an earlier version, we spuriously failed to forward payments if the expected feerate
 299         // changed between the channel open and the payment.
 300         {
 301                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
 302                 *feerate_lock *= 2;
 303         }
 304
 305         let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
 306         nodes[0].node.send_payment_with_route(&route, payment_hash_success,
 307                 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
 308         check_added_monitors!(nodes[0], 1);
 309         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
 310         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
 311 }
 312
 313 #[test]
 314 fn test_onion_failure() {
 315         // When we check for amount_below_minimum below, we want to test that we're using the *right*
 316         // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
 317         // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
 318         // This exposed a previous bug because we were using the wrong value all the way down in
 319         // Channel::get_counterparty_htlc_minimum_msat().
 320         let mut node_2_cfg: UserConfig = Default::default();
 321         node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
 322         node_2_cfg.channel_handshake_config.announced_channel = true;
 323         node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
 324
 325         // When this test was written, the default base fee floated based on the HTLC count.
 326         // It is now fixed, so we simply set the fee to the expected value here.
 327         let mut config = test_default_channel_config();
 328         config.channel_config.forwarding_fee_base_msat = 196;
 329
 330         let chanmon_cfgs = create_chanmon_cfgs(3);
 331         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 332         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
 333         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 334         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
 335         for node in nodes.iter() {
 336                 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
 337         }
 338         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
 339         // positive case
 340         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
 341
 342         // intermediate node failure
 343         let short_channel_id = channels[1].0.contents.short_channel_id;
 344         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 345                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 346                 let cur_height = nodes[0].best_block_info().1 + 1;
 347                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 348                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 349                 let mut new_payloads = Vec::new();
 350                 for payload in onion_payloads.drain(..) {
 351                         new_payloads.push(BogusOnionHopData::new(payload));
 352                 }
 353                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
 354                 // describing a length-1 TLV payload, which is obviously bogus.
 355                 new_payloads[0].data[0] = 1;
 356                 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
 357         }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 358
 359         // final node failure
 360         let short_channel_id = channels[1].0.contents.short_channel_id;
 361         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 362                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 363                 let cur_height = nodes[0].best_block_info().1 + 1;
 364                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 365                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 366                 let mut new_payloads = Vec::new();
 367                 for payload in onion_payloads.drain(..) {
 368                         new_payloads.push(BogusOnionHopData::new(payload));
 369                 }
 370                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
 371                 // length-1 TLV payload, which is obviously bogus.
 372                 new_payloads[1].data[0] = 1;
 373                 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
 374         }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 375
 376         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
 377         // receiving simulated fail messages
 378         // intermediate node failure
 379         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 380                 // trigger error
 381                 msg.amount_msat -= 1;
 382         }, |msg| {
 383                 // and tamper returning error message
 384                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 385                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 386                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
 387         }, ||{}, 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));
 388
 389         // final node failure
 390         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 391                 // and tamper returning error message
 392                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 393                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 394                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
 395         }, ||{
 396                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 397         }, 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));
 398         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 399
 400         // intermediate node failure
 401         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 402                 msg.amount_msat -= 1;
 403         }, |msg| {
 404                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 405                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 406                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
 407         }, ||{}, 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));
 408
 409         // final node failure
 410         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 411                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 412                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 413                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
 414         }, ||{
 415                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 416         }, 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));
 417         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 418
 419         // intermediate node failure
 420         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 421                 msg.amount_msat -= 1;
 422         }, |msg| {
 423                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 424                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 425                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
 426         }, ||{
 427                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 428         }, 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));
 429
 430         // final node failure
 431         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
 432                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 433                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 434                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
 435         }, ||{
 436                 nodes[2].node.fail_htlc_backwards(&payment_hash);
 437         }, 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));
 438         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
 439
 440         // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
 441         // the UpdateAddHTLC that we sent.
 442         let short_channel_id = channels[0].0.contents.short_channel_id;
 443         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
 444                 Some(BADONION|PERM|4), None, Some(short_channel_id));
 445
 446         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
 447                 Some(BADONION|PERM|5), None, Some(short_channel_id));
 448
 449         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,
 450                 Some(BADONION|PERM|6), None, Some(short_channel_id));
 451
 452         let short_channel_id = channels[1].0.contents.short_channel_id;
 453         let chan_update = ChannelUpdate::dummy(short_channel_id);
 454
 455         let mut err_data = Vec::new();
 456         err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
 457         err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
 458         err_data.extend_from_slice(&chan_update.encode());
 459         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 460                 msg.amount_msat -= 1;
 461         }, |msg| {
 462                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 463                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 464                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
 465         }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
 466
 467         // Check we can still handle onion failures that include channel updates without a type prefix
 468         let err_data_without_type = chan_update.encode_with_len();
 469         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 470                 msg.amount_msat -= 1;
 471         }, |msg| {
 472                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 473                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 474                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
 475         }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
 476
 477         let short_channel_id = channels[1].0.contents.short_channel_id;
 478         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 479                 msg.amount_msat -= 1;
 480         }, |msg| {
 481                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 482                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 483                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
 484                 // short_channel_id from the processing node
 485         }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 486
 487         let short_channel_id = channels[1].0.contents.short_channel_id;
 488         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
 489                 msg.amount_msat -= 1;
 490         }, |msg| {
 491                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 492                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 493                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
 494                 // short_channel_id from the processing node
 495         }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
 496
 497         let mut bogus_route = route.clone();
 498         bogus_route.paths[0][1].short_channel_id -= 1;
 499         let short_channel_id = bogus_route.paths[0][1].short_channel_id;
 500         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
 501           Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
 502
 503         let short_channel_id = channels[1].0.contents.short_channel_id;
 504         let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
 505                 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
 506                 .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         }, || {}, false, Some(0x4000 | 15), 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(PendingAddHTLCInfo { 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(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
 571                                                 forward_info.outgoing_amt_msat -= 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());
 582                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 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 #[test]
 609 fn test_overshoot_final_cltv() {
 610         let chanmon_cfgs = create_chanmon_cfgs(3);
 611         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 612         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
 613         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 614         create_announced_chan_between_nodes(&nodes, 0, 1);
 615         create_announced_chan_between_nodes(&nodes, 1, 2);
 616         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
 617
 618         let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
 619         nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id).unwrap();
 620
 621         check_added_monitors!(nodes[0], 1);
 622         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 623         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
 624         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
 625         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
 626
 627         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 628         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
 629                 for f in pending_forwards.iter_mut() {
 630                         match f {
 631                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
 632                                         forward_info.outgoing_cltv_value += 1,
 633                                 _ => {},
 634                         }
 635                 }
 636         }
 637         expect_pending_htlcs_forwardable!(nodes[1]);
 638
 639         check_added_monitors!(&nodes[1], 1);
 640         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
 641         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
 642         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
 643         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
 644
 645         expect_pending_htlcs_forwardable!(nodes[2]);
 646         expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
 647         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 648 }
 649
 650 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
 651         // Create a network of three nodes and two channels connecting them. We'll be updating the
 652         // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
 653         let mut config = UserConfig::default();
 654         config.channel_handshake_config.announced_channel = announced_channel;
 655         config.channel_handshake_limits.force_announced_channel_preference = false;
 656         config.accept_forwards_to_priv_channels = !announced_channel;
 657         let chanmon_cfgs = create_chanmon_cfgs(3);
 658         let persister;
 659         let chain_monitor;
 660         let channel_manager_1_deserialized;
 661         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 662         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
 663         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 664
 665         let other_channel = create_chan_between_nodes(
 666                 &nodes[0], &nodes[1],
 667         );
 668         let channel_to_update = if announced_channel {
 669                 let channel = create_announced_chan_between_nodes(
 670                         &nodes, 1, 2,
 671                 );
 672                 (channel.2, channel.0.contents.short_channel_id)
 673         } else {
 674                 let channel = create_unannounced_chan_between_nodes_with_value(
 675                         &nodes, 1, 2, 100000, 10001,
 676                 );
 677                 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
 678         };
 679         let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
 680
 681         let default_config = ChannelConfig::default();
 682
 683         // A test payment should succeed as the ChannelConfig has not been changed yet.
 684         const PAYMENT_AMT: u64 = 40000;
 685         let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
 686                 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
 687         } else {
 688                 let hop_hints = vec![RouteHint(vec![RouteHintHop {
 689                         src_node_id: nodes[1].node.get_our_node_id(),
 690                         short_channel_id: channel_to_update.1,
 691                         fees: RoutingFees {
 692                                 base_msat: default_config.forwarding_fee_base_msat,
 693                                 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
 694                         },
 695                         cltv_expiry_delta: default_config.cltv_expiry_delta,
 696                         htlc_maximum_msat: None,
 697                         htlc_minimum_msat: None,
 698                 }])];
 699                 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
 700                         .with_features(nodes[2].node.invoice_features())
 701                         .with_route_hints(hop_hints);
 702                 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV)
 703         };
 704         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
 705                 payment_hash, payment_secret);
 706         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 707
 708         // Closure to force expiry of a channel's previous config.
 709         let expire_prev_config = || {
 710                 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
 711                         nodes[1].node.timer_tick_occurred();
 712                 }
 713         };
 714
 715         // Closure to update and retrieve the latest ChannelUpdate.
 716         let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
 717                 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
 718                 nodes[1].node.update_channel_config(
 719                         channel_to_update_counterparty, &[channel_to_update.0], config,
 720                 ).unwrap();
 721                 let events = nodes[1].node.get_and_clear_pending_msg_events();
 722                 assert_eq!(events.len(), expect_new_update as usize);
 723                 if !expect_new_update {
 724                         return None;
 725                 }
 726                 let new_update = match &events[0] {
 727                         MessageSendEvent::BroadcastChannelUpdate { msg } => {
 728                                 assert!(announced_channel);
 729                                 msg.clone()
 730                         },
 731                         MessageSendEvent::SendChannelUpdate { node_id, msg } => {
 732                                 assert_eq!(node_id, channel_to_update_counterparty);
 733                                 assert!(!announced_channel);
 734                                 msg.clone()
 735                         },
 736                         _ => panic!("expected Broadcast/SendChannelUpdate event"),
 737                 };
 738                 if prev_update.is_some() {
 739                         assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
 740                 }
 741                 if should_expire_prev_config {
 742                         expire_prev_config();
 743                 }
 744                 Some(new_update)
 745         };
 746
 747         // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
 748         // lead to onion failures at the first hop once we update the ChannelConfig for the
 749         // second hop.
 750         let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
 751                 let short_channel_id = channel_to_update.1;
 752                 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
 753                 run_onion_failure_test(
 754                         name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
 755                         Some(error_code), Some(network_update), Some(short_channel_id),
 756                 );
 757         };
 758
 759         // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
 760         let mut invalid_config = default_config.clone();
 761         invalid_config.cltv_expiry_delta = 0;
 762         match nodes[1].node.update_channel_config(
 763                 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
 764         ) {
 765                 Err(APIError::APIMisuseError{ .. }) => {},
 766                 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
 767         }
 768
 769         // Increase the base fee which should trigger a new ChannelUpdate.
 770         let mut config = nodes[1].node.list_usable_channels().iter()
 771                 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
 772                 .config.unwrap();
 773         config.forwarding_fee_base_msat = u32::max_value();
 774         let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
 775
 776         // The old policy should still be in effect until a new block is connected.
 777         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
 778                 payment_hash, payment_secret);
 779         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 780
 781         // Connect a block, which should expire the previous config, leading to a failure when
 782         // forwarding the HTLC.
 783         expire_prev_config();
 784         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
 785
 786         // Redundant updates should not trigger a new ChannelUpdate.
 787         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
 788
 789         // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
 790         config.force_close_avoidance_max_fee_satoshis *= 2;
 791         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
 792
 793         // Reset the base fee to the default and increase the proportional fee which should trigger a
 794         // new ChannelUpdate.
 795         config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
 796         config.cltv_expiry_delta = u16::max_value();
 797         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
 798         expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
 799
 800         // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
 801         // ChannelUpdate.
 802         config.cltv_expiry_delta = default_config.cltv_expiry_delta;
 803         config.forwarding_fee_proportional_millionths = u32::max_value();
 804         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
 805         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
 806
 807         // To test persistence of the updated config, we'll re-initialize the ChannelManager.
 808         let config_after_restart = {
 809                 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
 810                 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
 811                 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
 812                         &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
 813                 nodes[1].node.list_channels().iter()
 814                         .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
 815                         .config.unwrap()
 816         };
 817         assert_eq!(config, config_after_restart);
 818 }
 819
 820 #[test]
 821 fn test_onion_failure_stale_channel_update() {
 822         do_test_onion_failure_stale_channel_update(false);
 823         do_test_onion_failure_stale_channel_update(true);
 824 }
 825
 826 #[test]
 827 fn test_always_create_tlv_format_onion_payloads() {
 828         // Verify that we always generate tlv onion format payloads, even if the features specifically
 829         // specifies no support for variable length onions, as the legacy payload format has been
 830         // deprecated in BOLT4.
 831         let chanmon_cfgs = create_chanmon_cfgs(3);
 832         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 833
 834         // Set `node[1]`'s init features to features which return `false` for
 835         // `supports_variable_length_onion()`
 836         let mut no_variable_length_onion_features = InitFeatures::empty();
 837         no_variable_length_onion_features.set_static_remote_key_required();
 838         *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
 839
 840         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 841         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 842
 843         create_announced_chan_between_nodes(&nodes, 0, 1);
 844         create_announced_chan_between_nodes(&nodes, 1, 2);
 845
 846         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
 847                 .with_features(InvoiceFeatures::empty());
 848         let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000, TEST_FINAL_CLTV);
 849
 850         let hops = &route.paths[0];
 851         // Asserts that the first hop to `node[1]` signals no support for variable length onions.
 852         assert!(!hops[0].node_features.supports_variable_length_onion());
 853         // Asserts that the first hop to `node[1]` signals no support for variable length onions.
 854         assert!(!hops[1].node_features.supports_variable_length_onion());
 855
 856         let cur_height = nodes[0].best_block_info().1 + 1;
 857         let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
 858
 859         match onion_payloads[0].format {
 860                 msgs::OnionHopDataFormat::NonFinalNode {..} => {},
 861                 _ => { panic!(
 862                         "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
 863                         despite that the features signals no support for variable length onions"
 864                 )}
 865         }
 866         match onion_payloads[1].format {
 867                 msgs::OnionHopDataFormat::FinalNode {..} => {},
 868                 _ => {panic!(
 869                         "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
 870                         despite that the features signals no support for variable length onions"
 871                 )}
 872         }
 873 }
 874
 875 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
 876
 877         let chanmon_cfgs = create_chanmon_cfgs(2);
 878         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 879         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 880         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 881
 882         create_announced_chan_between_nodes(&nodes, 0, 1);
 883
 884         let payment_amount = 100_000;
 885         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
 886         nodes[0].node.send_payment_with_route(&route, payment_hash,
 887                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
 888         check_added_monitors!(nodes[0], 1);
 889
 890         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 891         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
 892         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 893         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
 894
 895         expect_pending_htlcs_forwardable!(nodes[1]);
 896         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
 897         nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
 898
 899         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
 900         check_added_monitors!(nodes[1], 1);
 901
 902         let events = nodes[1].node.get_and_clear_pending_msg_events();
 903         assert_eq!(events.len(), 1);
 904         let (update_fail_htlc, commitment_signed) = match events[0] {
 905                 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
 906                         assert!(update_add_htlcs.is_empty());
 907                         assert!(update_fulfill_htlcs.is_empty());
 908                         assert_eq!(update_fail_htlcs.len(), 1);
 909                         assert!(update_fail_malformed_htlcs.is_empty());
 910                         assert!(update_fee.is_none());
 911                         (update_fail_htlcs[0].clone(), commitment_signed)
 912                 },
 913                 _ => panic!("Unexpected event"),
 914         };
 915
 916         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
 917         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
 918
 919         let failure_data = match failure_code {
 920                 FailureCode::TemporaryNodeFailure => vec![],
 921                 FailureCode::RequiredNodeFeatureMissing => vec![],
 922                 FailureCode::IncorrectOrUnknownPaymentDetails => {
 923                         let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
 924                         htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
 925                         htlc_msat_height_data
 926                 }
 927         };
 928
 929         let failure_code = failure_code as u16;
 930         let permanent_flag = 0x4000;
 931         let permanent_fail = (failure_code & permanent_flag) != 0;
 932         expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
 933
 934 }
 935
 936 #[test]
 937 fn test_fail_htlc_backwards_with_reason() {
 938         do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
 939         do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
 940         do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
 941 }
 942
 943 macro_rules! get_phantom_route {
 944         ($nodes: expr, $amt: expr, $channel: expr) => {{
 945                 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
 946                 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
 947                 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
 948                         .with_features($nodes[1].node.invoice_features())
 949                         .with_route_hints(vec![RouteHint(vec![
 950                                         RouteHintHop {
 951                                                 src_node_id: $nodes[0].node.get_our_node_id(),
 952                                                 short_channel_id: $channel.0.contents.short_channel_id,
 953                                                 fees: RoutingFees {
 954                                                         base_msat: $channel.0.contents.fee_base_msat,
 955                                                         proportional_millionths: $channel.0.contents.fee_proportional_millionths,
 956                                                 },
 957                                                 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
 958                                                 htlc_minimum_msat: None,
 959                                                 htlc_maximum_msat: None,
 960                                         },
 961                                         RouteHintHop {
 962                                                 src_node_id: phantom_route_hint.real_node_pubkey,
 963                                                 short_channel_id: phantom_route_hint.phantom_scid,
 964                                                 fees: RoutingFees {
 965                                                         base_msat: 0,
 966                                                         proportional_millionths: 0,
 967                                                 },
 968                                                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
 969                                                 htlc_minimum_msat: None,
 970                                                 htlc_maximum_msat: None,
 971                                         }
 972                 ])]);
 973                 let scorer = test_utils::TestScorer::new();
 974                 let network_graph = $nodes[0].network_graph.read_only();
 975                 (get_route(
 976                         &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
 977                         Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 978                         $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32]
 979                 ).unwrap(), phantom_route_hint.phantom_scid)
 980         }
 981 }}
 982
 983 #[test]
 984 fn test_phantom_onion_hmac_failure() {
 985         let chanmon_cfgs = create_chanmon_cfgs(2);
 986         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 987         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 988         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 989
 990         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
 991
 992         // Get the route.
 993         let recv_value_msat = 10_000;
 994         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
 995         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
 996
 997         // Route the HTLC through to the destination.
 998         nodes[0].node.send_payment_with_route(&route, payment_hash,
 999                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1000         check_added_monitors!(nodes[0], 1);
1001         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1002         let mut update_add = update_0.update_add_htlcs[0].clone();
1003
1004         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1005         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1006
1007         // Modify the payload so the phantom hop's HMAC is bogus.
1008         let sha256_of_onion = {
1009                 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1010                 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1011                 match pending_forward[0] {
1012                         HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1013                                 forward_info: PendingHTLCInfo {
1014                                         routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1015                                         ..
1016                                 }, ..
1017                         }) => {
1018                                 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1019                                 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1020                         },
1021                         _ => panic!("Unexpected forward"),
1022                 }
1023         };
1024         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1025         nodes[1].node.process_pending_htlc_forwards();
1026         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1027         nodes[1].node.process_pending_htlc_forwards();
1028         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1029         check_added_monitors!(&nodes[1], 1);
1030         assert!(update_1.update_fail_htlcs.len() == 1);
1031         let fail_msg = update_1.update_fail_htlcs[0].clone();
1032         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1033         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1034
1035         // Ensure the payment fails with the expected error.
1036         let mut fail_conditions = PaymentFailedConditions::new()
1037                 .blamed_scid(phantom_scid)
1038                 .blamed_chan_closed(true)
1039                 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1040         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1041 }
1042
1043 #[test]
1044 fn test_phantom_invalid_onion_payload() {
1045         let chanmon_cfgs = create_chanmon_cfgs(2);
1046         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1047         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1048         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1049
1050         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1051
1052         // Get the route.
1053         let recv_value_msat = 10_000;
1054         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1055         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1056
1057         // We'll use the session priv later when constructing an invalid onion packet.
1058         let session_priv = [3; 32];
1059         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1060         nodes[0].node.send_payment_with_route(&route, payment_hash,
1061                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1062         check_added_monitors!(nodes[0], 1);
1063         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1064         let mut update_add = update_0.update_add_htlcs[0].clone();
1065
1066         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1067         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1068
1069         // Modify the onion packet to have an invalid payment amount.
1070         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1071                 for f in pending_forwards.iter_mut() {
1072                         match f {
1073                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1074                                         forward_info: PendingHTLCInfo {
1075                                                 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1076                                                 ..
1077                                         }, ..
1078                                 }) => {
1079                                         // Construct the onion payloads for the entire route and an invalid amount.
1080                                         let height = nodes[0].best_block_info().1;
1081                                         let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1082                                         let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1083                                         let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], msgs::MAX_VALUE_MSAT + 1, &Some(payment_secret), height + 1, &None).unwrap();
1084                                         // We only want to construct the onion packet for the last hop, not the entire route, so
1085                                         // remove the first hop's payload and its keys.
1086                                         onion_keys.remove(0);
1087                                         onion_payloads.remove(0);
1088
1089                                         let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1090                                         onion_packet.hop_data = new_onion_packet.hop_data;
1091                                         onion_packet.hmac = new_onion_packet.hmac;
1092                                 },
1093                                 _ => panic!("Unexpected forward"),
1094                         }
1095                 }
1096         }
1097         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1098         nodes[1].node.process_pending_htlc_forwards();
1099         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1100         nodes[1].node.process_pending_htlc_forwards();
1101         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1102         check_added_monitors!(&nodes[1], 1);
1103         assert!(update_1.update_fail_htlcs.len() == 1);
1104         let fail_msg = update_1.update_fail_htlcs[0].clone();
1105         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1106         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1107
1108         // Ensure the payment fails with the expected error.
1109         let error_data = Vec::new();
1110         let mut fail_conditions = PaymentFailedConditions::new()
1111                 .blamed_scid(phantom_scid)
1112                 .blamed_chan_closed(true)
1113                 .expected_htlc_error_data(0x4000 | 22, &error_data);
1114         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1115 }
1116
1117 #[test]
1118 fn test_phantom_final_incorrect_cltv_expiry() {
1119         let chanmon_cfgs = create_chanmon_cfgs(2);
1120         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1121         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1122         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1123
1124         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1125
1126         // Get the route.
1127         let recv_value_msat = 10_000;
1128         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1129         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1130
1131         // Route the HTLC through to the destination.
1132         nodes[0].node.send_payment_with_route(&route, payment_hash,
1133                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1134         check_added_monitors!(nodes[0], 1);
1135         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1136         let mut update_add = update_0.update_add_htlcs[0].clone();
1137
1138         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1139         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1140
1141         // Modify the payload so the phantom hop's HMAC is bogus.
1142         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1143                 for f in pending_forwards.iter_mut() {
1144                         match f {
1145                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1146                                         forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1147                                 }) => {
1148                                         *outgoing_cltv_value -= 1;
1149                                 },
1150                                 _ => panic!("Unexpected forward"),
1151                         }
1152                 }
1153         }
1154         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1155         nodes[1].node.process_pending_htlc_forwards();
1156         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1157         nodes[1].node.process_pending_htlc_forwards();
1158         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1159         check_added_monitors!(&nodes[1], 1);
1160         assert!(update_1.update_fail_htlcs.len() == 1);
1161         let fail_msg = update_1.update_fail_htlcs[0].clone();
1162         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1163         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1164
1165         // Ensure the payment fails with the expected error.
1166         let expected_cltv: u32 = 80;
1167         let error_data = expected_cltv.to_be_bytes().to_vec();
1168         let mut fail_conditions = PaymentFailedConditions::new()
1169                 .blamed_scid(phantom_scid)
1170                 .expected_htlc_error_data(18, &error_data);
1171         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1172 }
1173
1174 #[test]
1175 fn test_phantom_failure_too_low_cltv() {
1176         let chanmon_cfgs = create_chanmon_cfgs(2);
1177         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1178         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1179         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1180
1181         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1182
1183         // Get the route.
1184         let recv_value_msat = 10_000;
1185         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1186         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1187
1188         // Modify the route to have a too-low cltv.
1189         route.paths[0][1].cltv_expiry_delta = 5;
1190
1191         // Route the HTLC through to the destination.
1192         nodes[0].node.send_payment_with_route(&route, payment_hash,
1193                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1194         check_added_monitors!(nodes[0], 1);
1195         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1196         let mut update_add = update_0.update_add_htlcs[0].clone();
1197
1198         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1199         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1200
1201         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1202         nodes[1].node.process_pending_htlc_forwards();
1203         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1204         nodes[1].node.process_pending_htlc_forwards();
1205         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1206         check_added_monitors!(&nodes[1], 1);
1207         assert!(update_1.update_fail_htlcs.len() == 1);
1208         let fail_msg = update_1.update_fail_htlcs[0].clone();
1209         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1210         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1211
1212         // Ensure the payment fails with the expected error.
1213         let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1214         error_data.extend_from_slice(
1215                 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1216         );
1217         let mut fail_conditions = PaymentFailedConditions::new()
1218                 .blamed_scid(phantom_scid)
1219                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1220         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1221 }
1222
1223 #[test]
1224 fn test_phantom_failure_modified_cltv() {
1225         // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1226         // correct error code.
1227         let chanmon_cfgs = create_chanmon_cfgs(2);
1228         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1229         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1230         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1231
1232         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1233
1234         // Get the route.
1235         let recv_value_msat = 10_000;
1236         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1237         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1238
1239         // Route the HTLC through to the destination.
1240         nodes[0].node.send_payment_with_route(&route, payment_hash,
1241                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1242         check_added_monitors!(nodes[0], 1);
1243         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1244         let mut update_add = update_0.update_add_htlcs[0].clone();
1245
1246         // Modify the route to have a too-low cltv.
1247         update_add.cltv_expiry -= 10;
1248
1249         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1250         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1251
1252         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1253         assert!(update_1.update_fail_htlcs.len() == 1);
1254         let fail_msg = update_1.update_fail_htlcs[0].clone();
1255         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1256         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1257
1258         // Ensure the payment fails with the expected error.
1259         let mut fail_conditions = PaymentFailedConditions::new()
1260                 .blamed_scid(phantom_scid)
1261                 .expected_htlc_error_data(0x2000 | 2, &[]);
1262         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1263 }
1264
1265 #[test]
1266 fn test_phantom_failure_expires_too_soon() {
1267         // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1268         // the correct error code.
1269         let chanmon_cfgs = create_chanmon_cfgs(2);
1270         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1271         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1272         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1273
1274         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1275
1276         // Get the route.
1277         let recv_value_msat = 10_000;
1278         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1279         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1280
1281         // Route the HTLC through to the destination.
1282         nodes[0].node.send_payment_with_route(&route, payment_hash,
1283                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1284         check_added_monitors!(nodes[0], 1);
1285         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1286         let mut update_add = update_0.update_add_htlcs[0].clone();
1287
1288         connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1289         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1290         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1291
1292         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1293         assert!(update_1.update_fail_htlcs.len() == 1);
1294         let fail_msg = update_1.update_fail_htlcs[0].clone();
1295         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1296         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1297
1298         // Ensure the payment fails with the expected error.
1299         let mut fail_conditions = PaymentFailedConditions::new()
1300                 .blamed_scid(phantom_scid)
1301                 .expected_htlc_error_data(0x2000 | 2, &[]);
1302         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1303 }
1304
1305 #[test]
1306 fn test_phantom_failure_too_low_recv_amt() {
1307         let chanmon_cfgs = create_chanmon_cfgs(2);
1308         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1309         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1310         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1311
1312         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1313
1314         // Get the route with a too-low amount.
1315         let recv_amt_msat = 10_000;
1316         let bad_recv_amt_msat = recv_amt_msat - 10;
1317         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1318         let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1319
1320         // Route the HTLC through to the destination.
1321         nodes[0].node.send_payment_with_route(&route, payment_hash,
1322                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1323         check_added_monitors!(nodes[0], 1);
1324         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1325         let mut update_add = update_0.update_add_htlcs[0].clone();
1326
1327         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1328         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1329
1330         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1331         nodes[1].node.process_pending_htlc_forwards();
1332         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1333         nodes[1].node.process_pending_htlc_forwards();
1334         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1335         nodes[1].node.process_pending_htlc_forwards();
1336         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1337         check_added_monitors!(&nodes[1], 1);
1338         assert!(update_1.update_fail_htlcs.len() == 1);
1339         let fail_msg = update_1.update_fail_htlcs[0].clone();
1340         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1341         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1342
1343         // Ensure the payment fails with the expected error.
1344         let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1345         error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1346         let mut fail_conditions = PaymentFailedConditions::new()
1347                 .blamed_scid(phantom_scid)
1348                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1349         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1350 }
1351
1352 #[test]
1353 fn test_phantom_dust_exposure_failure() {
1354         // Set the max dust exposure to the dust limit.
1355         let max_dust_exposure = 546;
1356         let mut receiver_config = UserConfig::default();
1357         receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1358         receiver_config.channel_handshake_config.announced_channel = true;
1359
1360         let chanmon_cfgs = create_chanmon_cfgs(2);
1361         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1362         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1363         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1364
1365         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1366
1367         // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1368         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1369         let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1370
1371         // Route the HTLC through to the destination.
1372         nodes[0].node.send_payment_with_route(&route, payment_hash,
1373                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1374         check_added_monitors!(nodes[0], 1);
1375         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1376         let mut update_add = update_0.update_add_htlcs[0].clone();
1377
1378         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1379         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1380
1381         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1382         assert!(update_1.update_fail_htlcs.len() == 1);
1383         let fail_msg = update_1.update_fail_htlcs[0].clone();
1384         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1385         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1386
1387         // Ensure the payment fails with the expected error.
1388         let mut err_data = Vec::new();
1389         err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1390         err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1391         err_data.extend_from_slice(&channel.1.encode());
1392
1393         let mut fail_conditions = PaymentFailedConditions::new()
1394                 .blamed_scid(channel.0.contents.short_channel_id)
1395                 .blamed_chan_closed(false)
1396                 .expected_htlc_error_data(0x1000 | 7, &err_data);
1397                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1398 }
1399
1400 #[test]
1401 fn test_phantom_failure_reject_payment() {
1402         // Test that the user can successfully fail back a phantom node payment.
1403         let chanmon_cfgs = create_chanmon_cfgs(2);
1404         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1405         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1406         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1407
1408         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1409
1410         // Get the route with a too-low amount.
1411         let recv_amt_msat = 10_000;
1412         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1413         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1414
1415         // Route the HTLC through to the destination.
1416         nodes[0].node.send_payment_with_route(&route, payment_hash,
1417                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1418         check_added_monitors!(nodes[0], 1);
1419         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1420         let mut update_add = update_0.update_add_htlcs[0].clone();
1421
1422         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1423         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1424
1425         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1426         nodes[1].node.process_pending_htlc_forwards();
1427         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1428         nodes[1].node.process_pending_htlc_forwards();
1429         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].last().unwrap().pubkey);
1430         nodes[1].node.fail_htlc_backwards(&payment_hash);
1431         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1432         nodes[1].node.process_pending_htlc_forwards();
1433
1434         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1435         check_added_monitors!(&nodes[1], 1);
1436         assert!(update_1.update_fail_htlcs.len() == 1);
1437         let fail_msg = update_1.update_fail_htlcs[0].clone();
1438         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1439         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1440
1441         // Ensure the payment fails with the expected error.
1442         let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1443         error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1444         let mut fail_conditions = PaymentFailedConditions::new()
1445                 .blamed_scid(phantom_scid)
1446                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1447         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1448 }