git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/blinded_payment_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 use bitcoin::secp256k1::{Secp256k1, SecretKey};
  11 use crate::blinded_path::BlindedPath;
  12 use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, PaymentConstraints, PaymentRelay, ReceiveTlvs};
  13 use crate::events::MessageSendEventsProvider;
  14 use crate::ln::channelmanager;
  15 use crate::ln::channelmanager::{PaymentId, RecipientOnionFields};
  16 use crate::ln::features::BlindedHopFeatures;
  17 use crate::ln::functional_test_utils::*;
  18 use crate::ln::msgs::ChannelMessageHandler;
  19 use crate::ln::onion_utils;
  20 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
  21 use crate::ln::outbound_payment::Retry;
  22 use crate::prelude::*;
  23 use crate::routing::router::{PaymentParameters, RouteParameters};
  24 use crate::util::config::UserConfig;
  25
  26 #[test]
  27 fn one_hop_blinded_path() {
  28         do_one_hop_blinded_path(true);
  29         do_one_hop_blinded_path(false);
  30 }
  31
  32 fn do_one_hop_blinded_path(success: bool) {
  33         let chanmon_cfgs = create_chanmon_cfgs(2);
  34         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  35         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  36         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  37         let chan_upd = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0).0.contents;
  38
  39         let amt_msat = 5000;
  40         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(amt_msat), None);
  41         let payee_tlvs = ReceiveTlvs {
  42                 payment_secret,
  43                 payment_constraints: PaymentConstraints {
  44                         max_cltv_expiry: u32::max_value(),
  45                         htlc_minimum_msat: chan_upd.htlc_minimum_msat,
  46                 },
  47         };
  48         let mut secp_ctx = Secp256k1::new();
  49         let blinded_path = BlindedPath::one_hop_for_payment(
  50                 nodes[1].node.get_our_node_id(), payee_tlvs, &chanmon_cfgs[1].keys_manager, &secp_ctx
  51         ).unwrap();
  52
  53         let route_params = RouteParameters::from_payment_params_and_value(
  54                 PaymentParameters::blinded(vec![blinded_path]),
  55                 amt_msat,
  56         );
  57         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
  58         PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
  59         check_added_monitors(&nodes[0], 1);
  60         pass_along_route(&nodes[0], &[&[&nodes[1]]], amt_msat, payment_hash, payment_secret);
  61         if success {
  62                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
  63         } else {
  64                 fail_payment(&nodes[0], &[&nodes[1]], payment_hash);
  65         }
  66 }
  67
  68 #[test]
  69 fn mpp_to_one_hop_blinded_path() {
  70         let chanmon_cfgs = create_chanmon_cfgs(4);
  71         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
  72         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
  73         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
  74         let mut secp_ctx = Secp256k1::new();
  75
  76         create_announced_chan_between_nodes(&nodes, 0, 1);
  77         create_announced_chan_between_nodes(&nodes, 0, 2);
  78         let chan_upd_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents;
  79         create_announced_chan_between_nodes(&nodes, 2, 3).0.contents;
  80
  81         let amt_msat = 15_000_000;
  82         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
  83         let payee_tlvs = ReceiveTlvs {
  84                 payment_secret,
  85                 payment_constraints: PaymentConstraints {
  86                         max_cltv_expiry: u32::max_value(),
  87                         htlc_minimum_msat: chan_upd_1_3.htlc_minimum_msat,
  88                 },
  89         };
  90         let blinded_path = BlindedPath::one_hop_for_payment(
  91                 nodes[3].node.get_our_node_id(), payee_tlvs, &chanmon_cfgs[3].keys_manager, &secp_ctx
  92         ).unwrap();
  93
  94         let bolt12_features =
  95                 channelmanager::provided_bolt12_invoice_features(&UserConfig::default());
  96         let route_params = RouteParameters::from_payment_params_and_value(
  97                 PaymentParameters::blinded(vec![blinded_path]).with_bolt12_features(bolt12_features).unwrap(),
  98                 amt_msat,
  99         );
 100         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 101         check_added_monitors(&nodes[0], 2);
 102
 103         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
 104         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 105         assert_eq!(events.len(), 2);
 106
 107         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 108         pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
 109                 Some(payment_secret), ev.clone(), false, None);
 110
 111         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 112         pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
 113                 Some(payment_secret), ev.clone(), true, None);
 114         claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
 115 }
 116
 117 enum ForwardCheckFail {
 118         // Fail a check on the inbound onion payload. In this case, we underflow when calculating the
 119         // outgoing cltv_expiry.
 120         InboundOnionCheck,
 121         // The forwarding node's payload is encoded as a receive, i.e. the next hop HMAC is [0; 32].
 122         ForwardPayloadEncodedAsReceive,
 123         // Fail a check on the outbound channel. In this case, our next-hop peer is offline.
 124         OutboundChannelCheck,
 125 }
 126
 127 #[test]
 128 fn forward_checks_failure() {
 129         do_forward_checks_failure(ForwardCheckFail::InboundOnionCheck);
 130         do_forward_checks_failure(ForwardCheckFail::ForwardPayloadEncodedAsReceive);
 131         do_forward_checks_failure(ForwardCheckFail::OutboundChannelCheck);
 132 }
 133
 134 fn do_forward_checks_failure(check: ForwardCheckFail) {
 135         // Ensure we'll fail backwards properly if a forwarding check fails on initial update_add
 136         // receipt.
 137         let chanmon_cfgs = create_chanmon_cfgs(3);
 138         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 139         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 140         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 141         // We need the session priv to construct a bogus onion packet later.
 142         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
 143         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 144         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 145
 146         let amt_msat = 5000;
 147         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 148         let intermediate_nodes = vec![ForwardNode {
 149                 node_id: nodes[1].node.get_our_node_id(),
 150                 tlvs: ForwardTlvs {
 151                         short_channel_id: chan_upd_1_2.short_channel_id,
 152                         payment_relay: PaymentRelay {
 153                                 cltv_expiry_delta: chan_upd_1_2.cltv_expiry_delta,
 154                                 fee_proportional_millionths: chan_upd_1_2.fee_proportional_millionths,
 155                                 fee_base_msat: chan_upd_1_2.fee_base_msat,
 156                         },
 157                         payment_constraints: PaymentConstraints {
 158                                 max_cltv_expiry: u32::max_value(),
 159                                 htlc_minimum_msat: chan_upd_1_2.htlc_minimum_msat,
 160                         },
 161                         features: BlindedHopFeatures::empty(),
 162                 },
 163                 htlc_maximum_msat: chan_upd_1_2.htlc_maximum_msat,
 164         }];
 165         let payee_tlvs = ReceiveTlvs {
 166                 payment_secret,
 167                 payment_constraints: PaymentConstraints {
 168                         max_cltv_expiry: u32::max_value(),
 169                         htlc_minimum_msat: chan_upd_1_2.htlc_minimum_msat,
 170                 },
 171         };
 172         let mut secp_ctx = Secp256k1::new();
 173         let blinded_path = BlindedPath::new_for_payment(
 174                 &intermediate_nodes[..], nodes[2].node.get_our_node_id(), payee_tlvs,
 175                 chan_upd_1_2.htlc_maximum_msat, &chanmon_cfgs[2].keys_manager, &secp_ctx
 176         ).unwrap();
 177
 178         let route_params = RouteParameters::from_payment_params_and_value(
 179                 PaymentParameters::blinded(vec![blinded_path]), amt_msat);
 180         let route = get_route(&nodes[0], &route_params).unwrap();
 181         node_cfgs[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
 182         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 183         check_added_monitors(&nodes[0], 1);
 184
 185         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 186         assert_eq!(events.len(), 1);
 187         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 188         let mut payment_event = SendEvent::from_event(ev);
 189
 190         let mut update_add = &mut payment_event.msgs[0];
 191         match check {
 192                 ForwardCheckFail::InboundOnionCheck => {
 193                         update_add.cltv_expiry = 10; // causes outbound CLTV expiry to underflow
 194                 },
 195                 ForwardCheckFail::ForwardPayloadEncodedAsReceive => {
 196                         let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 197                         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 198                         let cur_height = nodes[0].best_block_info().1;
 199                         let (mut onion_payloads, ..) = onion_utils::build_onion_payloads(
 200                                 &route.paths[0], amt_msat, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
 201                         // Remove the receive payload so the blinded forward payload is encoded as a final payload
 202                         // (i.e. next_hop_hmac == [0; 32])
 203                         onion_payloads.pop();
 204                         update_add.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
 205                 },
 206                 ForwardCheckFail::OutboundChannelCheck => {
 207                         // The intro node will see that the next-hop peer is disconnected and fail the HTLC backwards.
 208                         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
 209                 },
 210         }
 211         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 212         check_added_monitors!(nodes[1], 0);
 213         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, true, true);
 214
 215         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 216         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 217         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 218         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 219                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 220 }