1 //! Top level peer message handling and socket handling logic lives here.
3 //! Instead of actually servicing sockets ourselves we require that you implement the
4 //! SocketDescriptor interface and use that to receive actions which you should perform on the
5 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
6 //! call into the provided message handlers (probably a ChannelManager and Router) with messages
7 //! they should handle, and encoding/sending response messages.
9 use secp256k1::key::{SecretKey,PublicKey};
12 use util::ser::{Writeable, Writer, Readable};
13 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
15 use util::events::{MessageSendEvent};
16 use util::logger::Logger;
18 use std::collections::{HashMap,hash_map,LinkedList};
19 use std::sync::{Arc, Mutex};
20 use std::sync::atomic::{AtomicUsize, Ordering};
21 use std::{cmp,error,hash,fmt};
23 /// Provides references to trait impls which handle different types of messages.
24 pub struct MessageHandler {
25 /// A message handler which handles messages specific to channels. Usually this is just a
26 /// ChannelManager object.
27 pub chan_handler: Arc<msgs::ChannelMessageHandler>,
28 /// A message handler which handles messages updating our knowledge of the network channel
29 /// graph. Usually this is just a Router object.
30 pub route_handler: Arc<msgs::RoutingMessageHandler>,
33 /// Provides an object which can be used to send data to and which uniquely identifies a connection
34 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
35 /// implement Hash to meet the PeerManager API.
37 /// For efficiency, Clone should be relatively cheap for this type.
39 /// You probably want to just extend an int and put a file descriptor in a struct and implement
40 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
41 /// careful to ensure you don't have races whereby you might register a new connection with an fd
42 /// the same as a yet-to-be-disconnect_event()-ed.
43 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
44 /// Attempts to send some data from the given Vec starting at the given offset to the peer.
45 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
46 /// Note that in the disconnected case, a disconnect_event must still fire and further write
47 /// attempts may occur until that time.
49 /// If the returned size is smaller than data.len() - write_offset, a write_available event must
50 /// trigger the next time more data can be written. Additionally, until the a send_data event
51 /// completes fully, no further read_events should trigger on the same peer!
53 /// If a read_event on this descriptor had previously returned true (indicating that read
54 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
55 /// indicating that read events on this descriptor should resume. A resume_read of false does
56 /// *not* imply that further read events should be paused.
57 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, resume_read: bool) -> usize;
58 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
59 /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
60 /// No disconnect_event should be generated as a result of this call, though obviously races
61 /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
62 /// that event completing.
63 fn disconnect_socket(&mut self);
66 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
67 /// generate no further read/write_events for the descriptor, only triggering a single
68 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
69 /// no such disconnect_event must be generated and the socket be silently disconencted).
70 pub struct PeerHandleError {
71 /// Used to indicate that we probably can't make any future connections to this peer, implying
72 /// we should go ahead and force-close any channels we have with it.
73 no_connection_possible: bool,
75 impl fmt::Debug for PeerHandleError {
76 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
77 formatter.write_str("Peer Sent Invalid Data")
80 impl fmt::Display for PeerHandleError {
81 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
82 formatter.write_str("Peer Sent Invalid Data")
85 impl error::Error for PeerHandleError {
86 fn description(&self) -> &str {
87 "Peer Sent Invalid Data"
92 channel_encryptor: PeerChannelEncryptor,
94 their_node_id: Option<PublicKey>,
95 their_global_features: Option<msgs::GlobalFeatures>,
96 their_local_features: Option<msgs::LocalFeatures>,
98 pending_outbound_buffer: LinkedList<Vec<u8>>,
99 pending_outbound_buffer_first_msg_offset: usize,
100 awaiting_write_event: bool,
102 pending_read_buffer: Vec<u8>,
103 pending_read_buffer_pos: usize,
104 pending_read_is_header: bool,
107 struct PeerHolder<Descriptor: SocketDescriptor> {
108 peers: HashMap<Descriptor, Peer>,
109 /// Only add to this set when noise completes:
110 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
112 struct MutPeerHolder<'a, Descriptor: SocketDescriptor + 'a> {
113 peers: &'a mut HashMap<Descriptor, Peer>,
114 node_id_to_descriptor: &'a mut HashMap<PublicKey, Descriptor>,
116 impl<Descriptor: SocketDescriptor> PeerHolder<Descriptor> {
117 fn borrow_parts(&mut self) -> MutPeerHolder<Descriptor> {
119 peers: &mut self.peers,
120 node_id_to_descriptor: &mut self.node_id_to_descriptor,
125 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
126 /// events into messages which it passes on to its MessageHandlers.
127 pub struct PeerManager<Descriptor: SocketDescriptor> {
128 message_handler: MessageHandler,
129 peers: Mutex<PeerHolder<Descriptor>>,
130 our_node_secret: SecretKey,
131 initial_syncs_sent: AtomicUsize,
135 struct VecWriter(Vec<u8>);
136 impl Writer for VecWriter {
137 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
138 self.0.extend_from_slice(buf);
141 fn size_hint(&mut self, size: usize) {
142 self.0.reserve_exact(size);
146 macro_rules! encode_msg {
147 ($msg: expr, $msg_code: expr) => {{
148 let mut msg = VecWriter(Vec::new());
149 ($msg_code as u16).write(&mut msg).unwrap();
150 $msg.write(&mut msg).unwrap();
155 //TODO: Really should do something smarter for this
156 const INITIAL_SYNCS_TO_SEND: usize = 5;
158 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
159 /// PeerIds may repeat, but only after disconnect_event() has been called.
160 impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
161 /// Constructs a new PeerManager with the given message handlers and node_id secret key
162 pub fn new(message_handler: MessageHandler, our_node_secret: SecretKey, logger: Arc<Logger>) -> PeerManager<Descriptor> {
164 message_handler: message_handler,
165 peers: Mutex::new(PeerHolder { peers: HashMap::new(), node_id_to_descriptor: HashMap::new() }),
166 our_node_secret: our_node_secret,
167 initial_syncs_sent: AtomicUsize::new(0),
172 /// Get the list of node ids for peers which have completed the initial handshake.
174 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
175 /// new_outbound_connection, however entries will only appear once the initial handshake has
176 /// completed and we are sure the remote peer has the private key for the given node_id.
177 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
178 let peers = self.peers.lock().unwrap();
179 peers.peers.values().filter_map(|p| {
180 if !p.channel_encryptor.is_ready_for_encryption() || p.their_global_features.is_none() {
187 /// Indicates a new outbound connection has been established to a node with the given node_id.
188 /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
189 /// descriptor but must disconnect the connection immediately.
191 /// Returns some bytes to send to the remote node.
193 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
194 /// disconnect_event.
195 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
196 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone());
197 let res = peer_encryptor.get_act_one().to_vec();
198 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
200 let mut peers = self.peers.lock().unwrap();
201 if peers.peers.insert(descriptor, Peer {
202 channel_encryptor: peer_encryptor,
204 their_node_id: Some(their_node_id),
205 their_global_features: None,
206 their_local_features: None,
208 pending_outbound_buffer: LinkedList::new(),
209 pending_outbound_buffer_first_msg_offset: 0,
210 awaiting_write_event: false,
212 pending_read_buffer: pending_read_buffer,
213 pending_read_buffer_pos: 0,
214 pending_read_is_header: false,
216 panic!("PeerManager driver duplicated descriptors!");
221 /// Indicates a new inbound connection has been established.
223 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
224 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
225 /// call disconnect_event for the new descriptor but must disconnect the connection
228 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
229 /// disconnect_event.
230 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
231 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
232 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
234 let mut peers = self.peers.lock().unwrap();
235 if peers.peers.insert(descriptor, Peer {
236 channel_encryptor: peer_encryptor,
239 their_global_features: None,
240 their_local_features: None,
242 pending_outbound_buffer: LinkedList::new(),
243 pending_outbound_buffer_first_msg_offset: 0,
244 awaiting_write_event: false,
246 pending_read_buffer: pending_read_buffer,
247 pending_read_buffer_pos: 0,
248 pending_read_is_header: false,
250 panic!("PeerManager driver duplicated descriptors!");
255 fn do_attempt_write_data(descriptor: &mut Descriptor, peer: &mut Peer) {
256 while !peer.awaiting_write_event {
258 let next_buff = match peer.pending_outbound_buffer.front() {
262 let should_be_reading = peer.pending_outbound_buffer.len() < 10;
264 let data_sent = descriptor.send_data(next_buff, peer.pending_outbound_buffer_first_msg_offset, should_be_reading);
265 peer.pending_outbound_buffer_first_msg_offset += data_sent;
266 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
268 peer.pending_outbound_buffer_first_msg_offset = 0;
269 peer.pending_outbound_buffer.pop_front();
271 peer.awaiting_write_event = true;
276 /// Indicates that there is room to write data to the given socket descriptor.
278 /// May return an Err to indicate that the connection should be closed.
280 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
281 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
282 /// invariants around calling write_event in case a write did not fully complete must still
283 /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
284 /// Panics if the descriptor was not previously registered in a new_\*_connection event.
285 pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
286 let mut peers = self.peers.lock().unwrap();
287 match peers.peers.get_mut(descriptor) {
288 None => panic!("Descriptor for write_event is not already known to PeerManager"),
290 peer.awaiting_write_event = false;
291 Self::do_attempt_write_data(descriptor, peer);
297 /// Indicates that data was read from the given socket descriptor.
299 /// May return an Err to indicate that the connection should be closed.
301 /// Will very likely call send_data on the descriptor passed in (or a descriptor handed into
302 /// new_*_connection) before returning. Thus, be very careful with reentrancy issues! The
303 /// invariants around calling write_event in case a write did not fully complete must still
304 /// hold. Note that this function will often call send_data on many peers before returning, not
307 /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
308 /// this file descriptor has resume_read set (preventing DoS issues in the send buffer). Note
309 /// that this must be true even if a send_data call with resume_read=true was made during the
310 /// course of this function!
312 /// Panics if the descriptor was not previously registered in a new_*_connection event.
313 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
314 match self.do_read_event(peer_descriptor, data) {
317 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
323 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
325 let mut peers_lock = self.peers.lock().unwrap();
326 let peers = peers_lock.borrow_parts();
327 let pause_read = match peers.peers.get_mut(peer_descriptor) {
328 None => panic!("Descriptor for read_event is not already known to PeerManager"),
330 assert!(peer.pending_read_buffer.len() > 0);
331 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
333 let mut read_pos = 0;
334 while read_pos < data.len() {
336 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
337 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]);
338 read_pos += data_to_copy;
339 peer.pending_read_buffer_pos += data_to_copy;
342 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
343 peer.pending_read_buffer_pos = 0;
345 macro_rules! encode_and_send_msg {
346 ($msg: expr, $msg_code: expr) => {
348 log_trace!(self, "Encoding and sending message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
349 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
354 macro_rules! try_potential_handleerror {
359 if let Some(action) = e.action {
361 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
362 //TODO: Try to push msg
363 log_trace!(self, "Got Err handling message, disconnecting peer because {}", e.err);
364 return Err(PeerHandleError{ no_connection_possible: false });
366 msgs::ErrorAction::IgnoreError => {
367 log_trace!(self, "Got Err handling message, ignoring because {}", e.err);
370 msgs::ErrorAction::SendErrorMessage { msg } => {
371 log_trace!(self, "Got Err handling message, sending Error message because {}", e.err);
372 encode_and_send_msg!(msg, 17);
377 log_debug!(self, "Got Err handling message, action not yet filled in: {}", e.err);
378 return Err(PeerHandleError{ no_connection_possible: false });
385 macro_rules! try_potential_decodeerror {
391 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError{ no_connection_possible: false }),
392 msgs::DecodeError::UnknownRequiredFeature => {
393 log_debug!(self, "Got a channel/node announcement with an known required feature flag, you may want to udpate!");
396 msgs::DecodeError::InvalidValue => return Err(PeerHandleError{ no_connection_possible: false }),
397 msgs::DecodeError::ShortRead => return Err(PeerHandleError{ no_connection_possible: false }),
398 msgs::DecodeError::ExtraAddressesPerType => {
399 log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
402 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
403 msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
410 macro_rules! insert_node_id {
412 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
413 hash_map::Entry::Occupied(_) => {
414 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
415 return Err(PeerHandleError{ no_connection_possible: false })
417 hash_map::Entry::Vacant(entry) => entry.insert(peer_descriptor.clone()),
422 let next_step = peer.channel_encryptor.get_noise_step();
424 NextNoiseStep::ActOne => {
425 let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_key(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
426 peer.pending_outbound_buffer.push_back(act_two);
427 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
429 NextNoiseStep::ActTwo => {
430 let act_three = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
431 peer.pending_outbound_buffer.push_back(act_three);
432 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
433 peer.pending_read_is_header = true;
436 let mut local_features = msgs::LocalFeatures::new();
437 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
438 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
439 local_features.set_initial_routing_sync();
441 encode_and_send_msg!(msgs::Init {
442 global_features: msgs::GlobalFeatures::new(),
446 NextNoiseStep::ActThree => {
447 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
448 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
449 peer.pending_read_is_header = true;
450 peer.their_node_id = Some(their_node_id);
453 NextNoiseStep::NoiseComplete => {
454 if peer.pending_read_is_header {
455 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
456 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
457 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
458 if msg_len < 2 { // Need at least the message type tag
459 return Err(PeerHandleError{ no_connection_possible: false });
461 peer.pending_read_is_header = false;
463 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
464 assert!(msg_data.len() >= 2);
467 peer.pending_read_buffer = [0; 18].to_vec();
468 peer.pending_read_is_header = true;
470 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
471 log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
472 if msg_type != 16 && peer.their_global_features.is_none() {
473 // Need an init message as first message
474 return Err(PeerHandleError{ no_connection_possible: false });
476 let mut reader = ::std::io::Cursor::new(&msg_data[2..]);
478 // Connection control:
480 let msg = try_potential_decodeerror!(msgs::Init::read(&mut reader));
481 if msg.global_features.requires_unknown_bits() {
482 log_info!(self, "Peer global features required unknown version bits");
483 return Err(PeerHandleError{ no_connection_possible: true });
485 if msg.local_features.requires_unknown_bits() {
486 log_info!(self, "Peer local features required unknown version bits");
487 return Err(PeerHandleError{ no_connection_possible: true });
489 if msg.local_features.requires_data_loss_protect() {
490 log_info!(self, "Peer local features required data_loss_protect");
491 return Err(PeerHandleError{ no_connection_possible: true });
493 if msg.local_features.requires_upfront_shutdown_script() {
494 log_info!(self, "Peer local features required upfront_shutdown_script");
495 return Err(PeerHandleError{ no_connection_possible: true });
497 if peer.their_global_features.is_some() {
498 return Err(PeerHandleError{ no_connection_possible: false });
501 log_info!(self, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, unkown local flags: {}, unknown global flags: {}",
502 if msg.local_features.supports_data_loss_protect() { "supported" } else { "not supported"},
503 if msg.local_features.initial_routing_sync() { "requested" } else { "not requested" },
504 if msg.local_features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
505 if msg.local_features.supports_unknown_bits() { "present" } else { "none" },
506 if msg.global_features.supports_unknown_bits() { "present" } else { "none" });
508 peer.their_global_features = Some(msg.global_features);
509 peer.their_local_features = Some(msg.local_features);
512 let mut local_features = msgs::LocalFeatures::new();
513 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
514 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
515 local_features.set_initial_routing_sync();
517 encode_and_send_msg!(msgs::Init {
518 global_features: msgs::GlobalFeatures::new(),
523 for msg in self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap()) {
524 encode_and_send_msg!(msg, 136);
528 let msg = try_potential_decodeerror!(msgs::ErrorMessage::read(&mut reader));
529 let mut data_is_printable = true;
530 for b in msg.data.bytes() {
531 if b < 32 || b > 126 {
532 data_is_printable = false;
537 if data_is_printable {
538 log_debug!(self, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
540 log_debug!(self, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
542 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
543 if msg.channel_id == [0; 32] {
544 return Err(PeerHandleError{ no_connection_possible: true });
549 let msg = try_potential_decodeerror!(msgs::Ping::read(&mut reader));
550 if msg.ponglen < 65532 {
551 let resp = msgs::Pong { byteslen: msg.ponglen };
552 encode_and_send_msg!(resp, 19);
556 try_potential_decodeerror!(msgs::Pong::read(&mut reader));
561 let msg = try_potential_decodeerror!(msgs::OpenChannel::read(&mut reader));
562 try_potential_handleerror!(self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), &msg));
565 let msg = try_potential_decodeerror!(msgs::AcceptChannel::read(&mut reader));
566 try_potential_handleerror!(self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), &msg));
570 let msg = try_potential_decodeerror!(msgs::FundingCreated::read(&mut reader));
571 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg));
574 let msg = try_potential_decodeerror!(msgs::FundingSigned::read(&mut reader));
575 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg));
578 let msg = try_potential_decodeerror!(msgs::FundingLocked::read(&mut reader));
579 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg));
583 let msg = try_potential_decodeerror!(msgs::Shutdown::read(&mut reader));
584 let resp_options = try_potential_handleerror!(self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg));
585 if let Some(resp) = resp_options.0 {
586 encode_and_send_msg!(resp, 38);
588 if let Some(resp) = resp_options.1 {
589 encode_and_send_msg!(resp, 39);
593 let msg = try_potential_decodeerror!(msgs::ClosingSigned::read(&mut reader));
594 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg));
595 if let Some(resp) = resp_option {
596 encode_and_send_msg!(resp, 39);
601 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::read(&mut reader));
602 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg));
605 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::read(&mut reader));
606 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg));
609 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::read(&mut reader));
610 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
613 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::read(&mut reader));
614 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg));
618 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::read(&mut reader));
619 let resps = try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
620 encode_and_send_msg!(resps.0, 133);
621 if let Some(resp) = resps.1 {
622 encode_and_send_msg!(resp, 132);
626 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::read(&mut reader));
627 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
630 for resp in resps.update_add_htlcs {
631 encode_and_send_msg!(resp, 128);
633 for resp in resps.update_fulfill_htlcs {
634 encode_and_send_msg!(resp, 130);
636 for resp in resps.update_fail_htlcs {
637 encode_and_send_msg!(resp, 131);
639 if let Some(resp) = resps.update_fee {
640 encode_and_send_msg!(resp, 134);
642 encode_and_send_msg!(resps.commitment_signed, 132);
648 let msg = try_potential_decodeerror!(msgs::UpdateFee::read(&mut reader));
649 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg));
652 let msg = try_potential_decodeerror!(msgs::ChannelReestablish::read(&mut reader));
653 let (funding_locked, revoke_and_ack, commitment_update, order) = try_potential_handleerror!(self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg));
654 if let Some(lock_msg) = funding_locked {
655 encode_and_send_msg!(lock_msg, 36);
657 macro_rules! handle_raa { () => {
658 if let Some(revoke_msg) = revoke_and_ack {
659 encode_and_send_msg!(revoke_msg, 133);
662 macro_rules! handle_cu { () => {
663 match commitment_update {
665 for resp in resps.update_add_htlcs {
666 encode_and_send_msg!(resp, 128);
668 for resp in resps.update_fulfill_htlcs {
669 encode_and_send_msg!(resp, 130);
671 for resp in resps.update_fail_htlcs {
672 encode_and_send_msg!(resp, 131);
674 if let Some(resp) = resps.update_fee {
675 encode_and_send_msg!(resp, 134);
677 encode_and_send_msg!(resps.commitment_signed, 132);
683 msgs::RAACommitmentOrder::RevokeAndACKFirst => {
687 msgs::RAACommitmentOrder::CommitmentFirst => {
696 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::read(&mut reader));
697 try_potential_handleerror!(self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg));
700 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::read(&mut reader));
701 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
704 // TODO: forward msg along to all our other peers!
708 let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::read(&mut reader));
709 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
712 // TODO: forward msg along to all our other peers!
716 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::read(&mut reader));
717 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
720 // TODO: forward msg along to all our other peers!
724 if (msg_type & 1) == 0 {
725 return Err(PeerHandleError{ no_connection_possible: true });
735 Self::do_attempt_write_data(peer_descriptor, peer);
737 peer.pending_outbound_buffer.len() > 10 // pause_read
744 self.process_events();
749 /// Checks for any events generated by our handlers and processes them. May be needed after eg
750 /// calls to ChannelManager::process_pending_htlc_forward.
751 pub fn process_events(&self) {
753 // TODO: There are some DoS attacks here where you can flood someone's outbound send
754 // buffer by doing things like announcing channels on another node. We should be willing to
755 // drop optional-ish messages when send buffers get full!
757 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
758 let mut peers = self.peers.lock().unwrap();
759 for event in events_generated.drain(..) {
760 macro_rules! get_peer_for_forwarding {
761 ($node_id: expr, $handle_no_such_peer: block) => {
763 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
764 Some(descriptor) => descriptor.clone(),
766 $handle_no_such_peer;
770 match peers.peers.get_mut(&descriptor) {
772 if peer.their_global_features.is_none() {
773 $handle_no_such_peer;
778 None => panic!("Inconsistent peers set state!"),
784 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
785 log_trace!(self, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
786 log_pubkey!(node_id),
787 log_bytes!(msg.temporary_channel_id));
788 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
789 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
791 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 33)));
792 Self::do_attempt_write_data(&mut descriptor, peer);
794 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
795 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
796 log_pubkey!(node_id),
797 log_bytes!(msg.temporary_channel_id));
798 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
799 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
801 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
802 Self::do_attempt_write_data(&mut descriptor, peer);
804 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
805 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
806 log_pubkey!(node_id),
807 log_bytes!(msg.temporary_channel_id),
808 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
809 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
810 //TODO: generate a DiscardFunding event indicating to the wallet that
811 //they should just throw away this funding transaction
813 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
814 Self::do_attempt_write_data(&mut descriptor, peer);
816 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
817 log_trace!(self, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
818 log_pubkey!(node_id),
819 log_bytes!(msg.channel_id));
820 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
821 //TODO: generate a DiscardFunding event indicating to the wallet that
822 //they should just throw away this funding transaction
824 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 35)));
825 Self::do_attempt_write_data(&mut descriptor, peer);
827 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
828 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
829 log_pubkey!(node_id),
830 log_bytes!(msg.channel_id));
831 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
832 //TODO: Do whatever we're gonna do for handling dropped messages
834 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
835 Self::do_attempt_write_data(&mut descriptor, peer);
837 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
838 log_trace!(self, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
839 log_pubkey!(node_id),
840 log_bytes!(msg.channel_id));
841 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
842 //TODO: generate a DiscardFunding event indicating to the wallet that
843 //they should just throw away this funding transaction
845 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 259)));
846 Self::do_attempt_write_data(&mut descriptor, peer);
848 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
849 log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
850 log_pubkey!(node_id),
851 update_add_htlcs.len(),
852 update_fulfill_htlcs.len(),
853 update_fail_htlcs.len(),
854 log_bytes!(commitment_signed.channel_id));
855 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
856 //TODO: Do whatever we're gonna do for handling dropped messages
858 for msg in update_add_htlcs {
859 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
861 for msg in update_fulfill_htlcs {
862 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
864 for msg in update_fail_htlcs {
865 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
867 for msg in update_fail_malformed_htlcs {
868 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 135)));
870 if let &Some(ref msg) = update_fee {
871 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 134)));
873 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed, 132)));
874 Self::do_attempt_write_data(&mut descriptor, peer);
876 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
877 log_trace!(self, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
878 log_pubkey!(node_id),
879 log_bytes!(msg.channel_id));
880 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
881 //TODO: Do whatever we're gonna do for handling dropped messages
883 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 133)));
884 Self::do_attempt_write_data(&mut descriptor, peer);
886 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
887 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
888 log_pubkey!(node_id),
889 log_bytes!(msg.channel_id));
890 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
891 //TODO: Do whatever we're gonna do for handling dropped messages
893 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
894 Self::do_attempt_write_data(&mut descriptor, peer);
896 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
897 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
898 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
899 let encoded_msg = encode_msg!(msg, 256);
900 let encoded_update_msg = encode_msg!(update_msg, 258);
902 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
903 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
906 match peer.their_node_id {
908 Some(their_node_id) => {
909 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
914 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
915 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
916 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
920 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
921 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
922 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
923 let encoded_msg = encode_msg!(msg, 258);
925 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
926 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
929 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
930 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
934 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
935 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
937 MessageSendEvent::HandleError { ref node_id, ref action } => {
938 if let Some(ref action) = *action {
940 msgs::ErrorAction::DisconnectPeer { ref msg } => {
941 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
942 if let Some(mut peer) = peers.peers.remove(&descriptor) {
943 if let Some(ref msg) = *msg {
944 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
945 log_pubkey!(node_id),
947 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
948 // This isn't guaranteed to work, but if there is enough free
949 // room in the send buffer, put the error message there...
950 Self::do_attempt_write_data(&mut descriptor, &mut peer);
952 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
955 descriptor.disconnect_socket();
956 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
959 msgs::ErrorAction::IgnoreError => {},
960 msgs::ErrorAction::SendErrorMessage { ref msg } => {
961 log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
962 log_pubkey!(node_id),
964 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
965 //TODO: Do whatever we're gonna do for handling dropped messages
967 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
968 Self::do_attempt_write_data(&mut descriptor, peer);
972 log_error!(self, "Got no-action HandleError Event in peer_handler for node {}, no such events should ever be generated!", log_pubkey!(node_id));
980 /// Indicates that the given socket descriptor's connection is now closed.
982 /// This must be called even if a PeerHandleError was given for a read_event or write_event,
983 /// but must NOT be called if a PeerHandleError was provided out of a new_\*\_connection event!
985 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
986 pub fn disconnect_event(&self, descriptor: &Descriptor) {
987 self.disconnect_event_internal(descriptor, false);
990 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
991 let mut peers = self.peers.lock().unwrap();
992 let peer_option = peers.peers.remove(descriptor);
994 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
996 match peer.their_node_id {
998 peers.node_id_to_descriptor.remove(&node_id);
999 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1010 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1013 use util::test_utils;
1014 use util::logger::Logger;
1016 use secp256k1::Secp256k1;
1017 use secp256k1::key::{SecretKey, PublicKey};
1019 use rand::{thread_rng, Rng};
1021 use std::sync::{Arc};
1023 #[derive(PartialEq, Eq, Clone, Hash)]
1024 struct FileDescriptor {
1028 impl SocketDescriptor for FileDescriptor {
1029 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, _resume_read: bool) -> usize {
1030 assert!(write_offset < data.len());
1031 data.len() - write_offset
1034 fn disconnect_socket(&mut self) {}
1037 fn create_network(peer_count: usize) -> Vec<PeerManager<FileDescriptor>> {
1038 let secp_ctx = Secp256k1::new();
1039 let mut peers = Vec::new();
1040 let mut rng = thread_rng();
1041 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1043 for _ in 0..peer_count {
1044 let chan_handler = test_utils::TestChannelMessageHandler::new();
1045 let router = test_utils::TestRoutingMessageHandler::new();
1047 let mut key_slice = [0;32];
1048 rng.fill_bytes(&mut key_slice);
1049 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
1051 let msg_handler = MessageHandler { chan_handler: Arc::new(chan_handler), route_handler: Arc::new(router) };
1052 let peer = PeerManager::new(msg_handler, node_id, Arc::clone(&logger));
1059 fn establish_connection(peer_a: &PeerManager<FileDescriptor>, peer_b: &PeerManager<FileDescriptor>) {
1060 let secp_ctx = Secp256k1::new();
1061 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret);
1062 let fd = FileDescriptor { fd: 1};
1063 peer_a.new_inbound_connection(fd.clone()).unwrap();
1064 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
1068 fn test_disconnect_peer() {
1069 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1070 // push an DisconnectPeer event to remove the node flagged by id
1071 let mut peers = create_network(2);
1072 establish_connection(&peers[0], &peers[1]);
1073 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1075 let secp_ctx = Secp256k1::new();
1076 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1078 let chan_handler = test_utils::TestChannelMessageHandler::new();
1079 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1081 action: Some(msgs::ErrorAction::DisconnectPeer { msg: None }),
1083 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1084 peers[0].message_handler.chan_handler = Arc::new(chan_handler);
1086 peers[0].process_events();
1087 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);