23c63fee72bd0bb610e3d10acac798969a956889
[rust-lightning] / fuzz / fuzz_targets / channel_target.rs
1 extern crate bitcoin;
2 extern crate lightning;
3 extern crate secp256k1;
4
5 use bitcoin::blockdata::block::BlockHeader;
6 use bitcoin::blockdata::transaction::{Transaction, TxOut};
7 use bitcoin::util::hash::Sha256dHash;
8 use bitcoin::network::serialize::{serialize, BitcoinHash};
9
10 use lightning::ln::channel::{Channel, ChannelKeys};
11 use lightning::ln::channelmanager::{HTLCFailReason, PendingForwardHTLCInfo};
12 use lightning::ln::msgs;
13 use lightning::ln::msgs::MsgDecodable;
14 use lightning::chain::chaininterface::{FeeEstimator, ConfirmationTarget};
15 use lightning::chain::transaction::OutPoint;
16 use lightning::util::reset_rng_state;
17
18 use secp256k1::key::{PublicKey, SecretKey};
19 use secp256k1::Secp256k1;
20
21 use std::sync::atomic::{AtomicUsize,Ordering};
22
23 #[inline]
24 pub fn slice_to_be16(v: &[u8]) -> u16 {
25         ((v[0] as u16) << 8*1) |
26         ((v[1] as u16) << 8*0)
27 }
28
29 #[inline]
30 pub fn slice_to_be32(v: &[u8]) -> u32 {
31         ((v[0] as u32) << 8*3) |
32         ((v[1] as u32) << 8*2) |
33         ((v[2] as u32) << 8*1) |
34         ((v[3] as u32) << 8*0)
35 }
36
37 #[inline]
38 pub fn slice_to_be64(v: &[u8]) -> u64 {
39         ((v[0] as u64) << 8*7) |
40         ((v[1] as u64) << 8*6) |
41         ((v[2] as u64) << 8*5) |
42         ((v[3] as u64) << 8*4) |
43         ((v[4] as u64) << 8*3) |
44         ((v[5] as u64) << 8*2) |
45         ((v[6] as u64) << 8*1) |
46         ((v[7] as u64) << 8*0)
47 }
48
49 #[inline]
50 fn slice_to_be24(v: &[u8]) -> u64 {
51         //TODO: We should probably be returning a Result for channel creation, not panic!()ing on
52         //>2**24 values...
53         ((v[0] as u64) << 8*2) |
54         ((v[1] as u64) << 8*1) |
55         ((v[2] as u64) << 8*0)
56 }
57
58 struct InputData<'a> {
59         data: &'a [u8],
60         read_pos: AtomicUsize,
61 }
62 impl<'a> InputData<'a> {
63         fn get_slice(&self, len: usize) -> Option<&'a [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<&'a [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 FuzzEstimator<'a> {
80         input: &'a InputData<'a>,
81 }
82 impl<'a> FeeEstimator for FuzzEstimator<'a> {
83         fn get_est_sat_per_vbyte(&self, _: ConfirmationTarget) -> u64 {
84                 //TODO: We should actually be testing at least much more than 64k...
85                 match self.input.get_slice(2) {
86                         Some(slice) => slice_to_be16(slice) as u64,
87                         None => 0
88                 }
89         }
90 }
91
92 #[inline]
93 pub fn do_test(data: &[u8]) {
94         reset_rng_state();
95
96         let input = InputData {
97                 data,
98                 read_pos: AtomicUsize::new(0),
99         };
100         let fee_est = FuzzEstimator {
101                 input: &input,
102         };
103
104         macro_rules! get_slice {
105                 ($len: expr) => {
106                         match input.get_slice($len as usize) {
107                                 Some(slice) => slice,
108                                 None => return,
109                         }
110                 }
111         }
112
113         macro_rules! decode_msg {
114                 ($MsgType: path, $len: expr) => {
115                         match <($MsgType)>::decode(get_slice!($len)) {
116                                 Ok(msg) => msg,
117                                 Err(e) => match e {
118                                         msgs::DecodeError::UnknownRealmByte => return,
119                                         msgs::DecodeError::BadPublicKey => return,
120                                         msgs::DecodeError::BadSignature => return,
121                                         msgs::DecodeError::ExtraAddressesPerType => return,
122                                         msgs::DecodeError::WrongLength => panic!("We picked the length..."),
123                                 }
124                         }
125                 }
126         }
127
128         macro_rules! decode_msg_with_len16 {
129                 ($MsgType: path, $begin_len: expr, $factor: expr) => {
130                         {
131                                 let extra_len = slice_to_be16(&match input.get_slice_nonadvancing($begin_len as usize + 2) {
132                                         Some(slice) => slice,
133                                         None => return,
134                                 }[$begin_len..$begin_len + 2]);
135                                 match <($MsgType)>::decode(get_slice!($begin_len as usize + 2 + (extra_len as usize)*$factor)) {
136                                         Ok(msg) => msg,
137                                         Err(e) => match e {
138                                                 msgs::DecodeError::UnknownRealmByte => return,
139                                                 msgs::DecodeError::BadPublicKey => return,
140                                                 msgs::DecodeError::BadSignature => return,
141                                                 msgs::DecodeError::ExtraAddressesPerType => return,
142                                                 msgs::DecodeError::WrongLength => panic!("We picked the length..."),
143                                         }
144                                 }
145                         }
146                 }
147         }
148
149         let secp_ctx = Secp256k1::new();
150         macro_rules! get_pubkey {
151                 () => {
152                         match PublicKey::from_slice(&secp_ctx, get_slice!(33)) {
153                                 Ok(key) => key,
154                                 Err(_) => return,
155                         }
156                 }
157         }
158
159         macro_rules! return_err {
160                 ($expr: expr) => {
161                         match $expr {
162                                 Ok(r) => r,
163                                 Err(_) => return,
164                         }
165                 }
166         }
167
168         macro_rules! chan_keys {
169                 () => {
170                         ChannelKeys {
171                                 funding_key:               SecretKey::from_slice(&secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
172                                 revocation_base_key:       SecretKey::from_slice(&secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
173                                 payment_base_key:          SecretKey::from_slice(&secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
174                                 delayed_payment_base_key:  SecretKey::from_slice(&secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
175                                 htlc_base_key:             SecretKey::from_slice(&secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
176                                 channel_close_key:         SecretKey::from_slice(&secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
177                                 channel_monitor_claim_key: SecretKey::from_slice(&secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
178                                 commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
179                         }
180                 }
181         }
182
183         let their_pubkey = get_pubkey!();
184
185         let mut tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
186
187         let mut channel = if get_slice!(1)[0] != 0 {
188                 let chan_value = slice_to_be24(get_slice!(3));
189
190                 let mut chan = Channel::new_outbound(&fee_est, chan_keys!(), their_pubkey, chan_value, get_slice!(1)[0] == 0, slice_to_be64(get_slice!(8)));
191                 chan.get_open_channel(Sha256dHash::from(get_slice!(32)), &fee_est).unwrap();
192                 let accept_chan = if get_slice!(1)[0] == 0 {
193                         decode_msg_with_len16!(msgs::AcceptChannel, 270, 1)
194                 } else {
195                         decode_msg!(msgs::AcceptChannel, 270)
196                 };
197                 return_err!(chan.accept_channel(&accept_chan));
198
199                 tx.output.push(TxOut{ value: chan_value, script_pubkey: chan.get_funding_redeemscript().to_v0_p2wsh() });
200                 let funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
201
202                 chan.get_outbound_funding_created(funding_output).unwrap();
203                 let funding_signed = decode_msg!(msgs::FundingSigned, 32+64);
204                 return_err!(chan.funding_signed(&funding_signed));
205                 chan
206         } else {
207                 let open_chan = if get_slice!(1)[0] == 0 {
208                         decode_msg_with_len16!(msgs::OpenChannel, 2*32+6*8+4+2*2+6*33+1, 1)
209                 } else {
210                         decode_msg!(msgs::OpenChannel, 2*32+6*8+4+2*2+6*33+1)
211                 };
212                 let mut chan = match Channel::new_from_req(&fee_est, chan_keys!(), their_pubkey, &open_chan, slice_to_be64(get_slice!(8)), get_slice!(1)[0] == 0) {
213                         Ok(chan) => chan,
214                         Err(_) => return,
215                 };
216                 chan.get_accept_channel().unwrap();
217
218                 tx.output.push(TxOut{ value: open_chan.funding_satoshis, script_pubkey: chan.get_funding_redeemscript().to_v0_p2wsh() });
219                 let funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
220
221                 let mut funding_created = decode_msg!(msgs::FundingCreated, 32+32+2+64);
222                 funding_created.funding_txid = funding_output.txid.clone();
223                 funding_created.funding_output_index = funding_output.index;
224                 return_err!(chan.funding_created(&funding_created));
225                 chan
226         };
227
228         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
229         channel.block_connected(&header, 1, &[&tx; 1], &[42; 1]);
230         for i in 2..100 {
231                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
232                 channel.block_connected(&header, i, &[&tx; 0], &[0; 0]);
233         }
234
235         let funding_locked = decode_msg!(msgs::FundingLocked, 32+33);
236         return_err!(channel.funding_locked(&funding_locked));
237
238         loop {
239                 match get_slice!(1)[0] {
240                         0 => {
241                                 return_err!(channel.send_htlc(slice_to_be64(get_slice!(8)), [42; 32], slice_to_be32(get_slice!(4)), msgs::OnionPacket {
242                                         version: get_slice!(1)[0],
243                                         public_key: get_pubkey!(),
244                                         hop_data: [0; 20*65],
245                                         hmac: [0; 32],
246                                 }));
247                         },
248                         1 => {
249                                 return_err!(channel.send_commitment());
250                         },
251                         2 => {
252                                 let update_add_htlc = decode_msg!(msgs::UpdateAddHTLC, 32+8+8+32+4+4+33+20*65+32);
253                                 return_err!(channel.update_add_htlc(&update_add_htlc, PendingForwardHTLCInfo::dummy()));
254                         },
255                         3 => {
256                                 let update_fulfill_htlc = decode_msg!(msgs::UpdateFulfillHTLC, 32 + 8 + 32);
257                                 return_err!(channel.update_fulfill_htlc(&update_fulfill_htlc));
258                         },
259                         4 => {
260                                 let update_fail_htlc = decode_msg_with_len16!(msgs::UpdateFailHTLC, 32 + 8, 1);
261                                 return_err!(channel.update_fail_htlc(&update_fail_htlc, HTLCFailReason::dummy()));
262                         },
263                         5 => {
264                                 let update_fail_malformed_htlc = decode_msg!(msgs::UpdateFailMalformedHTLC, 32+8+32+2);
265                                 return_err!(channel.update_fail_malformed_htlc(&update_fail_malformed_htlc, HTLCFailReason::dummy()));
266                         },
267                         6 => {
268                                 let commitment_signed = decode_msg_with_len16!(msgs::CommitmentSigned, 32+64, 64);
269                                 return_err!(channel.commitment_signed(&commitment_signed));
270                         },
271                         7 => {
272                                 let revoke_and_ack = decode_msg!(msgs::RevokeAndACK, 32+32+33);
273                                 return_err!(channel.revoke_and_ack(&revoke_and_ack));
274                         },
275                         8 => {
276                                 let update_fee = decode_msg!(msgs::UpdateFee, 32+4);
277                                 return_err!(channel.update_fee(&fee_est, &update_fee));
278                         },
279                         9 => {
280                                 let shutdown = decode_msg_with_len16!(msgs::Shutdown, 32, 1);
281                                 return_err!(channel.shutdown(&fee_est, &shutdown));
282                                 if channel.is_shutdown() { return; }
283                         },
284                         10 => {
285                                 let closing_signed = decode_msg!(msgs::ClosingSigned, 32+8+64);
286                                 if return_err!(channel.closing_signed(&fee_est, &closing_signed)).1.is_some() {
287                                         assert!(channel.is_shutdown());
288                                         return;
289                                 }
290                         },
291                         _ => return,
292                 }
293         }
294 }
295
296 #[cfg(feature = "afl")]
297 extern crate afl;
298 #[cfg(feature = "afl")]
299 fn main() {
300         afl::read_stdio_bytes(|data| {
301                 do_test(&data);
302         });
303 }
304
305 #[cfg(feature = "honggfuzz")]
306 #[macro_use] extern crate honggfuzz;
307 #[cfg(feature = "honggfuzz")]
308 fn main() {
309         loop {
310                 fuzz!(|data| {
311                         do_test(data);
312                 });
313         }
314 }
315
316 #[cfg(test)]
317 mod tests {
318         fn extend_vec_from_hex(hex: &str, out: &mut Vec<u8>) {
319                 let mut b = 0;
320                 for (idx, c) in hex.as_bytes().iter().enumerate() {
321                         b <<= 4;
322                         match *c {
323                                 b'A'...b'F' => b |= c - b'A' + 10,
324                                 b'a'...b'f' => b |= c - b'a' + 10,
325                                 b'0'...b'9' => b |= c - b'0',
326                                 _ => panic!("Bad hex"),
327                         }
328                         if (idx & 1) == 1 {
329                                 out.push(b);
330                                 b = 0;
331                         }
332                 }
333         }
334
335         #[test]
336         fn duplicate_crash() {
337                 let mut a = Vec::new();
338                 extend_vec_from_hex("00", &mut a);
339                 super::do_test(&a);
340         }
341 }