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

   1 //! Top level peer message handling and socket handling logic lives here.
   2 //!
   3 //! Instead of actually servicing sockets ourselves we require that you implement the
   4 //! SocketDescriptor interface and use that to receive actions which you should perform on the
   5 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
   6 //! call into the provided message handlers (probably a ChannelManager and Router) with messages
   7 //! they should handle, and encoding/sending response messages.
   8
   9 use secp256k1::key::{SecretKey,PublicKey};
  10
  11 use ln::msgs;
  12 use util::ser::{Writeable, Writer, Readable};
  13 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
  14 use util::byte_utils;
  15 use util::events::{MessageSendEvent};
  16 use util::logger::Logger;
  17
  18 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
  19 use std::sync::{Arc, Mutex};
  20 use std::sync::atomic::{AtomicUsize, Ordering};
  21 use std::{cmp,error,hash,fmt};
  22
  23 /// Provides references to trait impls which handle different types of messages.
  24 pub struct MessageHandler {
  25         /// A message handler which handles messages specific to channels. Usually this is just a
  26         /// ChannelManager object.
  27         pub chan_handler: Arc<msgs::ChannelMessageHandler>,
  28         /// A message handler which handles messages updating our knowledge of the network channel
  29         /// graph. Usually this is just a Router object.
  30         pub route_handler: Arc<msgs::RoutingMessageHandler>,
  31 }
  32
  33 /// Provides an object which can be used to send data to and which uniquely identifies a connection
  34 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
  35 /// implement Hash to meet the PeerManager API.
  36 ///
  37 /// For efficiency, Clone should be relatively cheap for this type.
  38 ///
  39 /// You probably want to just extend an int and put a file descriptor in a struct and implement
  40 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
  41 /// careful to ensure you don't have races whereby you might register a new connection with an fd
  42 /// the same as a yet-to-be-disconnect_event()-ed.
  43 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
  44         /// Attempts to send some data from the given Vec starting at the given offset to the peer.
  45         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
  46         /// Note that in the disconnected case, a disconnect_event must still fire and further write
  47         /// attempts may occur until that time.
  48         ///
  49         /// If the returned size is smaller than data.len() - write_offset, a write_available event must
  50         /// trigger the next time more data can be written. Additionally, until the a send_data event
  51         /// completes fully, no further read_events should trigger on the same peer!
  52         ///
  53         /// If a read_event on this descriptor had previously returned true (indicating that read
  54         /// events should be paused to prevent DoS in the send buffer), resume_read may be set
  55         /// indicating that read events on this descriptor should resume. A resume_read of false does
  56         /// *not* imply that further read events should be paused.
  57         fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, resume_read: bool) -> usize;
  58         /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
  59         /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
  60         /// No disconnect_event should be generated as a result of this call, though obviously races
  61         /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
  62         /// that event completing.
  63         fn disconnect_socket(&mut self);
  64 }
  65
  66 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
  67 /// generate no further read/write_events for the descriptor, only triggering a single
  68 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
  69 /// no such disconnect_event must be generated and the socket be silently disconencted).
  70 pub struct PeerHandleError {
  71         /// Used to indicate that we probably can't make any future connections to this peer, implying
  72         /// we should go ahead and force-close any channels we have with it.
  73         no_connection_possible: bool,
  74 }
  75 impl fmt::Debug for PeerHandleError {
  76         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
  77                 formatter.write_str("Peer Sent Invalid Data")
  78         }
  79 }
  80 impl fmt::Display for PeerHandleError {
  81         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
  82                 formatter.write_str("Peer Sent Invalid Data")
  83         }
  84 }
  85 impl error::Error for PeerHandleError {
  86         fn description(&self) -> &str {
  87                 "Peer Sent Invalid Data"
  88         }
  89 }
  90
  91 enum InitSyncTracker{
  92         NoSyncRequested,
  93         ChannelsSyncing(u64),
  94         NodesSyncing(PublicKey),
  95 }
  96
  97 struct Peer {
  98         channel_encryptor: PeerChannelEncryptor,
  99         outbound: bool,
 100         their_node_id: Option<PublicKey>,
 101         their_global_features: Option<msgs::GlobalFeatures>,
 102         their_local_features: Option<msgs::LocalFeatures>,
 103
 104         pending_outbound_buffer: LinkedList<Vec<u8>>,
 105         pending_outbound_buffer_first_msg_offset: usize,
 106         awaiting_write_event: bool,
 107
 108         pending_read_buffer: Vec<u8>,
 109         pending_read_buffer_pos: usize,
 110         pending_read_is_header: bool,
 111
 112         sync_status: InitSyncTracker,
 113 }
 114
 115 impl Peer {
 116         /// Returns true if the the channel announcements/updates for the given channel should be
 117         /// forwarded to this peer.
 118         /// If we are sending our routing table to this peer and we have not yet sent channel
 119         /// announcements/updates for the given channel_id then we will send it when we get to that
 120         /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
 121         /// sent the old versions, we should send the update, and so return true here.
 122         fn should_forward_channel(&self, channel_id: u64)->bool{
 123                 match self.sync_status {
 124                         InitSyncTracker::NoSyncRequested => true,
 125                         InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
 126                         InitSyncTracker::NodesSyncing(_) => true,
 127                 }
 128         }
 129 }
 130
 131 struct PeerHolder<Descriptor: SocketDescriptor> {
 132         peers: HashMap<Descriptor, Peer>,
 133         /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
 134         /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
 135         peers_needing_send: HashSet<Descriptor>,
 136         /// Only add to this set when noise completes:
 137         node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
 138 }
 139 struct MutPeerHolder<'a, Descriptor: SocketDescriptor + 'a> {
 140         peers: &'a mut HashMap<Descriptor, Peer>,
 141         peers_needing_send: &'a mut HashSet<Descriptor>,
 142         node_id_to_descriptor: &'a mut HashMap<PublicKey, Descriptor>,
 143 }
 144 impl<Descriptor: SocketDescriptor> PeerHolder<Descriptor> {
 145         fn borrow_parts(&mut self) -> MutPeerHolder<Descriptor> {
 146                 MutPeerHolder {
 147                         peers: &mut self.peers,
 148                         peers_needing_send: &mut self.peers_needing_send,
 149                         node_id_to_descriptor: &mut self.node_id_to_descriptor,
 150                 }
 151         }
 152 }
 153
 154 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
 155 /// events into messages which it passes on to its MessageHandlers.
 156 pub struct PeerManager<Descriptor: SocketDescriptor> {
 157         message_handler: MessageHandler,
 158         peers: Mutex<PeerHolder<Descriptor>>,
 159         our_node_secret: SecretKey,
 160         initial_syncs_sent: AtomicUsize,
 161         logger: Arc<Logger>,
 162 }
 163
 164 struct VecWriter(Vec<u8>);
 165 impl Writer for VecWriter {
 166         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
 167                 self.0.extend_from_slice(buf);
 168                 Ok(())
 169         }
 170         fn size_hint(&mut self, size: usize) {
 171                 self.0.reserve_exact(size);
 172         }
 173 }
 174
 175 macro_rules! encode_msg {
 176         ($msg: expr, $msg_code: expr) => {{
 177                 let mut msg = VecWriter(Vec::new());
 178                 ($msg_code as u16).write(&mut msg).unwrap();
 179                 $msg.write(&mut msg).unwrap();
 180                 msg.0
 181         }}
 182 }
 183
 184 //TODO: Really should do something smarter for this
 185 const INITIAL_SYNCS_TO_SEND: usize = 5;
 186
 187 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
 188 /// PeerIds may repeat, but only after disconnect_event() has been called.
 189 impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 190         /// Constructs a new PeerManager with the given message handlers and node_id secret key
 191         pub fn new(message_handler: MessageHandler, our_node_secret: SecretKey, logger: Arc<Logger>) -> PeerManager<Descriptor> {
 192                 PeerManager {
 193                         message_handler: message_handler,
 194                         peers: Mutex::new(PeerHolder {
 195                                 peers: HashMap::new(),
 196                                 peers_needing_send: HashSet::new(),
 197                                 node_id_to_descriptor: HashMap::new()
 198                         }),
 199                         our_node_secret: our_node_secret,
 200                         initial_syncs_sent: AtomicUsize::new(0),
 201                         logger,
 202                 }
 203         }
 204
 205         /// Get the list of node ids for peers which have completed the initial handshake.
 206         ///
 207         /// For outbound connections, this will be the same as the their_node_id parameter passed in to
 208         /// new_outbound_connection, however entries will only appear once the initial handshake has
 209         /// completed and we are sure the remote peer has the private key for the given node_id.
 210         pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
 211                 let peers = self.peers.lock().unwrap();
 212                 peers.peers.values().filter_map(|p| {
 213                         if !p.channel_encryptor.is_ready_for_encryption() || p.their_global_features.is_none() {
 214                                 return None;
 215                         }
 216                         p.their_node_id
 217                 }).collect()
 218         }
 219
 220         /// Indicates a new outbound connection has been established to a node with the given node_id.
 221         /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
 222         /// descriptor but must disconnect the connection immediately.
 223         ///
 224         /// Returns a small number of bytes to send to the remote node (currently always 50).
 225         ///
 226         /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
 227         /// disconnect_event.
 228         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
 229                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone());
 230                 let res = peer_encryptor.get_act_one().to_vec();
 231                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
 232
 233                 let mut peers = self.peers.lock().unwrap();
 234                 if peers.peers.insert(descriptor, Peer {
 235                         channel_encryptor: peer_encryptor,
 236                         outbound: true,
 237                         their_node_id: None,
 238                         their_global_features: None,
 239                         their_local_features: None,
 240
 241                         pending_outbound_buffer: LinkedList::new(),
 242                         pending_outbound_buffer_first_msg_offset: 0,
 243                         awaiting_write_event: false,
 244
 245                         pending_read_buffer: pending_read_buffer,
 246                         pending_read_buffer_pos: 0,
 247                         pending_read_is_header: false,
 248
 249                         sync_status: InitSyncTracker::NoSyncRequested,
 250                 }).is_some() {
 251                         panic!("PeerManager driver duplicated descriptors!");
 252                 };
 253                 Ok(res)
 254         }
 255
 256         /// Indicates a new inbound connection has been established.
 257         ///
 258         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
 259         /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
 260         /// call disconnect_event for the new descriptor but must disconnect the connection
 261         /// immediately.
 262         ///
 263         /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
 264         /// disconnect_event.
 265         pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
 266                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
 267                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
 268
 269                 let mut peers = self.peers.lock().unwrap();
 270                 if peers.peers.insert(descriptor, Peer {
 271                         channel_encryptor: peer_encryptor,
 272                         outbound: false,
 273                         their_node_id: None,
 274                         their_global_features: None,
 275                         their_local_features: None,
 276
 277                         pending_outbound_buffer: LinkedList::new(),
 278                         pending_outbound_buffer_first_msg_offset: 0,
 279                         awaiting_write_event: false,
 280
 281                         pending_read_buffer: pending_read_buffer,
 282                         pending_read_buffer_pos: 0,
 283                         pending_read_is_header: false,
 284
 285                         sync_status: InitSyncTracker::NoSyncRequested,
 286                 }).is_some() {
 287                         panic!("PeerManager driver duplicated descriptors!");
 288                 };
 289                 Ok(())
 290         }
 291
 292         fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
 293                 macro_rules! encode_and_send_msg {
 294                         ($msg: expr, $msg_code: expr) => {
 295                                 {
 296                                         log_trace!(self, "Encoding and sending sync update message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
 297                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
 298                                 }
 299                         }
 300                 }
 301                 const MSG_BUFF_SIZE: usize = 10;
 302                 while !peer.awaiting_write_event {
 303                         if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
 304                                 match peer.sync_status {
 305                                         InitSyncTracker::NoSyncRequested => {},
 306                                         InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
 307                                                 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
 308                                                 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(0, steps);
 309                                                 for &(ref announce, ref update_a, ref update_b) in all_messages.iter() {
 310                                                         encode_and_send_msg!(announce, 256);
 311                                                         encode_and_send_msg!(update_a, 258);
 312                                                         encode_and_send_msg!(update_b, 258);
 313                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
 314                                                 }
 315                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 316                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
 317                                                 }
 318                                         },
 319                                         InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
 320                                                 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
 321                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
 322                                                 for msg in all_messages.iter() {
 323                                                         encode_and_send_msg!(msg, 256);
 324                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 325                                                 }
 326                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 327                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 328                                                 }
 329                                         },
 330                                         InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
 331                                         InitSyncTracker::NodesSyncing(key) => {
 332                                                 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
 333                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
 334                                                 for msg in all_messages.iter() {
 335                                                         encode_and_send_msg!(msg, 256);
 336                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 337                                                 }
 338                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 339                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 340                                                 }
 341                                         },
 342                                 }
 343                         }
 344
 345                         if {
 346                                 let next_buff = match peer.pending_outbound_buffer.front() {
 347                                         None => return,
 348                                         Some(buff) => buff,
 349                                 };
 350
 351                                 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
 352                                 let data_sent = descriptor.send_data(next_buff, peer.pending_outbound_buffer_first_msg_offset, should_be_reading);
 353                                 peer.pending_outbound_buffer_first_msg_offset += data_sent;
 354                                 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
 355                         } {
 356                                 peer.pending_outbound_buffer_first_msg_offset = 0;
 357                                 peer.pending_outbound_buffer.pop_front();
 358                         } else {
 359                                 peer.awaiting_write_event = true;
 360                         }
 361                 }
 362         }
 363
 364         /// Indicates that there is room to write data to the given socket descriptor.
 365         ///
 366         /// May return an Err to indicate that the connection should be closed.
 367         ///
 368         /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
 369         /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
 370         /// invariants around calling write_event in case a write did not fully complete must still
 371         /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
 372         /// Panics if the descriptor was not previously registered in a new_\*_connection event.
 373         pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
 374                 let mut peers = self.peers.lock().unwrap();
 375                 match peers.peers.get_mut(descriptor) {
 376                         None => panic!("Descriptor for write_event is not already known to PeerManager"),
 377                         Some(peer) => {
 378                                 peer.awaiting_write_event = false;
 379                                 self.do_attempt_write_data(descriptor, peer);
 380                         }
 381                 };
 382                 Ok(())
 383         }
 384
 385         /// Indicates that data was read from the given socket descriptor.
 386         ///
 387         /// May return an Err to indicate that the connection should be closed.
 388         ///
 389         /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
 390         /// Thus, however, you almost certainly want to call process_events() after any read_event to
 391         /// generate send_data calls to handle responses.
 392         ///
 393         /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
 394         /// this file descriptor has resume_read set (preventing DoS issues in the send buffer).
 395         ///
 396         /// Panics if the descriptor was not previously registered in a new_*_connection event.
 397         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
 398                 match self.do_read_event(peer_descriptor, data) {
 399                         Ok(res) => Ok(res),
 400                         Err(e) => {
 401                                 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
 402                                 Err(e)
 403                         }
 404                 }
 405         }
 406
 407         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
 408                 let pause_read = {
 409                         let mut peers_lock = self.peers.lock().unwrap();
 410                         let peers = peers_lock.borrow_parts();
 411                         let pause_read = match peers.peers.get_mut(peer_descriptor) {
 412                                 None => panic!("Descriptor for read_event is not already known to PeerManager"),
 413                                 Some(peer) => {
 414                                         assert!(peer.pending_read_buffer.len() > 0);
 415                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 416
 417                                         let mut read_pos = 0;
 418                                         while read_pos < data.len() {
 419                                                 {
 420                                                         let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
 421                                                         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]);
 422                                                         read_pos += data_to_copy;
 423                                                         peer.pending_read_buffer_pos += data_to_copy;
 424                                                 }
 425
 426                                                 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
 427                                                         peer.pending_read_buffer_pos = 0;
 428
 429                                                         macro_rules! encode_and_send_msg {
 430                                                                 ($msg: expr, $msg_code: expr) => {
 431                                                                         {
 432                                                                                 log_trace!(self, "Encoding and sending message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
 433                                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
 434                                                                                 peers.peers_needing_send.insert(peer_descriptor.clone());
 435                                                                         }
 436                                                                 }
 437                                                         }
 438
 439                                                         macro_rules! try_potential_handleerror {
 440                                                                 ($thing: expr) => {
 441                                                                         match $thing {
 442                                                                                 Ok(x) => x,
 443                                                                                 Err(e) => {
 444                                                                                         if let Some(action) = e.action {
 445                                                                                                 match action {
 446                                                                                                         msgs::ErrorAction::DisconnectPeer { msg: _ } => {
 447                                                                                                                 //TODO: Try to push msg
 448                                                                                                                 log_trace!(self, "Got Err handling message, disconnecting peer because {}", e.err);
 449                                                                                                                 return Err(PeerHandleError{ no_connection_possible: false });
 450                                                                                                         },
 451                                                                                                         msgs::ErrorAction::IgnoreError => {
 452                                                                                                                 log_trace!(self, "Got Err handling message, ignoring because {}", e.err);
 453                                                                                                                 continue;
 454                                                                                                         },
 455                                                                                                         msgs::ErrorAction::SendErrorMessage { msg } => {
 456                                                                                                                 log_trace!(self, "Got Err handling message, sending Error message because {}", e.err);
 457                                                                                                                 encode_and_send_msg!(msg, 17);
 458                                                                                                                 continue;
 459                                                                                                         },
 460                                                                                                 }
 461                                                                                         } else {
 462                                                                                                 log_debug!(self, "Got Err handling message, action not yet filled in: {}", e.err);
 463                                                                                                 return Err(PeerHandleError{ no_connection_possible: false });
 464                                                                                         }
 465                                                                                 }
 466                                                                         };
 467                                                                 }
 468                                                         }
 469
 470                                                         macro_rules! try_potential_decodeerror {
 471                                                                 ($thing: expr) => {
 472                                                                         match $thing {
 473                                                                                 Ok(x) => x,
 474                                                                                 Err(e) => {
 475                                                                                         match e {
 476                                                                                                 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError{ no_connection_possible: false }),
 477                                                                                                 msgs::DecodeError::UnknownRequiredFeature => {
 478                                                                                                         log_debug!(self, "Got a channel/node announcement with an known required feature flag, you may want to udpate!");
 479                                                                                                         continue;
 480                                                                                                 },
 481                                                                                                 msgs::DecodeError::InvalidValue => return Err(PeerHandleError{ no_connection_possible: false }),
 482                                                                                                 msgs::DecodeError::ShortRead => return Err(PeerHandleError{ no_connection_possible: false }),
 483                                                                                                 msgs::DecodeError::ExtraAddressesPerType => {
 484                                                                                                         log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
 485                                                                                                         continue;
 486                                                                                                 },
 487                                                                                                 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
 488                                                                                                 msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
 489                                                                                         }
 490                                                                                 }
 491                                                                         };
 492                                                                 }
 493                                                         }
 494
 495                                                         macro_rules! insert_node_id {
 496                                                                 () => {
 497                                                                         match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
 498                                                                                 hash_map::Entry::Occupied(_) => {
 499                                                                                         log_trace!(self, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
 500                                                                                         peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
 501                                                                                         return Err(PeerHandleError{ no_connection_possible: false })
 502                                                                                 },
 503                                                                                 hash_map::Entry::Vacant(entry) => {
 504                                                                                         log_trace!(self, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
 505                                                                                         entry.insert(peer_descriptor.clone())
 506                                                                                 },
 507                                                                         };
 508                                                                 }
 509                                                         }
 510
 511                                                         let next_step = peer.channel_encryptor.get_noise_step();
 512                                                         match next_step {
 513                                                                 NextNoiseStep::ActOne => {
 514                                                                         let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_key(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
 515                                                                         peer.pending_outbound_buffer.push_back(act_two);
 516                                                                         peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
 517                                                                 },
 518                                                                 NextNoiseStep::ActTwo => {
 519                                                                         let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
 520                                                                         peer.pending_outbound_buffer.push_back(act_three.to_vec());
 521                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 522                                                                         peer.pending_read_is_header = true;
 523
 524                                                                         peer.their_node_id = Some(their_node_id);
 525                                                                         insert_node_id!();
 526                                                                         let mut local_features = msgs::LocalFeatures::new();
 527                                                                         if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
 528                                                                                 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
 529                                                                                 local_features.set_initial_routing_sync();
 530                                                                         }
 531                                                                         encode_and_send_msg!(msgs::Init {
 532                                                                                 global_features: msgs::GlobalFeatures::new(),
 533                                                                                 local_features,
 534                                                                         }, 16);
 535                                                                 },
 536                                                                 NextNoiseStep::ActThree => {
 537                                                                         let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
 538                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 539                                                                         peer.pending_read_is_header = true;
 540                                                                         peer.their_node_id = Some(their_node_id);
 541                                                                         insert_node_id!();
 542                                                                 },
 543                                                                 NextNoiseStep::NoiseComplete => {
 544                                                                         if peer.pending_read_is_header {
 545                                                                                 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
 546                                                                                 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
 547                                                                                 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
 548                                                                                 if msg_len < 2 { // Need at least the message type tag
 549                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 550                                                                                 }
 551                                                                                 peer.pending_read_is_header = false;
 552                                                                         } else {
 553                                                                                 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
 554                                                                                 assert!(msg_data.len() >= 2);
 555
 556                                                                                 // Reset read buffer
 557                                                                                 peer.pending_read_buffer = [0; 18].to_vec();
 558                                                                                 peer.pending_read_is_header = true;
 559
 560                                                                                 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
 561                                                                                 log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
 562                                                                                 if msg_type != 16 && peer.their_global_features.is_none() {
 563                                                                                         // Need an init message as first message
 564                                                                                         log_trace!(self, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
 565                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 566                                                                                 }
 567                                                                                 let mut reader = ::std::io::Cursor::new(&msg_data[2..]);
 568                                                                                 match msg_type {
 569                                                                                         // Connection control:
 570                                                                                         16 => {
 571                                                                                                 let msg = try_potential_decodeerror!(msgs::Init::read(&mut reader));
 572                                                                                                 if msg.global_features.requires_unknown_bits() {
 573                                                                                                         log_info!(self, "Peer global features required unknown version bits");
 574                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
 575                                                                                                 }
 576                                                                                                 if msg.local_features.requires_unknown_bits() {
 577                                                                                                         log_info!(self, "Peer local features required unknown version bits");
 578                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
 579                                                                                                 }
 580                                                                                                 if msg.local_features.requires_data_loss_protect() {
 581                                                                                                         log_info!(self, "Peer local features required data_loss_protect");
 582                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
 583                                                                                                 }
 584                                                                                                 if msg.local_features.requires_upfront_shutdown_script() {
 585                                                                                                         log_info!(self, "Peer local features required upfront_shutdown_script");
 586                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
 587                                                                                                 }
 588                                                                                                 if peer.their_global_features.is_some() {
 589                                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 590                                                                                                 }
 591
 592                                                                                                 log_info!(self, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, unkown local flags: {}, unknown global flags: {}",
 593                                                                                                         if msg.local_features.supports_data_loss_protect() { "supported" } else { "not supported"},
 594                                                                                                         if msg.local_features.initial_routing_sync() { "requested" } else { "not requested" },
 595                                                                                                         if msg.local_features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
 596                                                                                                         if msg.local_features.supports_unknown_bits() { "present" } else { "none" },
 597                                                                                                         if msg.global_features.supports_unknown_bits() { "present" } else { "none" });
 598
 599                                                                                                 if msg.local_features.initial_routing_sync() {
 600                                                                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
 601                                                                                                         peers.peers_needing_send.insert(peer_descriptor.clone());
 602                                                                                                 }
 603                                                                                                 peer.their_global_features = Some(msg.global_features);
 604                                                                                                 peer.their_local_features = Some(msg.local_features);
 605
 606                                                                                                 if !peer.outbound {
 607                                                                                                         let mut local_features = msgs::LocalFeatures::new();
 608                                                                                                         if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
 609                                                                                                                 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
 610                                                                                                                 local_features.set_initial_routing_sync();
 611                                                                                                         }
 612
 613                                                                                                         encode_and_send_msg!(msgs::Init {
 614                                                                                                                 global_features: msgs::GlobalFeatures::new(),
 615                                                                                                                 local_features,
 616                                                                                                         }, 16);
 617                                                                                                 }
 618
 619                                                                                                 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap());
 620                                                                                         },
 621                                                                                         17 => {
 622                                                                                                 let msg = try_potential_decodeerror!(msgs::ErrorMessage::read(&mut reader));
 623                                                                                                 let mut data_is_printable = true;
 624                                                                                                 for b in msg.data.bytes() {
 625                                                                                                         if b < 32 || b > 126 {
 626                                                                                                                 data_is_printable = false;
 627                                                                                                                 break;
 628                                                                                                         }
 629                                                                                                 }
 630
 631                                                                                                 if data_is_printable {
 632                                                                                                         log_debug!(self, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
 633                                                                                                 } else {
 634                                                                                                         log_debug!(self, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
 635                                                                                                 }
 636                                                                                                 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
 637                                                                                                 if msg.channel_id == [0; 32] {
 638                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
 639                                                                                                 }
 640                                                                                         },
 641
 642                                                                                         18 => {
 643                                                                                                 let msg = try_potential_decodeerror!(msgs::Ping::read(&mut reader));
 644                                                                                                 if msg.ponglen < 65532 {
 645                                                                                                         let resp = msgs::Pong { byteslen: msg.ponglen };
 646                                                                                                         encode_and_send_msg!(resp, 19);
 647                                                                                                 }
 648                                                                                         },
 649                                                                                         19 => {
 650                                                                                                 try_potential_decodeerror!(msgs::Pong::read(&mut reader));
 651                                                                                         },
 652
 653                                                                                         // Channel control:
 654                                                                                         32 => {
 655                                                                                                 let msg = try_potential_decodeerror!(msgs::OpenChannel::read(&mut reader));
 656                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), &msg));
 657                                                                                         },
 658                                                                                         33 => {
 659                                                                                                 let msg = try_potential_decodeerror!(msgs::AcceptChannel::read(&mut reader));
 660                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), &msg));
 661                                                                                         },
 662
 663                                                                                         34 => {
 664                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingCreated::read(&mut reader));
 665                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg));
 666                                                                                         },
 667                                                                                         35 => {
 668                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingSigned::read(&mut reader));
 669                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg));
 670                                                                                         },
 671                                                                                         36 => {
 672                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingLocked::read(&mut reader));
 673                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg));
 674                                                                                         },
 675
 676                                                                                         38 => {
 677                                                                                                 let msg = try_potential_decodeerror!(msgs::Shutdown::read(&mut reader));
 678                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg));
 679                                                                                         },
 680                                                                                         39 => {
 681                                                                                                 let msg = try_potential_decodeerror!(msgs::ClosingSigned::read(&mut reader));
 682                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg));
 683                                                                                         },
 684
 685                                                                                         128 => {
 686                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::read(&mut reader));
 687                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg));
 688                                                                                         },
 689                                                                                         130 => {
 690                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::read(&mut reader));
 691                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg));
 692                                                                                         },
 693                                                                                         131 => {
 694                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::read(&mut reader));
 695                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
 696                                                                                         },
 697                                                                                         135 => {
 698                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::read(&mut reader));
 699                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg));
 700                                                                                         },
 701
 702                                                                                         132 => {
 703                                                                                                 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::read(&mut reader));
 704                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
 705                                                                                         },
 706                                                                                         133 => {
 707                                                                                                 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::read(&mut reader));
 708                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
 709                                                                                         },
 710                                                                                         134 => {
 711                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFee::read(&mut reader));
 712                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg));
 713                                                                                         },
 714                                                                                         136 => {
 715                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelReestablish::read(&mut reader));
 716                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg));
 717                                                                                         },
 718
 719                                                                                         // Routing control:
 720                                                                                         259 => {
 721                                                                                                 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::read(&mut reader));
 722                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg));
 723                                                                                         },
 724                                                                                         256 => {
 725                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::read(&mut reader));
 726                                                                                                 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
 727
 728                                                                                                 if should_forward {
 729                                                                                                         // TODO: forward msg along to all our other peers!
 730                                                                                                 }
 731                                                                                         },
 732                                                                                         257 => {
 733                                                                                                 let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::read(&mut reader));
 734                                                                                                 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
 735
 736                                                                                                 if should_forward {
 737                                                                                                         // TODO: forward msg along to all our other peers!
 738                                                                                                 }
 739                                                                                         },
 740                                                                                         258 => {
 741                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::read(&mut reader));
 742                                                                                                 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
 743
 744                                                                                                 if should_forward {
 745                                                                                                         // TODO: forward msg along to all our other peers!
 746                                                                                                 }
 747                                                                                         },
 748                                                                                         _ => {
 749                                                                                                 if (msg_type & 1) == 0 {
 750                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
 751                                                                                                 }
 752                                                                                         },
 753                                                                                 }
 754                                                                         }
 755                                                                 }
 756                                                         }
 757                                                 }
 758                                         }
 759
 760                                         self.do_attempt_write_data(peer_descriptor, peer);
 761
 762                                         peer.pending_outbound_buffer.len() > 10 // pause_read
 763                                 }
 764                         };
 765
 766                         pause_read
 767                 };
 768
 769                 Ok(pause_read)
 770         }
 771
 772         /// Checks for any events generated by our handlers and processes them. Includes sending most
 773         /// response messages as well as messages generated by calls to handler functions directly (eg
 774         /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
 775         pub fn process_events(&self) {
 776                 {
 777                         // TODO: There are some DoS attacks here where you can flood someone's outbound send
 778                         // buffer by doing things like announcing channels on another node. We should be willing to
 779                         // drop optional-ish messages when send buffers get full!
 780
 781                         let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
 782                         let mut peers_lock = self.peers.lock().unwrap();
 783                         let peers = peers_lock.borrow_parts();
 784                         for event in events_generated.drain(..) {
 785                                 macro_rules! get_peer_for_forwarding {
 786                                         ($node_id: expr, $handle_no_such_peer: block) => {
 787                                                 {
 788                                                         let descriptor = match peers.node_id_to_descriptor.get($node_id) {
 789                                                                 Some(descriptor) => descriptor.clone(),
 790                                                                 None => {
 791                                                                         $handle_no_such_peer;
 792                                                                         continue;
 793                                                                 },
 794                                                         };
 795                                                         match peers.peers.get_mut(&descriptor) {
 796                                                                 Some(peer) => {
 797                                                                         if peer.their_global_features.is_none() {
 798                                                                                 $handle_no_such_peer;
 799                                                                                 continue;
 800                                                                         }
 801                                                                         (descriptor, peer)
 802                                                                 },
 803                                                                 None => panic!("Inconsistent peers set state!"),
 804                                                         }
 805                                                 }
 806                                         }
 807                                 }
 808                                 match event {
 809                                         MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
 810                                                 log_trace!(self, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
 811                                                                 log_pubkey!(node_id),
 812                                                                 log_bytes!(msg.temporary_channel_id));
 813                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 814                                                                 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
 815                                                         });
 816                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 33)));
 817                                                 self.do_attempt_write_data(&mut descriptor, peer);
 818                                         },
 819                                         MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
 820                                                 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
 821                                                                 log_pubkey!(node_id),
 822                                                                 log_bytes!(msg.temporary_channel_id));
 823                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 824                                                                 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
 825                                                         });
 826                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
 827                                                 self.do_attempt_write_data(&mut descriptor, peer);
 828                                         },
 829                                         MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
 830                                                 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
 831                                                                 log_pubkey!(node_id),
 832                                                                 log_bytes!(msg.temporary_channel_id),
 833                                                                 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
 834                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 835                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
 836                                                                 //they should just throw away this funding transaction
 837                                                         });
 838                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
 839                                                 self.do_attempt_write_data(&mut descriptor, peer);
 840                                         },
 841                                         MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
 842                                                 log_trace!(self, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
 843                                                                 log_pubkey!(node_id),
 844                                                                 log_bytes!(msg.channel_id));
 845                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 846                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
 847                                                                 //they should just throw away this funding transaction
 848                                                         });
 849                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 35)));
 850                                                 self.do_attempt_write_data(&mut descriptor, peer);
 851                                         },
 852                                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
 853                                                 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
 854                                                                 log_pubkey!(node_id),
 855                                                                 log_bytes!(msg.channel_id));
 856                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 857                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 858                                                         });
 859                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
 860                                                 self.do_attempt_write_data(&mut descriptor, peer);
 861                                         },
 862                                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 863                                                 log_trace!(self, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
 864                                                                 log_pubkey!(node_id),
 865                                                                 log_bytes!(msg.channel_id));
 866                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 867                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
 868                                                                 //they should just throw away this funding transaction
 869                                                         });
 870                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 259)));
 871                                                 self.do_attempt_write_data(&mut descriptor, peer);
 872                                         },
 873                                         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 } } => {
 874                                                 log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
 875                                                                 log_pubkey!(node_id),
 876                                                                 update_add_htlcs.len(),
 877                                                                 update_fulfill_htlcs.len(),
 878                                                                 update_fail_htlcs.len(),
 879                                                                 log_bytes!(commitment_signed.channel_id));
 880                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 881                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 882                                                         });
 883                                                 for msg in update_add_htlcs {
 884                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
 885                                                 }
 886                                                 for msg in update_fulfill_htlcs {
 887                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
 888                                                 }
 889                                                 for msg in update_fail_htlcs {
 890                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
 891                                                 }
 892                                                 for msg in update_fail_malformed_htlcs {
 893                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 135)));
 894                                                 }
 895                                                 if let &Some(ref msg) = update_fee {
 896                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 134)));
 897                                                 }
 898                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed, 132)));
 899                                                 self.do_attempt_write_data(&mut descriptor, peer);
 900                                         },
 901                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 902                                                 log_trace!(self, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
 903                                                                 log_pubkey!(node_id),
 904                                                                 log_bytes!(msg.channel_id));
 905                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 906                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 907                                                         });
 908                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 133)));
 909                                                 self.do_attempt_write_data(&mut descriptor, peer);
 910                                         },
 911                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 912                                                 log_trace!(self, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
 913                                                                 log_pubkey!(node_id),
 914                                                                 log_bytes!(msg.channel_id));
 915                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 916                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 917                                                         });
 918                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 39)));
 919                                                 self.do_attempt_write_data(&mut descriptor, peer);
 920                                         },
 921                                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 922                                                 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
 923                                                                 log_pubkey!(node_id),
 924                                                                 log_bytes!(msg.channel_id));
 925                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 926                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 927                                                         });
 928                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
 929                                                 self.do_attempt_write_data(&mut descriptor, peer);
 930                                         },
 931                                         MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 932                                                 log_trace!(self, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
 933                                                                 log_pubkey!(node_id),
 934                                                                 log_bytes!(msg.channel_id));
 935                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 936                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 937                                                         });
 938                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 136)));
 939                                                 self.do_attempt_write_data(&mut descriptor, peer);
 940                                         },
 941                                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 942                                                 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
 943                                                 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
 944                                                         let encoded_msg = encode_msg!(msg, 256);
 945                                                         let encoded_update_msg = encode_msg!(update_msg, 258);
 946
 947                                                         for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
 948                                                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() ||
 949                                                                                 !peer.should_forward_channel(msg.contents.short_channel_id) {
 950                                                                         continue
 951                                                                 }
 952                                                                 match peer.their_node_id {
 953                                                                         None => continue,
 954                                                                         Some(their_node_id) => {
 955                                                                                 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
 956                                                                                         continue
 957                                                                                 }
 958                                                                         }
 959                                                                 }
 960                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
 961                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
 962                                                                 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
 963                                                         }
 964                                                 }
 965                                         },
 966                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 967                                                 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
 968                                                 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
 969                                                         let encoded_msg = encode_msg!(msg, 258);
 970
 971                                                         for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
 972                                                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() ||
 973                                                                                 !peer.should_forward_channel(msg.contents.short_channel_id)  {
 974                                                                         continue
 975                                                                 }
 976                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
 977                                                                 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
 978                                                         }
 979                                                 }
 980                                         },
 981                                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
 982                                                 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
 983                                         },
 984                                         MessageSendEvent::HandleError { ref node_id, ref action } => {
 985                                                 if let Some(ref action) = *action {
 986                                                         match *action {
 987                                                                 msgs::ErrorAction::DisconnectPeer { ref msg } => {
 988                                                                         if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
 989                                                                                 peers.peers_needing_send.remove(&descriptor);
 990                                                                                 if let Some(mut peer) = peers.peers.remove(&descriptor) {
 991                                                                                         if let Some(ref msg) = *msg {
 992                                                                                                 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
 993                                                                                                                 log_pubkey!(node_id),
 994                                                                                                                 msg.data);
 995                                                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
 996                                                                                                 // This isn't guaranteed to work, but if there is enough free
 997                                                                                                 // room in the send buffer, put the error message there...
 998                                                                                                 self.do_attempt_write_data(&mut descriptor, &mut peer);
 999                                                                                         } else {
1000                                                                                                 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1001                                                                                         }
1002                                                                                 }
1003                                                                                 descriptor.disconnect_socket();
1004                                                                                 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1005                                                                         }
1006                                                                 },
1007                                                                 msgs::ErrorAction::IgnoreError => {},
1008                                                                 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1009                                                                         log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1010                                                                                         log_pubkey!(node_id),
1011                                                                                         msg.data);
1012                                                                         let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1013                                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
1014                                                                         });
1015                                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
1016                                                                         self.do_attempt_write_data(&mut descriptor, peer);
1017                                                                 },
1018                                                         }
1019                                                 } else {
1020                                                         log_error!(self, "Got no-action HandleError Event in peer_handler for node {}, no such events should ever be generated!", log_pubkey!(node_id));
1021                                                 }
1022                                         }
1023                                 }
1024                         }
1025
1026                         for mut descriptor in peers.peers_needing_send.drain() {
1027                                 match peers.peers.get_mut(&descriptor) {
1028                                         Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1029                                         None => panic!("Inconsistent peers set state!"),
1030                                 }
1031                         }
1032                 }
1033         }
1034
1035         /// Indicates that the given socket descriptor's connection is now closed.
1036         ///
1037         /// This must be called even if a PeerHandleError was given for a read_event or write_event,
1038         /// but must NOT be called if a PeerHandleError was provided out of a new_\*\_connection event!
1039         ///
1040         /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1041         pub fn disconnect_event(&self, descriptor: &Descriptor) {
1042                 self.disconnect_event_internal(descriptor, false);
1043         }
1044
1045         fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1046                 let mut peers = self.peers.lock().unwrap();
1047                 peers.peers_needing_send.remove(descriptor);
1048                 let peer_option = peers.peers.remove(descriptor);
1049                 match peer_option {
1050                         None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1051                         Some(peer) => {
1052                                 match peer.their_node_id {
1053                                         Some(node_id) => {
1054                                                 peers.node_id_to_descriptor.remove(&node_id);
1055                                                 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1056                                         },
1057                                         None => {}
1058                                 }
1059                         }
1060                 };
1061         }
1062 }
1063
1064 #[cfg(test)]
1065 mod tests {
1066         use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1067         use ln::msgs;
1068         use util::events;
1069         use util::test_utils;
1070         use util::logger::Logger;
1071
1072         use secp256k1::Secp256k1;
1073         use secp256k1::key::{SecretKey, PublicKey};
1074
1075         use rand::{thread_rng, Rng};
1076
1077         use std::sync::{Arc};
1078
1079         #[derive(PartialEq, Eq, Clone, Hash)]
1080         struct FileDescriptor {
1081                 fd: u16,
1082         }
1083
1084         impl SocketDescriptor for FileDescriptor {
1085                 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, _resume_read: bool) -> usize {
1086                         assert!(write_offset < data.len());
1087                         data.len() - write_offset
1088                 }
1089
1090                 fn disconnect_socket(&mut self) {}
1091         }
1092
1093         fn create_network(peer_count: usize) -> Vec<PeerManager<FileDescriptor>> {
1094                 let mut peers = Vec::new();
1095                 let mut rng = thread_rng();
1096                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1097
1098                 for _ in 0..peer_count {
1099                         let chan_handler = test_utils::TestChannelMessageHandler::new();
1100                         let router = test_utils::TestRoutingMessageHandler::new();
1101                         let node_id = {
1102                                 let mut key_slice = [0;32];
1103                                 rng.fill_bytes(&mut key_slice);
1104                                 SecretKey::from_slice(&key_slice).unwrap()
1105                         };
1106                         let msg_handler = MessageHandler { chan_handler: Arc::new(chan_handler), route_handler: Arc::new(router) };
1107                         let peer = PeerManager::new(msg_handler, node_id, Arc::clone(&logger));
1108                         peers.push(peer);
1109                 }
1110
1111                 peers
1112         }
1113
1114         fn establish_connection(peer_a: &PeerManager<FileDescriptor>, peer_b: &PeerManager<FileDescriptor>) {
1115                 let secp_ctx = Secp256k1::new();
1116                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret);
1117                 let fd = FileDescriptor { fd: 1};
1118                 peer_a.new_inbound_connection(fd.clone()).unwrap();
1119                 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
1120         }
1121
1122         #[test]
1123         fn test_disconnect_peer() {
1124                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1125                 // push an DisconnectPeer event to remove the node flagged by id
1126                 let mut peers = create_network(2);
1127                 establish_connection(&peers[0], &peers[1]);
1128                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1129
1130                 let secp_ctx = Secp256k1::new();
1131                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1132
1133                 let chan_handler = test_utils::TestChannelMessageHandler::new();
1134                 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1135                         node_id: their_id,
1136                         action: Some(msgs::ErrorAction::DisconnectPeer { msg: None }),
1137                 });
1138                 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1139                 peers[0].message_handler.chan_handler = Arc::new(chan_handler);
1140
1141                 peers[0].process_events();
1142                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1143         }
1144 }