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