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 core::sync::atomic::{AtomicUsize, Ordering};
36 use core::{cmp, hash, fmt, mem};
40 use bitcoin::hashes::sha256::Hash as Sha256;
41 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
42 use bitcoin::hashes::{HashEngine, Hash};
44 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
45 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
46 pub struct IgnoringMessageHandler{}
47 impl MessageSendEventsProvider for IgnoringMessageHandler {
48 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
50 impl RoutingMessageHandler for IgnoringMessageHandler {
51 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
52 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
53 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
54 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
55 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
56 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
57 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
58 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
59 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
60 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
61 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
62 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
64 impl Deref for IgnoringMessageHandler {
65 type Target = IgnoringMessageHandler;
66 fn deref(&self) -> &Self { self }
69 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
70 /// You can provide one of these as the route_handler in a MessageHandler.
71 pub struct ErroringMessageHandler {
72 message_queue: Mutex<Vec<MessageSendEvent>>
74 impl ErroringMessageHandler {
75 /// Constructs a new ErroringMessageHandler
76 pub fn new() -> Self {
77 Self { message_queue: Mutex::new(Vec::new()) }
79 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
80 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
81 action: msgs::ErrorAction::SendErrorMessage {
82 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
84 node_id: node_id.clone(),
88 impl MessageSendEventsProvider for ErroringMessageHandler {
89 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
90 let mut res = Vec::new();
91 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
95 impl ChannelMessageHandler for ErroringMessageHandler {
96 // Any messages which are related to a specific channel generate an error message to let the
97 // peer know we don't care about channels.
98 fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
99 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
101 fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
102 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
104 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
105 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
107 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
108 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
110 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
111 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
113 fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
114 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
116 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
117 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
119 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
120 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
122 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
123 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
125 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
126 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
128 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
129 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
131 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
132 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
134 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
135 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
137 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
138 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
140 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
141 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
143 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
144 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
146 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
147 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
148 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
149 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
150 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
152 impl Deref for ErroringMessageHandler {
153 type Target = ErroringMessageHandler;
154 fn deref(&self) -> &Self { self }
157 /// Provides references to trait impls which handle different types of messages.
158 pub struct MessageHandler<CM: Deref, RM: Deref> where
159 CM::Target: ChannelMessageHandler,
160 RM::Target: RoutingMessageHandler {
161 /// A message handler which handles messages specific to channels. Usually this is just a
162 /// ChannelManager object or a ErroringMessageHandler.
163 pub chan_handler: CM,
164 /// A message handler which handles messages updating our knowledge of the network channel
165 /// graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
166 pub route_handler: RM,
169 /// Provides an object which can be used to send data to and which uniquely identifies a connection
170 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
171 /// implement Hash to meet the PeerManager API.
173 /// For efficiency, Clone should be relatively cheap for this type.
175 /// You probably want to just extend an int and put a file descriptor in a struct and implement
176 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
177 /// be careful to ensure you don't have races whereby you might register a new connection with an
178 /// fd which is the same as a previous one which has yet to be removed via
179 /// PeerManager::socket_disconnected().
180 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
181 /// Attempts to send some data from the given slice to the peer.
183 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
184 /// Note that in the disconnected case, socket_disconnected must still fire and further write
185 /// attempts may occur until that time.
187 /// If the returned size is smaller than data.len(), a write_available event must
188 /// trigger the next time more data can be written. Additionally, until the a send_data event
189 /// completes fully, no further read_events should trigger on the same peer!
191 /// If a read_event on this descriptor had previously returned true (indicating that read
192 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
193 /// indicating that read events on this descriptor should resume. A resume_read of false does
194 /// *not* imply that further read events should be paused.
195 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
196 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
197 /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
198 /// this descriptor. No socket_disconnected call should be generated as a result of this call,
199 /// though races may occur whereby disconnect_socket is called after a call to
200 /// socket_disconnected but prior to socket_disconnected returning.
201 fn disconnect_socket(&mut self);
204 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
205 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
208 pub struct PeerHandleError {
209 /// Used to indicate that we probably can't make any future connections to this peer, implying
210 /// we should go ahead and force-close any channels we have with it.
211 pub no_connection_possible: bool,
213 impl fmt::Debug for PeerHandleError {
214 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
215 formatter.write_str("Peer Sent Invalid Data")
218 impl fmt::Display for PeerHandleError {
219 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
220 formatter.write_str("Peer Sent Invalid Data")
223 impl error::Error for PeerHandleError {
224 fn description(&self) -> &str {
225 "Peer Sent Invalid Data"
229 enum InitSyncTracker{
231 ChannelsSyncing(u64),
232 NodesSyncing(PublicKey),
236 channel_encryptor: PeerChannelEncryptor,
237 their_node_id: Option<PublicKey>,
238 their_features: Option<InitFeatures>,
240 pending_outbound_buffer: LinkedList<Vec<u8>>,
241 pending_outbound_buffer_first_msg_offset: usize,
242 awaiting_write_event: bool,
244 pending_read_buffer: Vec<u8>,
245 pending_read_buffer_pos: usize,
246 pending_read_is_header: bool,
248 sync_status: InitSyncTracker,
254 /// Returns true if the channel announcements/updates for the given channel should be
255 /// forwarded to this peer.
256 /// If we are sending our routing table to this peer and we have not yet sent channel
257 /// announcements/updates for the given channel_id then we will send it when we get to that
258 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
259 /// sent the old versions, we should send the update, and so return true here.
260 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
261 match self.sync_status {
262 InitSyncTracker::NoSyncRequested => true,
263 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
264 InitSyncTracker::NodesSyncing(_) => true,
268 /// Similar to the above, but for node announcements indexed by node_id.
269 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
270 match self.sync_status {
271 InitSyncTracker::NoSyncRequested => true,
272 InitSyncTracker::ChannelsSyncing(_) => false,
273 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
278 struct PeerHolder<Descriptor: SocketDescriptor> {
279 peers: HashMap<Descriptor, Peer>,
280 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
281 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
282 peers_needing_send: HashSet<Descriptor>,
283 /// Only add to this set when noise completes:
284 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
287 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
288 fn _check_usize_is_32_or_64() {
289 // See below, less than 32 bit pointers may be unsafe here!
290 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
293 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
294 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
295 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
296 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
297 /// issues such as overly long function definitions.
298 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>>;
300 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
301 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
302 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
303 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
304 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
305 /// helps with issues such as long function definitions.
306 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>;
308 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
309 /// events into messages which it passes on to its MessageHandlers.
311 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
312 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
313 /// essentially you should default to using a SimpleRefPeerManager, and use a
314 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
315 /// you're using lightning-net-tokio.
316 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
317 CM::Target: ChannelMessageHandler,
318 RM::Target: RoutingMessageHandler,
320 message_handler: MessageHandler<CM, RM>,
321 peers: Mutex<PeerHolder<Descriptor>>,
322 our_node_secret: SecretKey,
323 ephemeral_key_midstate: Sha256Engine,
325 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
326 // bits we will never realistically count into high:
327 peer_counter_low: AtomicUsize,
328 peer_counter_high: AtomicUsize,
333 enum MessageHandlingError {
334 PeerHandleError(PeerHandleError),
335 LightningError(LightningError),
338 impl From<PeerHandleError> for MessageHandlingError {
339 fn from(error: PeerHandleError) -> Self {
340 MessageHandlingError::PeerHandleError(error)
344 impl From<LightningError> for MessageHandlingError {
345 fn from(error: LightningError) -> Self {
346 MessageHandlingError::LightningError(error)
350 macro_rules! encode_msg {
352 let mut buffer = VecWriter(Vec::new());
353 wire::write($msg, &mut buffer).unwrap();
358 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L> where
359 CM::Target: ChannelMessageHandler,
361 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
362 /// handler is used and network graph messages are ignored.
364 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
365 /// cryptographically secure random bytes.
367 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
368 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
369 Self::new(MessageHandler {
370 chan_handler: channel_message_handler,
371 route_handler: IgnoringMessageHandler{},
372 }, our_node_secret, ephemeral_random_data, logger)
376 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L> where
377 RM::Target: RoutingMessageHandler,
379 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
380 /// handler is used and messages related to channels will be ignored (or generate error
381 /// messages). Note that some other lightning implementations time-out connections after some
382 /// time if no channel is built with the peer.
384 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
385 /// cryptographically secure random bytes.
387 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
388 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
389 Self::new(MessageHandler {
390 chan_handler: ErroringMessageHandler::new(),
391 route_handler: routing_message_handler,
392 }, our_node_secret, ephemeral_random_data, logger)
396 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
397 /// PeerIds may repeat, but only after socket_disconnected() has been called.
398 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
399 CM::Target: ChannelMessageHandler,
400 RM::Target: RoutingMessageHandler,
402 /// Constructs a new PeerManager with the given message handlers and node_id secret key
403 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
404 /// cryptographically secure random bytes.
405 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
406 let mut ephemeral_key_midstate = Sha256::engine();
407 ephemeral_key_midstate.input(ephemeral_random_data);
411 peers: Mutex::new(PeerHolder {
412 peers: HashMap::new(),
413 peers_needing_send: HashSet::new(),
414 node_id_to_descriptor: HashMap::new()
417 ephemeral_key_midstate,
418 peer_counter_low: AtomicUsize::new(0),
419 peer_counter_high: AtomicUsize::new(0),
424 /// Get the list of node ids for peers which have completed the initial handshake.
426 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
427 /// new_outbound_connection, however entries will only appear once the initial handshake has
428 /// completed and we are sure the remote peer has the private key for the given node_id.
429 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
430 let peers = self.peers.lock().unwrap();
431 peers.peers.values().filter_map(|p| {
432 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
439 fn get_ephemeral_key(&self) -> SecretKey {
440 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
441 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
442 let high = if low == 0 {
443 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
445 self.peer_counter_high.load(Ordering::Acquire)
447 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
448 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
449 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
452 /// Indicates a new outbound connection has been established to a node with the given node_id.
453 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
454 /// descriptor but must disconnect the connection immediately.
456 /// Returns a small number of bytes to send to the remote node (currently always 50).
458 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
459 /// socket_disconnected().
460 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
461 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
462 let res = peer_encryptor.get_act_one().to_vec();
463 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
465 let mut peers = self.peers.lock().unwrap();
466 if peers.peers.insert(descriptor, Peer {
467 channel_encryptor: peer_encryptor,
469 their_features: None,
471 pending_outbound_buffer: LinkedList::new(),
472 pending_outbound_buffer_first_msg_offset: 0,
473 awaiting_write_event: false,
476 pending_read_buffer_pos: 0,
477 pending_read_is_header: false,
479 sync_status: InitSyncTracker::NoSyncRequested,
481 awaiting_pong: false,
483 panic!("PeerManager driver duplicated descriptors!");
488 /// Indicates a new inbound connection has been established.
490 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
491 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
492 /// call socket_disconnected for the new descriptor but must disconnect the connection
495 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
496 /// socket_disconnected called.
497 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
498 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
499 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
501 let mut peers = self.peers.lock().unwrap();
502 if peers.peers.insert(descriptor, Peer {
503 channel_encryptor: peer_encryptor,
505 their_features: None,
507 pending_outbound_buffer: LinkedList::new(),
508 pending_outbound_buffer_first_msg_offset: 0,
509 awaiting_write_event: false,
512 pending_read_buffer_pos: 0,
513 pending_read_is_header: false,
515 sync_status: InitSyncTracker::NoSyncRequested,
517 awaiting_pong: false,
519 panic!("PeerManager driver duplicated descriptors!");
524 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
525 macro_rules! encode_and_send_msg {
528 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
529 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
533 const MSG_BUFF_SIZE: usize = 10;
534 while !peer.awaiting_write_event {
535 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
536 match peer.sync_status {
537 InitSyncTracker::NoSyncRequested => {},
538 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
539 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
540 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
541 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
542 encode_and_send_msg!(announce);
543 if let &Some(ref update_a) = update_a_option {
544 encode_and_send_msg!(update_a);
546 if let &Some(ref update_b) = update_b_option {
547 encode_and_send_msg!(update_b);
549 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
551 if all_messages.is_empty() || all_messages.len() != steps as usize {
552 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
555 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
556 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
557 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
558 for msg in all_messages.iter() {
559 encode_and_send_msg!(msg);
560 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
562 if all_messages.is_empty() || all_messages.len() != steps as usize {
563 peer.sync_status = InitSyncTracker::NoSyncRequested;
566 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
567 InitSyncTracker::NodesSyncing(key) => {
568 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
569 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
570 for msg in all_messages.iter() {
571 encode_and_send_msg!(msg);
572 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
574 if all_messages.is_empty() || all_messages.len() != steps as usize {
575 peer.sync_status = InitSyncTracker::NoSyncRequested;
582 let next_buff = match peer.pending_outbound_buffer.front() {
587 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
588 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
589 let data_sent = descriptor.send_data(pending, should_be_reading);
590 peer.pending_outbound_buffer_first_msg_offset += data_sent;
591 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
593 peer.pending_outbound_buffer_first_msg_offset = 0;
594 peer.pending_outbound_buffer.pop_front();
596 peer.awaiting_write_event = true;
601 /// Indicates that there is room to write data to the given socket descriptor.
603 /// May return an Err to indicate that the connection should be closed.
605 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
606 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
607 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
608 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
609 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
610 /// new_\*_connection event.
611 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
612 let mut peers = self.peers.lock().unwrap();
613 match peers.peers.get_mut(descriptor) {
614 None => panic!("Descriptor for write_event is not already known to PeerManager"),
616 peer.awaiting_write_event = false;
617 self.do_attempt_write_data(descriptor, peer);
623 /// Indicates that data was read from the given socket descriptor.
625 /// May return an Err to indicate that the connection should be closed.
627 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
628 /// Thus, however, you almost certainly want to call process_events() after any read_event to
629 /// generate send_data calls to handle responses.
631 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
632 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
634 /// Panics if the descriptor was not previously registered in a new_*_connection event.
635 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
636 match self.do_read_event(peer_descriptor, data) {
639 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
645 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
646 fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
647 let mut buffer = VecWriter(Vec::new());
648 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
649 let encoded_message = buffer.0;
651 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
652 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
653 peers_needing_send.insert(descriptor);
656 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
658 let mut peers_lock = self.peers.lock().unwrap();
659 let peers = &mut *peers_lock;
660 let pause_read = match peers.peers.get_mut(peer_descriptor) {
661 None => panic!("Descriptor for read_event is not already known to PeerManager"),
663 assert!(peer.pending_read_buffer.len() > 0);
664 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
666 let mut read_pos = 0;
667 while read_pos < data.len() {
669 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
670 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]);
671 read_pos += data_to_copy;
672 peer.pending_read_buffer_pos += data_to_copy;
675 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
676 peer.pending_read_buffer_pos = 0;
678 macro_rules! try_potential_handleerror {
684 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
685 //TODO: Try to push msg
686 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
687 return Err(PeerHandleError{ no_connection_possible: false });
689 msgs::ErrorAction::IgnoreError => {
690 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
693 msgs::ErrorAction::SendErrorMessage { msg } => {
694 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
695 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
704 macro_rules! insert_node_id {
706 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
707 hash_map::Entry::Occupied(_) => {
708 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
709 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
710 return Err(PeerHandleError{ no_connection_possible: false })
712 hash_map::Entry::Vacant(entry) => {
713 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
714 entry.insert(peer_descriptor.clone())
720 let next_step = peer.channel_encryptor.get_noise_step();
722 NextNoiseStep::ActOne => {
723 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();
724 peer.pending_outbound_buffer.push_back(act_two);
725 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
727 NextNoiseStep::ActTwo => {
728 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
729 peer.pending_outbound_buffer.push_back(act_three.to_vec());
730 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
731 peer.pending_read_is_header = true;
733 peer.their_node_id = Some(their_node_id);
735 let features = InitFeatures::known();
736 let resp = msgs::Init { features };
737 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
739 NextNoiseStep::ActThree => {
740 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
741 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
742 peer.pending_read_is_header = true;
743 peer.their_node_id = Some(their_node_id);
745 let features = InitFeatures::known();
746 let resp = msgs::Init { features };
747 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
749 NextNoiseStep::NoiseComplete => {
750 if peer.pending_read_is_header {
751 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
752 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
753 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
754 if msg_len < 2 { // Need at least the message type tag
755 return Err(PeerHandleError{ no_connection_possible: false });
757 peer.pending_read_is_header = false;
759 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
760 assert!(msg_data.len() >= 2);
763 peer.pending_read_buffer = [0; 18].to_vec();
764 peer.pending_read_is_header = true;
766 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
767 let message_result = wire::read(&mut reader);
768 let message = match message_result {
772 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
773 msgs::DecodeError::UnknownRequiredFeature => {
774 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
777 msgs::DecodeError::InvalidValue => {
778 log_debug!(self.logger, "Got an invalid value while deserializing message");
779 return Err(PeerHandleError { no_connection_possible: false });
781 msgs::DecodeError::ShortRead => {
782 log_debug!(self.logger, "Deserialization failed due to shortness of message");
783 return Err(PeerHandleError { no_connection_possible: false });
785 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
786 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
787 msgs::DecodeError::UnsupportedCompression => {
788 log_debug!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
795 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message){
796 match handling_error {
797 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
798 MessageHandlingError::LightningError(e) => {
799 try_potential_handleerror!(Err(e));
809 self.do_attempt_write_data(peer_descriptor, peer);
811 peer.pending_outbound_buffer.len() > 10 // pause_read
821 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
822 fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
823 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
825 // Need an Init as first message
826 if let wire::Message::Init(_) = message {
827 } else if peer.their_features.is_none() {
828 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
829 return Err(PeerHandleError{ no_connection_possible: false }.into());
833 // Setup and Control messages:
834 wire::Message::Init(msg) => {
835 if msg.features.requires_unknown_bits() {
836 log_info!(self.logger, "Peer features required unknown version bits");
837 return Err(PeerHandleError{ no_connection_possible: true }.into());
839 if peer.their_features.is_some() {
840 return Err(PeerHandleError{ no_connection_possible: false }.into());
844 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): {}",
845 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
846 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
847 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
848 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
849 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
850 if msg.features.supports_unknown_bits() { "present" } else { "none" }
853 if msg.features.initial_routing_sync() {
854 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
855 peers_needing_send.insert(peer_descriptor.clone());
857 if !msg.features.supports_static_remote_key() {
858 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
859 return Err(PeerHandleError{ no_connection_possible: true }.into());
862 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
864 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
865 peer.their_features = Some(msg.features);
867 wire::Message::Error(msg) => {
868 let mut data_is_printable = true;
869 for b in msg.data.bytes() {
870 if b < 32 || b > 126 {
871 data_is_printable = false;
876 if data_is_printable {
877 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
879 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
881 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
882 if msg.channel_id == [0; 32] {
883 return Err(PeerHandleError{ no_connection_possible: true }.into());
887 wire::Message::Ping(msg) => {
888 if msg.ponglen < 65532 {
889 let resp = msgs::Pong { byteslen: msg.ponglen };
890 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
893 wire::Message::Pong(_msg) => {
894 peer.awaiting_pong = false;
898 wire::Message::OpenChannel(msg) => {
899 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
901 wire::Message::AcceptChannel(msg) => {
902 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
905 wire::Message::FundingCreated(msg) => {
906 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
908 wire::Message::FundingSigned(msg) => {
909 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
911 wire::Message::FundingLocked(msg) => {
912 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
915 wire::Message::Shutdown(msg) => {
916 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
918 wire::Message::ClosingSigned(msg) => {
919 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
922 // Commitment messages:
923 wire::Message::UpdateAddHTLC(msg) => {
924 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
926 wire::Message::UpdateFulfillHTLC(msg) => {
927 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
929 wire::Message::UpdateFailHTLC(msg) => {
930 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
932 wire::Message::UpdateFailMalformedHTLC(msg) => {
933 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
936 wire::Message::CommitmentSigned(msg) => {
937 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
939 wire::Message::RevokeAndACK(msg) => {
940 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
942 wire::Message::UpdateFee(msg) => {
943 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
945 wire::Message::ChannelReestablish(msg) => {
946 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
950 wire::Message::AnnouncementSignatures(msg) => {
951 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
953 wire::Message::ChannelAnnouncement(msg) => {
954 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
956 Err(e) => { return Err(e.into()); },
960 // TODO: forward msg along to all our other peers!
963 wire::Message::NodeAnnouncement(msg) => {
964 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
966 Err(e) => { return Err(e.into()); },
970 // TODO: forward msg along to all our other peers!
973 wire::Message::ChannelUpdate(msg) => {
974 self.message_handler.chan_handler.handle_channel_update(&peer.their_node_id.unwrap(), &msg);
975 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
977 Err(e) => { return Err(e.into()); },
981 // TODO: forward msg along to all our other peers!
984 wire::Message::QueryShortChannelIds(msg) => {
985 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
987 wire::Message::ReplyShortChannelIdsEnd(msg) => {
988 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
990 wire::Message::QueryChannelRange(msg) => {
991 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
993 wire::Message::ReplyChannelRange(msg) => {
994 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
996 wire::Message::GossipTimestampFilter(_msg) => {
997 // TODO: handle message
1000 // Unknown messages:
1001 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
1002 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
1003 // Fail the channel if message is an even, unknown type as per BOLT #1.
1004 return Err(PeerHandleError{ no_connection_possible: true }.into());
1006 wire::Message::Unknown(msg_type) => {
1007 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
1013 /// Checks for any events generated by our handlers and processes them. Includes sending most
1014 /// response messages as well as messages generated by calls to handler functions directly (eg
1015 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
1016 pub fn process_events(&self) {
1018 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1019 // buffer by doing things like announcing channels on another node. We should be willing to
1020 // drop optional-ish messages when send buffers get full!
1022 let mut peers_lock = self.peers.lock().unwrap();
1023 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1024 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1025 let peers = &mut *peers_lock;
1026 for event in events_generated.drain(..) {
1027 macro_rules! get_peer_for_forwarding {
1028 ($node_id: expr, $handle_no_such_peer: block) => {
1030 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
1031 Some(descriptor) => descriptor.clone(),
1033 $handle_no_such_peer;
1037 match peers.peers.get_mut(&descriptor) {
1039 if peer.their_features.is_none() {
1040 $handle_no_such_peer;
1045 None => panic!("Inconsistent peers set state!"),
1051 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1052 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1053 log_pubkey!(node_id),
1054 log_bytes!(msg.temporary_channel_id));
1055 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1056 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1058 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1059 self.do_attempt_write_data(&mut descriptor, peer);
1061 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1062 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1063 log_pubkey!(node_id),
1064 log_bytes!(msg.temporary_channel_id));
1065 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1066 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1068 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1069 self.do_attempt_write_data(&mut descriptor, peer);
1071 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1072 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1073 log_pubkey!(node_id),
1074 log_bytes!(msg.temporary_channel_id),
1075 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1076 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1077 //TODO: generate a DiscardFunding event indicating to the wallet that
1078 //they should just throw away this funding transaction
1080 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1081 self.do_attempt_write_data(&mut descriptor, peer);
1083 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1084 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1085 log_pubkey!(node_id),
1086 log_bytes!(msg.channel_id));
1087 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1088 //TODO: generate a DiscardFunding event indicating to the wallet that
1089 //they should just throw away this funding transaction
1091 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1092 self.do_attempt_write_data(&mut descriptor, peer);
1094 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1095 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1096 log_pubkey!(node_id),
1097 log_bytes!(msg.channel_id));
1098 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1099 //TODO: Do whatever we're gonna do for handling dropped messages
1101 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1102 self.do_attempt_write_data(&mut descriptor, peer);
1104 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1105 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1106 log_pubkey!(node_id),
1107 log_bytes!(msg.channel_id));
1108 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1109 //TODO: generate a DiscardFunding event indicating to the wallet that
1110 //they should just throw away this funding transaction
1112 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1113 self.do_attempt_write_data(&mut descriptor, peer);
1115 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 } } => {
1116 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1117 log_pubkey!(node_id),
1118 update_add_htlcs.len(),
1119 update_fulfill_htlcs.len(),
1120 update_fail_htlcs.len(),
1121 log_bytes!(commitment_signed.channel_id));
1122 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1123 //TODO: Do whatever we're gonna do for handling dropped messages
1125 for msg in update_add_htlcs {
1126 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1128 for msg in update_fulfill_htlcs {
1129 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1131 for msg in update_fail_htlcs {
1132 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1134 for msg in update_fail_malformed_htlcs {
1135 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1137 if let &Some(ref msg) = update_fee {
1138 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1140 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
1141 self.do_attempt_write_data(&mut descriptor, peer);
1143 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1144 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1145 log_pubkey!(node_id),
1146 log_bytes!(msg.channel_id));
1147 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1148 //TODO: Do whatever we're gonna do for handling dropped messages
1150 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1151 self.do_attempt_write_data(&mut descriptor, peer);
1153 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1154 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1155 log_pubkey!(node_id),
1156 log_bytes!(msg.channel_id));
1157 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1158 //TODO: Do whatever we're gonna do for handling dropped messages
1160 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1161 self.do_attempt_write_data(&mut descriptor, peer);
1163 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1164 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1165 log_pubkey!(node_id),
1166 log_bytes!(msg.channel_id));
1167 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1168 //TODO: Do whatever we're gonna do for handling dropped messages
1170 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1171 self.do_attempt_write_data(&mut descriptor, peer);
1173 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1174 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1175 log_pubkey!(node_id),
1176 log_bytes!(msg.channel_id));
1177 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1178 //TODO: Do whatever we're gonna do for handling dropped messages
1180 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1181 self.do_attempt_write_data(&mut descriptor, peer);
1183 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1184 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1185 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1186 let encoded_msg = encode_msg!(msg);
1187 let encoded_update_msg = encode_msg!(update_msg);
1189 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1190 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1191 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1194 match peer.their_node_id {
1196 Some(their_node_id) => {
1197 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1202 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1203 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1204 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1208 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1209 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1210 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1211 let encoded_msg = encode_msg!(msg);
1213 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1214 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1215 !peer.should_forward_node_announcement(msg.contents.node_id) {
1218 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1219 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1223 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1224 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1225 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1226 let encoded_msg = encode_msg!(msg);
1228 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1229 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1230 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1233 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1234 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1238 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1239 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1241 MessageSendEvent::HandleError { ref node_id, ref action } => {
1243 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1244 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1245 peers.peers_needing_send.remove(&descriptor);
1246 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1247 if let Some(ref msg) = *msg {
1248 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1249 log_pubkey!(node_id),
1251 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1252 // This isn't guaranteed to work, but if there is enough free
1253 // room in the send buffer, put the error message there...
1254 self.do_attempt_write_data(&mut descriptor, &mut peer);
1256 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1259 descriptor.disconnect_socket();
1260 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1263 msgs::ErrorAction::IgnoreError => {},
1264 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1265 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1266 log_pubkey!(node_id),
1268 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1269 //TODO: Do whatever we're gonna do for handling dropped messages
1271 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1272 self.do_attempt_write_data(&mut descriptor, peer);
1276 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1277 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1278 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1279 self.do_attempt_write_data(&mut descriptor, peer);
1281 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1282 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1283 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1284 self.do_attempt_write_data(&mut descriptor, peer);
1286 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1287 log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1288 log_pubkey!(node_id),
1289 msg.short_channel_ids.len(),
1291 msg.number_of_blocks,
1293 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1294 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1295 self.do_attempt_write_data(&mut descriptor, peer);
1300 for mut descriptor in peers.peers_needing_send.drain() {
1301 match peers.peers.get_mut(&descriptor) {
1302 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1303 None => panic!("Inconsistent peers set state!"),
1309 /// Indicates that the given socket descriptor's connection is now closed.
1311 /// This must only be called if the socket has been disconnected by the peer or your own
1312 /// decision to disconnect it and must NOT be called in any case where other parts of this
1313 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1316 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1317 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1318 self.disconnect_event_internal(descriptor, false);
1321 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1322 let mut peers = self.peers.lock().unwrap();
1323 peers.peers_needing_send.remove(descriptor);
1324 let peer_option = peers.peers.remove(descriptor);
1326 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1328 match peer.their_node_id {
1330 peers.node_id_to_descriptor.remove(&node_id);
1331 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1339 /// Disconnect a peer given its node id.
1341 /// Set no_connection_possible to true to prevent any further connection with this peer,
1342 /// force-closing any channels we have with it.
1344 /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1345 /// so be careful about reentrancy issues.
1346 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1347 let mut peers_lock = self.peers.lock().unwrap();
1348 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1349 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1350 peers_lock.peers.remove(&descriptor);
1351 peers_lock.peers_needing_send.remove(&descriptor);
1352 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1353 descriptor.disconnect_socket();
1357 /// This function should be called roughly once every 30 seconds.
1358 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1360 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1361 pub fn timer_tick_occurred(&self) {
1362 let mut peers_lock = self.peers.lock().unwrap();
1364 let peers = &mut *peers_lock;
1365 let peers_needing_send = &mut peers.peers_needing_send;
1366 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1367 let peers = &mut peers.peers;
1368 let mut descriptors_needing_disconnect = Vec::new();
1370 peers.retain(|descriptor, peer| {
1371 if peer.awaiting_pong {
1372 peers_needing_send.remove(descriptor);
1373 descriptors_needing_disconnect.push(descriptor.clone());
1374 match peer.their_node_id {
1376 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1377 node_id_to_descriptor.remove(&node_id);
1378 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1381 // This can't actually happen as we should have hit
1382 // is_ready_for_encryption() previously on this same peer.
1389 if !peer.channel_encryptor.is_ready_for_encryption() {
1390 // The peer needs to complete its handshake before we can exchange messages
1394 let ping = msgs::Ping {
1398 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1400 let mut descriptor_clone = descriptor.clone();
1401 self.do_attempt_write_data(&mut descriptor_clone, peer);
1403 peer.awaiting_pong = true;
1407 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1408 descriptor.disconnect_socket();
1416 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1419 use util::test_utils;
1421 use bitcoin::secp256k1::Secp256k1;
1422 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1424 use std::sync::{Arc, Mutex};
1425 use core::sync::atomic::Ordering;
1428 struct FileDescriptor {
1430 outbound_data: Arc<Mutex<Vec<u8>>>,
1432 impl PartialEq for FileDescriptor {
1433 fn eq(&self, other: &Self) -> bool {
1437 impl Eq for FileDescriptor { }
1438 impl core::hash::Hash for FileDescriptor {
1439 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1440 self.fd.hash(hasher)
1444 impl SocketDescriptor for FileDescriptor {
1445 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1446 self.outbound_data.lock().unwrap().extend_from_slice(data);
1450 fn disconnect_socket(&mut self) {}
1453 struct PeerManagerCfg {
1454 chan_handler: test_utils::TestChannelMessageHandler,
1455 routing_handler: test_utils::TestRoutingMessageHandler,
1456 logger: test_utils::TestLogger,
1459 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1460 let mut cfgs = Vec::new();
1461 for _ in 0..peer_count {
1464 chan_handler: test_utils::TestChannelMessageHandler::new(),
1465 logger: test_utils::TestLogger::new(),
1466 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1474 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>> {
1475 let mut peers = Vec::new();
1476 for i in 0..peer_count {
1477 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1478 let ephemeral_bytes = [i as u8; 32];
1479 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1480 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1487 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) {
1488 let secp_ctx = Secp256k1::new();
1489 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1490 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1491 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1492 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1493 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1494 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1495 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1496 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1497 (fd_a.clone(), fd_b.clone())
1501 fn test_disconnect_peer() {
1502 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1503 // push a DisconnectPeer event to remove the node flagged by id
1504 let cfgs = create_peermgr_cfgs(2);
1505 let chan_handler = test_utils::TestChannelMessageHandler::new();
1506 let mut peers = create_network(2, &cfgs);
1507 establish_connection(&peers[0], &peers[1]);
1508 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1510 let secp_ctx = Secp256k1::new();
1511 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1513 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1515 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1517 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1518 peers[0].message_handler.chan_handler = &chan_handler;
1520 peers[0].process_events();
1521 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1525 fn test_timer_tick_occurred() {
1526 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1527 let cfgs = create_peermgr_cfgs(2);
1528 let peers = create_network(2, &cfgs);
1529 establish_connection(&peers[0], &peers[1]);
1530 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1532 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1533 peers[0].timer_tick_occurred();
1534 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1536 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1537 peers[0].timer_tick_occurred();
1538 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1542 fn test_do_attempt_write_data() {
1543 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1544 let cfgs = create_peermgr_cfgs(2);
1545 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1546 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1547 let peers = create_network(2, &cfgs);
1549 // By calling establish_connect, we trigger do_attempt_write_data between
1550 // the peers. Previously this function would mistakenly enter an infinite loop
1551 // when there were more channel messages available than could fit into a peer's
1552 // buffer. This issue would now be detected by this test (because we use custom
1553 // RoutingMessageHandlers that intentionally return more channel messages
1554 // than can fit into a peer's buffer).
1555 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1557 // Make each peer to read the messages that the other peer just wrote to them.
1558 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1559 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1561 // Check that each peer has received the expected number of channel updates and channel
1563 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1564 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1565 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1566 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);