_ 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 crate::blinded_path::BlindedPath;
  13 use crate::sign::{NodeSigner, Recipient};
  14 use crate::ln::features::InitFeatures;
  15 use crate::ln::msgs::{self, DecodeError, OnionMessageHandler};
  16 use super::{CustomOnionMessageContents, CustomOnionMessageHandler, Destination, OffersMessage, OffersMessageHandler, OnionMessageContents, OnionMessenger, SendError};
  17 use crate::util::ser::{Writeable, Writer};
  18 use crate::util::test_utils;
  19
  20 use bitcoin::network::constants::Network;
  21 use bitcoin::secp256k1::{PublicKey, Secp256k1};
  22
  23 use core::sync::atomic::{AtomicU16, Ordering};
  24 use crate::io;
  25 use crate::io_extras::read_to_end;
  26 use crate::sync::Arc;
  27
  28 struct MessengerNode {
  29         keys_manager: Arc<test_utils::TestKeysInterface>,
  30         messenger: OnionMessenger<Arc<test_utils::TestKeysInterface>, Arc<test_utils::TestKeysInterface>, Arc<test_utils::TestLogger>, Arc<TestOffersMessageHandler>, Arc<TestCustomMessageHandler>>,
  31         custom_message_handler: Arc<TestCustomMessageHandler>,
  32         logger: Arc<test_utils::TestLogger>,
  33 }
  34
  35 impl MessengerNode {
  36         fn get_node_pk(&self) -> PublicKey {
  37                 self.keys_manager.get_node_id(Recipient::Node).unwrap()
  38         }
  39 }
  40
  41 struct TestOffersMessageHandler {}
  42
  43 impl OffersMessageHandler for TestOffersMessageHandler {
  44         fn handle_message(&self, _message: OffersMessage) {
  45                 todo!()
  46         }
  47 }
  48
  49 #[derive(Clone)]
  50 struct TestCustomMessage {}
  51
  52 const CUSTOM_MESSAGE_TYPE: u64 = 4242;
  53 const CUSTOM_MESSAGE_CONTENTS: [u8; 32] = [42; 32];
  54
  55 impl CustomOnionMessageContents for TestCustomMessage {
  56         fn tlv_type(&self) -> u64 {
  57                 CUSTOM_MESSAGE_TYPE
  58         }
  59 }
  60
  61 impl Writeable for TestCustomMessage {
  62         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
  63                 Ok(CUSTOM_MESSAGE_CONTENTS.write(w)?)
  64         }
  65 }
  66
  67 struct TestCustomMessageHandler {
  68         num_messages_expected: AtomicU16,
  69 }
  70
  71 impl TestCustomMessageHandler {
  72         fn new() -> Self {
  73                 Self { num_messages_expected: AtomicU16::new(0) }
  74         }
  75 }
  76
  77 impl Drop for TestCustomMessageHandler {
  78         fn drop(&mut self) {
  79                 #[cfg(feature = "std")] {
  80                         if std::thread::panicking() {
  81                                 return;
  82                         }
  83                 }
  84                 assert_eq!(self.num_messages_expected.load(Ordering::SeqCst), 0);
  85         }
  86 }
  87
  88 impl CustomOnionMessageHandler for TestCustomMessageHandler {
  89         type CustomMessage = TestCustomMessage;
  90         fn handle_custom_message(&self, _msg: Self::CustomMessage) {
  91                 self.num_messages_expected.fetch_sub(1, Ordering::SeqCst);
  92         }
  93         fn read_custom_message<R: io::Read>(&self, message_type: u64, buffer: &mut R) -> Result<Option<Self::CustomMessage>, DecodeError> where Self: Sized {
  94                 if message_type == CUSTOM_MESSAGE_TYPE {
  95                         let buf = read_to_end(buffer)?;
  96                         assert_eq!(buf, CUSTOM_MESSAGE_CONTENTS);
  97                         return Ok(Some(TestCustomMessage {}))
  98                 }
  99                 Ok(None)
 100         }
 101 }
 102
 103 fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
 104         let mut nodes = Vec::new();
 105         for i in 0..num_messengers {
 106                 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
 107                 let seed = [i as u8; 32];
 108                 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet));
 109                 let offers_message_handler = Arc::new(TestOffersMessageHandler {});
 110                 let custom_message_handler = Arc::new(TestCustomMessageHandler::new());
 111                 nodes.push(MessengerNode {
 112                         keys_manager: keys_manager.clone(),
 113                         messenger: OnionMessenger::new(keys_manager.clone(), keys_manager, logger.clone(), offers_message_handler, custom_message_handler.clone()),
 114                         custom_message_handler,
 115                         logger,
 116                 });
 117         }
 118         for idx in 0..num_messengers - 1 {
 119                 let i = idx as usize;
 120                 let mut features = InitFeatures::empty();
 121                 features.set_onion_messages_optional();
 122                 let init_msg = msgs::Init { features, networks: None, remote_network_address: None };
 123                 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone(), true).unwrap();
 124                 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone(), false).unwrap();
 125         }
 126         nodes
 127 }
 128
 129 fn pass_along_path(path: &Vec<MessengerNode>) {
 130         path[path.len() - 1].custom_message_handler.num_messages_expected.fetch_add(1, Ordering::SeqCst);
 131         let mut prev_node = &path[0];
 132         for node in path.into_iter().skip(1) {
 133                 let events = prev_node.messenger.release_pending_msgs();
 134                 let onion_msg =  {
 135                         let msgs = events.get(&node.get_node_pk()).unwrap();
 136                         assert_eq!(msgs.len(), 1);
 137                         msgs[0].clone()
 138                 };
 139                 node.messenger.handle_onion_message(&prev_node.get_node_pk(), &onion_msg);
 140                 prev_node = node;
 141         }
 142 }
 143
 144 #[test]
 145 fn one_hop() {
 146         let nodes = create_nodes(2);
 147         let test_msg = OnionMessageContents::Custom(TestCustomMessage {});
 148
 149         nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_msg, None).unwrap();
 150         pass_along_path(&nodes);
 151 }
 152
 153 #[test]
 154 fn two_unblinded_hops() {
 155         let nodes = create_nodes(3);
 156         let test_msg = OnionMessageContents::Custom(TestCustomMessage {});
 157
 158         nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk()], Destination::Node(nodes[2].get_node_pk()), test_msg, None).unwrap();
 159         pass_along_path(&nodes);
 160 }
 161
 162 #[test]
 163 fn two_unblinded_two_blinded() {
 164         let nodes = create_nodes(5);
 165         let test_msg = OnionMessageContents::Custom(TestCustomMessage {});
 166
 167         let secp_ctx = Secp256k1::new();
 168         let blinded_path = BlindedPath::new_for_message(&[nodes[3].get_node_pk(), nodes[4].get_node_pk()], &*nodes[4].keys_manager, &secp_ctx).unwrap();
 169
 170         nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::BlindedPath(blinded_path), test_msg, None).unwrap();
 171         pass_along_path(&nodes);
 172 }
 173
 174 #[test]
 175 fn three_blinded_hops() {
 176         let nodes = create_nodes(4);
 177         let test_msg = OnionMessageContents::Custom(TestCustomMessage {});
 178
 179         let secp_ctx = Secp256k1::new();
 180         let blinded_path = BlindedPath::new_for_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk(), nodes[3].get_node_pk()], &*nodes[3].keys_manager, &secp_ctx).unwrap();
 181
 182         nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), test_msg, None).unwrap();
 183         pass_along_path(&nodes);
 184 }
 185
 186 #[test]
 187 fn too_big_packet_error() {
 188         // Make sure we error as expected if a packet is too big to send.
 189         let nodes = create_nodes(2);
 190         let test_msg = OnionMessageContents::Custom(TestCustomMessage {});
 191
 192         let hop_node_id = nodes[1].get_node_pk();
 193         let hops = [hop_node_id; 400];
 194         let err = nodes[0].messenger.send_onion_message(&hops, Destination::Node(hop_node_id), test_msg, None).unwrap_err();
 195         assert_eq!(err, SendError::TooBigPacket);
 196 }
 197
 198 #[test]
 199 fn we_are_intro_node() {
 200         // If we are sending straight to a blinded path and we are the introduction node, we need to
 201         // advance the blinded path by 1 hop so the second hop is the new introduction node.
 202         let mut nodes = create_nodes(3);
 203         let test_msg = TestCustomMessage {};
 204
 205         let secp_ctx = Secp256k1::new();
 206         let blinded_path = BlindedPath::new_for_message(&[nodes[0].get_node_pk(), nodes[1].get_node_pk(), nodes[2].get_node_pk()], &*nodes[2].keys_manager, &secp_ctx).unwrap();
 207
 208         nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg.clone()), None).unwrap();
 209         pass_along_path(&nodes);
 210
 211         // Try with a two-hop blinded path where we are the introduction node.
 212         let blinded_path = BlindedPath::new_for_message(&[nodes[0].get_node_pk(), nodes[1].get_node_pk()], &*nodes[1].keys_manager, &secp_ctx).unwrap();
 213         nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg), None).unwrap();
 214         nodes.remove(2);
 215         pass_along_path(&nodes);
 216 }
 217
 218 #[test]
 219 fn invalid_blinded_path_error() {
 220         // Make sure we error as expected if a provided blinded path has 0 or 1 hops.
 221         let nodes = create_nodes(3);
 222         let test_msg = TestCustomMessage {};
 223
 224         // 0 hops
 225         let secp_ctx = Secp256k1::new();
 226         let mut blinded_path = BlindedPath::new_for_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], &*nodes[2].keys_manager, &secp_ctx).unwrap();
 227         blinded_path.blinded_hops.clear();
 228         let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg.clone()), None).unwrap_err();
 229         assert_eq!(err, SendError::TooFewBlindedHops);
 230
 231         // 1 hop
 232         let mut blinded_path = BlindedPath::new_for_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], &*nodes[2].keys_manager, &secp_ctx).unwrap();
 233         blinded_path.blinded_hops.remove(0);
 234         assert_eq!(blinded_path.blinded_hops.len(), 1);
 235         let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg), None).unwrap_err();
 236         assert_eq!(err, SendError::TooFewBlindedHops);
 237 }
 238
 239 #[test]
 240 fn reply_path() {
 241         let nodes = create_nodes(4);
 242         let test_msg = TestCustomMessage {};
 243         let secp_ctx = Secp256k1::new();
 244
 245         // Destination::Node
 246         let reply_path = BlindedPath::new_for_message(&[nodes[2].get_node_pk(), nodes[1].get_node_pk(), nodes[0].get_node_pk()], &*nodes[0].keys_manager, &secp_ctx).unwrap();
 247         nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::Node(nodes[3].get_node_pk()), OnionMessageContents::Custom(test_msg.clone()), Some(reply_path)).unwrap();
 248         pass_along_path(&nodes);
 249         // Make sure the last node successfully decoded the reply path.
 250         nodes[3].logger.assert_log_contains(
 251                 "lightning::onion_message::messenger",
 252                 &format!("Received an onion message with path_id None and a reply_path"), 1);
 253
 254         // Destination::BlindedPath
 255         let blinded_path = BlindedPath::new_for_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk(), nodes[3].get_node_pk()], &*nodes[3].keys_manager, &secp_ctx).unwrap();
 256         let reply_path = BlindedPath::new_for_message(&[nodes[2].get_node_pk(), nodes[1].get_node_pk(), nodes[0].get_node_pk()], &*nodes[0].keys_manager, &secp_ctx).unwrap();
 257
 258         nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg), Some(reply_path)).unwrap();
 259         pass_along_path(&nodes);
 260         nodes[3].logger.assert_log_contains(
 261                 "lightning::onion_message::messenger",
 262                 &format!("Received an onion message with path_id None and a reply_path"), 2);
 263 }
 264
 265 #[test]
 266 fn invalid_custom_message_type() {
 267         let nodes = create_nodes(2);
 268
 269         struct InvalidCustomMessage{}
 270         impl CustomOnionMessageContents for InvalidCustomMessage {
 271                 fn tlv_type(&self) -> u64 {
 272                         // Onion message contents must have a TLV >= 64.
 273                         63
 274                 }
 275         }
 276
 277         impl Writeable for InvalidCustomMessage {
 278                 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), io::Error> { unreachable!() }
 279         }
 280
 281         let test_msg = OnionMessageContents::Custom(InvalidCustomMessage {});
 282         let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_msg, None).unwrap_err();
 283         assert_eq!(err, SendError::InvalidMessage);
 284 }
 285
 286 #[test]
 287 fn peer_buffer_full() {
 288         let nodes = create_nodes(2);
 289         let test_msg = TestCustomMessage {};
 290         for _ in 0..188 { // Based on MAX_PER_PEER_BUFFER_SIZE in OnionMessenger
 291                 nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), OnionMessageContents::Custom(test_msg.clone()), None).unwrap();
 292         }
 293         let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), OnionMessageContents::Custom(test_msg), None).unwrap_err();
 294         assert_eq!(err, SendError::BufferFull);
 295 }
 296
 297 #[test]
 298 fn many_hops() {
 299         // Check we can send over a route with many hops. This will exercise our logic for onion messages
 300         // of size [`crate::onion_message::packet::BIG_PACKET_HOP_DATA_LEN`].
 301         let num_nodes: usize = 25;
 302         let nodes = create_nodes(num_nodes as u8);
 303         let test_msg = OnionMessageContents::Custom(TestCustomMessage {});
 304
 305         let mut intermediates = vec![];
 306         for i in 1..(num_nodes-1) {
 307                 intermediates.push(nodes[i].get_node_pk());
 308         }
 309
 310         nodes[0].messenger.send_onion_message(&intermediates, Destination::Node(nodes[num_nodes-1].get_node_pk()), test_msg, None).unwrap();
 311         pass_along_path(&nodes);
 312 }