_ Git - rust-lightning/blob - fuzz/src/router.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 bitcoin::blockdata::script::Builder;
  11 use bitcoin::blockdata::transaction::TxOut;
  12 use bitcoin::hash_types::BlockHash;
  13
  14 use lightning::chain::transaction::OutPoint;
  15 use lightning::ln::channelmanager::{self, ChannelDetails, ChannelCounterparty};
  16 use lightning::ln::msgs;
  17 use lightning::routing::gossip::{NetworkGraph, RoutingFees};
  18 use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};
  19 use lightning::routing::router::{find_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
  20 use lightning::routing::scoring::FixedPenaltyScorer;
  21 use lightning::util::config::UserConfig;
  22 use lightning::util::ser::Readable;
  23
  24 use bitcoin::hashes::Hash;
  25 use bitcoin::secp256k1::PublicKey;
  26 use bitcoin::network::constants::Network;
  27
  28 use crate::utils::test_logger;
  29
  30 use std::convert::TryInto;
  31 use hashbrown::HashSet;
  32 use std::sync::Arc;
  33 use std::sync::atomic::{AtomicUsize, Ordering};
  34
  35 #[inline]
  36 pub fn slice_to_be16(v: &[u8]) -> u16 {
  37         ((v[0] as u16) << 8*1) |
  38         ((v[1] as u16) << 8*0)
  39 }
  40
  41 #[inline]
  42 pub fn slice_to_be32(v: &[u8]) -> u32 {
  43         ((v[0] as u32) << 8*3) |
  44         ((v[1] as u32) << 8*2) |
  45         ((v[2] as u32) << 8*1) |
  46         ((v[3] as u32) << 8*0)
  47 }
  48
  49 #[inline]
  50 pub fn slice_to_be64(v: &[u8]) -> u64 {
  51         ((v[0] as u64) << 8*7) |
  52         ((v[1] as u64) << 8*6) |
  53         ((v[2] as u64) << 8*5) |
  54         ((v[3] as u64) << 8*4) |
  55         ((v[4] as u64) << 8*3) |
  56         ((v[5] as u64) << 8*2) |
  57         ((v[6] as u64) << 8*1) |
  58         ((v[7] as u64) << 8*0)
  59 }
  60
  61
  62 struct InputData {
  63         data: Vec<u8>,
  64         read_pos: AtomicUsize,
  65 }
  66 impl InputData {
  67         fn get_slice(&self, len: usize) -> Option<&[u8]> {
  68                 let old_pos = self.read_pos.fetch_add(len, Ordering::AcqRel);
  69                 if self.data.len() < old_pos + len {
  70                         return None;
  71                 }
  72                 Some(&self.data[old_pos..old_pos + len])
  73         }
  74         fn get_slice_nonadvancing(&self, len: usize) -> Option<&[u8]> {
  75                 let old_pos = self.read_pos.load(Ordering::Acquire);
  76                 if self.data.len() < old_pos + len {
  77                         return None;
  78                 }
  79                 Some(&self.data[old_pos..old_pos + len])
  80         }
  81 }
  82
  83 struct FuzzChainSource<'a, 'b, Out: test_logger::Output> {
  84         input: Arc<InputData>,
  85         net_graph: &'a NetworkGraph<&'b test_logger::TestLogger<Out>>,
  86 }
  87 impl<Out: test_logger::Output> UtxoLookup for FuzzChainSource<'_, '_, Out> {
  88         fn get_utxo(&self, _genesis_hash: &BlockHash, _short_channel_id: u64) -> UtxoResult {
  89                 let input_slice = self.input.get_slice(2);
  90                 if input_slice.is_none() { return UtxoResult::Sync(Err(UtxoLookupError::UnknownTx)); }
  91                 let input_slice = input_slice.unwrap();
  92                 let txo_res = TxOut {
  93                         value: if input_slice[0] % 2 == 0 { 1_000_000 } else { 1_000 },
  94                         script_pubkey: Builder::new().push_int(input_slice[1] as i64).into_script().to_v0_p2wsh(),
  95                 };
  96                 match input_slice {
  97                         &[0, _] => UtxoResult::Sync(Err(UtxoLookupError::UnknownChain)),
  98                         &[1, _] => UtxoResult::Sync(Err(UtxoLookupError::UnknownTx)),
  99                         &[2, _] => {
 100                                 let future = UtxoFuture::new();
 101                                 future.resolve_without_forwarding(self.net_graph, Ok(txo_res));
 102                                 UtxoResult::Async(future.clone())
 103                         },
 104                         &[3, _] => {
 105                                 let future = UtxoFuture::new();
 106                                 future.resolve_without_forwarding(self.net_graph, Err(UtxoLookupError::UnknownTx));
 107                                 UtxoResult::Async(future.clone())
 108                         },
 109                         &[4, _] => {
 110                                 UtxoResult::Async(UtxoFuture::new()) // the future will never resolve
 111                         },
 112                         &[..] => UtxoResult::Sync(Ok(txo_res)),
 113                 }
 114         }
 115 }
 116
 117 #[inline]
 118 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 119         let input = Arc::new(InputData {
 120                 data: data.to_vec(),
 121                 read_pos: AtomicUsize::new(0),
 122         });
 123         macro_rules! get_slice_nonadvancing {
 124                 ($len: expr) => {
 125                         match input.get_slice_nonadvancing($len as usize) {
 126                                 Some(slice) => slice,
 127                                 None => return,
 128                         }
 129                 }
 130         }
 131         macro_rules! get_slice {
 132                 ($len: expr) => {
 133                         match input.get_slice($len as usize) {
 134                                 Some(slice) => slice,
 135                                 None => return,
 136                         }
 137                 }
 138         }
 139
 140         macro_rules! decode_msg {
 141                 ($MsgType: path, $len: expr) => {{
 142                         let mut reader = ::std::io::Cursor::new(get_slice!($len));
 143                         match <$MsgType>::read(&mut reader) {
 144                                 Ok(msg) => {
 145                                         assert_eq!(reader.position(), $len as u64);
 146                                         msg
 147                                 },
 148                                 Err(e) => match e {
 149                                         msgs::DecodeError::UnknownVersion => return,
 150                                         msgs::DecodeError::UnknownRequiredFeature => return,
 151                                         msgs::DecodeError::InvalidValue => return,
 152                                         msgs::DecodeError::BadLengthDescriptor => return,
 153                                         msgs::DecodeError::ShortRead => panic!("We picked the length..."),
 154                                         msgs::DecodeError::Io(e) => panic!("{:?}", e),
 155                                         msgs::DecodeError::UnsupportedCompression => return,
 156                                 }
 157                         }
 158                 }}
 159         }
 160
 161         macro_rules! decode_msg_with_len16 {
 162                 ($MsgType: path, $excess: expr) => {
 163                         {
 164                                 let extra_len = slice_to_be16(get_slice_nonadvancing!(2));
 165                                 decode_msg!($MsgType, 2 + (extra_len as usize) + $excess)
 166                         }
 167                 }
 168         }
 169
 170         macro_rules! get_pubkey_from_node_id {
 171                 ($node_id: expr ) => {
 172                         match PublicKey::from_slice($node_id.as_slice()) {
 173                                 Ok(pk) => pk,
 174                                 Err(_) => return,
 175                         }
 176                 }
 177         }
 178
 179         macro_rules! get_pubkey {
 180                 () => {
 181                         match PublicKey::from_slice(get_slice!(33)) {
 182                                 Ok(key) => key,
 183                                 Err(_) => return,
 184                         }
 185                 }
 186         }
 187
 188         let logger = test_logger::TestLogger::new("".to_owned(), out);
 189
 190         let our_pubkey = get_pubkey!();
 191         let net_graph = NetworkGraph::new(Network::Bitcoin, &logger);
 192         let chain_source = FuzzChainSource {
 193                 input: Arc::clone(&input),
 194                 net_graph: &net_graph,
 195         };
 196
 197         let mut node_pks = HashSet::new();
 198         let mut scid = 42;
 199
 200         loop {
 201                 match get_slice!(1)[0] {
 202                         0 => {
 203                                 let start_len = slice_to_be16(&get_slice_nonadvancing!(2)[0..2]) as usize;
 204                                 let addr_len = slice_to_be16(&get_slice_nonadvancing!(start_len+2 + 74)[start_len+2 + 72..start_len+2 + 74]);
 205                                 if addr_len > (37+1)*4 {
 206                                         return;
 207                                 }
 208                                 let msg = decode_msg_with_len16!(msgs::UnsignedNodeAnnouncement, 288);
 209                                 node_pks.insert(get_pubkey_from_node_id!(msg.node_id));
 210                                 let _ = net_graph.update_node_from_unsigned_announcement(&msg);
 211                         },
 212                         1 => {
 213                                 let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
 214                                 node_pks.insert(get_pubkey_from_node_id!(msg.node_id_1));
 215                                 node_pks.insert(get_pubkey_from_node_id!(msg.node_id_2));
 216                                 let _ = net_graph.update_channel_from_unsigned_announcement::
 217                                         <&FuzzChainSource<'_, '_, Out>>(&msg, &None);
 218                         },
 219                         2 => {
 220                                 let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
 221                                 node_pks.insert(get_pubkey_from_node_id!(msg.node_id_1));
 222                                 node_pks.insert(get_pubkey_from_node_id!(msg.node_id_2));
 223                                 let _ = net_graph.update_channel_from_unsigned_announcement(&msg, &Some(&chain_source));
 224                         },
 225                         3 => {
 226                                 let _ = net_graph.update_channel_unsigned(&decode_msg!(msgs::UnsignedChannelUpdate, 72));
 227                         },
 228                         4 => {
 229                                 let short_channel_id = slice_to_be64(get_slice!(8));
 230                                 net_graph.channel_failed(short_channel_id, false);
 231                         },
 232                         _ if node_pks.is_empty() => {},
 233                         _ => {
 234                                 let mut first_hops_vec = Vec::new();
 235                                 let first_hops = match get_slice!(1)[0] {
 236                                         0 => None,
 237                                         count => {
 238                                                 for _ in 0..count {
 239                                                         scid += 1;
 240                                                         let rnid = node_pks.iter().skip(u16::from_be_bytes(get_slice!(2).try_into().unwrap()) as usize % node_pks.len()).next().unwrap();
 241                                                         let capacity = u64::from_be_bytes(get_slice!(8).try_into().unwrap());
 242                                                         first_hops_vec.push(ChannelDetails {
 243                                                                 channel_id: [0; 32],
 244                                                                 counterparty: ChannelCounterparty {
 245                                                                         node_id: *rnid,
 246                                                                         features: channelmanager::provided_init_features(&UserConfig::default()),
 247                                                                         unspendable_punishment_reserve: 0,
 248                                                                         forwarding_info: None,
 249                                                                         outbound_htlc_minimum_msat: None,
 250                                                                         outbound_htlc_maximum_msat: None,
 251                                                                 },
 252                                                                 funding_txo: Some(OutPoint { txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0 }),
 253                                                                 channel_type: None,
 254                                                                 short_channel_id: Some(scid),
 255                                                                 inbound_scid_alias: None,
 256                                                                 outbound_scid_alias: None,
 257                                                                 channel_value_satoshis: capacity,
 258                                                                 user_channel_id: 0, inbound_capacity_msat: 0,
 259                                                                 unspendable_punishment_reserve: None,
 260                                                                 confirmations_required: None,
 261                                                                 confirmations: None,
 262                                                                 force_close_spend_delay: None,
 263                                                                 is_outbound: true, is_channel_ready: true,
 264                                                                 is_usable: true, is_public: true,
 265                                                                 balance_msat: 0,
 266                                                                 outbound_capacity_msat: capacity.saturating_mul(1000),
 267                                                                 next_outbound_htlc_limit_msat: capacity.saturating_mul(1000),
 268                                                                 inbound_htlc_minimum_msat: None,
 269                                                                 inbound_htlc_maximum_msat: None,
 270                                                                 config: None,
 271                                                         });
 272                                                 }
 273                                                 Some(&first_hops_vec[..])
 274                                         },
 275                                 };
 276                                 let mut last_hops = Vec::new();
 277                                 {
 278                                         let count = get_slice!(1)[0];
 279                                         for _ in 0..count {
 280                                                 scid += 1;
 281                                                 let rnid = node_pks.iter().skip(slice_to_be16(get_slice!(2))as usize % node_pks.len()).next().unwrap();
 282                                                 last_hops.push(RouteHint(vec![RouteHintHop {
 283                                                         src_node_id: *rnid,
 284                                                         short_channel_id: scid,
 285                                                         fees: RoutingFees {
 286                                                                 base_msat: slice_to_be32(get_slice!(4)),
 287                                                                 proportional_millionths: slice_to_be32(get_slice!(4)),
 288                                                         },
 289                                                         cltv_expiry_delta: slice_to_be16(get_slice!(2)),
 290                                                         htlc_minimum_msat: Some(slice_to_be64(get_slice!(8))),
 291                                                         htlc_maximum_msat: None,
 292                                                 }]));
 293                                         }
 294                                 }
 295                                 let scorer = FixedPenaltyScorer::with_penalty(0);
 296                                 let random_seed_bytes: [u8; 32] = [get_slice!(1)[0]; 32];
 297                                 for target in node_pks.iter() {
 298                                         let final_value_msat = slice_to_be64(get_slice!(8));
 299                                         let final_cltv_expiry_delta = slice_to_be32(get_slice!(4));
 300                                         let route_params = RouteParameters {
 301                                                 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 302                                                         .with_route_hints(last_hops.clone()),
 303                                                 final_value_msat,
 304                                         };
 305                                         let _ = find_route(&our_pubkey, &route_params, &net_graph,
 306                                                 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 307                                                 &logger, &scorer, &random_seed_bytes);
 308                                 }
 309                         },
 310                 }
 311         }
 312 }
 313
 314 pub fn router_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 315         do_test(data, out);
 316 }
 317
 318 #[no_mangle]
 319 pub extern "C" fn router_run(data: *const u8, datalen: usize) {
 320         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull {});
 321 }