git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/blinded_path/mod.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 //! Creating blinded paths and related utilities live here.
  11
  12 pub mod payment;
  13 pub(crate) mod message;
  14 pub(crate) mod utils;
  15
  16 use bitcoin::secp256k1::{self, PublicKey, Secp256k1, SecretKey};
  17
  18 use crate::ln::msgs::DecodeError;
  19 use crate::offers::invoice::BlindedPayInfo;
  20 use crate::sign::EntropySource;
  21 use crate::util::ser::{Readable, Writeable, Writer};
  22
  23 use crate::io;
  24 use crate::prelude::*;
  25
  26 /// Onion messages and payments can be sent and received to blinded paths, which serve to hide the
  27 /// identity of the recipient.
  28 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
  29 pub struct BlindedPath {
  30         /// To send to a blinded path, the sender first finds a route to the unblinded
  31         /// `introduction_node_id`, which can unblind its [`encrypted_payload`] to find out the onion
  32         /// message or payment's next hop and forward it along.
  33         ///
  34         /// [`encrypted_payload`]: BlindedHop::encrypted_payload
  35         pub introduction_node_id: PublicKey,
  36         /// Used by the introduction node to decrypt its [`encrypted_payload`] to forward the onion
  37         /// message or payment.
  38         ///
  39         /// [`encrypted_payload`]: BlindedHop::encrypted_payload
  40         pub blinding_point: PublicKey,
  41         /// The hops composing the blinded path.
  42         pub blinded_hops: Vec<BlindedHop>,
  43 }
  44
  45 /// An encrypted payload and node id corresponding to a hop in a payment or onion message path, to
  46 /// be encoded in the sender's onion packet. These hops cannot be identified by outside observers
  47 /// and thus can be used to hide the identity of the recipient.
  48 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
  49 pub struct BlindedHop {
  50         /// The blinded node id of this hop in a [`BlindedPath`].
  51         pub blinded_node_id: PublicKey,
  52         /// The encrypted payload intended for this hop in a [`BlindedPath`].
  53         // The node sending to this blinded path will later encode this payload into the onion packet for
  54         // this hop.
  55         pub encrypted_payload: Vec<u8>,
  56 }
  57
  58 impl BlindedPath {
  59         /// Create a blinded path for an onion message, to be forwarded along `node_pks`. The last node
  60         /// pubkey in `node_pks` will be the destination node.
  61         ///
  62         /// Errors if less than two hops are provided or if `node_pk`(s) are invalid.
  63         //  TODO: make all payloads the same size with padding + add dummy hops
  64         pub fn new_for_message<ES: EntropySource, T: secp256k1::Signing + secp256k1::Verification>
  65                 (node_pks: &[PublicKey], entropy_source: &ES, secp_ctx: &Secp256k1<T>) -> Result<Self, ()>
  66         {
  67                 if node_pks.len() < 2 { return Err(()) }
  68                 let blinding_secret_bytes = entropy_source.get_secure_random_bytes();
  69                 let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
  70                 let introduction_node_id = node_pks[0];
  71
  72                 Ok(BlindedPath {
  73                         introduction_node_id,
  74                         blinding_point: PublicKey::from_secret_key(secp_ctx, &blinding_secret),
  75                         blinded_hops: message::blinded_hops(secp_ctx, node_pks, &blinding_secret).map_err(|_| ())?,
  76                 })
  77         }
  78
  79         /// Create a one-hop blinded path for a payment.
  80         pub fn one_hop_for_payment<ES: EntropySource, T: secp256k1::Signing + secp256k1::Verification>(
  81                 payee_node_id: PublicKey, payee_tlvs: payment::ReceiveTlvs, entropy_source: &ES,
  82                 secp_ctx: &Secp256k1<T>
  83         ) -> Result<(BlindedPayInfo, Self), ()> {
  84                 // This value is not considered in pathfinding for 1-hop blinded paths, because it's intended to
  85                 // be in relation to a specific channel.
  86                 let htlc_maximum_msat = u64::max_value();
  87                 Self::new_for_payment(
  88                         &[], payee_node_id, payee_tlvs, htlc_maximum_msat, entropy_source, secp_ctx
  89                 )
  90         }
  91
  92         /// Create a blinded path for a payment, to be forwarded along `intermediate_nodes`.
  93         ///
  94         /// Errors if:
  95         /// * a provided node id is invalid
  96         /// * [`BlindedPayInfo`] calculation results in an integer overflow
  97         /// * any unknown features are required in the provided [`ForwardTlvs`]
  98         ///
  99         /// [`ForwardTlvs`]: crate::blinded_path::payment::ForwardTlvs
 100         //  TODO: make all payloads the same size with padding + add dummy hops
 101         pub(crate) fn new_for_payment<ES: EntropySource, T: secp256k1::Signing + secp256k1::Verification>(
 102                 intermediate_nodes: &[payment::ForwardNode], payee_node_id: PublicKey,
 103                 payee_tlvs: payment::ReceiveTlvs, htlc_maximum_msat: u64, entropy_source: &ES,
 104                 secp_ctx: &Secp256k1<T>
 105         ) -> Result<(BlindedPayInfo, Self), ()> {
 106                 let blinding_secret_bytes = entropy_source.get_secure_random_bytes();
 107                 let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
 108
 109                 let blinded_payinfo = payment::compute_payinfo(intermediate_nodes, &payee_tlvs, htlc_maximum_msat)?;
 110                 Ok((blinded_payinfo, BlindedPath {
 111                         introduction_node_id: intermediate_nodes.first().map_or(payee_node_id, |n| n.node_id),
 112                         blinding_point: PublicKey::from_secret_key(secp_ctx, &blinding_secret),
 113                         blinded_hops: payment::blinded_hops(
 114                                 secp_ctx, intermediate_nodes, payee_node_id, payee_tlvs, &blinding_secret
 115                         ).map_err(|_| ())?,
 116                 }))
 117         }
 118 }
 119
 120 impl Writeable for BlindedPath {
 121         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 122                 self.introduction_node_id.write(w)?;
 123                 self.blinding_point.write(w)?;
 124                 (self.blinded_hops.len() as u8).write(w)?;
 125                 for hop in &self.blinded_hops {
 126                         hop.write(w)?;
 127                 }
 128                 Ok(())
 129         }
 130 }
 131
 132 impl Readable for BlindedPath {
 133         fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 134                 let introduction_node_id = Readable::read(r)?;
 135                 let blinding_point = Readable::read(r)?;
 136                 let num_hops: u8 = Readable::read(r)?;
 137                 if num_hops == 0 { return Err(DecodeError::InvalidValue) }
 138                 let mut blinded_hops: Vec<BlindedHop> = Vec::with_capacity(num_hops.into());
 139                 for _ in 0..num_hops {
 140                         blinded_hops.push(Readable::read(r)?);
 141                 }
 142                 Ok(BlindedPath {
 143                         introduction_node_id,
 144                         blinding_point,
 145                         blinded_hops,
 146                 })
 147         }
 148 }
 149
 150 impl_writeable!(BlindedHop, {
 151         blinded_node_id,
 152         encrypted_payload
 153 });
 154