]> git.bitcoin.ninja Git - rust-lightning/blob - fuzz/src/router.rs
a5cd91f2884a0a4e78eae3aa09114f3d417141b4
[rust-lightning] / 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::chain::transaction::OutPoint;
16 use lightning::ln::channelmanager::{self, ChannelDetails, ChannelCounterparty};
17 use lightning::ln::msgs;
18 use lightning::routing::gossip::{NetworkGraph, RoutingFees};
19 use lightning::routing::router::{find_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
20 use lightning::routing::scoring::FixedPenaltyScorer;
21 use lightning::util::ser::Readable;
22
23 use bitcoin::hashes::Hash;
24 use bitcoin::secp256k1::PublicKey;
25 use bitcoin::network::constants::Network;
26 use bitcoin::blockdata::constants::genesis_block;
27
28 use crate::utils::test_logger;
29
30 use std::convert::TryInto;
31 use std::collections::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 {
84         input: Arc<InputData>,
85 }
86 impl chain::Access for FuzzChainSource {
87         fn get_utxo(&self, _genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
88                 match self.input.get_slice(2) {
89                         Some(&[0, _]) => Err(chain::AccessError::UnknownChain),
90                         Some(&[1, _]) => Err(chain::AccessError::UnknownTx),
91                         Some(&[_, x]) => Ok(TxOut { value: 0, script_pubkey: Builder::new().push_int(x as i64).into_script().to_v0_p2wsh() }),
92                         None => Err(chain::AccessError::UnknownTx),
93                         _ => unreachable!(),
94                 }
95         }
96 }
97
98 #[inline]
99 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
100         let input = Arc::new(InputData {
101                 data: data.to_vec(),
102                 read_pos: AtomicUsize::new(0),
103         });
104         macro_rules! get_slice_nonadvancing {
105                 ($len: expr) => {
106                         match input.get_slice_nonadvancing($len as usize) {
107                                 Some(slice) => slice,
108                                 None => return,
109                         }
110                 }
111         }
112         macro_rules! get_slice {
113                 ($len: expr) => {
114                         match input.get_slice($len as usize) {
115                                 Some(slice) => slice,
116                                 None => return,
117                         }
118                 }
119         }
120
121         macro_rules! decode_msg {
122                 ($MsgType: path, $len: expr) => {{
123                         let mut reader = ::std::io::Cursor::new(get_slice!($len));
124                         match <$MsgType>::read(&mut reader) {
125                                 Ok(msg) => {
126                                         assert_eq!(reader.position(), $len as u64);
127                                         msg
128                                 },
129                                 Err(e) => match e {
130                                         msgs::DecodeError::UnknownVersion => return,
131                                         msgs::DecodeError::UnknownRequiredFeature => return,
132                                         msgs::DecodeError::InvalidValue => return,
133                                         msgs::DecodeError::BadLengthDescriptor => return,
134                                         msgs::DecodeError::ShortRead => panic!("We picked the length..."),
135                                         msgs::DecodeError::Io(e) => panic!("{:?}", e),
136                                         msgs::DecodeError::UnsupportedCompression => return,
137                                 }
138                         }
139                 }}
140         }
141
142         macro_rules! decode_msg_with_len16 {
143                 ($MsgType: path, $excess: expr) => {
144                         {
145                                 let extra_len = slice_to_be16(get_slice_nonadvancing!(2));
146                                 decode_msg!($MsgType, 2 + (extra_len as usize) + $excess)
147                         }
148                 }
149         }
150
151         macro_rules! get_pubkey {
152                 () => {
153                         match PublicKey::from_slice(get_slice!(33)) {
154                                 Ok(key) => key,
155                                 Err(_) => return,
156                         }
157                 }
158         }
159
160         let logger = test_logger::TestLogger::new("".to_owned(), out);
161
162         let our_pubkey = get_pubkey!();
163         let net_graph = NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash(), &logger);
164
165         let mut node_pks = HashSet::new();
166         let mut scid = 42;
167
168         loop {
169                 match get_slice!(1)[0] {
170                         0 => {
171                                 let start_len = slice_to_be16(&get_slice_nonadvancing!(2)[0..2]) as usize;
172                                 let addr_len = slice_to_be16(&get_slice_nonadvancing!(start_len+2 + 74)[start_len+2 + 72..start_len+2 + 74]);
173                                 if addr_len > (37+1)*4 {
174                                         return;
175                                 }
176                                 let msg = decode_msg_with_len16!(msgs::UnsignedNodeAnnouncement, 288);
177                                 node_pks.insert(msg.node_id);
178                                 let _ = net_graph.update_node_from_unsigned_announcement(&msg);
179                         },
180                         1 => {
181                                 let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
182                                 node_pks.insert(msg.node_id_1);
183                                 node_pks.insert(msg.node_id_2);
184                                 let _ = net_graph.update_channel_from_unsigned_announcement::<&FuzzChainSource>(&msg, &None);
185                         },
186                         2 => {
187                                 let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
188                                 node_pks.insert(msg.node_id_1);
189                                 node_pks.insert(msg.node_id_2);
190                                 let _ = net_graph.update_channel_from_unsigned_announcement(&msg, &Some(&FuzzChainSource { input: Arc::clone(&input) }));
191                         },
192                         3 => {
193                                 let _ = net_graph.update_channel_unsigned(&decode_msg!(msgs::UnsignedChannelUpdate, 72));
194                         },
195                         4 => {
196                                 let short_channel_id = slice_to_be64(get_slice!(8));
197                                 net_graph.channel_failed(short_channel_id, false);
198                         },
199                         _ if node_pks.is_empty() => {},
200                         _ => {
201                                 let mut first_hops_vec = Vec::new();
202                                 let first_hops = match get_slice!(1)[0] {
203                                         0 => None,
204                                         count => {
205                                                 for _ in 0..count {
206                                                         scid += 1;
207                                                         let rnid = node_pks.iter().skip(u16::from_be_bytes(get_slice!(2).try_into().unwrap()) as usize % node_pks.len()).next().unwrap();
208                                                         let capacity = u64::from_be_bytes(get_slice!(8).try_into().unwrap());
209                                                         first_hops_vec.push(ChannelDetails {
210                                                                 channel_id: [0; 32],
211                                                                 counterparty: ChannelCounterparty {
212                                                                         node_id: *rnid,
213                                                                         features: channelmanager::provided_init_features(),
214                                                                         unspendable_punishment_reserve: 0,
215                                                                         forwarding_info: None,
216                                                                         outbound_htlc_minimum_msat: None,
217                                                                         outbound_htlc_maximum_msat: None,
218                                                                 },
219                                                                 funding_txo: Some(OutPoint { txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0 }),
220                                                                 channel_type: None,
221                                                                 short_channel_id: Some(scid),
222                                                                 inbound_scid_alias: None,
223                                                                 outbound_scid_alias: None,
224                                                                 channel_value_satoshis: capacity,
225                                                                 user_channel_id: 0, inbound_capacity_msat: 0,
226                                                                 unspendable_punishment_reserve: None,
227                                                                 confirmations_required: None,
228                                                                 force_close_spend_delay: None,
229                                                                 is_outbound: true, is_channel_ready: true,
230                                                                 is_usable: true, is_public: true,
231                                                                 balance_msat: 0,
232                                                                 outbound_capacity_msat: capacity.saturating_mul(1000),
233                                                                 next_outbound_htlc_limit_msat: capacity.saturating_mul(1000),
234                                                                 inbound_htlc_minimum_msat: None,
235                                                                 inbound_htlc_maximum_msat: None,
236                                                                 config: None,
237                                                         });
238                                                 }
239                                                 Some(&first_hops_vec[..])
240                                         },
241                                 };
242                                 let mut last_hops = Vec::new();
243                                 {
244                                         let count = get_slice!(1)[0];
245                                         for _ in 0..count {
246                                                 scid += 1;
247                                                 let rnid = node_pks.iter().skip(slice_to_be16(get_slice!(2))as usize % node_pks.len()).next().unwrap();
248                                                 last_hops.push(RouteHint(vec![RouteHintHop {
249                                                         src_node_id: *rnid,
250                                                         short_channel_id: scid,
251                                                         fees: RoutingFees {
252                                                                 base_msat: slice_to_be32(get_slice!(4)),
253                                                                 proportional_millionths: slice_to_be32(get_slice!(4)),
254                                                         },
255                                                         cltv_expiry_delta: slice_to_be16(get_slice!(2)),
256                                                         htlc_minimum_msat: Some(slice_to_be64(get_slice!(8))),
257                                                         htlc_maximum_msat: None,
258                                                 }]));
259                                         }
260                                 }
261                                 let scorer = FixedPenaltyScorer::with_penalty(0);
262                                 let random_seed_bytes: [u8; 32] = [get_slice!(1)[0]; 32];
263                                 for target in node_pks.iter() {
264                                         let route_params = RouteParameters {
265                                                 payment_params: PaymentParameters::from_node_id(*target).with_route_hints(last_hops.clone()),
266                                                 final_value_msat: slice_to_be64(get_slice!(8)),
267                                                 final_cltv_expiry_delta: slice_to_be32(get_slice!(4)),
268                                         };
269                                         let _ = find_route(&our_pubkey, &route_params, &net_graph,
270                                                 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
271                                                 &logger, &scorer, &random_seed_bytes);
272                                 }
273                         },
274                 }
275         }
276 }
277
278 pub fn router_test<Out: test_logger::Output>(data: &[u8], out: Out) {
279         do_test(data, out);
280 }
281
282 #[no_mangle]
283 pub extern "C" fn router_run(data: *const u8, datalen: usize) {
284         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull {});
285 }