Add mpp_timeout and invalid_onion_payload descriptions & handling

Author: dunxen

fuzz/src/router.rs

@@ -135,6 +135,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 					msgs::DecodeError::ShortRead => panic!("We picked the length..."),
 					msgs::DecodeError::Io(e) => panic!("{:?}", e),
 					msgs::DecodeError::UnsupportedCompression => return,
+					msgs::DecodeError::UnknownTLV(_) => return,
 				}
 			}
 		}}

lightning/src/ln/channelmanager.rs

@@ -1792,7 +1792,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 						msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
 						msgs::DecodeError::UnknownRequiredFeature|
 						msgs::DecodeError::InvalidValue|
-						msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
+						msgs::DecodeError::ShortRead|
+						msgs::DecodeError::UnknownTLV(_) => 0x4000 | 22, // invalid_onion_payload
 						_ => 0x2000 | 2, // Should never happen
 					};
 					return_err!("Unable to decode our hop data", error_code, &[0;0]);

lightning/src/ln/msgs.rs

@@ -68,6 +68,8 @@ pub enum DecodeError {
         io::ErrorKind),
 	/// The message included zlib-compressed values, which we don't support.
 	UnsupportedCompression,
+	/// The message included a TLV with an unknown type.
+	UnknownTLV(u64),
 }
 
 /// An init message to be sent or received from a peer
@@ -961,6 +963,7 @@ impl fmt::Display for DecodeError {
 			DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
 			DecodeError::Io(ref e) => e.fmt(f),
 			DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
+			DecodeError::UnknownTLV(tlv_type) => f.write_fmt(format_args!( "Unknown TLV type encountered: {}", tlv_type)),
 		}
 	}
 }

lightning/src/ln/onion_route_tests.rs

@@ -563,4 +563,13 @@ fn test_onion_failure() {
 		msg.cltv_expiry = htlc_cltv;
 		msg.onion_routing_packet = onion_packet;
 	}, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
+
+	run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
+		// Tamper returning error message
+		let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
+		let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
+		msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], 23, &[0;0]);
+	}, ||{
+		nodes[2].node.fail_htlc_backwards(&payment_hash);
+	}, true, Some(23), None, None);
 }

lightning/src/ln/onion_utils.rs

@@ -380,7 +380,7 @@ pub(super) fn process_onion_failure<T: secp256k1::Signing, L: Deref>(secp_ctx: &
 						// indicate that payment parameter has failed and no need to
 						// update Route object
 						let payment_failed = match error_code & 0xff {
-							15|16|17|18|19 => true,
+							15|16|17|18|19|23 => true,
 							_ => false,
 						} && is_from_final_node; // PERM bit observed below even if this error is from the intermediate nodes
 

lightning/src/ln/peer_handler.rs

@@ -915,6 +915,10 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
 													msgs::DecodeError::UnsupportedCompression => {
 														log_gossip!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
 														continue;
+													},
+													msgs::DecodeError::UnknownTLV(tlv_type) => {
+														log_debug!(self.logger, "Got an unknown TLV type while deserializing message: {}", tlv_type);
+														return Err(PeerHandleError { no_connection_possible: false });
 													}
 												}
 											}

lightning/src/util/errors.rs

@@ -119,6 +119,8 @@ pub(crate) fn get_onion_error_description(error_code: u16) -> (&'static str, &'s
 		_c if _c == 19 => ("The final node indicated the amount in the HTLC does not match the value in the onion", "final_incorrect_htlc_amount"),
 		_c if _c == UPDATE|20 => ("Node indicated the outbound channel has been disabled", "channel_disabled"),
 		_c if _c == 21 => ("Node indicated the CLTV expiry in the HTLC is too far in the future", "expiry_too_far"),
+		_c if _c == PERM|22 => ("Node indicated that the decrypted onion per-hop payload was not understood by it or is incomplete", "invalid_onion_payload"),
+		_c if _c == 23 => ("The final node indicated the complete amount of the multi-part payment was not received within a reasonable time", "mpp_timeout"),
 		_ => ("Unknown", ""),
 	}
 }