Support responding to Ping messages in peer_handler
[rust-lightning] / src / ln / peer_handler.rs
index e01d2c9b89c4494d68b8720062de63147538a1fc..30900cab499a8407fb4c7029c76a2de75517276d 100644 (file)
@@ -8,7 +8,7 @@ use util::events::{EventsProvider,Event};
 
 use std::collections::{HashMap,LinkedList};
 use std::sync::{Arc, Mutex};
-use std::{cmp,mem,hash,fmt};
+use std::{cmp,error,mem,hash,fmt};
 
 pub struct MessageHandler {
        pub chan_handler: Arc<msgs::ChannelMessageHandler>,
@@ -48,6 +48,16 @@ impl fmt::Debug for PeerHandleError {
                formatter.write_str("Peer Sent Invalid Data")
        }
 }
+impl fmt::Display for PeerHandleError {
+       fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
+               formatter.write_str("Peer Sent Invalid Data")
+       }
+}
+impl error::Error for PeerHandleError {
+       fn description(&self) -> &str {
+               "Peer Sent Invalid Data"
+       }
+}
 
 struct Peer {
        channel_encryptor: PeerChannelEncryptor,
@@ -223,7 +233,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                match self.do_read_event(peer_descriptor, data) {
                        Ok(res) => Ok(res),
                        Err(e) => {
-                               self.disconnect_event(peer_descriptor);
+                               self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
                                Err(e)
                        }
                }
@@ -238,38 +248,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                        assert!(peer.pending_read_buffer.len() > 0);
                                        assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 
-                                       macro_rules! try_potential_handleerror {
-                                               ($thing: expr) => {
-                                                       match $thing {
-                                                               Ok(x) => x,
-                                                               Err(_e) => {
-                                                                       //TODO: Handle e appropriately!
-                                                                       return Err(PeerHandleError{});
-                                                               }
-                                                       };
-                                               }
-                                       }
-
-                                       macro_rules! try_potential_decodeerror {
-                                               ($thing: expr) => {
-                                                       match $thing {
-                                                               Ok(x) => x,
-                                                               Err(_e) => {
-                                                                       //TODO: Handle e?
-                                                                       return Err(PeerHandleError{});
-                                                               }
-                                                       };
-                                               }
-                                       }
-
-                                       macro_rules! encode_and_send_msg {
-                                               ($msg: expr, $msg_code: expr) => {
-                                                       peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
-                                               }
-                                       }
-
                                        let mut insert_node_id = None;
-
                                        let mut read_pos = 0;
                                        while read_pos < data.len() {
                                                {
@@ -278,7 +257,68 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                        read_pos += data_to_copy;
                                                        peer.pending_read_buffer_pos += data_to_copy;
                                                }
+
                                                if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
+                                                       peer.pending_read_buffer_pos = 0;
+
+                                                       macro_rules! encode_and_send_msg {
+                                                               ($msg: expr, $msg_code: expr) => {
+                                                                       peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
+                                                               }
+                                                       }
+
+                                                       macro_rules! try_potential_handleerror {
+                                                               ($thing: expr) => {
+                                                                       match $thing {
+                                                                               Ok(x) => x,
+                                                                               Err(e) => {
+                                                                                       println!("Got error handling message: {}!", e.err);
+                                                                                       if let Some(action) = e.msg {
+                                                                                               match action {
+                                                                                                       msgs::ErrorAction::UpdateFailHTLC { msg } => {
+                                                                                                               encode_and_send_msg!(msg, 131);
+                                                                                                               continue;
+                                                                                                       },
+                                                                                                       msgs::ErrorAction::DisconnectPeer => {
+                                                                                                               return Err(PeerHandleError{ no_connection_possible: false });
+                                                                                                       },
+                                                                                                       msgs::ErrorAction::IgnoreError => {
+                                                                                                               continue;
+                                                                                                       },
+                                                                                               }
+                                                                                       } else {
+                                                                                               return Err(PeerHandleError{ no_connection_possible: false });
+                                                                                       }
+                                                                               }
+                                                                       };
+                                                               }
+                                                       }
+
+                                                       macro_rules! try_potential_decodeerror {
+                                                               ($thing: expr) => {
+                                                                       match $thing {
+                                                                               Ok(x) => x,
+                                                                               Err(_e) => {
+                                                                                       println!("Error decoding message");
+                                                                                       //TODO: Handle e?
+                                                                                       return Err(PeerHandleError{ no_connection_possible: false });
+                                                                               }
+                                                                       };
+                                                               }
+                                                       }
+
+                                                       macro_rules! try_ignore_potential_decodeerror {
+                                                               ($thing: expr) => {
+                                                                       match $thing {
+                                                                               Ok(x) => x,
+                                                                               Err(_e) => {
+                                                                                       println!("Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
+                                                                                       continue;
+                                                                               }
+                                                                       };
+                                                               }
+                                                       }
+
                                                        let next_step = peer.channel_encryptor.get_noise_step();
                                                        match next_step {
                                                                NextNoiseStep::ActOne => {
@@ -311,27 +351,31 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
                                                                                peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
                                                                                if msg_len < 2 { // Need at least the message type tag
-                                                                                       return Err(PeerHandleError{});
+                                                                                       return Err(PeerHandleError{ no_connection_possible: false });
                                                                                }
                                                                                peer.pending_read_is_header = false;
                                                                        } else {
                                                                                let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
                                                                                assert!(msg_data.len() >= 2);
 
+                                                                               // Reset read buffer
+                                                                               peer.pending_read_buffer = [0; 18].to_vec();
+                                                                               peer.pending_read_is_header = true;
+
                                                                                let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
                                                                                if msg_type != 16 && peer.their_global_features.is_none() {
                                                                                        // Need an init message as first message
-                                                                                       return Err(PeerHandleError{});
+                                                                                       return Err(PeerHandleError{ no_connection_possible: false });
                                                                                }
                                                                                match msg_type {
                                                                                        // Connection control:
                                                                                        16 => {
                                                                                                let msg = try_potential_decodeerror!(msgs::Init::decode(&msg_data[2..]));
                                                                                                if msg.global_features.requires_unknown_bits() {
-                                                                                                       return Err(PeerHandleError{});
+                                                                                                       return Err(PeerHandleError{ no_connection_possible: true });
                                                                                                }
                                                                                                if msg.local_features.requires_unknown_bits() {
-                                                                                                       return Err(PeerHandleError{});
+                                                                                                       return Err(PeerHandleError{ no_connection_possible: true });
                                                                                                }
                                                                                                peer.their_global_features = Some(msg.global_features);
                                                                                                peer.their_local_features = Some(msg.local_features);
@@ -346,8 +390,15 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                        17 => {
                                                                                                // Error msg
                                                                                        },
-                                                                                       18 => { }, // ping
-                                                                                       19 => { }, // pong
+
+                                                                                       18 => {
+                                                                                               let msg = try_potential_decodeerror!(msgs::Ping::decode(&msg_data[2..]));
+                                                                                               let resp = msgs::Pong { byteslen: msg.ponglen };
+                                                                                               encode_and_send_msg!(resp, 19);
+                                                                                       },
+                                                                                       19 => {
+                                                                                               try_potential_decodeerror!(msgs::Pong::decode(&msg_data[2..]));
+                                                                                       },
 
                                                                                        // Channel control:
                                                                                        32 => {
@@ -406,7 +457,10 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                        },
                                                                                        131 => {
                                                                                                let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::decode(&msg_data[2..]));
-                                                                                               try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
+                                                                                               let chan_update = try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
+                                                                                               if let Some(update) = chan_update {
+                                                                                                       self.message_handler.route_handler.handle_htlc_fail_channel_update(&update);
+                                                                                               }
                                                                                        },
                                                                                        135 => {
                                                                                                let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::decode(&msg_data[2..]));
@@ -415,18 +469,27 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 
                                                                                        132 => {
                                                                                                let msg = try_potential_decodeerror!(msgs::CommitmentSigned::decode(&msg_data[2..]));
-                                                                                               let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
-                                                                                               encode_and_send_msg!(resp, 133);
+                                                                                               let resps = try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
+                                                                                               encode_and_send_msg!(resps.0, 133);
+                                                                                               if let Some(resp) = resps.1 {
+                                                                                                       encode_and_send_msg!(resp, 132);
+                                                                                               }
                                                                                        },
                                                                                        133 => {
                                                                                                let msg = try_potential_decodeerror!(msgs::RevokeAndACK::decode(&msg_data[2..]));
                                                                                                let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
                                                                                                match resp_option {
                                                                                                        Some(resps) => {
-                                                                                                               for resp in resps.0 {
+                                                                                                               for resp in resps.update_add_htlcs {
                                                                                                                        encode_and_send_msg!(resp, 128);
                                                                                                                }
-                                                                                                               encode_and_send_msg!(resps.1, 132);
+                                                                                                               for resp in resps.update_fulfill_htlcs {
+                                                                                                                       encode_and_send_msg!(resp, 130);
+                                                                                                               }
+                                                                                                               for resp in resps.update_fail_htlcs {
+                                                                                                                       encode_and_send_msg!(resp, 131);
+                                                                                                               }
+                                                                                                               encode_and_send_msg!(resps.commitment_signed, 132);
                                                                                                        },
                                                                                                        None => {},
                                                                                                }
@@ -451,7 +514,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                }
                                                                                        },
                                                                                        257 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::decode(&msg_data[2..]));
+                                                                                               let msg = try_ignore_potential_decodeerror!(msgs::NodeAnnouncement::decode(&msg_data[2..]));
                                                                                                try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
                                                                                        },
                                                                                        258 => {
@@ -460,18 +523,13 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                        },
                                                                                        _ => {
                                                                                                if (msg_type & 1) == 0 {
-                                                                                                       //TODO: Fail all channels. Kill the peer!
-                                                                                                       return Err(PeerHandleError{});
+                                                                                                       return Err(PeerHandleError{ no_connection_possible: true });
                                                                                                }
                                                                                        },
                                                                                }
-
-                                                                               peer.pending_read_buffer = [0; 18].to_vec();
-                                                                               peer.pending_read_is_header = true;
                                                                        }
                                                                }
                                                        }
-                                                       peer.pending_read_buffer_pos = 0;
                                                }
                                        }
 
@@ -568,41 +626,59 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                Self::do_attempt_write_data(&mut descriptor, peer);
                                                continue;
                                        },
-                                       Event::SendFulfillHTLC { ref node_id, ref msg } => {
+                                       Event::SendFulfillHTLC { ref node_id, ref msg, ref commitment_msg } => {
                                                let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
+                                               peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_msg, 132)));
                                                Self::do_attempt_write_data(&mut descriptor, peer);
                                                continue;
                                        },
-                                       Event::SendFailHTLC { ref node_id, ref msg } => {
+                                       Event::SendFailHTLC { ref node_id, ref msg, ref commitment_msg } => {
                                                let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
+                                               peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_msg, 132)));
                                                Self::do_attempt_write_data(&mut descriptor, peer);
                                                continue;
                                        },
                                        Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
-                                               let encoded_msg = encode_msg!(msg, 256);
-                                               let encoded_update_msg = encode_msg!(update_msg, 258);
+                                               if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
+                                                       let encoded_msg = encode_msg!(msg, 256);
+                                                       let encoded_update_msg = encode_msg!(update_msg, 258);
 
-                                               for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
-                                                       if !peer.channel_encryptor.is_ready_for_encryption() {
-                                                               continue
-                                                       }
-                                                       match peer.their_node_id {
-                                                               None => continue,
-                                                               Some(their_node_id) => {
-                                                                       if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
-                                                                               continue
+                                                       for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
+                                                               if !peer.channel_encryptor.is_ready_for_encryption() {
+                                                                       continue
+                                                               }
+                                                               match peer.their_node_id {
+                                                                       None => continue,
+                                                                       Some(their_node_id) => {
+                                                                               if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
+                                                                                       continue
+                                                                               }
                                                                        }
                                                                }
+                                                               peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
+                                                               peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
+                                                               Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
+                                                       }
+                                               }
+                                               continue;
+                                       },
+                                       Event::BroadcastChannelUpdate { ref msg } => {
+                                               if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
+                                                       let encoded_msg = encode_msg!(msg, 258);
+
+                                                       for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
+                                                               if !peer.channel_encryptor.is_ready_for_encryption() {
+                                                                       continue
+                                                               }
+                                                               peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
+                                                               Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
                                                        }
-                                                       peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
-                                                       peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
-                                                       Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
                                                }
                                                continue;
                                        },
@@ -623,18 +699,22 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
        /// but must NOT be called if a PeerHandleError was provided out of a new_*_connection event!
        /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
        pub fn disconnect_event(&self, descriptor: &Descriptor) {
+               self.disconnect_event_internal(descriptor, false);
+       }
+
+       fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
                let mut peers = self.peers.lock().unwrap();
                let peer_option = peers.peers.remove(descriptor);
                match peer_option {
                        None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
                        Some(peer) => {
                                match peer.their_node_id {
-                                       Some(node_id) => { peers.node_id_to_descriptor.remove(&node_id); },
+                                       Some(node_id) => {
+                                               peers.node_id_to_descriptor.remove(&node_id);
+                                               self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
+                                       },
                                        None => {}
                                }
-                               //TODO: Notify the chan_handler that this node disconnected, and do something about
-                               //handling response messages that were queued for sending (maybe the send buffer
-                               //needs to be unencrypted?)
                        }
                };
        }