X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fonion_route_tests.rs;h=3731c31c5b42c372663f29e31d30b6f6207ea811;hb=26b515c13cccd1d027e67d0c65d69321d235ce40;hp=d70016cf4ac1e854998a86e48513665238665f21;hpb=f1761e06e6b44cedb1e1a9886b96c6723cdad2f3;p=rust-lightning diff --git a/lightning/src/ln/onion_route_tests.rs b/lightning/src/ln/onion_route_tests.rs index d70016cf..3731c31c 100644 --- a/lightning/src/ln/onion_route_tests.rs +++ b/lightning/src/ln/onion_route_tests.rs @@ -12,26 +12,27 @@ //! returned errors decode to the correct thing. use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS}; -use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient}; +use crate::sign::{EntropySource, NodeSigner, Recipient}; use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason}; use crate::ln::{PaymentHash, PaymentSecret}; use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS; use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, DISABLE_GOSSIP_TICKS, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields}; use crate::ln::onion_utils; use crate::routing::gossip::{NetworkUpdate, RoutingFees}; -use crate::routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop}; -use crate::ln::features::{InitFeatures, InvoiceFeatures}; +use crate::routing::router::{get_route, PaymentParameters, Route, RouteParameters, RouteHint, RouteHintHop}; +use crate::ln::features::{InitFeatures, Bolt11InvoiceFeatures}; use crate::ln::msgs; use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate}; use crate::ln::wire::Encode; -use crate::util::ser::{Writeable, Writer}; +use crate::util::ser::{Writeable, Writer, BigSize}; use crate::util::test_utils; -use crate::util::config::{UserConfig, ChannelConfig}; +use crate::util::config::{UserConfig, ChannelConfig, MaxDustHTLCExposure}; use crate::util::errors::APIError; use bitcoin::hash_types::BlockHash; -use bitcoin::hashes::Hash; +use bitcoin::hashes::{Hash, HashEngine}; +use bitcoin::hashes::hmac::{Hmac, HmacEngine}; use bitcoin::hashes::sha256::Hash as Sha256; use bitcoin::secp256k1; @@ -57,7 +58,12 @@ fn run_onion_failure_test(_name: &str, test_case: u8, nodes: &Vec, // 3: final node fails backward (but tamper onion payloads from node0) // 100: trigger error in the intermediate node and tamper returning fail_htlc // 200: trigger error in the final node and tamper returning fail_htlc -fn run_onion_failure_test_with_fail_intercept(_name: &str, test_case: u8, nodes: &Vec, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option, expected_channel_update: Option, expected_short_channel_id: Option) +fn run_onion_failure_test_with_fail_intercept( + _name: &str, test_case: u8, nodes: &Vec, route: &Route, payment_hash: &PaymentHash, + payment_secret: &PaymentSecret, mut callback_msg: F1, mut callback_fail: F2, + mut callback_node: F3, expected_retryable: bool, expected_error_code: Option, + expected_channel_update: Option, expected_short_channel_id: Option +) where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC), F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC), F3: FnMut(), @@ -252,7 +258,7 @@ struct BogusOnionHopData { data: Vec } impl BogusOnionHopData { - fn new(orig: msgs::OnionHopData) -> Self { + fn new(orig: msgs::OutboundOnionPayload) -> Self { Self { data: orig.encode() } } } @@ -359,7 +365,7 @@ fn test_onion_failure() { // break the first (non-final) hop payload by swapping the realm (0) byte for a byte // describing a length-1 TLV payload, which is obviously bogus. new_payloads[0].data[0] = 1; - msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash); + msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap(); }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id)); // final node failure @@ -377,7 +383,7 @@ fn test_onion_failure() { // break the last-hop payload by swapping the realm (0) byte for a byte describing a // length-1 TLV payload, which is obviously bogus. new_payloads[1].data[0] = 1; - msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash); + msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap(); }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id)); // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node @@ -510,7 +516,7 @@ fn test_onion_failure() { let short_channel_id = channels[1].0.contents.short_channel_id; let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id()) .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap() - .get_counterparty_htlc_minimum_msat() - 1; + .context().get_counterparty_htlc_minimum_msat() - 1; let mut bogus_route = route.clone(); let route_len = bogus_route.paths[0].hops.len(); bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward; @@ -597,7 +603,7 @@ fn test_onion_failure() { nodes[1].node.get_and_clear_pending_msg_events(); nodes[2].node.get_and_clear_pending_msg_events(); }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id)); - reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false)); + reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2])); run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { let session_priv = SecretKey::from_slice(&[3; 32]).unwrap(); @@ -607,7 +613,7 @@ fn test_onion_failure() { let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap(); let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads( &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), height, &None).unwrap(); - let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash); + let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap(); msg.cltv_expiry = htlc_cltv; msg.onion_routing_packet = onion_packet; }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: true}), Some(route.paths[0].hops[0].short_channel_id)); @@ -620,6 +626,49 @@ fn test_onion_failure() { }, ||{ nodes[2].node.fail_htlc_backwards(&payment_hash); }, true, Some(23), None, None); + + run_onion_failure_test_with_fail_intercept("bogus err packet with valid hmac", 200, &nodes, + &route, &payment_hash, &payment_secret, |_msg| {}, |msg| { + 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(); + let mut decoded_err_packet = msgs::DecodedOnionErrorPacket { + failuremsg: vec![0], + pad: vec![0; 255], + hmac: [0; 32], + }; + let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref()); + let mut hmac = HmacEngine::::new(&um); + hmac.input(&decoded_err_packet.encode()[32..]); + decoded_err_packet.hmac = Hmac::from_engine(hmac).into_inner(); + msg.reason = onion_utils::encrypt_failure_packet( + &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..]) + }, || nodes[2].node.fail_htlc_backwards(&payment_hash), false, None, + Some(NetworkUpdate::NodeFailure { node_id: route.paths[0].hops[1].pubkey, is_permanent: true }), + Some(channels[1].0.contents.short_channel_id)); + run_onion_failure_test_with_fail_intercept("0-length channel update in UPDATE onion failure", 200, &nodes, + &route, &payment_hash, &payment_secret, |_msg| {}, |msg| { + 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(); + let mut decoded_err_packet = msgs::DecodedOnionErrorPacket { + failuremsg: vec![ + 0x10, 0x7, // UPDATE|7 + 0x0, 0x0 // 0-len channel update + ], + pad: vec![0; 255 - 4 /* 4-byte error message */], + hmac: [0; 32], + }; + let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref()); + let mut hmac = HmacEngine::::new(&um); + hmac.input(&decoded_err_packet.encode()[32..]); + decoded_err_packet.hmac = Hmac::from_engine(hmac).into_inner(); + msg.reason = onion_utils::encrypt_failure_packet( + &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..]) + }, || nodes[2].node.fail_htlc_backwards(&payment_hash), true, Some(0x1000|7), + Some(NetworkUpdate::ChannelFailure { + short_channel_id: channels[1].0.contents.short_channel_id, + is_permanent: false, + }), + Some(channels[1].0.contents.short_channel_id)); } #[test] @@ -671,12 +720,13 @@ fn do_test_onion_failure_stale_channel_update(announced_channel: bool) { config.channel_handshake_config.announced_channel = announced_channel; config.channel_handshake_limits.force_announced_channel_preference = false; config.accept_forwards_to_priv_channels = !announced_channel; + config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253); let chanmon_cfgs = create_chanmon_cfgs(3); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); let persister; let chain_monitor; - let channel_manager_1_deserialized; - let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]); + let channel_manager_1_deserialized; let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs); let other_channel = create_chan_between_nodes( @@ -714,9 +764,9 @@ fn do_test_onion_failure_stale_channel_update(announced_channel: bool) { htlc_minimum_msat: None, }])]; let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV) - .with_features(nodes[2].node.invoice_features()) - .with_route_hints(hop_hints); - get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV) + .with_bolt11_features(nodes[2].node.invoice_features()).unwrap() + .with_route_hints(hop_hints).unwrap(); + get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT) }; send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT, payment_hash, payment_secret); @@ -861,8 +911,8 @@ fn test_always_create_tlv_format_onion_payloads() { create_announced_chan_between_nodes(&nodes, 1, 2); let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV) - .with_features(InvoiceFeatures::empty()); - let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000, TEST_FINAL_CLTV); + .with_bolt11_features(Bolt11InvoiceFeatures::empty()).unwrap(); + let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000); let hops = &route.paths[0].hops; // Asserts that the first hop to `node[1]` signals no support for variable length onions. @@ -874,15 +924,15 @@ fn test_always_create_tlv_format_onion_payloads() { let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads( &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap(); - match onion_payloads[0].format { - msgs::OnionHopDataFormat::NonFinalNode {..} => {}, + match onion_payloads[0] { + msgs::OutboundOnionPayload::Forward {..} => {}, _ => { panic!( "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`, despite that the features signals no support for variable length onions" )} } - match onion_payloads[1].format { - msgs::OnionHopDataFormat::FinalNode {..} => {}, + match onion_payloads[1] { + msgs::OutboundOnionPayload::Receive {..} => {}, _ => {panic!( "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`, despite that the features signals no support for variable length onions" @@ -941,10 +991,16 @@ fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) { let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec(); htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes()); htlc_msat_height_data + }, + FailureCode::InvalidOnionPayload(data) => { + match data { + Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(), + None => Vec::new(), + } } }; - let failure_code = failure_code as u16; + let failure_code = failure_code.into(); let permanent_flag = 0x4000; let permanent_fail = (failure_code & permanent_flag) != 0; expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data); @@ -956,6 +1012,8 @@ fn test_fail_htlc_backwards_with_reason() { do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure); do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing); do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails); + do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(Some((1 << 16, 42)))); + do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(None)); } macro_rules! get_phantom_route { @@ -963,7 +1021,7 @@ macro_rules! get_phantom_route { let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap(); let phantom_route_hint = $nodes[1].node.get_phantom_route_hints(); let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV) - .with_features($nodes[1].node.invoice_features()) + .with_bolt11_features($nodes[1].node.invoice_features()).unwrap() .with_route_hints(vec![RouteHint(vec![ RouteHintHop { src_node_id: $nodes[0].node.get_our_node_id(), @@ -987,13 +1045,14 @@ macro_rules! get_phantom_route { htlc_minimum_msat: None, htlc_maximum_msat: None, } - ])]); + ])]).unwrap(); let scorer = test_utils::TestScorer::new(); let network_graph = $nodes[0].network_graph.read_only(); + let route_params = RouteParameters::from_payment_params_and_value(payment_params, $amt); (get_route( - &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph, + &$nodes[0].node.get_our_node_id(), &route_params, &network_graph, Some(&$nodes[0].node.list_usable_channels().iter().collect::>()), - $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32] + $nodes[0].logger, &scorer, &(), &[0u8; 32] ).unwrap(), phantom_route_hint.phantom_scid) } }} @@ -1106,7 +1165,7 @@ fn test_phantom_invalid_onion_payload() { onion_keys.remove(0); onion_payloads.remove(0); - let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash); + let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap(); onion_packet.hop_data = new_onion_packet.hop_data; onion_packet.hmac = new_onion_packet.hmac; }, @@ -1371,10 +1430,19 @@ fn test_phantom_failure_too_low_recv_amt() { #[test] fn test_phantom_dust_exposure_failure() { + do_test_phantom_dust_exposure_failure(false); + do_test_phantom_dust_exposure_failure(true); +} + +fn do_test_phantom_dust_exposure_failure(multiplier_dust_limit: bool) { // Set the max dust exposure to the dust limit. let max_dust_exposure = 546; let mut receiver_config = UserConfig::default(); - receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure; + // Default test fee estimator rate is 253, so to set the max dust exposure to the dust limit, + // we need to set the multiplier to 2. + receiver_config.channel_config.max_dust_htlc_exposure = + if multiplier_dust_limit { MaxDustHTLCExposure::FeeRateMultiplier(2) } + else { MaxDustHTLCExposure::FixedLimitMsat(max_dust_exposure) }; receiver_config.channel_handshake_config.announced_channel = true; let chanmon_cfgs = create_chanmon_cfgs(2);