X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fonion_message%2Ffunctional_tests.rs;h=d1b01b71eef0e041ef37007712bfd0eecd014ee9;hb=e404c129a5914531861608f1d266a4f0b6e48d97;hp=96e0c44b2ce8f31f77d1c5fcd936998b229be1eb;hpb=7a78998552b1d3c2d97f337a7d5aaf7fe1aa70b4;p=rust-lightning diff --git a/lightning/src/onion_message/functional_tests.rs b/lightning/src/onion_message/functional_tests.rs index 96e0c44b..d1b01b71 100644 --- a/lightning/src/onion_message/functional_tests.rs +++ b/lightning/src/onion_message/functional_tests.rs @@ -13,23 +13,30 @@ use crate::blinded_path::BlindedPath; use crate::sign::{NodeSigner, Recipient}; use crate::ln::features::InitFeatures; use crate::ln::msgs::{self, DecodeError, OnionMessageHandler}; -use super::{CustomOnionMessageContents, CustomOnionMessageHandler, Destination, OnionMessageContents, OnionMessenger, SendError}; +use super::{CustomOnionMessageContents, CustomOnionMessageHandler, Destination, MessageRouter, OffersMessage, OffersMessageHandler, OnionMessageContents, OnionMessagePath, OnionMessenger, SendError}; use crate::util::ser::{Writeable, Writer}; use crate::util::test_utils; use bitcoin::network::constants::Network; use bitcoin::secp256k1::{PublicKey, Secp256k1}; -use core::sync::atomic::{AtomicU16, Ordering}; use crate::io; use crate::io_extras::read_to_end; -use crate::sync::Arc; +use crate::sync::{Arc, Mutex}; + +use crate::prelude::*; struct MessengerNode { keys_manager: Arc, - messenger: OnionMessenger, Arc, Arc, Arc>, + messenger: OnionMessenger< + Arc, + Arc, + Arc, + Arc, + Arc, + Arc + >, custom_message_handler: Arc, - logger: Arc, } impl MessengerNode { @@ -38,31 +45,67 @@ impl MessengerNode { } } -#[derive(Clone)] -struct TestCustomMessage {} +struct TestMessageRouter {} + +impl MessageRouter for TestMessageRouter { + fn find_path( + &self, _sender: PublicKey, _peers: Vec, destination: Destination + ) -> Result { + Ok(OnionMessagePath { + intermediate_nodes: vec![], + destination, + }) + } +} + +struct TestOffersMessageHandler {} + +impl OffersMessageHandler for TestOffersMessageHandler { + fn handle_message(&self, _message: OffersMessage) -> Option { + None + } +} + +#[derive(Clone, Debug, PartialEq)] +enum TestCustomMessage { + Request, + Response, +} -const CUSTOM_MESSAGE_TYPE: u64 = 4242; -const CUSTOM_MESSAGE_CONTENTS: [u8; 32] = [42; 32]; +const CUSTOM_REQUEST_MESSAGE_TYPE: u64 = 4242; +const CUSTOM_RESPONSE_MESSAGE_TYPE: u64 = 4343; +const CUSTOM_REQUEST_MESSAGE_CONTENTS: [u8; 32] = [42; 32]; +const CUSTOM_RESPONSE_MESSAGE_CONTENTS: [u8; 32] = [43; 32]; impl CustomOnionMessageContents for TestCustomMessage { fn tlv_type(&self) -> u64 { - CUSTOM_MESSAGE_TYPE + match self { + TestCustomMessage::Request => CUSTOM_REQUEST_MESSAGE_TYPE, + TestCustomMessage::Response => CUSTOM_RESPONSE_MESSAGE_TYPE, + } } } impl Writeable for TestCustomMessage { fn write(&self, w: &mut W) -> Result<(), io::Error> { - Ok(CUSTOM_MESSAGE_CONTENTS.write(w)?) + match self { + TestCustomMessage::Request => Ok(CUSTOM_REQUEST_MESSAGE_CONTENTS.write(w)?), + TestCustomMessage::Response => Ok(CUSTOM_RESPONSE_MESSAGE_CONTENTS.write(w)?), + } } } struct TestCustomMessageHandler { - num_messages_expected: AtomicU16, + expected_messages: Mutex>, } impl TestCustomMessageHandler { fn new() -> Self { - Self { num_messages_expected: AtomicU16::new(0) } + Self { expected_messages: Mutex::new(VecDeque::new()) } + } + + fn expect_message(&self, message: TestCustomMessage) { + self.expected_messages.lock().unwrap().push_back(message); } } @@ -73,22 +116,37 @@ impl Drop for TestCustomMessageHandler { return; } } - assert_eq!(self.num_messages_expected.load(Ordering::SeqCst), 0); + assert!(self.expected_messages.lock().unwrap().is_empty()); } } impl CustomOnionMessageHandler for TestCustomMessageHandler { type CustomMessage = TestCustomMessage; - fn handle_custom_message(&self, _msg: Self::CustomMessage) { - self.num_messages_expected.fetch_sub(1, Ordering::SeqCst); + fn handle_custom_message(&self, msg: Self::CustomMessage) -> Option { + match self.expected_messages.lock().unwrap().pop_front() { + Some(expected_msg) => assert_eq!(expected_msg, msg), + None => panic!("Unexpected message: {:?}", msg), + } + + match msg { + TestCustomMessage::Request => Some(TestCustomMessage::Response), + TestCustomMessage::Response => None, + } } fn read_custom_message(&self, message_type: u64, buffer: &mut R) -> Result, DecodeError> where Self: Sized { - if message_type == CUSTOM_MESSAGE_TYPE { - let buf = read_to_end(buffer)?; - assert_eq!(buf, CUSTOM_MESSAGE_CONTENTS); - return Ok(Some(TestCustomMessage {})) + match message_type { + CUSTOM_REQUEST_MESSAGE_TYPE => { + let buf = read_to_end(buffer)?; + assert_eq!(buf, CUSTOM_REQUEST_MESSAGE_CONTENTS); + Ok(Some(TestCustomMessage::Request)) + }, + CUSTOM_RESPONSE_MESSAGE_TYPE => { + let buf = read_to_end(buffer)?; + assert_eq!(buf, CUSTOM_RESPONSE_MESSAGE_CONTENTS); + Ok(Some(TestCustomMessage::Response)) + }, + _ => Ok(None), } - Ok(None) } } @@ -98,12 +156,16 @@ fn create_nodes(num_messengers: u8) -> Vec { let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i))); let seed = [i as u8; 32]; let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet)); + let message_router = Arc::new(TestMessageRouter {}); + let offers_message_handler = Arc::new(TestOffersMessageHandler {}); let custom_message_handler = Arc::new(TestCustomMessageHandler::new()); nodes.push(MessengerNode { keys_manager: keys_manager.clone(), - messenger: OnionMessenger::new(keys_manager.clone(), keys_manager.clone(), logger.clone(), custom_message_handler.clone()), + messenger: OnionMessenger::new( + keys_manager.clone(), keys_manager, logger.clone(), message_router, + offers_message_handler, custom_message_handler.clone() + ), custom_message_handler, - logger, }); } for idx in 0..num_messengers - 1 { @@ -118,7 +180,6 @@ fn create_nodes(num_messengers: u8) -> Vec { } fn pass_along_path(path: &Vec) { - path[path.len() - 1].custom_message_handler.num_messages_expected.fetch_add(1, Ordering::SeqCst); let mut prev_node = &path[0]; for node in path.into_iter().skip(1) { let events = prev_node.messenger.release_pending_msgs(); @@ -135,42 +196,62 @@ fn pass_along_path(path: &Vec) { #[test] fn one_hop() { let nodes = create_nodes(2); - let test_msg = OnionMessageContents::Custom(TestCustomMessage {}); - - nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_msg, None).unwrap(); + let test_msg = OnionMessageContents::Custom(TestCustomMessage::Response); + + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::Node(nodes[1].get_node_pk()), + }; + nodes[0].messenger.send_onion_message(path, test_msg, None).unwrap(); + nodes[1].custom_message_handler.expect_message(TestCustomMessage::Response); pass_along_path(&nodes); } #[test] fn two_unblinded_hops() { let nodes = create_nodes(3); - let test_msg = OnionMessageContents::Custom(TestCustomMessage {}); - - nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk()], Destination::Node(nodes[2].get_node_pk()), test_msg, None).unwrap(); + let test_msg = OnionMessageContents::Custom(TestCustomMessage::Response); + + let path = OnionMessagePath { + intermediate_nodes: vec![nodes[1].get_node_pk()], + destination: Destination::Node(nodes[2].get_node_pk()), + }; + nodes[0].messenger.send_onion_message(path, test_msg, None).unwrap(); + nodes[2].custom_message_handler.expect_message(TestCustomMessage::Response); pass_along_path(&nodes); } #[test] fn two_unblinded_two_blinded() { let nodes = create_nodes(5); - let test_msg = OnionMessageContents::Custom(TestCustomMessage {}); + let test_msg = OnionMessageContents::Custom(TestCustomMessage::Response); let secp_ctx = Secp256k1::new(); let blinded_path = BlindedPath::new_for_message(&[nodes[3].get_node_pk(), nodes[4].get_node_pk()], &*nodes[4].keys_manager, &secp_ctx).unwrap(); + let path = OnionMessagePath { + intermediate_nodes: vec![nodes[1].get_node_pk(), nodes[2].get_node_pk()], + destination: Destination::BlindedPath(blinded_path), + }; - nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::BlindedPath(blinded_path), test_msg, None).unwrap(); + nodes[0].messenger.send_onion_message(path, test_msg, None).unwrap(); + nodes[4].custom_message_handler.expect_message(TestCustomMessage::Response); pass_along_path(&nodes); } #[test] fn three_blinded_hops() { let nodes = create_nodes(4); - let test_msg = OnionMessageContents::Custom(TestCustomMessage {}); + let test_msg = OnionMessageContents::Custom(TestCustomMessage::Response); let secp_ctx = Secp256k1::new(); 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(); + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::BlindedPath(blinded_path), + }; - nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), test_msg, None).unwrap(); + nodes[0].messenger.send_onion_message(path, test_msg, None).unwrap(); + nodes[3].custom_message_handler.expect_message(TestCustomMessage::Response); pass_along_path(&nodes); } @@ -178,11 +259,15 @@ fn three_blinded_hops() { fn too_big_packet_error() { // Make sure we error as expected if a packet is too big to send. let nodes = create_nodes(2); - let test_msg = OnionMessageContents::Custom(TestCustomMessage {}); + let test_msg = OnionMessageContents::Custom(TestCustomMessage::Response); let hop_node_id = nodes[1].get_node_pk(); - let hops = [hop_node_id; 400]; - let err = nodes[0].messenger.send_onion_message(&hops, Destination::Node(hop_node_id), test_msg, None).unwrap_err(); + let hops = vec![hop_node_id; 400]; + let path = OnionMessagePath { + intermediate_nodes: hops, + destination: Destination::Node(hop_node_id), + }; + let err = nodes[0].messenger.send_onion_message(path, test_msg, None).unwrap_err(); assert_eq!(err, SendError::TooBigPacket); } @@ -191,17 +276,27 @@ fn we_are_intro_node() { // If we are sending straight to a blinded path and we are the introduction node, we need to // advance the blinded path by 1 hop so the second hop is the new introduction node. let mut nodes = create_nodes(3); - let test_msg = TestCustomMessage {}; + let test_msg = TestCustomMessage::Response; let secp_ctx = Secp256k1::new(); 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(); + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::BlindedPath(blinded_path), + }; - nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg.clone()), None).unwrap(); + nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg.clone()), None).unwrap(); + nodes[2].custom_message_handler.expect_message(TestCustomMessage::Response); pass_along_path(&nodes); // Try with a two-hop blinded path where we are the introduction node. let blinded_path = BlindedPath::new_for_message(&[nodes[0].get_node_pk(), nodes[1].get_node_pk()], &*nodes[1].keys_manager, &secp_ctx).unwrap(); - nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg), None).unwrap(); + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::BlindedPath(blinded_path), + }; + nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg), None).unwrap(); + nodes[1].custom_message_handler.expect_message(TestCustomMessage::Response); nodes.remove(2); pass_along_path(&nodes); } @@ -210,47 +305,67 @@ fn we_are_intro_node() { fn invalid_blinded_path_error() { // Make sure we error as expected if a provided blinded path has 0 or 1 hops. let nodes = create_nodes(3); - let test_msg = TestCustomMessage {}; + let test_msg = TestCustomMessage::Response; // 0 hops let secp_ctx = Secp256k1::new(); 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(); blinded_path.blinded_hops.clear(); - let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg.clone()), None).unwrap_err(); + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::BlindedPath(blinded_path), + }; + let err = nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg.clone()), None).unwrap_err(); assert_eq!(err, SendError::TooFewBlindedHops); // 1 hop 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(); blinded_path.blinded_hops.remove(0); assert_eq!(blinded_path.blinded_hops.len(), 1); - let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg), None).unwrap_err(); + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::BlindedPath(blinded_path), + }; + let err = nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg), None).unwrap_err(); assert_eq!(err, SendError::TooFewBlindedHops); } #[test] fn reply_path() { - let nodes = create_nodes(4); - let test_msg = TestCustomMessage {}; + let mut nodes = create_nodes(4); + let test_msg = TestCustomMessage::Request; let secp_ctx = Secp256k1::new(); // Destination::Node + let path = OnionMessagePath { + intermediate_nodes: vec![nodes[1].get_node_pk(), nodes[2].get_node_pk()], + destination: Destination::Node(nodes[3].get_node_pk()), + }; 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(); - 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(); + nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg.clone()), Some(reply_path)).unwrap(); + nodes[3].custom_message_handler.expect_message(TestCustomMessage::Request); pass_along_path(&nodes); // Make sure the last node successfully decoded the reply path. - nodes[3].logger.assert_log_contains( - "lightning::onion_message::messenger", - &format!("Received an onion message with path_id None and a reply_path"), 1); + nodes[0].custom_message_handler.expect_message(TestCustomMessage::Response); + nodes.reverse(); + pass_along_path(&nodes); // Destination::BlindedPath 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(); + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::BlindedPath(blinded_path), + }; 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(); - nodes[0].messenger.send_onion_message(&[], Destination::BlindedPath(blinded_path), OnionMessageContents::Custom(test_msg), Some(reply_path)).unwrap(); + nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg), Some(reply_path)).unwrap(); + nodes[3].custom_message_handler.expect_message(TestCustomMessage::Request); + pass_along_path(&nodes); + + // Make sure the last node successfully decoded the reply path. + nodes[0].custom_message_handler.expect_message(TestCustomMessage::Response); + nodes.reverse(); pass_along_path(&nodes); - nodes[3].logger.assert_log_contains( - "lightning::onion_message::messenger", - &format!("Received an onion message with path_id None and a reply_path"), 2); } #[test] @@ -270,18 +385,26 @@ fn invalid_custom_message_type() { } let test_msg = OnionMessageContents::Custom(InvalidCustomMessage {}); - let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_msg, None).unwrap_err(); + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::Node(nodes[1].get_node_pk()), + }; + let err = nodes[0].messenger.send_onion_message(path, test_msg, None).unwrap_err(); assert_eq!(err, SendError::InvalidMessage); } #[test] fn peer_buffer_full() { let nodes = create_nodes(2); - let test_msg = TestCustomMessage {}; + let test_msg = TestCustomMessage::Request; + let path = OnionMessagePath { + intermediate_nodes: vec![], + destination: Destination::Node(nodes[1].get_node_pk()), + }; for _ in 0..188 { // Based on MAX_PER_PEER_BUFFER_SIZE in OnionMessenger - nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), OnionMessageContents::Custom(test_msg.clone()), None).unwrap(); + nodes[0].messenger.send_onion_message(path.clone(), OnionMessageContents::Custom(test_msg.clone()), None).unwrap(); } - let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), OnionMessageContents::Custom(test_msg), None).unwrap_err(); + let err = nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg), None).unwrap_err(); assert_eq!(err, SendError::BufferFull); } @@ -291,13 +414,18 @@ fn many_hops() { // of size [`crate::onion_message::packet::BIG_PACKET_HOP_DATA_LEN`]. let num_nodes: usize = 25; let nodes = create_nodes(num_nodes as u8); - let test_msg = OnionMessageContents::Custom(TestCustomMessage {}); + let test_msg = TestCustomMessage::Response; - let mut intermediates = vec![]; + let mut intermediate_nodes = vec![]; for i in 1..(num_nodes-1) { - intermediates.push(nodes[i].get_node_pk()); + intermediate_nodes.push(nodes[i].get_node_pk()); } - nodes[0].messenger.send_onion_message(&intermediates, Destination::Node(nodes[num_nodes-1].get_node_pk()), test_msg, None).unwrap(); + let path = OnionMessagePath { + intermediate_nodes, + destination: Destination::Node(nodes[num_nodes-1].get_node_pk()), + }; + nodes[0].messenger.send_onion_message(path, OnionMessageContents::Custom(test_msg), None).unwrap(); + nodes[num_nodes-1].custom_message_handler.expect_message(TestCustomMessage::Response); pass_along_path(&nodes); }