1 use secp256k1::key::{SecretKey,PublicKey};
4 use util::ser::{Writeable, Writer, Readable};
5 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
7 use util::events::{EventsProvider,Event};
8 use util::logger::Logger;
10 use std::collections::{HashMap,hash_map,LinkedList};
11 use std::sync::{Arc, Mutex};
12 use std::sync::atomic::{AtomicUsize, Ordering};
13 use std::{cmp,error,mem,hash,fmt};
15 pub struct MessageHandler {
16 pub chan_handler: Arc<msgs::ChannelMessageHandler>,
17 pub route_handler: Arc<msgs::RoutingMessageHandler>,
20 /// Provides an object which can be used to send data to and which uniquely identifies a connection
21 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
22 /// implement Hash to meet the PeerManager API.
23 /// For efficiency, Clone should be relatively cheap for this type.
24 /// You probably want to just extend an int and put a file descriptor in a struct and implement
25 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
26 /// careful to ensure you don't have races whereby you might register a new connection with an fd
27 /// the same as a yet-to-be-disconnect_event()-ed.
28 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
29 /// Attempts to send some data from the given Vec starting at the given offset to the peer.
30 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
31 /// Note that in the disconnected case, a disconnect_event must still fire and further write
32 /// attempts may occur until that time.
33 /// If the returned size is smaller than data.len() - write_offset, a write_available event must
34 /// trigger the next time more data can be written. Additionally, until the a send_data event
35 /// completes fully, no further read_events should trigger on the same peer!
36 /// If a read_event on this descriptor had previously returned true (indicating that read
37 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
38 /// indicating that read events on this descriptor should resume. A resume_read of false does
39 /// *not* imply that further read events should be paused.
40 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, resume_read: bool) -> usize;
41 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
42 /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
43 /// No disconnect_event should be generated as a result of this call, though obviously races
44 /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
45 /// that event completing.
46 fn disconnect_socket(&mut self);
49 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
50 /// generate no further read/write_events for the descriptor, only triggering a single
51 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
52 /// no such disconnect_event must be generated and the socket be silently disconencted).
53 pub struct PeerHandleError {
54 no_connection_possible: bool,
56 impl fmt::Debug for PeerHandleError {
57 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
58 formatter.write_str("Peer Sent Invalid Data")
61 impl fmt::Display for PeerHandleError {
62 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
63 formatter.write_str("Peer Sent Invalid Data")
66 impl error::Error for PeerHandleError {
67 fn description(&self) -> &str {
68 "Peer Sent Invalid Data"
73 channel_encryptor: PeerChannelEncryptor,
75 their_node_id: Option<PublicKey>,
76 their_global_features: Option<msgs::GlobalFeatures>,
77 their_local_features: Option<msgs::LocalFeatures>,
79 pending_outbound_buffer: LinkedList<Vec<u8>>,
80 pending_outbound_buffer_first_msg_offset: usize,
81 awaiting_write_event: bool,
83 pending_read_buffer: Vec<u8>,
84 pending_read_buffer_pos: usize,
85 pending_read_is_header: bool,
88 struct PeerHolder<Descriptor: SocketDescriptor> {
89 peers: HashMap<Descriptor, Peer>,
90 /// Only add to this set when noise completes:
91 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
93 struct MutPeerHolder<'a, Descriptor: SocketDescriptor + 'a> {
94 peers: &'a mut HashMap<Descriptor, Peer>,
95 node_id_to_descriptor: &'a mut HashMap<PublicKey, Descriptor>,
97 impl<Descriptor: SocketDescriptor> PeerHolder<Descriptor> {
98 fn borrow_parts(&mut self) -> MutPeerHolder<Descriptor> {
100 peers: &mut self.peers,
101 node_id_to_descriptor: &mut self.node_id_to_descriptor,
106 pub struct PeerManager<Descriptor: SocketDescriptor> {
107 message_handler: MessageHandler,
108 peers: Mutex<PeerHolder<Descriptor>>,
109 pending_events: Mutex<Vec<Event>>,
110 our_node_secret: SecretKey,
111 initial_syncs_sent: AtomicUsize,
115 struct VecWriter(Vec<u8>);
116 impl Writer for VecWriter {
117 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
118 self.0.extend_from_slice(buf);
121 fn size_hint(&mut self, size: usize) {
122 self.0.reserve_exact(size);
126 macro_rules! encode_msg {
127 ($msg: expr, $msg_code: expr) => {{
128 let mut msg = VecWriter(Vec::new());
129 ($msg_code as u16).write(&mut msg).unwrap();
130 $msg.write(&mut msg).unwrap();
135 //TODO: Really should do something smarter for this
136 const INITIAL_SYNCS_TO_SEND: usize = 5;
138 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
139 /// PeerIds may repeat, but only after disconnect_event() has been called.
140 impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
141 pub fn new(message_handler: MessageHandler, our_node_secret: SecretKey, logger: Arc<Logger>) -> PeerManager<Descriptor> {
143 message_handler: message_handler,
144 peers: Mutex::new(PeerHolder { peers: HashMap::new(), node_id_to_descriptor: HashMap::new() }),
145 pending_events: Mutex::new(Vec::new()),
146 our_node_secret: our_node_secret,
147 initial_syncs_sent: AtomicUsize::new(0),
152 /// Get the list of node ids for peers which have completed the initial handshake.
153 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
154 /// new_outbound_connection, however entries will only appear once the initial handshake has
155 /// completed and we are sure the remote peer has the private key for the given node_id.
156 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
157 let peers = self.peers.lock().unwrap();
158 peers.peers.values().filter_map(|p| {
159 if !p.channel_encryptor.is_ready_for_encryption() || p.their_global_features.is_none() {
166 /// Indicates a new outbound connection has been established to a node with the given node_id.
167 /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
168 /// descriptor but must disconnect the connection immediately.
169 /// Returns some bytes to send to the remote node.
170 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
171 /// disconnect_event.
172 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
173 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone());
174 let res = peer_encryptor.get_act_one().to_vec();
175 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
177 let mut peers = self.peers.lock().unwrap();
178 if peers.peers.insert(descriptor, Peer {
179 channel_encryptor: peer_encryptor,
181 their_node_id: Some(their_node_id),
182 their_global_features: None,
183 their_local_features: None,
185 pending_outbound_buffer: LinkedList::new(),
186 pending_outbound_buffer_first_msg_offset: 0,
187 awaiting_write_event: false,
189 pending_read_buffer: pending_read_buffer,
190 pending_read_buffer_pos: 0,
191 pending_read_is_header: false,
193 panic!("PeerManager driver duplicated descriptors!");
198 /// Indicates a new inbound connection has been established.
199 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
200 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
201 /// call disconnect_event for the new descriptor but must disconnect the connection
203 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
204 /// disconnect_event.
205 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
206 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
207 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
209 let mut peers = self.peers.lock().unwrap();
210 if peers.peers.insert(descriptor, Peer {
211 channel_encryptor: peer_encryptor,
214 their_global_features: None,
215 their_local_features: None,
217 pending_outbound_buffer: LinkedList::new(),
218 pending_outbound_buffer_first_msg_offset: 0,
219 awaiting_write_event: false,
221 pending_read_buffer: pending_read_buffer,
222 pending_read_buffer_pos: 0,
223 pending_read_is_header: false,
225 panic!("PeerManager driver duplicated descriptors!");
230 fn do_attempt_write_data(descriptor: &mut Descriptor, peer: &mut Peer) {
231 while !peer.awaiting_write_event {
233 let next_buff = match peer.pending_outbound_buffer.front() {
237 let should_be_reading = peer.pending_outbound_buffer.len() < 10;
239 let data_sent = descriptor.send_data(next_buff, peer.pending_outbound_buffer_first_msg_offset, should_be_reading);
240 peer.pending_outbound_buffer_first_msg_offset += data_sent;
241 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
243 peer.pending_outbound_buffer_first_msg_offset = 0;
244 peer.pending_outbound_buffer.pop_front();
246 peer.awaiting_write_event = true;
251 /// Indicates that there is room to write data to the given socket descriptor.
252 /// May return an Err to indicate that the connection should be closed.
253 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
254 /// new_*_connection) before returning. Thus, be very careful with reentrancy issues! The
255 /// invariants around calling write_event in case a write did not fully complete must still
256 /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
257 /// Panics if the descriptor was not previously registered in a new_*_connection event.
258 pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
259 let mut peers = self.peers.lock().unwrap();
260 match peers.peers.get_mut(descriptor) {
261 None => panic!("Descriptor for write_event is not already known to PeerManager"),
263 peer.awaiting_write_event = false;
264 Self::do_attempt_write_data(descriptor, peer);
270 /// Indicates that data was read from the given socket descriptor.
271 /// May return an Err to indicate that the connection should be closed.
272 /// Will very likely call send_data on the descriptor passed in (or a descriptor handed into
273 /// new_*_connection) before returning. Thus, be very careful with reentrancy issues! The
274 /// invariants around calling write_event in case a write did not fully complete must still
275 /// hold. Note that this function will often call send_data on many peers before returning, not
277 /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
278 /// this file descriptor has resume_read set (preventing DoS issues in the send buffer). Note
279 /// that this must be true even if a send_data call with resume_read=true was made during the
280 /// course of this function!
281 /// Panics if the descriptor was not previously registered in a new_*_connection event.
282 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
283 match self.do_read_event(peer_descriptor, data) {
286 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
292 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
294 let mut peers_lock = self.peers.lock().unwrap();
295 let peers = peers_lock.borrow_parts();
296 let pause_read = match peers.peers.get_mut(peer_descriptor) {
297 None => panic!("Descriptor for read_event is not already known to PeerManager"),
299 assert!(peer.pending_read_buffer.len() > 0);
300 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
302 let mut read_pos = 0;
303 while read_pos < data.len() {
305 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
306 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]);
307 read_pos += data_to_copy;
308 peer.pending_read_buffer_pos += data_to_copy;
311 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
312 peer.pending_read_buffer_pos = 0;
314 macro_rules! encode_and_send_msg {
315 ($msg: expr, $msg_code: expr) => {
317 log_trace!(self, "Encoding and sending message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
318 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
323 macro_rules! try_potential_handleerror {
328 if let Some(action) = e.action {
330 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
331 //TODO: Try to push msg
332 log_trace!(self, "Got Err handling message, disconnecting peer because {}", e.err);
333 return Err(PeerHandleError{ no_connection_possible: false });
335 msgs::ErrorAction::IgnoreError => {
336 log_trace!(self, "Got Err handling message, ignoring because {}", e.err);
339 msgs::ErrorAction::SendErrorMessage { msg } => {
340 log_trace!(self, "Got Err handling message, sending Error message because {}", e.err);
341 encode_and_send_msg!(msg, 17);
346 log_debug!(self, "Got Err handling message, action not yet filled in: {}", e.err);
347 return Err(PeerHandleError{ no_connection_possible: false });
354 macro_rules! try_potential_decodeerror {
360 msgs::DecodeError::UnknownRealmByte => return Err(PeerHandleError{ no_connection_possible: false }),
361 msgs::DecodeError::UnknownRequiredFeature => {
362 log_debug!(self, "Got a channel/node announcement with an known required feature flag, you may want to udpate!");
365 msgs::DecodeError::BadPublicKey => return Err(PeerHandleError{ no_connection_possible: false }),
366 msgs::DecodeError::BadSignature => return Err(PeerHandleError{ no_connection_possible: false }),
367 msgs::DecodeError::BadText => return Err(PeerHandleError{ no_connection_possible: false }),
368 msgs::DecodeError::ShortRead => return Err(PeerHandleError{ no_connection_possible: false }),
369 msgs::DecodeError::ExtraAddressesPerType => {
370 log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
373 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
374 msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
375 msgs::DecodeError::InvalidValue => panic!("should not happen with message decoding"),
382 macro_rules! insert_node_id {
384 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
385 hash_map::Entry::Occupied(_) => {
386 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
387 return Err(PeerHandleError{ no_connection_possible: false })
389 hash_map::Entry::Vacant(entry) => entry.insert(peer_descriptor.clone()),
394 let next_step = peer.channel_encryptor.get_noise_step();
396 NextNoiseStep::ActOne => {
397 let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_key(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
398 peer.pending_outbound_buffer.push_back(act_two);
399 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
401 NextNoiseStep::ActTwo => {
402 let act_three = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
403 peer.pending_outbound_buffer.push_back(act_three);
404 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
405 peer.pending_read_is_header = true;
408 let mut local_features = msgs::LocalFeatures::new();
409 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
410 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
411 local_features.set_initial_routing_sync();
413 encode_and_send_msg!(msgs::Init {
414 global_features: msgs::GlobalFeatures::new(),
418 NextNoiseStep::ActThree => {
419 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
420 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
421 peer.pending_read_is_header = true;
422 peer.their_node_id = Some(their_node_id);
425 NextNoiseStep::NoiseComplete => {
426 if peer.pending_read_is_header {
427 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
428 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
429 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
430 if msg_len < 2 { // Need at least the message type tag
431 return Err(PeerHandleError{ no_connection_possible: false });
433 peer.pending_read_is_header = false;
435 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
436 assert!(msg_data.len() >= 2);
439 peer.pending_read_buffer = [0; 18].to_vec();
440 peer.pending_read_is_header = true;
442 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
443 log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
444 if msg_type != 16 && peer.their_global_features.is_none() {
445 // Need an init message as first message
446 return Err(PeerHandleError{ no_connection_possible: false });
448 let mut reader = ::std::io::Cursor::new(&msg_data[2..]);
450 // Connection control:
452 let msg = try_potential_decodeerror!(msgs::Init::read(&mut reader));
453 if msg.global_features.requires_unknown_bits() {
454 log_info!(self, "Peer global features required unknown version bits");
455 return Err(PeerHandleError{ no_connection_possible: true });
457 if msg.local_features.requires_unknown_bits() {
458 log_info!(self, "Peer local features required unknown version bits");
459 return Err(PeerHandleError{ no_connection_possible: true });
461 if msg.local_features.requires_data_loss_protect() {
462 log_info!(self, "Peer local features required data_loss_protect");
463 return Err(PeerHandleError{ no_connection_possible: true });
465 if msg.local_features.requires_upfront_shutdown_script() {
466 log_info!(self, "Peer local features required upfront_shutdown_script");
467 return Err(PeerHandleError{ no_connection_possible: true });
469 if peer.their_global_features.is_some() {
470 return Err(PeerHandleError{ no_connection_possible: false });
473 log_info!(self, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, unkown local flags: {}, unknown global flags: {}",
474 if msg.local_features.supports_data_loss_protect() { "supported" } else { "not supported"},
475 if msg.local_features.initial_routing_sync() { "requested" } else { "not requested" },
476 if msg.local_features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
477 if msg.local_features.supports_unknown_bits() { "present" } else { "none" },
478 if msg.global_features.supports_unknown_bits() { "present" } else { "none" });
480 peer.their_global_features = Some(msg.global_features);
481 peer.their_local_features = Some(msg.local_features);
484 let mut local_features = msgs::LocalFeatures::new();
485 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
486 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
487 local_features.set_initial_routing_sync();
489 encode_and_send_msg!(msgs::Init {
490 global_features: msgs::GlobalFeatures::new(),
495 for msg in self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap()) {
496 encode_and_send_msg!(msg, 136);
500 let msg = try_potential_decodeerror!(msgs::ErrorMessage::read(&mut reader));
501 let mut data_is_printable = true;
502 for b in msg.data.bytes() {
503 if b < 32 || b > 126 {
504 data_is_printable = false;
509 if data_is_printable {
510 log_debug!(self, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
512 log_debug!(self, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
514 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
515 if msg.channel_id == [0; 32] {
516 return Err(PeerHandleError{ no_connection_possible: true });
521 let msg = try_potential_decodeerror!(msgs::Ping::read(&mut reader));
522 if msg.ponglen < 65532 {
523 let resp = msgs::Pong { byteslen: msg.ponglen };
524 encode_and_send_msg!(resp, 19);
528 try_potential_decodeerror!(msgs::Pong::read(&mut reader));
533 let msg = try_potential_decodeerror!(msgs::OpenChannel::read(&mut reader));
534 let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), &msg));
535 encode_and_send_msg!(resp, 33);
538 let msg = try_potential_decodeerror!(msgs::AcceptChannel::read(&mut reader));
539 try_potential_handleerror!(self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), &msg));
543 let msg = try_potential_decodeerror!(msgs::FundingCreated::read(&mut reader));
544 let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg));
545 encode_and_send_msg!(resp, 35);
548 let msg = try_potential_decodeerror!(msgs::FundingSigned::read(&mut reader));
549 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg));
552 let msg = try_potential_decodeerror!(msgs::FundingLocked::read(&mut reader));
553 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg));
555 Some(resp) => encode_and_send_msg!(resp, 259),
561 let msg = try_potential_decodeerror!(msgs::Shutdown::read(&mut reader));
562 let resp_options = try_potential_handleerror!(self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg));
563 if let Some(resp) = resp_options.0 {
564 encode_and_send_msg!(resp, 38);
566 if let Some(resp) = resp_options.1 {
567 encode_and_send_msg!(resp, 39);
571 let msg = try_potential_decodeerror!(msgs::ClosingSigned::read(&mut reader));
572 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg));
573 if let Some(resp) = resp_option {
574 encode_and_send_msg!(resp, 39);
579 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::read(&mut reader));
580 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg));
583 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::read(&mut reader));
584 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg));
587 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::read(&mut reader));
588 let chan_update = try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
589 if let Some(update) = chan_update {
590 self.message_handler.route_handler.handle_htlc_fail_channel_update(&update);
594 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::read(&mut reader));
595 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg));
599 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::read(&mut reader));
600 let resps = try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
601 encode_and_send_msg!(resps.0, 133);
602 if let Some(resp) = resps.1 {
603 encode_and_send_msg!(resp, 132);
607 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::read(&mut reader));
608 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
611 for resp in resps.update_add_htlcs {
612 encode_and_send_msg!(resp, 128);
614 for resp in resps.update_fulfill_htlcs {
615 encode_and_send_msg!(resp, 130);
617 for resp in resps.update_fail_htlcs {
618 encode_and_send_msg!(resp, 131);
620 encode_and_send_msg!(resps.commitment_signed, 132);
626 let msg = try_potential_decodeerror!(msgs::UpdateFee::read(&mut reader));
627 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg));
630 let msg = try_potential_decodeerror!(msgs::ChannelReestablish::read(&mut reader));
631 let (funding_locked, revoke_and_ack, commitment_update) = try_potential_handleerror!(self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg));
632 if let Some(lock_msg) = funding_locked {
633 encode_and_send_msg!(lock_msg, 36);
635 if let Some(revoke_msg) = revoke_and_ack {
636 encode_and_send_msg!(revoke_msg, 133);
638 match commitment_update {
640 for resp in resps.update_add_htlcs {
641 encode_and_send_msg!(resp, 128);
643 for resp in resps.update_fulfill_htlcs {
644 encode_and_send_msg!(resp, 130);
646 for resp in resps.update_fail_htlcs {
647 encode_and_send_msg!(resp, 131);
649 encode_and_send_msg!(resps.commitment_signed, 132);
657 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::read(&mut reader));
658 try_potential_handleerror!(self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg));
661 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::read(&mut reader));
662 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
665 // TODO: forward msg along to all our other peers!
669 let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::read(&mut reader));
670 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
673 // TODO: forward msg along to all our other peers!
677 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::read(&mut reader));
678 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
681 // TODO: forward msg along to all our other peers!
685 if (msg_type & 1) == 0 {
686 return Err(PeerHandleError{ no_connection_possible: true });
696 Self::do_attempt_write_data(peer_descriptor, peer);
698 peer.pending_outbound_buffer.len() > 10 // pause_read
705 self.process_events();
710 /// Checks for any events generated by our handlers and processes them. May be needed after eg
711 /// calls to ChannelManager::process_pending_htlc_forward.
712 pub fn process_events(&self) {
713 let mut upstream_events = Vec::new();
715 // TODO: There are some DoS attacks here where you can flood someone's outbound send
716 // buffer by doing things like announcing channels on another node. We should be willing to
717 // drop optional-ish messages when send buffers get full!
719 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_events();
720 let mut peers = self.peers.lock().unwrap();
721 for event in events_generated.drain(..) {
722 macro_rules! get_peer_for_forwarding {
723 ($node_id: expr, $handle_no_such_peer: block) => {
725 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
726 Some(descriptor) => descriptor.clone(),
728 $handle_no_such_peer;
732 match peers.peers.get_mut(&descriptor) {
734 if peer.their_global_features.is_none() {
735 $handle_no_such_peer;
740 None => panic!("Inconsistent peers set state!"),
746 Event::FundingGenerationReady {..} => { /* Hand upstream */ },
747 Event::FundingBroadcastSafe {..} => { /* Hand upstream */ },
748 Event::PaymentReceived {..} => { /* Hand upstream */ },
749 Event::PaymentSent {..} => { /* Hand upstream */ },
750 Event::PaymentFailed {..} => { /* Hand upstream */ },
751 Event::PendingHTLCsForwardable {..} => { /* Hand upstream */ },
753 Event::SendOpenChannel { ref node_id, ref msg } => {
754 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
755 log_pubkey!(node_id),
756 log_bytes!(msg.temporary_channel_id));
757 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
758 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
760 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
761 Self::do_attempt_write_data(&mut descriptor, peer);
764 Event::SendFundingCreated { ref node_id, ref msg } => {
765 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
766 log_pubkey!(node_id),
767 log_bytes!(msg.temporary_channel_id),
768 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
769 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
770 //TODO: generate a DiscardFunding event indicating to the wallet that
771 //they should just throw away this funding transaction
773 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
774 Self::do_attempt_write_data(&mut descriptor, peer);
777 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
778 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {}{} for channel {}",
779 log_pubkey!(node_id),
780 if announcement_sigs.is_some() { " with announcement sigs" } else { "" },
781 log_bytes!(msg.channel_id));
782 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
783 //TODO: Do whatever we're gonna do for handling dropped messages
785 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
786 match announcement_sigs {
787 &Some(ref announce_msg) => peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(announce_msg, 259))),
790 Self::do_attempt_write_data(&mut descriptor, peer);
793 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed } } => {
794 log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
795 log_pubkey!(node_id),
796 update_add_htlcs.len(),
797 update_fulfill_htlcs.len(),
798 update_fail_htlcs.len(),
799 log_bytes!(commitment_signed.channel_id));
800 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
801 //TODO: Do whatever we're gonna do for handling dropped messages
803 for msg in update_add_htlcs {
804 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
806 for msg in update_fulfill_htlcs {
807 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
809 for msg in update_fail_htlcs {
810 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
812 for msg in update_fail_malformed_htlcs {
813 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 135)));
815 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed, 132)));
816 Self::do_attempt_write_data(&mut descriptor, peer);
819 Event::SendShutdown { ref node_id, ref msg } => {
820 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
821 log_pubkey!(node_id),
822 log_bytes!(msg.channel_id));
823 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
824 //TODO: Do whatever we're gonna do for handling dropped messages
826 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
827 Self::do_attempt_write_data(&mut descriptor, peer);
830 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
831 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
832 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
833 let encoded_msg = encode_msg!(msg, 256);
834 let encoded_update_msg = encode_msg!(update_msg, 258);
836 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
837 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
840 match peer.their_node_id {
842 Some(their_node_id) => {
843 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
848 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
849 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
850 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
855 Event::BroadcastChannelUpdate { ref msg } => {
856 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
857 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
858 let encoded_msg = encode_msg!(msg, 258);
860 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
861 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
864 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
865 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
870 Event::HandleError { ref node_id, ref action } => {
871 if let Some(ref action) = *action {
873 msgs::ErrorAction::DisconnectPeer { ref msg } => {
874 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
875 if let Some(mut peer) = peers.peers.remove(&descriptor) {
876 if let Some(ref msg) = *msg {
877 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
878 log_pubkey!(node_id),
880 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
881 // This isn't guaranteed to work, but if there is enough free
882 // room in the send buffer, put the error message there...
883 Self::do_attempt_write_data(&mut descriptor, &mut peer);
885 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
888 descriptor.disconnect_socket();
889 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
892 msgs::ErrorAction::IgnoreError => {
895 msgs::ErrorAction::SendErrorMessage { ref msg } => {
896 log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
897 log_pubkey!(node_id),
899 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
900 //TODO: Do whatever we're gonna do for handling dropped messages
902 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
903 Self::do_attempt_write_data(&mut descriptor, peer);
907 log_error!(self, "Got no-action HandleError Event in peer_handler for node {}, no such events should ever be generated!", log_pubkey!(node_id));
913 upstream_events.push(event);
917 let mut pending_events = self.pending_events.lock().unwrap();
918 for event in upstream_events.drain(..) {
919 pending_events.push(event);
923 /// Indicates that the given socket descriptor's connection is now closed.
924 /// This must be called even if a PeerHandleError was given for a read_event or write_event,
925 /// but must NOT be called if a PeerHandleError was provided out of a new_*_connection event!
926 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
927 pub fn disconnect_event(&self, descriptor: &Descriptor) {
928 self.disconnect_event_internal(descriptor, false);
931 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
932 let mut peers = self.peers.lock().unwrap();
933 let peer_option = peers.peers.remove(descriptor);
935 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
937 match peer.their_node_id {
939 peers.node_id_to_descriptor.remove(&node_id);
940 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
949 impl<Descriptor: SocketDescriptor> EventsProvider for PeerManager<Descriptor> {
950 fn get_and_clear_pending_events(&self) -> Vec<Event> {
951 let mut pending_events = self.pending_events.lock().unwrap();
952 let mut ret = Vec::new();
953 mem::swap(&mut ret, &mut *pending_events);
960 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
963 use util::test_utils;
964 use util::logger::Logger;
966 use secp256k1::Secp256k1;
967 use secp256k1::key::{SecretKey, PublicKey};
969 use rand::{thread_rng, Rng};
971 use std::sync::{Arc};
973 #[derive(PartialEq, Eq, Clone, Hash)]
974 struct FileDescriptor {
978 impl SocketDescriptor for FileDescriptor {
979 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, _resume_read: bool) -> usize {
980 assert!(write_offset < data.len());
981 data.len() - write_offset
984 fn disconnect_socket(&mut self) {}
987 fn create_network(peer_count: usize) -> Vec<PeerManager<FileDescriptor>> {
988 let secp_ctx = Secp256k1::new();
989 let mut peers = Vec::new();
990 let mut rng = thread_rng();
991 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
993 for _ in 0..peer_count {
994 let chan_handler = test_utils::TestChannelMessageHandler::new();
995 let router = test_utils::TestRoutingMessageHandler::new();
997 let mut key_slice = [0;32];
998 rng.fill_bytes(&mut key_slice);
999 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
1001 let msg_handler = MessageHandler { chan_handler: Arc::new(chan_handler), route_handler: Arc::new(router) };
1002 let peer = PeerManager::new(msg_handler, node_id, Arc::clone(&logger));
1009 fn establish_connection(peer_a: &PeerManager<FileDescriptor>, peer_b: &PeerManager<FileDescriptor>) {
1010 let secp_ctx = Secp256k1::new();
1011 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret);
1012 let fd = FileDescriptor { fd: 1};
1013 peer_a.new_inbound_connection(fd.clone()).unwrap();
1014 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
1018 fn test_disconnect_peer() {
1019 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1020 // push an DisconnectPeer event to remove the node flagged by id
1021 let mut peers = create_network(2);
1022 establish_connection(&peers[0], &peers[1]);
1023 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1025 let secp_ctx = Secp256k1::new();
1026 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1028 let chan_handler = test_utils::TestChannelMessageHandler::new();
1029 chan_handler.pending_events.lock().unwrap().push(events::Event::HandleError {
1031 action: Some(msgs::ErrorAction::DisconnectPeer { msg: None }),
1033 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1034 peers[0].message_handler.chan_handler = Arc::new(chan_handler);
1036 peers[0].process_events();
1037 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);