1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! LDK sends, receives, and forwards onion messages via this [`OnionMessenger`], which lives here,
11 //! as well as various types, traits, and utilities that it uses.
13 use bitcoin::hashes::{Hash, HashEngine};
14 use bitcoin::hashes::hmac::{Hmac, HmacEngine};
15 use bitcoin::hashes::sha256::Hash as Sha256;
16 use bitcoin::secp256k1::{self, PublicKey, Scalar, Secp256k1, SecretKey};
18 use crate::blinded_path::BlindedPath;
19 use crate::blinded_path::message::{advance_path_by_one, ForwardTlvs, ReceiveTlvs};
20 use crate::blinded_path::utils;
21 use crate::events::{Event, EventHandler, EventsProvider};
22 use crate::sign::{EntropySource, NodeSigner, Recipient};
23 use crate::ln::features::{InitFeatures, NodeFeatures};
24 use crate::ln::msgs::{self, OnionMessage, OnionMessageHandler, SocketAddress};
25 use crate::ln::onion_utils;
26 use crate::routing::gossip::{NetworkGraph, NodeId};
27 use super::packet::OnionMessageContents;
28 use super::packet::ParsedOnionMessageContents;
29 use super::offers::OffersMessageHandler;
30 use super::packet::{BIG_PACKET_HOP_DATA_LEN, ForwardControlTlvs, Packet, Payload, ReceiveControlTlvs, SMALL_PACKET_HOP_DATA_LEN};
31 use crate::util::logger::{Logger, WithContext};
32 use crate::util::ser::Writeable;
37 use crate::sync::Mutex;
38 use crate::prelude::*;
40 #[cfg(not(c_bindings))]
42 crate::sign::KeysManager,
43 crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager},
44 crate::ln::peer_handler::IgnoringMessageHandler,
48 pub(super) const MAX_TIMER_TICKS: usize = 2;
50 /// A sender, receiver and forwarder of [`OnionMessage`]s.
52 /// # Handling Messages
54 /// `OnionMessenger` implements [`OnionMessageHandler`], making it responsible for either forwarding
55 /// messages to peers or delegating to the appropriate handler for the message type. Currently, the
56 /// available handlers are:
57 /// * [`OffersMessageHandler`], for responding to [`InvoiceRequest`]s and paying [`Bolt12Invoice`]s
58 /// * [`CustomOnionMessageHandler`], for handling user-defined message types
60 /// # Sending Messages
62 /// [`OnionMessage`]s are sent initially using [`OnionMessenger::send_onion_message`]. When handling
63 /// a message, the matched handler may return a response message which `OnionMessenger` will send
69 /// # extern crate bitcoin;
70 /// # use bitcoin::hashes::_export::_core::time::Duration;
71 /// # use bitcoin::hashes::hex::FromHex;
72 /// # use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey, self};
73 /// # use lightning::blinded_path::BlindedPath;
74 /// # use lightning::sign::{EntropySource, KeysManager};
75 /// # use lightning::ln::peer_handler::IgnoringMessageHandler;
76 /// # use lightning::onion_message::messenger::{Destination, MessageRouter, OnionMessagePath, OnionMessenger};
77 /// # use lightning::onion_message::packet::OnionMessageContents;
78 /// # use lightning::util::logger::{Logger, Record};
79 /// # use lightning::util::ser::{Writeable, Writer};
80 /// # use lightning::io;
81 /// # use std::sync::Arc;
82 /// # struct FakeLogger;
83 /// # impl Logger for FakeLogger {
84 /// # fn log(&self, record: Record) { println!("{:?}" , record); }
86 /// # struct FakeMessageRouter {}
87 /// # impl MessageRouter for FakeMessageRouter {
88 /// # fn find_path(&self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination) -> Result<OnionMessagePath, ()> {
89 /// # let secp_ctx = Secp256k1::new();
90 /// # let node_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
91 /// # let hop_node_id1 = PublicKey::from_secret_key(&secp_ctx, &node_secret);
92 /// # let hop_node_id2 = hop_node_id1;
93 /// # Ok(OnionMessagePath {
94 /// # intermediate_nodes: vec![hop_node_id1, hop_node_id2],
96 /// # first_node_addresses: None,
99 /// # fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
100 /// # &self, _recipient: PublicKey, _peers: Vec<PublicKey>, _secp_ctx: &Secp256k1<T>
101 /// # ) -> Result<Vec<BlindedPath>, ()> {
105 /// # let seed = [42u8; 32];
106 /// # let time = Duration::from_secs(123456);
107 /// # let keys_manager = KeysManager::new(&seed, time.as_secs(), time.subsec_nanos());
108 /// # let logger = Arc::new(FakeLogger {});
109 /// # let node_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
110 /// # let secp_ctx = Secp256k1::new();
111 /// # let hop_node_id1 = PublicKey::from_secret_key(&secp_ctx, &node_secret);
112 /// # let (hop_node_id3, hop_node_id4) = (hop_node_id1, hop_node_id1);
113 /// # let destination_node_id = hop_node_id1;
114 /// # let message_router = Arc::new(FakeMessageRouter {});
115 /// # let custom_message_handler = IgnoringMessageHandler {};
116 /// # let offers_message_handler = IgnoringMessageHandler {};
117 /// // Create the onion messenger. This must use the same `keys_manager` as is passed to your
118 /// // ChannelManager.
119 /// let onion_messenger = OnionMessenger::new(
120 /// &keys_manager, &keys_manager, logger, message_router, &offers_message_handler,
121 /// &custom_message_handler
124 /// # #[derive(Debug)]
125 /// # struct YourCustomMessage {}
126 /// impl Writeable for YourCustomMessage {
127 /// fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
129 /// // Write your custom onion message to `w`
132 /// impl OnionMessageContents for YourCustomMessage {
133 /// fn tlv_type(&self) -> u64 {
134 /// # let your_custom_message_type = 42;
135 /// your_custom_message_type
138 /// // Send a custom onion message to a node id.
139 /// let destination = Destination::Node(destination_node_id);
140 /// let reply_path = None;
141 /// # let message = YourCustomMessage {};
142 /// onion_messenger.send_onion_message(message, destination, reply_path);
144 /// // Create a blinded path to yourself, for someone to send an onion message to.
145 /// # let your_node_id = hop_node_id1;
146 /// let hops = [hop_node_id3, hop_node_id4, your_node_id];
147 /// let blinded_path = BlindedPath::new_for_message(&hops, &keys_manager, &secp_ctx).unwrap();
149 /// // Send a custom onion message to a blinded path.
150 /// let destination = Destination::BlindedPath(blinded_path);
151 /// let reply_path = None;
152 /// # let message = YourCustomMessage {};
153 /// onion_messenger.send_onion_message(message, destination, reply_path);
156 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
157 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
158 pub struct OnionMessenger<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref>
160 ES::Target: EntropySource,
161 NS::Target: NodeSigner,
163 MR::Target: MessageRouter,
164 OMH::Target: OffersMessageHandler,
165 CMH::Target: CustomOnionMessageHandler,
170 message_recipients: Mutex<HashMap<PublicKey, OnionMessageRecipient>>,
171 secp_ctx: Secp256k1<secp256k1::All>,
177 /// [`OnionMessage`]s buffered to be sent.
178 enum OnionMessageRecipient {
179 /// Messages for a node connected as a peer.
180 ConnectedPeer(VecDeque<OnionMessage>),
182 /// Messages for a node that is not yet connected, which are dropped after [`MAX_TIMER_TICKS`]
183 /// and tracked here.
184 PendingConnection(VecDeque<OnionMessage>, Option<Vec<SocketAddress>>, usize),
187 impl OnionMessageRecipient {
188 fn pending_connection(addresses: Vec<SocketAddress>) -> Self {
189 Self::PendingConnection(VecDeque::new(), Some(addresses), 0)
192 fn pending_messages(&self) -> &VecDeque<OnionMessage> {
194 OnionMessageRecipient::ConnectedPeer(pending_messages) => pending_messages,
195 OnionMessageRecipient::PendingConnection(pending_messages, _, _) => pending_messages,
199 fn enqueue_message(&mut self, message: OnionMessage) {
200 let pending_messages = match self {
201 OnionMessageRecipient::ConnectedPeer(pending_messages) => pending_messages,
202 OnionMessageRecipient::PendingConnection(pending_messages, _, _) => pending_messages,
205 pending_messages.push_back(message);
208 fn dequeue_message(&mut self) -> Option<OnionMessage> {
209 let pending_messages = match self {
210 OnionMessageRecipient::ConnectedPeer(pending_messages) => pending_messages,
211 OnionMessageRecipient::PendingConnection(pending_messages, _, _) => {
212 debug_assert!(false);
217 pending_messages.pop_front()
221 fn release_pending_messages(&mut self) -> VecDeque<OnionMessage> {
222 let pending_messages = match self {
223 OnionMessageRecipient::ConnectedPeer(pending_messages) => pending_messages,
224 OnionMessageRecipient::PendingConnection(pending_messages, _, _) => pending_messages,
227 core::mem::take(pending_messages)
230 fn mark_connected(&mut self) {
231 if let OnionMessageRecipient::PendingConnection(pending_messages, _, _) = self {
232 let mut new_pending_messages = VecDeque::new();
233 core::mem::swap(pending_messages, &mut new_pending_messages);
234 *self = OnionMessageRecipient::ConnectedPeer(new_pending_messages);
238 fn is_connected(&self) -> bool {
240 OnionMessageRecipient::ConnectedPeer(..) => true,
241 OnionMessageRecipient::PendingConnection(..) => false,
246 /// An [`OnionMessage`] for [`OnionMessenger`] to send.
248 /// These are obtained when released from [`OnionMessenger`]'s handlers after which they are
249 /// enqueued for sending.
250 #[cfg(not(c_bindings))]
251 pub struct PendingOnionMessage<T: OnionMessageContents> {
252 /// The message contents to send in an [`OnionMessage`].
255 /// The destination of the message.
256 pub destination: Destination,
258 /// A reply path to include in the [`OnionMessage`] for a response.
259 pub reply_path: Option<BlindedPath>,
263 /// An [`OnionMessage`] for [`OnionMessenger`] to send.
265 /// These are obtained when released from [`OnionMessenger`]'s handlers after which they are
266 /// enqueued for sending.
267 pub type PendingOnionMessage<T> = (T, Destination, Option<BlindedPath>);
269 pub(crate) fn new_pending_onion_message<T: OnionMessageContents>(
270 contents: T, destination: Destination, reply_path: Option<BlindedPath>
271 ) -> PendingOnionMessage<T> {
272 #[cfg(not(c_bindings))]
273 return PendingOnionMessage { contents, destination, reply_path };
275 return (contents, destination, reply_path);
278 /// A trait defining behavior for routing an [`OnionMessage`].
279 pub trait MessageRouter {
280 /// Returns a route for sending an [`OnionMessage`] to the given [`Destination`].
282 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
283 ) -> Result<OnionMessagePath, ()>;
285 /// Creates [`BlindedPath`]s to the `recipient` node. The nodes in `peers` are assumed to be
286 /// direct peers with the `recipient`.
287 fn create_blinded_paths<
288 T: secp256k1::Signing + secp256k1::Verification
290 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
291 ) -> Result<Vec<BlindedPath>, ()>;
294 /// A [`MessageRouter`] that can only route to a directly connected [`Destination`].
295 pub struct DefaultMessageRouter<G: Deref<Target=NetworkGraph<L>>, L: Deref, ES: Deref>
298 ES::Target: EntropySource,
304 impl<G: Deref<Target=NetworkGraph<L>>, L: Deref, ES: Deref> DefaultMessageRouter<G, L, ES>
307 ES::Target: EntropySource,
309 /// Creates a [`DefaultMessageRouter`] using the given [`NetworkGraph`].
310 pub fn new(network_graph: G, entropy_source: ES) -> Self {
311 Self { network_graph, entropy_source }
315 impl<G: Deref<Target=NetworkGraph<L>>, L: Deref, ES: Deref> MessageRouter for DefaultMessageRouter<G, L, ES>
318 ES::Target: EntropySource,
321 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
322 ) -> Result<OnionMessagePath, ()> {
323 let first_node = destination.first_node();
324 if peers.contains(&first_node) || sender == first_node {
325 Ok(OnionMessagePath {
326 intermediate_nodes: vec![], destination, first_node_addresses: None
329 let network_graph = self.network_graph.deref().read_only();
330 let node_announcement = network_graph
331 .node(&NodeId::from_pubkey(&first_node))
332 .and_then(|node_info| node_info.announcement_info.as_ref())
333 .and_then(|announcement_info| announcement_info.announcement_message.as_ref())
334 .map(|node_announcement| &node_announcement.contents);
336 match node_announcement {
337 Some(node_announcement) if node_announcement.features.supports_onion_messages() => {
338 let first_node_addresses = Some(node_announcement.addresses.clone());
339 Ok(OnionMessagePath {
340 intermediate_nodes: vec![], destination, first_node_addresses
348 fn create_blinded_paths<
349 T: secp256k1::Signing + secp256k1::Verification
351 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
352 ) -> Result<Vec<BlindedPath>, ()> {
353 // Limit the number of blinded paths that are computed.
354 const MAX_PATHS: usize = 3;
356 // Ensure peers have at least three channels so that it is more difficult to infer the
357 // recipient's node_id.
358 const MIN_PEER_CHANNELS: usize = 3;
360 let network_graph = self.network_graph.deref().read_only();
361 let is_recipient_announced =
362 network_graph.nodes().contains_key(&NodeId::from_pubkey(&recipient));
364 let mut peer_info = peers.iter()
365 // Limit to peers with announced channels
368 .node(&NodeId::from_pubkey(pubkey))
369 .filter(|info| info.channels.len() >= MIN_PEER_CHANNELS)
370 .map(|info| (*pubkey, info.is_tor_only(), info.channels.len()))
372 // Exclude Tor-only nodes when the recipient is announced.
373 .filter(|(_, is_tor_only, _)| !(*is_tor_only && is_recipient_announced))
374 .collect::<Vec<_>>();
376 // Prefer using non-Tor nodes with the most channels as the introduction node.
377 peer_info.sort_unstable_by(|(_, a_tor_only, a_channels), (_, b_tor_only, b_channels)| {
378 a_tor_only.cmp(b_tor_only).then(a_channels.cmp(b_channels).reverse())
381 let paths = peer_info.into_iter()
382 .map(|(pubkey, _, _)| vec![pubkey, recipient])
383 .map(|node_pks| BlindedPath::new_for_message(&node_pks, &*self.entropy_source, secp_ctx))
385 .collect::<Result<Vec<_>, _>>();
388 Ok(paths) if !paths.is_empty() => Ok(paths),
390 if is_recipient_announced {
391 BlindedPath::one_hop_for_message(recipient, &*self.entropy_source, secp_ctx)
392 .map(|path| vec![path])
401 /// A path for sending an [`OnionMessage`].
403 pub struct OnionMessagePath {
404 /// Nodes on the path between the sender and the destination.
405 pub intermediate_nodes: Vec<PublicKey>,
407 /// The recipient of the message.
408 pub destination: Destination,
410 /// Addresses that may be used to connect to [`OnionMessagePath::first_node`].
412 /// Only needs to be set if a connection to the node is required. [`OnionMessenger`] may use
413 /// this to initiate such a connection.
414 pub first_node_addresses: Option<Vec<SocketAddress>>,
417 impl OnionMessagePath {
418 /// Returns the first node in the path.
419 pub fn first_node(&self) -> PublicKey {
420 self.intermediate_nodes
423 .unwrap_or_else(|| self.destination.first_node())
427 /// The destination of an onion message.
428 #[derive(Clone, Hash, Debug, PartialEq, Eq)]
429 pub enum Destination {
430 /// We're sending this onion message to a node.
432 /// We're sending this onion message to a blinded path.
433 BlindedPath(BlindedPath),
437 pub(super) fn num_hops(&self) -> usize {
439 Destination::Node(_) => 1,
440 Destination::BlindedPath(BlindedPath { blinded_hops, .. }) => blinded_hops.len(),
444 fn first_node(&self) -> PublicKey {
446 Destination::Node(node_id) => *node_id,
447 Destination::BlindedPath(BlindedPath { introduction_node_id: node_id, .. }) => *node_id,
452 /// Result of successfully [sending an onion message].
454 /// [sending an onion message]: OnionMessenger::send_onion_message
455 #[derive(Clone, Hash, Debug, PartialEq, Eq)]
456 pub enum SendSuccess {
457 /// The message was buffered and will be sent once it is processed by
458 /// [`OnionMessageHandler::next_onion_message_for_peer`].
460 /// The message was buffered and will be sent once the node is connected as a peer and it is
461 /// processed by [`OnionMessageHandler::next_onion_message_for_peer`].
462 BufferedAwaitingConnection(PublicKey),
465 /// Errors that may occur when [sending an onion message].
467 /// [sending an onion message]: OnionMessenger::send_onion_message
468 #[derive(Clone, Hash, Debug, PartialEq, Eq)]
470 /// Errored computing onion message packet keys.
471 Secp256k1(secp256k1::Error),
472 /// Because implementations such as Eclair will drop onion messages where the message packet
473 /// exceeds 32834 bytes, we refuse to send messages where the packet exceeds this size.
475 /// The provided [`Destination`] was an invalid [`BlindedPath`] due to not having any blinded
478 /// The first hop is not a peer and doesn't have a known [`SocketAddress`].
479 InvalidFirstHop(PublicKey),
480 /// A path from the sender to the destination could not be found by the [`MessageRouter`].
482 /// Onion message contents must have a TLV type >= 64.
484 /// Our next-hop peer's buffer was full or our total outbound buffer was full.
486 /// Failed to retrieve our node id from the provided [`NodeSigner`].
488 /// [`NodeSigner`]: crate::sign::NodeSigner
490 /// We attempted to send to a blinded path where we are the introduction node, and failed to
491 /// advance the blinded path to make the second hop the new introduction node. Either
492 /// [`NodeSigner::ecdh`] failed, we failed to tweak the current blinding point to get the
493 /// new blinding point, or we were attempting to send to ourselves.
494 BlindedPathAdvanceFailed,
497 /// Handler for custom onion messages. If you are using [`SimpleArcOnionMessenger`],
498 /// [`SimpleRefOnionMessenger`], or prefer to ignore inbound custom onion messages,
499 /// [`IgnoringMessageHandler`] must be provided to [`OnionMessenger::new`]. Otherwise, a custom
500 /// implementation of this trait must be provided, with [`CustomMessage`] specifying the supported
503 /// See [`OnionMessenger`] for example usage.
505 /// [`IgnoringMessageHandler`]: crate::ln::peer_handler::IgnoringMessageHandler
506 /// [`CustomMessage`]: Self::CustomMessage
507 pub trait CustomOnionMessageHandler {
508 /// The message known to the handler. To support multiple message types, you may want to make this
509 /// an enum with a variant for each supported message.
510 type CustomMessage: OnionMessageContents;
512 /// Called with the custom message that was received, returning a response to send, if any.
514 /// The returned [`Self::CustomMessage`], if any, is enqueued to be sent by [`OnionMessenger`].
515 fn handle_custom_message(&self, msg: Self::CustomMessage) -> Option<Self::CustomMessage>;
517 /// Read a custom message of type `message_type` from `buffer`, returning `Ok(None)` if the
518 /// message type is unknown.
519 fn read_custom_message<R: io::Read>(&self, message_type: u64, buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError>;
521 /// Releases any [`Self::CustomMessage`]s that need to be sent.
523 /// Typically, this is used for messages initiating a message flow rather than in response to
524 /// another message. The latter should use the return value of [`Self::handle_custom_message`].
525 #[cfg(not(c_bindings))]
526 fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Self::CustomMessage>>;
528 /// Releases any [`Self::CustomMessage`]s that need to be sent.
530 /// Typically, this is used for messages initiating a message flow rather than in response to
531 /// another message. The latter should use the return value of [`Self::handle_custom_message`].
533 fn release_pending_custom_messages(&self) -> Vec<(Self::CustomMessage, Destination, Option<BlindedPath>)>;
536 /// A processed incoming onion message, containing either a Forward (another onion message)
537 /// or a Receive payload with decrypted contents.
539 pub enum PeeledOnion<T: OnionMessageContents> {
540 /// Forwarded onion, with the next node id and a new onion
541 Forward(PublicKey, OnionMessage),
542 /// Received onion message, with decrypted contents, path_id, and reply path
543 Receive(ParsedOnionMessageContents<T>, Option<[u8; 32]>, Option<BlindedPath>)
546 /// Creates an [`OnionMessage`] with the given `contents` for sending to the destination of
549 /// Returns the node id of the peer to send the message to, the message itself, and any addresses
550 /// need to connect to the first node.
551 pub fn create_onion_message<ES: Deref, NS: Deref, T: OnionMessageContents>(
552 entropy_source: &ES, node_signer: &NS, secp_ctx: &Secp256k1<secp256k1::All>,
553 path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,
554 ) -> Result<(PublicKey, OnionMessage, Option<Vec<SocketAddress>>), SendError>
556 ES::Target: EntropySource,
557 NS::Target: NodeSigner,
559 let OnionMessagePath { intermediate_nodes, mut destination, first_node_addresses } = path;
560 if let Destination::BlindedPath(BlindedPath { ref blinded_hops, .. }) = destination {
561 if blinded_hops.is_empty() {
562 return Err(SendError::TooFewBlindedHops);
566 if contents.tlv_type() < 64 { return Err(SendError::InvalidMessage) }
568 // If we are sending straight to a blinded path and we are the introduction node, we need to
569 // advance the blinded path by 1 hop so the second hop is the new introduction node.
570 if intermediate_nodes.len() == 0 {
571 if let Destination::BlindedPath(ref mut blinded_path) = destination {
572 let our_node_id = node_signer.get_node_id(Recipient::Node)
573 .map_err(|()| SendError::GetNodeIdFailed)?;
574 if blinded_path.introduction_node_id == our_node_id {
575 advance_path_by_one(blinded_path, node_signer, &secp_ctx)
576 .map_err(|()| SendError::BlindedPathAdvanceFailed)?;
581 let blinding_secret_bytes = entropy_source.get_secure_random_bytes();
582 let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
583 let (first_node_id, blinding_point) = if let Some(first_node_id) = intermediate_nodes.first() {
584 (*first_node_id, PublicKey::from_secret_key(&secp_ctx, &blinding_secret))
587 Destination::Node(pk) => (pk, PublicKey::from_secret_key(&secp_ctx, &blinding_secret)),
588 Destination::BlindedPath(BlindedPath { introduction_node_id, blinding_point, .. }) =>
589 (introduction_node_id, blinding_point),
592 let (packet_payloads, packet_keys) = packet_payloads_and_keys(
593 &secp_ctx, &intermediate_nodes, destination, contents, reply_path, &blinding_secret)
594 .map_err(|e| SendError::Secp256k1(e))?;
596 let prng_seed = entropy_source.get_secure_random_bytes();
597 let onion_routing_packet = construct_onion_message_packet(
598 packet_payloads, packet_keys, prng_seed).map_err(|()| SendError::TooBigPacket)?;
600 let message = OnionMessage { blinding_point, onion_routing_packet };
601 Ok((first_node_id, message, first_node_addresses))
604 /// Decode one layer of an incoming [`OnionMessage`].
606 /// Returns either the next layer of the onion for forwarding or the decrypted content for the
608 pub fn peel_onion_message<NS: Deref, L: Deref, CMH: Deref>(
609 msg: &OnionMessage, secp_ctx: &Secp256k1<secp256k1::All>, node_signer: NS, logger: L,
611 ) -> Result<PeeledOnion<<<CMH>::Target as CustomOnionMessageHandler>::CustomMessage>, ()>
613 NS::Target: NodeSigner,
615 CMH::Target: CustomOnionMessageHandler,
617 let control_tlvs_ss = match node_signer.ecdh(Recipient::Node, &msg.blinding_point, None) {
620 log_error!(logger, "Failed to retrieve node secret: {:?}", e);
624 let onion_decode_ss = {
625 let blinding_factor = {
626 let mut hmac = HmacEngine::<Sha256>::new(b"blinded_node_id");
627 hmac.input(control_tlvs_ss.as_ref());
628 Hmac::from_engine(hmac).to_byte_array()
630 match node_signer.ecdh(Recipient::Node, &msg.onion_routing_packet.public_key,
631 Some(&Scalar::from_be_bytes(blinding_factor).unwrap()))
633 Ok(ss) => ss.secret_bytes(),
635 log_trace!(logger, "Failed to compute onion packet shared secret");
640 match onion_utils::decode_next_untagged_hop(
641 onion_decode_ss, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac,
642 (control_tlvs_ss, custom_handler.deref(), logger.deref())
644 Ok((Payload::Receive::<ParsedOnionMessageContents<<<CMH as Deref>::Target as CustomOnionMessageHandler>::CustomMessage>> {
645 message, control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id }), reply_path,
647 Ok(PeeledOnion::Receive(message, path_id, reply_path))
649 Ok((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
650 next_node_id, next_blinding_override
651 })), Some((next_hop_hmac, new_packet_bytes)))) => {
652 // TODO: we need to check whether `next_node_id` is our node, in which case this is a dummy
653 // blinded hop and this onion message is destined for us. In this situation, we should keep
654 // unwrapping the onion layers to get to the final payload. Since we don't have the option
655 // of creating blinded paths with dummy hops currently, we should be ok to not handle this
657 let new_pubkey = match onion_utils::next_hop_pubkey(&secp_ctx, msg.onion_routing_packet.public_key, &onion_decode_ss) {
660 log_trace!(logger, "Failed to compute next hop packet pubkey: {}", e);
664 let outgoing_packet = Packet {
666 public_key: new_pubkey,
667 hop_data: new_packet_bytes,
670 let onion_message = OnionMessage {
671 blinding_point: match next_blinding_override {
672 Some(blinding_point) => blinding_point,
674 match onion_utils::next_hop_pubkey(
675 &secp_ctx, msg.blinding_point, control_tlvs_ss.as_ref()
679 log_trace!(logger, "Failed to compute next blinding point: {}", e);
685 onion_routing_packet: outgoing_packet,
688 Ok(PeeledOnion::Forward(next_node_id, onion_message))
691 log_trace!(logger, "Errored decoding onion message packet: {:?}", e);
695 log_trace!(logger, "Received bogus onion message packet, either the sender encoded a final hop as a forwarding hop or vice versa");
701 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref>
702 OnionMessenger<ES, NS, L, MR, OMH, CMH>
704 ES::Target: EntropySource,
705 NS::Target: NodeSigner,
707 MR::Target: MessageRouter,
708 OMH::Target: OffersMessageHandler,
709 CMH::Target: CustomOnionMessageHandler,
711 /// Constructs a new `OnionMessenger` to send, forward, and delegate received onion messages to
712 /// their respective handlers.
714 entropy_source: ES, node_signer: NS, logger: L, message_router: MR, offers_handler: OMH,
717 let mut secp_ctx = Secp256k1::new();
718 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
722 message_recipients: Mutex::new(new_hash_map()),
732 pub(crate) fn set_offers_handler(&mut self, offers_handler: OMH) {
733 self.offers_handler = offers_handler;
736 /// Sends an [`OnionMessage`] with the given `contents` to `destination`.
738 /// See [`OnionMessenger`] for example usage.
739 pub fn send_onion_message<T: OnionMessageContents>(
740 &self, contents: T, destination: Destination, reply_path: Option<BlindedPath>
741 ) -> Result<SendSuccess, SendError> {
742 self.find_path_and_enqueue_onion_message(
743 contents, destination, reply_path, format_args!("")
747 fn find_path_and_enqueue_onion_message<T: OnionMessageContents>(
748 &self, contents: T, destination: Destination, reply_path: Option<BlindedPath>,
749 log_suffix: fmt::Arguments
750 ) -> Result<SendSuccess, SendError> {
751 let mut logger = WithContext::from(&self.logger, None, None);
752 let result = self.find_path(destination)
754 let first_hop = path.intermediate_nodes.get(0).map(|p| *p);
755 logger = WithContext::from(&self.logger, first_hop, None);
756 self.enqueue_onion_message(path, contents, reply_path, log_suffix)
759 match result.as_ref() {
760 Err(SendError::GetNodeIdFailed) => {
761 log_warn!(logger, "Unable to retrieve node id {}", log_suffix);
763 Err(SendError::PathNotFound) => {
764 log_trace!(logger, "Failed to find path {}", log_suffix);
767 log_trace!(logger, "Failed sending onion message {}: {:?}", log_suffix, e);
769 Ok(SendSuccess::Buffered) => {
770 log_trace!(logger, "Buffered onion message {}", log_suffix);
772 Ok(SendSuccess::BufferedAwaitingConnection(node_id)) => {
775 "Buffered onion message waiting on peer connection {}: {}",
784 fn find_path(&self, destination: Destination) -> Result<OnionMessagePath, SendError> {
785 let sender = self.node_signer
786 .get_node_id(Recipient::Node)
787 .map_err(|_| SendError::GetNodeIdFailed)?;
789 let peers = self.message_recipients.lock().unwrap()
791 .filter(|(_, recipient)| matches!(recipient, OnionMessageRecipient::ConnectedPeer(_)))
792 .map(|(node_id, _)| *node_id)
796 .find_path(sender, peers, destination)
797 .map_err(|_| SendError::PathNotFound)
800 fn enqueue_onion_message<T: OnionMessageContents>(
801 &self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,
802 log_suffix: fmt::Arguments
803 ) -> Result<SendSuccess, SendError> {
804 log_trace!(self.logger, "Constructing onion message {}: {:?}", log_suffix, contents);
806 let (first_node_id, onion_message, addresses) = create_onion_message(
807 &self.entropy_source, &self.node_signer, &self.secp_ctx, path, contents, reply_path
810 let mut message_recipients = self.message_recipients.lock().unwrap();
811 if outbound_buffer_full(&first_node_id, &message_recipients) {
812 return Err(SendError::BufferFull);
815 match message_recipients.entry(first_node_id) {
816 hash_map::Entry::Vacant(e) => match addresses {
817 None => Err(SendError::InvalidFirstHop(first_node_id)),
819 e.insert(OnionMessageRecipient::pending_connection(addresses))
820 .enqueue_message(onion_message);
821 Ok(SendSuccess::BufferedAwaitingConnection(first_node_id))
824 hash_map::Entry::Occupied(mut e) => {
825 e.get_mut().enqueue_message(onion_message);
826 if e.get().is_connected() {
827 Ok(SendSuccess::Buffered)
829 Ok(SendSuccess::BufferedAwaitingConnection(first_node_id))
835 #[cfg(any(test, feature = "_test_utils"))]
836 pub fn send_onion_message_using_path<T: OnionMessageContents>(
837 &self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>
838 ) -> Result<SendSuccess, SendError> {
839 self.enqueue_onion_message(path, contents, reply_path, format_args!(""))
842 pub(crate) fn peel_onion_message(
843 &self, msg: &OnionMessage
844 ) -> Result<PeeledOnion<<<CMH>::Target as CustomOnionMessageHandler>::CustomMessage>, ()> {
846 msg, &self.secp_ctx, &*self.node_signer, &*self.logger, &*self.custom_handler
850 fn handle_onion_message_response<T: OnionMessageContents>(
851 &self, response: Option<T>, reply_path: Option<BlindedPath>, log_suffix: fmt::Arguments
853 if let Some(response) = response {
855 Some(reply_path) => {
856 let _ = self.find_path_and_enqueue_onion_message(
857 response, Destination::BlindedPath(reply_path), None, log_suffix
861 log_trace!(self.logger, "Missing reply path {}", log_suffix);
868 pub(super) fn release_pending_msgs(&self) -> HashMap<PublicKey, VecDeque<OnionMessage>> {
869 let mut message_recipients = self.message_recipients.lock().unwrap();
870 let mut msgs = new_hash_map();
871 // We don't want to disconnect the peers by removing them entirely from the original map, so we
872 // release the pending message buffers individually.
873 for (node_id, recipient) in &mut *message_recipients {
874 msgs.insert(*node_id, recipient.release_pending_messages());
880 fn outbound_buffer_full(peer_node_id: &PublicKey, buffer: &HashMap<PublicKey, OnionMessageRecipient>) -> bool {
881 const MAX_TOTAL_BUFFER_SIZE: usize = (1 << 20) * 128;
882 const MAX_PER_PEER_BUFFER_SIZE: usize = (1 << 10) * 256;
883 let mut total_buffered_bytes = 0;
884 let mut peer_buffered_bytes = 0;
885 for (pk, peer_buf) in buffer {
886 for om in peer_buf.pending_messages() {
887 let om_len = om.serialized_length();
888 if pk == peer_node_id {
889 peer_buffered_bytes += om_len;
891 total_buffered_bytes += om_len;
893 if total_buffered_bytes >= MAX_TOTAL_BUFFER_SIZE ||
894 peer_buffered_bytes >= MAX_PER_PEER_BUFFER_SIZE
903 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref> EventsProvider
904 for OnionMessenger<ES, NS, L, MR, OMH, CMH>
906 ES::Target: EntropySource,
907 NS::Target: NodeSigner,
909 MR::Target: MessageRouter,
910 OMH::Target: OffersMessageHandler,
911 CMH::Target: CustomOnionMessageHandler,
913 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
914 for (node_id, recipient) in self.message_recipients.lock().unwrap().iter_mut() {
915 if let OnionMessageRecipient::PendingConnection(_, addresses, _) = recipient {
916 if let Some(addresses) = addresses.take() {
917 handler.handle_event(Event::ConnectionNeeded { node_id: *node_id, addresses });
924 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref> OnionMessageHandler
925 for OnionMessenger<ES, NS, L, MR, OMH, CMH>
927 ES::Target: EntropySource,
928 NS::Target: NodeSigner,
930 MR::Target: MessageRouter,
931 OMH::Target: OffersMessageHandler,
932 CMH::Target: CustomOnionMessageHandler,
934 fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage) {
935 let logger = WithContext::from(&self.logger, Some(*peer_node_id), None);
936 match self.peel_onion_message(msg) {
937 Ok(PeeledOnion::Receive(message, path_id, reply_path)) => {
940 "Received an onion message with path_id {:02x?} and {} reply_path: {:?}",
941 path_id, if reply_path.is_some() { "a" } else { "no" }, message);
944 ParsedOnionMessageContents::Offers(msg) => {
945 let response = self.offers_handler.handle_message(msg);
946 self.handle_onion_message_response(
947 response, reply_path, format_args!(
948 "when responding to Offers onion message with path_id {:02x?}",
953 ParsedOnionMessageContents::Custom(msg) => {
954 let response = self.custom_handler.handle_custom_message(msg);
955 self.handle_onion_message_response(
956 response, reply_path, format_args!(
957 "when responding to Custom onion message with path_id {:02x?}",
964 Ok(PeeledOnion::Forward(next_node_id, onion_message)) => {
965 let mut message_recipients = self.message_recipients.lock().unwrap();
966 if outbound_buffer_full(&next_node_id, &message_recipients) {
969 "Dropping forwarded onion message to peer {}: outbound buffer full",
977 .or_insert_with(|| OnionMessageRecipient::ConnectedPeer(VecDeque::new()));
979 match message_recipients.entry(next_node_id) {
980 hash_map::Entry::Occupied(mut e) if matches!(
981 e.get(), OnionMessageRecipient::ConnectedPeer(..)
983 e.get_mut().enqueue_message(onion_message);
984 log_trace!(logger, "Forwarding an onion message to peer {}", next_node_id);
989 "Dropping forwarded onion message to disconnected peer {}",
996 log_error!(logger, "Failed to process onion message {:?}", e);
1001 fn peer_connected(&self, their_node_id: &PublicKey, init: &msgs::Init, _inbound: bool) -> Result<(), ()> {
1002 if init.features.supports_onion_messages() {
1003 self.message_recipients.lock().unwrap()
1004 .entry(*their_node_id)
1005 .or_insert_with(|| OnionMessageRecipient::ConnectedPeer(VecDeque::new()))
1008 self.message_recipients.lock().unwrap().remove(their_node_id);
1014 fn peer_disconnected(&self, their_node_id: &PublicKey) {
1015 match self.message_recipients.lock().unwrap().remove(their_node_id) {
1016 Some(OnionMessageRecipient::ConnectedPeer(..)) => {},
1017 Some(_) => debug_assert!(false),
1022 fn timer_tick_occurred(&self) {
1023 let mut message_recipients = self.message_recipients.lock().unwrap();
1025 // Drop any pending recipients since the last call to avoid retaining buffered messages for
1027 message_recipients.retain(|_, recipient| match recipient {
1028 OnionMessageRecipient::PendingConnection(_, None, ticks) => *ticks < MAX_TIMER_TICKS,
1029 OnionMessageRecipient::PendingConnection(_, Some(_), _) => true,
1033 // Increment a timer tick for pending recipients so that their buffered messages are dropped
1034 // at MAX_TIMER_TICKS.
1035 for recipient in message_recipients.values_mut() {
1036 if let OnionMessageRecipient::PendingConnection(_, None, ticks) = recipient {
1042 fn provided_node_features(&self) -> NodeFeatures {
1043 let mut features = NodeFeatures::empty();
1044 features.set_onion_messages_optional();
1048 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
1049 let mut features = InitFeatures::empty();
1050 features.set_onion_messages_optional();
1054 // Before returning any messages to send for the peer, this method will see if any messages were
1055 // enqueued in the handler by users, find a path to the corresponding blinded path's introduction
1056 // node, and then enqueue the message for sending to the first peer in the full path.
1057 fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<OnionMessage> {
1058 // Enqueue any initiating `OffersMessage`s to send.
1059 for message in self.offers_handler.release_pending_messages() {
1060 #[cfg(not(c_bindings))]
1061 let PendingOnionMessage { contents, destination, reply_path } = message;
1063 let (contents, destination, reply_path) = message;
1064 let _ = self.find_path_and_enqueue_onion_message(
1065 contents, destination, reply_path, format_args!("when sending OffersMessage")
1069 // Enqueue any initiating `CustomMessage`s to send.
1070 for message in self.custom_handler.release_pending_custom_messages() {
1071 #[cfg(not(c_bindings))]
1072 let PendingOnionMessage { contents, destination, reply_path } = message;
1074 let (contents, destination, reply_path) = message;
1075 let _ = self.find_path_and_enqueue_onion_message(
1076 contents, destination, reply_path, format_args!("when sending CustomMessage")
1080 self.message_recipients.lock().unwrap()
1081 .get_mut(&peer_node_id)
1082 .and_then(|buffer| buffer.dequeue_message())
1086 // TODO: parameterize the below Simple* types with OnionMessenger and handle the messages it
1088 /// Useful for simplifying the parameters of [`SimpleArcChannelManager`] and
1089 /// [`SimpleArcPeerManager`]. See their docs for more details.
1091 /// This is not exported to bindings users as type aliases aren't supported in most languages.
1093 /// [`SimpleArcChannelManager`]: crate::ln::channelmanager::SimpleArcChannelManager
1094 /// [`SimpleArcPeerManager`]: crate::ln::peer_handler::SimpleArcPeerManager
1095 #[cfg(not(c_bindings))]
1096 pub type SimpleArcOnionMessenger<M, T, F, L> = OnionMessenger<
1100 Arc<DefaultMessageRouter<Arc<NetworkGraph<Arc<L>>>, Arc<L>, Arc<KeysManager>>>,
1101 Arc<SimpleArcChannelManager<M, T, F, L>>,
1102 IgnoringMessageHandler
1105 /// Useful for simplifying the parameters of [`SimpleRefChannelManager`] and
1106 /// [`SimpleRefPeerManager`]. See their docs for more details.
1108 /// This is not exported to bindings users as type aliases aren't supported in most languages.
1110 /// [`SimpleRefChannelManager`]: crate::ln::channelmanager::SimpleRefChannelManager
1111 /// [`SimpleRefPeerManager`]: crate::ln::peer_handler::SimpleRefPeerManager
1112 #[cfg(not(c_bindings))]
1113 pub type SimpleRefOnionMessenger<
1114 'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i, 'j, M, T, F, L
1119 &'i DefaultMessageRouter<&'g NetworkGraph<&'b L>, &'b L, &'a KeysManager>,
1120 &'j SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L>,
1121 IgnoringMessageHandler
1124 /// Construct onion packet payloads and keys for sending an onion message along the given
1125 /// `unblinded_path` to the given `destination`.
1126 fn packet_payloads_and_keys<T: OnionMessageContents, S: secp256k1::Signing + secp256k1::Verification>(
1127 secp_ctx: &Secp256k1<S>, unblinded_path: &[PublicKey], destination: Destination, message: T,
1128 mut reply_path: Option<BlindedPath>, session_priv: &SecretKey
1129 ) -> Result<(Vec<(Payload<T>, [u8; 32])>, Vec<onion_utils::OnionKeys>), secp256k1::Error> {
1130 let num_hops = unblinded_path.len() + destination.num_hops();
1131 let mut payloads = Vec::with_capacity(num_hops);
1132 let mut onion_packet_keys = Vec::with_capacity(num_hops);
1134 let (mut intro_node_id_blinding_pt, num_blinded_hops) = if let Destination::BlindedPath(BlindedPath {
1135 introduction_node_id, blinding_point, blinded_hops }) = &destination {
1136 (Some((*introduction_node_id, *blinding_point)), blinded_hops.len()) } else { (None, 0) };
1137 let num_unblinded_hops = num_hops - num_blinded_hops;
1139 let mut unblinded_path_idx = 0;
1140 let mut blinded_path_idx = 0;
1141 let mut prev_control_tlvs_ss = None;
1142 let mut final_control_tlvs = None;
1143 utils::construct_keys_callback(secp_ctx, unblinded_path.iter(), Some(destination), session_priv,
1144 |_, onion_packet_ss, ephemeral_pubkey, control_tlvs_ss, unblinded_pk_opt, enc_payload_opt| {
1145 if num_unblinded_hops != 0 && unblinded_path_idx < num_unblinded_hops {
1146 if let Some(ss) = prev_control_tlvs_ss.take() {
1147 payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(
1149 next_node_id: unblinded_pk_opt.unwrap(),
1150 next_blinding_override: None,
1154 prev_control_tlvs_ss = Some(control_tlvs_ss);
1155 unblinded_path_idx += 1;
1156 } else if let Some((intro_node_id, blinding_pt)) = intro_node_id_blinding_pt.take() {
1157 if let Some(control_tlvs_ss) = prev_control_tlvs_ss.take() {
1158 payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
1159 next_node_id: intro_node_id,
1160 next_blinding_override: Some(blinding_pt),
1161 })), control_tlvs_ss));
1164 if blinded_path_idx < num_blinded_hops.saturating_sub(1) && enc_payload_opt.is_some() {
1165 payloads.push((Payload::Forward(ForwardControlTlvs::Blinded(enc_payload_opt.unwrap())),
1167 blinded_path_idx += 1;
1168 } else if let Some(encrypted_payload) = enc_payload_opt {
1169 final_control_tlvs = Some(ReceiveControlTlvs::Blinded(encrypted_payload));
1170 prev_control_tlvs_ss = Some(control_tlvs_ss);
1173 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(onion_packet_ss.as_ref());
1174 onion_packet_keys.push(onion_utils::OnionKeys {
1176 shared_secret: onion_packet_ss,
1178 blinding_factor: [0; 32],
1186 if let Some(control_tlvs) = final_control_tlvs {
1187 payloads.push((Payload::Receive {
1189 reply_path: reply_path.take(),
1191 }, prev_control_tlvs_ss.unwrap()));
1193 payloads.push((Payload::Receive {
1194 control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id: None, }),
1195 reply_path: reply_path.take(),
1197 }, prev_control_tlvs_ss.unwrap()));
1200 Ok((payloads, onion_packet_keys))
1203 /// Errors if the serialized payload size exceeds onion_message::BIG_PACKET_HOP_DATA_LEN
1204 fn construct_onion_message_packet<T: OnionMessageContents>(payloads: Vec<(Payload<T>, [u8; 32])>, onion_keys: Vec<onion_utils::OnionKeys>, prng_seed: [u8; 32]) -> Result<Packet, ()> {
1206 // "`len` allows larger messages to be sent than the standard 1300 bytes allowed for an HTLC
1207 // onion, but this should be used sparingly as it is reduces anonymity set, hence the
1208 // recommendation that it either look like an HTLC onion, or if larger, be a fixed size."
1209 let payloads_ser_len = onion_utils::payloads_serialized_length(&payloads);
1210 let hop_data_len = if payloads_ser_len <= SMALL_PACKET_HOP_DATA_LEN {
1211 SMALL_PACKET_HOP_DATA_LEN
1212 } else if payloads_ser_len <= BIG_PACKET_HOP_DATA_LEN {
1213 BIG_PACKET_HOP_DATA_LEN
1214 } else { return Err(()) };
1216 onion_utils::construct_onion_message_packet::<_, _>(
1217 payloads, onion_keys, prng_seed, hop_data_len)