_ Git - rust-lightning/blob - lightning/src/ln/onion_utils.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 use crate::crypto::chacha20::ChaCha20;
  11 use crate::crypto::streams::ChaChaReader;
  12 use crate::ln::channelmanager::{HTLCSource, RecipientOnionFields};
  13 use crate::ln::msgs;
  14 use crate::ln::wire::Encode;
  15 use crate::ln::{PaymentHash, PaymentPreimage};
  16 use crate::routing::gossip::NetworkUpdate;
  17 use crate::routing::router::{BlindedTail, Path, RouteHop};
  18 use crate::sign::NodeSigner;
  19 use crate::util::errors::{self, APIError};
  20 use crate::util::logger::Logger;
  21 use crate::util::ser::{LengthCalculatingWriter, Readable, ReadableArgs, Writeable, Writer};
  22
  23 use bitcoin::hashes::cmp::fixed_time_eq;
  24 use bitcoin::hashes::hmac::{Hmac, HmacEngine};
  25 use bitcoin::hashes::sha256::Hash as Sha256;
  26 use bitcoin::hashes::{Hash, HashEngine};
  27
  28 use bitcoin::secp256k1;
  29 use bitcoin::secp256k1::ecdh::SharedSecret;
  30 use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey};
  31
  32 use crate::io::{Cursor, Read};
  33 use crate::prelude::*;
  34 use core::convert::{AsMut, TryInto};
  35 use core::ops::Deref;
  36
  37 pub(crate) struct OnionKeys {
  38         #[cfg(test)]
  39         pub(crate) shared_secret: SharedSecret,
  40         #[cfg(test)]
  41         pub(crate) blinding_factor: [u8; 32],
  42         pub(crate) ephemeral_pubkey: PublicKey,
  43         pub(crate) rho: [u8; 32],
  44         pub(crate) mu: [u8; 32],
  45 }
  46
  47 #[inline]
  48 pub(crate) fn gen_rho_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
  49         assert_eq!(shared_secret.len(), 32);
  50         let mut hmac = HmacEngine::<Sha256>::new(&[0x72, 0x68, 0x6f]); // rho
  51         hmac.input(&shared_secret);
  52         Hmac::from_engine(hmac).to_byte_array()
  53 }
  54
  55 #[inline]
  56 pub(crate) fn gen_rho_mu_from_shared_secret(shared_secret: &[u8]) -> ([u8; 32], [u8; 32]) {
  57         assert_eq!(shared_secret.len(), 32);
  58         let mut engine_rho = HmacEngine::<Sha256>::new(b"rho");
  59         engine_rho.input(&shared_secret);
  60         let hmac_rho = Hmac::from_engine(engine_rho).to_byte_array();
  61
  62         let mut engine_mu = HmacEngine::<Sha256>::new(b"mu");
  63         engine_mu.input(&shared_secret);
  64         let hmac_mu = Hmac::from_engine(engine_mu).to_byte_array();
  65
  66         (hmac_rho, hmac_mu)
  67 }
  68
  69 #[inline]
  70 pub(super) fn gen_um_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
  71         assert_eq!(shared_secret.len(), 32);
  72         let mut hmac = HmacEngine::<Sha256>::new(&[0x75, 0x6d]); // um
  73         hmac.input(&shared_secret);
  74         Hmac::from_engine(hmac).to_byte_array()
  75 }
  76
  77 #[inline]
  78 pub(super) fn gen_ammag_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
  79         assert_eq!(shared_secret.len(), 32);
  80         let mut hmac = HmacEngine::<Sha256>::new(&[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
  81         hmac.input(&shared_secret);
  82         Hmac::from_engine(hmac).to_byte_array()
  83 }
  84
  85 #[cfg(test)]
  86 #[inline]
  87 pub(super) fn gen_pad_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
  88         assert_eq!(shared_secret.len(), 32);
  89         let mut hmac = HmacEngine::<Sha256>::new(&[0x70, 0x61, 0x64]); // pad
  90         hmac.input(&shared_secret);
  91         Hmac::from_engine(hmac).to_byte_array()
  92 }
  93
  94 /// Calculates a pubkey for the next hop, such as the next hop's packet pubkey or blinding point.
  95 pub(crate) fn next_hop_pubkey<T: secp256k1::Verification>(
  96         secp_ctx: &Secp256k1<T>, curr_pubkey: PublicKey, shared_secret: &[u8],
  97 ) -> Result<PublicKey, secp256k1::Error> {
  98         let blinding_factor = {
  99                 let mut sha = Sha256::engine();
 100                 sha.input(&curr_pubkey.serialize()[..]);
 101                 sha.input(shared_secret);
 102                 Sha256::from_engine(sha).to_byte_array()
 103         };
 104
 105         curr_pubkey.mul_tweak(secp_ctx, &Scalar::from_be_bytes(blinding_factor).unwrap())
 106 }
 107
 108 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 109 #[inline]
 110 pub(super) fn construct_onion_keys_callback<T, FType>(
 111         secp_ctx: &Secp256k1<T>, path: &Path, session_priv: &SecretKey, mut callback: FType,
 112 ) -> Result<(), secp256k1::Error>
 113 where
 114         T: secp256k1::Signing,
 115         FType: FnMut(SharedSecret, [u8; 32], PublicKey, Option<&RouteHop>, usize),
 116 {
 117         let mut blinded_priv = session_priv.clone();
 118         let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 119
 120         let unblinded_hops_iter = path.hops.iter().map(|h| (&h.pubkey, Some(h)));
 121         let blinded_pks_iter = path
 122                 .blinded_tail
 123                 .as_ref()
 124                 .map(|t| t.hops.iter())
 125                 .unwrap_or([].iter())
 126                 .skip(1) // Skip the intro node because it's included in the unblinded hops
 127                 .map(|h| (&h.blinded_node_id, None));
 128         for (idx, (pubkey, route_hop_opt)) in unblinded_hops_iter.chain(blinded_pks_iter).enumerate() {
 129                 let shared_secret = SharedSecret::new(pubkey, &blinded_priv);
 130
 131                 let mut sha = Sha256::engine();
 132                 sha.input(&blinded_pub.serialize()[..]);
 133                 sha.input(shared_secret.as_ref());
 134                 let blinding_factor = Sha256::from_engine(sha).to_byte_array();
 135
 136                 let ephemeral_pubkey = blinded_pub;
 137
 138                 blinded_priv = blinded_priv.mul_tweak(&Scalar::from_be_bytes(blinding_factor).unwrap())?;
 139                 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 140
 141                 callback(shared_secret, blinding_factor, ephemeral_pubkey, route_hop_opt, idx);
 142         }
 143
 144         Ok(())
 145 }
 146
 147 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 148 pub(super) fn construct_onion_keys<T: secp256k1::Signing>(
 149         secp_ctx: &Secp256k1<T>, path: &Path, session_priv: &SecretKey,
 150 ) -> Result<Vec<OnionKeys>, secp256k1::Error> {
 151         let mut res = Vec::with_capacity(path.hops.len());
 152
 153         construct_onion_keys_callback(
 154                 secp_ctx,
 155                 &path,
 156                 session_priv,
 157                 |shared_secret, _blinding_factor, ephemeral_pubkey, _, _| {
 158                         let (rho, mu) = gen_rho_mu_from_shared_secret(shared_secret.as_ref());
 159
 160                         res.push(OnionKeys {
 161                                 #[cfg(test)]
 162                                 shared_secret,
 163                                 #[cfg(test)]
 164                                 blinding_factor: _blinding_factor,
 165                                 ephemeral_pubkey,
 166                                 rho,
 167                                 mu,
 168                         });
 169                 },
 170         )?;
 171
 172         Ok(res)
 173 }
 174
 175 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
 176 pub(super) fn build_onion_payloads(
 177         path: &Path, total_msat: u64, mut recipient_onion: RecipientOnionFields,
 178         starting_htlc_offset: u32, keysend_preimage: &Option<PaymentPreimage>,
 179 ) -> Result<(Vec<msgs::OutboundOnionPayload>, u64, u32), APIError> {
 180         let mut cur_value_msat = 0u64;
 181         let mut cur_cltv = starting_htlc_offset;
 182         let mut last_short_channel_id = 0;
 183         let mut res: Vec<msgs::OutboundOnionPayload> = Vec::with_capacity(
 184                 path.hops.len() + path.blinded_tail.as_ref().map_or(0, |t| t.hops.len()),
 185         );
 186
 187         for (idx, hop) in path.hops.iter().rev().enumerate() {
 188                 // First hop gets special values so that it can check, on receipt, that everything is
 189                 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
 190                 // the intended recipient).
 191                 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
 192                 let cltv = if cur_cltv == starting_htlc_offset {
 193                         hop.cltv_expiry_delta + starting_htlc_offset
 194                 } else {
 195                         cur_cltv
 196                 };
 197                 if idx == 0 {
 198                         if let Some(BlindedTail {
 199                                 blinding_point,
 200                                 hops,
 201                                 final_value_msat,
 202                                 excess_final_cltv_expiry_delta,
 203                                 ..
 204                         }) = &path.blinded_tail
 205                         {
 206                                 let mut blinding_point = Some(*blinding_point);
 207                                 for (i, blinded_hop) in hops.iter().enumerate() {
 208                                         if i == hops.len() - 1 {
 209                                                 cur_value_msat += final_value_msat;
 210                                                 res.push(msgs::OutboundOnionPayload::BlindedReceive {
 211                                                         sender_intended_htlc_amt_msat: *final_value_msat,
 212                                                         total_msat,
 213                                                         cltv_expiry_height: cur_cltv + excess_final_cltv_expiry_delta,
 214                                                         encrypted_tlvs: blinded_hop.encrypted_payload.clone(),
 215                                                         intro_node_blinding_point: blinding_point.take(),
 216                                                 });
 217                                         } else {
 218                                                 res.push(msgs::OutboundOnionPayload::BlindedForward {
 219                                                         encrypted_tlvs: blinded_hop.encrypted_payload.clone(),
 220                                                         intro_node_blinding_point: blinding_point.take(),
 221                                                 });
 222                                         }
 223                                 }
 224                         } else {
 225                                 res.push(msgs::OutboundOnionPayload::Receive {
 226                                         payment_data: if let Some(secret) = recipient_onion.payment_secret.take() {
 227                                                 Some(msgs::FinalOnionHopData { payment_secret: secret, total_msat })
 228                                         } else {
 229                                                 None
 230                                         },
 231                                         payment_metadata: recipient_onion.payment_metadata.take(),
 232                                         keysend_preimage: *keysend_preimage,
 233                                         custom_tlvs: recipient_onion.custom_tlvs.clone(),
 234                                         sender_intended_htlc_amt_msat: value_msat,
 235                                         cltv_expiry_height: cltv,
 236                                 });
 237                         }
 238                 } else {
 239                         let payload = msgs::OutboundOnionPayload::Forward {
 240                                 short_channel_id: last_short_channel_id,
 241                                 amt_to_forward: value_msat,
 242                                 outgoing_cltv_value: cltv,
 243                         };
 244                         res.insert(0, payload);
 245                 }
 246                 cur_value_msat += hop.fee_msat;
 247                 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 248                         return Err(APIError::InvalidRoute { err: "Channel fees overflowed?".to_owned() });
 249                 }
 250                 cur_cltv += hop.cltv_expiry_delta as u32;
 251                 if cur_cltv >= 500000000 {
 252                         return Err(APIError::InvalidRoute { err: "Channel CLTV overflowed?".to_owned() });
 253                 }
 254                 last_short_channel_id = hop.short_channel_id;
 255         }
 256         Ok((res, cur_value_msat, cur_cltv))
 257 }
 258
 259 /// Length of the onion data packet. Before TLV-based onions this was 20 65-byte hops, though now
 260 /// the hops can be of variable length.
 261 pub(crate) const ONION_DATA_LEN: usize = 20 * 65;
 262
 263 pub(super) const INVALID_ONION_BLINDING: u16 = 0x8000 | 0x4000 | 24;
 264
 265 #[inline]
 266 fn shift_slice_right(arr: &mut [u8], amt: usize) {
 267         for i in (amt..arr.len()).rev() {
 268                 arr[i] = arr[i - amt];
 269         }
 270         for i in 0..amt {
 271                 arr[i] = 0;
 272         }
 273 }
 274
 275 pub(super) fn construct_onion_packet(
 276         payloads: Vec<msgs::OutboundOnionPayload>, onion_keys: Vec<OnionKeys>, prng_seed: [u8; 32],
 277         associated_data: &PaymentHash,
 278 ) -> Result<msgs::OnionPacket, ()> {
 279         let mut packet_data = [0; ONION_DATA_LEN];
 280
 281         let mut chacha = ChaCha20::new(&prng_seed, &[0; 8]);
 282         chacha.process(&[0; ONION_DATA_LEN], &mut packet_data);
 283
 284         let packet = FixedSizeOnionPacket(packet_data);
 285         construct_onion_packet_with_init_noise::<_, _>(
 286                 payloads,
 287                 onion_keys,
 288                 packet,
 289                 Some(associated_data),
 290         )
 291 }
 292
 293 #[cfg(test)]
 294 /// Used in testing to write bogus `BogusOnionHopData` as well as `RawOnionHopData`, which is
 295 /// otherwise not representable in `msgs::OnionHopData`.
 296 pub(super) fn construct_onion_packet_with_writable_hopdata<HD: Writeable>(
 297         payloads: Vec<HD>, onion_keys: Vec<OnionKeys>, prng_seed: [u8; 32],
 298         associated_data: &PaymentHash,
 299 ) -> Result<msgs::OnionPacket, ()> {
 300         let mut packet_data = [0; ONION_DATA_LEN];
 301
 302         let mut chacha = ChaCha20::new(&prng_seed, &[0; 8]);
 303         chacha.process(&[0; ONION_DATA_LEN], &mut packet_data);
 304
 305         let packet = FixedSizeOnionPacket(packet_data);
 306         construct_onion_packet_with_init_noise::<_, _>(
 307                 payloads,
 308                 onion_keys,
 309                 packet,
 310                 Some(associated_data),
 311         )
 312 }
 313
 314 /// Since onion message packets and onion payment packets have different lengths but are otherwise
 315 /// identical, we use this trait to allow `construct_onion_packet_with_init_noise` to return either
 316 /// type.
 317 pub(crate) trait Packet {
 318         type Data: AsMut<[u8]>;
 319         fn new(pubkey: PublicKey, hop_data: Self::Data, hmac: [u8; 32]) -> Self;
 320 }
 321
 322 // Needed for rustc versions older than 1.47 to avoid E0277: "arrays only have std trait
 323 // implementations for lengths 0..=32".
 324 pub(crate) struct FixedSizeOnionPacket(pub(crate) [u8; ONION_DATA_LEN]);
 325
 326 impl AsMut<[u8]> for FixedSizeOnionPacket {
 327         fn as_mut(&mut self) -> &mut [u8] {
 328                 &mut self.0
 329         }
 330 }
 331
 332 pub(crate) fn payloads_serialized_length<HD: Writeable>(payloads: &Vec<HD>) -> usize {
 333         payloads.iter().map(|p| p.serialized_length() + 32 /* HMAC */).sum()
 334 }
 335
 336 pub(crate) fn construct_onion_message_packet<HD: Writeable, P: Packet<Data = Vec<u8>>>(
 337         payloads: Vec<HD>, onion_keys: Vec<OnionKeys>, prng_seed: [u8; 32], packet_data_len: usize,
 338 ) -> Result<P, ()> {
 339         let mut packet_data = vec![0; packet_data_len];
 340
 341         let mut chacha = ChaCha20::new(&prng_seed, &[0; 8]);
 342         chacha.process_in_place(&mut packet_data);
 343
 344         construct_onion_packet_with_init_noise::<_, _>(payloads, onion_keys, packet_data, None)
 345 }
 346
 347 fn construct_onion_packet_with_init_noise<HD: Writeable, P: Packet>(
 348         mut payloads: Vec<HD>, onion_keys: Vec<OnionKeys>, mut packet_data: P::Data,
 349         associated_data: Option<&PaymentHash>,
 350 ) -> Result<P, ()> {
 351         let filler = {
 352                 let packet_data = packet_data.as_mut();
 353                 const ONION_HOP_DATA_LEN: usize = 65; // We may decrease this eventually after TLV is common
 354                 let mut res = Vec::with_capacity(ONION_HOP_DATA_LEN * (payloads.len() - 1));
 355
 356                 let mut pos = 0;
 357                 for (i, (payload, keys)) in payloads.iter().zip(onion_keys.iter()).enumerate() {
 358                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 359                         // TODO: Batch this.
 360                         for _ in 0..(packet_data.len() - pos) {
 361                                 let mut dummy = [0; 1];
 362                                 chacha.process_in_place(&mut dummy); // We don't have a seek function :(
 363                         }
 364
 365                         let mut payload_len = LengthCalculatingWriter(0);
 366                         payload.write(&mut payload_len).expect("Failed to calculate length");
 367                         pos += payload_len.0 + 32;
 368                         if pos > packet_data.len() {
 369                                 return Err(());
 370                         }
 371
 372                         if i == payloads.len() - 1 {
 373                                 break;
 374                         }
 375
 376                         res.resize(pos, 0u8);
 377                         chacha.process_in_place(&mut res);
 378                 }
 379                 res
 380         };
 381
 382         let mut hmac_res = [0; 32];
 383         for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
 384                 let mut payload_len = LengthCalculatingWriter(0);
 385                 payload.write(&mut payload_len).expect("Failed to calculate length");
 386
 387                 let packet_data = packet_data.as_mut();
 388                 shift_slice_right(packet_data, payload_len.0 + 32);
 389                 packet_data[0..payload_len.0].copy_from_slice(&payload.encode()[..]);
 390                 packet_data[payload_len.0..(payload_len.0 + 32)].copy_from_slice(&hmac_res);
 391
 392                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 393                 chacha.process_in_place(packet_data);
 394
 395                 if i == 0 {
 396                         let stop_index = packet_data.len();
 397                         let start_index = stop_index.checked_sub(filler.len()).ok_or(())?;
 398                         packet_data[start_index..stop_index].copy_from_slice(&filler[..]);
 399                 }
 400
 401                 let mut hmac = HmacEngine::<Sha256>::new(&keys.mu);
 402                 hmac.input(packet_data);
 403                 if let Some(associated_data) = associated_data {
 404                         hmac.input(&associated_data.0[..]);
 405                 }
 406                 hmac_res = Hmac::from_engine(hmac).to_byte_array();
 407         }
 408
 409         Ok(P::new(onion_keys.first().unwrap().ephemeral_pubkey, packet_data, hmac_res))
 410 }
 411
 412 /// Encrypts a failure packet. raw_packet can either be a
 413 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
 414 pub(super) fn encrypt_failure_packet(
 415         shared_secret: &[u8], raw_packet: &[u8],
 416 ) -> msgs::OnionErrorPacket {
 417         let ammag = gen_ammag_from_shared_secret(&shared_secret);
 418
 419         let mut packet_crypted = Vec::with_capacity(raw_packet.len());
 420         packet_crypted.resize(raw_packet.len(), 0);
 421         let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 422         chacha.process(&raw_packet, &mut packet_crypted[..]);
 423         msgs::OnionErrorPacket { data: packet_crypted }
 424 }
 425
 426 pub(super) fn build_failure_packet(
 427         shared_secret: &[u8], failure_type: u16, failure_data: &[u8],
 428 ) -> msgs::DecodedOnionErrorPacket {
 429         assert_eq!(shared_secret.len(), 32);
 430         assert!(failure_data.len() <= 256 - 2);
 431
 432         let um = gen_um_from_shared_secret(&shared_secret);
 433
 434         let failuremsg = {
 435                 let mut res = Vec::with_capacity(2 + failure_data.len());
 436                 res.push(((failure_type >> 8) & 0xff) as u8);
 437                 res.push(((failure_type >> 0) & 0xff) as u8);
 438                 res.extend_from_slice(&failure_data[..]);
 439                 res
 440         };
 441         let pad = {
 442                 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
 443                 res.resize(256 - 2 - failure_data.len(), 0);
 444                 res
 445         };
 446         let mut packet = msgs::DecodedOnionErrorPacket { hmac: [0; 32], failuremsg, pad };
 447
 448         let mut hmac = HmacEngine::<Sha256>::new(&um);
 449         hmac.input(&packet.encode()[32..]);
 450         packet.hmac = Hmac::from_engine(hmac).to_byte_array();
 451
 452         packet
 453 }
 454
 455 #[cfg(test)]
 456 pub(super) fn build_first_hop_failure_packet(
 457         shared_secret: &[u8], failure_type: u16, failure_data: &[u8],
 458 ) -> msgs::OnionErrorPacket {
 459         let failure_packet = build_failure_packet(shared_secret, failure_type, failure_data);
 460         encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
 461 }
 462
 463 pub(crate) struct DecodedOnionFailure {
 464         pub(crate) network_update: Option<NetworkUpdate>,
 465         pub(crate) short_channel_id: Option<u64>,
 466         pub(crate) payment_failed_permanently: bool,
 467         pub(crate) failed_within_blinded_path: bool,
 468         #[cfg(test)]
 469         pub(crate) onion_error_code: Option<u16>,
 470         #[cfg(test)]
 471         pub(crate) onion_error_data: Option<Vec<u8>>,
 472 }
 473
 474 /// Note that we always decrypt `packet` in-place here even if the deserialization into
 475 /// [`msgs::DecodedOnionErrorPacket`] ultimately fails.
 476 fn decrypt_onion_error_packet(
 477         packet: &mut Vec<u8>, shared_secret: SharedSecret,
 478 ) -> Result<msgs::DecodedOnionErrorPacket, msgs::DecodeError> {
 479         let ammag = gen_ammag_from_shared_secret(shared_secret.as_ref());
 480         let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 481         chacha.process_in_place(packet);
 482         msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(packet))
 483 }
 484
 485 /// Process failure we got back from upstream on a payment we sent (implying htlc_source is an
 486 /// OutboundRoute).
 487 #[inline]
 488 pub(super) fn process_onion_failure<T: secp256k1::Signing, L: Deref>(
 489         secp_ctx: &Secp256k1<T>, logger: &L, htlc_source: &HTLCSource, mut encrypted_packet: Vec<u8>,
 490 ) -> DecodedOnionFailure
 491 where
 492         L::Target: Logger,
 493 {
 494         let (path, session_priv, first_hop_htlc_msat) = match htlc_source {
 495                 HTLCSource::OutboundRoute {
 496                         ref path, ref session_priv, ref first_hop_htlc_msat, ..
 497                 } => (path, session_priv, first_hop_htlc_msat),
 498                 _ => {
 499                         unreachable!()
 500                 },
 501         };
 502
 503         // Learnings from the HTLC failure to inform future payment retries and scoring.
 504         struct FailureLearnings {
 505                 network_update: Option<NetworkUpdate>,
 506                 short_channel_id: Option<u64>,
 507                 payment_failed_permanently: bool,
 508                 failed_within_blinded_path: bool,
 509         }
 510         let mut res: Option<FailureLearnings> = None;
 511         let mut htlc_msat = *first_hop_htlc_msat;
 512         let mut error_code_ret = None;
 513         let mut error_packet_ret = None;
 514         let mut is_from_final_node = false;
 515
 516         const BADONION: u16 = 0x8000;
 517         const PERM: u16 = 0x4000;
 518         const NODE: u16 = 0x2000;
 519         const UPDATE: u16 = 0x1000;
 520
 521         // Handle packed channel/node updates for passing back for the route handler
 522         let callback = |shared_secret, _, _, route_hop_opt: Option<&RouteHop>, route_hop_idx| {
 523                 if res.is_some() {
 524                         return;
 525                 }
 526
 527                 let route_hop = match route_hop_opt {
 528                         Some(hop) => hop,
 529                         None => {
 530                                 // Got an error from within a blinded route.
 531                                 error_code_ret = Some(BADONION | PERM | 24); // invalid_onion_blinding
 532                                 error_packet_ret = Some(vec![0; 32]);
 533                                 res = Some(FailureLearnings {
 534                                         network_update: None,
 535                                         short_channel_id: None,
 536                                         payment_failed_permanently: false,
 537                                         failed_within_blinded_path: true,
 538                                 });
 539                                 return;
 540                         },
 541                 };
 542
 543                 // The failing hop includes either the inbound channel to the recipient or the outbound channel
 544                 // from the current hop (i.e., the next hop's inbound channel).
 545                 let num_blinded_hops = path.blinded_tail.as_ref().map_or(0, |bt| bt.hops.len());
 546                 // For 1-hop blinded paths, the final `path.hops` entry is the recipient.
 547                 is_from_final_node = route_hop_idx + 1 == path.hops.len() && num_blinded_hops <= 1;
 548                 let failing_route_hop = if is_from_final_node {
 549                         route_hop
 550                 } else {
 551                         match path.hops.get(route_hop_idx + 1) {
 552                                 Some(hop) => hop,
 553                                 None => {
 554                                         // The failing hop is within a multi-hop blinded path.
 555                                         #[cfg(not(test))]
 556                                         {
 557                                                 error_code_ret = Some(BADONION | PERM | 24); // invalid_onion_blinding
 558                                                 error_packet_ret = Some(vec![0; 32]);
 559                                         }
 560                                         #[cfg(test)]
 561                                         {
 562                                                 // Actually parse the onion error data in tests so we can check that blinded hops fail
 563                                                 // back correctly.
 564                                                 let err_packet =
 565                                                         decrypt_onion_error_packet(&mut encrypted_packet, shared_secret)
 566                                                                 .unwrap();
 567                                                 error_code_ret = Some(u16::from_be_bytes(
 568                                                         err_packet.failuremsg.get(0..2).unwrap().try_into().unwrap(),
 569                                                 ));
 570                                                 error_packet_ret = Some(err_packet.failuremsg[2..].to_vec());
 571                                         }
 572
 573                                         res = Some(FailureLearnings {
 574                                                 network_update: None,
 575                                                 short_channel_id: None,
 576                                                 payment_failed_permanently: false,
 577                                                 failed_within_blinded_path: true,
 578                                         });
 579                                         return;
 580                                 },
 581                         }
 582                 };
 583
 584                 let amt_to_forward = htlc_msat - route_hop.fee_msat;
 585                 htlc_msat = amt_to_forward;
 586
 587                 let err_packet = match decrypt_onion_error_packet(&mut encrypted_packet, shared_secret) {
 588                         Ok(p) => p,
 589                         Err(_) => return,
 590                 };
 591                 let um = gen_um_from_shared_secret(shared_secret.as_ref());
 592                 let mut hmac = HmacEngine::<Sha256>::new(&um);
 593                 hmac.input(&err_packet.encode()[32..]);
 594
 595                 if !fixed_time_eq(&Hmac::from_engine(hmac).to_byte_array(), &err_packet.hmac) {
 596                         return;
 597                 }
 598                 let error_code_slice = match err_packet.failuremsg.get(0..2) {
 599                         Some(s) => s,
 600                         None => {
 601                                 // Useless packet that we can't use but it passed HMAC, so it definitely came from the peer
 602                                 // in question
 603                                 let network_update = Some(NetworkUpdate::NodeFailure {
 604                                         node_id: route_hop.pubkey,
 605                                         is_permanent: true,
 606                                 });
 607                                 let short_channel_id = Some(route_hop.short_channel_id);
 608                                 res = Some(FailureLearnings {
 609                                         network_update,
 610                                         short_channel_id,
 611                                         payment_failed_permanently: is_from_final_node,
 612                                         failed_within_blinded_path: false,
 613                                 });
 614                                 return;
 615                         },
 616                 };
 617
 618                 let error_code = u16::from_be_bytes(error_code_slice.try_into().expect("len is 2"));
 619                 error_code_ret = Some(error_code);
 620                 error_packet_ret = Some(err_packet.failuremsg[2..].to_vec());
 621
 622                 let (debug_field, debug_field_size) = errors::get_onion_debug_field(error_code);
 623
 624                 // indicate that payment parameter has failed and no need to update Route object
 625                 let payment_failed = match error_code & 0xff {
 626                         15 | 16 | 17 | 18 | 19 | 23 => true,
 627                         _ => false,
 628                 } && is_from_final_node; // PERM bit observed below even if this error is from the intermediate nodes
 629
 630                 let mut network_update = None;
 631                 let mut short_channel_id = None;
 632
 633                 if error_code & BADONION == BADONION {
 634                         // If the error code has the BADONION bit set, always blame the channel from the node
 635                         // "originating" the error to its next hop. The "originator" is ultimately actually claiming
 636                         // that its counterparty is the one who is failing the HTLC.
 637                         // If the "originator" here isn't lying we should really mark the next-hop node as failed
 638                         // entirely, but we can't be confident in that, as it would allow any node to get us to
 639                         // completely ban one of its counterparties. Instead, we simply remove the channel in
 640                         // question.
 641                         network_update = Some(NetworkUpdate::ChannelFailure {
 642                                 short_channel_id: failing_route_hop.short_channel_id,
 643                                 is_permanent: true,
 644                         });
 645                 } else if error_code & NODE == NODE {
 646                         let is_permanent = error_code & PERM == PERM;
 647                         network_update =
 648                                 Some(NetworkUpdate::NodeFailure { node_id: route_hop.pubkey, is_permanent });
 649                         short_channel_id = Some(route_hop.short_channel_id);
 650                 } else if error_code & PERM == PERM {
 651                         if !payment_failed {
 652                                 network_update = Some(NetworkUpdate::ChannelFailure {
 653                                         short_channel_id: failing_route_hop.short_channel_id,
 654                                         is_permanent: true,
 655                                 });
 656                                 short_channel_id = Some(failing_route_hop.short_channel_id);
 657                         }
 658                 } else if error_code & UPDATE == UPDATE {
 659                         if let Some(update_len_slice) =
 660                                 err_packet.failuremsg.get(debug_field_size + 2..debug_field_size + 4)
 661                         {
 662                                 let update_len =
 663                                         u16::from_be_bytes(update_len_slice.try_into().expect("len is 2")) as usize;
 664                                 if let Some(mut update_slice) = err_packet
 665                                         .failuremsg
 666                                         .get(debug_field_size + 4..debug_field_size + 4 + update_len)
 667                                 {
 668                                         // Historically, the BOLTs were unclear if the message type
 669                                         // bytes should be included here or not. The BOLTs have now
 670                                         // been updated to indicate that they *are* included, but many
 671                                         // nodes still send messages without the type bytes, so we
 672                                         // support both here.
 673                                         // TODO: Switch to hard require the type prefix, as the current
 674                                         // permissiveness introduces the (although small) possibility
 675                                         // that we fail to decode legitimate channel updates that
 676                                         // happen to start with ChannelUpdate::TYPE, i.e., [0x01, 0x02].
 677                                         if update_slice.len() > 2
 678                                                 && update_slice[0..2] == msgs::ChannelUpdate::TYPE.to_be_bytes()
 679                                         {
 680                                                 update_slice = &update_slice[2..];
 681                                         } else {
 682                                                 log_trace!(logger, "Failure provided features a channel update without type prefix. Deprecated, but allowing for now.");
 683                                         }
 684                                         let update_opt = msgs::ChannelUpdate::read(&mut Cursor::new(&update_slice));
 685                                         if update_opt.is_ok() || update_slice.is_empty() {
 686                                                 // if channel_update should NOT have caused the failure:
 687                                                 // MAY treat the channel_update as invalid.
 688                                                 let is_chan_update_invalid = match error_code & 0xff {
 689                                                         7 => false,
 690                                                         11 => {
 691                                                                 update_opt.is_ok()
 692                                                                         && amt_to_forward
 693                                                                                 > update_opt.as_ref().unwrap().contents.htlc_minimum_msat
 694                                                         },
 695                                                         12 => {
 696                                                                 update_opt.is_ok()
 697                                                                         && amt_to_forward
 698                                                                                 .checked_mul(
 699                                                                                         update_opt
 700                                                                                                 .as_ref()
 701                                                                                                 .unwrap()
 702                                                                                                 .contents
 703                                                                                                 .fee_proportional_millionths as u64,
 704                                                                                 )
 705                                                                                 .map(|prop_fee| prop_fee / 1_000_000)
 706                                                                                 .and_then(|prop_fee| {
 707                                                                                         prop_fee.checked_add(
 708                                                                                                 update_opt.as_ref().unwrap().contents.fee_base_msat
 709                                                                                                         as u64,
 710                                                                                         )
 711                                                                                 })
 712                                                                                 .map(|fee_msats| route_hop.fee_msat >= fee_msats)
 713                                                                                 .unwrap_or(false)
 714                                                         },
 715                                                         13 => {
 716                                                                 update_opt.is_ok()
 717                                                                         && route_hop.cltv_expiry_delta as u16
 718                                                                                 >= update_opt.as_ref().unwrap().contents.cltv_expiry_delta
 719                                                         },
 720                                                         14 => false, // expiry_too_soon; always valid?
 721                                                         20 => update_opt.as_ref().unwrap().contents.flags & 2 == 0,
 722                                                         _ => false, // unknown error code; take channel_update as valid
 723                                                 };
 724                                                 if is_chan_update_invalid {
 725                                                         // This probably indicates the node which forwarded
 726                                                         // to the node in question corrupted something.
 727                                                         network_update = Some(NetworkUpdate::ChannelFailure {
 728                                                                 short_channel_id: route_hop.short_channel_id,
 729                                                                 is_permanent: true,
 730                                                         });
 731                                                 } else {
 732                                                         if let Ok(chan_update) = update_opt {
 733                                                                 // Make sure the ChannelUpdate contains the expected
 734                                                                 // short channel id.
 735                                                                 if failing_route_hop.short_channel_id
 736                                                                         == chan_update.contents.short_channel_id
 737                                                                 {
 738                                                                         short_channel_id = Some(failing_route_hop.short_channel_id);
 739                                                                 } else {
 740                                                                         log_info!(logger, "Node provided a channel_update for which it was not authoritative, ignoring.");
 741                                                                 }
 742                                                                 network_update =
 743                                                                         Some(NetworkUpdate::ChannelUpdateMessage { msg: chan_update })
 744                                                         } else {
 745                                                                 // The node in question intentionally encoded a 0-length channel update. This is
 746                                                                 // likely due to https://github.com/ElementsProject/lightning/issues/6200.
 747                                                                 short_channel_id = Some(failing_route_hop.short_channel_id);
 748                                                                 network_update = Some(NetworkUpdate::ChannelFailure {
 749                                                                         short_channel_id: failing_route_hop.short_channel_id,
 750                                                                         is_permanent: false,
 751                                                                 });
 752                                                         }
 753                                                 };
 754                                         } else {
 755                                                 // If the channel_update had a non-zero length (i.e. was
 756                                                 // present) but we couldn't read it, treat it as a total
 757                                                 // node failure.
 758                                                 log_info!(
 759                                                         logger,
 760                                                         "Failed to read a channel_update of len {} in an onion",
 761                                                         update_slice.len()
 762                                                 );
 763                                         }
 764                                 }
 765                         }
 766                         if network_update.is_none() {
 767                                 // They provided an UPDATE which was obviously bogus, not worth
 768                                 // trying to relay through them anymore.
 769                                 network_update = Some(NetworkUpdate::NodeFailure {
 770                                         node_id: route_hop.pubkey,
 771                                         is_permanent: true,
 772                                 });
 773                         }
 774                         if short_channel_id.is_none() {
 775                                 short_channel_id = Some(route_hop.short_channel_id);
 776                         }
 777                 } else if payment_failed {
 778                         // Only blame the hop when a value in the HTLC doesn't match the corresponding value in the
 779                         // onion.
 780                         short_channel_id = match error_code & 0xff {
 781                                 18 | 19 => Some(route_hop.short_channel_id),
 782                                 _ => None,
 783                         };
 784                 } else {
 785                         // We can't understand their error messages and they failed to forward...they probably can't
 786                         // understand our forwards so it's really not worth trying any further.
 787                         network_update =
 788                                 Some(NetworkUpdate::NodeFailure { node_id: route_hop.pubkey, is_permanent: true });
 789                         short_channel_id = Some(route_hop.short_channel_id);
 790                 }
 791
 792                 res = Some(FailureLearnings {
 793                         network_update,
 794                         short_channel_id,
 795                         payment_failed_permanently: error_code & PERM == PERM && is_from_final_node,
 796                         failed_within_blinded_path: false,
 797                 });
 798
 799                 let (description, title) = errors::get_onion_error_description(error_code);
 800                 if debug_field_size > 0 && err_packet.failuremsg.len() >= 4 + debug_field_size {
 801                         log_info!(
 802                                 logger,
 803                                 "Onion Error[from {}: {}({:#x}) {}({})] {}",
 804                                 route_hop.pubkey,
 805                                 title,
 806                                 error_code,
 807                                 debug_field,
 808                                 log_bytes!(&err_packet.failuremsg[4..4 + debug_field_size]),
 809                                 description
 810                         );
 811                 } else {
 812                         log_info!(
 813                                 logger,
 814                                 "Onion Error[from {}: {}({:#x})] {}",
 815                                 route_hop.pubkey,
 816                                 title,
 817                                 error_code,
 818                                 description
 819                         );
 820                 }
 821         };
 822
 823         construct_onion_keys_callback(secp_ctx, &path, session_priv, callback)
 824                 .expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
 825
 826         if let Some(FailureLearnings {
 827                 network_update,
 828                 short_channel_id,
 829                 payment_failed_permanently,
 830                 failed_within_blinded_path,
 831         }) = res
 832         {
 833                 DecodedOnionFailure {
 834                         network_update,
 835                         short_channel_id,
 836                         payment_failed_permanently,
 837                         failed_within_blinded_path,
 838                         #[cfg(test)]
 839                         onion_error_code: error_code_ret,
 840                         #[cfg(test)]
 841                         onion_error_data: error_packet_ret,
 842                 }
 843         } else {
 844                 // only not set either packet unparseable or hmac does not match with any
 845                 // payment not retryable only when garbage is from the final node
 846                 DecodedOnionFailure {
 847                         network_update: None,
 848                         short_channel_id: None,
 849                         payment_failed_permanently: is_from_final_node,
 850                         failed_within_blinded_path: false,
 851                         #[cfg(test)]
 852                         onion_error_code: None,
 853                         #[cfg(test)]
 854                         onion_error_data: None,
 855                 }
 856         }
 857 }
 858
 859 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
 860 #[cfg_attr(test, derive(PartialEq))]
 861 pub(super) struct HTLCFailReason(HTLCFailReasonRepr);
 862
 863 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
 864 #[cfg_attr(test, derive(PartialEq))]
 865 enum HTLCFailReasonRepr {
 866         LightningError { err: msgs::OnionErrorPacket },
 867         Reason { failure_code: u16, data: Vec<u8> },
 868 }
 869
 870 impl core::fmt::Debug for HTLCFailReason {
 871         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
 872                 match self.0 {
 873                         HTLCFailReasonRepr::Reason { ref failure_code, .. } => {
 874                                 write!(f, "HTLC error code {}", failure_code)
 875                         },
 876                         HTLCFailReasonRepr::LightningError { .. } => {
 877                                 write!(f, "pre-built LightningError")
 878                         },
 879                 }
 880         }
 881 }
 882
 883 impl Writeable for HTLCFailReason {
 884         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
 885                 self.0.write(writer)
 886         }
 887 }
 888 impl Readable for HTLCFailReason {
 889         fn read<R: Read>(reader: &mut R) -> Result<Self, msgs::DecodeError> {
 890                 Ok(Self(Readable::read(reader)?))
 891         }
 892 }
 893
 894 impl_writeable_tlv_based_enum!(HTLCFailReasonRepr,
 895         (0, LightningError) => {
 896                 (0, err, required),
 897         },
 898         (1, Reason) => {
 899                 (0, failure_code, required),
 900                 (2, data, required_vec),
 901         },
 902 ;);
 903
 904 impl HTLCFailReason {
 905         #[rustfmt::skip]
 906         pub(super) fn reason(failure_code: u16, data: Vec<u8>) -> Self {
 907                 const BADONION: u16 = 0x8000;
 908                 const PERM: u16 = 0x4000;
 909                 const NODE: u16 = 0x2000;
 910                 const UPDATE: u16 = 0x1000;
 911
 912                      if failure_code == 1  | PERM { debug_assert!(data.is_empty()) }
 913                 else if failure_code == 2  | NODE { debug_assert!(data.is_empty()) }
 914                 else if failure_code == 2  | PERM | NODE { debug_assert!(data.is_empty()) }
 915                 else if failure_code == 3  | PERM | NODE { debug_assert!(data.is_empty()) }
 916                 else if failure_code == 4  | BADONION | PERM { debug_assert_eq!(data.len(), 32) }
 917                 else if failure_code == 5  | BADONION | PERM { debug_assert_eq!(data.len(), 32) }
 918                 else if failure_code == 6  | BADONION | PERM { debug_assert_eq!(data.len(), 32) }
 919                 else if failure_code == 7  | UPDATE {
 920                         debug_assert_eq!(data.len() - 2, u16::from_be_bytes(data[0..2].try_into().unwrap()) as usize) }
 921                 else if failure_code == 8  | PERM { debug_assert!(data.is_empty()) }
 922                 else if failure_code == 9  | PERM { debug_assert!(data.is_empty()) }
 923                 else if failure_code == 10 | PERM { debug_assert!(data.is_empty()) }
 924                 else if failure_code == 11 | UPDATE {
 925                         debug_assert_eq!(data.len() - 2 - 8, u16::from_be_bytes(data[8..10].try_into().unwrap()) as usize) }
 926                 else if failure_code == 12 | UPDATE {
 927                         debug_assert_eq!(data.len() - 2 - 8, u16::from_be_bytes(data[8..10].try_into().unwrap()) as usize) }
 928                 else if failure_code == 13 | UPDATE {
 929                         debug_assert_eq!(data.len() - 2 - 4, u16::from_be_bytes(data[4..6].try_into().unwrap()) as usize) }
 930                 else if failure_code == 14 | UPDATE {
 931                         debug_assert_eq!(data.len() - 2, u16::from_be_bytes(data[0..2].try_into().unwrap()) as usize) }
 932                 else if failure_code == 15 | PERM { debug_assert_eq!(data.len(), 12) }
 933                 else if failure_code == 18 { debug_assert_eq!(data.len(), 4) }
 934                 else if failure_code == 19 { debug_assert_eq!(data.len(), 8) }
 935                 else if failure_code == 20 | UPDATE {
 936                         debug_assert_eq!(data.len() - 2 - 2, u16::from_be_bytes(data[2..4].try_into().unwrap()) as usize) }
 937                 else if failure_code == 21 { debug_assert!(data.is_empty()) }
 938                 else if failure_code == 22 | PERM { debug_assert!(data.len() <= 11) }
 939                 else if failure_code == 23 { debug_assert!(data.is_empty()) }
 940                 else if failure_code & BADONION != 0 {
 941                         // We set some bogus BADONION failure codes in test, so ignore unknown ones.
 942                 }
 943                 else { debug_assert!(false, "Unknown failure code: {}", failure_code) }
 944
 945                 Self(HTLCFailReasonRepr::Reason { failure_code, data })
 946         }
 947
 948         pub(super) fn from_failure_code(failure_code: u16) -> Self {
 949                 Self::reason(failure_code, Vec::new())
 950         }
 951
 952         pub(super) fn from_msg(msg: &msgs::UpdateFailHTLC) -> Self {
 953                 Self(HTLCFailReasonRepr::LightningError { err: msg.reason.clone() })
 954         }
 955
 956         pub(super) fn get_encrypted_failure_packet(
 957                 &self, incoming_packet_shared_secret: &[u8; 32], phantom_shared_secret: &Option<[u8; 32]>,
 958         ) -> msgs::OnionErrorPacket {
 959                 match self.0 {
 960                         HTLCFailReasonRepr::Reason { ref failure_code, ref data } => {
 961                                 if let Some(phantom_ss) = phantom_shared_secret {
 962                                         let phantom_packet =
 963                                                 build_failure_packet(phantom_ss, *failure_code, &data[..]).encode();
 964                                         let encrypted_phantom_packet =
 965                                                 encrypt_failure_packet(phantom_ss, &phantom_packet);
 966                                         encrypt_failure_packet(
 967                                                 incoming_packet_shared_secret,
 968                                                 &encrypted_phantom_packet.data[..],
 969                                         )
 970                                 } else {
 971                                         let packet = build_failure_packet(
 972                                                 incoming_packet_shared_secret,
 973                                                 *failure_code,
 974                                                 &data[..],
 975                                         )
 976                                         .encode();
 977                                         encrypt_failure_packet(incoming_packet_shared_secret, &packet)
 978                                 }
 979                         },
 980                         HTLCFailReasonRepr::LightningError { ref err } => {
 981                                 encrypt_failure_packet(incoming_packet_shared_secret, &err.data)
 982                         },
 983                 }
 984         }
 985
 986         pub(super) fn decode_onion_failure<T: secp256k1::Signing, L: Deref>(
 987                 &self, secp_ctx: &Secp256k1<T>, logger: &L, htlc_source: &HTLCSource,
 988         ) -> DecodedOnionFailure
 989         where
 990                 L::Target: Logger,
 991         {
 992                 match self.0 {
 993                         HTLCFailReasonRepr::LightningError { ref err } => {
 994                                 process_onion_failure(secp_ctx, logger, &htlc_source, err.data.clone())
 995                         },
 996                         #[allow(unused)]
 997                         HTLCFailReasonRepr::Reason { ref failure_code, ref data, .. } => {
 998                                 // we get a fail_malformed_htlc from the first hop
 999                                 // TODO: We'd like to generate a NetworkUpdate for temporary
1000                                 // failures here, but that would be insufficient as find_route
1001                                 // generally ignores its view of our own channels as we provide them via
1002                                 // ChannelDetails.
1003                                 if let &HTLCSource::OutboundRoute { ref path, .. } = htlc_source {
1004                                         DecodedOnionFailure {
1005                                                 network_update: None,
1006                                                 payment_failed_permanently: false,
1007                                                 short_channel_id: Some(path.hops[0].short_channel_id),
1008                                                 failed_within_blinded_path: false,
1009                                                 #[cfg(test)]
1010                                                 onion_error_code: Some(*failure_code),
1011                                                 #[cfg(test)]
1012                                                 onion_error_data: Some(data.clone()),
1013                                         }
1014                                 } else {
1015                                         unreachable!();
1016                                 }
1017                         },
1018                 }
1019         }
1020 }
1021
1022 /// Allows `decode_next_hop` to return the next hop packet bytes for either payments or onion
1023 /// message forwards.
1024 pub(crate) trait NextPacketBytes: AsMut<[u8]> {
1025         fn new(len: usize) -> Self;
1026 }
1027
1028 impl NextPacketBytes for FixedSizeOnionPacket {
1029         fn new(_len: usize) -> Self {
1030                 Self([0 as u8; ONION_DATA_LEN])
1031         }
1032 }
1033
1034 impl NextPacketBytes for Vec<u8> {
1035         fn new(len: usize) -> Self {
1036                 vec![0 as u8; len]
1037         }
1038 }
1039
1040 /// Data decrypted from a payment's onion payload.
1041 pub(crate) enum Hop {
1042         /// This onion payload was for us, not for forwarding to a next-hop. Contains information for
1043         /// verifying the incoming payment.
1044         Receive(msgs::InboundOnionPayload),
1045         /// This onion payload needs to be forwarded to a next-hop.
1046         Forward {
1047                 /// Onion payload data used in forwarding the payment.
1048                 next_hop_data: msgs::InboundOnionPayload,
1049                 /// HMAC of the next hop's onion packet.
1050                 next_hop_hmac: [u8; 32],
1051                 /// Bytes of the onion packet we're forwarding.
1052                 new_packet_bytes: [u8; ONION_DATA_LEN],
1053         },
1054 }
1055
1056 /// Error returned when we fail to decode the onion packet.
1057 #[derive(Debug)]
1058 pub(crate) enum OnionDecodeErr {
1059         /// The HMAC of the onion packet did not match the hop data.
1060         Malformed { err_msg: &'static str, err_code: u16 },
1061         /// We failed to decode the onion payload.
1062         Relay { err_msg: &'static str, err_code: u16 },
1063 }
1064
1065 pub(crate) fn decode_next_payment_hop<NS: Deref>(
1066         shared_secret: [u8; 32], hop_data: &[u8], hmac_bytes: [u8; 32], payment_hash: PaymentHash,
1067         blinding_point: Option<PublicKey>, node_signer: &NS,
1068 ) -> Result<Hop, OnionDecodeErr>
1069 where
1070         NS::Target: NodeSigner,
1071 {
1072         match decode_next_hop(
1073                 shared_secret,
1074                 hop_data,
1075                 hmac_bytes,
1076                 Some(payment_hash),
1077                 (blinding_point, node_signer),
1078         ) {
1079                 Ok((next_hop_data, None)) => Ok(Hop::Receive(next_hop_data)),
1080                 Ok((next_hop_data, Some((next_hop_hmac, FixedSizeOnionPacket(new_packet_bytes))))) => {
1081                         Ok(Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes })
1082                 },
1083                 Err(e) => Err(e),
1084         }
1085 }
1086
1087 /// Build a payment onion, returning the first hop msat and cltv values as well.
1088 /// `cur_block_height` should be set to the best known block height + 1.
1089 pub fn create_payment_onion<T: secp256k1::Signing>(
1090         secp_ctx: &Secp256k1<T>, path: &Path, session_priv: &SecretKey, total_msat: u64,
1091         recipient_onion: RecipientOnionFields, cur_block_height: u32, payment_hash: &PaymentHash,
1092         keysend_preimage: &Option<PaymentPreimage>, prng_seed: [u8; 32],
1093 ) -> Result<(msgs::OnionPacket, u64, u32), APIError> {
1094         let onion_keys = construct_onion_keys(&secp_ctx, &path, &session_priv).map_err(|_| {
1095                 APIError::InvalidRoute { err: "Pubkey along hop was maliciously selected".to_owned() }
1096         })?;
1097         let (onion_payloads, htlc_msat, htlc_cltv) = build_onion_payloads(
1098                 &path,
1099                 total_msat,
1100                 recipient_onion,
1101                 cur_block_height,
1102                 keysend_preimage,
1103         )?;
1104         let onion_packet = construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
1105                 .map_err(|_| APIError::InvalidRoute {
1106                         err: "Route size too large considering onion data".to_owned(),
1107                 })?;
1108         Ok((onion_packet, htlc_msat, htlc_cltv))
1109 }
1110
1111 pub(crate) fn decode_next_untagged_hop<T, R: ReadableArgs<T>, N: NextPacketBytes>(
1112         shared_secret: [u8; 32], hop_data: &[u8], hmac_bytes: [u8; 32], read_args: T,
1113 ) -> Result<(R, Option<([u8; 32], N)>), OnionDecodeErr> {
1114         decode_next_hop(shared_secret, hop_data, hmac_bytes, None, read_args)
1115 }
1116
1117 fn decode_next_hop<T, R: ReadableArgs<T>, N: NextPacketBytes>(
1118         shared_secret: [u8; 32], hop_data: &[u8], hmac_bytes: [u8; 32],
1119         payment_hash: Option<PaymentHash>, read_args: T,
1120 ) -> Result<(R, Option<([u8; 32], N)>), OnionDecodeErr> {
1121         let (rho, mu) = gen_rho_mu_from_shared_secret(&shared_secret);
1122         let mut hmac = HmacEngine::<Sha256>::new(&mu);
1123         hmac.input(hop_data);
1124         if let Some(tag) = payment_hash {
1125                 hmac.input(&tag.0[..]);
1126         }
1127         if !fixed_time_eq(&Hmac::from_engine(hmac).to_byte_array(), &hmac_bytes) {
1128                 return Err(OnionDecodeErr::Malformed {
1129                         err_msg: "HMAC Check failed",
1130                         err_code: 0x8000 | 0x4000 | 5,
1131                 });
1132         }
1133
1134         let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1135         let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&hop_data[..]) };
1136         match R::read(&mut chacha_stream, read_args) {
1137                 Err(err) => {
1138                         let error_code = match err {
1139                                 // Unknown realm byte
1140                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1,
1141                                 // invalid_onion_payload
1142                                 msgs::DecodeError::UnknownRequiredFeature
1143                                 | msgs::DecodeError::InvalidValue
1144                                 | msgs::DecodeError::ShortRead => 0x4000 | 22,
1145                                 // Should never happen
1146                                 _ => 0x2000 | 2,
1147                         };
1148                         return Err(OnionDecodeErr::Relay {
1149                                 err_msg: "Unable to decode our hop data",
1150                                 err_code: error_code,
1151                         });
1152                 },
1153                 Ok(msg) => {
1154                         let mut hmac = [0; 32];
1155                         if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1156                                 return Err(OnionDecodeErr::Relay {
1157                                         err_msg: "Unable to decode our hop data",
1158                                         err_code: 0x4000 | 22,
1159                                 });
1160                         }
1161                         if hmac == [0; 32] {
1162                                 #[cfg(test)]
1163                                 {
1164                                         if chacha_stream.read.position() < hop_data.len() as u64 - 64 {
1165                                                 // In tests, make sure that the initial onion packet data is, at least, non-0.
1166                                                 // We could do some fancy randomness test here, but, ehh, whatever.
1167                                                 // This checks for the issue where you can calculate the path length given the
1168                                                 // onion data as all the path entries that the originator sent will be here
1169                                                 // as-is (and were originally 0s).
1170                                                 // Of course reverse path calculation is still pretty easy given naive routing
1171                                                 // algorithms, but this fixes the most-obvious case.
1172                                                 let mut next_bytes = [0; 32];
1173                                                 chacha_stream.read_exact(&mut next_bytes).unwrap();
1174                                                 assert_ne!(next_bytes[..], [0; 32][..]);
1175                                                 chacha_stream.read_exact(&mut next_bytes).unwrap();
1176                                                 assert_ne!(next_bytes[..], [0; 32][..]);
1177                                         }
1178                                 }
1179                                 return Ok((msg, None)); // We are the final destination for this packet
1180                         } else {
1181                                 let mut new_packet_bytes = N::new(hop_data.len());
1182                                 let read_pos = hop_data.len() - chacha_stream.read.position() as usize;
1183                                 chacha_stream.read_exact(&mut new_packet_bytes.as_mut()[..read_pos]).unwrap();
1184                                 #[cfg(debug_assertions)]
1185                                 {
1186                                         // Check two things:
1187                                         // a) that the behavior of our stream here will return Ok(0) even if the TLV
1188                                         //    read above emptied out our buffer and the unwrap() wont needlessly panic
1189                                         // b) that we didn't somehow magically end up with extra data.
1190                                         let mut t = [0; 1];
1191                                         debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1192                                 }
1193                                 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1194                                 // fill the onion hop data we'll forward to our next-hop peer.
1195                                 chacha_stream.chacha.process_in_place(&mut new_packet_bytes.as_mut()[read_pos..]);
1196                                 return Ok((msg, Some((hmac, new_packet_bytes)))); // This packet needs forwarding
1197                         }
1198                 },
1199         }
1200 }
1201
1202 #[cfg(test)]
1203 mod tests {
1204         use crate::io;
1205         use crate::ln::features::{ChannelFeatures, NodeFeatures};
1206         use crate::ln::msgs;
1207         use crate::ln::PaymentHash;
1208         use crate::prelude::*;
1209         use crate::routing::router::{Path, Route, RouteHop};
1210         use crate::util::ser::{VecWriter, Writeable, Writer};
1211
1212         use bitcoin::hashes::hex::FromHex;
1213         use bitcoin::secp256k1::Secp256k1;
1214         use bitcoin::secp256k1::{PublicKey, SecretKey};
1215
1216         use super::OnionKeys;
1217
1218         fn get_test_session_key() -> SecretKey {
1219                 let hex = "4141414141414141414141414141414141414141414141414141414141414141";
1220                 SecretKey::from_slice(&<Vec<u8>>::from_hex(hex).unwrap()[..]).unwrap()
1221         }
1222
1223         fn build_test_onion_keys() -> Vec<OnionKeys> {
1224                 // Keys from BOLT 4, used in both test vector tests
1225                 let secp_ctx = Secp256k1::new();
1226
1227                 let route = Route {
1228                         paths: vec![Path { hops: vec![
1229                                         RouteHop {
1230                                                 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
1231                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
1232                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0, maybe_announced_channel: true, // We fill in the payloads manually instead of generating them from RouteHops.
1233                                         },
1234                                         RouteHop {
1235                                                 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
1236                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
1237                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0, maybe_announced_channel: true, // We fill in the payloads manually instead of generating them from RouteHops.
1238                                         },
1239                                         RouteHop {
1240                                                 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
1241                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
1242                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0, maybe_announced_channel: true, // We fill in the payloads manually instead of generating them from RouteHops.
1243                                         },
1244                                         RouteHop {
1245                                                 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
1246                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
1247                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0, maybe_announced_channel: true, // We fill in the payloads manually instead of generating them from RouteHops.
1248                                         },
1249                                         RouteHop {
1250                                                 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
1251                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
1252                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0, maybe_announced_channel: true, // We fill in the payloads manually instead of generating them from RouteHops.
1253                                         },
1254                         ], blinded_tail: None }],
1255                         route_params: None,
1256                 };
1257
1258                 let onion_keys =
1259                         super::construct_onion_keys(&secp_ctx, &route.paths[0], &get_test_session_key())
1260                                 .unwrap();
1261                 assert_eq!(onion_keys.len(), route.paths[0].hops.len());
1262                 onion_keys
1263         }
1264
1265         #[test]
1266         fn onion_vectors() {
1267                 let onion_keys = build_test_onion_keys();
1268
1269                 // Test generation of ephemeral keys and secrets. These values used to be part of the BOLT4
1270                 // test vectors, but have since been removed. We keep them as they provide test coverage.
1271                 let hex = "53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66";
1272                 assert_eq!(
1273                         onion_keys[0].shared_secret.secret_bytes(),
1274                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1275                 );
1276
1277                 let hex = "2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36";
1278                 assert_eq!(onion_keys[0].blinding_factor[..], <Vec<u8>>::from_hex(hex).unwrap()[..]);
1279
1280                 let hex = "02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619";
1281                 assert_eq!(
1282                         onion_keys[0].ephemeral_pubkey.serialize()[..],
1283                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1284                 );
1285
1286                 let hex = "ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986";
1287                 assert_eq!(onion_keys[0].rho, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1288
1289                 let hex = "b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba";
1290                 assert_eq!(onion_keys[0].mu, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1291
1292                 let hex = "a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae";
1293                 assert_eq!(
1294                         onion_keys[1].shared_secret.secret_bytes(),
1295                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1296                 );
1297
1298                 let hex = "bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f";
1299                 assert_eq!(onion_keys[1].blinding_factor[..], <Vec<u8>>::from_hex(hex).unwrap()[..]);
1300
1301                 let hex = "028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2";
1302                 assert_eq!(
1303                         onion_keys[1].ephemeral_pubkey.serialize()[..],
1304                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1305                 );
1306
1307                 let hex = "450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59";
1308                 assert_eq!(onion_keys[1].rho, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1309
1310                 let hex = "05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9";
1311                 assert_eq!(onion_keys[1].mu, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1312
1313                 let hex = "3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc";
1314                 assert_eq!(
1315                         onion_keys[2].shared_secret.secret_bytes(),
1316                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1317                 );
1318
1319                 let hex = "a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5";
1320                 assert_eq!(onion_keys[2].blinding_factor[..], <Vec<u8>>::from_hex(hex).unwrap()[..]);
1321
1322                 let hex = "03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0";
1323                 assert_eq!(
1324                         onion_keys[2].ephemeral_pubkey.serialize()[..],
1325                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1326                 );
1327
1328                 let hex = "11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea";
1329                 assert_eq!(onion_keys[2].rho, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1330
1331                 let hex = "caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78";
1332                 assert_eq!(onion_keys[2].mu, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1333
1334                 let hex = "21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d";
1335                 assert_eq!(
1336                         onion_keys[3].shared_secret.secret_bytes(),
1337                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1338                 );
1339
1340                 let hex = "7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262";
1341                 assert_eq!(onion_keys[3].blinding_factor[..], <Vec<u8>>::from_hex(hex).unwrap()[..]);
1342
1343                 let hex = "031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595";
1344                 assert_eq!(
1345                         onion_keys[3].ephemeral_pubkey.serialize()[..],
1346                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1347                 );
1348
1349                 let hex = "cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e";
1350                 assert_eq!(onion_keys[3].rho, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1351
1352                 let hex = "5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9";
1353                 assert_eq!(onion_keys[3].mu, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1354
1355                 let hex = "b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328";
1356                 assert_eq!(
1357                         onion_keys[4].shared_secret.secret_bytes(),
1358                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1359                 );
1360
1361                 let hex = "c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205";
1362                 assert_eq!(onion_keys[4].blinding_factor[..], <Vec<u8>>::from_hex(hex).unwrap()[..]);
1363
1364                 let hex = "03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4";
1365                 assert_eq!(
1366                         onion_keys[4].ephemeral_pubkey.serialize()[..],
1367                         <Vec<u8>>::from_hex(hex).unwrap()[..]
1368                 );
1369
1370                 let hex = "034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b";
1371                 assert_eq!(onion_keys[4].rho, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1372
1373                 let hex = "8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a";
1374                 assert_eq!(onion_keys[4].mu, <Vec<u8>>::from_hex(hex).unwrap()[..]);
1375
1376                 // Packet creation test vectors from BOLT 4 (see
1377                 // https://github.com/lightning/bolts/blob/16973e2b857e853308cafd59e42fa830d75b1642/bolt04/onion-test.json).
1378                 // Note that we represent the test vector payloads 2 and 5 through RawOnionHopData::data
1379                 // with raw hex instead of our in-memory enums, as the payloads contains custom types, and
1380                 // we have no way of representing that with our enums.
1381                 let payloads = vec!(
1382                         RawOnionHopData::new(msgs::OutboundOnionPayload::Forward {
1383                                 short_channel_id: 1,
1384                                 amt_to_forward: 15000,
1385                                 outgoing_cltv_value: 1500,
1386                         }),
1387                         /*
1388                         The second payload is represented by raw hex as it contains custom type data. Content:
1389                         1. length "52" (payload_length 82).
1390
1391                         The first part of the payload has the `NonFinalNode` format, with content as follows:
1392                         2. amt_to_forward "020236b0"
1393                            02 (type amt_to_forward) 02 (length 2) 36b0 (value 14000)
1394                         3. outgoing_cltv_value "04020578"
1395                            04 (type outgoing_cltv_value) 02 (length 2) 0578 (value 1400)
1396                         4. short_channel_id "06080000000000000002"
1397                            06 (type short_channel_id) 08 (length 8) 0000000000000002 (value 2)
1398
1399                         The rest of the payload is custom type data:
1400                         5. custom_record "fd02013c0102030405060708090a0b0c0d0e0f0102030405060708090a0b0c0d0e0f0102030405060708090a0b0c0d0e0f0102030405060708090a0b0c0d0e0f"
1401                         */
1402                         RawOnionHopData {
1403                                 data: <Vec<u8>>::from_hex("52020236b00402057806080000000000000002fd02013c0102030405060708090a0b0c0d0e0f0102030405060708090a0b0c0d0e0f0102030405060708090a0b0c0d0e0f0102030405060708090a0b0c0d0e0f").unwrap(),
1404                         },
1405                         RawOnionHopData::new(msgs::OutboundOnionPayload::Forward {
1406                                 short_channel_id: 3,
1407                                 amt_to_forward: 12500,
1408                                 outgoing_cltv_value: 1250,
1409                         }),
1410                         RawOnionHopData::new(msgs::OutboundOnionPayload::Forward {
1411                                 short_channel_id: 4,
1412                                 amt_to_forward: 10000,
1413                                 outgoing_cltv_value: 1000,
1414                         }),
1415                         /*
1416                         The fifth payload is represented by raw hex as it contains custom type data. Content:
1417                         1. length "fd0110" (payload_length 272).
1418
1419                         The first part of the payload has the `FinalNode` format, with content as follows:
1420                         1. amt_to_forward "02022710"
1421                            02 (type amt_to_forward) 02 (length 2) 2710 (value 10000)
1422                         2. outgoing_cltv_value "040203e8"
1423                            04 (type outgoing_cltv_value) 02 (length 2) 03e8 (value 1000)
1424                         3. payment_data "082224a33562c54507a9334e79f0dc4f17d407e6d7c61f0e2f3d0d38599502f617042710"
1425                            08 (type short_channel_id) 22 (length 34) 24a33562c54507a9334e79f0dc4f17d407e6d7c61f0e2f3d0d38599502f61704 (payment_secret) 2710 (total_msat value 10000)
1426
1427                         The rest of the payload is custom type data:
1428                         4. custom_record "fd012de02a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a"
1429                         */
1430                         RawOnionHopData {
1431                                 data: <Vec<u8>>::from_hex("fd011002022710040203e8082224a33562c54507a9334e79f0dc4f17d407e6d7c61f0e2f3d0d38599502f617042710fd012de02a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a").unwrap(),
1432                         },
1433                 );
1434
1435                 // Verify that the serialized OnionHopDataFormat::NonFinalNode tlv payloads matches the test vectors
1436                 let mut w = VecWriter(Vec::new());
1437                 payloads[0].write(&mut w).unwrap();
1438                 let hop_1_serialized_payload = w.0;
1439                 let hex = "1202023a98040205dc06080000000000000001";
1440                 let expected_serialized_hop_1_payload = &<Vec<u8>>::from_hex(hex).unwrap()[..];
1441                 assert_eq!(hop_1_serialized_payload, expected_serialized_hop_1_payload);
1442
1443                 w = VecWriter(Vec::new());
1444                 payloads[2].write(&mut w).unwrap();
1445                 let hop_3_serialized_payload = w.0;
1446                 let hex = "12020230d4040204e206080000000000000003";
1447                 let expected_serialized_hop_3_payload = &<Vec<u8>>::from_hex(hex).unwrap()[..];
1448                 assert_eq!(hop_3_serialized_payload, expected_serialized_hop_3_payload);
1449
1450                 w = VecWriter(Vec::new());
1451                 payloads[3].write(&mut w).unwrap();
1452                 let hop_4_serialized_payload = w.0;
1453                 let hex = "1202022710040203e806080000000000000004";
1454                 let expected_serialized_hop_4_payload = &<Vec<u8>>::from_hex(hex).unwrap()[..];
1455                 assert_eq!(hop_4_serialized_payload, expected_serialized_hop_4_payload);
1456
1457                 let pad_keytype_seed =
1458                         super::gen_pad_from_shared_secret(&get_test_session_key().secret_bytes());
1459
1460                 let packet: msgs::OnionPacket = super::construct_onion_packet_with_writable_hopdata::<_>(
1461                         payloads,
1462                         onion_keys,
1463                         pad_keytype_seed,
1464                         &PaymentHash([0x42; 32]),
1465                 )
1466                 .unwrap();
1467
1468                 let hex = "0002EEC7245D6B7D2CCB30380BFBE2A3648CD7A942653F5AA340EDCEA1F283686619F7F3416A5AA36DC7EEB3EC6D421E9615471AB870A33AC07FA5D5A51DF0A8823AABE3FEA3F90D387529D4F72837F9E687230371CCD8D263072206DBED0234F6505E21E282ABD8C0E4F5B9FF8042800BBAB065036EADD0149B37F27DDE664725A49866E052E809D2B0198AB9610FAA656BBF4EC516763A59F8F42C171B179166BA38958D4F51B39B3E98706E2D14A2DAFD6A5DF808093ABFCA5AEAACA16EDED5DB7D21FB0294DD1A163EDF0FB445D5C8D7D688D6DD9C541762BF5A5123BF9939D957FE648416E88F1B0928BFA034982B22548E1A4D922690EECF546275AFB233ACF4323974680779F1A964CFE687456035CC0FBA8A5428430B390F0057B6D1FE9A8875BFA89693EEB838CE59F09D207A503EE6F6299C92D6361BC335FCBF9B5CD44747AADCE2CE6069CFDC3D671DAEF9F8AE590CF93D957C9E873E9A1BC62D9640DC8FC39C14902D49A1C80239B6C5B7FD91D05878CBF5FFC7DB2569F47C43D6C0D27C438ABFF276E87364DEB8858A37E5A62C446AF95D8B786EAF0B5FCF78D98B41496794F8DCAAC4EEF34B2ACFB94C7E8C32A9E9866A8FA0B6F2A06F00A1CCDE569F97EEC05C803BA7500ACC96691D8898D73D8E6A47B8F43C3D5DE74458D20EDA61474C426359677001FBD75A74D7D5DB6CB4FEB83122F133206203E4E2D293F838BF8C8B3A29ACB321315100B87E80E0EDB272EE80FDA944E3FB6084ED4D7F7C7D21C69D9DA43D31A90B70693F9B0CC3EAC74C11AB8FF655905688916CFA4EF0BD04135F2E50B7C689A21D04E8E981E74C6058188B9B1F9DFC3EEC6838E9FFBCF22CE738D8A177C19318DFFEF090CEE67E12DE1A3E2A39F61247547BA5257489CBC11D7D91ED34617FCC42F7A9DA2E3CF31A94A210A1018143173913C38F60E62B24BF0D7518F38B5BAB3E6A1F8AEB35E31D6442C8ABB5178EFC892D2E787D79C6AD9E2FC271792983FA9955AC4D1D84A36C024071BC6E431B625519D556AF38185601F70E29035EA6A09C8B676C9D88CF7E05E0F17098B584C4168735940263F940033A220F40BE4C85344128B14BEB9E75696DB37014107801A59B13E89CD9D2258C169D523BE6D31552C44C82FF4BB18EC9F099F3BF0E5B1BB2BA9A87D7E26F98D294927B600B5529C47E04D98956677CBCEE8FA2B60F49776D8B8C367465B7C626DA53700684FB6C918EAD0EAB8360E4F60EDD25B4F43816A75ECF70F909301825B512469F8389D79402311D8AECB7B3EF8599E79485A4388D87744D899F7C47EE644361E17040A7958C8911BE6F463AB6A9B2AFACD688EC55EF517B38F1339EFC54487232798BB25522FF4572FF68567FE830F92F7B8113EFCE3E98C3FFFBAEDCE4FD8B50E41DA97C0C08E423A72689CC68E68F752A5E3A9003E64E35C957CA2E1C48BB6F64B05F56B70B575AD2F278D57850A7AD568C24A4D32A3D74B29F03DC125488BC7C637DA582357F40B0A52D16B3B40BB2C2315D03360BC24209E20972C200566BCF3BBE5C5B0AEDD83132A8A4D5B4242BA370B6D67D9B67EB01052D132C7866B9CB502E44796D9D356E4E3CB47CC527322CD24976FE7C9257A2864151A38E568EF7A79F10D6EF27CC04CE382347A2488B1F404FDBF407FE1CA1C9D0D5649E34800E25E18951C98CAE9F43555EEF65FEE1EA8F15828807366C3B612CD5753BF9FB8FCED08855F742CDDD6F765F74254F03186683D646E6F09AC2805586C7CF11998357CAFC5DF3F285329366F475130C928B2DCEBA4AA383758E7A9D20705C4BB9DB619E2992F608A1BA65DB254BB389468741D0502E2588AEB54390AC600C19AF5C8E61383FC1BEBE0029E4474051E4EF908828DB9CCA13277EF65DB3FD47CCC2179126AAEFB627719F421E20";
1469                 assert_eq!(packet.encode(), <Vec<u8>>::from_hex(hex).unwrap());
1470         }
1471
1472         #[test]
1473         fn test_failure_packet_onion() {
1474                 // Returning Errors test vectors from BOLT 4
1475
1476                 let onion_keys = build_test_onion_keys();
1477                 let onion_error =
1478                         super::build_failure_packet(onion_keys[4].shared_secret.as_ref(), 0x2002, &[0; 0]);
1479                 let hex = "4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000";
1480                 assert_eq!(onion_error.encode(), <Vec<u8>>::from_hex(hex).unwrap());
1481
1482                 let onion_packet_1 = super::encrypt_failure_packet(
1483                         onion_keys[4].shared_secret.as_ref(),
1484                         &onion_error.encode()[..],
1485                 );
1486                 let hex = "a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4";
1487                 assert_eq!(onion_packet_1.data, <Vec<u8>>::from_hex(hex).unwrap());
1488
1489                 let onion_packet_2 = super::encrypt_failure_packet(
1490                         onion_keys[3].shared_secret.as_ref(),
1491                         &onion_packet_1.data[..],
1492                 );
1493                 let hex = "c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270";
1494                 assert_eq!(onion_packet_2.data, <Vec<u8>>::from_hex(hex).unwrap());
1495
1496                 let onion_packet_3 = super::encrypt_failure_packet(
1497                         onion_keys[2].shared_secret.as_ref(),
1498                         &onion_packet_2.data[..],
1499                 );
1500                 let hex = "a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3";
1501                 assert_eq!(onion_packet_3.data, <Vec<u8>>::from_hex(hex).unwrap());
1502
1503                 let onion_packet_4 = super::encrypt_failure_packet(
1504                         onion_keys[1].shared_secret.as_ref(),
1505                         &onion_packet_3.data[..],
1506                 );
1507                 let hex = "aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921";
1508                 assert_eq!(onion_packet_4.data, <Vec<u8>>::from_hex(hex).unwrap());
1509
1510                 let onion_packet_5 = super::encrypt_failure_packet(
1511                         onion_keys[0].shared_secret.as_ref(),
1512                         &onion_packet_4.data[..],
1513                 );
1514                 let hex = "9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d";
1515                 assert_eq!(onion_packet_5.data, <Vec<u8>>::from_hex(hex).unwrap());
1516         }
1517
1518         struct RawOnionHopData {
1519                 data: Vec<u8>,
1520         }
1521         impl RawOnionHopData {
1522                 fn new(orig: msgs::OutboundOnionPayload) -> Self {
1523                         Self { data: orig.encode() }
1524                 }
1525         }
1526         impl Writeable for RawOnionHopData {
1527                 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1528                         writer.write_all(&self.data[..])
1529                 }
1530         }
1531 }