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