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 std::sync::{Arc, Mutex};
36 use core::sync::atomic::{AtomicUsize, Ordering};
37 use core::{cmp, hash, fmt, mem};
41 use bitcoin::hashes::sha256::Hash as Sha256;
42 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
43 use bitcoin::hashes::{HashEngine, Hash};
45 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
46 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
47 pub struct IgnoringMessageHandler{}
48 impl MessageSendEventsProvider for IgnoringMessageHandler {
49 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
51 impl RoutingMessageHandler for IgnoringMessageHandler {
52 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
53 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
54 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
55 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
56 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
57 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
58 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
59 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
60 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
61 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
62 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
63 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
65 impl Deref for IgnoringMessageHandler {
66 type Target = IgnoringMessageHandler;
67 fn deref(&self) -> &Self { self }
70 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
71 /// You can provide one of these as the route_handler in a MessageHandler.
72 pub struct ErroringMessageHandler {
73 message_queue: Mutex<Vec<MessageSendEvent>>
75 impl ErroringMessageHandler {
76 /// Constructs a new ErroringMessageHandler
77 pub fn new() -> Self {
78 Self { message_queue: Mutex::new(Vec::new()) }
80 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
81 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
82 action: msgs::ErrorAction::SendErrorMessage {
83 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
85 node_id: node_id.clone(),
89 impl MessageSendEventsProvider for ErroringMessageHandler {
90 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
91 let mut res = Vec::new();
92 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
96 impl ChannelMessageHandler for ErroringMessageHandler {
97 // Any messages which are related to a specific channel generate an error message to let the
98 // peer know we don't care about channels.
99 fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
100 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
102 fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
103 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
105 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
106 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
108 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
109 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
111 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
112 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
114 fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
115 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
117 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
118 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
120 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
121 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
123 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
124 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
126 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
127 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
129 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
130 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
132 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
133 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
135 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
136 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
138 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
139 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
141 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
142 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
144 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
145 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
147 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
148 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
149 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
150 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
151 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
153 impl Deref for ErroringMessageHandler {
154 type Target = ErroringMessageHandler;
155 fn deref(&self) -> &Self { self }
158 /// Provides references to trait impls which handle different types of messages.
159 pub struct MessageHandler<CM: Deref, RM: Deref> where
160 CM::Target: ChannelMessageHandler,
161 RM::Target: RoutingMessageHandler {
162 /// A message handler which handles messages specific to channels. Usually this is just a
163 /// ChannelManager object or a ErroringMessageHandler.
164 pub chan_handler: CM,
165 /// A message handler which handles messages updating our knowledge of the network channel
166 /// graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
167 pub route_handler: RM,
170 /// Provides an object which can be used to send data to and which uniquely identifies a connection
171 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
172 /// implement Hash to meet the PeerManager API.
174 /// For efficiency, Clone should be relatively cheap for this type.
176 /// You probably want to just extend an int and put a file descriptor in a struct and implement
177 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
178 /// be careful to ensure you don't have races whereby you might register a new connection with an
179 /// fd which is the same as a previous one which has yet to be removed via
180 /// PeerManager::socket_disconnected().
181 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
182 /// Attempts to send some data from the given slice to the peer.
184 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
185 /// Note that in the disconnected case, socket_disconnected must still fire and further write
186 /// attempts may occur until that time.
188 /// If the returned size is smaller than data.len(), a write_available event must
189 /// trigger the next time more data can be written. Additionally, until the a send_data event
190 /// completes fully, no further read_events should trigger on the same peer!
192 /// If a read_event on this descriptor had previously returned true (indicating that read
193 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
194 /// indicating that read events on this descriptor should resume. A resume_read of false does
195 /// *not* imply that further read events should be paused.
196 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
197 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
198 /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
199 /// this descriptor. No socket_disconnected call should be generated as a result of this call,
200 /// though races may occur whereby disconnect_socket is called after a call to
201 /// socket_disconnected but prior to socket_disconnected returning.
202 fn disconnect_socket(&mut self);
205 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
206 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
209 pub struct PeerHandleError {
210 /// Used to indicate that we probably can't make any future connections to this peer, implying
211 /// we should go ahead and force-close any channels we have with it.
212 pub no_connection_possible: bool,
214 impl fmt::Debug for PeerHandleError {
215 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
216 formatter.write_str("Peer Sent Invalid Data")
219 impl fmt::Display for PeerHandleError {
220 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
221 formatter.write_str("Peer Sent Invalid Data")
224 impl error::Error for PeerHandleError {
225 fn description(&self) -> &str {
226 "Peer Sent Invalid Data"
230 enum InitSyncTracker{
232 ChannelsSyncing(u64),
233 NodesSyncing(PublicKey),
236 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
237 /// we have fewer than this many messages in the outbound buffer again.
238 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
239 /// refilled as we send bytes.
240 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 10;
241 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
243 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = 20;
246 channel_encryptor: PeerChannelEncryptor,
247 their_node_id: Option<PublicKey>,
248 their_features: Option<InitFeatures>,
250 pending_outbound_buffer: LinkedList<Vec<u8>>,
251 pending_outbound_buffer_first_msg_offset: usize,
252 awaiting_write_event: bool,
254 pending_read_buffer: Vec<u8>,
255 pending_read_buffer_pos: usize,
256 pending_read_is_header: bool,
258 sync_status: InitSyncTracker,
264 /// Returns true if the channel announcements/updates for the given channel should be
265 /// forwarded to this peer.
266 /// If we are sending our routing table to this peer and we have not yet sent channel
267 /// announcements/updates for the given channel_id then we will send it when we get to that
268 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
269 /// sent the old versions, we should send the update, and so return true here.
270 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
271 match self.sync_status {
272 InitSyncTracker::NoSyncRequested => true,
273 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
274 InitSyncTracker::NodesSyncing(_) => true,
278 /// Similar to the above, but for node announcements indexed by node_id.
279 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
280 match self.sync_status {
281 InitSyncTracker::NoSyncRequested => true,
282 InitSyncTracker::ChannelsSyncing(_) => false,
283 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
288 struct PeerHolder<Descriptor: SocketDescriptor> {
289 peers: HashMap<Descriptor, Peer>,
290 /// Only add to this set when noise completes:
291 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
294 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
295 fn _check_usize_is_32_or_64() {
296 // See below, less than 32 bit pointers may be unsafe here!
297 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
300 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
301 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
302 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
303 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
304 /// issues such as overly long function definitions.
305 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>>;
307 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
308 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
309 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
310 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
311 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
312 /// helps with issues such as long function definitions.
313 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>;
315 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
316 /// events into messages which it passes on to its MessageHandlers.
318 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
319 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
320 /// essentially you should default to using a SimpleRefPeerManager, and use a
321 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
322 /// you're using lightning-net-tokio.
323 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
324 CM::Target: ChannelMessageHandler,
325 RM::Target: RoutingMessageHandler,
327 message_handler: MessageHandler<CM, RM>,
328 peers: Mutex<PeerHolder<Descriptor>>,
329 our_node_secret: SecretKey,
330 ephemeral_key_midstate: Sha256Engine,
332 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
333 // bits we will never realistically count into high:
334 peer_counter_low: AtomicUsize,
335 peer_counter_high: AtomicUsize,
340 enum MessageHandlingError {
341 PeerHandleError(PeerHandleError),
342 LightningError(LightningError),
345 impl From<PeerHandleError> for MessageHandlingError {
346 fn from(error: PeerHandleError) -> Self {
347 MessageHandlingError::PeerHandleError(error)
351 impl From<LightningError> for MessageHandlingError {
352 fn from(error: LightningError) -> Self {
353 MessageHandlingError::LightningError(error)
357 macro_rules! encode_msg {
359 let mut buffer = VecWriter(Vec::new());
360 wire::write($msg, &mut buffer).unwrap();
365 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L> where
366 CM::Target: ChannelMessageHandler,
368 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
369 /// handler is used and network graph messages are ignored.
371 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
372 /// cryptographically secure random bytes.
374 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
375 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
376 Self::new(MessageHandler {
377 chan_handler: channel_message_handler,
378 route_handler: IgnoringMessageHandler{},
379 }, our_node_secret, ephemeral_random_data, logger)
383 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L> where
384 RM::Target: RoutingMessageHandler,
386 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
387 /// handler is used and messages related to channels will be ignored (or generate error
388 /// messages). Note that some other lightning implementations time-out connections after some
389 /// time if no channel is built with the peer.
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 channel handler
395 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
396 Self::new(MessageHandler {
397 chan_handler: ErroringMessageHandler::new(),
398 route_handler: routing_message_handler,
399 }, our_node_secret, ephemeral_random_data, logger)
403 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
404 /// PeerIds may repeat, but only after socket_disconnected() has been called.
405 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
406 CM::Target: ChannelMessageHandler,
407 RM::Target: RoutingMessageHandler,
409 /// Constructs a new PeerManager with the given message handlers and node_id secret key
410 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
411 /// cryptographically secure random bytes.
412 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
413 let mut ephemeral_key_midstate = Sha256::engine();
414 ephemeral_key_midstate.input(ephemeral_random_data);
418 peers: Mutex::new(PeerHolder {
419 peers: HashMap::new(),
420 node_id_to_descriptor: HashMap::new()
423 ephemeral_key_midstate,
424 peer_counter_low: AtomicUsize::new(0),
425 peer_counter_high: AtomicUsize::new(0),
430 /// Get the list of node ids for peers which have completed the initial handshake.
432 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
433 /// new_outbound_connection, however entries will only appear once the initial handshake has
434 /// completed and we are sure the remote peer has the private key for the given node_id.
435 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
436 let peers = self.peers.lock().unwrap();
437 peers.peers.values().filter_map(|p| {
438 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
445 fn get_ephemeral_key(&self) -> SecretKey {
446 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
447 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
448 let high = if low == 0 {
449 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
451 self.peer_counter_high.load(Ordering::Acquire)
453 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
454 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
455 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
458 /// Indicates a new outbound connection has been established to a node with the given node_id.
459 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
460 /// descriptor but must disconnect the connection immediately.
462 /// Returns a small number of bytes to send to the remote node (currently always 50).
464 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
465 /// socket_disconnected().
466 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
467 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
468 let res = peer_encryptor.get_act_one().to_vec();
469 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
471 let mut peers = self.peers.lock().unwrap();
472 if peers.peers.insert(descriptor, Peer {
473 channel_encryptor: peer_encryptor,
475 their_features: None,
477 pending_outbound_buffer: LinkedList::new(),
478 pending_outbound_buffer_first_msg_offset: 0,
479 awaiting_write_event: false,
482 pending_read_buffer_pos: 0,
483 pending_read_is_header: false,
485 sync_status: InitSyncTracker::NoSyncRequested,
487 awaiting_pong: false,
489 panic!("PeerManager driver duplicated descriptors!");
494 /// Indicates a new inbound connection has been established.
496 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
497 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
498 /// call socket_disconnected for the new descriptor but must disconnect the connection
501 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
502 /// socket_disconnected called.
503 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
504 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
505 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
507 let mut peers = self.peers.lock().unwrap();
508 if peers.peers.insert(descriptor, Peer {
509 channel_encryptor: peer_encryptor,
511 their_features: None,
513 pending_outbound_buffer: LinkedList::new(),
514 pending_outbound_buffer_first_msg_offset: 0,
515 awaiting_write_event: false,
518 pending_read_buffer_pos: 0,
519 pending_read_is_header: false,
521 sync_status: InitSyncTracker::NoSyncRequested,
523 awaiting_pong: false,
525 panic!("PeerManager driver duplicated descriptors!");
530 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
531 macro_rules! encode_and_send_msg {
534 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
535 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
539 while !peer.awaiting_write_event {
540 if peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE {
541 match peer.sync_status {
542 InitSyncTracker::NoSyncRequested => {},
543 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
544 let steps = ((OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
545 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
546 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
547 encode_and_send_msg!(announce);
548 if let &Some(ref update_a) = update_a_option {
549 encode_and_send_msg!(update_a);
551 if let &Some(ref update_b) = update_b_option {
552 encode_and_send_msg!(update_b);
554 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
556 if all_messages.is_empty() || all_messages.len() != steps as usize {
557 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
560 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
561 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
562 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
563 for msg in all_messages.iter() {
564 encode_and_send_msg!(msg);
565 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
567 if all_messages.is_empty() || all_messages.len() != steps as usize {
568 peer.sync_status = InitSyncTracker::NoSyncRequested;
571 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
572 InitSyncTracker::NodesSyncing(key) => {
573 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
574 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
575 for msg in all_messages.iter() {
576 encode_and_send_msg!(msg);
577 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
579 if all_messages.is_empty() || all_messages.len() != steps as usize {
580 peer.sync_status = InitSyncTracker::NoSyncRequested;
587 let next_buff = match peer.pending_outbound_buffer.front() {
592 let should_be_reading = peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
593 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
594 let data_sent = descriptor.send_data(pending, should_be_reading);
595 peer.pending_outbound_buffer_first_msg_offset += data_sent;
596 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
598 peer.pending_outbound_buffer_first_msg_offset = 0;
599 peer.pending_outbound_buffer.pop_front();
601 peer.awaiting_write_event = true;
606 /// Indicates that there is room to write data to the given socket descriptor.
608 /// May return an Err to indicate that the connection should be closed.
610 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
611 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
612 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
613 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
614 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
615 /// new_\*_connection event.
616 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
617 let mut peers = self.peers.lock().unwrap();
618 match peers.peers.get_mut(descriptor) {
619 None => panic!("Descriptor for write_event is not already known to PeerManager"),
621 peer.awaiting_write_event = false;
622 self.do_attempt_write_data(descriptor, peer);
628 /// Indicates that data was read from the given socket descriptor.
630 /// May return an Err to indicate that the connection should be closed.
632 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
633 /// Thus, however, you almost certainly want to call process_events() after any read_event to
634 /// generate send_data calls to handle responses.
636 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
637 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
639 /// Panics if the descriptor was not previously registered in a new_*_connection event.
640 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
641 match self.do_read_event(peer_descriptor, data) {
644 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
650 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
651 fn enqueue_message<M: Encode + Writeable>(&self, peer: &mut Peer, message: &M) {
652 let mut buffer = VecWriter(Vec::new());
653 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
654 let encoded_message = buffer.0;
656 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
657 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
660 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
662 let mut peers_lock = self.peers.lock().unwrap();
663 let peers = &mut *peers_lock;
664 let mut msgs_to_forward = Vec::new();
665 let mut peer_node_id = None;
666 let pause_read = match peers.peers.get_mut(peer_descriptor) {
667 None => panic!("Descriptor for read_event is not already known to PeerManager"),
669 assert!(peer.pending_read_buffer.len() > 0);
670 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
672 let mut read_pos = 0;
673 while read_pos < data.len() {
675 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
676 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]);
677 read_pos += data_to_copy;
678 peer.pending_read_buffer_pos += data_to_copy;
681 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
682 peer.pending_read_buffer_pos = 0;
684 macro_rules! try_potential_handleerror {
690 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
691 //TODO: Try to push msg
692 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
693 return Err(PeerHandleError{ no_connection_possible: false });
695 msgs::ErrorAction::IgnoreError => {
696 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
699 msgs::ErrorAction::SendErrorMessage { msg } => {
700 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
701 self.enqueue_message(peer, &msg);
710 macro_rules! insert_node_id {
712 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
713 hash_map::Entry::Occupied(_) => {
714 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
715 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
716 return Err(PeerHandleError{ no_connection_possible: false })
718 hash_map::Entry::Vacant(entry) => {
719 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
720 entry.insert(peer_descriptor.clone())
726 let next_step = peer.channel_encryptor.get_noise_step();
728 NextNoiseStep::ActOne => {
729 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();
730 peer.pending_outbound_buffer.push_back(act_two);
731 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
733 NextNoiseStep::ActTwo => {
734 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
735 peer.pending_outbound_buffer.push_back(act_three.to_vec());
736 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
737 peer.pending_read_is_header = true;
739 peer.their_node_id = Some(their_node_id);
741 let features = InitFeatures::known();
742 let resp = msgs::Init { features };
743 self.enqueue_message(peer, &resp);
745 NextNoiseStep::ActThree => {
746 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
747 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
748 peer.pending_read_is_header = true;
749 peer.their_node_id = Some(their_node_id);
751 let features = InitFeatures::known();
752 let resp = msgs::Init { features };
753 self.enqueue_message(peer, &resp);
755 NextNoiseStep::NoiseComplete => {
756 if peer.pending_read_is_header {
757 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
758 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
759 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
760 if msg_len < 2 { // Need at least the message type tag
761 return Err(PeerHandleError{ no_connection_possible: false });
763 peer.pending_read_is_header = false;
765 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
766 assert!(msg_data.len() >= 2);
769 peer.pending_read_buffer = [0; 18].to_vec();
770 peer.pending_read_is_header = true;
772 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
773 let message_result = wire::read(&mut reader);
774 let message = match message_result {
778 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
779 msgs::DecodeError::UnknownRequiredFeature => {
780 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
783 msgs::DecodeError::InvalidValue => {
784 log_debug!(self.logger, "Got an invalid value while deserializing message");
785 return Err(PeerHandleError { no_connection_possible: false });
787 msgs::DecodeError::ShortRead => {
788 log_debug!(self.logger, "Deserialization failed due to shortness of message");
789 return Err(PeerHandleError { no_connection_possible: false });
791 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
792 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
793 msgs::DecodeError::UnsupportedCompression => {
794 log_debug!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
801 match self.handle_message(peer, message) {
802 Err(handling_error) => match handling_error {
803 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
804 MessageHandlingError::LightningError(e) => {
805 try_potential_handleerror!(Err(e));
809 peer_node_id = Some(peer.their_node_id.expect("After noise is complete, their_node_id is always set"));
810 msgs_to_forward.push(msg);
820 peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_READ_PAUSE // pause_read
824 for msg in msgs_to_forward.drain(..) {
825 self.forward_broadcast_msg(peers, &msg, peer_node_id.as_ref());
834 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
835 /// Returns the message back if it needs to be broadcasted to all other peers.
836 fn handle_message(&self, peer: &mut Peer, message: wire::Message) -> Result<Option<wire::Message>, MessageHandlingError> {
837 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
839 // Need an Init as first message
840 if let wire::Message::Init(_) = message {
841 } else if peer.their_features.is_none() {
842 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
843 return Err(PeerHandleError{ no_connection_possible: false }.into());
846 let mut should_forward = None;
849 // Setup and Control messages:
850 wire::Message::Init(msg) => {
851 if msg.features.requires_unknown_bits() {
852 log_info!(self.logger, "Peer features required unknown version bits");
853 return Err(PeerHandleError{ no_connection_possible: true }.into());
855 if peer.their_features.is_some() {
856 return Err(PeerHandleError{ no_connection_possible: false }.into());
860 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): {}",
861 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
862 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
863 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
864 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
865 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
866 if msg.features.supports_unknown_bits() { "present" } else { "none" }
869 if msg.features.initial_routing_sync() {
870 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
872 if !msg.features.supports_static_remote_key() {
873 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
874 return Err(PeerHandleError{ no_connection_possible: true }.into());
877 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
879 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
880 peer.their_features = Some(msg.features);
882 wire::Message::Error(msg) => {
883 let mut data_is_printable = true;
884 for b in msg.data.bytes() {
885 if b < 32 || b > 126 {
886 data_is_printable = false;
891 if data_is_printable {
892 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
894 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
896 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
897 if msg.channel_id == [0; 32] {
898 return Err(PeerHandleError{ no_connection_possible: true }.into());
902 wire::Message::Ping(msg) => {
903 if msg.ponglen < 65532 {
904 let resp = msgs::Pong { byteslen: msg.ponglen };
905 self.enqueue_message(peer, &resp);
908 wire::Message::Pong(_msg) => {
909 peer.awaiting_pong = false;
913 wire::Message::OpenChannel(msg) => {
914 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
916 wire::Message::AcceptChannel(msg) => {
917 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
920 wire::Message::FundingCreated(msg) => {
921 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
923 wire::Message::FundingSigned(msg) => {
924 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
926 wire::Message::FundingLocked(msg) => {
927 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
930 wire::Message::Shutdown(msg) => {
931 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
933 wire::Message::ClosingSigned(msg) => {
934 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
937 // Commitment messages:
938 wire::Message::UpdateAddHTLC(msg) => {
939 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
941 wire::Message::UpdateFulfillHTLC(msg) => {
942 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
944 wire::Message::UpdateFailHTLC(msg) => {
945 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
947 wire::Message::UpdateFailMalformedHTLC(msg) => {
948 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
951 wire::Message::CommitmentSigned(msg) => {
952 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
954 wire::Message::RevokeAndACK(msg) => {
955 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
957 wire::Message::UpdateFee(msg) => {
958 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
960 wire::Message::ChannelReestablish(msg) => {
961 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
965 wire::Message::AnnouncementSignatures(msg) => {
966 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
968 wire::Message::ChannelAnnouncement(msg) => {
969 if self.message_handler.route_handler.handle_channel_announcement(&msg)
970 .map_err(|e| -> MessageHandlingError { e.into() })? {
971 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
974 wire::Message::NodeAnnouncement(msg) => {
975 if self.message_handler.route_handler.handle_node_announcement(&msg)
976 .map_err(|e| -> MessageHandlingError { e.into() })? {
977 should_forward = Some(wire::Message::NodeAnnouncement(msg));
980 wire::Message::ChannelUpdate(msg) => {
981 self.message_handler.chan_handler.handle_channel_update(&peer.their_node_id.unwrap(), &msg);
982 if self.message_handler.route_handler.handle_channel_update(&msg)
983 .map_err(|e| -> MessageHandlingError { e.into() })? {
984 should_forward = Some(wire::Message::ChannelUpdate(msg));
987 wire::Message::QueryShortChannelIds(msg) => {
988 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
990 wire::Message::ReplyShortChannelIdsEnd(msg) => {
991 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
993 wire::Message::QueryChannelRange(msg) => {
994 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
996 wire::Message::ReplyChannelRange(msg) => {
997 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
999 wire::Message::GossipTimestampFilter(_msg) => {
1000 // TODO: handle message
1003 // Unknown messages:
1004 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
1005 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
1006 // Fail the channel if message is an even, unknown type as per BOLT #1.
1007 return Err(PeerHandleError{ no_connection_possible: true }.into());
1009 wire::Message::Unknown(msg_type) => {
1010 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
1016 fn forward_broadcast_msg(&self, peers: &mut PeerHolder<Descriptor>, msg: &wire::Message, except_node: Option<&PublicKey>) {
1018 wire::Message::ChannelAnnouncement(ref msg) => {
1019 let encoded_msg = encode_msg!(msg);
1021 for (_, peer) in peers.peers.iter_mut() {
1022 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1023 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1026 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1029 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1030 peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1033 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1036 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1039 wire::Message::NodeAnnouncement(ref msg) => {
1040 let encoded_msg = encode_msg!(msg);
1042 for (_, peer) in peers.peers.iter_mut() {
1043 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1044 !peer.should_forward_node_announcement(msg.contents.node_id) {
1047 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1050 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1053 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1056 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1059 wire::Message::ChannelUpdate(ref msg) => {
1060 let encoded_msg = encode_msg!(msg);
1062 for (_, peer) in peers.peers.iter_mut() {
1063 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1064 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1067 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1070 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1073 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1076 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1080 /// Checks for any events generated by our handlers and processes them. Includes sending most
1081 /// response messages as well as messages generated by calls to handler functions directly (eg
1082 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
1083 pub fn process_events(&self) {
1085 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1086 // buffer by doing things like announcing channels on another node. We should be willing to
1087 // drop optional-ish messages when send buffers get full!
1089 let mut peers_lock = self.peers.lock().unwrap();
1090 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1091 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1092 let peers = &mut *peers_lock;
1093 for event in events_generated.drain(..) {
1094 macro_rules! get_peer_for_forwarding {
1095 ($node_id: expr) => {
1097 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
1098 Some(descriptor) => descriptor.clone(),
1103 match peers.peers.get_mut(&descriptor) {
1105 if peer.their_features.is_none() {
1110 None => panic!("Inconsistent peers set state!"),
1116 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1117 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1118 log_pubkey!(node_id),
1119 log_bytes!(msg.temporary_channel_id));
1120 let (_, peer) = get_peer_for_forwarding!(node_id);
1121 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1123 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1124 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1125 log_pubkey!(node_id),
1126 log_bytes!(msg.temporary_channel_id));
1127 let (_, peer) = get_peer_for_forwarding!(node_id);
1128 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1130 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1131 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1132 log_pubkey!(node_id),
1133 log_bytes!(msg.temporary_channel_id),
1134 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1135 // TODO: If the peer is gone we should generate a DiscardFunding event
1136 // indicating to the wallet that they should just throw away this funding transaction
1137 let (_, peer) = get_peer_for_forwarding!(node_id);
1138 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1140 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1141 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1142 log_pubkey!(node_id),
1143 log_bytes!(msg.channel_id));
1144 let (_, peer) = get_peer_for_forwarding!(node_id);
1145 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1147 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1148 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1149 log_pubkey!(node_id),
1150 log_bytes!(msg.channel_id));
1151 let (_, peer) = get_peer_for_forwarding!(node_id);
1152 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1154 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1155 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1156 log_pubkey!(node_id),
1157 log_bytes!(msg.channel_id));
1158 let (_, peer) = get_peer_for_forwarding!(node_id);
1159 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1161 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 } } => {
1162 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1163 log_pubkey!(node_id),
1164 update_add_htlcs.len(),
1165 update_fulfill_htlcs.len(),
1166 update_fail_htlcs.len(),
1167 log_bytes!(commitment_signed.channel_id));
1168 let (_, peer) = get_peer_for_forwarding!(node_id);
1169 for msg in update_add_htlcs {
1170 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1172 for msg in update_fulfill_htlcs {
1173 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1175 for msg in update_fail_htlcs {
1176 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1178 for msg in update_fail_malformed_htlcs {
1179 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1181 if let &Some(ref msg) = update_fee {
1182 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1184 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
1186 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1187 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1188 log_pubkey!(node_id),
1189 log_bytes!(msg.channel_id));
1190 let (_, peer) = get_peer_for_forwarding!(node_id);
1191 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1193 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1194 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1195 log_pubkey!(node_id),
1196 log_bytes!(msg.channel_id));
1197 let (_, peer) = get_peer_for_forwarding!(node_id);
1198 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1200 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1201 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1202 log_pubkey!(node_id),
1203 log_bytes!(msg.channel_id));
1204 let (_, peer) = get_peer_for_forwarding!(node_id);
1205 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1207 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1208 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1209 log_pubkey!(node_id),
1210 log_bytes!(msg.channel_id));
1211 let (_, peer) = get_peer_for_forwarding!(node_id);
1212 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1214 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1215 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1216 if self.message_handler.route_handler.handle_channel_announcement(&msg).is_ok() && self.message_handler.route_handler.handle_channel_update(&update_msg).is_ok() {
1217 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None);
1218 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None);
1221 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1222 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1223 if self.message_handler.route_handler.handle_node_announcement(&msg).is_ok() {
1224 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None);
1227 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1228 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1229 if self.message_handler.route_handler.handle_channel_update(&msg).is_ok() {
1230 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None);
1233 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1234 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1236 MessageSendEvent::HandleError { ref node_id, ref action } => {
1238 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1239 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1240 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1241 if let Some(ref msg) = *msg {
1242 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1243 log_pubkey!(node_id),
1245 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1246 // This isn't guaranteed to work, but if there is enough free
1247 // room in the send buffer, put the error message there...
1248 self.do_attempt_write_data(&mut descriptor, &mut peer);
1250 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1253 descriptor.disconnect_socket();
1254 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1257 msgs::ErrorAction::IgnoreError => {},
1258 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1259 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1260 log_pubkey!(node_id),
1262 let (_, peer) = get_peer_for_forwarding!(node_id);
1263 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1267 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1268 let (_, peer) = get_peer_for_forwarding!(node_id);
1269 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1271 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1272 let (_, peer) = get_peer_for_forwarding!(node_id);
1273 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1275 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1276 log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1277 log_pubkey!(node_id),
1278 msg.short_channel_ids.len(),
1280 msg.number_of_blocks,
1282 let (_, peer) = get_peer_for_forwarding!(node_id);
1283 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1288 for (descriptor, peer) in peers.peers.iter_mut() {
1289 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1294 /// Indicates that the given socket descriptor's connection is now closed.
1296 /// This must only be called if the socket has been disconnected by the peer or your own
1297 /// decision to disconnect it and must NOT be called in any case where other parts of this
1298 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1301 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1302 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1303 self.disconnect_event_internal(descriptor, false);
1306 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1307 let mut peers = self.peers.lock().unwrap();
1308 let peer_option = peers.peers.remove(descriptor);
1310 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1312 match peer.their_node_id {
1314 peers.node_id_to_descriptor.remove(&node_id);
1315 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1323 /// Disconnect a peer given its node id.
1325 /// Set no_connection_possible to true to prevent any further connection with this peer,
1326 /// force-closing any channels we have with it.
1328 /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1329 /// so be careful about reentrancy issues.
1330 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1331 let mut peers_lock = self.peers.lock().unwrap();
1332 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1333 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1334 peers_lock.peers.remove(&descriptor);
1335 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1336 descriptor.disconnect_socket();
1340 /// This function should be called roughly once every 30 seconds.
1341 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1343 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1344 pub fn timer_tick_occurred(&self) {
1345 let mut peers_lock = self.peers.lock().unwrap();
1347 let peers = &mut *peers_lock;
1348 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1349 let peers = &mut peers.peers;
1350 let mut descriptors_needing_disconnect = Vec::new();
1352 peers.retain(|descriptor, peer| {
1353 if peer.awaiting_pong {
1354 descriptors_needing_disconnect.push(descriptor.clone());
1355 match peer.their_node_id {
1357 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1358 node_id_to_descriptor.remove(&node_id);
1359 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1362 // This can't actually happen as we should have hit
1363 // is_ready_for_encryption() previously on this same peer.
1370 if !peer.channel_encryptor.is_ready_for_encryption() {
1371 // The peer needs to complete its handshake before we can exchange messages
1375 let ping = msgs::Ping {
1379 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1381 let mut descriptor_clone = descriptor.clone();
1382 self.do_attempt_write_data(&mut descriptor_clone, peer);
1384 peer.awaiting_pong = true;
1388 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1389 descriptor.disconnect_socket();
1397 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1400 use util::test_utils;
1402 use bitcoin::secp256k1::Secp256k1;
1403 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1406 use std::sync::{Arc, Mutex};
1407 use core::sync::atomic::Ordering;
1410 struct FileDescriptor {
1412 outbound_data: Arc<Mutex<Vec<u8>>>,
1414 impl PartialEq for FileDescriptor {
1415 fn eq(&self, other: &Self) -> bool {
1419 impl Eq for FileDescriptor { }
1420 impl core::hash::Hash for FileDescriptor {
1421 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1422 self.fd.hash(hasher)
1426 impl SocketDescriptor for FileDescriptor {
1427 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1428 self.outbound_data.lock().unwrap().extend_from_slice(data);
1432 fn disconnect_socket(&mut self) {}
1435 struct PeerManagerCfg {
1436 chan_handler: test_utils::TestChannelMessageHandler,
1437 routing_handler: test_utils::TestRoutingMessageHandler,
1438 logger: test_utils::TestLogger,
1441 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1442 let mut cfgs = Vec::new();
1443 for _ in 0..peer_count {
1446 chan_handler: test_utils::TestChannelMessageHandler::new(),
1447 logger: test_utils::TestLogger::new(),
1448 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1456 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>> {
1457 let mut peers = Vec::new();
1458 for i in 0..peer_count {
1459 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1460 let ephemeral_bytes = [i as u8; 32];
1461 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1462 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1469 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) {
1470 let secp_ctx = Secp256k1::new();
1471 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1472 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1473 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1474 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1475 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1476 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1477 peer_a.process_events();
1478 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1479 peer_b.process_events();
1480 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1481 (fd_a.clone(), fd_b.clone())
1485 fn test_disconnect_peer() {
1486 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1487 // push a DisconnectPeer event to remove the node flagged by id
1488 let cfgs = create_peermgr_cfgs(2);
1489 let chan_handler = test_utils::TestChannelMessageHandler::new();
1490 let mut peers = create_network(2, &cfgs);
1491 establish_connection(&peers[0], &peers[1]);
1492 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1494 let secp_ctx = Secp256k1::new();
1495 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1497 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1499 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1501 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1502 peers[0].message_handler.chan_handler = &chan_handler;
1504 peers[0].process_events();
1505 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1509 fn test_timer_tick_occurred() {
1510 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1511 let cfgs = create_peermgr_cfgs(2);
1512 let peers = create_network(2, &cfgs);
1513 establish_connection(&peers[0], &peers[1]);
1514 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1516 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1517 peers[0].timer_tick_occurred();
1518 peers[0].process_events();
1519 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1521 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1522 peers[0].timer_tick_occurred();
1523 peers[0].process_events();
1524 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1528 fn test_do_attempt_write_data() {
1529 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1530 let cfgs = create_peermgr_cfgs(2);
1531 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1532 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1533 let peers = create_network(2, &cfgs);
1535 // By calling establish_connect, we trigger do_attempt_write_data between
1536 // the peers. Previously this function would mistakenly enter an infinite loop
1537 // when there were more channel messages available than could fit into a peer's
1538 // buffer. This issue would now be detected by this test (because we use custom
1539 // RoutingMessageHandlers that intentionally return more channel messages
1540 // than can fit into a peer's buffer).
1541 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1543 // Make each peer to read the messages that the other peer just wrote to them.
1544 peers[0].process_events();
1545 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1546 peers[1].process_events();
1547 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1549 // Check that each peer has received the expected number of channel updates and channel
1551 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1552 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1553 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1554 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);