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;
33 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
34 use std::sync::{Arc, Mutex};
35 use std::sync::atomic::{AtomicUsize, Ordering};
36 use std::{cmp,error,hash,fmt};
39 use bitcoin::hashes::sha256::Hash as Sha256;
40 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
41 use bitcoin::hashes::{HashEngine, Hash};
43 /// Provides references to trait impls which handle different types of messages.
44 pub struct MessageHandler<CM: Deref, RM: Deref> where
45 CM::Target: ChannelMessageHandler,
46 RM::Target: RoutingMessageHandler {
47 /// A message handler which handles messages specific to channels. Usually this is just a
48 /// ChannelManager object.
50 /// A message handler which handles messages updating our knowledge of the network channel
51 /// graph. Usually this is just a NetGraphMsgHandlerMonitor object.
52 pub route_handler: RM,
55 /// Provides an object which can be used to send data to and which uniquely identifies a connection
56 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
57 /// implement Hash to meet the PeerManager API.
59 /// For efficiency, Clone should be relatively cheap for this type.
61 /// You probably want to just extend an int and put a file descriptor in a struct and implement
62 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
63 /// be careful to ensure you don't have races whereby you might register a new connection with an
64 /// fd which is the same as a previous one which has yet to be removed via
65 /// PeerManager::socket_disconnected().
66 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
67 /// Attempts to send some data from the given slice to the peer.
69 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
70 /// Note that in the disconnected case, socket_disconnected must still fire and further write
71 /// attempts may occur until that time.
73 /// If the returned size is smaller than data.len(), a write_available event must
74 /// trigger the next time more data can be written. Additionally, until the a send_data event
75 /// completes fully, no further read_events should trigger on the same peer!
77 /// If a read_event on this descriptor had previously returned true (indicating that read
78 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
79 /// indicating that read events on this descriptor should resume. A resume_read of false does
80 /// *not* imply that further read events should be paused.
81 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
82 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
83 /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
84 /// this descriptor. No socket_disconnected call should be generated as a result of this call,
85 /// though races may occur whereby disconnect_socket is called after a call to
86 /// socket_disconnected but prior to socket_disconnected returning.
87 fn disconnect_socket(&mut self);
90 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
91 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
93 pub struct PeerHandleError {
94 /// Used to indicate that we probably can't make any future connections to this peer, implying
95 /// we should go ahead and force-close any channels we have with it.
96 pub no_connection_possible: bool,
98 impl fmt::Debug for PeerHandleError {
99 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
100 formatter.write_str("Peer Sent Invalid Data")
103 impl fmt::Display for PeerHandleError {
104 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
105 formatter.write_str("Peer Sent Invalid Data")
108 impl error::Error for PeerHandleError {
109 fn description(&self) -> &str {
110 "Peer Sent Invalid Data"
114 enum InitSyncTracker{
116 ChannelsSyncing(u64),
117 NodesSyncing(PublicKey),
121 channel_encryptor: PeerChannelEncryptor,
123 their_node_id: Option<PublicKey>,
124 their_features: Option<InitFeatures>,
126 pending_outbound_buffer: LinkedList<Vec<u8>>,
127 pending_outbound_buffer_first_msg_offset: usize,
128 awaiting_write_event: bool,
130 pending_read_buffer: Vec<u8>,
131 pending_read_buffer_pos: usize,
132 pending_read_is_header: bool,
134 sync_status: InitSyncTracker,
140 /// Returns true if the channel announcements/updates for the given channel should be
141 /// forwarded to this peer.
142 /// If we are sending our routing table to this peer and we have not yet sent channel
143 /// announcements/updates for the given channel_id then we will send it when we get to that
144 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
145 /// sent the old versions, we should send the update, and so return true here.
146 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
147 match self.sync_status {
148 InitSyncTracker::NoSyncRequested => true,
149 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
150 InitSyncTracker::NodesSyncing(_) => true,
154 /// Similar to the above, but for node announcements indexed by node_id.
155 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
156 match self.sync_status {
157 InitSyncTracker::NoSyncRequested => true,
158 InitSyncTracker::ChannelsSyncing(_) => false,
159 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
164 struct PeerHolder<Descriptor: SocketDescriptor> {
165 peers: HashMap<Descriptor, Peer>,
166 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
167 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
168 peers_needing_send: HashSet<Descriptor>,
169 /// Only add to this set when noise completes:
170 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
173 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
174 fn _check_usize_is_32_or_64() {
175 // See below, less than 32 bit pointers may be unsafe here!
176 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
179 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
180 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
181 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
182 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
183 /// issues such as overly long function definitions.
184 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = Arc<PeerManager<SD, SimpleArcChannelManager<M, T, F, L>, Arc<NetGraphMsgHandler<Arc<C>, Arc<L>>>, Arc<L>>>;
186 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
187 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
188 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
189 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
190 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
191 /// helps with issues such as long function definitions.
192 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>;
194 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
195 /// events into messages which it passes on to its MessageHandlers.
197 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
198 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
199 /// essentially you should default to using a SimpleRefPeerManager, and use a
200 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
201 /// you're using lightning-net-tokio.
202 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
203 CM::Target: ChannelMessageHandler,
204 RM::Target: RoutingMessageHandler,
206 message_handler: MessageHandler<CM, RM>,
207 peers: Mutex<PeerHolder<Descriptor>>,
208 our_node_secret: SecretKey,
209 ephemeral_key_midstate: Sha256Engine,
211 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
212 // bits we will never realistically count into high:
213 peer_counter_low: AtomicUsize,
214 peer_counter_high: AtomicUsize,
219 enum MessageHandlingError {
220 PeerHandleError(PeerHandleError),
221 LightningError(LightningError),
224 impl From<PeerHandleError> for MessageHandlingError {
225 fn from(error: PeerHandleError) -> Self {
226 MessageHandlingError::PeerHandleError(error)
230 impl From<LightningError> for MessageHandlingError {
231 fn from(error: LightningError) -> Self {
232 MessageHandlingError::LightningError(error)
236 macro_rules! encode_msg {
238 let mut buffer = VecWriter(Vec::new());
239 wire::write($msg, &mut buffer).unwrap();
244 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
245 /// PeerIds may repeat, but only after socket_disconnected() has been called.
246 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
247 CM::Target: ChannelMessageHandler,
248 RM::Target: RoutingMessageHandler,
250 /// Constructs a new PeerManager with the given message handlers and node_id secret key
251 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
252 /// cryptographically secure random bytes.
253 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
254 let mut ephemeral_key_midstate = Sha256::engine();
255 ephemeral_key_midstate.input(ephemeral_random_data);
259 peers: Mutex::new(PeerHolder {
260 peers: HashMap::new(),
261 peers_needing_send: HashSet::new(),
262 node_id_to_descriptor: HashMap::new()
265 ephemeral_key_midstate,
266 peer_counter_low: AtomicUsize::new(0),
267 peer_counter_high: AtomicUsize::new(0),
272 /// Get the list of node ids for peers which have completed the initial handshake.
274 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
275 /// new_outbound_connection, however entries will only appear once the initial handshake has
276 /// completed and we are sure the remote peer has the private key for the given node_id.
277 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
278 let peers = self.peers.lock().unwrap();
279 peers.peers.values().filter_map(|p| {
280 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
287 fn get_ephemeral_key(&self) -> SecretKey {
288 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
289 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
290 let high = if low == 0 {
291 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
293 self.peer_counter_high.load(Ordering::Acquire)
295 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
296 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
297 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
300 /// Indicates a new outbound connection has been established to a node with the given node_id.
301 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
302 /// descriptor but must disconnect the connection immediately.
304 /// Returns a small number of bytes to send to the remote node (currently always 50).
306 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
307 /// socket_disconnected().
308 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
309 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
310 let res = peer_encryptor.get_act_one().to_vec();
311 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
313 let mut peers = self.peers.lock().unwrap();
314 if peers.peers.insert(descriptor, Peer {
315 channel_encryptor: peer_encryptor,
318 their_features: None,
320 pending_outbound_buffer: LinkedList::new(),
321 pending_outbound_buffer_first_msg_offset: 0,
322 awaiting_write_event: false,
325 pending_read_buffer_pos: 0,
326 pending_read_is_header: false,
328 sync_status: InitSyncTracker::NoSyncRequested,
330 awaiting_pong: false,
332 panic!("PeerManager driver duplicated descriptors!");
337 /// Indicates a new inbound connection has been established.
339 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
340 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
341 /// call socket_disconnected for the new descriptor but must disconnect the connection
344 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
345 /// socket_disconnected called.
346 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
347 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
348 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
350 let mut peers = self.peers.lock().unwrap();
351 if peers.peers.insert(descriptor, Peer {
352 channel_encryptor: peer_encryptor,
355 their_features: None,
357 pending_outbound_buffer: LinkedList::new(),
358 pending_outbound_buffer_first_msg_offset: 0,
359 awaiting_write_event: false,
362 pending_read_buffer_pos: 0,
363 pending_read_is_header: false,
365 sync_status: InitSyncTracker::NoSyncRequested,
367 awaiting_pong: false,
369 panic!("PeerManager driver duplicated descriptors!");
374 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
375 macro_rules! encode_and_send_msg {
378 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
379 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
383 const MSG_BUFF_SIZE: usize = 10;
384 while !peer.awaiting_write_event {
385 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
386 match peer.sync_status {
387 InitSyncTracker::NoSyncRequested => {},
388 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
389 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
390 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
391 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
392 encode_and_send_msg!(announce);
393 if let &Some(ref update_a) = update_a_option {
394 encode_and_send_msg!(update_a);
396 if let &Some(ref update_b) = update_b_option {
397 encode_and_send_msg!(update_b);
399 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
401 if all_messages.is_empty() || all_messages.len() != steps as usize {
402 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
405 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
406 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
407 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
408 for msg in all_messages.iter() {
409 encode_and_send_msg!(msg);
410 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
412 if all_messages.is_empty() || all_messages.len() != steps as usize {
413 peer.sync_status = InitSyncTracker::NoSyncRequested;
416 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
417 InitSyncTracker::NodesSyncing(key) => {
418 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
419 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
420 for msg in all_messages.iter() {
421 encode_and_send_msg!(msg);
422 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
424 if all_messages.is_empty() || all_messages.len() != steps as usize {
425 peer.sync_status = InitSyncTracker::NoSyncRequested;
432 let next_buff = match peer.pending_outbound_buffer.front() {
437 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
438 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
439 let data_sent = descriptor.send_data(pending, should_be_reading);
440 peer.pending_outbound_buffer_first_msg_offset += data_sent;
441 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
443 peer.pending_outbound_buffer_first_msg_offset = 0;
444 peer.pending_outbound_buffer.pop_front();
446 peer.awaiting_write_event = true;
451 /// Indicates that there is room to write data to the given socket descriptor.
453 /// May return an Err to indicate that the connection should be closed.
455 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
456 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
457 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
458 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
459 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
460 /// new_\*_connection event.
461 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
462 let mut peers = self.peers.lock().unwrap();
463 match peers.peers.get_mut(descriptor) {
464 None => panic!("Descriptor for write_event is not already known to PeerManager"),
466 peer.awaiting_write_event = false;
467 self.do_attempt_write_data(descriptor, peer);
473 /// Indicates that data was read from the given socket descriptor.
475 /// May return an Err to indicate that the connection should be closed.
477 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
478 /// Thus, however, you almost certainly want to call process_events() after any read_event to
479 /// generate send_data calls to handle responses.
481 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
482 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
484 /// Panics if the descriptor was not previously registered in a new_*_connection event.
485 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
486 match self.do_read_event(peer_descriptor, data) {
489 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
495 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
496 fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
497 let mut buffer = VecWriter(Vec::new());
498 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
499 let encoded_message = buffer.0;
501 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
502 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
503 peers_needing_send.insert(descriptor);
506 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
508 let mut peers_lock = self.peers.lock().unwrap();
509 let peers = &mut *peers_lock;
510 let pause_read = match peers.peers.get_mut(peer_descriptor) {
511 None => panic!("Descriptor for read_event is not already known to PeerManager"),
513 assert!(peer.pending_read_buffer.len() > 0);
514 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
516 let mut read_pos = 0;
517 while read_pos < data.len() {
519 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
520 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]);
521 read_pos += data_to_copy;
522 peer.pending_read_buffer_pos += data_to_copy;
525 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
526 peer.pending_read_buffer_pos = 0;
528 macro_rules! try_potential_handleerror {
534 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
535 //TODO: Try to push msg
536 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
537 return Err(PeerHandleError{ no_connection_possible: false });
539 msgs::ErrorAction::IgnoreError => {
540 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
543 msgs::ErrorAction::SendErrorMessage { msg } => {
544 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
545 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
554 macro_rules! insert_node_id {
556 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
557 hash_map::Entry::Occupied(_) => {
558 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
559 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
560 return Err(PeerHandleError{ no_connection_possible: false })
562 hash_map::Entry::Vacant(entry) => {
563 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
564 entry.insert(peer_descriptor.clone())
570 let next_step = peer.channel_encryptor.get_noise_step();
572 NextNoiseStep::ActOne => {
573 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();
574 peer.pending_outbound_buffer.push_back(act_two);
575 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
577 NextNoiseStep::ActTwo => {
578 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
579 peer.pending_outbound_buffer.push_back(act_three.to_vec());
580 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
581 peer.pending_read_is_header = true;
583 peer.their_node_id = Some(their_node_id);
585 let features = InitFeatures::known();
586 let resp = msgs::Init { features };
587 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
589 NextNoiseStep::ActThree => {
590 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
591 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
592 peer.pending_read_is_header = true;
593 peer.their_node_id = Some(their_node_id);
596 NextNoiseStep::NoiseComplete => {
597 if peer.pending_read_is_header {
598 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
599 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
600 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
601 if msg_len < 2 { // Need at least the message type tag
602 return Err(PeerHandleError{ no_connection_possible: false });
604 peer.pending_read_is_header = false;
606 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
607 assert!(msg_data.len() >= 2);
610 peer.pending_read_buffer = [0; 18].to_vec();
611 peer.pending_read_is_header = true;
613 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
614 let message_result = wire::read(&mut reader);
615 let message = match message_result {
619 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
620 msgs::DecodeError::UnknownRequiredFeature => {
621 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
624 msgs::DecodeError::InvalidValue => {
625 log_debug!(self.logger, "Got an invalid value while deserializing message");
626 return Err(PeerHandleError { no_connection_possible: false });
628 msgs::DecodeError::ShortRead => {
629 log_debug!(self.logger, "Deserialization failed due to shortness of message");
630 return Err(PeerHandleError { no_connection_possible: false });
632 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
633 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
638 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message){
639 match handling_error {
640 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
641 MessageHandlingError::LightningError(e) => {
642 try_potential_handleerror!(Err(e));
652 self.do_attempt_write_data(peer_descriptor, peer);
654 peer.pending_outbound_buffer.len() > 10 // pause_read
664 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
665 fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
666 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
668 // Need an Init as first message
669 if let wire::Message::Init(_) = message {
670 } else if peer.their_features.is_none() {
671 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
672 return Err(PeerHandleError{ no_connection_possible: false }.into());
676 // Setup and Control messages:
677 wire::Message::Init(msg) => {
678 if msg.features.requires_unknown_bits() {
679 log_info!(self.logger, "Peer features required unknown version bits");
680 return Err(PeerHandleError{ no_connection_possible: true }.into());
682 if peer.their_features.is_some() {
683 return Err(PeerHandleError{ no_connection_possible: false }.into());
687 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): {}",
688 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
689 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
690 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
691 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
692 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
693 if msg.features.supports_unknown_bits() { "present" } else { "none" }
696 if msg.features.initial_routing_sync() {
697 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
698 peers_needing_send.insert(peer_descriptor.clone());
700 if !msg.features.supports_static_remote_key() {
701 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
702 return Err(PeerHandleError{ no_connection_possible: true }.into());
706 let features = InitFeatures::known();
707 let resp = msgs::Init { features };
708 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
711 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
713 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
714 peer.their_features = Some(msg.features);
716 wire::Message::Error(msg) => {
717 let mut data_is_printable = true;
718 for b in msg.data.bytes() {
719 if b < 32 || b > 126 {
720 data_is_printable = false;
725 if data_is_printable {
726 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
728 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
730 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
731 if msg.channel_id == [0; 32] {
732 return Err(PeerHandleError{ no_connection_possible: true }.into());
736 wire::Message::Ping(msg) => {
737 if msg.ponglen < 65532 {
738 let resp = msgs::Pong { byteslen: msg.ponglen };
739 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
742 wire::Message::Pong(_msg) => {
743 peer.awaiting_pong = false;
747 wire::Message::OpenChannel(msg) => {
748 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
750 wire::Message::AcceptChannel(msg) => {
751 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
754 wire::Message::FundingCreated(msg) => {
755 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
757 wire::Message::FundingSigned(msg) => {
758 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
760 wire::Message::FundingLocked(msg) => {
761 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
764 wire::Message::Shutdown(msg) => {
765 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg);
767 wire::Message::ClosingSigned(msg) => {
768 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
771 // Commitment messages:
772 wire::Message::UpdateAddHTLC(msg) => {
773 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
775 wire::Message::UpdateFulfillHTLC(msg) => {
776 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
778 wire::Message::UpdateFailHTLC(msg) => {
779 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
781 wire::Message::UpdateFailMalformedHTLC(msg) => {
782 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
785 wire::Message::CommitmentSigned(msg) => {
786 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
788 wire::Message::RevokeAndACK(msg) => {
789 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
791 wire::Message::UpdateFee(msg) => {
792 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
794 wire::Message::ChannelReestablish(msg) => {
795 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
799 wire::Message::AnnouncementSignatures(msg) => {
800 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
802 wire::Message::ChannelAnnouncement(msg) => {
803 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
805 Err(e) => { return Err(e.into()); },
809 // TODO: forward msg along to all our other peers!
812 wire::Message::NodeAnnouncement(msg) => {
813 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
815 Err(e) => { return Err(e.into()); },
819 // TODO: forward msg along to all our other peers!
822 wire::Message::ChannelUpdate(msg) => {
823 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
825 Err(e) => { return Err(e.into()); },
829 // TODO: forward msg along to all our other peers!
832 wire::Message::QueryShortChannelIds(msg) => {
833 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
835 wire::Message::ReplyShortChannelIdsEnd(msg) => {
836 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
838 wire::Message::QueryChannelRange(msg) => {
839 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
841 wire::Message::ReplyChannelRange(msg) => {
842 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
844 wire::Message::GossipTimestampFilter(_msg) => {
845 // TODO: handle message
849 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
850 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
851 // Fail the channel if message is an even, unknown type as per BOLT #1.
852 return Err(PeerHandleError{ no_connection_possible: true }.into());
854 wire::Message::Unknown(msg_type) => {
855 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
861 /// Checks for any events generated by our handlers and processes them. Includes sending most
862 /// response messages as well as messages generated by calls to handler functions directly (eg
863 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
864 pub fn process_events(&self) {
866 // TODO: There are some DoS attacks here where you can flood someone's outbound send
867 // buffer by doing things like announcing channels on another node. We should be willing to
868 // drop optional-ish messages when send buffers get full!
870 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
871 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
872 let mut peers_lock = self.peers.lock().unwrap();
873 let peers = &mut *peers_lock;
874 for event in events_generated.drain(..) {
875 macro_rules! get_peer_for_forwarding {
876 ($node_id: expr, $handle_no_such_peer: block) => {
878 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
879 Some(descriptor) => descriptor.clone(),
881 $handle_no_such_peer;
885 match peers.peers.get_mut(&descriptor) {
887 if peer.their_features.is_none() {
888 $handle_no_such_peer;
893 None => panic!("Inconsistent peers set state!"),
899 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
900 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
901 log_pubkey!(node_id),
902 log_bytes!(msg.temporary_channel_id));
903 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
904 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
906 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
907 self.do_attempt_write_data(&mut descriptor, peer);
909 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
910 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
911 log_pubkey!(node_id),
912 log_bytes!(msg.temporary_channel_id));
913 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
914 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
916 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
917 self.do_attempt_write_data(&mut descriptor, peer);
919 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
920 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
921 log_pubkey!(node_id),
922 log_bytes!(msg.temporary_channel_id),
923 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
924 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
925 //TODO: generate a DiscardFunding event indicating to the wallet that
926 //they should just throw away this funding transaction
928 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
929 self.do_attempt_write_data(&mut descriptor, peer);
931 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
932 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
933 log_pubkey!(node_id),
934 log_bytes!(msg.channel_id));
935 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
936 //TODO: generate a DiscardFunding event indicating to the wallet that
937 //they should just throw away this funding transaction
939 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
940 self.do_attempt_write_data(&mut descriptor, peer);
942 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
943 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
944 log_pubkey!(node_id),
945 log_bytes!(msg.channel_id));
946 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
947 //TODO: Do whatever we're gonna do for handling dropped messages
949 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
950 self.do_attempt_write_data(&mut descriptor, peer);
952 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
953 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
954 log_pubkey!(node_id),
955 log_bytes!(msg.channel_id));
956 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
957 //TODO: generate a DiscardFunding event indicating to the wallet that
958 //they should just throw away this funding transaction
960 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
961 self.do_attempt_write_data(&mut descriptor, peer);
963 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 } } => {
964 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
965 log_pubkey!(node_id),
966 update_add_htlcs.len(),
967 update_fulfill_htlcs.len(),
968 update_fail_htlcs.len(),
969 log_bytes!(commitment_signed.channel_id));
970 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
971 //TODO: Do whatever we're gonna do for handling dropped messages
973 for msg in update_add_htlcs {
974 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
976 for msg in update_fulfill_htlcs {
977 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
979 for msg in update_fail_htlcs {
980 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
982 for msg in update_fail_malformed_htlcs {
983 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
985 if let &Some(ref msg) = update_fee {
986 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
988 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
989 self.do_attempt_write_data(&mut descriptor, peer);
991 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
992 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
993 log_pubkey!(node_id),
994 log_bytes!(msg.channel_id));
995 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
996 //TODO: Do whatever we're gonna do for handling dropped messages
998 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
999 self.do_attempt_write_data(&mut descriptor, peer);
1001 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1002 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1003 log_pubkey!(node_id),
1004 log_bytes!(msg.channel_id));
1005 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1006 //TODO: Do whatever we're gonna do for handling dropped messages
1008 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1009 self.do_attempt_write_data(&mut descriptor, peer);
1011 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1012 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1013 log_pubkey!(node_id),
1014 log_bytes!(msg.channel_id));
1015 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1016 //TODO: Do whatever we're gonna do for handling dropped messages
1018 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1019 self.do_attempt_write_data(&mut descriptor, peer);
1021 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1022 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1023 log_pubkey!(node_id),
1024 log_bytes!(msg.channel_id));
1025 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1026 //TODO: Do whatever we're gonna do for handling dropped messages
1028 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1029 self.do_attempt_write_data(&mut descriptor, peer);
1031 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1032 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1033 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1034 let encoded_msg = encode_msg!(msg);
1035 let encoded_update_msg = encode_msg!(update_msg);
1037 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1038 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1039 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1042 match peer.their_node_id {
1044 Some(their_node_id) => {
1045 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1050 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1051 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1052 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1056 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1057 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1058 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1059 let encoded_msg = encode_msg!(msg);
1061 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1062 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1063 !peer.should_forward_node_announcement(msg.contents.node_id) {
1066 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1067 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1071 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1072 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1073 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1074 let encoded_msg = encode_msg!(msg);
1076 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1077 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1078 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1081 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1082 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1086 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1087 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1089 MessageSendEvent::HandleError { ref node_id, ref action } => {
1091 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1092 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1093 peers.peers_needing_send.remove(&descriptor);
1094 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1095 if let Some(ref msg) = *msg {
1096 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1097 log_pubkey!(node_id),
1099 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1100 // This isn't guaranteed to work, but if there is enough free
1101 // room in the send buffer, put the error message there...
1102 self.do_attempt_write_data(&mut descriptor, &mut peer);
1104 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1107 descriptor.disconnect_socket();
1108 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1111 msgs::ErrorAction::IgnoreError => {},
1112 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1113 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1114 log_pubkey!(node_id),
1116 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1117 //TODO: Do whatever we're gonna do for handling dropped messages
1119 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1120 self.do_attempt_write_data(&mut descriptor, peer);
1124 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1125 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1126 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1127 self.do_attempt_write_data(&mut descriptor, peer);
1129 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1130 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1131 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1132 self.do_attempt_write_data(&mut descriptor, peer);
1137 for mut descriptor in peers.peers_needing_send.drain() {
1138 match peers.peers.get_mut(&descriptor) {
1139 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1140 None => panic!("Inconsistent peers set state!"),
1146 /// Indicates that the given socket descriptor's connection is now closed.
1148 /// This must only be called if the socket has been disconnected by the peer or your own
1149 /// decision to disconnect it and must NOT be called in any case where other parts of this
1150 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1153 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1154 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1155 self.disconnect_event_internal(descriptor, false);
1158 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1159 let mut peers = self.peers.lock().unwrap();
1160 peers.peers_needing_send.remove(descriptor);
1161 let peer_option = peers.peers.remove(descriptor);
1163 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1165 match peer.their_node_id {
1167 peers.node_id_to_descriptor.remove(&node_id);
1168 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1176 /// Disconnect a peer given its node id.
1178 /// Set no_connection_possible to true to prevent any further connection with this peer,
1179 /// force-closing any channels we have with it.
1181 /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1182 /// so be careful about reentrancy issues.
1183 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1184 let mut peers_lock = self.peers.lock().unwrap();
1185 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1186 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1187 peers_lock.peers.remove(&descriptor);
1188 peers_lock.peers_needing_send.remove(&descriptor);
1189 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1190 descriptor.disconnect_socket();
1194 /// This function should be called roughly once every 30 seconds.
1195 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1197 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1198 pub fn timer_tick_occured(&self) {
1199 let mut peers_lock = self.peers.lock().unwrap();
1201 let peers = &mut *peers_lock;
1202 let peers_needing_send = &mut peers.peers_needing_send;
1203 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1204 let peers = &mut peers.peers;
1205 let mut descriptors_needing_disconnect = Vec::new();
1207 peers.retain(|descriptor, peer| {
1208 if peer.awaiting_pong {
1209 peers_needing_send.remove(descriptor);
1210 descriptors_needing_disconnect.push(descriptor.clone());
1211 match peer.their_node_id {
1213 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1214 node_id_to_descriptor.remove(&node_id);
1215 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1218 // This can't actually happen as we should have hit
1219 // is_ready_for_encryption() previously on this same peer.
1226 if !peer.channel_encryptor.is_ready_for_encryption() {
1227 // The peer needs to complete its handshake before we can exchange messages
1231 let ping = msgs::Ping {
1235 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1237 let mut descriptor_clone = descriptor.clone();
1238 self.do_attempt_write_data(&mut descriptor_clone, peer);
1240 peer.awaiting_pong = true;
1244 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1245 descriptor.disconnect_socket();
1253 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1256 use util::test_utils;
1258 use bitcoin::secp256k1::Secp256k1;
1259 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1262 use std::sync::{Arc, Mutex};
1263 use std::sync::atomic::Ordering;
1266 struct FileDescriptor {
1268 outbound_data: Arc<Mutex<Vec<u8>>>,
1270 impl PartialEq for FileDescriptor {
1271 fn eq(&self, other: &Self) -> bool {
1275 impl Eq for FileDescriptor { }
1276 impl std::hash::Hash for FileDescriptor {
1277 fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {
1278 self.fd.hash(hasher)
1282 impl SocketDescriptor for FileDescriptor {
1283 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1284 self.outbound_data.lock().unwrap().extend_from_slice(data);
1288 fn disconnect_socket(&mut self) {}
1291 struct PeerManagerCfg {
1292 chan_handler: test_utils::TestChannelMessageHandler,
1293 routing_handler: test_utils::TestRoutingMessageHandler,
1294 logger: test_utils::TestLogger,
1297 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1298 let mut cfgs = Vec::new();
1299 for _ in 0..peer_count {
1302 chan_handler: test_utils::TestChannelMessageHandler::new(),
1303 logger: test_utils::TestLogger::new(),
1304 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1312 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>> {
1313 let mut peers = Vec::new();
1314 for i in 0..peer_count {
1315 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1316 let ephemeral_bytes = [i as u8; 32];
1317 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1318 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1325 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) {
1326 let secp_ctx = Secp256k1::new();
1327 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1328 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1329 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1330 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1331 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1332 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1333 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1334 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1335 (fd_a.clone(), fd_b.clone())
1339 fn test_disconnect_peer() {
1340 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1341 // push a DisconnectPeer event to remove the node flagged by id
1342 let cfgs = create_peermgr_cfgs(2);
1343 let chan_handler = test_utils::TestChannelMessageHandler::new();
1344 let mut peers = create_network(2, &cfgs);
1345 establish_connection(&peers[0], &peers[1]);
1346 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1348 let secp_ctx = Secp256k1::new();
1349 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1351 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1353 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1355 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1356 peers[0].message_handler.chan_handler = &chan_handler;
1358 peers[0].process_events();
1359 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1363 fn test_timer_tick_occurred() {
1364 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1365 let cfgs = create_peermgr_cfgs(2);
1366 let peers = create_network(2, &cfgs);
1367 establish_connection(&peers[0], &peers[1]);
1368 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1370 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1371 peers[0].timer_tick_occured();
1372 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1374 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1375 peers[0].timer_tick_occured();
1376 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1380 fn test_do_attempt_write_data() {
1381 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1382 let cfgs = create_peermgr_cfgs(2);
1383 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1384 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1385 let peers = create_network(2, &cfgs);
1387 // By calling establish_connect, we trigger do_attempt_write_data between
1388 // the peers. Previously this function would mistakenly enter an infinite loop
1389 // when there were more channel messages available than could fit into a peer's
1390 // buffer. This issue would now be detected by this test (because we use custom
1391 // RoutingMessageHandlers that intentionally return more channel messages
1392 // than can fit into a peer's buffer).
1393 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1395 // Make each peer to read the messages that the other peer just wrote to them.
1396 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1397 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1399 // Check that each peer has received the expected number of channel updates and channel
1401 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1402 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1403 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1404 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);