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

   1 use secp256k1::key::{SecretKey,PublicKey};
   2
   3 use ln::msgs;
   4 use ln::msgs::{MsgEncodable,MsgDecodable};
   5 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
   6 use util::byte_utils;
   7 use util::events::{EventsProvider,Event};
   8
   9 use std::collections::{HashMap,LinkedList};
  10 use std::sync::{Arc, Mutex};
  11 use std::{cmp,mem,hash,fmt};
  12
  13 pub struct MessageHandler {
  14         pub chan_handler: Arc<msgs::ChannelMessageHandler>,
  15         pub route_handler: Arc<msgs::RoutingMessageHandler>,
  16 }
  17
  18 /// Provides an object which can be used to send data to and which uniquely identifies a connection
  19 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
  20 /// implement Hash to meet the PeerManager API.
  21 /// For efficiency, Clone should be relatively cheap for this type.
  22 /// You probably want to just extend an int and put a file descriptor in a struct and implement
  23 /// send_data.
  24 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
  25         /// Attempts to send some data from the given Vec starting at the given offset to the peer.
  26         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
  27         /// Note that in the disconnected case, a disconnect_event must still fire and further write
  28         /// attempts may occur until that time.
  29         /// If the returned size is smaller than data.len() - write_offset, a write_available event must
  30         /// trigger the next time more data can be written. Additionally, until the a send_data event
  31         /// completes fully, no further read_events should trigger on the same peer!
  32         /// If a read_event on this descriptor had previously returned true (indicating that read
  33         /// events should be paused to prevent DoS in the send buffer), resume_read may be set
  34         /// indicating that read events on this descriptor should resume. A resume_read of false does
  35         /// *not* imply that further read events should be paused.
  36         fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, resume_read: bool) -> usize;
  37 }
  38
  39 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
  40 /// generate no further read/write_events for the descriptor, only triggering a single
  41 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
  42 /// no such disconnect_event must be generated and the socket be silently disconencted).
  43 pub struct PeerHandleError {}
  44 impl fmt::Debug for PeerHandleError {
  45         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
  46                 formatter.write_str("Peer Send Invalid Data")
  47         }
  48 }
  49
  50 struct Peer {
  51         channel_encryptor: PeerChannelEncryptor,
  52         their_node_id: Option<PublicKey>,
  53
  54         pending_outbound_buffer: LinkedList<Vec<u8>>,
  55         pending_outbound_buffer_first_msg_offset: usize,
  56         awaiting_write_event: bool,
  57
  58         pending_read_buffer: Vec<u8>,
  59         pending_read_buffer_pos: usize,
  60         pending_read_is_header: bool,
  61 }
  62
  63 struct PeerHolder<Descriptor: SocketDescriptor> {
  64         peers: HashMap<Descriptor, Peer>,
  65         /// Only add to this set when noise completes:
  66         node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
  67 }
  68
  69 pub struct PeerManager<Descriptor: SocketDescriptor> {
  70         message_handler: MessageHandler,
  71         peers: Mutex<PeerHolder<Descriptor>>,
  72         pending_events: Mutex<Vec<Event>>,
  73         our_node_secret: SecretKey,
  74 }
  75
  76
  77 macro_rules! encode_msg {
  78         ($msg: expr, $msg_code: expr) => {
  79                 {
  80                         let just_msg = $msg.encode();
  81                         let mut encoded_msg = Vec::with_capacity(just_msg.len() + 2);
  82                         encoded_msg.extend_from_slice(&byte_utils::be16_to_array($msg_code));
  83                         encoded_msg.extend_from_slice(&just_msg[..]);
  84                         encoded_msg
  85                 }
  86         }
  87 }
  88
  89 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
  90 /// PeerIds may repeat, but only after disconnect_event() has been called.
  91 impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
  92         pub fn new(message_handler: MessageHandler, our_node_secret: SecretKey) -> PeerManager<Descriptor> {
  93                 PeerManager {
  94                         message_handler: message_handler,
  95                         peers: Mutex::new(PeerHolder { peers: HashMap::new(), node_id_to_descriptor: HashMap::new() }),
  96                         pending_events: Mutex::new(Vec::new()),
  97                         our_node_secret: our_node_secret,
  98                 }
  99         }
 100
 101         /// Indicates a new outbound connection has been established to a node with the given node_id.
 102         /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
 103         /// descriptor but must disconnect the connection immediately.
 104         /// Returns some bytes to send to the remote node.
 105         /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
 106         /// disconnect_event.
 107         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
 108                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone());
 109                 let res = peer_encryptor.get_act_one().to_vec();
 110                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
 111
 112                 let mut peers = self.peers.lock().unwrap();
 113                 if peers.peers.insert(descriptor, Peer {
 114                         channel_encryptor: peer_encryptor,
 115                         their_node_id: Some(their_node_id),
 116
 117                         pending_outbound_buffer: LinkedList::new(),
 118                         pending_outbound_buffer_first_msg_offset: 0,
 119                         awaiting_write_event: false,
 120
 121                         pending_read_buffer: pending_read_buffer,
 122                         pending_read_buffer_pos: 0,
 123                         pending_read_is_header: false,
 124                 }).is_some() {
 125                         panic!("PeerManager driver duplicated descriptors!");
 126                 };
 127                 Ok(res)
 128         }
 129
 130         /// Indicates a new inbound connection has been established.
 131         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
 132         /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
 133         /// call disconnect_event for the new descriptor but must disconnect the connection
 134         /// immediately.
 135         /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
 136         /// disconnect_event.
 137         pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
 138                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
 139                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
 140
 141                 let mut peers = self.peers.lock().unwrap();
 142                 if peers.peers.insert(descriptor, Peer {
 143                         channel_encryptor: peer_encryptor,
 144                         their_node_id: None,
 145
 146                         pending_outbound_buffer: LinkedList::new(),
 147                         pending_outbound_buffer_first_msg_offset: 0,
 148                         awaiting_write_event: false,
 149
 150                         pending_read_buffer: pending_read_buffer,
 151                         pending_read_buffer_pos: 0,
 152                         pending_read_is_header: false,
 153                 }).is_some() {
 154                         panic!("PeerManager driver duplicated descriptors!");
 155                 };
 156                 Ok(())
 157         }
 158
 159         fn do_attempt_write_data(descriptor: &mut Descriptor, peer: &mut Peer) {
 160                 while !peer.awaiting_write_event {
 161                         if {
 162                                 let next_buff = match peer.pending_outbound_buffer.front() {
 163                                         None => return,
 164                                         Some(buff) => buff,
 165                                 };
 166                                 let should_be_reading = peer.pending_outbound_buffer.len() < 10;
 167
 168                                 let data_sent = descriptor.send_data(next_buff, peer.pending_outbound_buffer_first_msg_offset, should_be_reading);
 169                                 peer.pending_outbound_buffer_first_msg_offset += data_sent;
 170                                 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
 171                         } {
 172                                 peer.pending_outbound_buffer_first_msg_offset = 0;
 173                                 peer.pending_outbound_buffer.pop_front();
 174                         } else {
 175                                 peer.awaiting_write_event = true;
 176                         }
 177                 }
 178         }
 179
 180         /// Indicates that there is room to write data to the given socket descriptor.
 181         /// May return an Err to indicate that the connection should be closed.
 182         /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
 183         /// new_*_connection) before returning. Thus, be very careful with reentrancy issues! The
 184         /// invariants around calling write_event in case a write did not fully complete must still
 185         /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
 186         /// Panics if the descriptor was not previously registered in a new_*_connection event.
 187         pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
 188                 let mut peers = self.peers.lock().unwrap();
 189                 match peers.peers.get_mut(descriptor) {
 190                         None => panic!("Descriptor for write_event is not already known to PeerManager"),
 191                         Some(peer) => {
 192                                 peer.awaiting_write_event = false;
 193                                 Self::do_attempt_write_data(descriptor, peer);
 194                         }
 195                 };
 196                 Ok(())
 197         }
 198
 199         /// Indicates that data was read from the given socket descriptor.
 200         /// May return an Err to indicate that the connection should be closed.
 201         /// Will very likely call send_data on the descriptor passed in (or a descriptor handed into
 202         /// new_*_connection) before returning. Thus, be very careful with reentrancy issues! The
 203         /// invariants around calling write_event in case a write did not fully complete must still
 204         /// hold. Note that this function will often call send_data on many peers before returning, not
 205         /// just this peer!
 206         /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
 207         /// this file descriptor has resume_read set (preventing DoS issues in the send buffer). Note
 208         /// that this must be true even if a send_data call with resume_read=true was made during the
 209         /// course of this function!
 210         /// Panics if the descriptor was not previously registered in a new_*_connection event.
 211         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
 212                 match self.do_read_event(peer_descriptor, data) {
 213                         Ok(res) => Ok(res),
 214                         Err(e) => {
 215                                 self.disconnect_event(peer_descriptor);
 216                                 Err(e)
 217                         }
 218                 }
 219         }
 220
 221         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
 222                 let pause_read = {
 223                         let mut peers = self.peers.lock().unwrap();
 224                         let (should_insert_node_id, pause_read) = match peers.peers.get_mut(peer_descriptor) {
 225                                 None => panic!("Descriptor for read_event is not already known to PeerManager"),
 226                                 Some(peer) => {
 227                                         assert!(peer.pending_read_buffer.len() > 0);
 228                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 229
 230                                         macro_rules! try_potential_handleerror {
 231                                                 ($thing: expr) => {
 232                                                         match $thing {
 233                                                                 Ok(x) => x,
 234                                                                 Err(_e) => {
 235                                                                         //TODO: Handle e appropriately!
 236                                                                         return Err(PeerHandleError{});
 237                                                                 }
 238                                                         };
 239                                                 }
 240                                         }
 241
 242                                         macro_rules! try_potential_decodeerror {
 243                                                 ($thing: expr) => {
 244                                                         match $thing {
 245                                                                 Ok(x) => x,
 246                                                                 Err(_e) => {
 247                                                                         //TODO: Handle e?
 248                                                                         return Err(PeerHandleError{});
 249                                                                 }
 250                                                         };
 251                                                 }
 252                                         }
 253
 254                                         macro_rules! encode_and_send_msg {
 255                                                 ($msg: expr, $msg_code: expr) => {
 256                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
 257                                                 }
 258                                         }
 259
 260                                         let mut insert_node_id = None;
 261
 262                                         let mut read_pos = 0;
 263                                         while read_pos < data.len() {
 264                                                 {
 265                                                         let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
 266                                                         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]);
 267                                                         read_pos += data_to_copy;
 268                                                         peer.pending_read_buffer_pos += data_to_copy;
 269                                                 }
 270                                                 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
 271                                                         let next_step = peer.channel_encryptor.get_noise_step();
 272                                                         match next_step {
 273                                                                 NextNoiseStep::ActOne => {
 274                                                                         let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_key(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
 275                                                                         peer.pending_outbound_buffer.push_back(act_two);
 276                                                                         peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
 277                                                                 },
 278                                                                 NextNoiseStep::ActTwo => {
 279                                                                         let act_three = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
 280                                                                         peer.pending_outbound_buffer.push_back(act_three);
 281                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 282
 283                                                                         insert_node_id = Some(peer.their_node_id.unwrap());
 284                                                                         encode_and_send_msg!(msgs::Init {
 285                                                                                 global_features: msgs::GlobalFeatures::new(),
 286                                                                                 local_features: msgs::LocalFeatures::new(),
 287                                                                         }, 16);
 288                                                                 },
 289                                                                 NextNoiseStep::ActThree => {
 290                                                                         let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
 291                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 292                                                                         peer.pending_read_is_header = true;
 293                                                                         peer.their_node_id = Some(their_node_id);
 294                                                                         insert_node_id = Some(peer.their_node_id.unwrap());
 295                                                                 },
 296                                                                 NextNoiseStep::NoiseComplete => {
 297                                                                         if peer.pending_read_is_header {
 298                                                                                 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
 299                                                                                 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
 300                                                                                 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
 301                                                                                 if msg_len < 2 { // Need at least the message type tag
 302                                                                                         return Err(PeerHandleError{});
 303                                                                                 }
 304                                                                                 peer.pending_read_is_header = false;
 305                                                                         } else {
 306                                                                                 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
 307                                                                                 assert!(msg_data.len() >= 2);
 308
 309                                                                                 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
 310                                                                                 match msg_type {
 311                                                                                         // Connection control:
 312                                                                                         16 => {
 313                                                                                                 let msg = try_potential_decodeerror!(msgs::Init::decode(&msg_data[2..]));
 314                                                                                                 if msg.global_features.requires_unknown_bits() {
 315                                                                                                         return Err(PeerHandleError{});
 316                                                                                                 }
 317                                                                                                 if msg.local_features.requires_unknown_bits() {
 318                                                                                                         return Err(PeerHandleError{});
 319                                                                                                 }
 320                                                                                                 //TODO: Store features!
 321                                                                                         },
 322                                                                                         17 => {
 323                                                                                                 // Error msg
 324                                                                                         },
 325                                                                                         18 => { }, // ping
 326                                                                                         19 => { }, // pong
 327
 328                                                                                         // Channel control:
 329                                                                                         32 => {
 330                                                                                                 let msg = try_potential_decodeerror!(msgs::OpenChannel::decode(&msg_data[2..]));
 331                                                                                                 let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), &msg));
 332                                                                                                 encode_and_send_msg!(resp, 33);
 333                                                                                         },
 334                                                                                         33 => {
 335                                                                                                 let msg = try_potential_decodeerror!(msgs::AcceptChannel::decode(&msg_data[2..]));
 336                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), &msg));
 337                                                                                         },
 338
 339                                                                                         34 => {
 340                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingCreated::decode(&msg_data[2..]));
 341                                                                                                 let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg));
 342                                                                                                 encode_and_send_msg!(resp, 35);
 343                                                                                         },
 344                                                                                         35 => {
 345                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingSigned::decode(&msg_data[2..]));
 346                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg));
 347                                                                                         },
 348                                                                                         36 => {
 349                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingLocked::decode(&msg_data[2..]));
 350                                                                                                 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg));
 351                                                                                                 match resp_option {
 352                                                                                                         Some(resp) => encode_and_send_msg!(resp, 259),
 353                                                                                                         None => {},
 354                                                                                                 }
 355                                                                                         },
 356
 357                                                                                         38 => {
 358                                                                                                 let msg = try_potential_decodeerror!(msgs::Shutdown::decode(&msg_data[2..]));
 359                                                                                                 let resp_options = try_potential_handleerror!(self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg));
 360                                                                                                 if let Some(resp) = resp_options.0 {
 361                                                                                                         encode_and_send_msg!(resp, 38);
 362                                                                                                 }
 363                                                                                                 if let Some(resp) = resp_options.1 {
 364                                                                                                         encode_and_send_msg!(resp, 39);
 365                                                                                                 }
 366                                                                                         },
 367                                                                                         39 => {
 368                                                                                                 let msg = try_potential_decodeerror!(msgs::ClosingSigned::decode(&msg_data[2..]));
 369                                                                                                 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg));
 370                                                                                                 if let Some(resp) = resp_option {
 371                                                                                                         encode_and_send_msg!(resp, 39);
 372                                                                                                 }
 373                                                                                         },
 374
 375                                                                                         128 => {
 376                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::decode(&msg_data[2..]));
 377                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg));
 378                                                                                         },
 379                                                                                         130 => {
 380                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::decode(&msg_data[2..]));
 381                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg));
 382                                                                                         },
 383                                                                                         131 => {
 384                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::decode(&msg_data[2..]));
 385                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
 386                                                                                         },
 387                                                                                         135 => {
 388                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::decode(&msg_data[2..]));
 389                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg));
 390                                                                                         },
 391
 392                                                                                         132 => {
 393                                                                                                 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::decode(&msg_data[2..]));
 394                                                                                                 let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
 395                                                                                                 encode_and_send_msg!(resp, 133);
 396                                                                                         },
 397                                                                                         133 => {
 398                                                                                                 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::decode(&msg_data[2..]));
 399                                                                                                 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
 400                                                                                                 match resp_option {
 401                                                                                                         Some(resps) => {
 402                                                                                                                 for resp in resps.0 {
 403                                                                                                                         encode_and_send_msg!(resp, 128);
 404                                                                                                                 }
 405                                                                                                                 encode_and_send_msg!(resps.1, 132);
 406                                                                                                         },
 407                                                                                                         None => {},
 408                                                                                                 }
 409                                                                                         },
 410                                                                                         134 => {
 411                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFee::decode(&msg_data[2..]));
 412                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg));
 413                                                                                         },
 414                                                                                         136 => { }, // TODO: channel_reestablish
 415
 416                                                                                         // Routing control:
 417                                                                                         259 => {
 418                                                                                                 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::decode(&msg_data[2..]));
 419                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg));
 420                                                                                         },
 421                                                                                         256 => {
 422                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::decode(&msg_data[2..]));
 423                                                                                                 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
 424
 425                                                                                                 if should_forward {
 426                                                                                                         // TODO: forward msg along to all our other peers!
 427                                                                                                 }
 428                                                                                         },
 429                                                                                         257 => {
 430                                                                                                 let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::decode(&msg_data[2..]));
 431                                                                                                 try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
 432                                                                                         },
 433                                                                                         258 => {
 434                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::decode(&msg_data[2..]));
 435                                                                                                 try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
 436                                                                                         },
 437                                                                                         _ => {
 438                                                                                                 if (msg_type & 1) == 0 {
 439                                                                                                         //TODO: Fail all channels. Kill the peer!
 440                                                                                                         return Err(PeerHandleError{});
 441                                                                                                 }
 442                                                                                         },
 443                                                                                 }
 444
 445                                                                                 peer.pending_read_buffer = [0; 18].to_vec();
 446                                                                                 peer.pending_read_is_header = true;
 447                                                                         }
 448                                                                 }
 449                                                         }
 450                                                         peer.pending_read_buffer_pos = 0;
 451                                                 }
 452                                         }
 453
 454                                         Self::do_attempt_write_data(peer_descriptor, peer);
 455
 456                                         (insert_node_id /* should_insert_node_id */, peer.pending_outbound_buffer.len() > 10) // pause_read
 457                                 }
 458                         };
 459
 460                         match should_insert_node_id {
 461                                 Some(node_id) => { peers.node_id_to_descriptor.insert(node_id, peer_descriptor.clone()); },
 462                                 None => {}
 463                         };
 464
 465                         pause_read
 466                 };
 467
 468                 self.process_events();
 469
 470                 Ok(pause_read)
 471         }
 472
 473         /// Checks for any events generated by our handlers and processes them. May be needed after eg
 474         /// calls to ChannelManager::process_pending_htlc_forward.
 475         pub fn process_events(&self) {
 476                 let mut upstream_events = Vec::new();
 477                 {
 478                         // TODO: There are some DoS attacks here where you can flood someone's outbound send
 479                         // buffer by doing things like announcing channels on another node. We should be willing to
 480                         // drop optional-ish messages when send buffers get full!
 481
 482                         let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_events();
 483                         let mut peers = self.peers.lock().unwrap();
 484                         for event in events_generated.drain(..) {
 485                                 macro_rules! get_peer_for_forwarding {
 486                                         ($node_id: expr, $handle_no_such_peer: block) => {
 487                                                 {
 488                                                         let descriptor = match peers.node_id_to_descriptor.get($node_id) {
 489                                                                 Some(descriptor) => descriptor.clone(),
 490                                                                 None => {
 491                                                                         $handle_no_such_peer;
 492                                                                         continue;
 493                                                                 },
 494                                                         };
 495                                                         match peers.peers.get_mut(&descriptor) {
 496                                                                 Some(peer) => {
 497                                                                         (descriptor, peer)
 498                                                                 },
 499                                                                 None => panic!("Inconsistent peers set state!"),
 500                                                         }
 501                                                 }
 502                                         }
 503                                 }
 504                                 match event {
 505                                         Event::FundingGenerationReady {..} => { /* Hand upstream */ },
 506                                         Event::FundingBroadcastSafe {..} => { /* Hand upstream */ },
 507                                         Event::PaymentReceived {..} => { /* Hand upstream */ },
 508                                         Event::PaymentSent {..} => { /* Hand upstream */ },
 509                                         Event::PaymentFailed {..} => { /* Hand upstream */ },
 510
 511                                         Event::PendingHTLCsForwardable {..} => {
 512                                                 //TODO: Handle upstream in some confused form so that upstream just knows
 513                                                 //to call us somehow?
 514                                         },
 515                                         Event::SendFundingCreated { ref node_id, ref msg } => {
 516                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 517                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
 518                                                                 //they should just throw away this funding transaction
 519                                                         });
 520                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
 521                                                 Self::do_attempt_write_data(&mut descriptor, peer);
 522                                                 continue;
 523                                         },
 524                                         Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
 525                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 526                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 527                                                         });
 528                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
 529                                                 match announcement_sigs {
 530                                                         &Some(ref announce_msg) => peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(announce_msg, 259))),
 531                                                         &None => {},
 532                                                 }
 533                                                 Self::do_attempt_write_data(&mut descriptor, peer);
 534                                                 continue;
 535                                         },
 536                                         Event::SendHTLCs { ref node_id, ref msgs, ref commitment_msg } => {
 537                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 538                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 539                                                         });
 540                                                 for msg in msgs {
 541                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
 542                                                 }
 543                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_msg, 132)));
 544                                                 Self::do_attempt_write_data(&mut descriptor, peer);
 545                                                 continue;
 546                                         },
 547                                         Event::SendFulfillHTLC { ref node_id, ref msg } => {
 548                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 549                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 550                                                         });
 551                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
 552                                                 Self::do_attempt_write_data(&mut descriptor, peer);
 553                                                 continue;
 554                                         },
 555                                         Event::SendFailHTLC { ref node_id, ref msg } => {
 556                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 557                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 558                                                         });
 559                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
 560                                                 Self::do_attempt_write_data(&mut descriptor, peer);
 561                                                 continue;
 562                                         },
 563                                         Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 564                                                 let encoded_msg = encode_msg!(msg, 256);
 565                                                 let encoded_update_msg = encode_msg!(update_msg, 258);
 566
 567                                                 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
 568                                                         if !peer.channel_encryptor.is_ready_for_encryption() {
 569                                                                 continue
 570                                                         }
 571                                                         match peer.their_node_id {
 572                                                                 None => continue,
 573                                                                 Some(their_node_id) => {
 574                                                                         if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
 575                                                                                 continue
 576                                                                         }
 577                                                                 }
 578                                                         }
 579                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
 580                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
 581                                                         Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
 582                                                 }
 583                                                 continue;
 584                                         },
 585                                 }
 586
 587                                 upstream_events.push(event);
 588                         }
 589                 }
 590
 591                 let mut pending_events = self.pending_events.lock().unwrap();
 592                 for event in upstream_events.drain(..) {
 593                         pending_events.push(event);
 594                 }
 595         }
 596
 597         /// Indicates that the given socket descriptor's connection is now closed.
 598         /// This must be called even if a PeerHandleError was given for a read_event or write_event,
 599         /// but must NOT be called if a PeerHandleError was provided out of a new_*_connection event!
 600         /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
 601         pub fn disconnect_event(&self, descriptor: &Descriptor) {
 602                 let mut peers = self.peers.lock().unwrap();
 603                 let peer_option = peers.peers.remove(descriptor);
 604                 match peer_option {
 605                         None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
 606                         Some(peer) => {
 607                                 match peer.their_node_id {
 608                                         Some(node_id) => { peers.node_id_to_descriptor.remove(&node_id); },
 609                                         None => {}
 610                                 }
 611                                 //TODO: Notify the chan_handler that this node disconnected, and do something about
 612                                 //handling response messages that were queued for sending (maybe the send buffer
 613                                 //needs to be unencrypted?)
 614                         }
 615                 };
 616         }
 617 }
 618
 619 impl<Descriptor: SocketDescriptor> EventsProvider for PeerManager<Descriptor> {
 620         fn get_and_clear_pending_events(&self) -> Vec<Event> {
 621                 let mut pending_events = self.pending_events.lock().unwrap();
 622                 let mut ret = Vec::new();
 623                 mem::swap(&mut ret, &mut *pending_events);
 624                 ret
 625         }
 626 }