_ Git - rust-lightning/blob - lightning/src/onion_message/functional_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 //! Onion message testing and test utilities live here.
  11
  12 use chain::keysinterface::{KeysInterface, Recipient};
  13 use ln::features::InitFeatures;
  14 use ln::msgs::{self, OnionMessageHandler};
  15 use super::blinded_route::BlindedRoute;
  16 use super::messenger::{Destination, OnionMessenger, SendError};
  17 use util::enforcing_trait_impls::EnforcingSigner;
  18 use util::test_utils;
  19
  20 use bitcoin::network::constants::Network;
  21 use bitcoin::secp256k1::{PublicKey, Secp256k1};
  22
  23 use sync::Arc;
  24
  25 struct MessengerNode {
  26         keys_manager: Arc<test_utils::TestKeysInterface>,
  27         messenger: OnionMessenger<EnforcingSigner, Arc<test_utils::TestKeysInterface>, Arc<test_utils::TestLogger>>,
  28         logger: Arc<test_utils::TestLogger>,
  29 }
  30
  31 impl MessengerNode {
  32         fn get_node_pk(&self) -> PublicKey {
  33                 let secp_ctx = Secp256k1::new();
  34                 PublicKey::from_secret_key(&secp_ctx, &self.keys_manager.get_node_secret(Recipient::Node).unwrap())
  35         }
  36 }
  37
  38 fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
  39         let mut nodes = Vec::new();
  40         for i in 0..num_messengers {
  41                 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
  42                 let seed = [i as u8; 32];
  43                 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet));
  44                 nodes.push(MessengerNode {
  45                         keys_manager: keys_manager.clone(),
  46                         messenger: OnionMessenger::new(keys_manager, logger.clone()),
  47                         logger,
  48                 });
  49         }
  50         for idx in 0..num_messengers - 1 {
  51                 let i = idx as usize;
  52                 let mut features = InitFeatures::known();
  53                 features.set_onion_messages_optional();
  54                 let init_msg = msgs::Init { features, remote_network_address: None };
  55                 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
  56                 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
  57         }
  58         nodes
  59 }
  60
  61 fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
  62         let mut prev_node = &path[0];
  63         let num_nodes = path.len();
  64         for (idx, node) in path.into_iter().skip(1).enumerate() {
  65                 let events = prev_node.messenger.release_pending_msgs();
  66                 let onion_msg =  {
  67                         let msgs = events.get(&node.get_node_pk()).unwrap();
  68                         assert_eq!(msgs.len(), 1);
  69                         msgs[0].clone()
  70                 };
  71                 node.messenger.handle_onion_message(&prev_node.get_node_pk(), &onion_msg);
  72                 if idx == num_nodes - 1 {
  73                         node.logger.assert_log_contains(
  74                                 "lightning::onion_message::messenger".to_string(),
  75                                 format!("Received an onion message with path_id: {:02x?}", expected_path_id).to_string(), 1);
  76                 }
  77                 prev_node = node;
  78         }
  79 }
  80
  81 #[test]
  82 fn one_hop() {
  83         let nodes = create_nodes(2);
  84
  85         nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap();
  86         pass_along_path(&nodes, None);
  87 }
  88
  89 #[test]
  90 fn two_unblinded_hops() {
  91         let nodes = create_nodes(3);
  92
  93         nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk()], Destination::Node(nodes[2].get_node_pk()), None).unwrap();
  94         pass_along_path(&nodes, None);
  95 }
  96
  97 #[test]
  98 fn two_unblinded_two_blinded() {
  99         let nodes = create_nodes(5);
 100
 101         let secp_ctx = Secp256k1::new();
 102         let blinded_route = BlindedRoute::new(&[nodes[3].get_node_pk(), nodes[4].get_node_pk()], &*nodes[4].keys_manager, &secp_ctx).unwrap();
 103
 104         nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::BlindedRoute(blinded_route), None).unwrap();
 105         pass_along_path(&nodes, None);
 106 }
 107
 108 #[test]
 109 fn three_blinded_hops() {
 110         let nodes = create_nodes(4);
 111
 112         let secp_ctx = Secp256k1::new();
 113         let blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk(), nodes[3].get_node_pk()], &*nodes[3].keys_manager, &secp_ctx).unwrap();
 114
 115         nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), None).unwrap();
 116         pass_along_path(&nodes, None);
 117 }
 118
 119 #[test]
 120 fn too_big_packet_error() {
 121         // Make sure we error as expected if a packet is too big to send.
 122         let nodes = create_nodes(2);
 123
 124         let hop_node_id = nodes[1].get_node_pk();
 125         let hops = [hop_node_id; 400];
 126         let err = nodes[0].messenger.send_onion_message(&hops, Destination::Node(hop_node_id), None).unwrap_err();
 127         assert_eq!(err, SendError::TooBigPacket);
 128 }
 129
 130 #[test]
 131 fn invalid_blinded_route_error() {
 132         // Make sure we error as expected if a provided blinded route has 0 or 1 hops.
 133         let nodes = create_nodes(3);
 134
 135         // 0 hops
 136         let secp_ctx = Secp256k1::new();
 137         let mut blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], &*nodes[2].keys_manager, &secp_ctx).unwrap();
 138         blinded_route.blinded_hops.clear();
 139         let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), None).unwrap_err();
 140         assert_eq!(err, SendError::TooFewBlindedHops);
 141
 142         // 1 hop
 143         let mut blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], &*nodes[2].keys_manager, &secp_ctx).unwrap();
 144         blinded_route.blinded_hops.remove(0);
 145         assert_eq!(blinded_route.blinded_hops.len(), 1);
 146         let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), None).unwrap_err();
 147         assert_eq!(err, SendError::TooFewBlindedHops);
 148 }
 149
 150 #[test]
 151 fn reply_path() {
 152         let nodes = create_nodes(4);
 153         let secp_ctx = Secp256k1::new();
 154
 155         // Destination::Node
 156         let reply_path = BlindedRoute::new(&[nodes[2].get_node_pk(), nodes[1].get_node_pk(), nodes[0].get_node_pk()], &*nodes[0].keys_manager, &secp_ctx).unwrap();
 157         nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::Node(nodes[3].get_node_pk()), Some(reply_path)).unwrap();
 158         pass_along_path(&nodes, None);
 159         // Make sure the last node successfully decoded the reply path.
 160         nodes[3].logger.assert_log_contains(
 161                 "lightning::onion_message::messenger".to_string(),
 162                 format!("Received an onion message with path_id: None and reply_path").to_string(), 1);
 163
 164         // Destination::BlindedRoute
 165         let blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk(), nodes[3].get_node_pk()], &*nodes[3].keys_manager, &secp_ctx).unwrap();
 166         let reply_path = BlindedRoute::new(&[nodes[2].get_node_pk(), nodes[1].get_node_pk(), nodes[0].get_node_pk()], &*nodes[0].keys_manager, &secp_ctx).unwrap();
 167
 168         nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), Some(reply_path)).unwrap();
 169         pass_along_path(&nodes, None);
 170         nodes[3].logger.assert_log_contains(
 171                 "lightning::onion_message::messenger".to_string(),
 172                 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
 173 }
 174
 175 #[test]
 176 fn peer_buffer_full() {
 177         let nodes = create_nodes(2);
 178         for _ in 0..188 { // Based on MAX_PER_PEER_BUFFER_SIZE in OnionMessenger
 179                 nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap();
 180         }
 181         let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
 182         assert_eq!(err, SendError::BufferFull);
 183 }