Check expected amount in claim_funds
[rust-lightning] / src / ln / channelmanager.rs
index 156b31964887fc1c7ae3af85e250913cd4bab301..c863f46b613c77c27198d85e8f3121d9a2eb5c20 100644 (file)
@@ -152,12 +152,12 @@ impl MsgHandleErrInternal {
                Self {
                        err: LightningError {
                                err,
-                               action: Some(msgs::ErrorAction::SendErrorMessage {
+                               action: msgs::ErrorAction::SendErrorMessage {
                                        msg: msgs::ErrorMessage {
                                                channel_id,
                                                data: err.to_string()
                                        },
-                               }),
+                               },
                        },
                        shutdown_finish: None,
                }
@@ -167,7 +167,7 @@ impl MsgHandleErrInternal {
                Self {
                        err: LightningError {
                                err,
-                               action: Some(msgs::ErrorAction::IgnoreError),
+                               action: msgs::ErrorAction::IgnoreError,
                        },
                        shutdown_finish: None,
                }
@@ -181,12 +181,12 @@ impl MsgHandleErrInternal {
                Self {
                        err: LightningError {
                                err,
-                               action: Some(msgs::ErrorAction::SendErrorMessage {
+                               action: msgs::ErrorAction::SendErrorMessage {
                                        msg: msgs::ErrorMessage {
                                                channel_id,
                                                data: err.to_string()
                                        },
-                               }),
+                               },
                        },
                        shutdown_finish: Some((shutdown_res, channel_update)),
                }
@@ -197,25 +197,25 @@ impl MsgHandleErrInternal {
                        err: match err {
                                ChannelError::Ignore(msg) => LightningError {
                                        err: msg,
-                                       action: Some(msgs::ErrorAction::IgnoreError),
+                                       action: msgs::ErrorAction::IgnoreError,
                                },
                                ChannelError::Close(msg) => LightningError {
                                        err: msg,
-                                       action: Some(msgs::ErrorAction::SendErrorMessage {
+                                       action: msgs::ErrorAction::SendErrorMessage {
                                                msg: msgs::ErrorMessage {
                                                        channel_id,
                                                        data: msg.to_string()
                                                },
-                                       }),
+                                       },
                                },
                                ChannelError::CloseDelayBroadcast { msg, .. } => LightningError {
                                        err: msg,
-                                       action: Some(msgs::ErrorAction::SendErrorMessage {
+                                       action: msgs::ErrorAction::SendErrorMessage {
                                                msg: msgs::ErrorMessage {
                                                        channel_id,
                                                        data: msg.to_string()
                                                },
-                                       }),
+                                       },
                                },
                        },
                        shutdown_finish: None,
@@ -585,7 +585,10 @@ impl ChannelManager {
        /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
        ///
        /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
-       pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig) -> Result<Arc<ChannelManager>, secp256k1::Error> {
+       ///
+       /// User must provide the current blockchain height from which to track onchain channel
+       /// funding outpoints and send payments with reliable timelocks.
+       pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig, current_blockchain_height: usize) -> Result<Arc<ChannelManager>, secp256k1::Error> {
                let secp_ctx = Secp256k1::new();
 
                let res = Arc::new(ChannelManager {
@@ -596,7 +599,7 @@ impl ChannelManager {
                        chain_monitor,
                        tx_broadcaster,
 
-                       latest_block_height: AtomicUsize::new(0), //TODO: Get an init value
+                       latest_block_height: AtomicUsize::new(current_blockchain_height),
                        last_block_hash: Mutex::new(Default::default()),
                        secp_ctx,
 
@@ -1011,7 +1014,7 @@ impl ChannelManager {
        /// May be called with channel_state already locked!
        fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, LightningError> {
                let short_channel_id = match chan.get_short_channel_id() {
-                       None => return Err(LightningError{err: "Channel not yet established", action: None}),
+                       None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
                        Some(id) => id,
                };
 
@@ -1140,7 +1143,7 @@ impl ChannelManager {
                match handle_error!(self, err) {
                        Ok(_) => unreachable!(),
                        Err(e) => {
-                               if let Some(msgs::ErrorAction::IgnoreError) = e.action {
+                               if let msgs::ErrorAction::IgnoreError = e.action {
                                } else {
                                        log_error!(self, "Got bad keys: {}!", e.err);
                                        let mut channel_state = self.channel_state.lock().unwrap();
@@ -1370,12 +1373,41 @@ impl ChannelManager {
                                                        let (commitment_msg, monitor) = match chan.get_mut().send_commitment() {
                                                                Ok(res) => res,
                                                                Err(e) => {
-                                                                       if let ChannelError::Ignore(_) = e {
-                                                                               panic!("Stated return value requirements in send_commitment() were not met");
+                                                                       // We surely failed send_commitment due to bad keys, in that case
+                                                                       // close channel and then send error message to peer.
+                                                                       let their_node_id = chan.get().get_their_node_id();
+                                                                       let err: Result<(), _>  = match e {
+                                                                               ChannelError::Ignore(_) => {
+                                                                                       panic!("Stated return value requirements in send_commitment() were not met");
+                                                                               },
+                                                                               ChannelError::Close(msg) => {
+                                                                                       log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
+                                                                                       let (channel_id, mut channel) = chan.remove_entry();
+                                                                                       if let Some(short_id) = channel.get_short_channel_id() {
+                                                                                               channel_state.short_to_id.remove(&short_id);
+                                                                                       }
+                                                                                       Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(), self.get_channel_update(&channel).ok()))
+                                                                               },
+                                                                               ChannelError::CloseDelayBroadcast { .. } => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
+                                                                       };
+                                                                       match handle_error!(self, err) {
+                                                                               Ok(_) => unreachable!(),
+                                                                               Err(e) => {
+                                                                                       match e.action {
+                                                                                               msgs::ErrorAction::IgnoreError => {},
+                                                                                               _ => {
+                                                                                                       log_error!(self, "Got bad keys: {}!", e.err);
+                                                                                                       let mut channel_state = self.channel_state.lock().unwrap();
+                                                                                                       channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
+                                                                                                               node_id: their_node_id,
+                                                                                                               action: e.action,
+                                                                                                       });
+                                                                                               },
+                                                                                       }
+                                                                                       continue;
+                                                                               },
                                                                        }
-                                                                       //TODO: Handle...this is bad!
-                                                                       continue;
-                                                               },
+                                                               }
                                                        };
                                                        if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
                                                                handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
@@ -1434,7 +1466,7 @@ impl ChannelManager {
                        match handle_error!(self, err) {
                                Ok(_) => {},
                                Err(e) => {
-                                       if let Some(msgs::ErrorAction::IgnoreError) = e.action {
+                                       if let msgs::ErrorAction::IgnoreError = e.action {
                                        } else {
                                                let mut channel_state = self.channel_state.lock().unwrap();
                                                channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
@@ -1574,8 +1606,15 @@ impl ChannelManager {
        /// generating message events for the net layer to claim the payment, if possible. Thus, you
        /// should probably kick the net layer to go send messages if this returns true!
        ///
+       /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
+       /// available within a few percent of the expected amount. This is critical for several
+       /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
+       /// payment_preimage without having provided the full value and b) it avoids certain
+       /// privacy-breaking recipient-probing attacks which may reveal payment activity to
+       /// motivated attackers.
+       ///
        /// May panic if called except in response to a PaymentReceived event.
-       pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
+       pub fn claim_funds(&self, payment_preimage: PaymentPreimage, expected_amount: u64) -> bool {
                let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
 
                let _ = self.total_consistency_lock.read().unwrap();
@@ -1583,12 +1622,18 @@ impl ChannelManager {
                let mut channel_state = Some(self.channel_state.lock().unwrap());
                let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
                if let Some(mut sources) = removed_source {
-                       // TODO: We should require the user specify the expected amount so that we can claim
-                       // only payments for the correct amount, and reject payments for incorrect amounts
-                       // (which are probably middle nodes probing to break our privacy).
-                       for (_, htlc_with_hash) in sources.drain(..) {
+                       for (received_amount, htlc_with_hash) in sources.drain(..) {
                                if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
-                               self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
+                               if received_amount < expected_amount || received_amount > expected_amount * 2 {
+                                       let mut htlc_msat_data = byte_utils::be64_to_array(received_amount).to_vec();
+                                       let mut height_data = byte_utils::be32_to_array(self.latest_block_height.load(Ordering::Acquire) as u32).to_vec();
+                                       htlc_msat_data.append(&mut height_data);
+                                       self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
+                                                                        HTLCSource::PreviousHopData(htlc_with_hash), &payment_hash,
+                                                                        HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_data });
+                               } else {
+                                       self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
+                               }
                        }
                        true
                } else { false }
@@ -1660,7 +1705,7 @@ impl ChannelManager {
                match handle_error!(self, err) {
                        Ok(_) => {},
                        Err(e) => {
-                               if let Some(msgs::ErrorAction::IgnoreError) = e.action {
+                               if let msgs::ErrorAction::IgnoreError = e.action {
                                } else {
                                        let mut channel_state = self.channel_state.lock().unwrap();
                                        channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
@@ -2292,7 +2337,7 @@ impl ChannelManager {
                                        return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
                                }
                                if !chan.get().is_usable() {
-                                       return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
+                                       return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
                                }
 
                                let our_node_id = self.get_our_node_id();
@@ -2445,7 +2490,7 @@ impl ChannelManager {
                match handle_error!(self, err) {
                        Ok(_) => unreachable!(),
                        Err(e) => {
-                               if let Some(msgs::ErrorAction::IgnoreError) = e.action {
+                               if let msgs::ErrorAction::IgnoreError = e.action {
                                } else {
                                        log_error!(self, "Got bad keys: {}!", e.err);
                                        let mut channel_state = self.channel_state.lock().unwrap();
@@ -2538,7 +2583,7 @@ impl ChainListener for ChannelManager {
                                } else if let Err(e) = chan_res {
                                        pending_msg_events.push(events::MessageSendEvent::HandleError {
                                                node_id: channel.get_their_node_id(),
-                                               action: Some(msgs::ErrorAction::SendErrorMessage { msg: e }),
+                                               action: msgs::ErrorAction::SendErrorMessage { msg: e },
                                        });
                                        return false;
                                }