Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 4 commits into from
Sep 2, 2022
Merged

Expose onion messages in public API #1650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b1f476
Expose onion message module as public
valentinewallace Aug 3, 2022
b9b02b4
Refuse to send and forward OMs to disconnected peers
valentinewallace Aug 4, 2022
04f4673
Don't construct OnionMessage while holding peer lock
valentinewallace Sep 2, 2022
a8ea0bd
Limit OnionMessenger outbound buffer size
valentinewallace Sep 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions lightning/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down
7 changes: 6 additions & 1 deletion lightning/src/ln/features.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
"Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
// We do not yet advertise the onion messages feature bit, but we need to detect when peers
// support it.
define_feature!(39, OnionMessages, [InitContext, NodeContext],
"Feature flags for `option_onion_messages`.", set_onion_messages_optional,
set_onion_messages_required, supports_onion_messages, requires_onion_messages);
define_feature!(45, ChannelType, [InitContext, NodeContext],
"Feature flags for `option_channel_type`.", set_channel_type_optional,
set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
// We are no longer setting initial_routing_sync now that gossip_queries
// is enabled. This feature is ignored by a peer when gossip_queries has
// is enabled. This feature is ignored by a peer when gossip_queries has
// been negotiated.
#[cfg(test)]
pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down
6 changes: 6 additions & 0 deletions lightning/src/ln/msgs.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
/// Handle an incoming onion_message message from the given peer.
fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
/// Called when a connection is established with a peer. Can be used to track which peers
/// advertise onion message support and are online.
fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
/// drop and refuse to forward onion messages to this peer.
fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down
10 changes: 9 additions & 1 deletion lightning/src/ln/peer_handler.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
}

self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

peer_lock.their_features = Some(msg.features);
return Ok(None);
} else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
}
descriptor.disconnect_socket();
self.message_handler.chan_handler.peer_disconnected(&node_id, false);
self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
}
}
}
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
}
}
};
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
peers_lock.remove(&descriptor);
self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
descriptor.disconnect_socket();
}
}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
if let Some(node_id) = peer.lock().unwrap().their_node_id {
log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
self.message_handler.chan_handler.peer_disconnected(&node_id, false);
self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
}
descriptor.disconnect_socket();
}
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
self.message_handler.chan_handler.peer_disconnected(&node_id, false);
self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
}
}
}
Expand Down
41 changes: 28 additions & 13 deletions lightning/src/onion_message/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
let mut res = Vec::new();
let mut nodes = Vec::new();
for i in 0..num_messengers {
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));
res.push(MessengerNode {
nodes.push(MessengerNode {
keys_manager: keys_manager.clone(),
messenger: OnionMessenger::new(keys_manager, logger.clone()),
logger,
});
}
res
for idx in 0..num_messengers - 1 {
let i = idx as usize;
let mut features = InitFeatures::known();
features.set_onion_messages_optional();
let init_msg = msgs::Init { features, remote_network_address: None };
nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
}
nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
let mut prev_node = &path[0];
let num_nodes = path.len();
for (idx, node) in path.into_iter().skip(1).enumerate() {
let events = prev_node.messenger.release_pending_msgs();
assert_eq!(events.len(), 1);
let onion_msg = {
let msgs = events.get(&node.get_node_pk()).unwrap();
assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
// Make sure we error as expected if a packet is too big to send.
let nodes = create_nodes(1);

let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
let secp_ctx = Secp256k1::new();
let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
let nodes = create_nodes(2);

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), None).unwrap_err();
assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
let mut nodes = create_nodes(3);
let nodes = create_nodes(3);

// 0 hops
let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
let mut nodes = create_nodes(4);
let nodes = create_nodes(4);
let secp_ctx = Secp256k1::new();

// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
"lightning::onion_message::messenger".to_string(),
format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
let nodes = create_nodes(2);
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()), None).unwrap();
}
let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
assert_eq!(err, SendError::BufferFull);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 4 commits into

from

Sep 2, 2022
 Merged


Expose onion messages in public API #1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
0b1f476

Expose onion message module as public


valentinewallace Aug 3, 2022
b9b02b4

Refuse to send and forward OMs to disconnected peers


valentinewallace Aug 4, 2022
04f4673

Don't construct OnionMessage while holding peer lock


valentinewallace Sep 2, 2022
a8ea0bd

Limit OnionMessenger outbound buffer size


valentinewallace Sep 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 0 additions & 4 deletions
lightning/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down

7 changes: 6 additions & 1 deletion
lightning/src/ln/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
	define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
	// We do not yet advertise the onion messages feature bit, but we need to detect when peers
	// support it.
	define_feature!(39, OnionMessages, [InitContext, NodeContext],
 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
	define_feature!(45, ChannelType, [InitContext, NodeContext],
 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
	// We are no longer setting initial_routing_sync now that gossip_queries
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// been negotiated.
	#[cfg(test)]
	pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down

6 changes: 6 additions & 0 deletions
lightning/src/ln/msgs.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
	/// Handle an incoming onion_message message from the given peer.
	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
	/// Called when a connection is established with a peer. Can be used to track which peers
	/// advertise onion message support and are online.
	fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
	/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
	/// drop and refuse to forward onion messages to this peer.
	fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down

10 changes: 9 additions & 1 deletion
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
	fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
	fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
	fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
	type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }

 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
 self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
 descriptor.disconnect_socket();
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 }
 }
 };
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
 peers_lock.remove(&descriptor);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 descriptor.disconnect_socket();
 }
	}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 if let Some(node_id) = peer.lock().unwrap().their_node_id {
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 descriptor.disconnect_socket();
 }
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand Down

41 changes: 28 additions & 13 deletions
lightning/src/onion_message/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
	let mut res = Vec::new();
	let mut nodes = Vec::new();
	for i in 0..num_messengers {
 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));
res.push(MessengerNode {
nodes.push(MessengerNode {
 keys_manager: keys_manager.clone(),
 messenger: OnionMessenger::new(keys_manager, logger.clone()),
 logger,
 });
	}
	res
	for idx in 0..num_messengers - 1 {
 let i = idx as usize;
 let mut features = InitFeatures::known();
 features.set_onion_messages_optional();
 let init_msg = msgs::Init { features, remote_network_address: None };
 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
	}
	nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
	let mut prev_node = &path[0];
	let num_nodes = path.len();
	for (idx, node) in path.into_iter().skip(1).enumerate() {
 let events = prev_node.messenger.release_pending_msgs();
 assert_eq!(events.len(), 1);
 let onion_msg = {
 let msgs = events.get(&node.get_node_pk()).unwrap();
 assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
	// Make sure we error as expected if a packet is too big to send.
	let nodes = create_nodes(1);

	let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
	let secp_ctx = Secp256k1::new();
	let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
	let nodes = create_nodes(2);

	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), None).unwrap_err();
	assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
	// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
	let mut nodes = create_nodes(3);
	let nodes = create_nodes(3);

	// 0 hops
	let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
	let mut nodes = create_nodes(4);
	let nodes = create_nodes(4);
	let secp_ctx = Secp256k1::new();

	// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
 "lightning::onion_message::messenger".to_string(),
 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
	let nodes = create_nodes(2);
	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()), None).unwrap();
	}
	let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
	assert_eq!(err, SendError::BufferFull);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 4 commits into

from

Sep 2, 2022
 Merged


Expose onion messages in public API #1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
0b1f476

Expose onion message module as public


valentinewallace Aug 3, 2022
b9b02b4

Refuse to send and forward OMs to disconnected peers


valentinewallace Aug 4, 2022
04f4673

Don't construct OnionMessage while holding peer lock


valentinewallace Sep 2, 2022
a8ea0bd

Limit OnionMessenger outbound buffer size


valentinewallace Sep 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 0 additions & 4 deletions
lightning/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down

7 changes: 6 additions & 1 deletion
lightning/src/ln/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
	define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
	// We do not yet advertise the onion messages feature bit, but we need to detect when peers
	// support it.
	define_feature!(39, OnionMessages, [InitContext, NodeContext],
 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
	define_feature!(45, ChannelType, [InitContext, NodeContext],
 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
	// We are no longer setting initial_routing_sync now that gossip_queries
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// been negotiated.
	#[cfg(test)]
	pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down

6 changes: 6 additions & 0 deletions
lightning/src/ln/msgs.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
	/// Handle an incoming onion_message message from the given peer.
	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
	/// Called when a connection is established with a peer. Can be used to track which peers
	/// advertise onion message support and are online.
	fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
	/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
	/// drop and refuse to forward onion messages to this peer.
	fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down

10 changes: 9 additions & 1 deletion
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
	fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
	fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
	fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
	type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }

 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
 self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
 descriptor.disconnect_socket();
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 }
 }
 };
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
 peers_lock.remove(&descriptor);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 descriptor.disconnect_socket();
 }
	}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 if let Some(node_id) = peer.lock().unwrap().their_node_id {
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 descriptor.disconnect_socket();
 }
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand Down

41 changes: 28 additions & 13 deletions
lightning/src/onion_message/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
	let mut res = Vec::new();
	let mut nodes = Vec::new();
	for i in 0..num_messengers {
 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));
res.push(MessengerNode {
nodes.push(MessengerNode {
 keys_manager: keys_manager.clone(),
 messenger: OnionMessenger::new(keys_manager, logger.clone()),
 logger,
 });
	}
	res
	for idx in 0..num_messengers - 1 {
 let i = idx as usize;
 let mut features = InitFeatures::known();
 features.set_onion_messages_optional();
 let init_msg = msgs::Init { features, remote_network_address: None };
 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
	}
	nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
	let mut prev_node = &path[0];
	let num_nodes = path.len();
	for (idx, node) in path.into_iter().skip(1).enumerate() {
 let events = prev_node.messenger.release_pending_msgs();
 assert_eq!(events.len(), 1);
 let onion_msg = {
 let msgs = events.get(&node.get_node_pk()).unwrap();
 assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
	// Make sure we error as expected if a packet is too big to send.
	let nodes = create_nodes(1);

	let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
	let secp_ctx = Secp256k1::new();
	let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
	let nodes = create_nodes(2);

	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), None).unwrap_err();
	assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
	// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
	let mut nodes = create_nodes(3);
	let nodes = create_nodes(3);

	// 0 hops
	let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
	let mut nodes = create_nodes(4);
	let nodes = create_nodes(4);
	let secp_ctx = Secp256k1::new();

	// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
 "lightning::onion_message::messenger".to_string(),
 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
	let nodes = create_nodes(2);
	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()), None).unwrap();
	}
	let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
	assert_eq!(err, SendError::BufferFull);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 4 commits into

from

Sep 2, 2022
 Merged


Expose onion messages in public API #1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
0b1f476

Expose onion message module as public


valentinewallace Aug 3, 2022
b9b02b4

Refuse to send and forward OMs to disconnected peers


valentinewallace Aug 4, 2022
04f4673

Don't construct OnionMessage while holding peer lock


valentinewallace Sep 2, 2022
a8ea0bd

Limit OnionMessenger outbound buffer size


valentinewallace Sep 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 0 additions & 4 deletions
lightning/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down

7 changes: 6 additions & 1 deletion
lightning/src/ln/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
	define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
	// We do not yet advertise the onion messages feature bit, but we need to detect when peers
	// support it.
	define_feature!(39, OnionMessages, [InitContext, NodeContext],
 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
	define_feature!(45, ChannelType, [InitContext, NodeContext],
 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
	// We are no longer setting initial_routing_sync now that gossip_queries
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// been negotiated.
	#[cfg(test)]
	pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down

6 changes: 6 additions & 0 deletions
lightning/src/ln/msgs.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
	/// Handle an incoming onion_message message from the given peer.
	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
	/// Called when a connection is established with a peer. Can be used to track which peers
	/// advertise onion message support and are online.
	fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
	/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
	/// drop and refuse to forward onion messages to this peer.
	fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down

10 changes: 9 additions & 1 deletion
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
	fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
	fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
	fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
	type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }

 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
 self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
 descriptor.disconnect_socket();
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 }
 }
 };
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
 peers_lock.remove(&descriptor);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 descriptor.disconnect_socket();
 }
	}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 if let Some(node_id) = peer.lock().unwrap().their_node_id {
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 descriptor.disconnect_socket();
 }
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand Down

41 changes: 28 additions & 13 deletions
lightning/src/onion_message/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
	let mut res = Vec::new();
	let mut nodes = Vec::new();
	for i in 0..num_messengers {
 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));
res.push(MessengerNode {
nodes.push(MessengerNode {
 keys_manager: keys_manager.clone(),
 messenger: OnionMessenger::new(keys_manager, logger.clone()),
 logger,
 });
	}
	res
	for idx in 0..num_messengers - 1 {
 let i = idx as usize;
 let mut features = InitFeatures::known();
 features.set_onion_messages_optional();
 let init_msg = msgs::Init { features, remote_network_address: None };
 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
	}
	nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
	let mut prev_node = &path[0];
	let num_nodes = path.len();
	for (idx, node) in path.into_iter().skip(1).enumerate() {
 let events = prev_node.messenger.release_pending_msgs();
 assert_eq!(events.len(), 1);
 let onion_msg = {
 let msgs = events.get(&node.get_node_pk()).unwrap();
 assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
	// Make sure we error as expected if a packet is too big to send.
	let nodes = create_nodes(1);

	let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
	let secp_ctx = Secp256k1::new();
	let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
	let nodes = create_nodes(2);

	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), None).unwrap_err();
	assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
	// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
	let mut nodes = create_nodes(3);
	let nodes = create_nodes(3);

	// 0 hops
	let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
	let mut nodes = create_nodes(4);
	let nodes = create_nodes(4);
	let secp_ctx = Secp256k1::new();

	// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
 "lightning::onion_message::messenger".to_string(),
 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
	let nodes = create_nodes(2);
	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()), None).unwrap();
	}
	let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
	assert_eq!(err, SendError::BufferFull);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 4 commits into

from

Sep 2, 2022
 Merged


Expose onion messages in public API #1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
0b1f476

Expose onion message module as public


valentinewallace Aug 3, 2022
b9b02b4

Refuse to send and forward OMs to disconnected peers


valentinewallace Aug 4, 2022
04f4673

Don't construct OnionMessage while holding peer lock


valentinewallace Sep 2, 2022
a8ea0bd

Limit OnionMessenger outbound buffer size


valentinewallace Sep 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 0 additions & 4 deletions
lightning/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down

7 changes: 6 additions & 1 deletion
lightning/src/ln/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
	define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
	// We do not yet advertise the onion messages feature bit, but we need to detect when peers
	// support it.
	define_feature!(39, OnionMessages, [InitContext, NodeContext],
 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
	define_feature!(45, ChannelType, [InitContext, NodeContext],
 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
	// We are no longer setting initial_routing_sync now that gossip_queries
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// been negotiated.
	#[cfg(test)]
	pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down

6 changes: 6 additions & 0 deletions
lightning/src/ln/msgs.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
	/// Handle an incoming onion_message message from the given peer.
	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
	/// Called when a connection is established with a peer. Can be used to track which peers
	/// advertise onion message support and are online.
	fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
	/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
	/// drop and refuse to forward onion messages to this peer.
	fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down

10 changes: 9 additions & 1 deletion
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
	fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
	fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
	fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
	type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }

 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
 self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
 descriptor.disconnect_socket();
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 }
 }
 };
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
 peers_lock.remove(&descriptor);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 descriptor.disconnect_socket();
 }
	}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 if let Some(node_id) = peer.lock().unwrap().their_node_id {
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 descriptor.disconnect_socket();
 }
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand Down

41 changes: 28 additions & 13 deletions
lightning/src/onion_message/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
	let mut res = Vec::new();
	let mut nodes = Vec::new();
	for i in 0..num_messengers {
 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));
res.push(MessengerNode {
nodes.push(MessengerNode {
 keys_manager: keys_manager.clone(),
 messenger: OnionMessenger::new(keys_manager, logger.clone()),
 logger,
 });
	}
	res
	for idx in 0..num_messengers - 1 {
 let i = idx as usize;
 let mut features = InitFeatures::known();
 features.set_onion_messages_optional();
 let init_msg = msgs::Init { features, remote_network_address: None };
 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
	}
	nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
	let mut prev_node = &path[0];
	let num_nodes = path.len();
	for (idx, node) in path.into_iter().skip(1).enumerate() {
 let events = prev_node.messenger.release_pending_msgs();
 assert_eq!(events.len(), 1);
 let onion_msg = {
 let msgs = events.get(&node.get_node_pk()).unwrap();
 assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
	// Make sure we error as expected if a packet is too big to send.
	let nodes = create_nodes(1);

	let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
	let secp_ctx = Secp256k1::new();
	let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
	let nodes = create_nodes(2);

	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), None).unwrap_err();
	assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
	// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
	let mut nodes = create_nodes(3);
	let nodes = create_nodes(3);

	// 0 hops
	let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
	let mut nodes = create_nodes(4);
	let nodes = create_nodes(4);
	let secp_ctx = Secp256k1::new();

	// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
 "lightning::onion_message::messenger".to_string(),
 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
	let nodes = create_nodes(2);
	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()), None).unwrap();
	}
	let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
	assert_eq!(err, SendError::BufferFull);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 4 commits into

from

Sep 2, 2022
 Merged


Expose onion messages in public API #1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
0b1f476

Expose onion message module as public


valentinewallace Aug 3, 2022
b9b02b4

Refuse to send and forward OMs to disconnected peers


valentinewallace Aug 4, 2022
04f4673

Don't construct OnionMessage while holding peer lock


valentinewallace Sep 2, 2022
a8ea0bd

Limit OnionMessenger outbound buffer size


valentinewallace Sep 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 0 additions & 4 deletions
lightning/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down

7 changes: 6 additions & 1 deletion
lightning/src/ln/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
	define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
	// We do not yet advertise the onion messages feature bit, but we need to detect when peers
	// support it.
	define_feature!(39, OnionMessages, [InitContext, NodeContext],
 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
	define_feature!(45, ChannelType, [InitContext, NodeContext],
 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
	// We are no longer setting initial_routing_sync now that gossip_queries
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// been negotiated.
	#[cfg(test)]
	pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down

6 changes: 6 additions & 0 deletions
lightning/src/ln/msgs.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
	/// Handle an incoming onion_message message from the given peer.
	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
	/// Called when a connection is established with a peer. Can be used to track which peers
	/// advertise onion message support and are online.
	fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
	/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
	/// drop and refuse to forward onion messages to this peer.
	fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down

10 changes: 9 additions & 1 deletion
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
	fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
	fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
	fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
	type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }

 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
 self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
 descriptor.disconnect_socket();
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 }
 }
 };
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
 peers_lock.remove(&descriptor);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 descriptor.disconnect_socket();
 }
	}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 if let Some(node_id) = peer.lock().unwrap().their_node_id {
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 descriptor.disconnect_socket();
 }
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand Down

41 changes: 28 additions & 13 deletions
lightning/src/onion_message/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
	let mut res = Vec::new();
	let mut nodes = Vec::new();
	for i in 0..num_messengers {
 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));
res.push(MessengerNode {
nodes.push(MessengerNode {
 keys_manager: keys_manager.clone(),
 messenger: OnionMessenger::new(keys_manager, logger.clone()),
 logger,
 });
	}
	res
	for idx in 0..num_messengers - 1 {
 let i = idx as usize;
 let mut features = InitFeatures::known();
 features.set_onion_messages_optional();
 let init_msg = msgs::Init { features, remote_network_address: None };
 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
	}
	nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
	let mut prev_node = &path[0];
	let num_nodes = path.len();
	for (idx, node) in path.into_iter().skip(1).enumerate() {
 let events = prev_node.messenger.release_pending_msgs();
 assert_eq!(events.len(), 1);
 let onion_msg = {
 let msgs = events.get(&node.get_node_pk()).unwrap();
 assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
	// Make sure we error as expected if a packet is too big to send.
	let nodes = create_nodes(1);

	let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
	let secp_ctx = Secp256k1::new();
	let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
	let nodes = create_nodes(2);

	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), None).unwrap_err();
	assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
	// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
	let mut nodes = create_nodes(3);
	let nodes = create_nodes(3);

	// 0 hops
	let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
	let mut nodes = create_nodes(4);
	let nodes = create_nodes(4);
	let secp_ctx = Secp256k1::new();

	// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
 "lightning::onion_message::messenger".to_string(),
 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
	let nodes = create_nodes(2);
	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()), None).unwrap();
	}
	let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
	assert_eq!(err, SendError::BufferFull);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 4 commits into

from

Sep 2, 2022
 Merged


Expose onion messages in public API #1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
0b1f476

Expose onion message module as public


valentinewallace Aug 3, 2022
b9b02b4

Refuse to send and forward OMs to disconnected peers


valentinewallace Aug 4, 2022
04f4673

Don't construct OnionMessage while holding peer lock


valentinewallace Sep 2, 2022
a8ea0bd

Limit OnionMessenger outbound buffer size


valentinewallace Sep 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 0 additions & 4 deletions
lightning/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down

7 changes: 6 additions & 1 deletion
lightning/src/ln/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
	define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
	// We do not yet advertise the onion messages feature bit, but we need to detect when peers
	// support it.
	define_feature!(39, OnionMessages, [InitContext, NodeContext],
 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
	define_feature!(45, ChannelType, [InitContext, NodeContext],
 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
	// We are no longer setting initial_routing_sync now that gossip_queries
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// been negotiated.
	#[cfg(test)]
	pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down

6 changes: 6 additions & 0 deletions
lightning/src/ln/msgs.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
	/// Handle an incoming onion_message message from the given peer.
	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
	/// Called when a connection is established with a peer. Can be used to track which peers
	/// advertise onion message support and are online.
	fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
	/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
	/// drop and refuse to forward onion messages to this peer.
	fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down

10 changes: 9 additions & 1 deletion
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
	fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
	fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
	fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
	type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }

 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
 self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
 descriptor.disconnect_socket();
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 }
 }
 };
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
 peers_lock.remove(&descriptor);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 descriptor.disconnect_socket();
 }
	}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 if let Some(node_id) = peer.lock().unwrap().their_node_id {
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 descriptor.disconnect_socket();
 }
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand Down

41 changes: 28 additions & 13 deletions
lightning/src/onion_message/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
	let mut res = Vec::new();
	let mut nodes = Vec::new();
	for i in 0..num_messengers {
 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));
res.push(MessengerNode {
nodes.push(MessengerNode {
 keys_manager: keys_manager.clone(),
 messenger: OnionMessenger::new(keys_manager, logger.clone()),
 logger,
 });
	}
	res
	for idx in 0..num_messengers - 1 {
 let i = idx as usize;
 let mut features = InitFeatures::known();
 features.set_onion_messages_optional();
 let init_msg = msgs::Init { features, remote_network_address: None };
 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
	}
	nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
	let mut prev_node = &path[0];
	let num_nodes = path.len();
	for (idx, node) in path.into_iter().skip(1).enumerate() {
 let events = prev_node.messenger.release_pending_msgs();
 assert_eq!(events.len(), 1);
 let onion_msg = {
 let msgs = events.get(&node.get_node_pk()).unwrap();
 assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
	// Make sure we error as expected if a packet is too big to send.
	let nodes = create_nodes(1);

	let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
	let secp_ctx = Secp256k1::new();
	let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
	let nodes = create_nodes(2);

	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), None).unwrap_err();
	assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
	// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
	let mut nodes = create_nodes(3);
	let nodes = create_nodes(3);

	// 0 hops
	let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
	let mut nodes = create_nodes(4);
	let nodes = create_nodes(4);
	let secp_ctx = Secp256k1::new();

	// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
 "lightning::onion_message::messenger".to_string(),
 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
	let nodes = create_nodes(2);
	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()), None).unwrap();
	}
	let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
	assert_eq!(err, SendError::BufferFull);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Expose onion messages in public API #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 4 commits into

from

Sep 2, 2022
 Merged


Expose onion messages in public API #1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
0b1f476

Expose onion message module as public


valentinewallace Aug 3, 2022
b9b02b4

Refuse to send and forward OMs to disconnected peers


valentinewallace Aug 4, 2022
04f4673

Don't construct OnionMessage while holding peer lock


valentinewallace Sep 2, 2022
a8ea0bd

Limit OnionMessenger outbound buffer size


valentinewallace Sep 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 0 additions & 4 deletions
lightning/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,7 @@ pub mod util;
pub mod chain;
pub mod ln;
pub mod routing;
#[cfg(fuzzing)]
pub mod onion_message;
#[cfg(not(fuzzing))]
#[allow(unused)]
mod onion_message; // To be exposed after sending/receiving OMs is supported in PeerManager.

#[cfg(feature = "std")]
/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
Expand Down

7 changes: 6 additions & 1 deletion
lightning/src/ln/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,11 @@ mod sealed {
	define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
	// We do not yet advertise the onion messages feature bit, but we need to detect when peers
	// support it.
	define_feature!(39, OnionMessages, [InitContext, NodeContext],
 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
	define_feature!(45, ChannelType, [InitContext, NodeContext],
 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 set_channel_type_required, supports_channel_type, requires_channel_type);
Expand DownExpand Up@@ -767,7 +772,7 @@ impl<T: sealed::GossipQueries> Features<T> {

impl<T: sealed::InitialRoutingSync> Features<T> {
	// We are no longer setting initial_routing_sync now that gossip_queries
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// is enabled. This feature is ignored by a peer when gossip_queries has
	// been negotiated.
	#[cfg(test)]
	pub(crate) fn clear_initial_routing_sync(&mut self) {
Expand Down

6 changes: 6 additions & 0 deletions
lightning/src/ln/msgs.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -949,6 +949,12 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
pub trait OnionMessageHandler : OnionMessageProvider {
	/// Handle an incoming onion_message message from the given peer.
	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
	/// Called when a connection is established with a peer. Can be used to track which peers
	/// advertise onion message support and are online.
	fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
	/// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
	/// drop and refuse to forward onion messages to this peer.
	fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
}

mod fuzzy_internal_msgs {
Expand Down

10 changes: 9 additions & 1 deletion
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ impl OnionMessageProvider for IgnoringMessageHandler {
}
impl OnionMessageHandler for IgnoringMessageHandler {
	fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
	fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
	fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
}
impl Deref for IgnoringMessageHandler {
	type Target = IgnoringMessageHandler;
Expand DownExpand Up@@ -1173,8 +1175,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }

 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);

 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
 self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg);

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -1729,6 +1732,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
 descriptor.disconnect_socket();
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand DownExpand Up@@ -1756,6 +1760,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 }
 }
 };
Expand All@@ -1776,6 +1781,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
 peers_lock.remove(&descriptor);
 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
 descriptor.disconnect_socket();
 }
	}
Expand All@@ -1791,6 +1797,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 if let Some(node_id) = peer.lock().unwrap().their_node_id {
 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 descriptor.disconnect_socket();
 }
Expand DownExpand Up@@ -1881,6 +1888,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
 }
 }
 }
Expand Down

41 changes: 28 additions & 13 deletions
lightning/src/onion_message/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
//! Onion message testing and test utilities live here.

use chain::keysinterface::{KeysInterface, Recipient};
use ln::msgs::OnionMessageHandler;
use ln::features::InitFeatures;
use ln::msgs::{self, OnionMessageHandler};
use super::{BlindedRoute, Destination, OnionMessenger, SendError};
use util::enforcing_trait_impls::EnforcingSigner;
use util::test_utils;

use bitcoin::network::constants::Network;
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
use bitcoin::secp256k1::{PublicKey, Secp256k1};

use sync::Arc;

Expand All@@ -34,26 +35,33 @@ impl MessengerNode {
}

fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
	let mut res = Vec::new();
	let mut nodes = Vec::new();
	for i in 0..num_messengers {
 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));
res.push(MessengerNode {
nodes.push(MessengerNode {
 keys_manager: keys_manager.clone(),
 messenger: OnionMessenger::new(keys_manager, logger.clone()),
 logger,
 });
	}
	res
	for idx in 0..num_messengers - 1 {
 let i = idx as usize;
 let mut features = InitFeatures::known();
 features.set_onion_messages_optional();
 let init_msg = msgs::Init { features, remote_network_address: None };
 nodes[i].messenger.peer_connected(&nodes[i + 1].get_node_pk(), &init_msg.clone());
 nodes[i + 1].messenger.peer_connected(&nodes[i].get_node_pk(), &init_msg.clone());
	}
	nodes
}

fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>) {
	let mut prev_node = &path[0];
	let num_nodes = path.len();
	for (idx, node) in path.into_iter().skip(1).enumerate() {
 let events = prev_node.messenger.release_pending_msgs();
 assert_eq!(events.len(), 1);
 let onion_msg = {
 let msgs = events.get(&node.get_node_pk()).unwrap();
 assert_eq!(msgs.len(), 1);
Expand DownExpand Up@@ -110,12 +118,9 @@ fn three_blinded_hops() {
#[test]
fn too_big_packet_error() {
	// Make sure we error as expected if a packet is too big to send.
	let nodes = create_nodes(1);

	let hop_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
	let secp_ctx = Secp256k1::new();
	let hop_node_id = PublicKey::from_secret_key(&secp_ctx, &hop_secret);
	let nodes = create_nodes(2);

	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), None).unwrap_err();
	assert_eq!(err, SendError::TooBigPacket);
Expand All@@ -124,7 +129,7 @@ fn too_big_packet_error() {
#[test]
fn invalid_blinded_route_error() {
	// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
	let mut nodes = create_nodes(3);
	let nodes = create_nodes(3);

	// 0 hops
	let secp_ctx = Secp256k1::new();
Expand All@@ -143,7 +148,7 @@ fn invalid_blinded_route_error() {

#[test]
fn reply_path() {
	let mut nodes = create_nodes(4);
	let nodes = create_nodes(4);
	let secp_ctx = Secp256k1::new();

	// Destination::Node
Expand All@@ -165,3 +170,13 @@ fn reply_path() {
 "lightning::onion_message::messenger".to_string(),
 format!("Received an onion message with path_id: None and reply_path").to_string(), 2);
}

#[test]
fn peer_buffer_full() {
	let nodes = create_nodes(2);
	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()), None).unwrap();
	}
	let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), None).unwrap_err();
	assert_eq!(err, SendError::BufferFull);
}
Loading