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;
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<ES: EntropySource + ?Sized, T: secp256k1::Signing + secp256k1::Verification>(
100 /// # &self, _recipient: PublicKey, _peers: Vec<PublicKey>, _entropy_source: &ES, _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 ES: EntropySource + ?Sized, T: secp256k1::Signing + secp256k1::Verification
290 &self, recipient: PublicKey, peers: Vec<PublicKey>, entropy_source: &ES,
291 secp_ctx: &Secp256k1<T>
292 ) -> Result<Vec<BlindedPath>, ()>;
295 /// A [`MessageRouter`] that can only route to a directly connected [`Destination`].
296 pub struct DefaultMessageRouter<G: Deref<Target=NetworkGraph<L>>, L: Deref>
303 impl<G: Deref<Target=NetworkGraph<L>>, L: Deref> DefaultMessageRouter<G, L>
307 /// Creates a [`DefaultMessageRouter`] using the given [`NetworkGraph`].
308 pub fn new(network_graph: G) -> Self {
309 Self { network_graph }
313 impl<G: Deref<Target=NetworkGraph<L>>, L: Deref> MessageRouter for DefaultMessageRouter<G, L>
318 &self, _sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
319 ) -> Result<OnionMessagePath, ()> {
320 let first_node = destination.first_node();
321 if peers.contains(&first_node) {
322 Ok(OnionMessagePath {
323 intermediate_nodes: vec![], destination, first_node_addresses: None
326 let network_graph = self.network_graph.deref().read_only();
327 let node_announcement = network_graph
328 .node(&NodeId::from_pubkey(&first_node))
329 .and_then(|node_info| node_info.announcement_info.as_ref())
330 .and_then(|announcement_info| announcement_info.announcement_message.as_ref())
331 .map(|node_announcement| &node_announcement.contents);
333 match node_announcement {
334 Some(node_announcement) if node_announcement.features.supports_onion_messages() => {
335 let first_node_addresses = Some(node_announcement.addresses.clone());
336 Ok(OnionMessagePath {
337 intermediate_nodes: vec![], destination, first_node_addresses
345 fn create_blinded_paths<
346 ES: EntropySource + ?Sized, T: secp256k1::Signing + secp256k1::Verification
348 &self, recipient: PublicKey, peers: Vec<PublicKey>, entropy_source: &ES,
349 secp_ctx: &Secp256k1<T>
350 ) -> Result<Vec<BlindedPath>, ()> {
351 // Limit the number of blinded paths that are computed.
352 const MAX_PATHS: usize = 3;
354 // Ensure peers have at least three channels so that it is more difficult to infer the
355 // recipient's node_id.
356 const MIN_PEER_CHANNELS: usize = 3;
358 let network_graph = self.network_graph.deref().read_only();
359 let paths = peers.iter()
360 // Limit to peers with announced channels
363 .node(&NodeId::from_pubkey(pubkey))
364 .map(|info| &info.channels[..])
365 .map(|channels| channels.len() >= MIN_PEER_CHANNELS)
368 .map(|pubkey| vec![*pubkey, recipient])
369 .map(|node_pks| BlindedPath::new_for_message(&node_pks, entropy_source, secp_ctx))
371 .collect::<Result<Vec<_>, _>>();
374 Ok(paths) if !paths.is_empty() => Ok(paths),
376 if network_graph.nodes().contains_key(&NodeId::from_pubkey(&recipient)) {
377 BlindedPath::one_hop_for_message(recipient, entropy_source, secp_ctx)
378 .map(|path| vec![path])
387 /// A path for sending an [`OnionMessage`].
389 pub struct OnionMessagePath {
390 /// Nodes on the path between the sender and the destination.
391 pub intermediate_nodes: Vec<PublicKey>,
393 /// The recipient of the message.
394 pub destination: Destination,
396 /// Addresses that may be used to connect to [`OnionMessagePath::first_node`].
398 /// Only needs to be set if a connection to the node is required. [`OnionMessenger`] may use
399 /// this to initiate such a connection.
400 pub first_node_addresses: Option<Vec<SocketAddress>>,
403 impl OnionMessagePath {
404 /// Returns the first node in the path.
405 pub fn first_node(&self) -> PublicKey {
406 self.intermediate_nodes
409 .unwrap_or_else(|| self.destination.first_node())
413 /// The destination of an onion message.
415 pub enum Destination {
416 /// We're sending this onion message to a node.
418 /// We're sending this onion message to a blinded path.
419 BlindedPath(BlindedPath),
423 pub(super) fn num_hops(&self) -> usize {
425 Destination::Node(_) => 1,
426 Destination::BlindedPath(BlindedPath { blinded_hops, .. }) => blinded_hops.len(),
430 fn first_node(&self) -> PublicKey {
432 Destination::Node(node_id) => *node_id,
433 Destination::BlindedPath(BlindedPath { introduction_node_id: node_id, .. }) => *node_id,
438 /// Result of successfully [sending an onion message].
440 /// [sending an onion message]: OnionMessenger::send_onion_message
441 #[derive(Debug, PartialEq, Eq)]
442 pub enum SendSuccess {
443 /// The message was buffered and will be sent once it is processed by
444 /// [`OnionMessageHandler::next_onion_message_for_peer`].
446 /// The message was buffered and will be sent once the node is connected as a peer and it is
447 /// processed by [`OnionMessageHandler::next_onion_message_for_peer`].
448 BufferedAwaitingConnection(PublicKey),
451 /// Errors that may occur when [sending an onion message].
453 /// [sending an onion message]: OnionMessenger::send_onion_message
454 #[derive(Debug, PartialEq, Eq)]
456 /// Errored computing onion message packet keys.
457 Secp256k1(secp256k1::Error),
458 /// Because implementations such as Eclair will drop onion messages where the message packet
459 /// exceeds 32834 bytes, we refuse to send messages where the packet exceeds this size.
461 /// The provided [`Destination`] was an invalid [`BlindedPath`] due to not having any blinded
464 /// The first hop is not a peer and doesn't have a known [`SocketAddress`].
465 InvalidFirstHop(PublicKey),
466 /// A path from the sender to the destination could not be found by the [`MessageRouter`].
468 /// Onion message contents must have a TLV type >= 64.
470 /// Our next-hop peer's buffer was full or our total outbound buffer was full.
472 /// Failed to retrieve our node id from the provided [`NodeSigner`].
474 /// [`NodeSigner`]: crate::sign::NodeSigner
476 /// We attempted to send to a blinded path where we are the introduction node, and failed to
477 /// advance the blinded path to make the second hop the new introduction node. Either
478 /// [`NodeSigner::ecdh`] failed, we failed to tweak the current blinding point to get the
479 /// new blinding point, or we were attempting to send to ourselves.
480 BlindedPathAdvanceFailed,
483 /// Handler for custom onion messages. If you are using [`SimpleArcOnionMessenger`],
484 /// [`SimpleRefOnionMessenger`], or prefer to ignore inbound custom onion messages,
485 /// [`IgnoringMessageHandler`] must be provided to [`OnionMessenger::new`]. Otherwise, a custom
486 /// implementation of this trait must be provided, with [`CustomMessage`] specifying the supported
489 /// See [`OnionMessenger`] for example usage.
491 /// [`IgnoringMessageHandler`]: crate::ln::peer_handler::IgnoringMessageHandler
492 /// [`CustomMessage`]: Self::CustomMessage
493 pub trait CustomOnionMessageHandler {
494 /// The message known to the handler. To support multiple message types, you may want to make this
495 /// an enum with a variant for each supported message.
496 type CustomMessage: OnionMessageContents;
498 /// Called with the custom message that was received, returning a response to send, if any.
500 /// The returned [`Self::CustomMessage`], if any, is enqueued to be sent by [`OnionMessenger`].
501 fn handle_custom_message(&self, msg: Self::CustomMessage) -> Option<Self::CustomMessage>;
503 /// Read a custom message of type `message_type` from `buffer`, returning `Ok(None)` if the
504 /// message type is unknown.
505 fn read_custom_message<R: io::Read>(&self, message_type: u64, buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError>;
507 /// Releases any [`Self::CustomMessage`]s that need to be sent.
509 /// Typically, this is used for messages initiating a message flow rather than in response to
510 /// another message. The latter should use the return value of [`Self::handle_custom_message`].
511 #[cfg(not(c_bindings))]
512 fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Self::CustomMessage>>;
514 /// Releases any [`Self::CustomMessage`]s that need to be sent.
516 /// Typically, this is used for messages initiating a message flow rather than in response to
517 /// another message. The latter should use the return value of [`Self::handle_custom_message`].
519 fn release_pending_custom_messages(&self) -> Vec<(Self::CustomMessage, Destination, Option<BlindedPath>)>;
522 /// A processed incoming onion message, containing either a Forward (another onion message)
523 /// or a Receive payload with decrypted contents.
524 pub enum PeeledOnion<T: OnionMessageContents> {
525 /// Forwarded onion, with the next node id and a new onion
526 Forward(PublicKey, OnionMessage),
527 /// Received onion message, with decrypted contents, path_id, and reply path
528 Receive(ParsedOnionMessageContents<T>, Option<[u8; 32]>, Option<BlindedPath>)
531 /// Creates an [`OnionMessage`] with the given `contents` for sending to the destination of
534 /// Returns the node id of the peer to send the message to, the message itself, and any addresses
535 /// need to connect to the first node.
536 pub fn create_onion_message<ES: Deref, NS: Deref, T: OnionMessageContents>(
537 entropy_source: &ES, node_signer: &NS, secp_ctx: &Secp256k1<secp256k1::All>,
538 path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,
539 ) -> Result<(PublicKey, OnionMessage, Option<Vec<SocketAddress>>), SendError>
541 ES::Target: EntropySource,
542 NS::Target: NodeSigner,
544 let OnionMessagePath { intermediate_nodes, mut destination, first_node_addresses } = path;
545 if let Destination::BlindedPath(BlindedPath { ref blinded_hops, .. }) = destination {
546 if blinded_hops.is_empty() {
547 return Err(SendError::TooFewBlindedHops);
551 if contents.tlv_type() < 64 { return Err(SendError::InvalidMessage) }
553 // If we are sending straight to a blinded path and we are the introduction node, we need to
554 // advance the blinded path by 1 hop so the second hop is the new introduction node.
555 if intermediate_nodes.len() == 0 {
556 if let Destination::BlindedPath(ref mut blinded_path) = destination {
557 let our_node_id = node_signer.get_node_id(Recipient::Node)
558 .map_err(|()| SendError::GetNodeIdFailed)?;
559 if blinded_path.introduction_node_id == our_node_id {
560 advance_path_by_one(blinded_path, node_signer, &secp_ctx)
561 .map_err(|()| SendError::BlindedPathAdvanceFailed)?;
566 let blinding_secret_bytes = entropy_source.get_secure_random_bytes();
567 let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
568 let (first_node_id, blinding_point) = if let Some(first_node_id) = intermediate_nodes.first() {
569 (*first_node_id, PublicKey::from_secret_key(&secp_ctx, &blinding_secret))
572 Destination::Node(pk) => (pk, PublicKey::from_secret_key(&secp_ctx, &blinding_secret)),
573 Destination::BlindedPath(BlindedPath { introduction_node_id, blinding_point, .. }) =>
574 (introduction_node_id, blinding_point),
577 let (packet_payloads, packet_keys) = packet_payloads_and_keys(
578 &secp_ctx, &intermediate_nodes, destination, contents, reply_path, &blinding_secret)
579 .map_err(|e| SendError::Secp256k1(e))?;
581 let prng_seed = entropy_source.get_secure_random_bytes();
582 let onion_routing_packet = construct_onion_message_packet(
583 packet_payloads, packet_keys, prng_seed).map_err(|()| SendError::TooBigPacket)?;
585 let message = OnionMessage { blinding_point, onion_routing_packet };
586 Ok((first_node_id, message, first_node_addresses))
589 /// Decode one layer of an incoming [`OnionMessage`].
591 /// Returns either the next layer of the onion for forwarding or the decrypted content for the
593 pub fn peel_onion_message<NS: Deref, L: Deref, CMH: Deref>(
594 msg: &OnionMessage, secp_ctx: &Secp256k1<secp256k1::All>, node_signer: NS, logger: L,
596 ) -> Result<PeeledOnion<<<CMH>::Target as CustomOnionMessageHandler>::CustomMessage>, ()>
598 NS::Target: NodeSigner,
600 CMH::Target: CustomOnionMessageHandler,
602 let control_tlvs_ss = match node_signer.ecdh(Recipient::Node, &msg.blinding_point, None) {
605 log_error!(logger, "Failed to retrieve node secret: {:?}", e);
609 let onion_decode_ss = {
610 let blinding_factor = {
611 let mut hmac = HmacEngine::<Sha256>::new(b"blinded_node_id");
612 hmac.input(control_tlvs_ss.as_ref());
613 Hmac::from_engine(hmac).to_byte_array()
615 match node_signer.ecdh(Recipient::Node, &msg.onion_routing_packet.public_key,
616 Some(&Scalar::from_be_bytes(blinding_factor).unwrap()))
618 Ok(ss) => ss.secret_bytes(),
620 log_trace!(logger, "Failed to compute onion packet shared secret");
625 match onion_utils::decode_next_untagged_hop(
626 onion_decode_ss, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac,
627 (control_tlvs_ss, custom_handler.deref(), logger.deref())
629 Ok((Payload::Receive::<ParsedOnionMessageContents<<<CMH as Deref>::Target as CustomOnionMessageHandler>::CustomMessage>> {
630 message, control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id }), reply_path,
632 Ok(PeeledOnion::Receive(message, path_id, reply_path))
634 Ok((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
635 next_node_id, next_blinding_override
636 })), Some((next_hop_hmac, new_packet_bytes)))) => {
637 // TODO: we need to check whether `next_node_id` is our node, in which case this is a dummy
638 // blinded hop and this onion message is destined for us. In this situation, we should keep
639 // unwrapping the onion layers to get to the final payload. Since we don't have the option
640 // of creating blinded paths with dummy hops currently, we should be ok to not handle this
642 let new_pubkey = match onion_utils::next_hop_pubkey(&secp_ctx, msg.onion_routing_packet.public_key, &onion_decode_ss) {
645 log_trace!(logger, "Failed to compute next hop packet pubkey: {}", e);
649 let outgoing_packet = Packet {
651 public_key: new_pubkey,
652 hop_data: new_packet_bytes,
655 let onion_message = OnionMessage {
656 blinding_point: match next_blinding_override {
657 Some(blinding_point) => blinding_point,
659 match onion_utils::next_hop_pubkey(
660 &secp_ctx, msg.blinding_point, control_tlvs_ss.as_ref()
664 log_trace!(logger, "Failed to compute next blinding point: {}", e);
670 onion_routing_packet: outgoing_packet,
673 Ok(PeeledOnion::Forward(next_node_id, onion_message))
676 log_trace!(logger, "Errored decoding onion message packet: {:?}", e);
680 log_trace!(logger, "Received bogus onion message packet, either the sender encoded a final hop as a forwarding hop or vice versa");
686 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref>
687 OnionMessenger<ES, NS, L, MR, OMH, CMH>
689 ES::Target: EntropySource,
690 NS::Target: NodeSigner,
692 MR::Target: MessageRouter,
693 OMH::Target: OffersMessageHandler,
694 CMH::Target: CustomOnionMessageHandler,
696 /// Constructs a new `OnionMessenger` to send, forward, and delegate received onion messages to
697 /// their respective handlers.
699 entropy_source: ES, node_signer: NS, logger: L, message_router: MR, offers_handler: OMH,
702 let mut secp_ctx = Secp256k1::new();
703 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
707 message_recipients: Mutex::new(HashMap::new()),
717 pub(crate) fn set_offers_handler(&mut self, offers_handler: OMH) {
718 self.offers_handler = offers_handler;
721 /// Sends an [`OnionMessage`] with the given `contents` to `destination`.
723 /// See [`OnionMessenger`] for example usage.
724 pub fn send_onion_message<T: OnionMessageContents>(
725 &self, contents: T, destination: Destination, reply_path: Option<BlindedPath>
726 ) -> Result<SendSuccess, SendError> {
727 self.find_path_and_enqueue_onion_message(
728 contents, destination, reply_path, format_args!("")
732 fn find_path_and_enqueue_onion_message<T: OnionMessageContents>(
733 &self, contents: T, destination: Destination, reply_path: Option<BlindedPath>,
734 log_suffix: fmt::Arguments
735 ) -> Result<SendSuccess, SendError> {
736 let result = self.find_path(destination)
737 .and_then(|path| self.enqueue_onion_message(path, contents, reply_path, log_suffix));
739 match result.as_ref() {
740 Err(SendError::GetNodeIdFailed) => {
741 log_warn!(self.logger, "Unable to retrieve node id {}", log_suffix);
743 Err(SendError::PathNotFound) => {
744 log_trace!(self.logger, "Failed to find path {}", log_suffix);
747 log_trace!(self.logger, "Failed sending onion message {}: {:?}", log_suffix, e);
749 Ok(SendSuccess::Buffered) => {
750 log_trace!(self.logger, "Buffered onion message {}", log_suffix);
752 Ok(SendSuccess::BufferedAwaitingConnection(node_id)) => {
754 self.logger, "Buffered onion message waiting on peer connection {}: {:?}",
763 fn find_path(&self, destination: Destination) -> Result<OnionMessagePath, SendError> {
764 let sender = self.node_signer
765 .get_node_id(Recipient::Node)
766 .map_err(|_| SendError::GetNodeIdFailed)?;
768 let peers = self.message_recipients.lock().unwrap()
770 .filter(|(_, recipient)| matches!(recipient, OnionMessageRecipient::ConnectedPeer(_)))
771 .map(|(node_id, _)| *node_id)
775 .find_path(sender, peers, destination)
776 .map_err(|_| SendError::PathNotFound)
779 fn enqueue_onion_message<T: OnionMessageContents>(
780 &self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,
781 log_suffix: fmt::Arguments
782 ) -> Result<SendSuccess, SendError> {
783 log_trace!(self.logger, "Constructing onion message {}: {:?}", log_suffix, contents);
785 let (first_node_id, onion_message, addresses) = create_onion_message(
786 &self.entropy_source, &self.node_signer, &self.secp_ctx, path, contents, reply_path
789 let mut message_recipients = self.message_recipients.lock().unwrap();
790 if outbound_buffer_full(&first_node_id, &message_recipients) {
791 return Err(SendError::BufferFull);
794 match message_recipients.entry(first_node_id) {
795 hash_map::Entry::Vacant(e) => match addresses {
796 None => Err(SendError::InvalidFirstHop(first_node_id)),
798 e.insert(OnionMessageRecipient::pending_connection(addresses))
799 .enqueue_message(onion_message);
800 Ok(SendSuccess::BufferedAwaitingConnection(first_node_id))
803 hash_map::Entry::Occupied(mut e) => {
804 e.get_mut().enqueue_message(onion_message);
805 if e.get().is_connected() {
806 Ok(SendSuccess::Buffered)
808 Ok(SendSuccess::BufferedAwaitingConnection(first_node_id))
814 #[cfg(any(test, feature = "_test_utils"))]
815 pub fn send_onion_message_using_path<T: OnionMessageContents>(
816 &self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>
817 ) -> Result<SendSuccess, SendError> {
818 self.enqueue_onion_message(path, contents, reply_path, format_args!(""))
821 pub(crate) fn peel_onion_message(
822 &self, msg: &OnionMessage
823 ) -> Result<PeeledOnion<<<CMH>::Target as CustomOnionMessageHandler>::CustomMessage>, ()> {
825 msg, &self.secp_ctx, &*self.node_signer, &*self.logger, &*self.custom_handler
829 fn handle_onion_message_response<T: OnionMessageContents>(
830 &self, response: Option<T>, reply_path: Option<BlindedPath>, log_suffix: fmt::Arguments
832 if let Some(response) = response {
834 Some(reply_path) => {
835 let _ = self.find_path_and_enqueue_onion_message(
836 response, Destination::BlindedPath(reply_path), None, log_suffix
840 log_trace!(self.logger, "Missing reply path {}", log_suffix);
847 pub(super) fn release_pending_msgs(&self) -> HashMap<PublicKey, VecDeque<OnionMessage>> {
848 let mut message_recipients = self.message_recipients.lock().unwrap();
849 let mut msgs = HashMap::new();
850 // We don't want to disconnect the peers by removing them entirely from the original map, so we
851 // release the pending message buffers individually.
852 for (node_id, recipient) in &mut *message_recipients {
853 msgs.insert(*node_id, recipient.release_pending_messages());
859 fn outbound_buffer_full(peer_node_id: &PublicKey, buffer: &HashMap<PublicKey, OnionMessageRecipient>) -> bool {
860 const MAX_TOTAL_BUFFER_SIZE: usize = (1 << 20) * 128;
861 const MAX_PER_PEER_BUFFER_SIZE: usize = (1 << 10) * 256;
862 let mut total_buffered_bytes = 0;
863 let mut peer_buffered_bytes = 0;
864 for (pk, peer_buf) in buffer {
865 for om in peer_buf.pending_messages() {
866 let om_len = om.serialized_length();
867 if pk == peer_node_id {
868 peer_buffered_bytes += om_len;
870 total_buffered_bytes += om_len;
872 if total_buffered_bytes >= MAX_TOTAL_BUFFER_SIZE ||
873 peer_buffered_bytes >= MAX_PER_PEER_BUFFER_SIZE
882 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref> EventsProvider
883 for OnionMessenger<ES, NS, L, MR, OMH, CMH>
885 ES::Target: EntropySource,
886 NS::Target: NodeSigner,
888 MR::Target: MessageRouter,
889 OMH::Target: OffersMessageHandler,
890 CMH::Target: CustomOnionMessageHandler,
892 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
893 for (node_id, recipient) in self.message_recipients.lock().unwrap().iter_mut() {
894 if let OnionMessageRecipient::PendingConnection(_, addresses, _) = recipient {
895 if let Some(addresses) = addresses.take() {
896 handler.handle_event(Event::ConnectionNeeded { node_id: *node_id, addresses });
903 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref> OnionMessageHandler
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 handle_onion_message(&self, _peer_node_id: &PublicKey, msg: &OnionMessage) {
914 match self.peel_onion_message(msg) {
915 Ok(PeeledOnion::Receive(message, path_id, reply_path)) => {
918 "Received an onion message with path_id {:02x?} and {} reply_path: {:?}",
919 path_id, if reply_path.is_some() { "a" } else { "no" }, message);
922 ParsedOnionMessageContents::Offers(msg) => {
923 let response = self.offers_handler.handle_message(msg);
924 self.handle_onion_message_response(
925 response, reply_path, format_args!(
926 "when responding to Offers onion message with path_id {:02x?}",
931 ParsedOnionMessageContents::Custom(msg) => {
932 let response = self.custom_handler.handle_custom_message(msg);
933 self.handle_onion_message_response(
934 response, reply_path, format_args!(
935 "when responding to Custom onion message with path_id {:02x?}",
942 Ok(PeeledOnion::Forward(next_node_id, onion_message)) => {
943 let mut message_recipients = self.message_recipients.lock().unwrap();
944 if outbound_buffer_full(&next_node_id, &message_recipients) {
945 log_trace!(self.logger, "Dropping forwarded onion message to peer {:?}: outbound buffer full", next_node_id);
952 .or_insert_with(|| OnionMessageRecipient::ConnectedPeer(VecDeque::new()));
954 match message_recipients.entry(next_node_id) {
955 hash_map::Entry::Occupied(mut e) if matches!(
956 e.get(), OnionMessageRecipient::ConnectedPeer(..)
958 e.get_mut().enqueue_message(onion_message);
959 log_trace!(self.logger, "Forwarding an onion message to peer {}", next_node_id);
962 log_trace!(self.logger, "Dropping forwarded onion message to disconnected peer {:?}", next_node_id);
968 log_error!(self.logger, "Failed to process onion message {:?}", e);
973 fn peer_connected(&self, their_node_id: &PublicKey, init: &msgs::Init, _inbound: bool) -> Result<(), ()> {
974 if init.features.supports_onion_messages() {
975 self.message_recipients.lock().unwrap()
976 .entry(*their_node_id)
977 .or_insert_with(|| OnionMessageRecipient::ConnectedPeer(VecDeque::new()))
980 self.message_recipients.lock().unwrap().remove(their_node_id);
986 fn peer_disconnected(&self, their_node_id: &PublicKey) {
987 match self.message_recipients.lock().unwrap().remove(their_node_id) {
988 Some(OnionMessageRecipient::ConnectedPeer(..)) => {},
989 Some(_) => debug_assert!(false),
994 fn timer_tick_occurred(&self) {
995 let mut message_recipients = self.message_recipients.lock().unwrap();
997 // Drop any pending recipients since the last call to avoid retaining buffered messages for
999 message_recipients.retain(|_, recipient| match recipient {
1000 OnionMessageRecipient::PendingConnection(_, None, ticks) => *ticks < MAX_TIMER_TICKS,
1001 OnionMessageRecipient::PendingConnection(_, Some(_), _) => true,
1005 // Increment a timer tick for pending recipients so that their buffered messages are dropped
1006 // at MAX_TIMER_TICKS.
1007 for recipient in message_recipients.values_mut() {
1008 if let OnionMessageRecipient::PendingConnection(_, None, ticks) = recipient {
1014 fn provided_node_features(&self) -> NodeFeatures {
1015 let mut features = NodeFeatures::empty();
1016 features.set_onion_messages_optional();
1020 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
1021 let mut features = InitFeatures::empty();
1022 features.set_onion_messages_optional();
1026 // Before returning any messages to send for the peer, this method will see if any messages were
1027 // enqueued in the handler by users, find a path to the corresponding blinded path's introduction
1028 // node, and then enqueue the message for sending to the first peer in the full path.
1029 fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<OnionMessage> {
1030 // Enqueue any initiating `OffersMessage`s to send.
1031 for message in self.offers_handler.release_pending_messages() {
1032 #[cfg(not(c_bindings))]
1033 let PendingOnionMessage { contents, destination, reply_path } = message;
1035 let (contents, destination, reply_path) = message;
1036 let _ = self.find_path_and_enqueue_onion_message(
1037 contents, destination, reply_path, format_args!("when sending OffersMessage")
1041 // Enqueue any initiating `CustomMessage`s to send.
1042 for message in self.custom_handler.release_pending_custom_messages() {
1043 #[cfg(not(c_bindings))]
1044 let PendingOnionMessage { contents, destination, reply_path } = message;
1046 let (contents, destination, reply_path) = message;
1047 let _ = self.find_path_and_enqueue_onion_message(
1048 contents, destination, reply_path, format_args!("when sending CustomMessage")
1052 self.message_recipients.lock().unwrap()
1053 .get_mut(&peer_node_id)
1054 .and_then(|buffer| buffer.dequeue_message())
1058 // TODO: parameterize the below Simple* types with OnionMessenger and handle the messages it
1060 /// Useful for simplifying the parameters of [`SimpleArcChannelManager`] and
1061 /// [`SimpleArcPeerManager`]. See their docs for more details.
1063 /// This is not exported to bindings users as type aliases aren't supported in most languages.
1065 /// [`SimpleArcChannelManager`]: crate::ln::channelmanager::SimpleArcChannelManager
1066 /// [`SimpleArcPeerManager`]: crate::ln::peer_handler::SimpleArcPeerManager
1067 #[cfg(not(c_bindings))]
1068 pub type SimpleArcOnionMessenger<M, T, F, L> = OnionMessenger<
1072 Arc<DefaultMessageRouter<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>,
1073 Arc<SimpleArcChannelManager<M, T, F, L>>,
1074 IgnoringMessageHandler
1077 /// Useful for simplifying the parameters of [`SimpleRefChannelManager`] and
1078 /// [`SimpleRefPeerManager`]. See their docs for more details.
1080 /// This is not exported to bindings users as type aliases aren't supported in most languages.
1082 /// [`SimpleRefChannelManager`]: crate::ln::channelmanager::SimpleRefChannelManager
1083 /// [`SimpleRefPeerManager`]: crate::ln::peer_handler::SimpleRefPeerManager
1084 #[cfg(not(c_bindings))]
1085 pub type SimpleRefOnionMessenger<
1086 'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i, 'j, M, T, F, L
1091 &'i DefaultMessageRouter<&'g NetworkGraph<&'b L>, &'b L>,
1092 &'j SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L>,
1093 IgnoringMessageHandler
1096 /// Construct onion packet payloads and keys for sending an onion message along the given
1097 /// `unblinded_path` to the given `destination`.
1098 fn packet_payloads_and_keys<T: OnionMessageContents, S: secp256k1::Signing + secp256k1::Verification>(
1099 secp_ctx: &Secp256k1<S>, unblinded_path: &[PublicKey], destination: Destination, message: T,
1100 mut reply_path: Option<BlindedPath>, session_priv: &SecretKey
1101 ) -> Result<(Vec<(Payload<T>, [u8; 32])>, Vec<onion_utils::OnionKeys>), secp256k1::Error> {
1102 let num_hops = unblinded_path.len() + destination.num_hops();
1103 let mut payloads = Vec::with_capacity(num_hops);
1104 let mut onion_packet_keys = Vec::with_capacity(num_hops);
1106 let (mut intro_node_id_blinding_pt, num_blinded_hops) = if let Destination::BlindedPath(BlindedPath {
1107 introduction_node_id, blinding_point, blinded_hops }) = &destination {
1108 (Some((*introduction_node_id, *blinding_point)), blinded_hops.len()) } else { (None, 0) };
1109 let num_unblinded_hops = num_hops - num_blinded_hops;
1111 let mut unblinded_path_idx = 0;
1112 let mut blinded_path_idx = 0;
1113 let mut prev_control_tlvs_ss = None;
1114 let mut final_control_tlvs = None;
1115 utils::construct_keys_callback(secp_ctx, unblinded_path.iter(), Some(destination), session_priv,
1116 |_, onion_packet_ss, ephemeral_pubkey, control_tlvs_ss, unblinded_pk_opt, enc_payload_opt| {
1117 if num_unblinded_hops != 0 && unblinded_path_idx < num_unblinded_hops {
1118 if let Some(ss) = prev_control_tlvs_ss.take() {
1119 payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(
1121 next_node_id: unblinded_pk_opt.unwrap(),
1122 next_blinding_override: None,
1126 prev_control_tlvs_ss = Some(control_tlvs_ss);
1127 unblinded_path_idx += 1;
1128 } else if let Some((intro_node_id, blinding_pt)) = intro_node_id_blinding_pt.take() {
1129 if let Some(control_tlvs_ss) = prev_control_tlvs_ss.take() {
1130 payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
1131 next_node_id: intro_node_id,
1132 next_blinding_override: Some(blinding_pt),
1133 })), control_tlvs_ss));
1136 if blinded_path_idx < num_blinded_hops.saturating_sub(1) && enc_payload_opt.is_some() {
1137 payloads.push((Payload::Forward(ForwardControlTlvs::Blinded(enc_payload_opt.unwrap())),
1139 blinded_path_idx += 1;
1140 } else if let Some(encrypted_payload) = enc_payload_opt {
1141 final_control_tlvs = Some(ReceiveControlTlvs::Blinded(encrypted_payload));
1142 prev_control_tlvs_ss = Some(control_tlvs_ss);
1145 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(onion_packet_ss.as_ref());
1146 onion_packet_keys.push(onion_utils::OnionKeys {
1148 shared_secret: onion_packet_ss,
1150 blinding_factor: [0; 32],
1158 if let Some(control_tlvs) = final_control_tlvs {
1159 payloads.push((Payload::Receive {
1161 reply_path: reply_path.take(),
1163 }, prev_control_tlvs_ss.unwrap()));
1165 payloads.push((Payload::Receive {
1166 control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id: None, }),
1167 reply_path: reply_path.take(),
1169 }, prev_control_tlvs_ss.unwrap()));
1172 Ok((payloads, onion_packet_keys))
1175 /// Errors if the serialized payload size exceeds onion_message::BIG_PACKET_HOP_DATA_LEN
1176 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, ()> {
1178 // "`len` allows larger messages to be sent than the standard 1300 bytes allowed for an HTLC
1179 // onion, but this should be used sparingly as it is reduces anonymity set, hence the
1180 // recommendation that it either look like an HTLC onion, or if larger, be a fixed size."
1181 let payloads_ser_len = onion_utils::payloads_serialized_length(&payloads);
1182 let hop_data_len = if payloads_ser_len <= SMALL_PACKET_HOP_DATA_LEN {
1183 SMALL_PACKET_HOP_DATA_LEN
1184 } else if payloads_ser_len <= BIG_PACKET_HOP_DATA_LEN {
1185 BIG_PACKET_HOP_DATA_LEN
1186 } else { return Err(()) };
1188 onion_utils::construct_onion_message_packet::<_, _>(
1189 payloads, onion_keys, prng_seed, hop_data_len)