_ Git - rust-lightning/blob - fuzz/src/onion_message.rs

   1 // Imports that need to be added manually
   2 use bitcoin::bech32::u5;
   3 use bitcoin::blockdata::script::Script;
   4 use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey};
   5 use bitcoin::secp256k1::ecdh::SharedSecret;
   6 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
   7 use bitcoin::secp256k1::schnorr;
   8
   9 use lightning::sign::{Recipient, KeyMaterial, EntropySource, NodeSigner, SignerProvider};
  10 use lightning::ln::msgs::{self, DecodeError, OnionMessageHandler};
  11 use lightning::ln::script::ShutdownScript;
  12 use lightning::offers::invoice::UnsignedBolt12Invoice;
  13 use lightning::offers::invoice_request::UnsignedInvoiceRequest;
  14 use lightning::util::test_channel_signer::TestChannelSigner;
  15 use lightning::util::logger::Logger;
  16 use lightning::util::ser::{Readable, Writeable, Writer};
  17 use lightning::onion_message::{CustomOnionMessageHandler, Destination, MessageRouter, OffersMessage, OffersMessageHandler, OnionMessageContents, OnionMessagePath, OnionMessenger, PendingOnionMessage};
  18
  19 use crate::utils::test_logger;
  20
  21 use std::io::{self, Cursor};
  22 use std::sync::atomic::{AtomicU64, Ordering};
  23
  24 #[inline]
  25 /// Actual fuzz test, method signature and name are fixed
  26 pub fn do_test<L: Logger>(data: &[u8], logger: &L) {
  27         if let Ok(msg) = <msgs::OnionMessage as Readable>::read(&mut Cursor::new(data)) {
  28                 let mut secret_bytes = [1; 32];
  29                 secret_bytes[31] = 2;
  30                 let secret = SecretKey::from_slice(&secret_bytes).unwrap();
  31                 let keys_manager = KeyProvider {
  32                         node_secret: secret,
  33                         counter: AtomicU64::new(0),
  34                 };
  35                 let message_router = TestMessageRouter {};
  36                 let offers_msg_handler = TestOffersMessageHandler {};
  37                 let custom_msg_handler = TestCustomMessageHandler {};
  38                 let onion_messenger = OnionMessenger::new(
  39                         &keys_manager, &keys_manager, logger, &message_router, &offers_msg_handler,
  40                         &custom_msg_handler
  41                 );
  42                 let mut pk = [2; 33]; pk[1] = 0xff;
  43                 let peer_node_id_not_used = PublicKey::from_slice(&pk).unwrap();
  44                 onion_messenger.handle_onion_message(&peer_node_id_not_used, &msg);
  45         }
  46 }
  47
  48 /// Method that needs to be added manually, {name}_test
  49 pub fn onion_message_test<Out: test_logger::Output>(data: &[u8], out: Out) {
  50         let logger = test_logger::TestLogger::new("".to_owned(), out);
  51         do_test(data, &logger);
  52 }
  53
  54 /// Method that needs to be added manually, {name}_run
  55 #[no_mangle]
  56 pub extern "C" fn onion_message_run(data: *const u8, datalen: usize) {
  57         let logger = test_logger::TestLogger::new("".to_owned(), test_logger::DevNull {});
  58         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, &logger);
  59 }
  60
  61 struct TestMessageRouter {}
  62
  63 impl MessageRouter for TestMessageRouter {
  64         fn find_path(
  65                 &self, _sender: PublicKey, _peers: Vec<PublicKey>, destination: Destination
  66         ) -> Result<OnionMessagePath, ()> {
  67                 Ok(OnionMessagePath {
  68                         intermediate_nodes: vec![],
  69                         destination,
  70                 })
  71         }
  72 }
  73
  74 struct TestOffersMessageHandler {}
  75
  76 impl OffersMessageHandler for TestOffersMessageHandler {
  77         fn handle_message(&self, _message: OffersMessage) -> Option<OffersMessage> {
  78                 None
  79         }
  80 }
  81
  82 struct TestCustomMessage {}
  83
  84 const CUSTOM_MESSAGE_TYPE: u64 = 4242;
  85 const CUSTOM_MESSAGE_CONTENTS: [u8; 32] = [42; 32];
  86
  87 impl OnionMessageContents for TestCustomMessage {
  88         fn tlv_type(&self) -> u64 {
  89                 CUSTOM_MESSAGE_TYPE
  90         }
  91 }
  92
  93 impl Writeable for TestCustomMessage {
  94         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
  95                 Ok(CUSTOM_MESSAGE_CONTENTS.write(w)?)
  96         }
  97 }
  98
  99 struct TestCustomMessageHandler {}
 100
 101 impl CustomOnionMessageHandler for TestCustomMessageHandler {
 102         type CustomMessage = TestCustomMessage;
 103         fn handle_custom_message(&self, _msg: Self::CustomMessage) -> Option<Self::CustomMessage> {
 104                 Some(TestCustomMessage {})
 105         }
 106         fn read_custom_message<R: io::Read>(&self, _message_type: u64, buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
 107                 let mut buf = Vec::new();
 108                 buffer.read_to_end(&mut buf)?;
 109                 return Ok(Some(TestCustomMessage {}))
 110         }
 111         fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Self::CustomMessage>> {
 112                 vec![]
 113         }
 114 }
 115
 116 pub struct VecWriter(pub Vec<u8>);
 117 impl Writer for VecWriter {
 118         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
 119                 self.0.extend_from_slice(buf);
 120                 Ok(())
 121         }
 122 }
 123 struct KeyProvider {
 124         node_secret: SecretKey,
 125         counter: AtomicU64,
 126 }
 127
 128 impl EntropySource for KeyProvider {
 129         fn get_secure_random_bytes(&self) -> [u8; 32] {
 130                 let ctr = self.counter.fetch_add(1, Ordering::Relaxed);
 131                 [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
 132                         (ctr >> 8*7) as u8, (ctr >> 8*6) as u8, (ctr >> 8*5) as u8, (ctr >> 8*4) as u8, (ctr >> 8*3) as u8, (ctr >> 8*2) as u8, (ctr >> 8*1) as u8, 14, (ctr >> 8*0) as u8]
 133         }
 134 }
 135
 136 impl NodeSigner for KeyProvider {
 137         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
 138                 let node_secret = match recipient {
 139                         Recipient::Node => Ok(&self.node_secret),
 140                         Recipient::PhantomNode => Err(())
 141                 }?;
 142                 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
 143         }
 144
 145         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
 146                 let mut node_secret = match recipient {
 147                         Recipient::Node => Ok(self.node_secret.clone()),
 148                         Recipient::PhantomNode => Err(())
 149                 }?;
 150                 if let Some(tweak) = tweak {
 151                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
 152                 }
 153                 Ok(SharedSecret::new(other_key, &node_secret))
 154         }
 155
 156         fn get_inbound_payment_key_material(&self) -> KeyMaterial { unreachable!() }
 157
 158         fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
 159                 unreachable!()
 160         }
 161
 162         fn sign_bolt12_invoice_request(
 163                 &self, _invoice_request: &UnsignedInvoiceRequest
 164         ) -> Result<schnorr::Signature, ()> {
 165                 unreachable!()
 166         }
 167
 168         fn sign_bolt12_invoice(
 169                 &self, _invoice: &UnsignedBolt12Invoice,
 170         ) -> Result<schnorr::Signature, ()> {
 171                 unreachable!()
 172         }
 173
 174         fn sign_gossip_message(&self, _msg: lightning::ln::msgs::UnsignedGossipMessage) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
 175                 unreachable!()
 176         }
 177 }
 178
 179 impl SignerProvider for KeyProvider {
 180         type Signer = TestChannelSigner;
 181
 182         fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!() }
 183
 184         fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::Signer {
 185                 unreachable!()
 186         }
 187
 188         fn read_chan_signer(&self, _data: &[u8]) -> Result<TestChannelSigner, DecodeError> { unreachable!() }
 189
 190         fn get_destination_script(&self) -> Result<Script, ()> { unreachable!() }
 191
 192         fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { unreachable!() }
 193 }
 194
 195 #[cfg(test)]
 196 mod tests {
 197         use lightning::util::logger::{Logger, Record};
 198         use std::collections::HashMap;
 199         use std::sync::Mutex;
 200
 201         struct TrackingLogger {
 202                 /// (module, message) -> count
 203                 pub lines: Mutex<HashMap<(String, String), usize>>,
 204         }
 205         impl Logger for TrackingLogger {
 206                 fn log(&self, record: &Record) {
 207                         *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 208                         println!("{:<5} [{} : {}, {}] {}", record.level.to_string(), record.module_path, record.file, record.line, record.args);
 209                 }
 210         }
 211
 212         #[test]
 213         fn test_no_onion_message_breakage() {
 214                 let two_unblinded_hops_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e0135043304210202020202020202020202020202020202020202020202020202020202020202026d000000000000000000000000000000eb0000000000000000000000000000000000000000000000000000000000000036041096000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004800000000000000000000000000000000000000000000000000000000000000";
 215                 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
 216                 super::do_test(&::hex::decode(two_unblinded_hops_om).unwrap(), &logger);
 217                 {
 218                         let log_entries = logger.lines.lock().unwrap();
 219                         assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020202020202020202020202020202020202020202020202020202020202020202".to_string())), Some(&1));
 220                 }
 221
 222                 let two_unblinded_two_blinded_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e0135043304210202020202020202020202020202020202020202020202020202020202020202026d0000000000000000000000000000009e0000000000000000000000000000000000000000000000000000000000000058045604210203030303030303030303030303030303030303030303030303030303030303020821020000000000000000000000000000000000000000000000000000000000000e0196000000000000000000000000000000e9000000000000000000000000000000000000000000000000000000000000003504330421020404040404040404040404040404040404040404040404040404040404040402ca00000000000000000000000000000042000000000000000000000000000000000000000000000000000000000000003604103f000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004800000000000000000000000000000000000000000000000000000000000000";
 223                 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
 224                 super::do_test(&::hex::decode(two_unblinded_two_blinded_om).unwrap(), &logger);
 225                 {
 226                         let log_entries = logger.lines.lock().unwrap();
 227                         assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020202020202020202020202020202020202020202020202020202020202020202".to_string())), Some(&1));
 228                 }
 229
 230                 let three_blinded_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e0135043304210202020202020202020202020202020202020202020202020202020202020202026d000000000000000000000000000000b20000000000000000000000000000000000000000000000000000000000000035043304210203030303030303030303030303030303030303030303030303030303030303029600000000000000000000000000000033000000000000000000000000000000000000000000000000000000000000003604104e000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004800000000000000000000000000000000000000000000000000000000000000";
 231                 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
 232                 super::do_test(&::hex::decode(three_blinded_om).unwrap(), &logger);
 233                 {
 234                         let log_entries = logger.lines.lock().unwrap();
 235                         assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020202020202020202020202020202020202020202020202020202020202020202".to_string())), Some(&1));
 236                 }
 237         }
 238 }