1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Top level peer message handling and socket handling logic lives here.
12 //! Instead of actually servicing sockets ourselves we require that you implement the
13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
15 //! call into the provided message handlers (probably a ChannelManager and NetGraphmsgHandler) with messages
16 //! they should handle, and encoding/sending response messages.
18 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
20 use ln::features::InitFeatures;
22 use ln::msgs::{ChannelMessageHandler, LightningError, RoutingMessageHandler};
23 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
24 use util::ser::{VecWriter, Writeable};
25 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
29 use util::events::{MessageSendEvent, MessageSendEventsProvider};
30 use util::logger::Logger;
31 use routing::network_graph::NetGraphMsgHandler;
34 use alloc::collections::LinkedList;
35 use alloc::fmt::Debug;
36 use std::sync::{Arc, Mutex};
37 use core::sync::atomic::{AtomicUsize, Ordering};
38 use core::{cmp, hash, fmt, mem};
42 use bitcoin::hashes::sha256::Hash as Sha256;
43 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
44 use bitcoin::hashes::{HashEngine, Hash};
46 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
47 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
48 pub struct IgnoringMessageHandler{}
49 impl MessageSendEventsProvider for IgnoringMessageHandler {
50 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
52 impl RoutingMessageHandler for IgnoringMessageHandler {
53 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
54 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
55 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
56 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
57 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
58 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
59 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
60 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
61 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
62 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
63 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
64 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
66 impl Deref for IgnoringMessageHandler {
67 type Target = IgnoringMessageHandler;
68 fn deref(&self) -> &Self { self }
71 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
72 /// You can provide one of these as the route_handler in a MessageHandler.
73 pub struct ErroringMessageHandler {
74 message_queue: Mutex<Vec<MessageSendEvent>>
76 impl ErroringMessageHandler {
77 /// Constructs a new ErroringMessageHandler
78 pub fn new() -> Self {
79 Self { message_queue: Mutex::new(Vec::new()) }
81 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
82 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
83 action: msgs::ErrorAction::SendErrorMessage {
84 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
86 node_id: node_id.clone(),
90 impl MessageSendEventsProvider for ErroringMessageHandler {
91 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
92 let mut res = Vec::new();
93 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
97 impl ChannelMessageHandler for ErroringMessageHandler {
98 // Any messages which are related to a specific channel generate an error message to let the
99 // peer know we don't care about channels.
100 fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
101 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
103 fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
104 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
106 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
107 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
109 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
110 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
112 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
113 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
115 fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
116 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
118 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
119 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
121 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
122 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
124 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
125 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
127 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
128 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
130 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
131 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
133 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
134 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
136 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
137 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
139 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
140 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
142 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
143 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
145 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
146 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
148 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
149 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
150 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
151 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
152 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
154 impl Deref for ErroringMessageHandler {
155 type Target = ErroringMessageHandler;
156 fn deref(&self) -> &Self { self }
159 /// Provides references to trait impls which handle different types of messages.
160 pub struct MessageHandler<CM: Deref, RM: Deref> where
161 CM::Target: ChannelMessageHandler,
162 RM::Target: RoutingMessageHandler {
163 /// A message handler which handles messages specific to channels. Usually this is just a
164 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
166 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
167 pub chan_handler: CM,
168 /// A message handler which handles messages updating our knowledge of the network channel
169 /// graph. Usually this is just a [`NetGraphMsgHandler`] object or an
170 /// [`IgnoringMessageHandler`].
172 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
173 pub route_handler: RM,
176 /// Provides an object which can be used to send data to and which uniquely identifies a connection
177 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
178 /// implement Hash to meet the PeerManager API.
180 /// For efficiency, Clone should be relatively cheap for this type.
182 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
183 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
184 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
185 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
186 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
187 /// to simply use another value which is guaranteed to be globally unique instead.
188 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
189 /// Attempts to send some data from the given slice to the peer.
191 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
192 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
193 /// called and further write attempts may occur until that time.
195 /// If the returned size is smaller than `data.len()`, a
196 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
197 /// written. Additionally, until a `send_data` event completes fully, no further
198 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
199 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
202 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
203 /// (indicating that read events should be paused to prevent DoS in the send buffer),
204 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
205 /// `resume_read` of false carries no meaning, and should not cause any action.
206 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
207 /// Disconnect the socket pointed to by this SocketDescriptor.
209 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
210 /// call (doing so is a noop).
211 fn disconnect_socket(&mut self);
214 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
215 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
218 pub struct PeerHandleError {
219 /// Used to indicate that we probably can't make any future connections to this peer, implying
220 /// we should go ahead and force-close any channels we have with it.
221 pub no_connection_possible: bool,
223 impl fmt::Debug for PeerHandleError {
224 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
225 formatter.write_str("Peer Sent Invalid Data")
228 impl fmt::Display for PeerHandleError {
229 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
230 formatter.write_str("Peer Sent Invalid Data")
233 impl error::Error for PeerHandleError {
234 fn description(&self) -> &str {
235 "Peer Sent Invalid Data"
239 enum InitSyncTracker{
241 ChannelsSyncing(u64),
242 NodesSyncing(PublicKey),
245 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
246 /// we have fewer than this many messages in the outbound buffer again.
247 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
248 /// refilled as we send bytes.
249 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 10;
250 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
252 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = 20;
255 channel_encryptor: PeerChannelEncryptor,
256 their_node_id: Option<PublicKey>,
257 their_features: Option<InitFeatures>,
259 pending_outbound_buffer: LinkedList<Vec<u8>>,
260 pending_outbound_buffer_first_msg_offset: usize,
261 awaiting_write_event: bool,
263 pending_read_buffer: Vec<u8>,
264 pending_read_buffer_pos: usize,
265 pending_read_is_header: bool,
267 sync_status: InitSyncTracker,
273 /// Returns true if the channel announcements/updates for the given channel should be
274 /// forwarded to this peer.
275 /// If we are sending our routing table to this peer and we have not yet sent channel
276 /// announcements/updates for the given channel_id then we will send it when we get to that
277 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
278 /// sent the old versions, we should send the update, and so return true here.
279 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
280 match self.sync_status {
281 InitSyncTracker::NoSyncRequested => true,
282 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
283 InitSyncTracker::NodesSyncing(_) => true,
287 /// Similar to the above, but for node announcements indexed by node_id.
288 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
289 match self.sync_status {
290 InitSyncTracker::NoSyncRequested => true,
291 InitSyncTracker::ChannelsSyncing(_) => false,
292 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
297 struct PeerHolder<Descriptor: SocketDescriptor> {
298 peers: HashMap<Descriptor, Peer>,
299 /// Only add to this set when noise completes:
300 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
303 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
304 fn _check_usize_is_32_or_64() {
305 // See below, less than 32 bit pointers may be unsafe here!
306 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
309 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
310 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
311 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
312 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
313 /// issues such as overly long function definitions.
314 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<SD, Arc<SimpleArcChannelManager<M, T, F, L>>, Arc<NetGraphMsgHandler<Arc<C>, Arc<L>>>, Arc<L>>;
316 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
317 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
318 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
319 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
320 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
321 /// helps with issues such as long function definitions.
322 pub type SimpleRefPeerManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, SD, M, T, F, C, L> = PeerManager<SD, SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L>, &'e NetGraphMsgHandler<&'g C, &'f L>, &'f L>;
324 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
325 /// socket events into messages which it passes on to its [`MessageHandler`].
327 /// Locks are taken internally, so you must never assume that reentrancy from a
328 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
330 /// Calls to [`read_event`] will decode relevant messages and pass them to the
331 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
332 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
333 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
334 /// calls only after previous ones have returned.
336 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
337 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
338 /// essentially you should default to using a SimpleRefPeerManager, and use a
339 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
340 /// you're using lightning-net-tokio.
342 /// [`read_event`]: PeerManager::read_event
343 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
344 CM::Target: ChannelMessageHandler,
345 RM::Target: RoutingMessageHandler,
347 message_handler: MessageHandler<CM, RM>,
348 peers: Mutex<PeerHolder<Descriptor>>,
349 our_node_secret: SecretKey,
350 ephemeral_key_midstate: Sha256Engine,
352 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
353 // bits we will never realistically count into high:
354 peer_counter_low: AtomicUsize,
355 peer_counter_high: AtomicUsize,
360 enum MessageHandlingError {
361 PeerHandleError(PeerHandleError),
362 LightningError(LightningError),
365 impl From<PeerHandleError> for MessageHandlingError {
366 fn from(error: PeerHandleError) -> Self {
367 MessageHandlingError::PeerHandleError(error)
371 impl From<LightningError> for MessageHandlingError {
372 fn from(error: LightningError) -> Self {
373 MessageHandlingError::LightningError(error)
377 macro_rules! encode_msg {
379 let mut buffer = VecWriter(Vec::new());
380 wire::write($msg, &mut buffer).unwrap();
385 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L> where
386 CM::Target: ChannelMessageHandler,
388 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
389 /// handler is used and network graph messages are ignored.
391 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
392 /// cryptographically secure random bytes.
394 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
395 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
396 Self::new(MessageHandler {
397 chan_handler: channel_message_handler,
398 route_handler: IgnoringMessageHandler{},
399 }, our_node_secret, ephemeral_random_data, logger)
403 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L> where
404 RM::Target: RoutingMessageHandler,
406 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
407 /// handler is used and messages related to channels will be ignored (or generate error
408 /// messages). Note that some other lightning implementations time-out connections after some
409 /// time if no channel is built with the peer.
411 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
412 /// cryptographically secure random bytes.
414 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
415 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
416 Self::new(MessageHandler {
417 chan_handler: ErroringMessageHandler::new(),
418 route_handler: routing_message_handler,
419 }, our_node_secret, ephemeral_random_data, logger)
423 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
424 CM::Target: ChannelMessageHandler,
425 RM::Target: RoutingMessageHandler,
427 /// Constructs a new PeerManager with the given message handlers and node_id secret key
428 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
429 /// cryptographically secure random bytes.
430 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
431 let mut ephemeral_key_midstate = Sha256::engine();
432 ephemeral_key_midstate.input(ephemeral_random_data);
436 peers: Mutex::new(PeerHolder {
437 peers: HashMap::new(),
438 node_id_to_descriptor: HashMap::new()
441 ephemeral_key_midstate,
442 peer_counter_low: AtomicUsize::new(0),
443 peer_counter_high: AtomicUsize::new(0),
448 /// Get the list of node ids for peers which have completed the initial handshake.
450 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
451 /// new_outbound_connection, however entries will only appear once the initial handshake has
452 /// completed and we are sure the remote peer has the private key for the given node_id.
453 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
454 let peers = self.peers.lock().unwrap();
455 peers.peers.values().filter_map(|p| {
456 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
463 fn get_ephemeral_key(&self) -> SecretKey {
464 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
465 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
466 let high = if low == 0 {
467 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
469 self.peer_counter_high.load(Ordering::Acquire)
471 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
472 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
473 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
476 /// Indicates a new outbound connection has been established to a node with the given node_id.
477 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
478 /// descriptor but must disconnect the connection immediately.
480 /// Returns a small number of bytes to send to the remote node (currently always 50).
482 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
483 /// [`socket_disconnected()`].
485 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
486 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
487 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
488 let res = peer_encryptor.get_act_one().to_vec();
489 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
491 let mut peers = self.peers.lock().unwrap();
492 if peers.peers.insert(descriptor, Peer {
493 channel_encryptor: peer_encryptor,
495 their_features: None,
497 pending_outbound_buffer: LinkedList::new(),
498 pending_outbound_buffer_first_msg_offset: 0,
499 awaiting_write_event: false,
502 pending_read_buffer_pos: 0,
503 pending_read_is_header: false,
505 sync_status: InitSyncTracker::NoSyncRequested,
507 awaiting_pong: false,
509 panic!("PeerManager driver duplicated descriptors!");
514 /// Indicates a new inbound connection has been established.
516 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
517 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
518 /// call socket_disconnected for the new descriptor but must disconnect the connection
521 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
522 /// [`socket_disconnected()`].
524 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
525 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
526 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
527 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
529 let mut peers = self.peers.lock().unwrap();
530 if peers.peers.insert(descriptor, Peer {
531 channel_encryptor: peer_encryptor,
533 their_features: None,
535 pending_outbound_buffer: LinkedList::new(),
536 pending_outbound_buffer_first_msg_offset: 0,
537 awaiting_write_event: false,
540 pending_read_buffer_pos: 0,
541 pending_read_is_header: false,
543 sync_status: InitSyncTracker::NoSyncRequested,
545 awaiting_pong: false,
547 panic!("PeerManager driver duplicated descriptors!");
552 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
553 while !peer.awaiting_write_event {
554 if peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE {
555 match peer.sync_status {
556 InitSyncTracker::NoSyncRequested => {},
557 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
558 let steps = ((OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
559 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
560 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
561 self.enqueue_message(peer, announce);
562 if let &Some(ref update_a) = update_a_option {
563 self.enqueue_message(peer, update_a);
565 if let &Some(ref update_b) = update_b_option {
566 self.enqueue_message(peer, update_b);
568 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
570 if all_messages.is_empty() || all_messages.len() != steps as usize {
571 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
574 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
575 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
576 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
577 for msg in all_messages.iter() {
578 self.enqueue_message(peer, msg);
579 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
581 if all_messages.is_empty() || all_messages.len() != steps as usize {
582 peer.sync_status = InitSyncTracker::NoSyncRequested;
585 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
586 InitSyncTracker::NodesSyncing(key) => {
587 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
588 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
589 for msg in all_messages.iter() {
590 self.enqueue_message(peer, msg);
591 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
593 if all_messages.is_empty() || all_messages.len() != steps as usize {
594 peer.sync_status = InitSyncTracker::NoSyncRequested;
601 let next_buff = match peer.pending_outbound_buffer.front() {
606 let should_be_reading = peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
607 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
608 let data_sent = descriptor.send_data(pending, should_be_reading);
609 peer.pending_outbound_buffer_first_msg_offset += data_sent;
610 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
612 peer.pending_outbound_buffer_first_msg_offset = 0;
613 peer.pending_outbound_buffer.pop_front();
615 peer.awaiting_write_event = true;
620 /// Indicates that there is room to write data to the given socket descriptor.
622 /// May return an Err to indicate that the connection should be closed.
624 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
625 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
626 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
627 /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
630 /// [`send_data`]: SocketDescriptor::send_data
631 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
632 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
633 let mut peers = self.peers.lock().unwrap();
634 match peers.peers.get_mut(descriptor) {
636 // This is most likely a simple race condition where the user found that the socket
637 // was writeable, then we told the user to `disconnect_socket()`, then they called
638 // this method. Return an error to make sure we get disconnected.
639 return Err(PeerHandleError { no_connection_possible: false });
642 peer.awaiting_write_event = false;
643 self.do_attempt_write_data(descriptor, peer);
649 /// Indicates that data was read from the given socket descriptor.
651 /// May return an Err to indicate that the connection should be closed.
653 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
654 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
655 /// [`send_data`] calls to handle responses.
657 /// If `Ok(true)` is returned, further read_events should not be triggered until a
658 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
661 /// [`send_data`]: SocketDescriptor::send_data
662 /// [`process_events`]: PeerManager::process_events
663 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
664 match self.do_read_event(peer_descriptor, data) {
667 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
673 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
674 fn enqueue_message<M: Encode + Writeable + Debug>(&self, peer: &mut Peer, message: &M) {
675 let mut buffer = VecWriter(Vec::new());
676 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
677 let encoded_message = buffer.0;
679 log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()));
680 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
683 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
685 let mut peers_lock = self.peers.lock().unwrap();
686 let peers = &mut *peers_lock;
687 let mut msgs_to_forward = Vec::new();
688 let mut peer_node_id = None;
689 let pause_read = match peers.peers.get_mut(peer_descriptor) {
691 // This is most likely a simple race condition where the user read some bytes
692 // from the socket, then we told the user to `disconnect_socket()`, then they
693 // called this method. Return an error to make sure we get disconnected.
694 return Err(PeerHandleError { no_connection_possible: false });
697 assert!(peer.pending_read_buffer.len() > 0);
698 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
700 let mut read_pos = 0;
701 while read_pos < data.len() {
703 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
704 peer.pending_read_buffer[peer.pending_read_buffer_pos..peer.pending_read_buffer_pos + data_to_copy].copy_from_slice(&data[read_pos..read_pos + data_to_copy]);
705 read_pos += data_to_copy;
706 peer.pending_read_buffer_pos += data_to_copy;
709 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
710 peer.pending_read_buffer_pos = 0;
712 macro_rules! try_potential_handleerror {
718 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
719 //TODO: Try to push msg
720 log_debug!(self.logger, "Error handling message; disconnecting peer with: {}", e.err);
721 return Err(PeerHandleError{ no_connection_possible: false });
723 msgs::ErrorAction::IgnoreAndLog(level) => {
724 log_given_level!(self.logger, level, "Error handling message; ignoring: {}", e.err);
727 msgs::ErrorAction::IgnoreError => {
728 log_debug!(self.logger, "Error handling message; ignoring: {}", e.err);
731 msgs::ErrorAction::SendErrorMessage { msg } => {
732 log_debug!(self.logger, "Error handling message; sending error message with: {}", e.err);
733 self.enqueue_message(peer, &msg);
742 macro_rules! insert_node_id {
744 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
745 hash_map::Entry::Occupied(_) => {
746 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
747 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
748 return Err(PeerHandleError{ no_connection_possible: false })
750 hash_map::Entry::Vacant(entry) => {
751 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
752 entry.insert(peer_descriptor.clone())
758 let next_step = peer.channel_encryptor.get_noise_step();
760 NextNoiseStep::ActOne => {
761 let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_keys(&peer.pending_read_buffer[..], &self.our_node_secret, self.get_ephemeral_key())).to_vec();
762 peer.pending_outbound_buffer.push_back(act_two);
763 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
765 NextNoiseStep::ActTwo => {
766 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
767 peer.pending_outbound_buffer.push_back(act_three.to_vec());
768 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
769 peer.pending_read_is_header = true;
771 peer.their_node_id = Some(their_node_id);
773 let features = InitFeatures::known();
774 let resp = msgs::Init { features };
775 self.enqueue_message(peer, &resp);
777 NextNoiseStep::ActThree => {
778 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
779 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
780 peer.pending_read_is_header = true;
781 peer.their_node_id = Some(their_node_id);
783 let features = InitFeatures::known();
784 let resp = msgs::Init { features };
785 self.enqueue_message(peer, &resp);
787 NextNoiseStep::NoiseComplete => {
788 if peer.pending_read_is_header {
789 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
790 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
791 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
792 if msg_len < 2 { // Need at least the message type tag
793 return Err(PeerHandleError{ no_connection_possible: false });
795 peer.pending_read_is_header = false;
797 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
798 assert!(msg_data.len() >= 2);
801 peer.pending_read_buffer = [0; 18].to_vec();
802 peer.pending_read_is_header = true;
804 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
805 let message_result = wire::read(&mut reader);
806 let message = match message_result {
810 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
811 msgs::DecodeError::UnknownRequiredFeature => {
812 log_trace!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
815 msgs::DecodeError::InvalidValue => {
816 log_debug!(self.logger, "Got an invalid value while deserializing message");
817 return Err(PeerHandleError { no_connection_possible: false });
819 msgs::DecodeError::ShortRead => {
820 log_debug!(self.logger, "Deserialization failed due to shortness of message");
821 return Err(PeerHandleError { no_connection_possible: false });
823 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
824 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
825 msgs::DecodeError::UnsupportedCompression => {
826 log_trace!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
833 match self.handle_message(peer, message) {
834 Err(handling_error) => match handling_error {
835 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
836 MessageHandlingError::LightningError(e) => {
837 try_potential_handleerror!(Err(e));
841 peer_node_id = Some(peer.their_node_id.expect("After noise is complete, their_node_id is always set"));
842 msgs_to_forward.push(msg);
852 peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_READ_PAUSE // pause_read
856 for msg in msgs_to_forward.drain(..) {
857 self.forward_broadcast_msg(peers, &msg, peer_node_id.as_ref());
866 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
867 /// Returns the message back if it needs to be broadcasted to all other peers.
868 fn handle_message(&self, peer: &mut Peer, message: wire::Message) -> Result<Option<wire::Message>, MessageHandlingError> {
869 log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(peer.their_node_id.unwrap()));
871 // Need an Init as first message
872 if let wire::Message::Init(_) = message {
873 } else if peer.their_features.is_none() {
874 log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
875 return Err(PeerHandleError{ no_connection_possible: false }.into());
878 let mut should_forward = None;
881 // Setup and Control messages:
882 wire::Message::Init(msg) => {
883 if msg.features.requires_unknown_bits() {
884 log_debug!(self.logger, "Peer features required unknown version bits");
885 return Err(PeerHandleError{ no_connection_possible: true }.into());
887 if peer.their_features.is_some() {
888 return Err(PeerHandleError{ no_connection_possible: false }.into());
892 self.logger, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, gossip_queries: {}, static_remote_key: {}, unknown flags (local and global): {}",
893 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
894 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
895 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
896 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
897 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
898 if msg.features.supports_unknown_bits() { "present" } else { "none" }
901 if msg.features.initial_routing_sync() {
902 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
904 if !msg.features.supports_static_remote_key() {
905 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
906 return Err(PeerHandleError{ no_connection_possible: true }.into());
909 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
911 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
912 peer.their_features = Some(msg.features);
914 wire::Message::Error(msg) => {
915 let mut data_is_printable = true;
916 for b in msg.data.bytes() {
917 if b < 32 || b > 126 {
918 data_is_printable = false;
923 if data_is_printable {
924 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
926 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
928 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
929 if msg.channel_id == [0; 32] {
930 return Err(PeerHandleError{ no_connection_possible: true }.into());
934 wire::Message::Ping(msg) => {
935 if msg.ponglen < 65532 {
936 let resp = msgs::Pong { byteslen: msg.ponglen };
937 self.enqueue_message(peer, &resp);
940 wire::Message::Pong(_msg) => {
941 peer.awaiting_pong = false;
945 wire::Message::OpenChannel(msg) => {
946 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
948 wire::Message::AcceptChannel(msg) => {
949 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
952 wire::Message::FundingCreated(msg) => {
953 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
955 wire::Message::FundingSigned(msg) => {
956 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
958 wire::Message::FundingLocked(msg) => {
959 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
962 wire::Message::Shutdown(msg) => {
963 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
965 wire::Message::ClosingSigned(msg) => {
966 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
969 // Commitment messages:
970 wire::Message::UpdateAddHTLC(msg) => {
971 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
973 wire::Message::UpdateFulfillHTLC(msg) => {
974 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
976 wire::Message::UpdateFailHTLC(msg) => {
977 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
979 wire::Message::UpdateFailMalformedHTLC(msg) => {
980 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
983 wire::Message::CommitmentSigned(msg) => {
984 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
986 wire::Message::RevokeAndACK(msg) => {
987 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
989 wire::Message::UpdateFee(msg) => {
990 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
992 wire::Message::ChannelReestablish(msg) => {
993 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
997 wire::Message::AnnouncementSignatures(msg) => {
998 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
1000 wire::Message::ChannelAnnouncement(msg) => {
1001 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1002 .map_err(|e| -> MessageHandlingError { e.into() })? {
1003 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1006 wire::Message::NodeAnnouncement(msg) => {
1007 if self.message_handler.route_handler.handle_node_announcement(&msg)
1008 .map_err(|e| -> MessageHandlingError { e.into() })? {
1009 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1012 wire::Message::ChannelUpdate(msg) => {
1013 self.message_handler.chan_handler.handle_channel_update(&peer.their_node_id.unwrap(), &msg);
1014 if self.message_handler.route_handler.handle_channel_update(&msg)
1015 .map_err(|e| -> MessageHandlingError { e.into() })? {
1016 should_forward = Some(wire::Message::ChannelUpdate(msg));
1019 wire::Message::QueryShortChannelIds(msg) => {
1020 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
1022 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1023 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
1025 wire::Message::QueryChannelRange(msg) => {
1026 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
1028 wire::Message::ReplyChannelRange(msg) => {
1029 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
1031 wire::Message::GossipTimestampFilter(_msg) => {
1032 // TODO: handle message
1035 // Unknown messages:
1036 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
1037 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
1038 // Fail the channel if message is an even, unknown type as per BOLT #1.
1039 return Err(PeerHandleError{ no_connection_possible: true }.into());
1041 wire::Message::Unknown(msg_type) => {
1042 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
1048 fn forward_broadcast_msg(&self, peers: &mut PeerHolder<Descriptor>, msg: &wire::Message, except_node: Option<&PublicKey>) {
1050 wire::Message::ChannelAnnouncement(ref msg) => {
1051 log_trace!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1052 let encoded_msg = encode_msg!(msg);
1054 for (_, peer) in peers.peers.iter_mut() {
1055 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1056 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1059 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1060 log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1063 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1064 peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1067 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1070 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1073 wire::Message::NodeAnnouncement(ref msg) => {
1074 log_trace!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1075 let encoded_msg = encode_msg!(msg);
1077 for (_, peer) in peers.peers.iter_mut() {
1078 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1079 !peer.should_forward_node_announcement(msg.contents.node_id) {
1082 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1083 log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1086 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1089 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1092 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1095 wire::Message::ChannelUpdate(ref msg) => {
1096 log_trace!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1097 let encoded_msg = encode_msg!(msg);
1099 for (_, peer) in peers.peers.iter_mut() {
1100 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1101 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1104 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1105 log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1108 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1111 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1114 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1118 /// Checks for any events generated by our handlers and processes them. Includes sending most
1119 /// response messages as well as messages generated by calls to handler functions directly (eg
1120 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1122 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1125 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1126 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1127 /// [`send_data`]: SocketDescriptor::send_data
1128 pub fn process_events(&self) {
1130 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1131 // buffer by doing things like announcing channels on another node. We should be willing to
1132 // drop optional-ish messages when send buffers get full!
1134 let mut peers_lock = self.peers.lock().unwrap();
1135 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1136 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1137 let peers = &mut *peers_lock;
1138 for event in events_generated.drain(..) {
1139 macro_rules! get_peer_for_forwarding {
1140 ($node_id: expr) => {
1142 match peers.node_id_to_descriptor.get($node_id) {
1143 Some(descriptor) => match peers.peers.get_mut(&descriptor) {
1145 if peer.their_features.is_none() {
1150 None => panic!("Inconsistent peers set state!"),
1160 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1161 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1162 log_pubkey!(node_id),
1163 log_bytes!(msg.temporary_channel_id));
1164 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1166 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1167 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1168 log_pubkey!(node_id),
1169 log_bytes!(msg.temporary_channel_id));
1170 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1172 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1173 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1174 log_pubkey!(node_id),
1175 log_bytes!(msg.temporary_channel_id),
1176 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1177 // TODO: If the peer is gone we should generate a DiscardFunding event
1178 // indicating to the wallet that they should just throw away this funding transaction
1179 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1181 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1182 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1183 log_pubkey!(node_id),
1184 log_bytes!(msg.channel_id));
1185 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1187 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1188 log_debug!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1189 log_pubkey!(node_id),
1190 log_bytes!(msg.channel_id));
1191 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1193 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1194 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1195 log_pubkey!(node_id),
1196 log_bytes!(msg.channel_id));
1197 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1199 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
1200 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1201 log_pubkey!(node_id),
1202 update_add_htlcs.len(),
1203 update_fulfill_htlcs.len(),
1204 update_fail_htlcs.len(),
1205 log_bytes!(commitment_signed.channel_id));
1206 let peer = get_peer_for_forwarding!(node_id);
1207 for msg in update_add_htlcs {
1208 self.enqueue_message(peer, msg);
1210 for msg in update_fulfill_htlcs {
1211 self.enqueue_message(peer, msg);
1213 for msg in update_fail_htlcs {
1214 self.enqueue_message(peer, msg);
1216 for msg in update_fail_malformed_htlcs {
1217 self.enqueue_message(peer, msg);
1219 if let &Some(ref msg) = update_fee {
1220 self.enqueue_message(peer, msg);
1222 self.enqueue_message(peer, commitment_signed);
1224 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1225 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1226 log_pubkey!(node_id),
1227 log_bytes!(msg.channel_id));
1228 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1230 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1231 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1232 log_pubkey!(node_id),
1233 log_bytes!(msg.channel_id));
1234 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1236 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1237 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1238 log_pubkey!(node_id),
1239 log_bytes!(msg.channel_id));
1240 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1242 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1243 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1244 log_pubkey!(node_id),
1245 log_bytes!(msg.channel_id));
1246 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1248 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1249 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1250 if self.message_handler.route_handler.handle_channel_announcement(&msg).is_ok() && self.message_handler.route_handler.handle_channel_update(&update_msg).is_ok() {
1251 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None);
1252 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None);
1255 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1256 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1257 if self.message_handler.route_handler.handle_node_announcement(&msg).is_ok() {
1258 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None);
1261 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1262 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1263 if self.message_handler.route_handler.handle_channel_update(&msg).is_ok() {
1264 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None);
1267 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1268 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1269 log_pubkey!(node_id), msg.contents.short_channel_id);
1270 let peer = get_peer_for_forwarding!(node_id);
1271 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1273 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1274 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1276 MessageSendEvent::HandleError { ref node_id, ref action } => {
1278 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1279 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1280 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1281 if let Some(ref msg) = *msg {
1282 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1283 log_pubkey!(node_id),
1285 self.enqueue_message(&mut peer, msg);
1286 // This isn't guaranteed to work, but if there is enough free
1287 // room in the send buffer, put the error message there...
1288 self.do_attempt_write_data(&mut descriptor, &mut peer);
1290 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1293 descriptor.disconnect_socket();
1294 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1297 msgs::ErrorAction::IgnoreAndLog(level) => {
1298 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1300 msgs::ErrorAction::IgnoreError => {
1301 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1303 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1304 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1305 log_pubkey!(node_id),
1307 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1311 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1312 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1314 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1315 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1317 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1318 log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1319 log_pubkey!(node_id),
1320 msg.short_channel_ids.len(),
1322 msg.number_of_blocks,
1324 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1329 for (descriptor, peer) in peers.peers.iter_mut() {
1330 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1335 /// Indicates that the given socket descriptor's connection is now closed.
1336 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1337 self.disconnect_event_internal(descriptor, false);
1340 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1341 let mut peers = self.peers.lock().unwrap();
1342 let peer_option = peers.peers.remove(descriptor);
1345 // This is most likely a simple race condition where the user found that the socket
1346 // was disconnected, then we told the user to `disconnect_socket()`, then they
1347 // called this method. Either way we're disconnected, return.
1350 match peer.their_node_id {
1352 peers.node_id_to_descriptor.remove(&node_id);
1353 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1361 /// Disconnect a peer given its node id.
1363 /// Set `no_connection_possible` to true to prevent any further connection with this peer,
1364 /// force-closing any channels we have with it.
1366 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1367 /// peer. Thus, be very careful about reentrancy issues.
1369 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1370 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1371 let mut peers_lock = self.peers.lock().unwrap();
1372 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1373 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1374 peers_lock.peers.remove(&descriptor);
1375 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1376 descriptor.disconnect_socket();
1380 /// This function should be called roughly once every 30 seconds.
1381 /// It will send pings to each peer and disconnect those which did not respond to the last
1384 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1387 /// [`send_data`]: SocketDescriptor::send_data
1388 pub fn timer_tick_occurred(&self) {
1389 let mut peers_lock = self.peers.lock().unwrap();
1391 let peers = &mut *peers_lock;
1392 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1393 let peers = &mut peers.peers;
1394 let mut descriptors_needing_disconnect = Vec::new();
1396 peers.retain(|descriptor, peer| {
1397 if peer.awaiting_pong {
1398 descriptors_needing_disconnect.push(descriptor.clone());
1399 match peer.their_node_id {
1401 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1402 node_id_to_descriptor.remove(&node_id);
1403 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1406 // This can't actually happen as we should have hit
1407 // is_ready_for_encryption() previously on this same peer.
1414 if !peer.channel_encryptor.is_ready_for_encryption() {
1415 // The peer needs to complete its handshake before we can exchange messages
1419 let ping = msgs::Ping {
1423 self.enqueue_message(peer, &ping);
1425 let mut descriptor_clone = descriptor.clone();
1426 self.do_attempt_write_data(&mut descriptor_clone, peer);
1428 peer.awaiting_pong = true;
1432 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1433 descriptor.disconnect_socket();
1441 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1444 use util::test_utils;
1446 use bitcoin::secp256k1::Secp256k1;
1447 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1450 use std::sync::{Arc, Mutex};
1451 use core::sync::atomic::Ordering;
1454 struct FileDescriptor {
1456 outbound_data: Arc<Mutex<Vec<u8>>>,
1458 impl PartialEq for FileDescriptor {
1459 fn eq(&self, other: &Self) -> bool {
1463 impl Eq for FileDescriptor { }
1464 impl core::hash::Hash for FileDescriptor {
1465 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1466 self.fd.hash(hasher)
1470 impl SocketDescriptor for FileDescriptor {
1471 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1472 self.outbound_data.lock().unwrap().extend_from_slice(data);
1476 fn disconnect_socket(&mut self) {}
1479 struct PeerManagerCfg {
1480 chan_handler: test_utils::TestChannelMessageHandler,
1481 routing_handler: test_utils::TestRoutingMessageHandler,
1482 logger: test_utils::TestLogger,
1485 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1486 let mut cfgs = Vec::new();
1487 for _ in 0..peer_count {
1490 chan_handler: test_utils::TestChannelMessageHandler::new(),
1491 logger: test_utils::TestLogger::new(),
1492 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1500 fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>> {
1501 let mut peers = Vec::new();
1502 for i in 0..peer_count {
1503 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1504 let ephemeral_bytes = [i as u8; 32];
1505 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1506 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1513 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>) -> (FileDescriptor, FileDescriptor) {
1514 let secp_ctx = Secp256k1::new();
1515 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1516 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1517 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1518 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1519 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1520 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1521 peer_a.process_events();
1522 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1523 peer_b.process_events();
1524 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1525 (fd_a.clone(), fd_b.clone())
1529 fn test_disconnect_peer() {
1530 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1531 // push a DisconnectPeer event to remove the node flagged by id
1532 let cfgs = create_peermgr_cfgs(2);
1533 let chan_handler = test_utils::TestChannelMessageHandler::new();
1534 let mut peers = create_network(2, &cfgs);
1535 establish_connection(&peers[0], &peers[1]);
1536 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1538 let secp_ctx = Secp256k1::new();
1539 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1541 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1543 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1545 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1546 peers[0].message_handler.chan_handler = &chan_handler;
1548 peers[0].process_events();
1549 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1553 fn test_timer_tick_occurred() {
1554 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1555 let cfgs = create_peermgr_cfgs(2);
1556 let peers = create_network(2, &cfgs);
1557 establish_connection(&peers[0], &peers[1]);
1558 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1560 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1561 peers[0].timer_tick_occurred();
1562 peers[0].process_events();
1563 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1565 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1566 peers[0].timer_tick_occurred();
1567 peers[0].process_events();
1568 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1572 fn test_do_attempt_write_data() {
1573 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1574 let cfgs = create_peermgr_cfgs(2);
1575 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1576 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1577 let peers = create_network(2, &cfgs);
1579 // By calling establish_connect, we trigger do_attempt_write_data between
1580 // the peers. Previously this function would mistakenly enter an infinite loop
1581 // when there were more channel messages available than could fit into a peer's
1582 // buffer. This issue would now be detected by this test (because we use custom
1583 // RoutingMessageHandlers that intentionally return more channel messages
1584 // than can fit into a peer's buffer).
1585 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1587 // Make each peer to read the messages that the other peer just wrote to them.
1588 peers[0].process_events();
1589 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1590 peers[1].process_events();
1591 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1593 // Check that each peer has received the expected number of channel updates and channel
1595 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1596 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1597 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1598 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);