git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/onion_message/messenger.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! LDK sends, receives, and forwards onion messages via the [`OnionMessenger`]. See its docs for
  11 //! more information.
  12
  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};
  17
  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::sign::{EntropySource, KeysManager, NodeSigner, Recipient};
  22 #[cfg(not(c_bindings))]
  23 use crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
  24 use crate::ln::features::{InitFeatures, NodeFeatures};
  25 use crate::ln::msgs::{self, OnionMessage, OnionMessageHandler};
  26 use crate::ln::onion_utils;
  27 use crate::ln::peer_handler::IgnoringMessageHandler;
  28 pub use super::packet::OnionMessageContents;
  29 use super::packet::ParsedOnionMessageContents;
  30 use super::offers::OffersMessageHandler;
  31 use super::packet::{BIG_PACKET_HOP_DATA_LEN, ForwardControlTlvs, Packet, Payload, ReceiveControlTlvs, SMALL_PACKET_HOP_DATA_LEN};
  32 use crate::util::logger::Logger;
  33 use crate::util::ser::Writeable;
  34
  35 use core::fmt;
  36 use core::ops::Deref;
  37 use crate::io;
  38 use crate::sync::{Arc, Mutex};
  39 use crate::prelude::*;
  40
  41 /// A sender, receiver and forwarder of [`OnionMessage`]s.
  42 ///
  43 /// # Handling Messages
  44 ///
  45 /// `OnionMessenger` implements [`OnionMessageHandler`], making it responsible for either forwarding
  46 /// messages to peers or delegating to the appropriate handler for the message type. Currently, the
  47 /// available handlers are:
  48 /// * [`OffersMessageHandler`], for responding to [`InvoiceRequest`]s and paying [`Bolt12Invoice`]s
  49 /// * [`CustomOnionMessageHandler`], for handling user-defined message types
  50 ///
  51 /// # Sending Messages
  52 ///
  53 /// [`OnionMessage`]s are sent initially using [`OnionMessenger::send_onion_message`]. When handling
  54 /// a message, the matched handler may return a response message which `OnionMessenger` will send
  55 /// on its behalf.
  56 ///
  57 /// # Example
  58 ///
  59 /// ```
  60 /// # extern crate bitcoin;
  61 /// # use bitcoin::hashes::_export::_core::time::Duration;
  62 /// # use bitcoin::hashes::hex::FromHex;
  63 /// # use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
  64 /// # use lightning::blinded_path::BlindedPath;
  65 /// # use lightning::sign::KeysManager;
  66 /// # use lightning::ln::peer_handler::IgnoringMessageHandler;
  67 /// # use lightning::onion_message::{OnionMessageContents, Destination, MessageRouter, OnionMessagePath, OnionMessenger};
  68 /// # use lightning::util::logger::{Logger, Record};
  69 /// # use lightning::util::ser::{Writeable, Writer};
  70 /// # use lightning::io;
  71 /// # use std::sync::Arc;
  72 /// # struct FakeLogger;
  73 /// # impl Logger for FakeLogger {
  74 /// #     fn log(&self, record: Record) { println!("{:?}" , record); }
  75 /// # }
  76 /// # struct FakeMessageRouter {}
  77 /// # impl MessageRouter for FakeMessageRouter {
  78 /// #     fn find_path(&self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination) -> Result<OnionMessagePath, ()> {
  79 /// #         let secp_ctx = Secp256k1::new();
  80 /// #         let node_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
  81 /// #         let hop_node_id1 = PublicKey::from_secret_key(&secp_ctx, &node_secret);
  82 /// #         let hop_node_id2 = hop_node_id1;
  83 /// #         Ok(OnionMessagePath {
  84 /// #             intermediate_nodes: vec![hop_node_id1, hop_node_id2],
  85 /// #             destination,
  86 /// #         })
  87 /// #     }
  88 /// # }
  89 /// # let seed = [42u8; 32];
  90 /// # let time = Duration::from_secs(123456);
  91 /// # let keys_manager = KeysManager::new(&seed, time.as_secs(), time.subsec_nanos());
  92 /// # let logger = Arc::new(FakeLogger {});
  93 /// # let node_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
  94 /// # let secp_ctx = Secp256k1::new();
  95 /// # let hop_node_id1 = PublicKey::from_secret_key(&secp_ctx, &node_secret);
  96 /// # let (hop_node_id3, hop_node_id4) = (hop_node_id1, hop_node_id1);
  97 /// # let destination_node_id = hop_node_id1;
  98 /// # let message_router = Arc::new(FakeMessageRouter {});
  99 /// # let custom_message_handler = IgnoringMessageHandler {};
 100 /// # let offers_message_handler = IgnoringMessageHandler {};
 101 /// // Create the onion messenger. This must use the same `keys_manager` as is passed to your
 102 /// // ChannelManager.
 103 /// let onion_messenger = OnionMessenger::new(
 104 ///     &keys_manager, &keys_manager, logger, message_router, &offers_message_handler,
 105 ///     &custom_message_handler
 106 /// );
 107
 108 /// # #[derive(Debug)]
 109 /// # struct YourCustomMessage {}
 110 /// impl Writeable for YourCustomMessage {
 111 ///     fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 112 ///             # Ok(())
 113 ///             // Write your custom onion message to `w`
 114 ///     }
 115 /// }
 116 /// impl OnionMessageContents for YourCustomMessage {
 117 ///     fn tlv_type(&self) -> u64 {
 118 ///             # let your_custom_message_type = 42;
 119 ///             your_custom_message_type
 120 ///     }
 121 /// }
 122 /// // Send a custom onion message to a node id.
 123 /// let destination = Destination::Node(destination_node_id);
 124 /// let reply_path = None;
 125 /// # let message = YourCustomMessage {};
 126 /// onion_messenger.send_onion_message(message, destination, reply_path);
 127 ///
 128 /// // Create a blinded path to yourself, for someone to send an onion message to.
 129 /// # let your_node_id = hop_node_id1;
 130 /// let hops = [hop_node_id3, hop_node_id4, your_node_id];
 131 /// let blinded_path = BlindedPath::new_for_message(&hops, &keys_manager, &secp_ctx).unwrap();
 132 ///
 133 /// // Send a custom onion message to a blinded path.
 134 /// let destination = Destination::BlindedPath(blinded_path);
 135 /// let reply_path = None;
 136 /// # let message = YourCustomMessage {};
 137 /// onion_messenger.send_onion_message(message, destination, reply_path);
 138 /// ```
 139 ///
 140 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 141 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 142 pub struct OnionMessenger<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref>
 143 where
 144         ES::Target: EntropySource,
 145         NS::Target: NodeSigner,
 146         L::Target: Logger,
 147         MR::Target: MessageRouter,
 148         OMH::Target: OffersMessageHandler,
 149         CMH:: Target: CustomOnionMessageHandler,
 150 {
 151         entropy_source: ES,
 152         node_signer: NS,
 153         logger: L,
 154         message_buffers: Mutex<HashMap<PublicKey, OnionMessageBuffer>>,
 155         secp_ctx: Secp256k1<secp256k1::All>,
 156         message_router: MR,
 157         offers_handler: OMH,
 158         custom_handler: CMH,
 159 }
 160
 161 /// [`OnionMessage`]s buffered to be sent.
 162 enum OnionMessageBuffer {
 163         /// Messages for a node connected as a peer.
 164         ConnectedPeer(VecDeque<OnionMessage>),
 165
 166         /// Messages for a node that is not yet connected.
 167         PendingConnection(VecDeque<OnionMessage>),
 168 }
 169
 170 impl OnionMessageBuffer {
 171         fn pending_messages(&self) -> &VecDeque<OnionMessage> {
 172                 match self {
 173                         OnionMessageBuffer::ConnectedPeer(pending_messages) => pending_messages,
 174                         OnionMessageBuffer::PendingConnection(pending_messages) => pending_messages,
 175                 }
 176         }
 177
 178         fn enqueue_message(&mut self, message: OnionMessage) {
 179                 let pending_messages = match self {
 180                         OnionMessageBuffer::ConnectedPeer(pending_messages) => pending_messages,
 181                         OnionMessageBuffer::PendingConnection(pending_messages) => pending_messages,
 182                 };
 183
 184                 pending_messages.push_back(message);
 185         }
 186
 187         fn dequeue_message(&mut self) -> Option<OnionMessage> {
 188                 let pending_messages = match self {
 189                         OnionMessageBuffer::ConnectedPeer(pending_messages) => pending_messages,
 190                         OnionMessageBuffer::PendingConnection(pending_messages) => {
 191                                 debug_assert!(false);
 192                                 pending_messages
 193                         },
 194                 };
 195
 196                 pending_messages.pop_front()
 197         }
 198
 199         #[cfg(test)]
 200         fn release_pending_messages(&mut self) -> VecDeque<OnionMessage> {
 201                 let pending_messages = match self {
 202                         OnionMessageBuffer::ConnectedPeer(pending_messages) => pending_messages,
 203                         OnionMessageBuffer::PendingConnection(pending_messages) => pending_messages,
 204                 };
 205
 206                 core::mem::take(pending_messages)
 207         }
 208
 209         fn mark_connected(&mut self) {
 210                 if let OnionMessageBuffer::PendingConnection(pending_messages) = self {
 211                         let mut new_pending_messages = VecDeque::new();
 212                         core::mem::swap(pending_messages, &mut new_pending_messages);
 213                         *self = OnionMessageBuffer::ConnectedPeer(new_pending_messages);
 214                 }
 215         }
 216 }
 217
 218 /// An [`OnionMessage`] for [`OnionMessenger`] to send.
 219 ///
 220 /// These are obtained when released from [`OnionMessenger`]'s handlers after which they are
 221 /// enqueued for sending.
 222 #[cfg(not(c_bindings))]
 223 pub struct PendingOnionMessage<T: OnionMessageContents> {
 224         /// The message contents to send in an [`OnionMessage`].
 225         pub contents: T,
 226
 227         /// The destination of the message.
 228         pub destination: Destination,
 229
 230         /// A reply path to include in the [`OnionMessage`] for a response.
 231         pub reply_path: Option<BlindedPath>,
 232 }
 233
 234 #[cfg(c_bindings)]
 235 /// An [`OnionMessage`] for [`OnionMessenger`] to send.
 236 ///
 237 /// These are obtained when released from [`OnionMessenger`]'s handlers after which they are
 238 /// enqueued for sending.
 239 pub type PendingOnionMessage<T: OnionMessageContents> = (T, Destination, Option<BlindedPath>);
 240
 241 pub(crate) fn new_pending_onion_message<T: OnionMessageContents>(
 242         contents: T, destination: Destination, reply_path: Option<BlindedPath>
 243 ) -> PendingOnionMessage<T> {
 244         #[cfg(not(c_bindings))]
 245         return PendingOnionMessage { contents, destination, reply_path };
 246         #[cfg(c_bindings)]
 247         return (contents, destination, reply_path);
 248 }
 249
 250 /// A trait defining behavior for routing an [`OnionMessage`].
 251 pub trait MessageRouter {
 252         /// Returns a route for sending an [`OnionMessage`] to the given [`Destination`].
 253         fn find_path(
 254                 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
 255         ) -> Result<OnionMessagePath, ()>;
 256 }
 257
 258 /// A [`MessageRouter`] that can only route to a directly connected [`Destination`].
 259 pub struct DefaultMessageRouter;
 260
 261 impl MessageRouter for DefaultMessageRouter {
 262         fn find_path(
 263                 &self, _sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
 264         ) -> Result<OnionMessagePath, ()> {
 265                 if peers.contains(&destination.first_node()) {
 266                         Ok(OnionMessagePath { intermediate_nodes: vec![], destination })
 267                 } else {
 268                         Err(())
 269                 }
 270         }
 271 }
 272
 273 /// A path for sending an [`OnionMessage`].
 274 #[derive(Clone)]
 275 pub struct OnionMessagePath {
 276         /// Nodes on the path between the sender and the destination.
 277         pub intermediate_nodes: Vec<PublicKey>,
 278
 279         /// The recipient of the message.
 280         pub destination: Destination,
 281 }
 282
 283 /// The destination of an onion message.
 284 #[derive(Clone)]
 285 pub enum Destination {
 286         /// We're sending this onion message to a node.
 287         Node(PublicKey),
 288         /// We're sending this onion message to a blinded path.
 289         BlindedPath(BlindedPath),
 290 }
 291
 292 impl Destination {
 293         pub(super) fn num_hops(&self) -> usize {
 294                 match self {
 295                         Destination::Node(_) => 1,
 296                         Destination::BlindedPath(BlindedPath { blinded_hops, .. }) => blinded_hops.len(),
 297                 }
 298         }
 299
 300         fn first_node(&self) -> PublicKey {
 301                 match self {
 302                         Destination::Node(node_id) => *node_id,
 303                         Destination::BlindedPath(BlindedPath { introduction_node_id: node_id, .. }) => *node_id,
 304                 }
 305         }
 306 }
 307
 308 /// Result of successfully [sending an onion message].
 309 ///
 310 /// [sending an onion message]: OnionMessenger::send_onion_message
 311 #[derive(Debug, PartialEq, Eq)]
 312 pub enum SendSuccess {
 313         /// The message was buffered and will be sent once it is processed by
 314         /// [`OnionMessageHandler::next_onion_message_for_peer`].
 315         Buffered,
 316         /// The message was buffered and will be sent once the node is connected as a peer and it is
 317         /// processed by [`OnionMessageHandler::next_onion_message_for_peer`].
 318         BufferedAwaitingConnection(PublicKey),
 319 }
 320
 321 /// Errors that may occur when [sending an onion message].
 322 ///
 323 /// [sending an onion message]: OnionMessenger::send_onion_message
 324 #[derive(Debug, PartialEq, Eq)]
 325 pub enum SendError {
 326         /// Errored computing onion message packet keys.
 327         Secp256k1(secp256k1::Error),
 328         /// Because implementations such as Eclair will drop onion messages where the message packet
 329         /// exceeds 32834 bytes, we refuse to send messages where the packet exceeds this size.
 330         TooBigPacket,
 331         /// The provided [`Destination`] was an invalid [`BlindedPath`] due to not having any blinded
 332         /// hops.
 333         TooFewBlindedHops,
 334         /// A path from the sender to the destination could not be found by the [`MessageRouter`].
 335         PathNotFound,
 336         /// Onion message contents must have a TLV type >= 64.
 337         InvalidMessage,
 338         /// Our next-hop peer's buffer was full or our total outbound buffer was full.
 339         BufferFull,
 340         /// Failed to retrieve our node id from the provided [`NodeSigner`].
 341         ///
 342         /// [`NodeSigner`]: crate::sign::NodeSigner
 343         GetNodeIdFailed,
 344         /// We attempted to send to a blinded path where we are the introduction node, and failed to
 345         /// advance the blinded path to make the second hop the new introduction node. Either
 346         /// [`NodeSigner::ecdh`] failed, we failed to tweak the current blinding point to get the
 347         /// new blinding point, or we were attempting to send to ourselves.
 348         BlindedPathAdvanceFailed,
 349 }
 350
 351 /// Handler for custom onion messages. If you are using [`SimpleArcOnionMessenger`],
 352 /// [`SimpleRefOnionMessenger`], or prefer to ignore inbound custom onion messages,
 353 /// [`IgnoringMessageHandler`] must be provided to [`OnionMessenger::new`]. Otherwise, a custom
 354 /// implementation of this trait must be provided, with [`CustomMessage`] specifying the supported
 355 /// message types.
 356 ///
 357 /// See [`OnionMessenger`] for example usage.
 358 ///
 359 /// [`IgnoringMessageHandler`]: crate::ln::peer_handler::IgnoringMessageHandler
 360 /// [`CustomMessage`]: Self::CustomMessage
 361 pub trait CustomOnionMessageHandler {
 362         /// The message known to the handler. To support multiple message types, you may want to make this
 363         /// an enum with a variant for each supported message.
 364         type CustomMessage: OnionMessageContents;
 365
 366         /// Called with the custom message that was received, returning a response to send, if any.
 367         ///
 368         /// The returned [`Self::CustomMessage`], if any, is enqueued to be sent by [`OnionMessenger`].
 369         fn handle_custom_message(&self, msg: Self::CustomMessage) -> Option<Self::CustomMessage>;
 370
 371         /// Read a custom message of type `message_type` from `buffer`, returning `Ok(None)` if the
 372         /// message type is unknown.
 373         fn read_custom_message<R: io::Read>(&self, message_type: u64, buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError>;
 374
 375         /// Releases any [`Self::CustomMessage`]s that need to be sent.
 376         ///
 377         /// Typically, this is used for messages initiating a message flow rather than in response to
 378         /// another message. The latter should use the return value of [`Self::handle_custom_message`].
 379         #[cfg(not(c_bindings))]
 380         fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Self::CustomMessage>>;
 381
 382         /// Releases any [`Self::CustomMessage`]s that need to be sent.
 383         ///
 384         /// Typically, this is used for messages initiating a message flow rather than in response to
 385         /// another message. The latter should use the return value of [`Self::handle_custom_message`].
 386         #[cfg(c_bindings)]
 387         fn release_pending_custom_messages(&self) -> Vec<(Self::CustomMessage, Destination, Option<BlindedPath>)>;
 388 }
 389
 390 /// A processed incoming onion message, containing either a Forward (another onion message)
 391 /// or a Receive payload with decrypted contents.
 392 pub enum PeeledOnion<T: OnionMessageContents> {
 393         /// Forwarded onion, with the next node id and a new onion
 394         Forward(PublicKey, OnionMessage),
 395         /// Received onion message, with decrypted contents, path_id, and reply path
 396         Receive(ParsedOnionMessageContents<T>, Option<[u8; 32]>, Option<BlindedPath>)
 397 }
 398
 399 /// Creates an [`OnionMessage`] with the given `contents` for sending to the destination of
 400 /// `path`.
 401 ///
 402 /// Returns both the node id of the peer to send the message to and the message itself.
 403 pub fn create_onion_message<ES: Deref, NS: Deref, T: OnionMessageContents>(
 404         entropy_source: &ES, node_signer: &NS, secp_ctx: &Secp256k1<secp256k1::All>,
 405         path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,
 406 ) -> Result<(PublicKey, OnionMessage), SendError>
 407 where
 408         ES::Target: EntropySource,
 409         NS::Target: NodeSigner,
 410 {
 411         let OnionMessagePath { intermediate_nodes, mut destination } = path;
 412         if let Destination::BlindedPath(BlindedPath { ref blinded_hops, .. }) = destination {
 413                 if blinded_hops.is_empty() {
 414                         return Err(SendError::TooFewBlindedHops);
 415                 }
 416         }
 417
 418         if contents.tlv_type() < 64 { return Err(SendError::InvalidMessage) }
 419
 420         // If we are sending straight to a blinded path and we are the introduction node, we need to
 421         // advance the blinded path by 1 hop so the second hop is the new introduction node.
 422         if intermediate_nodes.len() == 0 {
 423                 if let Destination::BlindedPath(ref mut blinded_path) = destination {
 424                         let our_node_id = node_signer.get_node_id(Recipient::Node)
 425                                 .map_err(|()| SendError::GetNodeIdFailed)?;
 426                         if blinded_path.introduction_node_id == our_node_id {
 427                                 advance_path_by_one(blinded_path, node_signer, &secp_ctx)
 428                                         .map_err(|()| SendError::BlindedPathAdvanceFailed)?;
 429                         }
 430                 }
 431         }
 432
 433         let blinding_secret_bytes = entropy_source.get_secure_random_bytes();
 434         let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
 435         let (first_node_id, blinding_point) = if let Some(first_node_id) = intermediate_nodes.first() {
 436                 (*first_node_id, PublicKey::from_secret_key(&secp_ctx, &blinding_secret))
 437         } else {
 438                 match destination {
 439                         Destination::Node(pk) => (pk, PublicKey::from_secret_key(&secp_ctx, &blinding_secret)),
 440                         Destination::BlindedPath(BlindedPath { introduction_node_id, blinding_point, .. }) =>
 441                                 (introduction_node_id, blinding_point),
 442                 }
 443         };
 444         let (packet_payloads, packet_keys) = packet_payloads_and_keys(
 445                 &secp_ctx, &intermediate_nodes, destination, contents, reply_path, &blinding_secret)
 446                 .map_err(|e| SendError::Secp256k1(e))?;
 447
 448         let prng_seed = entropy_source.get_secure_random_bytes();
 449         let onion_routing_packet = construct_onion_message_packet(
 450                 packet_payloads, packet_keys, prng_seed).map_err(|()| SendError::TooBigPacket)?;
 451
 452         Ok((first_node_id, OnionMessage {
 453                 blinding_point,
 454                 onion_routing_packet
 455         }))
 456 }
 457
 458 /// Decode one layer of an incoming [`OnionMessage`].
 459 ///
 460 /// Returns either the next layer of the onion for forwarding or the decrypted content for the
 461 /// receiver.
 462 pub fn peel_onion_message<NS: Deref, L: Deref, CMH: Deref>(
 463         msg: &OnionMessage, secp_ctx: &Secp256k1<secp256k1::All>, node_signer: NS, logger: L,
 464         custom_handler: CMH,
 465 ) -> Result<PeeledOnion<<<CMH>::Target as CustomOnionMessageHandler>::CustomMessage>, ()>
 466 where
 467         NS::Target: NodeSigner,
 468         L::Target: Logger,
 469         CMH::Target: CustomOnionMessageHandler,
 470 {
 471         let control_tlvs_ss = match node_signer.ecdh(Recipient::Node, &msg.blinding_point, None) {
 472                 Ok(ss) => ss,
 473                 Err(e) =>  {
 474                         log_error!(logger, "Failed to retrieve node secret: {:?}", e);
 475                         return Err(());
 476                 }
 477         };
 478         let onion_decode_ss = {
 479                 let blinding_factor = {
 480                         let mut hmac = HmacEngine::<Sha256>::new(b"blinded_node_id");
 481                         hmac.input(control_tlvs_ss.as_ref());
 482                         Hmac::from_engine(hmac).to_byte_array()
 483                 };
 484                 match node_signer.ecdh(Recipient::Node, &msg.onion_routing_packet.public_key,
 485                         Some(&Scalar::from_be_bytes(blinding_factor).unwrap()))
 486                 {
 487                         Ok(ss) => ss.secret_bytes(),
 488                         Err(()) => {
 489                                 log_trace!(logger, "Failed to compute onion packet shared secret");
 490                                 return Err(());
 491                         }
 492                 }
 493         };
 494         match onion_utils::decode_next_untagged_hop(
 495                 onion_decode_ss, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac,
 496                 (control_tlvs_ss, custom_handler.deref(), logger.deref())
 497         ) {
 498                 Ok((Payload::Receive::<ParsedOnionMessageContents<<<CMH as Deref>::Target as CustomOnionMessageHandler>::CustomMessage>> {
 499                         message, control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id }), reply_path,
 500                 }, None)) => {
 501                         Ok(PeeledOnion::Receive(message, path_id, reply_path))
 502                 },
 503                 Ok((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
 504                         next_node_id, next_blinding_override
 505                 })), Some((next_hop_hmac, new_packet_bytes)))) => {
 506                         // TODO: we need to check whether `next_node_id` is our node, in which case this is a dummy
 507                         // blinded hop and this onion message is destined for us. In this situation, we should keep
 508                         // unwrapping the onion layers to get to the final payload. Since we don't have the option
 509                         // of creating blinded paths with dummy hops currently, we should be ok to not handle this
 510                         // for now.
 511                         let new_pubkey = match onion_utils::next_hop_pubkey(&secp_ctx, msg.onion_routing_packet.public_key, &onion_decode_ss) {
 512                                 Ok(pk) => pk,
 513                                 Err(e) => {
 514                                         log_trace!(logger, "Failed to compute next hop packet pubkey: {}", e);
 515                                         return Err(())
 516                                 }
 517                         };
 518                         let outgoing_packet = Packet {
 519                                 version: 0,
 520                                 public_key: new_pubkey,
 521                                 hop_data: new_packet_bytes,
 522                                 hmac: next_hop_hmac,
 523                         };
 524                         let onion_message = OnionMessage {
 525                                 blinding_point: match next_blinding_override {
 526                                         Some(blinding_point) => blinding_point,
 527                                         None => {
 528                                                 match onion_utils::next_hop_pubkey(
 529                                                         &secp_ctx, msg.blinding_point, control_tlvs_ss.as_ref()
 530                                                 ) {
 531                                                         Ok(bp) => bp,
 532                                                         Err(e) => {
 533                                                                 log_trace!(logger, "Failed to compute next blinding point: {}", e);
 534                                                                 return Err(())
 535                                                         }
 536                                                 }
 537                                         }
 538                                 },
 539                                 onion_routing_packet: outgoing_packet,
 540                         };
 541
 542                         Ok(PeeledOnion::Forward(next_node_id, onion_message))
 543                 },
 544                 Err(e) => {
 545                         log_trace!(logger, "Errored decoding onion message packet: {:?}", e);
 546                         Err(())
 547                 },
 548                 _ => {
 549                         log_trace!(logger, "Received bogus onion message packet, either the sender encoded a final hop as a forwarding hop or vice versa");
 550                         Err(())
 551                 },
 552         }
 553 }
 554
 555 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref>
 556 OnionMessenger<ES, NS, L, MR, OMH, CMH>
 557 where
 558         ES::Target: EntropySource,
 559         NS::Target: NodeSigner,
 560         L::Target: Logger,
 561         MR::Target: MessageRouter,
 562         OMH::Target: OffersMessageHandler,
 563         CMH::Target: CustomOnionMessageHandler,
 564 {
 565         /// Constructs a new `OnionMessenger` to send, forward, and delegate received onion messages to
 566         /// their respective handlers.
 567         pub fn new(
 568                 entropy_source: ES, node_signer: NS, logger: L, message_router: MR, offers_handler: OMH,
 569                 custom_handler: CMH
 570         ) -> Self {
 571                 let mut secp_ctx = Secp256k1::new();
 572                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
 573                 OnionMessenger {
 574                         entropy_source,
 575                         node_signer,
 576                         message_buffers: Mutex::new(HashMap::new()),
 577                         secp_ctx,
 578                         logger,
 579                         message_router,
 580                         offers_handler,
 581                         custom_handler,
 582                 }
 583         }
 584
 585         /// Sends an [`OnionMessage`] with the given `contents` to `destination`.
 586         ///
 587         /// See [`OnionMessenger`] for example usage.
 588         pub fn send_onion_message<T: OnionMessageContents>(
 589                 &self, contents: T, destination: Destination, reply_path: Option<BlindedPath>
 590         ) -> Result<SendSuccess, SendError> {
 591                 self.find_path_and_enqueue_onion_message(
 592                         contents, destination, reply_path, format_args!("")
 593                 )
 594         }
 595
 596         fn find_path_and_enqueue_onion_message<T: OnionMessageContents>(
 597                 &self, contents: T, destination: Destination, reply_path: Option<BlindedPath>,
 598                 log_suffix: fmt::Arguments
 599         ) -> Result<SendSuccess, SendError> {
 600                 let result = self.find_path(destination)
 601                         .and_then(|path| self.enqueue_onion_message(path, contents, reply_path, log_suffix));
 602
 603                 match result.as_ref() {
 604                         Err(SendError::GetNodeIdFailed) => {
 605                                 log_warn!(self.logger, "Unable to retrieve node id {}", log_suffix);
 606                         },
 607                         Err(SendError::PathNotFound) => {
 608                                 log_trace!(self.logger, "Failed to find path {}", log_suffix);
 609                         },
 610                         Err(e) => {
 611                                 log_trace!(self.logger, "Failed sending onion message {}: {:?}", log_suffix, e);
 612                         },
 613                         Ok(SendSuccess::Buffered) => {
 614                                 log_trace!(self.logger, "Buffered onion message {}", log_suffix);
 615                         },
 616                         Ok(SendSuccess::BufferedAwaitingConnection(node_id)) => {
 617                                 log_trace!(
 618                                         self.logger, "Buffered onion message waiting on peer connection {}: {:?}",
 619                                         log_suffix, node_id
 620                                 );
 621                         },
 622                 }
 623
 624                 result
 625         }
 626
 627         fn find_path(&self, destination: Destination) -> Result<OnionMessagePath, SendError> {
 628                 let sender = self.node_signer
 629                         .get_node_id(Recipient::Node)
 630                         .map_err(|_| SendError::GetNodeIdFailed)?;
 631
 632                 let peers = self.message_buffers.lock().unwrap()
 633                         .iter()
 634                         .filter(|(_, buffer)| matches!(buffer, OnionMessageBuffer::ConnectedPeer(_)))
 635                         .map(|(node_id, _)| *node_id)
 636                         .collect();
 637
 638                 self.message_router
 639                         .find_path(sender, peers, destination)
 640                         .map_err(|_| SendError::PathNotFound)
 641         }
 642
 643         fn enqueue_onion_message<T: OnionMessageContents>(
 644                 &self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,
 645                 log_suffix: fmt::Arguments
 646         ) -> Result<SendSuccess, SendError> {
 647                 log_trace!(self.logger, "Constructing onion message {}: {:?}", log_suffix, contents);
 648
 649                 let (first_node_id, onion_message) = create_onion_message(
 650                         &self.entropy_source, &self.node_signer, &self.secp_ctx, path, contents, reply_path
 651                 )?;
 652
 653                 let mut message_buffers = self.message_buffers.lock().unwrap();
 654                 if outbound_buffer_full(&first_node_id, &message_buffers) {
 655                         return Err(SendError::BufferFull);
 656                 }
 657
 658                 match message_buffers.entry(first_node_id) {
 659                         hash_map::Entry::Vacant(e) => {
 660                                 e.insert(OnionMessageBuffer::PendingConnection(VecDeque::new()))
 661                                         .enqueue_message(onion_message);
 662                                 Ok(SendSuccess::BufferedAwaitingConnection(first_node_id))
 663                         },
 664                         hash_map::Entry::Occupied(mut e) => {
 665                                 e.get_mut().enqueue_message(onion_message);
 666                                 Ok(SendSuccess::Buffered)
 667                         },
 668                 }
 669         }
 670
 671         #[cfg(test)]
 672         pub(super) fn send_onion_message_using_path<T: OnionMessageContents>(
 673                 &self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>
 674         ) -> Result<SendSuccess, SendError> {
 675                 self.enqueue_onion_message(path, contents, reply_path, format_args!(""))
 676         }
 677
 678         fn handle_onion_message_response<T: OnionMessageContents>(
 679                 &self, response: Option<T>, reply_path: Option<BlindedPath>, log_suffix: fmt::Arguments
 680         ) {
 681                 if let Some(response) = response {
 682                         match reply_path {
 683                                 Some(reply_path) => {
 684                                         let _ = self.find_path_and_enqueue_onion_message(
 685                                                 response, Destination::BlindedPath(reply_path), None, log_suffix
 686                                         );
 687                                 },
 688                                 None => {
 689                                         log_trace!(self.logger, "Missing reply path {}", log_suffix);
 690                                 },
 691                         }
 692                 }
 693         }
 694
 695         #[cfg(test)]
 696         pub(super) fn release_pending_msgs(&self) -> HashMap<PublicKey, VecDeque<OnionMessage>> {
 697                 let mut message_buffers = self.message_buffers.lock().unwrap();
 698                 let mut msgs = HashMap::new();
 699                 // We don't want to disconnect the peers by removing them entirely from the original map, so we
 700                 // release the pending message buffers individually.
 701                 for (peer_node_id, buffer) in &mut *message_buffers {
 702                         msgs.insert(*peer_node_id, buffer.release_pending_messages());
 703                 }
 704                 msgs
 705         }
 706 }
 707
 708 fn outbound_buffer_full(peer_node_id: &PublicKey, buffer: &HashMap<PublicKey, OnionMessageBuffer>) -> bool {
 709         const MAX_TOTAL_BUFFER_SIZE: usize = (1 << 20) * 128;
 710         const MAX_PER_PEER_BUFFER_SIZE: usize = (1 << 10) * 256;
 711         let mut total_buffered_bytes = 0;
 712         let mut peer_buffered_bytes = 0;
 713         for (pk, peer_buf) in buffer {
 714                 for om in peer_buf.pending_messages() {
 715                         let om_len = om.serialized_length();
 716                         if pk == peer_node_id {
 717                                 peer_buffered_bytes += om_len;
 718                         }
 719                         total_buffered_bytes += om_len;
 720
 721                         if total_buffered_bytes >= MAX_TOTAL_BUFFER_SIZE ||
 722                                 peer_buffered_bytes >= MAX_PER_PEER_BUFFER_SIZE
 723                         {
 724                                 return true
 725                         }
 726                 }
 727         }
 728         false
 729 }
 730
 731 impl<ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref> OnionMessageHandler
 732 for OnionMessenger<ES, NS, L, MR, OMH, CMH>
 733 where
 734         ES::Target: EntropySource,
 735         NS::Target: NodeSigner,
 736         L::Target: Logger,
 737         MR::Target: MessageRouter,
 738         OMH::Target: OffersMessageHandler,
 739         CMH::Target: CustomOnionMessageHandler,
 740 {
 741         fn handle_onion_message(&self, _peer_node_id: &PublicKey, msg: &OnionMessage) {
 742                 match peel_onion_message(
 743                         msg, &self.secp_ctx, &*self.node_signer, &*self.logger, &*self.custom_handler
 744                 ) {
 745                         Ok(PeeledOnion::Receive(message, path_id, reply_path)) => {
 746                                 log_trace!(
 747                                         self.logger,
 748                                    "Received an onion message with path_id {:02x?} and {} reply_path: {:?}",
 749                                         path_id, if reply_path.is_some() { "a" } else { "no" }, message);
 750
 751                                 match message {
 752                                         ParsedOnionMessageContents::Offers(msg) => {
 753                                                 let response = self.offers_handler.handle_message(msg);
 754                                                 self.handle_onion_message_response(
 755                                                         response, reply_path, format_args!(
 756                                                                 "when responding to Offers onion message with path_id {:02x?}",
 757                                                                 path_id
 758                                                         )
 759                                                 );
 760                                         },
 761                                         ParsedOnionMessageContents::Custom(msg) => {
 762                                                 let response = self.custom_handler.handle_custom_message(msg);
 763                                                 self.handle_onion_message_response(
 764                                                         response, reply_path, format_args!(
 765                                                                 "when responding to Custom onion message with path_id {:02x?}",
 766                                                                 path_id
 767                                                         )
 768                                                 );
 769                                         },
 770                                 }
 771                         },
 772                         Ok(PeeledOnion::Forward(next_node_id, onion_message)) => {
 773                                 let mut message_buffers = self.message_buffers.lock().unwrap();
 774                                 if outbound_buffer_full(&next_node_id, &message_buffers) {
 775                                         log_trace!(self.logger, "Dropping forwarded onion message to peer {:?}: outbound buffer full", next_node_id);
 776                                         return
 777                                 }
 778
 779                                 #[cfg(fuzzing)]
 780                                 message_buffers
 781                                         .entry(next_node_id)
 782                                         .or_insert_with(|| OnionMessageBuffer::ConnectedPeer(VecDeque::new()));
 783
 784                                 match message_buffers.entry(next_node_id) {
 785                                         hash_map::Entry::Occupied(mut e) if matches!(
 786                                                 e.get(), OnionMessageBuffer::ConnectedPeer(..)
 787                                         ) => {
 788                                                 e.get_mut().enqueue_message(onion_message);
 789                                                 log_trace!(self.logger, "Forwarding an onion message to peer {}", next_node_id);
 790                                         },
 791                                         _ => {
 792                                                 log_trace!(self.logger, "Dropping forwarded onion message to disconnected peer {:?}", next_node_id);
 793                                                 return
 794                                         },
 795                                 }
 796                         },
 797                         Err(e) => {
 798                                 log_error!(self.logger, "Failed to process onion message {:?}", e);
 799                         }
 800                 }
 801         }
 802
 803         fn peer_connected(&self, their_node_id: &PublicKey, init: &msgs::Init, _inbound: bool) -> Result<(), ()> {
 804                 if init.features.supports_onion_messages() {
 805                         self.message_buffers.lock().unwrap()
 806                                 .entry(*their_node_id)
 807                                 .or_insert_with(|| OnionMessageBuffer::ConnectedPeer(VecDeque::new()))
 808                                 .mark_connected();
 809                 } else {
 810                         self.message_buffers.lock().unwrap().remove(their_node_id);
 811                 }
 812
 813                 Ok(())
 814         }
 815
 816         fn peer_disconnected(&self, their_node_id: &PublicKey) {
 817                 match self.message_buffers.lock().unwrap().remove(their_node_id) {
 818                         Some(OnionMessageBuffer::ConnectedPeer(..)) => {},
 819                         _ => debug_assert!(false),
 820                 }
 821         }
 822
 823         fn provided_node_features(&self) -> NodeFeatures {
 824                 let mut features = NodeFeatures::empty();
 825                 features.set_onion_messages_optional();
 826                 features
 827         }
 828
 829         fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
 830                 let mut features = InitFeatures::empty();
 831                 features.set_onion_messages_optional();
 832                 features
 833         }
 834
 835         // Before returning any messages to send for the peer, this method will see if any messages were
 836         // enqueued in the handler by users, find a path to the corresponding blinded path's introduction
 837         // node, and then enqueue the message for sending to the first peer in the full path.
 838         fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<OnionMessage> {
 839                 // Enqueue any initiating `OffersMessage`s to send.
 840                 for message in self.offers_handler.release_pending_messages() {
 841                         #[cfg(not(c_bindings))]
 842                         let PendingOnionMessage { contents, destination, reply_path } = message;
 843                         #[cfg(c_bindings)]
 844                         let (contents, destination, reply_path) = message;
 845                         let _ = self.find_path_and_enqueue_onion_message(
 846                                 contents, destination, reply_path, format_args!("when sending OffersMessage")
 847                         );
 848                 }
 849
 850                 // Enqueue any initiating `CustomMessage`s to send.
 851                 for message in self.custom_handler.release_pending_custom_messages() {
 852                         #[cfg(not(c_bindings))]
 853                         let PendingOnionMessage { contents, destination, reply_path } = message;
 854                         #[cfg(c_bindings)]
 855                         let (contents, destination, reply_path) = message;
 856                         let _ = self.find_path_and_enqueue_onion_message(
 857                                 contents, destination, reply_path, format_args!("when sending CustomMessage")
 858                         );
 859                 }
 860
 861                 self.message_buffers.lock().unwrap()
 862                         .get_mut(&peer_node_id)
 863                         .and_then(|buffer| buffer.dequeue_message())
 864         }
 865 }
 866
 867 // TODO: parameterize the below Simple* types with OnionMessenger and handle the messages it
 868 // produces
 869 /// Useful for simplifying the parameters of [`SimpleArcChannelManager`] and
 870 /// [`SimpleArcPeerManager`]. See their docs for more details.
 871 ///
 872 /// This is not exported to bindings users as type aliases aren't supported in most languages.
 873 ///
 874 /// [`SimpleArcChannelManager`]: crate::ln::channelmanager::SimpleArcChannelManager
 875 /// [`SimpleArcPeerManager`]: crate::ln::peer_handler::SimpleArcPeerManager
 876 #[cfg(not(c_bindings))]
 877 pub type SimpleArcOnionMessenger<M, T, F, L> = OnionMessenger<
 878         Arc<KeysManager>,
 879         Arc<KeysManager>,
 880         Arc<L>,
 881         Arc<DefaultMessageRouter>,
 882         Arc<SimpleArcChannelManager<M, T, F, L>>,
 883         IgnoringMessageHandler
 884 >;
 885
 886 /// Useful for simplifying the parameters of [`SimpleRefChannelManager`] and
 887 /// [`SimpleRefPeerManager`]. See their docs for more details.
 888 ///
 889 /// This is not exported to bindings users as type aliases aren't supported in most languages.
 890 ///
 891 /// [`SimpleRefChannelManager`]: crate::ln::channelmanager::SimpleRefChannelManager
 892 /// [`SimpleRefPeerManager`]: crate::ln::peer_handler::SimpleRefPeerManager
 893 #[cfg(not(c_bindings))]
 894 pub type SimpleRefOnionMessenger<
 895         'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i, 'j, M, T, F, L
 896 > = OnionMessenger<
 897         &'a KeysManager,
 898         &'a KeysManager,
 899         &'b L,
 900         &'i DefaultMessageRouter,
 901         &'j SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L>,
 902         IgnoringMessageHandler
 903 >;
 904
 905 /// Construct onion packet payloads and keys for sending an onion message along the given
 906 /// `unblinded_path` to the given `destination`.
 907 fn packet_payloads_and_keys<T: OnionMessageContents, S: secp256k1::Signing + secp256k1::Verification>(
 908         secp_ctx: &Secp256k1<S>, unblinded_path: &[PublicKey], destination: Destination, message: T,
 909         mut reply_path: Option<BlindedPath>, session_priv: &SecretKey
 910 ) -> Result<(Vec<(Payload<T>, [u8; 32])>, Vec<onion_utils::OnionKeys>), secp256k1::Error> {
 911         let num_hops = unblinded_path.len() + destination.num_hops();
 912         let mut payloads = Vec::with_capacity(num_hops);
 913         let mut onion_packet_keys = Vec::with_capacity(num_hops);
 914
 915         let (mut intro_node_id_blinding_pt, num_blinded_hops) = if let Destination::BlindedPath(BlindedPath {
 916                 introduction_node_id, blinding_point, blinded_hops }) = &destination {
 917                 (Some((*introduction_node_id, *blinding_point)), blinded_hops.len()) } else { (None, 0) };
 918         let num_unblinded_hops = num_hops - num_blinded_hops;
 919
 920         let mut unblinded_path_idx = 0;
 921         let mut blinded_path_idx = 0;
 922         let mut prev_control_tlvs_ss = None;
 923         let mut final_control_tlvs = None;
 924         utils::construct_keys_callback(secp_ctx, unblinded_path.iter(), Some(destination), session_priv,
 925                 |_, onion_packet_ss, ephemeral_pubkey, control_tlvs_ss, unblinded_pk_opt, enc_payload_opt| {
 926                         if num_unblinded_hops != 0 && unblinded_path_idx < num_unblinded_hops {
 927                                 if let Some(ss) = prev_control_tlvs_ss.take() {
 928                                         payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(
 929                                                 ForwardTlvs {
 930                                                         next_node_id: unblinded_pk_opt.unwrap(),
 931                                                         next_blinding_override: None,
 932                                                 }
 933                                         )), ss));
 934                                 }
 935                                 prev_control_tlvs_ss = Some(control_tlvs_ss);
 936                                 unblinded_path_idx += 1;
 937                         } else if let Some((intro_node_id, blinding_pt)) = intro_node_id_blinding_pt.take() {
 938                                 if let Some(control_tlvs_ss) = prev_control_tlvs_ss.take() {
 939                                         payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
 940                                                 next_node_id: intro_node_id,
 941                                                 next_blinding_override: Some(blinding_pt),
 942                                         })), control_tlvs_ss));
 943                                 }
 944                         }
 945                         if blinded_path_idx < num_blinded_hops.saturating_sub(1) && enc_payload_opt.is_some() {
 946                                 payloads.push((Payload::Forward(ForwardControlTlvs::Blinded(enc_payload_opt.unwrap())),
 947                                         control_tlvs_ss));
 948                                 blinded_path_idx += 1;
 949                         } else if let Some(encrypted_payload) = enc_payload_opt {
 950                                 final_control_tlvs = Some(ReceiveControlTlvs::Blinded(encrypted_payload));
 951                                 prev_control_tlvs_ss = Some(control_tlvs_ss);
 952                         }
 953
 954                         let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(onion_packet_ss.as_ref());
 955                         onion_packet_keys.push(onion_utils::OnionKeys {
 956                                 #[cfg(test)]
 957                                 shared_secret: onion_packet_ss,
 958                                 #[cfg(test)]
 959                                 blinding_factor: [0; 32],
 960                                 ephemeral_pubkey,
 961                                 rho,
 962                                 mu,
 963                         });
 964                 }
 965         )?;
 966
 967         if let Some(control_tlvs) = final_control_tlvs {
 968                 payloads.push((Payload::Receive {
 969                         control_tlvs,
 970                         reply_path: reply_path.take(),
 971                         message,
 972                 }, prev_control_tlvs_ss.unwrap()));
 973         } else {
 974                 payloads.push((Payload::Receive {
 975                         control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id: None, }),
 976                         reply_path: reply_path.take(),
 977                         message,
 978                 }, prev_control_tlvs_ss.unwrap()));
 979         }
 980
 981         Ok((payloads, onion_packet_keys))
 982 }
 983
 984 /// Errors if the serialized payload size exceeds onion_message::BIG_PACKET_HOP_DATA_LEN
 985 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, ()> {
 986         // Spec rationale:
 987         // "`len` allows larger messages to be sent than the standard 1300 bytes allowed for an HTLC
 988         // onion, but this should be used sparingly as it is reduces anonymity set, hence the
 989         // recommendation that it either look like an HTLC onion, or if larger, be a fixed size."
 990         let payloads_ser_len = onion_utils::payloads_serialized_length(&payloads);
 991         let hop_data_len = if payloads_ser_len <= SMALL_PACKET_HOP_DATA_LEN {
 992                 SMALL_PACKET_HOP_DATA_LEN
 993         } else if payloads_ser_len <= BIG_PACKET_HOP_DATA_LEN {
 994                 BIG_PACKET_HOP_DATA_LEN
 995         } else { return Err(()) };
 996
 997         onion_utils::construct_onion_message_packet::<_, _>(
 998                 payloads, onion_keys, prng_seed, hop_data_len)
 999 }