1 // Imports that need to be added manually
2 use bitcoin::bech32::u5;
3 use bitcoin::blockdata::script::ScriptBuf;
4 use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, self};
5 use bitcoin::secp256k1::ecdh::SharedSecret;
6 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
7 use bitcoin::secp256k1::schnorr;
9 use lightning::blinded_path::{BlindedPath, EmptyNodeIdLookUp};
10 use lightning::ln::features::InitFeatures;
11 use lightning::ln::msgs::{self, DecodeError, OnionMessageHandler};
12 use lightning::ln::script::ShutdownScript;
13 use lightning::offers::invoice::UnsignedBolt12Invoice;
14 use lightning::offers::invoice_request::UnsignedInvoiceRequest;
15 use lightning::sign::{Recipient, KeyMaterial, EntropySource, NodeSigner, SignerProvider};
16 use lightning::util::test_channel_signer::TestChannelSigner;
17 use lightning::util::logger::Logger;
18 use lightning::util::ser::{Readable, Writeable, Writer};
19 use lightning::onion_message::messenger::{CustomOnionMessageHandler, Destination, MessageRouter, OnionMessagePath, OnionMessenger, PendingOnionMessage};
20 use lightning::onion_message::offers::{OffersMessage, OffersMessageHandler};
21 use lightning::onion_message::packet::OnionMessageContents;
23 use crate::utils::test_logger;
25 use std::io::{self, Cursor};
26 use std::sync::atomic::{AtomicU64, Ordering};
29 /// Actual fuzz test, method signature and name are fixed
30 pub fn do_test<L: Logger>(data: &[u8], logger: &L) {
31 if let Ok(msg) = <msgs::OnionMessage as Readable>::read(&mut Cursor::new(data)) {
32 let mut secret_bytes = [1; 32];
34 let secret = SecretKey::from_slice(&secret_bytes).unwrap();
35 let keys_manager = KeyProvider {
37 counter: AtomicU64::new(0),
39 let node_id_lookup = EmptyNodeIdLookUp {};
40 let message_router = TestMessageRouter {};
41 let offers_msg_handler = TestOffersMessageHandler {};
42 let custom_msg_handler = TestCustomMessageHandler {};
43 let onion_messenger = OnionMessenger::new(
44 &keys_manager, &keys_manager, logger, &node_id_lookup, &message_router,
45 &offers_msg_handler, &custom_msg_handler
49 let mut secret_bytes = [0; 32];
51 let secret = SecretKey::from_slice(&secret_bytes).unwrap();
52 PublicKey::from_secret_key(&Secp256k1::signing_only(), &secret)
55 let mut features = InitFeatures::empty();
56 features.set_onion_messages_optional();
57 let init = msgs::Init { features, networks: None, remote_network_address: None };
59 onion_messenger.peer_connected(&peer_node_id, &init, false).unwrap();
60 onion_messenger.handle_onion_message(&peer_node_id, &msg);
64 /// Method that needs to be added manually, {name}_test
65 pub fn onion_message_test<Out: test_logger::Output>(data: &[u8], out: Out) {
66 let logger = test_logger::TestLogger::new("".to_owned(), out);
67 do_test(data, &logger);
70 /// Method that needs to be added manually, {name}_run
72 pub extern "C" fn onion_message_run(data: *const u8, datalen: usize) {
73 let logger = test_logger::TestLogger::new("".to_owned(), test_logger::DevNull {});
74 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, &logger);
77 struct TestMessageRouter {}
79 impl MessageRouter for TestMessageRouter {
81 &self, _sender: PublicKey, _peers: Vec<PublicKey>, destination: Destination
82 ) -> Result<OnionMessagePath, ()> {
84 intermediate_nodes: vec![],
86 first_node_addresses: None,
90 fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
91 &self, _recipient: PublicKey, _peers: Vec<PublicKey>, _secp_ctx: &Secp256k1<T>,
92 ) -> Result<Vec<BlindedPath>, ()> {
97 struct TestOffersMessageHandler {}
99 impl OffersMessageHandler for TestOffersMessageHandler {
100 fn handle_message(&self, _message: OffersMessage) -> Option<OffersMessage> {
106 struct TestCustomMessage {}
108 const CUSTOM_MESSAGE_TYPE: u64 = 4242;
109 const CUSTOM_MESSAGE_CONTENTS: [u8; 32] = [42; 32];
111 impl OnionMessageContents for TestCustomMessage {
112 fn tlv_type(&self) -> u64 {
117 impl Writeable for TestCustomMessage {
118 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
119 Ok(CUSTOM_MESSAGE_CONTENTS.write(w)?)
123 struct TestCustomMessageHandler {}
125 impl CustomOnionMessageHandler for TestCustomMessageHandler {
126 type CustomMessage = TestCustomMessage;
127 fn handle_custom_message(&self, _msg: Self::CustomMessage) -> Option<Self::CustomMessage> {
128 Some(TestCustomMessage {})
130 fn read_custom_message<R: io::Read>(&self, _message_type: u64, buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
131 let mut buf = Vec::new();
132 buffer.read_to_end(&mut buf)?;
133 return Ok(Some(TestCustomMessage {}))
135 fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Self::CustomMessage>> {
140 pub struct VecWriter(pub Vec<u8>);
141 impl Writer for VecWriter {
142 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
143 self.0.extend_from_slice(buf);
148 node_secret: SecretKey,
152 impl EntropySource for KeyProvider {
153 fn get_secure_random_bytes(&self) -> [u8; 32] {
154 let ctr = self.counter.fetch_add(1, Ordering::Relaxed);
155 [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
156 (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]
160 impl NodeSigner for KeyProvider {
161 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
162 let node_secret = match recipient {
163 Recipient::Node => Ok(&self.node_secret),
164 Recipient::PhantomNode => Err(())
166 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
169 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
170 let mut node_secret = match recipient {
171 Recipient::Node => Ok(self.node_secret.clone()),
172 Recipient::PhantomNode => Err(())
174 if let Some(tweak) = tweak {
175 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
177 Ok(SharedSecret::new(other_key, &node_secret))
180 fn get_inbound_payment_key_material(&self) -> KeyMaterial { unreachable!() }
182 fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
186 fn sign_bolt12_invoice_request(
187 &self, _invoice_request: &UnsignedInvoiceRequest
188 ) -> Result<schnorr::Signature, ()> {
192 fn sign_bolt12_invoice(
193 &self, _invoice: &UnsignedBolt12Invoice,
194 ) -> Result<schnorr::Signature, ()> {
198 fn sign_gossip_message(&self, _msg: lightning::ln::msgs::UnsignedGossipMessage) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
203 impl SignerProvider for KeyProvider {
204 type EcdsaSigner = TestChannelSigner;
206 type TaprootSigner = TestChannelSigner;
208 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!() }
210 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner {
214 fn read_chan_signer(&self, _data: &[u8]) -> Result<TestChannelSigner, DecodeError> { unreachable!() }
216 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { unreachable!() }
218 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { unreachable!() }
223 use bitcoin::hashes::hex::FromHex;
224 use lightning::util::logger::{Logger, Record};
225 use std::collections::HashMap;
226 use std::sync::Mutex;
228 struct TrackingLogger {
229 /// (module, message) -> count
230 pub lines: Mutex<HashMap<(String, String), usize>>,
232 impl Logger for TrackingLogger {
233 fn log(&self, record: Record) {
234 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
235 println!("{:<5} [{} : {}, {}] {}", record.level.to_string(), record.module_path, record.file, record.line, record.args);
240 fn test_no_onion_message_breakage() {
242 020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000\
243 000000000000000000000000000000000000000000000000e01ae0276020000000000000000000000000000\
244 000000000000000000000000000000000002020000000000000000000000000000000000000000000000000\
245 000000000000e0101022a0000000000000000000000000000014551231950b75fc4402da1732fc9bebf0010\
246 9500000000000000000000000000000004106d000000000000000000000000000000fd1092202a2a2a2a2a2\
247 a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a0000000000000000000000000000000000\
248 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
249 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
250 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
251 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
252 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
253 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
254 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
255 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
256 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
257 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
258 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
259 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
260 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
261 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
262 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
263 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
264 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
265 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
266 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
267 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
268 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
269 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
270 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
271 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
272 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
273 000000000000000000000000000000000000000005600000000000000000000000000000000000000000000\
275 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
276 super::do_test(&<Vec<u8>>::from_hex(one_hop_om).unwrap(), &logger);
278 let log_entries = logger.lines.lock().unwrap();
279 assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(),
280 "Received an onion message with path_id None and a reply_path: Custom(TestCustomMessage)"
281 .to_string())), Some(&1));
282 assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(),
283 "Constructing onion message when responding to Custom onion message with path_id None: TestCustomMessage".to_string())), Some(&1));
284 assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(),
285 "Buffered onion message when responding to Custom onion message with path_id None".to_string())), Some(&1));
288 let two_unblinded_hops_om = "\
289 020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000\
290 000000000000000000000000000000000000000000000000e01350433042102020202020202020202020202\
291 02020202020202020202020202020202020202026d000000000000000000000000000000eb0000000000000\
292 000000000000000000000000000000000000000000000000036041096000000000000000000000000000000\
293 fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a000000000000000\
294 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
295 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
296 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
297 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
298 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
299 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
300 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
301 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
302 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
303 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
304 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
305 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
306 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
307 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
308 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
309 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
310 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
311 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
312 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
313 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
314 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
315 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
316 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
317 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
318 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
319 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
320 000000000000000000000000000000000000000004800000000000000000000000000000000000000000000\
322 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
323 super::do_test(&<Vec<u8>>::from_hex(two_unblinded_hops_om).unwrap(), &logger);
325 let log_entries = logger.lines.lock().unwrap();
326 assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020202020202020202020202020202020202020202020202020202020202020202".to_string())), Some(&1));
329 let two_unblinded_two_blinded_om = "\
330 020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000\
331 000000000000000000000000000000000000000000000000e01350433042102020202020202020202020202\
332 02020202020202020202020202020202020202026d0000000000000000000000000000009e0000000000000\
333 000000000000000000000000000000000000000000000000058045604210203030303030303030303030303\
334 030303030303030303030303030303030303020821020000000000000000000000000000000000000000000\
335 000000000000000000e0196000000000000000000000000000000e900000000000000000000000000000000\
336 000000000000000000000000000000350433042102040404040404040404040404040404040404040404040\
337 4040404040404040402ca000000000000000000000000000000420000000000000000000000000000000000\
338 00000000000000000000000000003604103f000000000000000000000000000000fd1092202a2a2a2a2a2a2\
339 a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a000000000000000000000000000000000000\
340 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
341 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
342 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
343 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
344 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
345 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
346 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
347 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
348 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
349 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
350 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
351 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
352 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
353 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
354 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
355 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
356 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
357 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
358 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
359 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
360 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
361 000000000000000000000000000000000000000004800000000000000000000000000000000000000000000\
363 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
364 super::do_test(&<Vec<u8>>::from_hex(two_unblinded_two_blinded_om).unwrap(), &logger);
366 let log_entries = logger.lines.lock().unwrap();
367 assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020202020202020202020202020202020202020202020202020202020202020202".to_string())), Some(&1));
370 let three_blinded_om = "\
371 020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000\
372 000000000000000000000000000000000000000000000000e01350433042102020202020202020202020202\
373 02020202020202020202020202020202020202026d000000000000000000000000000000b20000000000000\
374 000000000000000000000000000000000000000000000000035043304210203030303030303030303030303\
375 030303030303030303030303030303030303029600000000000000000000000000000033000000000000000\
376 000000000000000000000000000000000000000000000003604104e000000000000000000000000000000fd\
377 1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a00000000000000000\
378 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
379 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
380 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
381 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
382 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
383 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
384 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
385 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
386 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
387 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
388 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
389 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
390 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
391 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
392 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
393 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
394 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
395 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
396 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
397 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
398 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
399 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
400 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
401 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\
402 000000000000000000000000000000000000000004800000000000000000000000000000000000000000000\
404 let logger = TrackingLogger { lines: Mutex::new(HashMap::new()) };
405 super::do_test(&<Vec<u8>>::from_hex(three_blinded_om).unwrap(), &logger);
407 let log_entries = logger.lines.lock().unwrap();
408 assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(), "Forwarding an onion message to peer 020202020202020202020202020202020202020202020202020202020202020202".to_string())), Some(&1));