_ 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 chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager, Recipient, Sign};
  19 use ln::features::{InitFeatures, NodeFeatures};
  20 use ln::msgs::{self, OnionMessageHandler};
  21 use ln::onion_utils;
  22 use ln::peer_handler::IgnoringMessageHandler;
  23 use super::blinded_route::{BlindedRoute, ForwardTlvs, ReceiveTlvs};
  24 pub use super::packet::{CustomOnionMessageContents, OnionMessageContents};
  25 use super::packet::{BIG_PACKET_HOP_DATA_LEN, ForwardControlTlvs, Packet, Payload, ReceiveControlTlvs, SMALL_PACKET_HOP_DATA_LEN};
  26 use super::utils;
  27 use util::events::OnionMessageProvider;
  28 use util::logger::Logger;
  29 use util::ser::Writeable;
  30
  31 use core::ops::Deref;
  32 use sync::{Arc, Mutex};
  33 use prelude::*;
  34
  35 /// A sender, receiver and forwarder of onion messages. In upcoming releases, this object will be
  36 /// used to retrieve invoices and fulfill invoice requests from [offers]. Currently, only sending
  37 /// and receiving custom onion messages is supported.
  38 ///
  39 /// # Example
  40 ///
  41 /// ```
  42 /// # extern crate bitcoin;
  43 /// # use bitcoin::hashes::_export::_core::time::Duration;
  44 /// # use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
  45 /// # use lightning::chain::keysinterface::{InMemorySigner, KeysManager, KeysInterface};
  46 /// # use lightning::ln::msgs::DecodeError;
  47 /// # use lightning::ln::peer_handler::IgnoringMessageHandler;
  48 /// # use lightning::onion_message::{BlindedRoute, CustomOnionMessageContents, Destination, OnionMessageContents, OnionMessenger};
  49 /// # use lightning::util::logger::{Logger, Record};
  50 /// # use lightning::util::ser::{MaybeReadableArgs, Writeable, Writer};
  51 /// # use lightning::io;
  52 /// # use std::sync::Arc;
  53 /// # struct FakeLogger {};
  54 /// # impl Logger for FakeLogger {
  55 /// #     fn log(&self, record: &Record) { unimplemented!() }
  56 /// # }
  57 /// # let seed = [42u8; 32];
  58 /// # let time = Duration::from_secs(123456);
  59 /// # let keys_manager = KeysManager::new(&seed, time.as_secs(), time.subsec_nanos());
  60 /// # let logger = Arc::new(FakeLogger {});
  61 /// # let node_secret = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
  62 /// # let secp_ctx = Secp256k1::new();
  63 /// # let hop_node_id1 = PublicKey::from_secret_key(&secp_ctx, &node_secret);
  64 /// # let (hop_node_id2, hop_node_id3, hop_node_id4) = (hop_node_id1, hop_node_id1, hop_node_id1);
  65 /// # let destination_node_id = hop_node_id1;
  66 /// # let your_custom_message_handler = IgnoringMessageHandler {};
  67 /// // Create the onion messenger. This must use the same `keys_manager` as is passed to your
  68 /// // ChannelManager.
  69 /// let onion_messenger = OnionMessenger::new(&keys_manager, logger, your_custom_message_handler);
  70 ///
  71 /// # struct YourCustomMessage {}
  72 /// impl Writeable for YourCustomMessage {
  73 ///     fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
  74 ///             # Ok(())
  75 ///             // Write your custom onion message to `w`
  76 ///     }
  77 /// }
  78 /// impl CustomOnionMessageContents for YourCustomMessage {
  79 ///     fn tlv_type(&self) -> u64 {
  80 ///             # let your_custom_message_type = 42;
  81 ///             your_custom_message_type
  82 ///     }
  83 /// }
  84 /// impl MaybeReadableArgs<u64> for YourCustomMessage {
  85 ///     fn read<R: io::Read>(r: &mut R, message_type: u64) -> Result<Option<Self>, DecodeError> {
  86 ///             # unreachable!()
  87 ///             // Read your custom onion message of type `message_type` from `r`, or return `None`
  88 ///             // if the message type is unknown
  89 ///     }
  90 /// }
  91 /// // Send a custom onion message to a node id.
  92 /// let intermediate_hops = [hop_node_id1, hop_node_id2];
  93 /// let reply_path = None;
  94 /// # let your_custom_message = YourCustomMessage {};
  95 /// let message = OnionMessageContents::Custom(your_custom_message);
  96 /// onion_messenger.send_onion_message(&intermediate_hops, Destination::Node(destination_node_id), message, reply_path);
  97 ///
  98 /// // Create a blinded route to yourself, for someone to send an onion message to.
  99 /// # let your_node_id = hop_node_id1;
 100 /// let hops = [hop_node_id3, hop_node_id4, your_node_id];
 101 /// let blinded_route = BlindedRoute::new(&hops, &keys_manager, &secp_ctx).unwrap();
 102 ///
 103 /// // Send a custom onion message to a blinded route.
 104 /// # let intermediate_hops = [hop_node_id1, hop_node_id2];
 105 /// let reply_path = None;
 106 /// # let your_custom_message = YourCustomMessage {};
 107 /// let message = OnionMessageContents::Custom(your_custom_message);
 108 /// onion_messenger.send_onion_message(&intermediate_hops, Destination::BlindedRoute(blinded_route), message, reply_path);
 109 /// ```
 110 ///
 111 /// [offers]: <https://github.com/lightning/bolts/pull/798>
 112 /// [`OnionMessenger`]: crate::onion_message::OnionMessenger
 113 pub struct OnionMessenger<Signer: Sign, K: Deref, L: Deref, CMH: Deref>
 114         where K::Target: KeysInterface<Signer = Signer>,
 115               L::Target: Logger,
 116               CMH:: Target: CustomOnionMessageHandler,
 117 {
 118         keys_manager: K,
 119         logger: L,
 120         pending_messages: Mutex<HashMap<PublicKey, VecDeque<msgs::OnionMessage>>>,
 121         secp_ctx: Secp256k1<secp256k1::All>,
 122         custom_handler: CMH,
 123         // Coming soon:
 124         // invoice_handler: InvoiceHandler,
 125 }
 126
 127 /// The destination of an onion message.
 128 pub enum Destination {
 129         /// We're sending this onion message to a node.
 130         Node(PublicKey),
 131         /// We're sending this onion message to a blinded route.
 132         BlindedRoute(BlindedRoute),
 133 }
 134
 135 impl Destination {
 136         pub(super) fn num_hops(&self) -> usize {
 137                 match self {
 138                         Destination::Node(_) => 1,
 139                         Destination::BlindedRoute(BlindedRoute { blinded_hops, .. }) => blinded_hops.len(),
 140                 }
 141         }
 142 }
 143
 144 /// Errors that may occur when [sending an onion message].
 145 ///
 146 /// [sending an onion message]: OnionMessenger::send_onion_message
 147 #[derive(Debug, PartialEq)]
 148 pub enum SendError {
 149         /// Errored computing onion message packet keys.
 150         Secp256k1(secp256k1::Error),
 151         /// Because implementations such as Eclair will drop onion messages where the message packet
 152         /// exceeds 32834 bytes, we refuse to send messages where the packet exceeds this size.
 153         TooBigPacket,
 154         /// The provided [`Destination`] was an invalid [`BlindedRoute`], due to having fewer than two
 155         /// blinded hops.
 156         TooFewBlindedHops,
 157         /// Our next-hop peer was offline or does not support onion message forwarding.
 158         InvalidFirstHop,
 159         /// Our next-hop peer's buffer was full or our total outbound buffer was full.
 160         BufferFull,
 161 }
 162
 163 /// Handler for custom onion messages. If you are using [`SimpleArcOnionMessenger`],
 164 /// [`SimpleRefOnionMessenger`], or prefer to ignore inbound custom onion messages,
 165 /// [`IgnoringMessageHandler`] must be provided to [`OnionMessenger::new`]. Otherwise, a custom
 166 /// implementation of this trait must be provided, with [`CustomMessage`] specifying the supported
 167 /// message types.
 168 ///
 169 /// See [`OnionMessenger`] for example usage.
 170 ///
 171 /// [`IgnoringMessageHandler`]: crate::ln::peer_handler::IgnoringMessageHandler
 172 /// [`CustomMessage`]: Self::CustomMessage
 173 pub trait CustomOnionMessageHandler {
 174         /// The message known to the handler. To support multiple message types, you may want to make this
 175         /// an enum with a variant for each supported message.
 176         type CustomMessage: CustomOnionMessageContents;
 177         /// Called with the custom message that was received.
 178         fn handle_custom_message(&self, msg: Self::CustomMessage);
 179 }
 180
 181 impl<Signer: Sign, K: Deref, L: Deref, CMH: Deref> OnionMessenger<Signer, K, L, CMH>
 182         where K::Target: KeysInterface<Signer = Signer>,
 183               L::Target: Logger,
 184               CMH::Target: CustomOnionMessageHandler,
 185 {
 186         /// Constructs a new `OnionMessenger` to send, forward, and delegate received onion messages to
 187         /// their respective handlers.
 188         pub fn new(keys_manager: K, logger: L, custom_handler: CMH) -> Self {
 189                 let mut secp_ctx = Secp256k1::new();
 190                 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
 191                 OnionMessenger {
 192                         keys_manager,
 193                         pending_messages: Mutex::new(HashMap::new()),
 194                         secp_ctx,
 195                         logger,
 196                         custom_handler,
 197                 }
 198         }
 199
 200         /// Send an onion message with contents `message` to `destination`, routing it through `intermediate_nodes`.
 201         /// See [`OnionMessenger`] for example usage.
 202         pub fn send_onion_message<T: CustomOnionMessageContents>(&self, intermediate_nodes: &[PublicKey], destination: Destination, message: OnionMessageContents<T>, reply_path: Option<BlindedRoute>) -> Result<(), SendError> {
 203                 if let Destination::BlindedRoute(BlindedRoute { ref blinded_hops, .. }) = destination {
 204                         if blinded_hops.len() < 2 {
 205                                 return Err(SendError::TooFewBlindedHops);
 206                         }
 207                 }
 208                 let blinding_secret_bytes = self.keys_manager.get_secure_random_bytes();
 209                 let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
 210                 let (introduction_node_id, blinding_point) = if intermediate_nodes.len() != 0 {
 211                         (intermediate_nodes[0], PublicKey::from_secret_key(&self.secp_ctx, &blinding_secret))
 212                 } else {
 213                         match destination {
 214                                 Destination::Node(pk) => (pk, PublicKey::from_secret_key(&self.secp_ctx, &blinding_secret)),
 215                                 Destination::BlindedRoute(BlindedRoute { introduction_node_id, blinding_point, .. }) =>
 216                                         (introduction_node_id, blinding_point),
 217                         }
 218                 };
 219                 let (packet_payloads, packet_keys) = packet_payloads_and_keys(
 220                         &self.secp_ctx, intermediate_nodes, destination, message, reply_path, &blinding_secret)
 221                         .map_err(|e| SendError::Secp256k1(e))?;
 222
 223                 let prng_seed = self.keys_manager.get_secure_random_bytes();
 224                 let onion_routing_packet = construct_onion_message_packet(
 225                         packet_payloads, packet_keys, prng_seed).map_err(|()| SendError::TooBigPacket)?;
 226
 227                 let mut pending_per_peer_msgs = self.pending_messages.lock().unwrap();
 228                 if outbound_buffer_full(&introduction_node_id, &pending_per_peer_msgs) { return Err(SendError::BufferFull) }
 229                 match pending_per_peer_msgs.entry(introduction_node_id) {
 230                         hash_map::Entry::Vacant(_) => Err(SendError::InvalidFirstHop),
 231                         hash_map::Entry::Occupied(mut e) => {
 232                                 e.get_mut().push_back(msgs::OnionMessage { blinding_point, onion_routing_packet });
 233                                 Ok(())
 234                         }
 235                 }
 236         }
 237
 238         #[cfg(test)]
 239         pub(super) fn release_pending_msgs(&self) -> HashMap<PublicKey, VecDeque<msgs::OnionMessage>> {
 240                 let mut pending_msgs = self.pending_messages.lock().unwrap();
 241                 let mut msgs = HashMap::new();
 242                 // We don't want to disconnect the peers by removing them entirely from the original map, so we
 243                 // swap the pending message buffers individually.
 244                 for (peer_node_id, pending_messages) in &mut *pending_msgs {
 245                         msgs.insert(*peer_node_id, core::mem::take(pending_messages));
 246                 }
 247                 msgs
 248         }
 249 }
 250
 251 fn outbound_buffer_full(peer_node_id: &PublicKey, buffer: &HashMap<PublicKey, VecDeque<msgs::OnionMessage>>) -> bool {
 252         const MAX_TOTAL_BUFFER_SIZE: usize = (1 << 20) * 128;
 253         const MAX_PER_PEER_BUFFER_SIZE: usize = (1 << 10) * 256;
 254         let mut total_buffered_bytes = 0;
 255         let mut peer_buffered_bytes = 0;
 256         for (pk, peer_buf) in buffer {
 257                 for om in peer_buf {
 258                         let om_len = om.serialized_length();
 259                         if pk == peer_node_id {
 260                                 peer_buffered_bytes += om_len;
 261                         }
 262                         total_buffered_bytes += om_len;
 263
 264                         if total_buffered_bytes >= MAX_TOTAL_BUFFER_SIZE ||
 265                                 peer_buffered_bytes >= MAX_PER_PEER_BUFFER_SIZE
 266                         {
 267                                 return true
 268                         }
 269                 }
 270         }
 271         false
 272 }
 273
 274 impl<Signer: Sign, K: Deref, L: Deref, CMH: Deref> OnionMessageHandler for OnionMessenger<Signer, K, L, CMH>
 275         where K::Target: KeysInterface<Signer = Signer>,
 276               L::Target: Logger,
 277               CMH::Target: CustomOnionMessageHandler,
 278 {
 279         /// Handle an incoming onion message. Currently, if a message was destined for us we will log, but
 280         /// soon we'll delegate the onion message to a handler that can generate invoices or send
 281         /// payments.
 282         fn handle_onion_message(&self, _peer_node_id: &PublicKey, msg: &msgs::OnionMessage) {
 283                 let control_tlvs_ss = match self.keys_manager.ecdh(Recipient::Node, &msg.blinding_point, None) {
 284                         Ok(ss) => ss,
 285                         Err(e) =>  {
 286                                 log_error!(self.logger, "Failed to retrieve node secret: {:?}", e);
 287                                 return
 288                         }
 289                 };
 290                 let onion_decode_ss = {
 291                         let blinding_factor = {
 292                                 let mut hmac = HmacEngine::<Sha256>::new(b"blinded_node_id");
 293                                 hmac.input(control_tlvs_ss.as_ref());
 294                                 Hmac::from_engine(hmac).into_inner()
 295                         };
 296                         match self.keys_manager.ecdh(Recipient::Node, &msg.onion_routing_packet.public_key,
 297                                 Some(&Scalar::from_be_bytes(blinding_factor).unwrap()))
 298                         {
 299                                 Ok(ss) => ss.secret_bytes(),
 300                                 Err(()) => {
 301                                         log_trace!(self.logger, "Failed to compute onion packet shared secret");
 302                                         return
 303                                 }
 304                         }
 305                 };
 306                 match onion_utils::decode_next_hop(onion_decode_ss, &msg.onion_routing_packet.hop_data[..],
 307                         msg.onion_routing_packet.hmac, control_tlvs_ss)
 308                 {
 309                         Ok((Payload::Receive::<<<CMH as Deref>::Target as CustomOnionMessageHandler>::CustomMessage> {
 310                                 message, control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id }), reply_path,
 311                         }, None)) => {
 312                                 log_info!(self.logger,
 313                                         "Received an onion message with path_id {:02x?} and {} reply_path",
 314                                                 path_id, if reply_path.is_some() { "a" } else { "no" });
 315                                 match message {
 316                                         OnionMessageContents::Custom(msg) => self.custom_handler.handle_custom_message(msg),
 317                                 }
 318                         },
 319                         Ok((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
 320                                 next_node_id, next_blinding_override
 321                         })), Some((next_hop_hmac, new_packet_bytes)))) => {
 322                                 // TODO: we need to check whether `next_node_id` is our node, in which case this is a dummy
 323                                 // blinded hop and this onion message is destined for us. In this situation, we should keep
 324                                 // unwrapping the onion layers to get to the final payload. Since we don't have the option
 325                                 // of creating blinded routes with dummy hops currently, we should be ok to not handle this
 326                                 // for now.
 327                                 let new_pubkey = match onion_utils::next_hop_packet_pubkey(&self.secp_ctx, msg.onion_routing_packet.public_key, &onion_decode_ss) {
 328                                         Ok(pk) => pk,
 329                                         Err(e) => {
 330                                                 log_trace!(self.logger, "Failed to compute next hop packet pubkey: {}", e);
 331                                                 return
 332                                         }
 333                                 };
 334                                 let outgoing_packet = Packet {
 335                                         version: 0,
 336                                         public_key: new_pubkey,
 337                                         hop_data: new_packet_bytes,
 338                                         hmac: next_hop_hmac,
 339                                 };
 340                                 let onion_message = msgs::OnionMessage {
 341                                         blinding_point: match next_blinding_override {
 342                                                 Some(blinding_point) => blinding_point,
 343                                                 None => {
 344                                                         let blinding_factor = {
 345                                                                 let mut sha = Sha256::engine();
 346                                                                 sha.input(&msg.blinding_point.serialize()[..]);
 347                                                                 sha.input(control_tlvs_ss.as_ref());
 348                                                                 Sha256::from_engine(sha).into_inner()
 349                                                         };
 350                                                         let next_blinding_point = msg.blinding_point;
 351                                                         match next_blinding_point.mul_tweak(&self.secp_ctx, &Scalar::from_be_bytes(blinding_factor).unwrap()) {
 352                                                                 Ok(bp) => bp,
 353                                                                 Err(e) => {
 354                                                                         log_trace!(self.logger, "Failed to compute next blinding point: {}", e);
 355                                                                         return
 356                                                                 }
 357                                                         }
 358                                                 },
 359                                         },
 360                                         onion_routing_packet: outgoing_packet,
 361                                 };
 362
 363                                 let mut pending_per_peer_msgs = self.pending_messages.lock().unwrap();
 364                                 if outbound_buffer_full(&next_node_id, &pending_per_peer_msgs) {
 365                                         log_trace!(self.logger, "Dropping forwarded onion message to peer {:?}: outbound buffer full", next_node_id);
 366                                         return
 367                                 }
 368
 369                                 #[cfg(fuzzing)]
 370                                 pending_per_peer_msgs.entry(next_node_id).or_insert_with(VecDeque::new);
 371
 372                                 match pending_per_peer_msgs.entry(next_node_id) {
 373                                         hash_map::Entry::Vacant(_) => {
 374                                                 log_trace!(self.logger, "Dropping forwarded onion message to disconnected peer {:?}", next_node_id);
 375                                                 return
 376                                         },
 377                                         hash_map::Entry::Occupied(mut e) => {
 378                                                 e.get_mut().push_back(onion_message);
 379                                                 log_trace!(self.logger, "Forwarding an onion message to peer {}", next_node_id);
 380                                         }
 381                                 };
 382                         },
 383                         Err(e) => {
 384                                 log_trace!(self.logger, "Errored decoding onion message packet: {:?}", e);
 385                         },
 386                         _ => {
 387                                 log_trace!(self.logger, "Received bogus onion message packet, either the sender encoded a final hop as a forwarding hop or vice versa");
 388                         },
 389                 };
 390         }
 391
 392         fn peer_connected(&self, their_node_id: &PublicKey, init: &msgs::Init) -> Result<(), ()> {
 393                 if init.features.supports_onion_messages() {
 394                         let mut peers = self.pending_messages.lock().unwrap();
 395                         peers.insert(their_node_id.clone(), VecDeque::new());
 396                 }
 397                 Ok(())
 398         }
 399
 400         fn peer_disconnected(&self, their_node_id: &PublicKey, _no_connection_possible: bool) {
 401                 let mut pending_msgs = self.pending_messages.lock().unwrap();
 402                 pending_msgs.remove(their_node_id);
 403         }
 404
 405         fn provided_node_features(&self) -> NodeFeatures {
 406                 let mut features = NodeFeatures::empty();
 407                 features.set_onion_messages_optional();
 408                 features
 409         }
 410
 411         fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
 412                 let mut features = InitFeatures::empty();
 413                 features.set_onion_messages_optional();
 414                 features
 415         }
 416 }
 417
 418 impl<Signer: Sign, K: Deref, L: Deref, CMH: Deref> OnionMessageProvider for OnionMessenger<Signer, K, L, CMH>
 419         where K::Target: KeysInterface<Signer = Signer>,
 420               L::Target: Logger,
 421               CMH::Target: CustomOnionMessageHandler,
 422 {
 423         fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<msgs::OnionMessage> {
 424                 let mut pending_msgs = self.pending_messages.lock().unwrap();
 425                 if let Some(msgs) = pending_msgs.get_mut(&peer_node_id) {
 426                         return msgs.pop_front()
 427                 }
 428                 None
 429         }
 430 }
 431
 432 // TODO: parameterize the below Simple* types with OnionMessenger and handle the messages it
 433 // produces
 434 /// Useful for simplifying the parameters of [`SimpleArcChannelManager`] and
 435 /// [`SimpleArcPeerManager`]. See their docs for more details.
 436 ///
 437 /// (C-not exported) as `Arc`s don't make sense in bindings.
 438 ///
 439 /// [`SimpleArcChannelManager`]: crate::ln::channelmanager::SimpleArcChannelManager
 440 /// [`SimpleArcPeerManager`]: crate::ln::peer_handler::SimpleArcPeerManager
 441 pub type SimpleArcOnionMessenger<L> = OnionMessenger<InMemorySigner, Arc<KeysManager>, Arc<L>, IgnoringMessageHandler>;
 442 /// Useful for simplifying the parameters of [`SimpleRefChannelManager`] and
 443 /// [`SimpleRefPeerManager`]. See their docs for more details.
 444 ///
 445 /// (C-not exported) as general type aliases don't make sense in bindings.
 446 ///
 447 /// [`SimpleRefChannelManager`]: crate::ln::channelmanager::SimpleRefChannelManager
 448 /// [`SimpleRefPeerManager`]: crate::ln::peer_handler::SimpleRefPeerManager
 449 pub type SimpleRefOnionMessenger<'a, 'b, L> = OnionMessenger<InMemorySigner, &'a KeysManager, &'b L, IgnoringMessageHandler>;
 450
 451 /// Construct onion packet payloads and keys for sending an onion message along the given
 452 /// `unblinded_path` to the given `destination`.
 453 fn packet_payloads_and_keys<T: CustomOnionMessageContents, S: secp256k1::Signing + secp256k1::Verification>(
 454         secp_ctx: &Secp256k1<S>, unblinded_path: &[PublicKey], destination: Destination,
 455         message: OnionMessageContents<T>, mut reply_path: Option<BlindedRoute>, session_priv: &SecretKey
 456 ) -> Result<(Vec<(Payload<T>, [u8; 32])>, Vec<onion_utils::OnionKeys>), secp256k1::Error> {
 457         let num_hops = unblinded_path.len() + destination.num_hops();
 458         let mut payloads = Vec::with_capacity(num_hops);
 459         let mut onion_packet_keys = Vec::with_capacity(num_hops);
 460
 461         let (mut intro_node_id_blinding_pt, num_blinded_hops) = if let Destination::BlindedRoute(BlindedRoute {
 462                 introduction_node_id, blinding_point, blinded_hops }) = &destination {
 463                 (Some((*introduction_node_id, *blinding_point)), blinded_hops.len()) } else { (None, 0) };
 464         let num_unblinded_hops = num_hops - num_blinded_hops;
 465
 466         let mut unblinded_path_idx = 0;
 467         let mut blinded_path_idx = 0;
 468         let mut prev_control_tlvs_ss = None;
 469         let mut final_control_tlvs = None;
 470         utils::construct_keys_callback(secp_ctx, unblinded_path, Some(destination), session_priv, |_, onion_packet_ss, ephemeral_pubkey, control_tlvs_ss, unblinded_pk_opt, enc_payload_opt| {
 471                 if num_unblinded_hops != 0 && unblinded_path_idx < num_unblinded_hops {
 472                         if let Some(ss) = prev_control_tlvs_ss.take() {
 473                                 payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(
 474                                         ForwardTlvs {
 475                                                 next_node_id: unblinded_pk_opt.unwrap(),
 476                                                 next_blinding_override: None,
 477                                         }
 478                                 )), ss));
 479                         }
 480                         prev_control_tlvs_ss = Some(control_tlvs_ss);
 481                         unblinded_path_idx += 1;
 482                 } else if let Some((intro_node_id, blinding_pt)) = intro_node_id_blinding_pt.take() {
 483                         if let Some(control_tlvs_ss) = prev_control_tlvs_ss.take() {
 484                                 payloads.push((Payload::Forward(ForwardControlTlvs::Unblinded(ForwardTlvs {
 485                                         next_node_id: intro_node_id,
 486                                         next_blinding_override: Some(blinding_pt),
 487                                 })), control_tlvs_ss));
 488                         }
 489                         if let Some(encrypted_payload) = enc_payload_opt {
 490                                 payloads.push((Payload::Forward(ForwardControlTlvs::Blinded(encrypted_payload)),
 491                                         control_tlvs_ss));
 492                         } else { debug_assert!(false); }
 493                         blinded_path_idx += 1;
 494                 } else if blinded_path_idx < num_blinded_hops - 1 && enc_payload_opt.is_some() {
 495                         payloads.push((Payload::Forward(ForwardControlTlvs::Blinded(enc_payload_opt.unwrap())),
 496                                 control_tlvs_ss));
 497                         blinded_path_idx += 1;
 498                 } else if let Some(encrypted_payload) = enc_payload_opt {
 499                         final_control_tlvs = Some(ReceiveControlTlvs::Blinded(encrypted_payload));
 500                         prev_control_tlvs_ss = Some(control_tlvs_ss);
 501                 }
 502
 503                 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(onion_packet_ss.as_ref());
 504                 onion_packet_keys.push(onion_utils::OnionKeys {
 505                         #[cfg(test)]
 506                         shared_secret: onion_packet_ss,
 507                         #[cfg(test)]
 508                         blinding_factor: [0; 32],
 509                         ephemeral_pubkey,
 510                         rho,
 511                         mu,
 512                 });
 513         })?;
 514
 515         if let Some(control_tlvs) = final_control_tlvs {
 516                 payloads.push((Payload::Receive {
 517                         control_tlvs,
 518                         reply_path: reply_path.take(),
 519                         message,
 520                 }, prev_control_tlvs_ss.unwrap()));
 521         } else {
 522                 payloads.push((Payload::Receive {
 523                         control_tlvs: ReceiveControlTlvs::Unblinded(ReceiveTlvs { path_id: None, }),
 524                         reply_path: reply_path.take(),
 525                         message,
 526                 }, prev_control_tlvs_ss.unwrap()));
 527         }
 528
 529         Ok((payloads, onion_packet_keys))
 530 }
 531
 532 /// Errors if the serialized payload size exceeds onion_message::BIG_PACKET_HOP_DATA_LEN
 533 fn construct_onion_message_packet<T: CustomOnionMessageContents>(payloads: Vec<(Payload<T>, [u8; 32])>, onion_keys: Vec<onion_utils::OnionKeys>, prng_seed: [u8; 32]) -> Result<Packet, ()> {
 534         // Spec rationale:
 535         // "`len` allows larger messages to be sent than the standard 1300 bytes allowed for an HTLC
 536         // onion, but this should be used sparingly as it is reduces anonymity set, hence the
 537         // recommendation that it either look like an HTLC onion, or if larger, be a fixed size."
 538         let payloads_ser_len = onion_utils::payloads_serialized_length(&payloads);
 539         let hop_data_len = if payloads_ser_len <= SMALL_PACKET_HOP_DATA_LEN {
 540                 SMALL_PACKET_HOP_DATA_LEN
 541         } else if payloads_ser_len <= BIG_PACKET_HOP_DATA_LEN {
 542                 BIG_PACKET_HOP_DATA_LEN
 543         } else { return Err(()) };
 544
 545         Ok(onion_utils::construct_onion_message_packet::<_, _>(
 546                 payloads, onion_keys, prng_seed, hop_data_len))
 547 }