]> git.bitcoin.ninja Git - rust-lightning/blob - fuzz/src/onion_message.rs
Persist scorer upon update based on event handling
[rust-lightning] / 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
8 use lightning::chain::keysinterface::{Recipient, KeyMaterial, EntropySource, NodeSigner, SignerProvider};
9 use lightning::ln::msgs::{self, DecodeError, OnionMessageHandler};
10 use lightning::ln::script::ShutdownScript;
11 use lightning::util::enforcing_trait_impls::EnforcingSigner;
12 use lightning::util::logger::Logger;
13 use lightning::util::ser::{Readable, Writeable, Writer};
14 use lightning::onion_message::{CustomOnionMessageContents, CustomOnionMessageHandler, OnionMessenger};
15
16 use crate::utils::test_logger;
17
18 use std::io::{self, Cursor};
19 use std::sync::atomic::{AtomicU64, Ordering};
20
21 #[inline]
22 /// Actual fuzz test, method signature and name are fixed
23 pub fn do_test<L: Logger>(data: &[u8], logger: &L) {
24         if let Ok(msg) = <msgs::OnionMessage as Readable>::read(&mut Cursor::new(data)) {
25                 let mut secret_bytes = [0; 32];
26                 secret_bytes[31] = 2;
27                 let secret = SecretKey::from_slice(&secret_bytes).unwrap();
28                 let keys_manager = KeyProvider {
29                         node_secret: secret,
30                         counter: AtomicU64::new(0),
31                 };
32                 let custom_msg_handler = TestCustomMessageHandler {};
33                 let onion_messenger = OnionMessenger::new(&keys_manager, &keys_manager, logger, &custom_msg_handler);
34                 let mut pk = [2; 33]; pk[1] = 0xff;
35                 let peer_node_id_not_used = PublicKey::from_slice(&pk).unwrap();
36                 onion_messenger.handle_onion_message(&peer_node_id_not_used, &msg);
37         }
38 }
39
40 /// Method that needs to be added manually, {name}_test
41 pub fn onion_message_test<Out: test_logger::Output>(data: &[u8], out: Out) {
42         let logger = test_logger::TestLogger::new("".to_owned(), out);
43         do_test(data, &logger);
44 }
45
46 /// Method that needs to be added manually, {name}_run
47 #[no_mangle]
48 pub extern "C" fn onion_message_run(data: *const u8, datalen: usize) {
49         let logger = test_logger::TestLogger::new("".to_owned(), test_logger::DevNull {});
50         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, &logger);
51 }
52
53 struct TestCustomMessage {}
54
55 const CUSTOM_MESSAGE_TYPE: u64 = 4242;
56 const CUSTOM_MESSAGE_CONTENTS: [u8; 32] = [42; 32];
57
58 impl CustomOnionMessageContents for TestCustomMessage {
59         fn tlv_type(&self) -> u64 {
60                 CUSTOM_MESSAGE_TYPE
61         }
62 }
63
64 impl Writeable for TestCustomMessage {
65         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
66                 Ok(CUSTOM_MESSAGE_CONTENTS.write(w)?)
67         }
68 }
69
70 struct TestCustomMessageHandler {}
71
72 impl CustomOnionMessageHandler for TestCustomMessageHandler {
73         type CustomMessage = TestCustomMessage;
74         fn handle_custom_message(&self, _msg: Self::CustomMessage) {}
75         fn read_custom_message<R: io::Read>(&self, _message_type: u64, buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
76                 let mut buf = Vec::new();
77                 buffer.read_to_end(&mut buf)?;
78                 return Ok(Some(TestCustomMessage {}))
79         }
80 }
81
82 pub struct VecWriter(pub Vec<u8>);
83 impl Writer for VecWriter {
84         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
85                 self.0.extend_from_slice(buf);
86                 Ok(())
87         }
88 }
89 struct KeyProvider {
90         node_secret: SecretKey,
91         counter: AtomicU64,
92 }
93
94 impl EntropySource for KeyProvider {
95         fn get_secure_random_bytes(&self) -> [u8; 32] {
96                 let ctr = self.counter.fetch_add(1, Ordering::Relaxed);
97                 [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
98                         (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]
99         }
100 }
101
102 impl NodeSigner for KeyProvider {
103         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
104                 let node_secret = match recipient {
105                         Recipient::Node => Ok(&self.node_secret),
106                         Recipient::PhantomNode => Err(())
107                 }?;
108                 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
109         }
110
111         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
112                 let mut node_secret = match recipient {
113                         Recipient::Node => Ok(self.node_secret.clone()),
114                         Recipient::PhantomNode => Err(())
115                 }?;
116                 if let Some(tweak) = tweak {
117                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
118                 }
119                 Ok(SharedSecret::new(other_key, &node_secret))
120         }
121
122         fn get_inbound_payment_key_material(&self) -> KeyMaterial { unreachable!() }
123
124         fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
125                 unreachable!()
126         }
127
128         fn sign_gossip_message(&self, _msg: lightning::ln::msgs::UnsignedGossipMessage) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
129                 unreachable!()
130         }
131 }
132
133 impl SignerProvider for KeyProvider {
134         type Signer = EnforcingSigner;
135
136         fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!() }
137
138         fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::Signer {
139                 unreachable!()
140         }
141
142         fn read_chan_signer(&self, _data: &[u8]) -> Result<EnforcingSigner, DecodeError> { unreachable!() }
143
144         fn get_destination_script(&self) -> Script { unreachable!() }
145
146         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!() }
147 }
148
149 #[cfg(test)]
150 mod tests {
151         use lightning::util::logger::{Logger, Record};
152         use std::collections::HashMap;
153         use std::sync::Mutex;
154
155         struct TrackingLogger {
156                 /// (module, message) -> count
157                 pub lines: Mutex<HashMap<(String, String), usize>>,
158         }
159         impl Logger for TrackingLogger {
160                 fn log(&self, record: &Record) {
161                         *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
162                         println!("{:<5} [{} : {}, {}] {}", record.level.to_string(), record.module_path, record.file, record.line, record.args);
163                 }
164         }
165
166         #[test]
167         fn test_no_onion_message_breakage() {
168                 let one_hop_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e0136041095000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000e800000000000000000000000000000000000000000000000000000000000000";
169                 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
170                 super::do_test(&::hex::decode(one_hop_om).unwrap(), &logger);
171                 {
172                         let log_entries = logger.lines.lock().unwrap();
173                         assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(),
174                                                 "Received an onion message with path_id None and no reply_path".to_string())), Some(&1));
175                 }
176
177                 let two_unblinded_hops_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e0135043304210200000000000000000000000000000000000000000000000000000000000000029500000000000000000000000000000036000000000000000000000000000000000000000000000000000000000000003604104b000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000b200000000000000000000000000000000000000000000000000000000000000";
178                 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
179                 super::do_test(&::hex::decode(two_unblinded_hops_om).unwrap(), &logger);
180                 {
181                         let log_entries = logger.lines.lock().unwrap();
182                         assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020000000000000000000000000000000000000000000000000000000000000002".to_string())), Some(&1));
183                 }
184
185                 let two_unblinded_two_blinded_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e01350433042102000000000000000000000000000000000000000000000000000000000000000295000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000058045604210200000000000000000000000000000000000000000000000000000000000000020821020000000000000000000000000000000000000000000000000000000000000e014b000000000000000000000000000000b20000000000000000000000000000000000000000000000000000000000000035043304210200000000000000000000000000000000000000000000000000000000000000029500000000000000000000000000000036000000000000000000000000000000000000000000000000000000000000003604104b000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000b200000000000000000000000000000000000000000000000000000000000000";
186                 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
187                 super::do_test(&::hex::decode(two_unblinded_two_blinded_om).unwrap(), &logger);
188                 {
189                         let log_entries = logger.lines.lock().unwrap();
190                         assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020000000000000000000000000000000000000000000000000000000000000002".to_string())), Some(&1));
191                 }
192
193                 let three_blinded_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e013504330421020000000000000000000000000000000000000000000000000000000000000002950000000000000000000000000000006c0000000000000000000000000000000000000000000000000000000000000035043304210200000000000000000000000000000000000000000000000000000000000000024b000000000000000000000000000000ac00000000000000000000000000000000000000000000000000000000000000360410d1000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000b200000000000000000000000000000000000000000000000000000000000000";
194                 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
195                 super::do_test(&::hex::decode(three_blinded_om).unwrap(), &logger);
196                 {
197                         let log_entries = logger.lines.lock().unwrap();
198                         assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020000000000000000000000000000000000000000000000000000000000000002".to_string())), Some(&1));
199                 }
200         }
201 }