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