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