_ 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 ln::{PaymentHash, PaymentPreimage, PaymentSecret};
  11 use ln::channelmanager::HTLCSource;
  12 use ln::msgs;
  13 use routing::network_graph::NetworkUpdate;
  14 use routing::router::RouteHop;
  15 use util::chacha20::ChaCha20;
  16 use util::errors::{self, APIError};
  17 use util::ser::{Readable, Writeable, LengthCalculatingWriter};
  18 use util::logger::Logger;
  19
  20 use bitcoin::hashes::{Hash, HashEngine};
  21 use bitcoin::hashes::cmp::fixed_time_eq;
  22 use bitcoin::hashes::hmac::{Hmac, HmacEngine};
  23 use bitcoin::hashes::sha256::Hash as Sha256;
  24
  25 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
  26 use bitcoin::secp256k1::Secp256k1;
  27 use bitcoin::secp256k1::ecdh::SharedSecret;
  28 use bitcoin::secp256k1;
  29
  30 use prelude::*;
  31 use io::Cursor;
  32 use core::convert::TryInto;
  33 use core::ops::Deref;
  34
  35 pub(super) struct OnionKeys {
  36         #[cfg(test)]
  37         pub(super) shared_secret: SharedSecret,
  38         #[cfg(test)]
  39         pub(super) blinding_factor: [u8; 32],
  40         pub(super) ephemeral_pubkey: PublicKey,
  41         pub(super) rho: [u8; 32],
  42         pub(super) mu: [u8; 32],
  43 }
  44
  45 #[inline]
  46 pub(super) fn gen_rho_mu_from_shared_secret(shared_secret: &[u8]) -> ([u8; 32], [u8; 32]) {
  47         assert_eq!(shared_secret.len(), 32);
  48         ({
  49                 let mut hmac = HmacEngine::<Sha256>::new(&[0x72, 0x68, 0x6f]); // rho
  50                 hmac.input(&shared_secret[..]);
  51                 Hmac::from_engine(hmac).into_inner()
  52         },
  53         {
  54                 let mut hmac = HmacEngine::<Sha256>::new(&[0x6d, 0x75]); // mu
  55                 hmac.input(&shared_secret[..]);
  56                 Hmac::from_engine(hmac).into_inner()
  57         })
  58 }
  59
  60 #[inline]
  61 pub(super) fn gen_um_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
  62         assert_eq!(shared_secret.len(), 32);
  63         let mut hmac = HmacEngine::<Sha256>::new(&[0x75, 0x6d]); // um
  64         hmac.input(&shared_secret[..]);
  65         Hmac::from_engine(hmac).into_inner()
  66 }
  67
  68 #[inline]
  69 pub(super) fn gen_ammag_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
  70         assert_eq!(shared_secret.len(), 32);
  71         let mut hmac = HmacEngine::<Sha256>::new(&[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
  72         hmac.input(&shared_secret[..]);
  73         Hmac::from_engine(hmac).into_inner()
  74 }
  75
  76 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
  77 #[inline]
  78 pub(super) fn construct_onion_keys_callback<T: secp256k1::Signing, FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1<T>, path: &Vec<RouteHop>, session_priv: &SecretKey, mut callback: FType) -> Result<(), secp256k1::Error> {
  79         let mut blinded_priv = session_priv.clone();
  80         let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
  81
  82         for hop in path.iter() {
  83                 let shared_secret = SharedSecret::new(&hop.pubkey, &blinded_priv);
  84
  85                 let mut sha = Sha256::engine();
  86                 sha.input(&blinded_pub.serialize()[..]);
  87                 sha.input(&shared_secret[..]);
  88                 let blinding_factor = Sha256::from_engine(sha).into_inner();
  89
  90                 let ephemeral_pubkey = blinded_pub;
  91
  92                 blinded_priv.mul_assign(&blinding_factor)?;
  93                 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
  94
  95                 callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
  96         }
  97
  98         Ok(())
  99 }
 100
 101 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 102 pub(super) fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, path: &Vec<RouteHop>, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
 103         let mut res = Vec::with_capacity(path.len());
 104
 105         construct_onion_keys_callback(secp_ctx, path, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
 106                 let (rho, mu) = gen_rho_mu_from_shared_secret(&shared_secret[..]);
 107
 108                 res.push(OnionKeys {
 109                         #[cfg(test)]
 110                         shared_secret,
 111                         #[cfg(test)]
 112                         blinding_factor: _blinding_factor,
 113                         ephemeral_pubkey,
 114                         rho,
 115                         mu,
 116                 });
 117         })?;
 118
 119         Ok(res)
 120 }
 121
 122 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
 123 pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, payment_secret_option: &Option<PaymentSecret>, starting_htlc_offset: u32, keysend_preimage: &Option<PaymentPreimage>) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
 124         let mut cur_value_msat = 0u64;
 125         let mut cur_cltv = starting_htlc_offset;
 126         let mut last_short_channel_id = 0;
 127         let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(path.len());
 128
 129         for (idx, hop) in path.iter().rev().enumerate() {
 130                 // First hop gets special values so that it can check, on receipt, that everything is
 131                 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
 132                 // the intended recipient).
 133                 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
 134                 let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
 135                 res.insert(0, msgs::OnionHopData {
 136                         format: if hop.node_features.supports_variable_length_onion() {
 137                                 if idx == 0 {
 138                                         msgs::OnionHopDataFormat::FinalNode {
 139                                                 payment_data: if let &Some(ref payment_secret) = payment_secret_option {
 140                                                         Some(msgs::FinalOnionHopData {
 141                                                                 payment_secret: payment_secret.clone(),
 142                                                                 total_msat,
 143                                                         })
 144                                                 } else { None },
 145                                                 keysend_preimage: *keysend_preimage,
 146                                         }
 147                                 } else {
 148                                         msgs::OnionHopDataFormat::NonFinalNode {
 149                                                 short_channel_id: last_short_channel_id,
 150                                         }
 151                                 }
 152                         } else {
 153                                 msgs::OnionHopDataFormat::Legacy {
 154                                         short_channel_id: last_short_channel_id,
 155                                 }
 156                         },
 157                         amt_to_forward: value_msat,
 158                         outgoing_cltv_value: cltv,
 159                 });
 160                 cur_value_msat += hop.fee_msat;
 161                 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 162                         return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 163                 }
 164                 cur_cltv += hop.cltv_expiry_delta as u32;
 165                 if cur_cltv >= 500000000 {
 166                         return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 167                 }
 168                 last_short_channel_id = hop.short_channel_id;
 169         }
 170         Ok((res, cur_value_msat, cur_cltv))
 171 }
 172
 173 /// Length of the onion data packet. Before TLV-based onions this was 20 65-byte hops, though now
 174 /// the hops can be of variable length.
 175 pub(crate) const ONION_DATA_LEN: usize = 20*65;
 176
 177 #[inline]
 178 fn shift_arr_right(arr: &mut [u8; ONION_DATA_LEN], amt: usize) {
 179         for i in (amt..ONION_DATA_LEN).rev() {
 180                 arr[i] = arr[i-amt];
 181         }
 182         for i in 0..amt {
 183                 arr[i] = 0;
 184         }
 185 }
 186
 187 pub(super) fn route_size_insane(payloads: &Vec<msgs::OnionHopData>) -> bool {
 188         let mut len = 0;
 189         for payload in payloads.iter() {
 190                 let mut payload_len = LengthCalculatingWriter(0);
 191                 payload.write(&mut payload_len).expect("Failed to calculate length");
 192                 assert!(payload_len.0 + 32 < ONION_DATA_LEN);
 193                 len += payload_len.0 + 32;
 194                 if len > ONION_DATA_LEN {
 195                         return true;
 196                 }
 197         }
 198         false
 199 }
 200
 201 /// panics if route_size_insane(paylods)
 202 pub(super) fn construct_onion_packet(payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, prng_seed: [u8; 32], associated_data: &PaymentHash) -> msgs::OnionPacket {
 203         let mut packet_data = [0; ONION_DATA_LEN];
 204
 205         let mut chacha = ChaCha20::new(&prng_seed, &[0; 8]);
 206         chacha.process(&[0; ONION_DATA_LEN], &mut packet_data);
 207
 208         construct_onion_packet_with_init_noise(payloads, onion_keys, packet_data, associated_data)
 209 }
 210
 211 #[cfg(test)]
 212 // Used in testing to write bogus OnionHopDatas, which is otherwise not representable in
 213 // msgs::OnionHopData.
 214 pub(super) fn construct_onion_packet_bogus_hopdata<HD: Writeable>(payloads: Vec<HD>, onion_keys: Vec<OnionKeys>, prng_seed: [u8; 32], associated_data: &PaymentHash) -> msgs::OnionPacket {
 215         let mut packet_data = [0; ONION_DATA_LEN];
 216
 217         let mut chacha = ChaCha20::new(&prng_seed, &[0; 8]);
 218         chacha.process(&[0; ONION_DATA_LEN], &mut packet_data);
 219
 220         construct_onion_packet_with_init_noise(payloads, onion_keys, packet_data, associated_data)
 221 }
 222
 223 /// panics if route_size_insane(paylods)
 224 fn construct_onion_packet_with_init_noise<HD: Writeable>(mut payloads: Vec<HD>, onion_keys: Vec<OnionKeys>, mut packet_data: [u8; ONION_DATA_LEN], associated_data: &PaymentHash) -> msgs::OnionPacket {
 225         let filler = {
 226                 const ONION_HOP_DATA_LEN: usize = 65; // We may decrease this eventually after TLV is common
 227                 let mut res = Vec::with_capacity(ONION_HOP_DATA_LEN * (payloads.len() - 1));
 228
 229                 let mut pos = 0;
 230                 for (i, (payload, keys)) in payloads.iter().zip(onion_keys.iter()).enumerate() {
 231                         if i == payloads.len() - 1 { break; }
 232
 233                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 234                         for _ in 0..(ONION_DATA_LEN - pos) { // TODO: Batch this.
 235                                 let mut dummy = [0; 1];
 236                                 chacha.process_in_place(&mut dummy); // We don't have a seek function :(
 237                         }
 238
 239                         let mut payload_len = LengthCalculatingWriter(0);
 240                         payload.write(&mut payload_len).expect("Failed to calculate length");
 241                         pos += payload_len.0 + 32;
 242                         assert!(pos <= ONION_DATA_LEN);
 243
 244                         res.resize(pos, 0u8);
 245                         chacha.process_in_place(&mut res);
 246                 }
 247                 res
 248         };
 249
 250         let mut hmac_res = [0; 32];
 251         for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
 252                 let mut payload_len = LengthCalculatingWriter(0);
 253                 payload.write(&mut payload_len).expect("Failed to calculate length");
 254                 shift_arr_right(&mut packet_data, payload_len.0 + 32);
 255                 packet_data[0..payload_len.0].copy_from_slice(&payload.encode()[..]);
 256                 packet_data[payload_len.0..(payload_len.0 + 32)].copy_from_slice(&hmac_res);
 257
 258                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 259                 chacha.process_in_place(&mut packet_data);
 260
 261                 if i == 0 {
 262                         packet_data[ONION_DATA_LEN - filler.len()..ONION_DATA_LEN].copy_from_slice(&filler[..]);
 263                 }
 264
 265                 let mut hmac = HmacEngine::<Sha256>::new(&keys.mu);
 266                 hmac.input(&packet_data);
 267                 hmac.input(&associated_data.0[..]);
 268                 hmac_res = Hmac::from_engine(hmac).into_inner();
 269         }
 270
 271         msgs::OnionPacket {
 272                 version: 0,
 273                 public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
 274                 hop_data: packet_data,
 275                 hmac: hmac_res,
 276         }
 277 }
 278
 279 /// Encrypts a failure packet. raw_packet can either be a
 280 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
 281 pub(super) fn encrypt_failure_packet(shared_secret: &[u8], raw_packet: &[u8]) -> msgs::OnionErrorPacket {
 282         let ammag = gen_ammag_from_shared_secret(&shared_secret);
 283
 284         let mut packet_crypted = Vec::with_capacity(raw_packet.len());
 285         packet_crypted.resize(raw_packet.len(), 0);
 286         let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 287         chacha.process(&raw_packet, &mut packet_crypted[..]);
 288         msgs::OnionErrorPacket {
 289                 data: packet_crypted,
 290         }
 291 }
 292
 293 pub(super) fn build_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
 294         assert_eq!(shared_secret.len(), 32);
 295         assert!(failure_data.len() <= 256 - 2);
 296
 297         let um = gen_um_from_shared_secret(&shared_secret);
 298
 299         let failuremsg = {
 300                 let mut res = Vec::with_capacity(2 + failure_data.len());
 301                 res.push(((failure_type >> 8) & 0xff) as u8);
 302                 res.push(((failure_type >> 0) & 0xff) as u8);
 303                 res.extend_from_slice(&failure_data[..]);
 304                 res
 305         };
 306         let pad = {
 307                 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
 308                 res.resize(256 - 2 - failure_data.len(), 0);
 309                 res
 310         };
 311         let mut packet = msgs::DecodedOnionErrorPacket {
 312                 hmac: [0; 32],
 313                 failuremsg,
 314                 pad,
 315         };
 316
 317         let mut hmac = HmacEngine::<Sha256>::new(&um);
 318         hmac.input(&packet.encode()[32..]);
 319         packet.hmac = Hmac::from_engine(hmac).into_inner();
 320
 321         packet
 322 }
 323
 324 #[inline]
 325 pub(super) fn build_first_hop_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
 326         let failure_packet = build_failure_packet(shared_secret, failure_type, failure_data);
 327         encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
 328 }
 329
 330 /// Process failure we got back from upstream on a payment we sent (implying htlc_source is an
 331 /// OutboundRoute).
 332 /// Returns update, a boolean indicating that the payment itself failed, and the error code.
 333 #[inline]
 334 pub(super) fn process_onion_failure<T: secp256k1::Signing, L: Deref>(secp_ctx: &Secp256k1<T>, logger: &L, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<NetworkUpdate>, bool, Option<u16>, Option<Vec<u8>>) where L::Target: Logger {
 335         if let &HTLCSource::OutboundRoute { ref path, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
 336                 let mut res = None;
 337                 let mut htlc_msat = *first_hop_htlc_msat;
 338                 let mut error_code_ret = None;
 339                 let mut error_packet_ret = None;
 340                 let mut next_route_hop_ix = 0;
 341                 let mut is_from_final_node = false;
 342
 343                 // Handle packed channel/node updates for passing back for the route handler
 344                 construct_onion_keys_callback(secp_ctx, path, session_priv, |shared_secret, _, _, route_hop| {
 345                         next_route_hop_ix += 1;
 346                         if res.is_some() { return; }
 347
 348                         let amt_to_forward = htlc_msat - route_hop.fee_msat;
 349                         htlc_msat = amt_to_forward;
 350
 351                         let ammag = gen_ammag_from_shared_secret(&shared_secret[..]);
 352
 353                         let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
 354                         decryption_tmp.resize(packet_decrypted.len(), 0);
 355                         let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 356                         chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
 357                         packet_decrypted = decryption_tmp;
 358
 359                         is_from_final_node = path.last().unwrap().pubkey == route_hop.pubkey;
 360
 361                         if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
 362                                 let um = gen_um_from_shared_secret(&shared_secret[..]);
 363                                 let mut hmac = HmacEngine::<Sha256>::new(&um);
 364                                 hmac.input(&err_packet.encode()[32..]);
 365
 366                                 if fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &err_packet.hmac) {
 367                                         if let Some(error_code_slice) = err_packet.failuremsg.get(0..2) {
 368                                                 const PERM: u16 = 0x4000;
 369                                                 const NODE: u16 = 0x2000;
 370                                                 const UPDATE: u16 = 0x1000;
 371
 372                                                 let error_code = u16::from_be_bytes(error_code_slice.try_into().expect("len is 2"));
 373                                                 error_code_ret = Some(error_code);
 374                                                 error_packet_ret = Some(err_packet.failuremsg[2..].to_vec());
 375
 376                                                 let (debug_field, debug_field_size) = errors::get_onion_debug_field(error_code);
 377
 378                                                 // indicate that payment parameter has failed and no need to
 379                                                 // update Route object
 380                                                 let payment_failed = (match error_code & 0xff {
 381                                                         15|16|17|18|19 => true,
 382                                                         _ => false,
 383                                                 } && is_from_final_node) // PERM bit observed below even this error is from the intermediate nodes
 384                                                 || error_code == 21; // Special case error 21 as the Route object is bogus, TODO: Maybe fail the node if the CLTV was reasonable?
 385
 386                                                 let mut network_update = None;
 387
 388                                                 if error_code & NODE == NODE {
 389                                                         network_update = Some(NetworkUpdate::NodeFailure { node_id: route_hop.pubkey, is_permanent: error_code & PERM == PERM });
 390                                                 }
 391                                                 else if error_code & PERM == PERM {
 392                                                         network_update = if payment_failed { None } else { Some(NetworkUpdate::ChannelClosed {
 393                                                                 short_channel_id: path[next_route_hop_ix - if next_route_hop_ix == path.len() { 1 } else { 0 }].short_channel_id,
 394                                                                 is_permanent: true,
 395                                                         })};
 396                                                 }
 397                                                 else if error_code & UPDATE == UPDATE {
 398                                                         if let Some(update_len_slice) = err_packet.failuremsg.get(debug_field_size+2..debug_field_size+4) {
 399                                                                 let update_len = u16::from_be_bytes(update_len_slice.try_into().expect("len is 2")) as usize;
 400                                                                 if let Some(update_slice) = err_packet.failuremsg.get(debug_field_size + 4..debug_field_size + 4 + update_len) {
 401                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&update_slice)) {
 402                                                                                 // if channel_update should NOT have caused the failure:
 403                                                                                 // MAY treat the channel_update as invalid.
 404                                                                                 let is_chan_update_invalid = match error_code & 0xff {
 405                                                                                         7 => false,
 406                                                                                         11 => amt_to_forward > chan_update.contents.htlc_minimum_msat,
 407                                                                                         12 => {
 408                                                                                                 let new_fee = amt_to_forward.checked_mul(chan_update.contents.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan_update.contents.fee_base_msat as u64) });
 409                                                                                                 new_fee.is_some() && route_hop.fee_msat >= new_fee.unwrap()
 410                                                                                         }
 411                                                                                         13 => route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta,
 412                                                                                         14 => false, // expiry_too_soon; always valid?
 413                                                                                         20 => chan_update.contents.flags & 2 == 0,
 414                                                                                         _ => false, // unknown error code; take channel_update as valid
 415                                                                                 };
 416                                                                                 network_update = if is_chan_update_invalid {
 417                                                                                         // This probably indicates the node which forwarded
 418                                                                                         // to the node in question corrupted something.
 419                                                                                         Some(NetworkUpdate::ChannelClosed {
 420                                                                                                 short_channel_id: route_hop.short_channel_id,
 421                                                                                                 is_permanent: true,
 422                                                                                         })
 423                                                                                 } else {
 424                                                                                         Some(NetworkUpdate::ChannelUpdateMessage {
 425                                                                                                 msg: chan_update,
 426                                                                                         })
 427                                                                                 };
 428                                                                         }
 429                                                                 }
 430                                                         }
 431                                                         if network_update.is_none() {
 432                                                                 // They provided an UPDATE which was obviously bogus, not worth
 433                                                                 // trying to relay through them anymore.
 434                                                                 network_update = Some(NetworkUpdate::NodeFailure {
 435                                                                         node_id: route_hop.pubkey,
 436                                                                         is_permanent: true,
 437                                                                 });
 438                                                         }
 439                                                 } else if !payment_failed {
 440                                                         // We can't understand their error messages and they failed to
 441                                                         // forward...they probably can't understand our forwards so its
 442                                                         // really not worth trying any further.
 443                                                         network_update = Some(NetworkUpdate::NodeFailure {
 444                                                                 node_id: route_hop.pubkey,
 445                                                                 is_permanent: true,
 446                                                         });
 447                                                 }
 448
 449                                                 // TODO: Here (and a few other places) we assume that BADONION errors
 450                                                 // are always "sourced" from the node previous to the one which failed
 451                                                 // to decode the onion.
 452                                                 res = Some((network_update, !(error_code & PERM == PERM && is_from_final_node)));
 453
 454                                                 let (description, title) = errors::get_onion_error_description(error_code);
 455                                                 if debug_field_size > 0 && err_packet.failuremsg.len() >= 4 + debug_field_size {
 456                                                         log_warn!(logger, "Onion Error[from {}: {}({:#x}) {}({})] {}", route_hop.pubkey, title, error_code, debug_field, log_bytes!(&err_packet.failuremsg[4..4+debug_field_size]), description);
 457                                                 }
 458                                                 else {
 459                                                         log_warn!(logger, "Onion Error[from {}: {}({:#x})] {}", route_hop.pubkey, title, error_code, description);
 460                                                 }
 461                                         } else {
 462                                                 // Useless packet that we can't use but it passed HMAC, so it
 463                                                 // definitely came from the peer in question
 464                                                 res = Some((Some(NetworkUpdate::NodeFailure {
 465                                                         node_id: route_hop.pubkey,
 466                                                         is_permanent: true,
 467                                                 }), !is_from_final_node));
 468                                         }
 469                                 }
 470                         }
 471                 }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
 472                 if let Some((channel_update, payment_retryable)) = res {
 473                         (channel_update, payment_retryable, error_code_ret, error_packet_ret)
 474                 } else {
 475                         // only not set either packet unparseable or hmac does not match with any
 476                         // payment not retryable only when garbage is from the final node
 477                         (None, !is_from_final_node, None, None)
 478                 }
 479         } else { unreachable!(); }
 480 }
 481
 482 #[cfg(test)]
 483 mod tests {
 484         use io;
 485         use prelude::*;
 486         use ln::PaymentHash;
 487         use ln::features::{ChannelFeatures, NodeFeatures};
 488         use routing::router::{Route, RouteHop};
 489         use ln::msgs;
 490         use util::ser::{Writeable, Writer};
 491
 492         use hex;
 493
 494         use bitcoin::secp256k1::Secp256k1;
 495         use bitcoin::secp256k1::key::{PublicKey,SecretKey};
 496
 497         use super::OnionKeys;
 498
 499         fn build_test_onion_keys() -> Vec<OnionKeys> {
 500                 // Keys from BOLT 4, used in both test vector tests
 501                 let secp_ctx = Secp256k1::new();
 502
 503                 let route = Route {
 504                         paths: vec![vec![
 505                                         RouteHop {
 506                                                 pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
 507                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 508                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
 509                                         },
 510                                         RouteHop {
 511                                                 pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
 512                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 513                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
 514                                         },
 515                                         RouteHop {
 516                                                 pubkey: PublicKey::from_slice(&hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
 517                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 518                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
 519                                         },
 520                                         RouteHop {
 521                                                 pubkey: PublicKey::from_slice(&hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
 522                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 523                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
 524                                         },
 525                                         RouteHop {
 526                                                 pubkey: PublicKey::from_slice(&hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
 527                                                 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 528                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
 529                                         },
 530                         ]],
 531                 };
 532
 533                 let session_priv = SecretKey::from_slice(&hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
 534
 535                 let onion_keys = super::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
 536                 assert_eq!(onion_keys.len(), route.paths[0].len());
 537                 onion_keys
 538         }
 539
 540         #[test]
 541         fn onion_vectors() {
 542                 // Legacy packet creation test vectors from BOLT 4
 543                 let onion_keys = build_test_onion_keys();
 544
 545                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
 546                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
 547                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
 548                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
 549                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
 550
 551                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
 552                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
 553                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
 554                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
 555                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
 556
 557                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
 558                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
 559                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
 560                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
 561                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
 562
 563                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
 564                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
 565                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
 566                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
 567                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
 568
 569                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
 570                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
 571                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
 572                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
 573                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
 574
 575                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
 576                 let payloads = vec!(
 577                         msgs::OnionHopData {
 578                                 format: msgs::OnionHopDataFormat::Legacy {
 579                                         short_channel_id: 0,
 580                                 },
 581                                 amt_to_forward: 0,
 582                                 outgoing_cltv_value: 0,
 583                         },
 584                         msgs::OnionHopData {
 585                                 format: msgs::OnionHopDataFormat::Legacy {
 586                                         short_channel_id: 0x0101010101010101,
 587                                 },
 588                                 amt_to_forward: 0x0100000001,
 589                                 outgoing_cltv_value: 0,
 590                         },
 591                         msgs::OnionHopData {
 592                                 format: msgs::OnionHopDataFormat::Legacy {
 593                                         short_channel_id: 0x0202020202020202,
 594                                 },
 595                                 amt_to_forward: 0x0200000002,
 596                                 outgoing_cltv_value: 0,
 597                         },
 598                         msgs::OnionHopData {
 599                                 format: msgs::OnionHopDataFormat::Legacy {
 600                                         short_channel_id: 0x0303030303030303,
 601                                 },
 602                                 amt_to_forward: 0x0300000003,
 603                                 outgoing_cltv_value: 0,
 604                         },
 605                         msgs::OnionHopData {
 606                                 format: msgs::OnionHopDataFormat::Legacy {
 607                                         short_channel_id: 0x0404040404040404,
 608                                 },
 609                                 amt_to_forward: 0x0400000004,
 610                                 outgoing_cltv_value: 0,
 611                         },
 612                 );
 613
 614                 let packet = super::construct_onion_packet_with_init_noise(payloads, onion_keys, [0; super::ONION_DATA_LEN], &PaymentHash([0x42; 32]));
 615                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
 616                 // anyway...
 617                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
 618         }
 619
 620         #[test]
 621         fn test_failure_packet_onion() {
 622                 // Returning Errors test vectors from BOLT 4
 623
 624                 let onion_keys = build_test_onion_keys();
 625                 let onion_error = super::build_failure_packet(&onion_keys[4].shared_secret[..], 0x2002, &[0; 0]);
 626                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
 627
 628                 let onion_packet_1 = super::encrypt_failure_packet(&onion_keys[4].shared_secret[..], &onion_error.encode()[..]);
 629                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
 630
 631                 let onion_packet_2 = super::encrypt_failure_packet(&onion_keys[3].shared_secret[..], &onion_packet_1.data[..]);
 632                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
 633
 634                 let onion_packet_3 = super::encrypt_failure_packet(&onion_keys[2].shared_secret[..], &onion_packet_2.data[..]);
 635                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
 636
 637                 let onion_packet_4 = super::encrypt_failure_packet(&onion_keys[1].shared_secret[..], &onion_packet_3.data[..]);
 638                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
 639
 640                 let onion_packet_5 = super::encrypt_failure_packet(&onion_keys[0].shared_secret[..], &onion_packet_4.data[..]);
 641                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
 642         }
 643
 644         struct RawOnionHopData {
 645                 data: Vec<u8>
 646         }
 647         impl RawOnionHopData {
 648                 fn new(orig: msgs::OnionHopData) -> Self {
 649                         Self { data: orig.encode() }
 650                 }
 651         }
 652         impl Writeable for RawOnionHopData {
 653                 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 654                         writer.write_all(&self.data[..])
 655                 }
 656         }
 657
 658         #[test]
 659         fn variable_length_onion_vectors() {
 660                 // Packet creation test vectors from BOLT 4 (as of this writing at
 661                 // bolt04/onion-test-multi-frame.json in the spec repo).
 662                 // Note that we use he RawOnionHopData for everything except Legacy hops, as even the hops
 663                 // with "type": "tlv" are not valid TLV (they were for a previous version of TLV that
 664                 // didn't move forward), and, thus, cannot be directly represented in our in-memory enums.
 665                 let onion_keys = build_test_onion_keys();
 666
 667                 let payloads = vec!(
 668                         RawOnionHopData::new(msgs::OnionHopData {
 669                                 format: msgs::OnionHopDataFormat::Legacy {
 670                                         short_channel_id: 0,
 671                                 },
 672                                 amt_to_forward: 0,
 673                                 outgoing_cltv_value: 0,
 674                         }),
 675                         RawOnionHopData {
 676                                 data: hex::decode("140101010101010101000000000000000100000001").unwrap(),
 677                         },
 678                         RawOnionHopData {
 679                                 data: hex::decode("fd0100000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f404142434445464748494a4b4c4d4e4f505152535455565758595a5b5c5d5e5f606162636465666768696a6b6c6d6e6f707172737475767778797a7b7c7d7e7f808182838485868788898a8b8c8d8e8f909192939495969798999a9b9c9d9e9fa0a1a2a3a4a5a6a7a8a9aaabacadaeafb0b1b2b3b4b5b6b7b8b9babbbcbdbebfc0c1c2c3c4c5c6c7c8c9cacbcccdcecfd0d1d2d3d4d5d6d7d8d9dadbdcdddedfe0e1e2e3e4e5e6e7e8e9eaebecedeeeff0f1f2f3f4f5f6f7f8f9fafbfcfdfeff").unwrap(),
 680                         },
 681                         RawOnionHopData {
 682                                 data: hex::decode("140303030303030303000000000000000300000003").unwrap(),
 683                         },
 684                         RawOnionHopData::new(msgs::OnionHopData {
 685                                 format: msgs::OnionHopDataFormat::Legacy {
 686                                         short_channel_id: 0x0404040404040404,
 687                                 },
 688                                 amt_to_forward: 4,
 689                                 outgoing_cltv_value: 4,
 690                         }),
 691                 );
 692
 693                 let packet = super::construct_onion_packet_with_init_noise(payloads, onion_keys, [0; super::ONION_DATA_LEN], &PaymentHash([0x42; 32]));
 694                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
 695                 // anyway...
 696                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a71a060daf367132b378b3a3883c0e2c0e026b8900b2b5cdbc784e1a3bb913f88a9c50f7d61ab590531cf08000178a333a347f8b4072ed056f820f77774345e183a342ec4729f3d84accf515e88adddb85ecc08daba68404bae9a8e8d7178977d7094a1ae549f89338c0777551f874159eb42d3a59fb9285ad4e24883f27de23942ec966611e99bee1cee503455be9e8e642cef6cef7b9864130f692283f8a973d47a8f1c1726b6e59969385975c766e35737c8d76388b64f748ee7943ffb0e2ee45c57a1abc40762ae598723d21bd184e2b338f68ebff47219357bd19cd7e01e2337b806ef4d717888e129e59cd3dc31e6201ccb2fd6d7499836f37a993262468bcb3a4dcd03a22818aca49c6b7b9b8e9e870045631d8e039b066ff86e0d1b7291f71cefa7264c70404a8e538b566c17ccc5feab231401e6c08a01bd5edfc1aa8e3e533b96e82d1f91118d508924b923531929aea889fcdf050597c681185f336b1da63b0939aa2b7c50b21b5eb7b6ad66c81fab98a3cdf73f658149e7e9ced4edde5d38c9b8f92e16f6b4ab13d7fca6a0e4ecc9f9de611a90da6e99c39551094c56e3196f282c5dffd9fc4b2fc12f3bca8e6fe47eb45fbdd3be21a8a8d200797eae3c9a0497132f92410d804977408494dff49dd3d8bce248e0b74fd9e6f0f7102c25ddfa02bd9ad9f746abbfa337ef811d5345a9e16b60de1767b209645ba40bd1f9a5f75bc04feca9b27c5554be4fe83fac2cb83aa447a817bb85ae966c68b420063833fada375e2f515965e687a45699632902672c654d1d18d7bcbf55e8fa57f63f2da449f8e1e606e8722df081e5f193fc4179feb99ad22819afdeef211f7c54afdba92aeef0c00b7bc2b65a4813c01f907a8377585708f2d4c940a25328e585714c8ded0a9a4d7a6de1027c1cb7a0198cd3db68b58c0704dfd0cfbe624e9cd18cc0ae5d96697bb476708b9ee0403d211e64e0d5a7683a7a9a140c02f0ff1c6e67a302941b4052bdea8a63e70a3ad62c5b89c698f1fd3c7685cb49705096cad702d02d93bcb1c27a409f4c9bddec001205ca4a2740f19b50900be81c7e847f1a863deea8d35701f1355cad8db57b1d4eb2ab4e29587734785abfb46ddede71928213d7d089dfdeda052827f459f1688cc0935bd47e7bcec27427c8376dcce7e22699567c0d145f8a7db33f6758815f1f15f9f7a9760dec4f34ae095edda4c64e9735bdd029c4e32c2ee31ba47ec5e6bdb97813d52dbd15b4e0b7a2c7f790ae64104d99f38c127f0a093288fa34144adb16b8968d4fa7656fcec99de8503dd46d3b03620a71c7cd085364abd30dccf7fbda25a1cdc102600149c9af1c97aa0372cd2e1909f28ac5c686f432b310e79528c9b8b9e8f314c1e74621ce6308ad2278b81d460892e0d9dd38b7c76d58be6dfd10ae7583ee1e7ef5b3f6f78dc60af0950df1b00cc55b6d178ba2e476bea0eaeef49323b83f05804159e7aef4eed4cc60dd07be76f067dfd0bcfb0b806b69ba921336a20c43c832d0cab8fa3ddeb29e3bf07b0d98a112eb07802756235a49d44a8b82a950d84e95e01971f0e106ccb337f07384e21620e0ad39e16ed9edca123226cf55ac44f449eeb53e38a7f27d101806e4823e4efcc887414240ee6826c4a5cb1c6443ad36ebf905a435c1d9054e54173911b17b5b40f60b3d9fd5f12eac54ca1e20191f5f18544d5fd3d665e9bcef96fb44b76110aa64d9db4c86c9513cbdad546538e8aec521fbe83ceac5e74a15629f1ed0b870a1d0d1e5680b6d6100d1bd3f3b9043bd35b8919c4088f1949b8be89e4701eb870f8ed64fafa446c78df3ea").unwrap());
 697         }
 698 }