Skip to content

Commit 4739d22

Browse files
valentinewallacevalentinewallace
committed
f matt feedback
1 parent ded359c commit 4739d22

File tree

7 files changed

+234
-94
lines changed

7 files changed

+234
-94
lines changed

‎fuzz/src/onion_message.rs

+38-5
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ use lightning::ln::msgs::{self, DecodeError, OnionMessageHandler};
1010
use lightning::ln::script::ShutdownScript;
1111
use lightning::util::enforcing_trait_impls::EnforcingSigner;
1212
use lightning::util::logger::Logger;
13-
use lightning::util::ser::{Readable, Writer};
14-
use lightning::onion_message::OnionMessenger;
13+
use lightning::util::ser::{Readable, Writeable, Writer};
14+
use lightning::onion_message::{CustomOnionMessageHandler, CustomMessageReadable, OnionMessageContents, OnionMessenger};
1515

1616
use utils::test_logger;
1717

18-
use std::io::Cursor;
18+
use std::io::{self, Cursor};
1919
use std::sync::atomic::{AtomicU64, Ordering};
2020

2121
#[inline]
@@ -29,7 +29,8 @@ pub fn do_test<L: Logger>(data: &[u8], logger: &L) {
2929
node_secret: secret,
3030
counter: AtomicU64::new(0),
3131
};
32-
let onion_messenger = OnionMessenger::new(&keys_manager, logger);
32+
let custom_msg_handler = TestCustomMessageHandler {};
33+
let onion_messenger = OnionMessenger::new(&keys_manager, logger, &custom_msg_handler);
3334
let mut pk = [2; 33]; pk[1] = 0xff;
3435
let peer_node_id_not_used = PublicKey::from_slice(&pk).unwrap();
3536
onion_messenger.handle_onion_message(&peer_node_id_not_used, &msg);
@@ -49,6 +50,38 @@ pub extern "C" fn onion_message_run(data: *const u8, datalen: usize) {
4950
do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, &logger);
5051
}
5152

53+
struct TestCustomMessage {}
54+
55+
const CUSTOM_MESSAGE_TYPE: u64 = 4242;
56+
const CUSTOM_MESSAGE_CONTENTS: [u8; 32] = [42; 32];
57+
58+
impl OnionMessageContents 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+
impl CustomMessageReadable for TestCustomMessage {
71+
fn read<R: io::Read>(_message_type: u64, buffer: &mut R) -> Result<Option<Self>, DecodeError> where Self: Sized {
72+
let mut buf = Vec::new();
73+
buffer.read_to_end(&mut buf)?;
74+
return Ok(Some(TestCustomMessage {}))
75+
}
76+
}
77+
78+
struct TestCustomMessageHandler {}
79+
80+
impl CustomOnionMessageHandler for TestCustomMessageHandler {
81+
type CustomMessage = TestCustomMessage;
82+
fn handle_custom_message(&self, _msg: Self::CustomMessage) {}
83+
}
84+
5285
pub struct VecWriter(pub Vec<u8>);
5386
impl Writer for VecWriter {
5487
fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
@@ -123,7 +156,7 @@ mod tests {
123156
{
124157
let log_entries = logger.lines.lock().unwrap();
125158
assert_eq!(log_entries.get(&("lightning::onion_message::messenger".to_string(),
126-
"Received an onion message with path_id None and no reply_path: Tlv { tag: 4242, value: [42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42] }".to_string())), Some(&1));
159+
"Received an onion message with path_id None and no reply_path".to_string())), Some(&1));
127160
}
128161

129162
let two_unblinded_hops_om = "020000000000000000000000000000000000000000000000000000000000000e01055600020000000000000000000000000000000000000000000000000000000000000e0135043304210200000000000000000000000000000000000000000000000000000000000000029500000000000000000000000000000036000000000000000000000000000000000000000000000000000000000000003604104b000000000000000000000000000000fd1092202a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000b200000000000000000000000000000000000000000000000000000000000000";

‎lightning/src/ln/peer_handler.rs

+5-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ use util::ser::{VecWriter, Writeable, Writer};
2525
use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
2626
use ln::wire;
2727
use ln::wire::Encode;
28-
use onion_message::{SimpleArcOnionMessenger, SimpleRefOnionMessenger};
28+
use onion_message::{CustomOnionMessageHandler, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
2929
use routing::gossip::{NetworkGraph, P2PGossipSync};
3030
use util::atomic_counter::AtomicCounter;
3131
use util::crypto::sign;
@@ -95,6 +95,10 @@ impl OnionMessageHandler for IgnoringMessageHandler {
9595
InitFeatures::empty()
9696
}
9797
}
98+
impl CustomOnionMessageHandler for IgnoringMessageHandler {
99+
type CustomMessage = ();
100+
fn handle_custom_message(&self, _msg: Self::CustomMessage) {}
101+
}
98102
impl Deref for IgnoringMessageHandler {
99103
type Target = IgnoringMessageHandler;
100104
fn deref(&self) -> &Self { self }

‎lightning/src/onion_message/functional_tests.rs

+62-23
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,21 @@
1111
1212
use chain::keysinterface::{KeysInterface, Recipient};
1313
use ln::features::InitFeatures;
14-
use ln::msgs::{self, OnionMessageHandler};
15-
use super::{BlindedRoute, Destination, OnionMessenger, SendError, Tlv};
14+
use ln::msgs::{self, DecodeError, OnionMessageHandler};
15+
use super::{BlindedRoute, CustomOnionMessageHandler, CustomMessageReadable, Destination, Message, OnionMessageContents, OnionMessenger, SendError};
1616
use util::enforcing_trait_impls::EnforcingSigner;
17+
use util::ser::{Writeable, Writer};
1718
use util::test_utils;
1819

1920
use bitcoin::network::constants::Network;
2021
use bitcoin::secp256k1::{PublicKey, Secp256k1};
2122

23+
use io;
2224
use sync::Arc;
2325

2426
struct MessengerNode {
2527
keys_manager: Arc<test_utils::TestKeysInterface>,
26-
messenger: OnionMessenger<EnforcingSigner, Arc<test_utils::TestKeysInterface>, Arc<test_utils::TestLogger>>,
28+
messenger: OnionMessenger<EnforcingSigner, Arc<test_utils::TestKeysInterface>, Arc<test_utils::TestLogger>, Arc<TestCustomMessageHandler>>,
2729
logger: Arc<test_utils::TestLogger>,
2830
}
2931

@@ -34,6 +36,43 @@ impl MessengerNode {
3436
}
3537
}
3638

39+
#[derive(Clone)]
40+
struct TestCustomMessage {}
41+
42+
const CUSTOM_MESSAGE_TYPE: u64 = 4242;
43+
const CUSTOM_MESSAGE_CONTENTS: [u8; 32] = [42; 32];
44+
45+
impl OnionMessageContents for TestCustomMessage {
46+
fn tlv_type(&self) -> u64 {
47+
CUSTOM_MESSAGE_TYPE
48+
}
49+
}
50+
51+
impl Writeable for TestCustomMessage {
52+
fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
53+
Ok(CUSTOM_MESSAGE_CONTENTS.write(w)?)
54+
}
55+
}
56+
57+
impl CustomMessageReadable for TestCustomMessage {
58+
fn read<R: io::Read>(message_type: u64, buffer: &mut R) -> Result<Option<Self>, DecodeError> where Self: Sized {
59+
if message_type == CUSTOM_MESSAGE_TYPE {
60+
let mut buf = Vec::new();
61+
buffer.read_to_end(&mut buf)?;
62+
assert_eq!(buf, CUSTOM_MESSAGE_CONTENTS);
63+
return Ok(Some(TestCustomMessage {}))
64+
}
65+
Ok(None)
66+
}
67+
}
68+
69+
struct TestCustomMessageHandler {}
70+
71+
impl CustomOnionMessageHandler for TestCustomMessageHandler {
72+
type CustomMessage = TestCustomMessage;
73+
fn handle_custom_message(&self, _msg: Self::CustomMessage) {}
74+
}
75+
3776
fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
3877
let mut nodes = Vec::new();
3978
for i in 0..num_messengers {
@@ -42,7 +81,7 @@ fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
4281
let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet));
4382
nodes.push(MessengerNode {
4483
keys_manager: keys_manager.clone(),
45-
messenger: OnionMessenger::new(keys_manager, logger.clone()),
84+
messenger: OnionMessenger::new(keys_manager, logger.clone(), Arc::new(TestCustomMessageHandler{})),
4685
logger,
4786
});
4887
}
@@ -80,87 +119,87 @@ fn pass_along_path(path: &Vec<MessengerNode>, expected_path_id: Option<[u8; 32]>
80119
#[test]
81120
fn one_hop() {
82121
let nodes = create_nodes(2);
83-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
122+
let test_msg = Message::Custom(TestCustomMessage {});
84123

85-
nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_tlv, None).unwrap();
124+
nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_msg, None).unwrap();
86125
pass_along_path(&nodes, None);
87126
}
88127

89128
#[test]
90129
fn two_unblinded_hops() {
91130
let nodes = create_nodes(3);
92-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
131+
let test_msg = Message::Custom(TestCustomMessage {});
93132

94-
nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk()], Destination::Node(nodes[2].get_node_pk()), test_tlv, None).unwrap();
133+
nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk()], Destination::Node(nodes[2].get_node_pk()), test_msg, None).unwrap();
95134
pass_along_path(&nodes, None);
96135
}
97136

98137
#[test]
99138
fn two_unblinded_two_blinded() {
100139
let nodes = create_nodes(5);
101-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
140+
let test_msg = Message::Custom(TestCustomMessage {});
102141

103142
let secp_ctx = Secp256k1::new();
104143
let blinded_route = BlindedRoute::new(&[nodes[3].get_node_pk(), nodes[4].get_node_pk()], &*nodes[4].keys_manager, &secp_ctx).unwrap();
105144

106-
nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::BlindedRoute(blinded_route), test_tlv, None).unwrap();
145+
nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::BlindedRoute(blinded_route), test_msg, None).unwrap();
107146
pass_along_path(&nodes, None);
108147
}
109148

110149
#[test]
111150
fn three_blinded_hops() {
112151
let nodes = create_nodes(4);
113-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
152+
let test_msg = Message::Custom(TestCustomMessage {});
114153

115154
let secp_ctx = Secp256k1::new();
116155
let blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk(), nodes[3].get_node_pk()], &*nodes[3].keys_manager, &secp_ctx).unwrap();
117156

118-
nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), test_tlv, None).unwrap();
157+
nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), test_msg, None).unwrap();
119158
pass_along_path(&nodes, None);
120159
}
121160

122161
#[test]
123162
fn too_big_packet_error() {
124163
// Make sure we error as expected if a packet is too big to send.
125164
let nodes = create_nodes(2);
126-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
165+
let test_msg = Message::Custom(TestCustomMessage {});
127166

128167
let hop_node_id = nodes[1].get_node_pk();
129168
let hops = [hop_node_id; 400];
130-
let err = nodes[0].messenger.send_onion_message(&hops, Destination::Node(hop_node_id), test_tlv, None).unwrap_err();
169+
let err = nodes[0].messenger.send_onion_message(&hops, Destination::Node(hop_node_id), test_msg, None).unwrap_err();
131170
assert_eq!(err, SendError::TooBigPacket);
132171
}
133172

134173
#[test]
135174
fn invalid_blinded_route_error() {
136175
// Make sure we error as expected if a provided blinded route has 0 or 1 hops.
137176
let nodes = create_nodes(3);
138-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
177+
let test_msg = TestCustomMessage {};
139178

140179
// 0 hops
141180
let secp_ctx = Secp256k1::new();
142181
let mut blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], &*nodes[2].keys_manager, &secp_ctx).unwrap();
143182
blinded_route.blinded_hops.clear();
144-
let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), test_tlv.clone(), None).unwrap_err();
183+
let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), Message::Custom(test_msg.clone()), None).unwrap_err();
145184
assert_eq!(err, SendError::TooFewBlindedHops);
146185

147186
// 1 hop
148187
let mut blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], &*nodes[2].keys_manager, &secp_ctx).unwrap();
149188
blinded_route.blinded_hops.remove(0);
150189
assert_eq!(blinded_route.blinded_hops.len(), 1);
151-
let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), test_tlv, None).unwrap_err();
190+
let err = nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), Message::Custom(test_msg), None).unwrap_err();
152191
assert_eq!(err, SendError::TooFewBlindedHops);
153192
}
154193

155194
#[test]
156195
fn reply_path() {
157196
let nodes = create_nodes(4);
158-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
197+
let test_msg = TestCustomMessage {};
159198
let secp_ctx = Secp256k1::new();
160199

161200
// Destination::Node
162201
let reply_path = BlindedRoute::new(&[nodes[2].get_node_pk(), nodes[1].get_node_pk(), nodes[0].get_node_pk()], &*nodes[0].keys_manager, &secp_ctx).unwrap();
163-
nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::Node(nodes[3].get_node_pk()), test_tlv.clone(), Some(reply_path)).unwrap();
202+
nodes[0].messenger.send_onion_message(&[nodes[1].get_node_pk(), nodes[2].get_node_pk()], Destination::Node(nodes[3].get_node_pk()), Message::Custom(test_msg.clone()), Some(reply_path)).unwrap();
164203
pass_along_path(&nodes, None);
165204
// Make sure the last node successfully decoded the reply path.
166205
nodes[3].logger.assert_log_contains(
@@ -171,7 +210,7 @@ fn reply_path() {
171210
let blinded_route = BlindedRoute::new(&[nodes[1].get_node_pk(), nodes[2].get_node_pk(), nodes[3].get_node_pk()], &*nodes[3].keys_manager, &secp_ctx).unwrap();
172211
let reply_path = BlindedRoute::new(&[nodes[2].get_node_pk(), nodes[1].get_node_pk(), nodes[0].get_node_pk()], &*nodes[0].keys_manager, &secp_ctx).unwrap();
173212

174-
nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), test_tlv, Some(reply_path)).unwrap();
213+
nodes[0].messenger.send_onion_message(&[], Destination::BlindedRoute(blinded_route), Message::Custom(test_msg), Some(reply_path)).unwrap();
175214
pass_along_path(&nodes, None);
176215
nodes[3].logger.assert_log_contains(
177216
"lightning::onion_message::messenger".to_string(),
@@ -181,10 +220,10 @@ fn reply_path() {
181220
#[test]
182221
fn peer_buffer_full() {
183222
let nodes = create_nodes(2);
184-
let test_tlv = Tlv { tag: 4242, value: vec![42; 32] };
223+
let test_msg = TestCustomMessage {};
185224
for _ in 0..188 { // Based on MAX_PER_PEER_BUFFER_SIZE in OnionMessenger
186-
nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_tlv.clone(), None).unwrap();
225+
nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), Message::Custom(test_msg.clone()), None).unwrap();
187226
}
188-
let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), test_tlv, None).unwrap_err();
227+
let err = nodes[0].messenger.send_onion_message(&[], Destination::Node(nodes[1].get_node_pk()), Message::Custom(test_msg), None).unwrap_err();
189228
assert_eq!(err, SendError::BufferFull);
190229
}

0 commit comments

Comments
 (0)