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