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