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