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