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