_ Git - rust-lightning/blob - lightning/src/ln/peer_handler.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! Top level peer message handling and socket handling logic lives here.
  11 //!
  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.
  17
  18 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
  19
  20 use ln::features::InitFeatures;
  21 use ln::msgs;
  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};
  26 use ln::wire;
  27 use ln::wire::Encode;
  28 use util::byte_utils;
  29 use util::events::{MessageSendEvent, MessageSendEventsProvider};
  30 use util::logger::Logger;
  31 use routing::network_graph::NetGraphMsgHandler;
  32
  33 use prelude::*;
  34 use alloc::collections::LinkedList;
  35 use std::sync::{Arc, Mutex};
  36 use core::sync::atomic::{AtomicUsize, Ordering};
  37 use core::{cmp, hash, fmt, mem};
  38 use core::ops::Deref;
  39 use std::error;
  40
  41 use bitcoin::hashes::sha256::Hash as Sha256;
  42 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
  43 use bitcoin::hashes::{HashEngine, Hash};
  44
  45 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
  46 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
  47 pub struct IgnoringMessageHandler{}
  48 impl MessageSendEventsProvider for IgnoringMessageHandler {
  49         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
  50 }
  51 impl RoutingMessageHandler for IgnoringMessageHandler {
  52         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  53         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  54         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
  55         fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
  56         fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
  57                 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
  58         fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
  59         fn sync_routing_table(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
  60         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
  61         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
  62         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
  63         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
  64 }
  65 impl Deref for IgnoringMessageHandler {
  66         type Target = IgnoringMessageHandler;
  67         fn deref(&self) -> &Self { self }
  68 }
  69
  70 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
  71 /// You can provide one of these as the route_handler in a MessageHandler.
  72 pub struct ErroringMessageHandler {
  73         message_queue: Mutex<Vec<MessageSendEvent>>
  74 }
  75 impl ErroringMessageHandler {
  76         /// Constructs a new ErroringMessageHandler
  77         pub fn new() -> Self {
  78                 Self { message_queue: Mutex::new(Vec::new()) }
  79         }
  80         fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
  81                 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
  82                         action: msgs::ErrorAction::SendErrorMessage {
  83                                 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
  84                         },
  85                         node_id: node_id.clone(),
  86                 });
  87         }
  88 }
  89 impl MessageSendEventsProvider for ErroringMessageHandler {
  90         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
  91                 let mut res = Vec::new();
  92                 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
  93                 res
  94         }
  95 }
  96 impl ChannelMessageHandler for ErroringMessageHandler {
  97         // Any messages which are related to a specific channel generate an error message to let the
  98         // peer know we don't care about channels.
  99         fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
 100                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 101         }
 102         fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
 103                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 104         }
 105         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
 106                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 107         }
 108         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
 109                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 110         }
 111         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
 112                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 113         }
 114         fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
 115                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 116         }
 117         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
 118                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 119         }
 120         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
 121                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 122         }
 123         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
 124                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 125         }
 126         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
 127                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 128         }
 129         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
 130                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 131         }
 132         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
 133                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 134         }
 135         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
 136                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 137         }
 138         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
 139                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 140         }
 141         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
 142                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 143         }
 144         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
 145                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 146         }
 147         // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
 148         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
 149         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
 150         fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
 151         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
 152 }
 153 impl Deref for ErroringMessageHandler {
 154         type Target = ErroringMessageHandler;
 155         fn deref(&self) -> &Self { self }
 156 }
 157
 158 /// Provides references to trait impls which handle different types of messages.
 159 pub struct MessageHandler<CM: Deref, RM: Deref> where
 160                 CM::Target: ChannelMessageHandler,
 161                 RM::Target: RoutingMessageHandler {
 162         /// A message handler which handles messages specific to channels. Usually this is just a
 163         /// ChannelManager object or a ErroringMessageHandler.
 164         pub chan_handler: CM,
 165         /// A message handler which handles messages updating our knowledge of the network channel
 166         /// graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
 167         pub route_handler: RM,
 168 }
 169
 170 /// Provides an object which can be used to send data to and which uniquely identifies a connection
 171 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
 172 /// implement Hash to meet the PeerManager API.
 173 ///
 174 /// For efficiency, Clone should be relatively cheap for this type.
 175 ///
 176 /// You probably want to just extend an int and put a file descriptor in a struct and implement
 177 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
 178 /// be careful to ensure you don't have races whereby you might register a new connection with an
 179 /// fd which is the same as a previous one which has yet to be removed via
 180 /// PeerManager::socket_disconnected().
 181 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
 182         /// Attempts to send some data from the given slice to the peer.
 183         ///
 184         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
 185         /// Note that in the disconnected case, socket_disconnected must still fire and further write
 186         /// attempts may occur until that time.
 187         ///
 188         /// If the returned size is smaller than data.len(), a write_available event must
 189         /// trigger the next time more data can be written. Additionally, until the a send_data event
 190         /// completes fully, no further read_events should trigger on the same peer!
 191         ///
 192         /// If a read_event on this descriptor had previously returned true (indicating that read
 193         /// events should be paused to prevent DoS in the send buffer), resume_read may be set
 194         /// indicating that read events on this descriptor should resume. A resume_read of false does
 195         /// *not* imply that further read events should be paused.
 196         fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
 197         /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
 198         /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
 199         /// this descriptor. No socket_disconnected call should be generated as a result of this call,
 200         /// though races may occur whereby disconnect_socket is called after a call to
 201         /// socket_disconnected but prior to socket_disconnected returning.
 202         fn disconnect_socket(&mut self);
 203 }
 204
 205 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
 206 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
 207 /// descriptor.
 208 #[derive(Clone)]
 209 pub struct PeerHandleError {
 210         /// Used to indicate that we probably can't make any future connections to this peer, implying
 211         /// we should go ahead and force-close any channels we have with it.
 212         pub no_connection_possible: bool,
 213 }
 214 impl fmt::Debug for PeerHandleError {
 215         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 216                 formatter.write_str("Peer Sent Invalid Data")
 217         }
 218 }
 219 impl fmt::Display for PeerHandleError {
 220         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 221                 formatter.write_str("Peer Sent Invalid Data")
 222         }
 223 }
 224 impl error::Error for PeerHandleError {
 225         fn description(&self) -> &str {
 226                 "Peer Sent Invalid Data"
 227         }
 228 }
 229
 230 enum InitSyncTracker{
 231         NoSyncRequested,
 232         ChannelsSyncing(u64),
 233         NodesSyncing(PublicKey),
 234 }
 235
 236 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
 237 /// we have fewer than this many messages in the outbound buffer again.
 238 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
 239 /// refilled as we send bytes.
 240 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 10;
 241 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
 242 /// the peer.
 243 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = 20;
 244
 245 struct Peer {
 246         channel_encryptor: PeerChannelEncryptor,
 247         their_node_id: Option<PublicKey>,
 248         their_features: Option<InitFeatures>,
 249
 250         pending_outbound_buffer: LinkedList<Vec<u8>>,
 251         pending_outbound_buffer_first_msg_offset: usize,
 252         awaiting_write_event: bool,
 253
 254         pending_read_buffer: Vec<u8>,
 255         pending_read_buffer_pos: usize,
 256         pending_read_is_header: bool,
 257
 258         sync_status: InitSyncTracker,
 259
 260         awaiting_pong: bool,
 261 }
 262
 263 impl Peer {
 264         /// Returns true if the channel announcements/updates for the given channel should be
 265         /// forwarded to this peer.
 266         /// If we are sending our routing table to this peer and we have not yet sent channel
 267         /// announcements/updates for the given channel_id then we will send it when we get to that
 268         /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
 269         /// sent the old versions, we should send the update, and so return true here.
 270         fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
 271                 match self.sync_status {
 272                         InitSyncTracker::NoSyncRequested => true,
 273                         InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
 274                         InitSyncTracker::NodesSyncing(_) => true,
 275                 }
 276         }
 277
 278         /// Similar to the above, but for node announcements indexed by node_id.
 279         fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
 280                 match self.sync_status {
 281                         InitSyncTracker::NoSyncRequested => true,
 282                         InitSyncTracker::ChannelsSyncing(_) => false,
 283                         InitSyncTracker::NodesSyncing(pk) => pk < node_id,
 284                 }
 285         }
 286 }
 287
 288 struct PeerHolder<Descriptor: SocketDescriptor> {
 289         peers: HashMap<Descriptor, Peer>,
 290         /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
 291         /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
 292         peers_needing_send: HashSet<Descriptor>,
 293         /// Only add to this set when noise completes:
 294         node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
 295 }
 296
 297 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
 298 fn _check_usize_is_32_or_64() {
 299         // See below, less than 32 bit pointers may be unsafe here!
 300         unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
 301 }
 302
 303 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
 304 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
 305 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
 306 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
 307 /// issues such as overly long function definitions.
 308 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>>;
 309
 310 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
 311 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
 312 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
 313 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
 314 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
 315 /// helps with issues such as long function definitions.
 316 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>;
 317
 318 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
 319 /// events into messages which it passes on to its MessageHandlers.
 320 ///
 321 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
 322 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
 323 /// essentially you should default to using a SimpleRefPeerManager, and use a
 324 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
 325 /// you're using lightning-net-tokio.
 326 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
 327                 CM::Target: ChannelMessageHandler,
 328                 RM::Target: RoutingMessageHandler,
 329                 L::Target: Logger {
 330         message_handler: MessageHandler<CM, RM>,
 331         peers: Mutex<PeerHolder<Descriptor>>,
 332         our_node_secret: SecretKey,
 333         ephemeral_key_midstate: Sha256Engine,
 334
 335         // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
 336         // bits we will never realistically count into high:
 337         peer_counter_low: AtomicUsize,
 338         peer_counter_high: AtomicUsize,
 339
 340         logger: L,
 341 }
 342
 343 enum MessageHandlingError {
 344         PeerHandleError(PeerHandleError),
 345         LightningError(LightningError),
 346 }
 347
 348 impl From<PeerHandleError> for MessageHandlingError {
 349         fn from(error: PeerHandleError) -> Self {
 350                 MessageHandlingError::PeerHandleError(error)
 351         }
 352 }
 353
 354 impl From<LightningError> for MessageHandlingError {
 355         fn from(error: LightningError) -> Self {
 356                 MessageHandlingError::LightningError(error)
 357         }
 358 }
 359
 360 macro_rules! encode_msg {
 361         ($msg: expr) => {{
 362                 let mut buffer = VecWriter(Vec::new());
 363                 wire::write($msg, &mut buffer).unwrap();
 364                 buffer.0
 365         }}
 366 }
 367
 368 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L> where
 369                 CM::Target: ChannelMessageHandler,
 370                 L::Target: Logger {
 371         /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
 372         /// handler is used and network graph messages are ignored.
 373         ///
 374         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 375         /// cryptographically secure random bytes.
 376         ///
 377         /// (C-not exported) as we can't export a PeerManager with a dummy route handler
 378         pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 379                 Self::new(MessageHandler {
 380                         chan_handler: channel_message_handler,
 381                         route_handler: IgnoringMessageHandler{},
 382                 }, our_node_secret, ephemeral_random_data, logger)
 383         }
 384 }
 385
 386 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L> where
 387                 RM::Target: RoutingMessageHandler,
 388                 L::Target: Logger {
 389         /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
 390         /// handler is used and messages related to channels will be ignored (or generate error
 391         /// messages). Note that some other lightning implementations time-out connections after some
 392         /// time if no channel is built with the peer.
 393         ///
 394         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 395         /// cryptographically secure random bytes.
 396         ///
 397         /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
 398         pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 399                 Self::new(MessageHandler {
 400                         chan_handler: ErroringMessageHandler::new(),
 401                         route_handler: routing_message_handler,
 402                 }, our_node_secret, ephemeral_random_data, logger)
 403         }
 404 }
 405
 406 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
 407 /// PeerIds may repeat, but only after socket_disconnected() has been called.
 408 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
 409                 CM::Target: ChannelMessageHandler,
 410                 RM::Target: RoutingMessageHandler,
 411                 L::Target: Logger {
 412         /// Constructs a new PeerManager with the given message handlers and node_id secret key
 413         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 414         /// cryptographically secure random bytes.
 415         pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 416                 let mut ephemeral_key_midstate = Sha256::engine();
 417                 ephemeral_key_midstate.input(ephemeral_random_data);
 418
 419                 PeerManager {
 420                         message_handler,
 421                         peers: Mutex::new(PeerHolder {
 422                                 peers: HashMap::new(),
 423                                 peers_needing_send: HashSet::new(),
 424                                 node_id_to_descriptor: HashMap::new()
 425                         }),
 426                         our_node_secret,
 427                         ephemeral_key_midstate,
 428                         peer_counter_low: AtomicUsize::new(0),
 429                         peer_counter_high: AtomicUsize::new(0),
 430                         logger,
 431                 }
 432         }
 433
 434         /// Get the list of node ids for peers which have completed the initial handshake.
 435         ///
 436         /// For outbound connections, this will be the same as the their_node_id parameter passed in to
 437         /// new_outbound_connection, however entries will only appear once the initial handshake has
 438         /// completed and we are sure the remote peer has the private key for the given node_id.
 439         pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
 440                 let peers = self.peers.lock().unwrap();
 441                 peers.peers.values().filter_map(|p| {
 442                         if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
 443                                 return None;
 444                         }
 445                         p.their_node_id
 446                 }).collect()
 447         }
 448
 449         fn get_ephemeral_key(&self) -> SecretKey {
 450                 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 451                 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
 452                 let high = if low == 0 {
 453                         self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
 454                 } else {
 455                         self.peer_counter_high.load(Ordering::Acquire)
 456                 };
 457                 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
 458                 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
 459                 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
 460         }
 461
 462         /// Indicates a new outbound connection has been established to a node with the given node_id.
 463         /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
 464         /// descriptor but must disconnect the connection immediately.
 465         ///
 466         /// Returns a small number of bytes to send to the remote node (currently always 50).
 467         ///
 468         /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
 469         /// socket_disconnected().
 470         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
 471                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
 472                 let res = peer_encryptor.get_act_one().to_vec();
 473                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
 474
 475                 let mut peers = self.peers.lock().unwrap();
 476                 if peers.peers.insert(descriptor, Peer {
 477                         channel_encryptor: peer_encryptor,
 478                         their_node_id: None,
 479                         their_features: None,
 480
 481                         pending_outbound_buffer: LinkedList::new(),
 482                         pending_outbound_buffer_first_msg_offset: 0,
 483                         awaiting_write_event: false,
 484
 485                         pending_read_buffer,
 486                         pending_read_buffer_pos: 0,
 487                         pending_read_is_header: false,
 488
 489                         sync_status: InitSyncTracker::NoSyncRequested,
 490
 491                         awaiting_pong: false,
 492                 }).is_some() {
 493                         panic!("PeerManager driver duplicated descriptors!");
 494                 };
 495                 Ok(res)
 496         }
 497
 498         /// Indicates a new inbound connection has been established.
 499         ///
 500         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
 501         /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
 502         /// call socket_disconnected for the new descriptor but must disconnect the connection
 503         /// immediately.
 504         ///
 505         /// Panics if descriptor is duplicative with some other descriptor which has not yet had
 506         /// socket_disconnected called.
 507         pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
 508                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
 509                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
 510
 511                 let mut peers = self.peers.lock().unwrap();
 512                 if peers.peers.insert(descriptor, Peer {
 513                         channel_encryptor: peer_encryptor,
 514                         their_node_id: None,
 515                         their_features: None,
 516
 517                         pending_outbound_buffer: LinkedList::new(),
 518                         pending_outbound_buffer_first_msg_offset: 0,
 519                         awaiting_write_event: false,
 520
 521                         pending_read_buffer,
 522                         pending_read_buffer_pos: 0,
 523                         pending_read_is_header: false,
 524
 525                         sync_status: InitSyncTracker::NoSyncRequested,
 526
 527                         awaiting_pong: false,
 528                 }).is_some() {
 529                         panic!("PeerManager driver duplicated descriptors!");
 530                 };
 531                 Ok(())
 532         }
 533
 534         fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
 535                 macro_rules! encode_and_send_msg {
 536                         ($msg: expr) => {
 537                                 {
 538                                         log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
 539                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
 540                                 }
 541                         }
 542                 }
 543                 while !peer.awaiting_write_event {
 544                         if peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE {
 545                                 match peer.sync_status {
 546                                         InitSyncTracker::NoSyncRequested => {},
 547                                         InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
 548                                                 let steps = ((OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
 549                                                 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
 550                                                 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
 551                                                         encode_and_send_msg!(announce);
 552                                                         if let &Some(ref update_a) = update_a_option {
 553                                                                 encode_and_send_msg!(update_a);
 554                                                         }
 555                                                         if let &Some(ref update_b) = update_b_option {
 556                                                                 encode_and_send_msg!(update_b);
 557                                                         }
 558                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
 559                                                 }
 560                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 561                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
 562                                                 }
 563                                         },
 564                                         InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
 565                                                 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
 566                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
 567                                                 for msg in all_messages.iter() {
 568                                                         encode_and_send_msg!(msg);
 569                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 570                                                 }
 571                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 572                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 573                                                 }
 574                                         },
 575                                         InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
 576                                         InitSyncTracker::NodesSyncing(key) => {
 577                                                 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
 578                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
 579                                                 for msg in all_messages.iter() {
 580                                                         encode_and_send_msg!(msg);
 581                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 582                                                 }
 583                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 584                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 585                                                 }
 586                                         },
 587                                 }
 588                         }
 589
 590                         if {
 591                                 let next_buff = match peer.pending_outbound_buffer.front() {
 592                                         None => return,
 593                                         Some(buff) => buff,
 594                                 };
 595
 596                                 let should_be_reading = peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
 597                                 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
 598                                 let data_sent = descriptor.send_data(pending, should_be_reading);
 599                                 peer.pending_outbound_buffer_first_msg_offset += data_sent;
 600                                 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
 601                         } {
 602                                 peer.pending_outbound_buffer_first_msg_offset = 0;
 603                                 peer.pending_outbound_buffer.pop_front();
 604                         } else {
 605                                 peer.awaiting_write_event = true;
 606                         }
 607                 }
 608         }
 609
 610         /// Indicates that there is room to write data to the given socket descriptor.
 611         ///
 612         /// May return an Err to indicate that the connection should be closed.
 613         ///
 614         /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
 615         /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
 616         /// invariants around calling write_buffer_space_avail in case a write did not fully complete
 617         /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
 618         /// here isn't sufficient! Panics if the descriptor was not previously registered in a
 619         /// new_\*_connection event.
 620         pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
 621                 let mut peers = self.peers.lock().unwrap();
 622                 match peers.peers.get_mut(descriptor) {
 623                         None => panic!("Descriptor for write_event is not already known to PeerManager"),
 624                         Some(peer) => {
 625                                 peer.awaiting_write_event = false;
 626                                 self.do_attempt_write_data(descriptor, peer);
 627                         }
 628                 };
 629                 Ok(())
 630         }
 631
 632         /// Indicates that data was read from the given socket descriptor.
 633         ///
 634         /// May return an Err to indicate that the connection should be closed.
 635         ///
 636         /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
 637         /// Thus, however, you almost certainly want to call process_events() after any read_event to
 638         /// generate send_data calls to handle responses.
 639         ///
 640         /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
 641         /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
 642         ///
 643         /// Panics if the descriptor was not previously registered in a new_*_connection event.
 644         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 645                 match self.do_read_event(peer_descriptor, data) {
 646                         Ok(res) => Ok(res),
 647                         Err(e) => {
 648                                 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
 649                                 Err(e)
 650                         }
 651                 }
 652         }
 653
 654         /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
 655         fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
 656                 let mut buffer = VecWriter(Vec::new());
 657                 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
 658                 let encoded_message = buffer.0;
 659
 660                 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
 661                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
 662                 peers_needing_send.insert(descriptor);
 663         }
 664
 665         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 666                 let pause_read = {
 667                         let mut peers_lock = self.peers.lock().unwrap();
 668                         let peers = &mut *peers_lock;
 669                         let mut msgs_to_forward = Vec::new();
 670                         let mut peer_node_id = None;
 671                         let pause_read = match peers.peers.get_mut(peer_descriptor) {
 672                                 None => panic!("Descriptor for read_event is not already known to PeerManager"),
 673                                 Some(peer) => {
 674                                         assert!(peer.pending_read_buffer.len() > 0);
 675                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 676
 677                                         let mut read_pos = 0;
 678                                         while read_pos < data.len() {
 679                                                 {
 680                                                         let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
 681                                                         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]);
 682                                                         read_pos += data_to_copy;
 683                                                         peer.pending_read_buffer_pos += data_to_copy;
 684                                                 }
 685
 686                                                 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
 687                                                         peer.pending_read_buffer_pos = 0;
 688
 689                                                         macro_rules! try_potential_handleerror {
 690                                                                 ($thing: expr) => {
 691                                                                         match $thing {
 692                                                                                 Ok(x) => x,
 693                                                                                 Err(e) => {
 694                                                                                         match e.action {
 695                                                                                                 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
 696                                                                                                         //TODO: Try to push msg
 697                                                                                                         log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
 698                                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 699                                                                                                 },
 700                                                                                                 msgs::ErrorAction::IgnoreError => {
 701                                                                                                         log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
 702                                                                                                         continue;
 703                                                                                                 },
 704                                                                                                 msgs::ErrorAction::SendErrorMessage { msg } => {
 705                                                                                                         log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
 706                                                                                                         self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
 707                                                                                                         continue;
 708                                                                                                 },
 709                                                                                         }
 710                                                                                 }
 711                                                                         };
 712                                                                 }
 713                                                         }
 714
 715                                                         macro_rules! insert_node_id {
 716                                                                 () => {
 717                                                                         match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
 718                                                                                 hash_map::Entry::Occupied(_) => {
 719                                                                                         log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
 720                                                                                         peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
 721                                                                                         return Err(PeerHandleError{ no_connection_possible: false })
 722                                                                                 },
 723                                                                                 hash_map::Entry::Vacant(entry) => {
 724                                                                                         log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
 725                                                                                         entry.insert(peer_descriptor.clone())
 726                                                                                 },
 727                                                                         };
 728                                                                 }
 729                                                         }
 730
 731                                                         let next_step = peer.channel_encryptor.get_noise_step();
 732                                                         match next_step {
 733                                                                 NextNoiseStep::ActOne => {
 734                                                                         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();
 735                                                                         peer.pending_outbound_buffer.push_back(act_two);
 736                                                                         peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
 737                                                                 },
 738                                                                 NextNoiseStep::ActTwo => {
 739                                                                         let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
 740                                                                         peer.pending_outbound_buffer.push_back(act_three.to_vec());
 741                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 742                                                                         peer.pending_read_is_header = true;
 743
 744                                                                         peer.their_node_id = Some(their_node_id);
 745                                                                         insert_node_id!();
 746                                                                         let features = InitFeatures::known();
 747                                                                         let resp = msgs::Init { features };
 748                                                                         self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
 749                                                                 },
 750                                                                 NextNoiseStep::ActThree => {
 751                                                                         let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
 752                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 753                                                                         peer.pending_read_is_header = true;
 754                                                                         peer.their_node_id = Some(their_node_id);
 755                                                                         insert_node_id!();
 756                                                                         let features = InitFeatures::known();
 757                                                                         let resp = msgs::Init { features };
 758                                                                         self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
 759                                                                 },
 760                                                                 NextNoiseStep::NoiseComplete => {
 761                                                                         if peer.pending_read_is_header {
 762                                                                                 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
 763                                                                                 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
 764                                                                                 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
 765                                                                                 if msg_len < 2 { // Need at least the message type tag
 766                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 767                                                                                 }
 768                                                                                 peer.pending_read_is_header = false;
 769                                                                         } else {
 770                                                                                 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
 771                                                                                 assert!(msg_data.len() >= 2);
 772
 773                                                                                 // Reset read buffer
 774                                                                                 peer.pending_read_buffer = [0; 18].to_vec();
 775                                                                                 peer.pending_read_is_header = true;
 776
 777                                                                                 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
 778                                                                                 let message_result = wire::read(&mut reader);
 779                                                                                 let message = match message_result {
 780                                                                                         Ok(x) => x,
 781                                                                                         Err(e) => {
 782                                                                                                 match e {
 783                                                                                                         msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
 784                                                                                                         msgs::DecodeError::UnknownRequiredFeature => {
 785                                                                                                                 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
 786                                                                                                                 continue;
 787                                                                                                         }
 788                                                                                                         msgs::DecodeError::InvalidValue => {
 789                                                                                                                 log_debug!(self.logger, "Got an invalid value while deserializing message");
 790                                                                                                                 return Err(PeerHandleError { no_connection_possible: false });
 791                                                                                                         }
 792                                                                                                         msgs::DecodeError::ShortRead => {
 793                                                                                                                 log_debug!(self.logger, "Deserialization failed due to shortness of message");
 794                                                                                                                 return Err(PeerHandleError { no_connection_possible: false });
 795                                                                                                         }
 796                                                                                                         msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
 797                                                                                                         msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
 798                                                                                                         msgs::DecodeError::UnsupportedCompression => {
 799                                                                                                                 log_debug!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
 800                                                                                                                 continue;
 801                                                                                                         }
 802                                                                                                 }
 803                                                                                         }
 804                                                                                 };
 805
 806                                                                                 match self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message) {
 807                                                                                         Err(handling_error) => match handling_error {
 808                                                                                                 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
 809                                                                                                 MessageHandlingError::LightningError(e) => {
 810                                                                                                         try_potential_handleerror!(Err(e));
 811                                                                                                 },
 812                                                                                         },
 813                                                                                         Ok(Some(msg)) => {
 814                                                                                                 peer_node_id = Some(peer.their_node_id.expect("After noise is complete, their_node_id is always set"));
 815                                                                                                 msgs_to_forward.push(msg);
 816                                                                                         },
 817                                                                                         Ok(None) => {},
 818                                                                                 }
 819                                                                         }
 820                                                                 }
 821                                                         }
 822                                                 }
 823                                         }
 824
 825                                         peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_READ_PAUSE // pause_read
 826                                 }
 827                         };
 828
 829                         for msg in msgs_to_forward.drain(..) {
 830                                 self.forward_broadcast_msg(peers, &msg, peer_node_id.as_ref());
 831                         }
 832
 833                         pause_read
 834                 };
 835
 836                 Ok(pause_read)
 837         }
 838
 839         /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
 840         /// Returns the message back if it needs to be broadcasted to all other peers.
 841         fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<Option<wire::Message>, MessageHandlingError> {
 842                 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
 843
 844                 // Need an Init as first message
 845                 if let wire::Message::Init(_) = message {
 846                 } else if peer.their_features.is_none() {
 847                         log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
 848                         return Err(PeerHandleError{ no_connection_possible: false }.into());
 849                 }
 850
 851                 let mut should_forward = None;
 852
 853                 match message {
 854                         // Setup and Control messages:
 855                         wire::Message::Init(msg) => {
 856                                 if msg.features.requires_unknown_bits() {
 857                                         log_info!(self.logger, "Peer features required unknown version bits");
 858                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
 859                                 }
 860                                 if peer.their_features.is_some() {
 861                                         return Err(PeerHandleError{ no_connection_possible: false }.into());
 862                                 }
 863
 864                                 log_info!(
 865                                         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): {}",
 866                                         if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
 867                                         if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
 868                                         if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
 869                                         if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
 870                                         if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
 871                                         if msg.features.supports_unknown_bits() { "present" } else { "none" }
 872                                 );
 873
 874                                 if msg.features.initial_routing_sync() {
 875                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
 876                                         peers_needing_send.insert(peer_descriptor.clone());
 877                                 }
 878                                 if !msg.features.supports_static_remote_key() {
 879                                         log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
 880                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
 881                                 }
 882
 883                                 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
 884
 885                                 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
 886                                 peer.their_features = Some(msg.features);
 887                         },
 888                         wire::Message::Error(msg) => {
 889                                 let mut data_is_printable = true;
 890                                 for b in msg.data.bytes() {
 891                                         if b < 32 || b > 126 {
 892                                                 data_is_printable = false;
 893                                                 break;
 894                                         }
 895                                 }
 896
 897                                 if data_is_printable {
 898                                         log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
 899                                 } else {
 900                                         log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
 901                                 }
 902                                 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
 903                                 if msg.channel_id == [0; 32] {
 904                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
 905                                 }
 906                         },
 907
 908                         wire::Message::Ping(msg) => {
 909                                 if msg.ponglen < 65532 {
 910                                         let resp = msgs::Pong { byteslen: msg.ponglen };
 911                                         self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
 912                                 }
 913                         },
 914                         wire::Message::Pong(_msg) => {
 915                                 peer.awaiting_pong = false;
 916                         },
 917
 918                         // Channel messages:
 919                         wire::Message::OpenChannel(msg) => {
 920                                 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
 921                         },
 922                         wire::Message::AcceptChannel(msg) => {
 923                                 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
 924                         },
 925
 926                         wire::Message::FundingCreated(msg) => {
 927                                 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
 928                         },
 929                         wire::Message::FundingSigned(msg) => {
 930                                 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
 931                         },
 932                         wire::Message::FundingLocked(msg) => {
 933                                 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
 934                         },
 935
 936                         wire::Message::Shutdown(msg) => {
 937                                 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
 938                         },
 939                         wire::Message::ClosingSigned(msg) => {
 940                                 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
 941                         },
 942
 943                         // Commitment messages:
 944                         wire::Message::UpdateAddHTLC(msg) => {
 945                                 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
 946                         },
 947                         wire::Message::UpdateFulfillHTLC(msg) => {
 948                                 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
 949                         },
 950                         wire::Message::UpdateFailHTLC(msg) => {
 951                                 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
 952                         },
 953                         wire::Message::UpdateFailMalformedHTLC(msg) => {
 954                                 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
 955                         },
 956
 957                         wire::Message::CommitmentSigned(msg) => {
 958                                 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
 959                         },
 960                         wire::Message::RevokeAndACK(msg) => {
 961                                 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
 962                         },
 963                         wire::Message::UpdateFee(msg) => {
 964                                 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
 965                         },
 966                         wire::Message::ChannelReestablish(msg) => {
 967                                 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
 968                         },
 969
 970                         // Routing messages:
 971                         wire::Message::AnnouncementSignatures(msg) => {
 972                                 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
 973                         },
 974                         wire::Message::ChannelAnnouncement(msg) => {
 975                                 if match self.message_handler.route_handler.handle_channel_announcement(&msg) {
 976                                         Ok(v) => v,
 977                                         Err(e) => { return Err(e.into()); },
 978                                 } {
 979                                         should_forward = Some(wire::Message::ChannelAnnouncement(msg));
 980                                 }
 981                         },
 982                         wire::Message::NodeAnnouncement(msg) => {
 983                                 if match self.message_handler.route_handler.handle_node_announcement(&msg) {
 984                                         Ok(v) => v,
 985                                         Err(e) => { return Err(e.into()); },
 986                                 } {
 987                                         should_forward = Some(wire::Message::NodeAnnouncement(msg));
 988                                 }
 989                         },
 990                         wire::Message::ChannelUpdate(msg) => {
 991                                 self.message_handler.chan_handler.handle_channel_update(&peer.their_node_id.unwrap(), &msg);
 992                                 if match self.message_handler.route_handler.handle_channel_update(&msg) {
 993                                         Ok(v) => v,
 994                                         Err(e) => { return Err(e.into()); },
 995                                 } {
 996                                         should_forward = Some(wire::Message::ChannelUpdate(msg));
 997                                 }
 998                         },
 999                         wire::Message::QueryShortChannelIds(msg) => {
1000                                 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
1001                         },
1002                         wire::Message::ReplyShortChannelIdsEnd(msg) => {
1003                                 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
1004                         },
1005                         wire::Message::QueryChannelRange(msg) => {
1006                                 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
1007                         },
1008                         wire::Message::ReplyChannelRange(msg) => {
1009                                 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
1010                         },
1011                         wire::Message::GossipTimestampFilter(_msg) => {
1012                                 // TODO: handle message
1013                         },
1014
1015                         // Unknown messages:
1016                         wire::Message::Unknown(msg_type) if msg_type.is_even() => {
1017                                 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
1018                                 // Fail the channel if message is an even, unknown type as per BOLT #1.
1019                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
1020                         },
1021                         wire::Message::Unknown(msg_type) => {
1022                                 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
1023                         }
1024                 };
1025                 Ok(should_forward)
1026         }
1027
1028         fn forward_broadcast_msg(&self, peers: &mut PeerHolder<Descriptor>, msg: &wire::Message, except_node: Option<&PublicKey>) {
1029                 match msg {
1030                         wire::Message::ChannelAnnouncement(ref msg) => {
1031                                 let encoded_msg = encode_msg!(msg);
1032
1033                                 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1034                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1035                                                         !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1036                                                 continue
1037                                         }
1038                                         if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1039                                                 continue;
1040                                         }
1041                                         if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1042                                            peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1043                                                 continue;
1044                                         }
1045                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1046                                                 continue;
1047                                         }
1048                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1049                                         peers.peers_needing_send.insert((*descriptor).clone());
1050                                 }
1051                         },
1052                         wire::Message::NodeAnnouncement(ref msg) => {
1053                                 let encoded_msg = encode_msg!(msg);
1054
1055                                 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1056                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1057                                                         !peer.should_forward_node_announcement(msg.contents.node_id) {
1058                                                 continue
1059                                         }
1060                                         if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1061                                                 continue;
1062                                         }
1063                                         if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1064                                                 continue;
1065                                         }
1066                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1067                                                 continue;
1068                                         }
1069                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1070                                         peers.peers_needing_send.insert((*descriptor).clone());
1071                                 }
1072                         },
1073                         wire::Message::ChannelUpdate(ref msg) => {
1074                                 let encoded_msg = encode_msg!(msg);
1075
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)  {
1079                                                 continue
1080                                         }
1081                                         if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP {
1082                                                 continue;
1083                                         }
1084                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1085                                                 continue;
1086                                         }
1087                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1088                                         peers.peers_needing_send.insert((*descriptor).clone());
1089                                 }
1090                         },
1091                         _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1092                 }
1093         }
1094
1095         /// Checks for any events generated by our handlers and processes them. Includes sending most
1096         /// response messages as well as messages generated by calls to handler functions directly (eg
1097         /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
1098         pub fn process_events(&self) {
1099                 {
1100                         // TODO: There are some DoS attacks here where you can flood someone's outbound send
1101                         // buffer by doing things like announcing channels on another node. We should be willing to
1102                         // drop optional-ish messages when send buffers get full!
1103
1104                         let mut peers_lock = self.peers.lock().unwrap();
1105                         let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1106                         events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1107                         let peers = &mut *peers_lock;
1108                         for event in events_generated.drain(..) {
1109                                 macro_rules! get_peer_for_forwarding {
1110                                         ($node_id: expr) => {
1111                                                 {
1112                                                         let descriptor = match peers.node_id_to_descriptor.get($node_id) {
1113                                                                 Some(descriptor) => descriptor.clone(),
1114                                                                 None => {
1115                                                                         continue;
1116                                                                 },
1117                                                         };
1118                                                         match peers.peers.get_mut(&descriptor) {
1119                                                                 Some(peer) => {
1120                                                                         if peer.their_features.is_none() {
1121                                                                                 continue;
1122                                                                         }
1123                                                                         (descriptor, peer)
1124                                                                 },
1125                                                                 None => panic!("Inconsistent peers set state!"),
1126                                                         }
1127                                                 }
1128                                         }
1129                                 }
1130                                 match event {
1131                                         MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1132                                                 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1133                                                                 log_pubkey!(node_id),
1134                                                                 log_bytes!(msg.temporary_channel_id));
1135                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1136                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1137                                                 self.do_attempt_write_data(&mut descriptor, peer);
1138                                         },
1139                                         MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1140                                                 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1141                                                                 log_pubkey!(node_id),
1142                                                                 log_bytes!(msg.temporary_channel_id));
1143                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1144                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1145                                                 self.do_attempt_write_data(&mut descriptor, peer);
1146                                         },
1147                                         MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1148                                                 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1149                                                                 log_pubkey!(node_id),
1150                                                                 log_bytes!(msg.temporary_channel_id),
1151                                                                 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1152                                                 // TODO: If the peer is gone we should generate a DiscardFunding event
1153                                                 // indicating to the wallet that they should just throw away this funding transaction
1154                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1155                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1156                                                 self.do_attempt_write_data(&mut descriptor, peer);
1157                                         },
1158                                         MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1159                                                 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1160                                                                 log_pubkey!(node_id),
1161                                                                 log_bytes!(msg.channel_id));
1162                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1163                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1164                                                 self.do_attempt_write_data(&mut descriptor, peer);
1165                                         },
1166                                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1167                                                 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1168                                                                 log_pubkey!(node_id),
1169                                                                 log_bytes!(msg.channel_id));
1170                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1171                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1172                                                 self.do_attempt_write_data(&mut descriptor, peer);
1173                                         },
1174                                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1175                                                 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1176                                                                 log_pubkey!(node_id),
1177                                                                 log_bytes!(msg.channel_id));
1178                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1179                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1180                                                 self.do_attempt_write_data(&mut descriptor, peer);
1181                                         },
1182                                         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 } } => {
1183                                                 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1184                                                                 log_pubkey!(node_id),
1185                                                                 update_add_htlcs.len(),
1186                                                                 update_fulfill_htlcs.len(),
1187                                                                 update_fail_htlcs.len(),
1188                                                                 log_bytes!(commitment_signed.channel_id));
1189                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1190                                                 for msg in update_add_htlcs {
1191                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1192                                                 }
1193                                                 for msg in update_fulfill_htlcs {
1194                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1195                                                 }
1196                                                 for msg in update_fail_htlcs {
1197                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1198                                                 }
1199                                                 for msg in update_fail_malformed_htlcs {
1200                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1201                                                 }
1202                                                 if let &Some(ref msg) = update_fee {
1203                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1204                                                 }
1205                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
1206                                                 self.do_attempt_write_data(&mut descriptor, peer);
1207                                         },
1208                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1209                                                 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1210                                                                 log_pubkey!(node_id),
1211                                                                 log_bytes!(msg.channel_id));
1212                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1213                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1214                                                 self.do_attempt_write_data(&mut descriptor, peer);
1215                                         },
1216                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1217                                                 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1218                                                                 log_pubkey!(node_id),
1219                                                                 log_bytes!(msg.channel_id));
1220                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1221                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1222                                                 self.do_attempt_write_data(&mut descriptor, peer);
1223                                         },
1224                                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1225                                                 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1226                                                                 log_pubkey!(node_id),
1227                                                                 log_bytes!(msg.channel_id));
1228                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1229                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1230                                                 self.do_attempt_write_data(&mut descriptor, peer);
1231                                         },
1232                                         MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1233                                                 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1234                                                                 log_pubkey!(node_id),
1235                                                                 log_bytes!(msg.channel_id));
1236                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1237                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1238                                                 self.do_attempt_write_data(&mut descriptor, peer);
1239                                         },
1240                                         MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1241                                                 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1242                                                 if self.message_handler.route_handler.handle_channel_announcement(&msg).is_ok() && self.message_handler.route_handler.handle_channel_update(&update_msg).is_ok() {
1243                                                         self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None);
1244                                                         self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None);
1245                                                 }
1246                                         },
1247                                         MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1248                                                 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1249                                                 if self.message_handler.route_handler.handle_node_announcement(&msg).is_ok() {
1250                                                         self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None);
1251                                                 }
1252                                         },
1253                                         MessageSendEvent::BroadcastChannelUpdate { msg } => {
1254                                                 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1255                                                 if self.message_handler.route_handler.handle_channel_update(&msg).is_ok() {
1256                                                         self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None);
1257                                                 }
1258                                         },
1259                                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1260                                                 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1261                                         },
1262                                         MessageSendEvent::HandleError { ref node_id, ref action } => {
1263                                                 match *action {
1264                                                         msgs::ErrorAction::DisconnectPeer { ref msg } => {
1265                                                                 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1266                                                                         peers.peers_needing_send.remove(&descriptor);
1267                                                                         if let Some(mut peer) = peers.peers.remove(&descriptor) {
1268                                                                                 if let Some(ref msg) = *msg {
1269                                                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1270                                                                                                         log_pubkey!(node_id),
1271                                                                                                         msg.data);
1272                                                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1273                                                                                         // This isn't guaranteed to work, but if there is enough free
1274                                                                                         // room in the send buffer, put the error message there...
1275                                                                                         self.do_attempt_write_data(&mut descriptor, &mut peer);
1276                                                                                 } else {
1277                                                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1278                                                                                 }
1279                                                                         }
1280                                                                         descriptor.disconnect_socket();
1281                                                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1282                                                                 }
1283                                                         },
1284                                                         msgs::ErrorAction::IgnoreError => {},
1285                                                         msgs::ErrorAction::SendErrorMessage { ref msg } => {
1286                                                                 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1287                                                                                 log_pubkey!(node_id),
1288                                                                                 msg.data);
1289                                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1290                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1291                                                                 self.do_attempt_write_data(&mut descriptor, peer);
1292                                                         },
1293                                                 }
1294                                         },
1295                                         MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1296                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1297                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1298                                                 self.do_attempt_write_data(&mut descriptor, peer);
1299                                         },
1300                                         MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1301                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1302                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1303                                                 self.do_attempt_write_data(&mut descriptor, peer);
1304                                         }
1305                                         MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1306                                                 log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1307                                                         log_pubkey!(node_id),
1308                                                         msg.short_channel_ids.len(),
1309                                                         msg.first_blocknum,
1310                                                         msg.number_of_blocks,
1311                                                         msg.sync_complete);
1312                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1313                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1314                                                 self.do_attempt_write_data(&mut descriptor, peer);
1315                                         }
1316                                 }
1317                         }
1318
1319                         for mut descriptor in peers.peers_needing_send.drain() {
1320                                 match peers.peers.get_mut(&descriptor) {
1321                                         Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1322                                         None => panic!("Inconsistent peers set state!"),
1323                                 }
1324                         }
1325                 }
1326         }
1327
1328         /// Indicates that the given socket descriptor's connection is now closed.
1329         ///
1330         /// This must only be called if the socket has been disconnected by the peer or your own
1331         /// decision to disconnect it and must NOT be called in any case where other parts of this
1332         /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1333         /// the peer.
1334         ///
1335         /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1336         pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1337                 self.disconnect_event_internal(descriptor, false);
1338         }
1339
1340         fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1341                 let mut peers = self.peers.lock().unwrap();
1342                 peers.peers_needing_send.remove(descriptor);
1343                 let peer_option = peers.peers.remove(descriptor);
1344                 match peer_option {
1345                         None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1346                         Some(peer) => {
1347                                 match peer.their_node_id {
1348                                         Some(node_id) => {
1349                                                 peers.node_id_to_descriptor.remove(&node_id);
1350                                                 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1351                                         },
1352                                         None => {}
1353                                 }
1354                         }
1355                 };
1356         }
1357
1358         /// Disconnect a peer given its node id.
1359         ///
1360         /// Set no_connection_possible to true to prevent any further connection with this peer,
1361         /// force-closing any channels we have with it.
1362         ///
1363         /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1364         /// so be careful about reentrancy issues.
1365         pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1366                 let mut peers_lock = self.peers.lock().unwrap();
1367                 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1368                         log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1369                         peers_lock.peers.remove(&descriptor);
1370                         peers_lock.peers_needing_send.remove(&descriptor);
1371                         self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1372                         descriptor.disconnect_socket();
1373                 }
1374         }
1375
1376         /// This function should be called roughly once every 30 seconds.
1377         /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1378
1379         /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1380         pub fn timer_tick_occurred(&self) {
1381                 let mut peers_lock = self.peers.lock().unwrap();
1382                 {
1383                         let peers = &mut *peers_lock;
1384                         let peers_needing_send = &mut peers.peers_needing_send;
1385                         let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1386                         let peers = &mut peers.peers;
1387                         let mut descriptors_needing_disconnect = Vec::new();
1388
1389                         peers.retain(|descriptor, peer| {
1390                                 if peer.awaiting_pong {
1391                                         peers_needing_send.remove(descriptor);
1392                                         descriptors_needing_disconnect.push(descriptor.clone());
1393                                         match peer.their_node_id {
1394                                                 Some(node_id) => {
1395                                                         log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1396                                                         node_id_to_descriptor.remove(&node_id);
1397                                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1398                                                 }
1399                                                 None => {
1400                                                         // This can't actually happen as we should have hit
1401                                                         // is_ready_for_encryption() previously on this same peer.
1402                                                         unreachable!();
1403                                                 },
1404                                         }
1405                                         return false;
1406                                 }
1407
1408                                 if !peer.channel_encryptor.is_ready_for_encryption() {
1409                                         // The peer needs to complete its handshake before we can exchange messages
1410                                         return true;
1411                                 }
1412
1413                                 let ping = msgs::Ping {
1414                                         ponglen: 0,
1415                                         byteslen: 64,
1416                                 };
1417                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1418
1419                                 let mut descriptor_clone = descriptor.clone();
1420                                 self.do_attempt_write_data(&mut descriptor_clone, peer);
1421
1422                                 peer.awaiting_pong = true;
1423                                 true
1424                         });
1425
1426                         for mut descriptor in descriptors_needing_disconnect.drain(..) {
1427                                 descriptor.disconnect_socket();
1428                         }
1429                 }
1430         }
1431 }
1432
1433 #[cfg(test)]
1434 mod tests {
1435         use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1436         use ln::msgs;
1437         use util::events;
1438         use util::test_utils;
1439
1440         use bitcoin::secp256k1::Secp256k1;
1441         use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1442
1443         use prelude::*;
1444         use std::sync::{Arc, Mutex};
1445         use core::sync::atomic::Ordering;
1446
1447         #[derive(Clone)]
1448         struct FileDescriptor {
1449                 fd: u16,
1450                 outbound_data: Arc<Mutex<Vec<u8>>>,
1451         }
1452         impl PartialEq for FileDescriptor {
1453                 fn eq(&self, other: &Self) -> bool {
1454                         self.fd == other.fd
1455                 }
1456         }
1457         impl Eq for FileDescriptor { }
1458         impl core::hash::Hash for FileDescriptor {
1459                 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1460                         self.fd.hash(hasher)
1461                 }
1462         }
1463
1464         impl SocketDescriptor for FileDescriptor {
1465                 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1466                         self.outbound_data.lock().unwrap().extend_from_slice(data);
1467                         data.len()
1468                 }
1469
1470                 fn disconnect_socket(&mut self) {}
1471         }
1472
1473         struct PeerManagerCfg {
1474                 chan_handler: test_utils::TestChannelMessageHandler,
1475                 routing_handler: test_utils::TestRoutingMessageHandler,
1476                 logger: test_utils::TestLogger,
1477         }
1478
1479         fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1480                 let mut cfgs = Vec::new();
1481                 for _ in 0..peer_count {
1482                         cfgs.push(
1483                                 PeerManagerCfg{
1484                                         chan_handler: test_utils::TestChannelMessageHandler::new(),
1485                                         logger: test_utils::TestLogger::new(),
1486                                         routing_handler: test_utils::TestRoutingMessageHandler::new(),
1487                                 }
1488                         );
1489                 }
1490
1491                 cfgs
1492         }
1493
1494         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>> {
1495                 let mut peers = Vec::new();
1496                 for i in 0..peer_count {
1497                         let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1498                         let ephemeral_bytes = [i as u8; 32];
1499                         let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1500                         let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1501                         peers.push(peer);
1502                 }
1503
1504                 peers
1505         }
1506
1507         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) {
1508                 let secp_ctx = Secp256k1::new();
1509                 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1510                 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1511                 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1512                 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1513                 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1514                 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1515                 peer_a.process_events();
1516                 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1517                 peer_b.process_events();
1518                 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1519                 (fd_a.clone(), fd_b.clone())
1520         }
1521
1522         #[test]
1523         fn test_disconnect_peer() {
1524                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1525                 // push a DisconnectPeer event to remove the node flagged by id
1526                 let cfgs = create_peermgr_cfgs(2);
1527                 let chan_handler = test_utils::TestChannelMessageHandler::new();
1528                 let mut peers = create_network(2, &cfgs);
1529                 establish_connection(&peers[0], &peers[1]);
1530                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1531
1532                 let secp_ctx = Secp256k1::new();
1533                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1534
1535                 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1536                         node_id: their_id,
1537                         action: msgs::ErrorAction::DisconnectPeer { msg: None },
1538                 });
1539                 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1540                 peers[0].message_handler.chan_handler = &chan_handler;
1541
1542                 peers[0].process_events();
1543                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1544         }
1545
1546         #[test]
1547         fn test_timer_tick_occurred() {
1548                 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1549                 let cfgs = create_peermgr_cfgs(2);
1550                 let peers = create_network(2, &cfgs);
1551                 establish_connection(&peers[0], &peers[1]);
1552                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1553
1554                 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1555                 peers[0].timer_tick_occurred();
1556                 peers[0].process_events();
1557                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1558
1559                 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1560                 peers[0].timer_tick_occurred();
1561                 peers[0].process_events();
1562                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1563         }
1564
1565         #[test]
1566         fn test_do_attempt_write_data() {
1567                 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1568                 let cfgs = create_peermgr_cfgs(2);
1569                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1570                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1571                 let peers = create_network(2, &cfgs);
1572
1573                 // By calling establish_connect, we trigger do_attempt_write_data between
1574                 // the peers. Previously this function would mistakenly enter an infinite loop
1575                 // when there were more channel messages available than could fit into a peer's
1576                 // buffer. This issue would now be detected by this test (because we use custom
1577                 // RoutingMessageHandlers that intentionally return more channel messages
1578                 // than can fit into a peer's buffer).
1579                 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1580
1581                 // Make each peer to read the messages that the other peer just wrote to them.
1582                 peers[0].process_events();
1583                 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1584                 peers[1].process_events();
1585                 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1586
1587                 // Check that each peer has received the expected number of channel updates and channel
1588                 // announcements.
1589                 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1590                 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1591                 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1592                 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1593         }
1594 }