_ 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;
  15 use lightning::ln::channelmanager::ChannelDetails;
  16 use lightning::ln::features::InitFeatures;
  17 use lightning::ln::msgs;
  18 use lightning::routing::router::{get_route, RouteHint};
  19 use lightning::util::logger::Logger;
  20 use lightning::util::ser::Readable;
  21 use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
  22
  23 use bitcoin::secp256k1::key::PublicKey;
  24 use bitcoin::network::constants::Network;
  25 use bitcoin::blockdata::constants::genesis_block;
  26
  27 use utils::test_logger;
  28
  29 use std::collections::HashSet;
  30 use std::sync::Arc;
  31 use std::sync::atomic::{AtomicUsize, Ordering};
  32
  33 #[inline]
  34 pub fn slice_to_be16(v: &[u8]) -> u16 {
  35         ((v[0] as u16) << 8*1) |
  36         ((v[1] as u16) << 8*0)
  37 }
  38
  39 #[inline]
  40 pub fn slice_to_be32(v: &[u8]) -> u32 {
  41         ((v[0] as u32) << 8*3) |
  42         ((v[1] as u32) << 8*2) |
  43         ((v[2] as u32) << 8*1) |
  44         ((v[3] as u32) << 8*0)
  45 }
  46
  47 #[inline]
  48 pub fn slice_to_be64(v: &[u8]) -> u64 {
  49         ((v[0] as u64) << 8*7) |
  50         ((v[1] as u64) << 8*6) |
  51         ((v[2] as u64) << 8*5) |
  52         ((v[3] as u64) << 8*4) |
  53         ((v[4] as u64) << 8*3) |
  54         ((v[5] as u64) << 8*2) |
  55         ((v[6] as u64) << 8*1) |
  56         ((v[7] as u64) << 8*0)
  57 }
  58
  59
  60 struct InputData {
  61         data: Vec<u8>,
  62         read_pos: AtomicUsize,
  63 }
  64 impl InputData {
  65         fn get_slice(&self, len: usize) -> Option<&[u8]> {
  66                 let old_pos = self.read_pos.fetch_add(len, Ordering::AcqRel);
  67                 if self.data.len() < old_pos + len {
  68                         return None;
  69                 }
  70                 Some(&self.data[old_pos..old_pos + len])
  71         }
  72         fn get_slice_nonadvancing(&self, len: usize) -> Option<&[u8]> {
  73                 let old_pos = self.read_pos.load(Ordering::Acquire);
  74                 if self.data.len() < old_pos + len {
  75                         return None;
  76                 }
  77                 Some(&self.data[old_pos..old_pos + len])
  78         }
  79 }
  80
  81 struct FuzzChainSource {
  82         input: Arc<InputData>,
  83 }
  84 impl chain::Access for FuzzChainSource {
  85         fn get_utxo(&self, _genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
  86                 match self.input.get_slice(2) {
  87                         Some(&[0, _]) => Err(chain::AccessError::UnknownChain),
  88                         Some(&[1, _]) => Err(chain::AccessError::UnknownTx),
  89                         Some(&[_, x]) => Ok(TxOut { value: 0, script_pubkey: Builder::new().push_int(x as i64).into_script().to_v0_p2wsh() }),
  90                         None => Err(chain::AccessError::UnknownTx),
  91                         _ => unreachable!(),
  92                 }
  93         }
  94 }
  95
  96 #[inline]
  97 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
  98         let input = Arc::new(InputData {
  99                 data: data.to_vec(),
 100                 read_pos: AtomicUsize::new(0),
 101         });
 102         macro_rules! get_slice_nonadvancing {
 103                 ($len: expr) => {
 104                         match input.get_slice_nonadvancing($len as usize) {
 105                                 Some(slice) => slice,
 106                                 None => return,
 107                         }
 108                 }
 109         }
 110         macro_rules! get_slice {
 111                 ($len: expr) => {
 112                         match input.get_slice($len as usize) {
 113                                 Some(slice) => slice,
 114                                 None => return,
 115                         }
 116                 }
 117         }
 118
 119         macro_rules! decode_msg {
 120                 ($MsgType: path, $len: expr) => {{
 121                         let mut reader = ::std::io::Cursor::new(get_slice!($len));
 122                         match <$MsgType>::read(&mut reader) {
 123                                 Ok(msg) => {
 124                                         assert_eq!(reader.position(), $len as u64);
 125                                         msg
 126                                 },
 127                                 Err(e) => match e {
 128                                         msgs::DecodeError::UnknownVersion => return,
 129                                         msgs::DecodeError::UnknownRequiredFeature => return,
 130                                         msgs::DecodeError::InvalidValue => return,
 131                                         msgs::DecodeError::BadLengthDescriptor => return,
 132                                         msgs::DecodeError::ShortRead => panic!("We picked the length..."),
 133                                         msgs::DecodeError::Io(e) => panic!(format!("{:?}", e)),
 134                                 }
 135                         }
 136                 }}
 137         }
 138
 139         macro_rules! decode_msg_with_len16 {
 140                 ($MsgType: path, $excess: expr) => {
 141                         {
 142                                 let extra_len = slice_to_be16(get_slice_nonadvancing!(2));
 143                                 decode_msg!($MsgType, 2 + (extra_len as usize) + $excess)
 144                         }
 145                 }
 146         }
 147
 148         macro_rules! get_pubkey {
 149                 () => {
 150                         match PublicKey::from_slice(get_slice!(33)) {
 151                                 Ok(key) => key,
 152                                 Err(_) => return,
 153                         }
 154                 }
 155         }
 156
 157         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new("".to_owned(), out));
 158
 159         let our_pubkey = get_pubkey!();
 160         let mut net_graph = NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash());
 161
 162         let mut node_pks = HashSet::new();
 163         let mut scid = 42;
 164
 165         loop {
 166                 match get_slice!(1)[0] {
 167                         0 => {
 168                                 let start_len = slice_to_be16(&get_slice_nonadvancing!(2)[0..2]) as usize;
 169                                 let addr_len = slice_to_be16(&get_slice_nonadvancing!(start_len+2 + 74)[start_len+2 + 72..start_len+2 + 74]);
 170                                 if addr_len > (37+1)*4 {
 171                                         return;
 172                                 }
 173                                 let msg = decode_msg_with_len16!(msgs::UnsignedNodeAnnouncement, 288);
 174                                 node_pks.insert(msg.node_id);
 175                                 let _ = net_graph.update_node_from_unsigned_announcement(&msg);
 176                         },
 177                         1 => {
 178                                 let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
 179                                 node_pks.insert(msg.node_id_1);
 180                                 node_pks.insert(msg.node_id_2);
 181                                 let _ = net_graph.update_channel_from_unsigned_announcement::<&FuzzChainSource>(&msg, &None);
 182                         },
 183                         2 => {
 184                                 let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
 185                                 node_pks.insert(msg.node_id_1);
 186                                 node_pks.insert(msg.node_id_2);
 187                                 let _ = net_graph.update_channel_from_unsigned_announcement(&msg, &Some(&FuzzChainSource { input: Arc::clone(&input) }));
 188                         },
 189                         3 => {
 190                                 let _ = net_graph.update_channel_unsigned(&decode_msg!(msgs::UnsignedChannelUpdate, 72));
 191                         },
 192                         4 => {
 193                                 let short_channel_id = slice_to_be64(get_slice!(8));
 194                                 net_graph.close_channel_from_update(short_channel_id, false);
 195                         },
 196                         _ if node_pks.is_empty() => {},
 197                         _ => {
 198                                 let mut first_hops_vec = Vec::new();
 199                                 let first_hops = match get_slice!(1)[0] {
 200                                         0 => None,
 201                                         count => {
 202                                                 for _ in 0..count {
 203                                                         scid += 1;
 204                                                         let rnid = node_pks.iter().skip(slice_to_be16(get_slice!(2))as usize % node_pks.len()).next().unwrap();
 205                                                         first_hops_vec.push(ChannelDetails {
 206                                                                 channel_id: [0; 32],
 207                                                                 short_channel_id: Some(scid),
 208                                                                 remote_network_id: *rnid,
 209                                                                 counterparty_features: InitFeatures::known(),
 210                                                                 channel_value_satoshis: slice_to_be64(get_slice!(8)),
 211                                                                 user_id: 0,
 212                                                                 inbound_capacity_msat: 0,
 213                                                                 is_live: true,
 214                                                                 outbound_capacity_msat: 0,
 215                                                         });
 216                                                 }
 217                                                 Some(&first_hops_vec[..])
 218                                         },
 219                                 };
 220                                 let mut last_hops_vec = Vec::new();
 221                                 {
 222                                         let count = get_slice!(1)[0];
 223                                         for _ in 0..count {
 224                                                 scid += 1;
 225                                                 let rnid = node_pks.iter().skip(slice_to_be16(get_slice!(2))as usize % node_pks.len()).next().unwrap();
 226                                                 last_hops_vec.push(RouteHint {
 227                                                         src_node_id: *rnid,
 228                                                         short_channel_id: scid,
 229                                                         fees: RoutingFees {
 230                                                                 base_msat: slice_to_be32(get_slice!(4)),
 231                                                                 proportional_millionths: slice_to_be32(get_slice!(4)),
 232                                                         },
 233                                                         cltv_expiry_delta: slice_to_be16(get_slice!(2)),
 234                                                         htlc_minimum_msat: Some(slice_to_be64(get_slice!(8))),
 235                                                         htlc_maximum_msat: None,
 236                                                 });
 237                                         }
 238                                 }
 239                                 let last_hops = &last_hops_vec[..];
 240                                 for target in node_pks.iter() {
 241                                         let _ = get_route(&our_pubkey, &net_graph, target,
 242                                                 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 243                                                 &last_hops.iter().collect::<Vec<_>>(),
 244                                                 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 245                                 }
 246                         },
 247                 }
 248         }
 249 }
 250
 251 pub fn router_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 252         do_test(data, out);
 253 }
 254
 255 #[no_mangle]
 256 pub extern "C" fn router_run(data: *const u8, datalen: usize) {
 257         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull {});
 258 }