Skip to content

Commit feb9a8f

Browse files
valentinewallacevalentinewallace
committed
Enforce onion message has correct context when peeling
Previously the compiler would not enforce that a peeled onion message had a corresponding context that matched, e.g. an offers message needs an offers blinded path context. Refactor PeeledOnion to have multiple Receive message types such that this is now enforced.
1 parent c4a393f commit feb9a8f

File tree

3 files changed

+96
-118
lines changed

3 files changed

+96
-118
lines changed

‎fuzz/src/onion_message.rs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,8 +343,7 @@ mod tests {
343343
assert_eq!(
344344
log_entries.get(&(
345345
"lightning::onion_message::messenger".to_string(),
346-
"Received an onion message with a reply_path: Custom(TestCustomMessage)"
347-
.to_string()
346+
"Received an onion message with a reply_path: TestCustomMessage".to_string()
348347
)),
349348
Some(&1)
350349
);

‎lightning/src/ln/offers_tests.rs‎

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ use core::time::Duration;
4646
use crate::blinded_path::IntroductionNode;
4747
use crate::blinded_path::message::BlindedMessagePath;
4848
use crate::blinded_path::payment::{Bolt12OfferContext, Bolt12RefundContext, PaymentContext};
49-
use crate::blinded_path::message::{MessageContext, OffersContext};
49+
use crate::blinded_path::message::OffersContext;
5050
use crate::events::{ClosureReason, Event, HTLCDestination, PaymentFailureReason, PaymentPurpose};
5151
use crate::ln::channelmanager::{Bolt12PaymentError, MAX_SHORT_LIVED_RELATIVE_EXPIRY, PaymentId, RecentPaymentDetails, RecipientOnionFields, Retry, self};
5252
use crate::types::features::Bolt12InvoiceFeatures;
@@ -60,7 +60,6 @@ use crate::offers::nonce::Nonce;
6060
use crate::offers::parse::Bolt12SemanticError;
6161
use crate::onion_message::messenger::{Destination, PeeledOnion, MessageSendInstructions};
6262
use crate::onion_message::offers::OffersMessage;
63-
use crate::onion_message::packet::ParsedOnionMessageContents;
6463
use crate::routing::gossip::{NodeAlias, NodeId};
6564
use crate::routing::router::{PaymentParameters, RouteParameters, RouteParametersConfig};
6665
use crate::sign::{NodeSigner, Recipient};
@@ -193,9 +192,10 @@ fn claim_bolt12_payment<'a, 'b, 'c>(
193192

194193
fn extract_offer_nonce<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, message: &OnionMessage) -> Nonce {
195194
match node.onion_messenger.peel_onion_message(message) {
196-
Ok(PeeledOnion::Receive(_, Some(MessageContext::Offers(OffersContext::InvoiceRequest { nonce })), _)) => nonce,
197-
Ok(PeeledOnion::Receive(_, context, _)) => panic!("Unexpected onion message context: {:?}", context),
195+
Ok(PeeledOnion::Offers(_, Some(OffersContext::InvoiceRequest { nonce }), _)) => nonce,
196+
Ok(PeeledOnion::Offers(_, context, _)) => panic!("Unexpected onion message context: {:?}", context),
198197
Ok(PeeledOnion::Forward(_, _)) => panic!("Unexpected onion message forward"),
198+
Ok(_) => panic!("Unexpected onion message"),
199199
Err(e) => panic!("Failed to process onion message {:?}", e),
200200
}
201201
}
@@ -204,34 +204,30 @@ pub(super) fn extract_invoice_request<'a, 'b, 'c>(
204204
node: &Node<'a, 'b, 'c>, message: &OnionMessage
205205
) -> (InvoiceRequest, BlindedMessagePath) {
206206
match node.onion_messenger.peel_onion_message(message) {
207-
Ok(PeeledOnion::Receive(message, _, reply_path)) => match message {
208-
ParsedOnionMessageContents::Offers(offers_message) => match offers_message {
209-
OffersMessage::InvoiceRequest(invoice_request) => (invoice_request, reply_path.unwrap()),
210-
OffersMessage::Invoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
211-
#[cfg(async_payments)]
212-
OffersMessage::StaticInvoice(invoice) => panic!("Unexpected static invoice: {:?}", invoice),
213-
OffersMessage::InvoiceError(error) => panic!("Unexpected invoice_error: {:?}", error),
214-
},
215-
_ => panic!("Unexpected message {:?}", message),
207+
Ok(PeeledOnion::Offers(message, _, reply_path)) => match message {
208+
OffersMessage::InvoiceRequest(invoice_request) => (invoice_request, reply_path.unwrap()),
209+
OffersMessage::Invoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
210+
#[cfg(async_payments)]
211+
OffersMessage::StaticInvoice(invoice) => panic!("Unexpected static invoice: {:?}", invoice),
212+
OffersMessage::InvoiceError(error) => panic!("Unexpected invoice_error: {:?}", error),
216213
},
217214
Ok(PeeledOnion::Forward(_, _)) => panic!("Unexpected onion message forward"),
215+
Ok(_) => panic!("Unexpected onion message"),
218216
Err(e) => panic!("Failed to process onion message {:?}", e),
219217
}
220218
}
221219

222220
fn extract_invoice<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, message: &OnionMessage) -> (Bolt12Invoice, BlindedMessagePath) {
223221
match node.onion_messenger.peel_onion_message(message) {
224-
Ok(PeeledOnion::Receive(message, _, reply_path)) => match message {
225-
ParsedOnionMessageContents::Offers(offers_message) => match offers_message {
226-
OffersMessage::InvoiceRequest(invoice_request) => panic!("Unexpected invoice_request: {:?}", invoice_request),
227-
OffersMessage::Invoice(invoice) => (invoice, reply_path.unwrap()),
228-
#[cfg(async_payments)]
229-
OffersMessage::StaticInvoice(invoice) => panic!("Unexpected static invoice: {:?}", invoice),
230-
OffersMessage::InvoiceError(error) => panic!("Unexpected invoice_error: {:?}", error),
231-
},
232-
_ => panic!("Unexpected message {:?}", message),
222+
Ok(PeeledOnion::Offers(message, _, reply_path)) => match message {
223+
OffersMessage::InvoiceRequest(invoice_request) => panic!("Unexpected invoice_request: {:?}", invoice_request),
224+
OffersMessage::Invoice(invoice) => (invoice, reply_path.unwrap()),
225+
#[cfg(async_payments)]
226+
OffersMessage::StaticInvoice(invoice) => panic!("Unexpected static invoice: {:?}", invoice),
227+
OffersMessage::InvoiceError(error) => panic!("Unexpected invoice_error: {:?}", error),
233228
},
234229
Ok(PeeledOnion::Forward(_, _)) => panic!("Unexpected onion message forward"),
230+
Ok(_) => panic!("Unexpected onion message"),
235231
Err(e) => panic!("Failed to process onion message {:?}", e),
236232
}
237233
}
@@ -240,17 +236,15 @@ fn extract_invoice_error<'a, 'b, 'c>(
240236
node: &Node<'a, 'b, 'c>, message: &OnionMessage
241237
) -> InvoiceError {
242238
match node.onion_messenger.peel_onion_message(message) {
243-
Ok(PeeledOnion::Receive(message, _, _)) => match message {
244-
ParsedOnionMessageContents::Offers(offers_message) => match offers_message {
245-
OffersMessage::InvoiceRequest(invoice_request) => panic!("Unexpected invoice_request: {:?}", invoice_request),
246-
OffersMessage::Invoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
247-
#[cfg(async_payments)]
248-
OffersMessage::StaticInvoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
249-
OffersMessage::InvoiceError(error) => error,
250-
},
251-
_ => panic!("Unexpected message: {:?}", message),
239+
Ok(PeeledOnion::Offers(message, _, _)) => match message {
240+
OffersMessage::InvoiceRequest(invoice_request) => panic!("Unexpected invoice_request: {:?}", invoice_request),
241+
OffersMessage::Invoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
242+
#[cfg(async_payments)]
243+
OffersMessage::StaticInvoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
244+
OffersMessage::InvoiceError(error) => error,
252245
},
253246
Ok(PeeledOnion::Forward(_, _)) => panic!("Unexpected onion message forward"),
247+
Ok(_) => panic!("Unexpected onion message"),
254248
Err(e) => panic!("Failed to process onion message {:?}", e),
255249
}
256250
}

‎lightning/src/onion_message/messenger.rs‎

Lines changed: 70 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,18 @@ use bitcoin::secp256k1::{self, PublicKey, Scalar, Secp256k1, SecretKey};
1919
use super::async_payments::AsyncPaymentsMessage;
2020
use super::async_payments::AsyncPaymentsMessageHandler;
2121
use super::dns_resolution::{DNSResolverMessage, DNSResolverMessageHandler};
22-
use super::offers::OffersMessageHandler;
22+
use super::offers::{OffersMessage, OffersMessageHandler};
2323
use super::packet::OnionMessageContents;
2424
use super::packet::ParsedOnionMessageContents;
2525
use super::packet::{
2626
ForwardControlTlvs, Packet, Payload, ReceiveControlTlvs, BIG_PACKET_HOP_DATA_LEN,
2727
SMALL_PACKET_HOP_DATA_LEN,
2828
};
29+
#[cfg(async_payments)]
30+
use crate::blinded_path::message::AsyncPaymentsContext;
2931
use crate::blinded_path::message::{
30-
BlindedMessagePath, ForwardTlvs, MessageContext, MessageForwardNode, NextMessageHop,
31-
ReceiveTlvs,
32+
BlindedMessagePath, DNSResolverContext, ForwardTlvs, MessageContext, MessageForwardNode,
33+
NextMessageHop, OffersContext, ReceiveTlvs,
3234
};
3335
use crate::blinded_path::utils;
3436
use crate::blinded_path::{IntroductionNode, NodeIdLookUp};
@@ -897,8 +899,15 @@ pub trait CustomOnionMessageHandler {
897899
pub enum PeeledOnion<T: OnionMessageContents> {
898900
/// Forwarded onion, with the next node id and a new onion
899901
Forward(NextMessageHop, OnionMessage),
900-
/// Received onion message, with decrypted contents, context, and reply path
901-
Receive(ParsedOnionMessageContents<T>, Option<MessageContext>, Option<BlindedMessagePath>),
902+
/// Received offers onion message, with decrypted contents, context, and reply path
903+
Offers(OffersMessage, Option<OffersContext>, Option<BlindedMessagePath>),
904+
/// Received async payments onion message, with decrypted contents, context, and reply path
905+
#[cfg(async_payments)]
906+
AsyncPayments(AsyncPaymentsMessage, AsyncPaymentsContext, Option<BlindedMessagePath>),
907+
/// Received DNS resolver onion message, with decrypted contents, context, and reply path
908+
DNSResolver(DNSResolverMessage, DNSResolverContext, Option<BlindedMessagePath>),
909+
/// Received custom onion message, with decrypted contents, context, and reply path
910+
Custom(T, Option<Vec<u8>>, Option<BlindedMessagePath>),
902911
}
903912

904913
/// Creates an [`OnionMessage`] with the given `contents` for sending to the destination of
@@ -1073,26 +1082,32 @@ where
10731082
reply_path,
10741083
},
10751084
None,
1076-
)) => match (&message, &context) {
1077-
(_, None) => Ok(PeeledOnion::Receive(message, None, reply_path)),
1078-
(ParsedOnionMessageContents::Offers(_), Some(MessageContext::Offers(_))) => {
1079-
Ok(PeeledOnion::Receive(message, context, reply_path))
1085+
)) => match (message, context) {
1086+
(ParsedOnionMessageContents::Offers(msg), Some(MessageContext::Offers(ctx))) => {
1087+
Ok(PeeledOnion::Offers(msg, Some(ctx), reply_path))
1088+
},
1089+
(ParsedOnionMessageContents::Offers(msg), None) => {
1090+
Ok(PeeledOnion::Offers(msg, None, reply_path))
10801091
},
10811092
#[cfg(async_payments)]
10821093
(
1083-
ParsedOnionMessageContents::AsyncPayments(_),
1084-
Some(MessageContext::AsyncPayments(_)),
1085-
) => Ok(PeeledOnion::Receive(message, context, reply_path)),
1086-
(ParsedOnionMessageContents::Custom(_), Some(MessageContext::Custom(_))) => {
1087-
Ok(PeeledOnion::Receive(message, context, reply_path))
1094+
ParsedOnionMessageContents::AsyncPayments(msg),
1095+
Some(MessageContext::AsyncPayments(ctx)),
1096+
) => Ok(PeeledOnion::AsyncPayments(msg, ctx, reply_path)),
1097+
(ParsedOnionMessageContents::Custom(msg), Some(MessageContext::Custom(ctx))) => {
1098+
Ok(PeeledOnion::Custom(msg, Some(ctx), reply_path))
10881099
},
1089-
(ParsedOnionMessageContents::DNSResolver(_), Some(MessageContext::DNSResolver(_))) => {
1090-
Ok(PeeledOnion::Receive(message, context, reply_path))
1100+
(ParsedOnionMessageContents::Custom(msg), None) => {
1101+
Ok(PeeledOnion::Custom(msg, None, reply_path))
10911102
},
1103+
(
1104+
ParsedOnionMessageContents::DNSResolver(msg),
1105+
Some(MessageContext::DNSResolver(ctx)),
1106+
) => Ok(PeeledOnion::DNSResolver(msg, ctx, reply_path)),
10921107
_ => {
10931108
log_trace!(
10941109
logger,
1095-
"Received message was sent on a blinded path with the wrong context."
1110+
"Received message was sent on a blinded path with wrong or missing context."
10961111
);
10971112
Err(())
10981113
},
@@ -1894,98 +1909,68 @@ where
18941909
{
18951910
fn handle_onion_message(&self, peer_node_id: PublicKey, msg: &OnionMessage) {
18961911
let logger = WithContext::from(&self.logger, Some(peer_node_id), None, None);
1897-
match self.peel_onion_message(msg) {
1898-
Ok(PeeledOnion::Receive(message, context, reply_path)) => {
1912+
macro_rules! log_receive {
1913+
($message: expr, $with_reply_path: expr) => {
18991914
log_trace!(
19001915
logger,
19011916
"Received an onion message with {} reply_path: {:?}",
1902-
if reply_path.is_some() { "a" } else { "no" },
1903-
message
1917+
if $with_reply_path { "a" } else { "no" },
1918+
$message
19041919
);
1920+
};
1921+
}
19051922

1923+
match self.peel_onion_message(msg) {
1924+
Ok(PeeledOnion::Offers(message, context, reply_path)) => {
1925+
log_receive!(message, reply_path.is_some());
1926+
let responder = reply_path.map(Responder::new);
1927+
let response_instructions =
1928+
self.offers_handler.handle_message(message, context, responder);
1929+
if let Some((msg, instructions)) = response_instructions {
1930+
let _ = self.handle_onion_message_response(msg, instructions);
1931+
}
1932+
},
1933+
#[cfg(async_payments)]
1934+
Ok(PeeledOnion::AsyncPayments(message, context, reply_path)) => {
1935+
log_receive!(message, reply_path.is_some());
19061936
let responder = reply_path.map(Responder::new);
19071937
match message {
1908-
ParsedOnionMessageContents::Offers(msg) => {
1909-
let context = match context {
1910-
None => None,
1911-
Some(MessageContext::Offers(context)) => Some(context),
1912-
_ => {
1913-
debug_assert!(false, "Checked in peel_onion_message");
1914-
return;
1915-
},
1916-
};
1917-
let response_instructions =
1918-
self.offers_handler.handle_message(msg, context, responder);
1919-
if let Some((msg, instructions)) = response_instructions {
1920-
let _ = self.handle_onion_message_response(msg, instructions);
1921-
}
1922-
},
1923-
#[cfg(async_payments)]
1924-
ParsedOnionMessageContents::AsyncPayments(
1925-
AsyncPaymentsMessage::HeldHtlcAvailable(msg),
1926-
) => {
1927-
let context = match context {
1928-
Some(MessageContext::AsyncPayments(context)) => context,
1929-
Some(_) => {
1930-
debug_assert!(false, "Checked in peel_onion_message");
1931-
return;
1932-
},
1933-
None => return,
1934-
};
1938+
AsyncPaymentsMessage::HeldHtlcAvailable(msg) => {
19351939
let response_instructions = self
19361940
.async_payments_handler
19371941
.handle_held_htlc_available(msg, context, responder);
19381942
if let Some((msg, instructions)) = response_instructions {
19391943
let _ = self.handle_onion_message_response(msg, instructions);
19401944
}
19411945
},
1942-
#[cfg(async_payments)]
1943-
ParsedOnionMessageContents::AsyncPayments(
1944-
AsyncPaymentsMessage::ReleaseHeldHtlc(msg),
1945-
) => {
1946-
let context = match context {
1947-
Some(MessageContext::AsyncPayments(context)) => context,
1948-
Some(_) => {
1949-
debug_assert!(false, "Checked in peel_onion_message");
1950-
return;
1951-
},
1952-
None => return,
1953-
};
1946+
AsyncPaymentsMessage::ReleaseHeldHtlc(msg) => {
19541947
self.async_payments_handler.handle_release_held_htlc(msg, context);
19551948
},
1956-
ParsedOnionMessageContents::DNSResolver(DNSResolverMessage::DNSSECQuery(
1957-
msg,
1958-
)) => {
1949+
}
1950+
},
1951+
Ok(PeeledOnion::DNSResolver(message, context, reply_path)) => {
1952+
log_receive!(message, reply_path.is_some());
1953+
let responder = reply_path.map(Responder::new);
1954+
match message {
1955+
DNSResolverMessage::DNSSECQuery(msg) => {
19591956
let response_instructions =
19601957
self.dns_resolver_handler.handle_dnssec_query(msg, responder);
19611958
if let Some((msg, instructions)) = response_instructions {
19621959
let _ = self.handle_onion_message_response(msg, instructions);
19631960
}
19641961
},
1965-
ParsedOnionMessageContents::DNSResolver(DNSResolverMessage::DNSSECProof(
1966-
msg,
1967-
)) => {
1968-
let context = match context {
1969-
Some(MessageContext::DNSResolver(context)) => context,
1970-
_ => return,
1971-
};
1962+
DNSResolverMessage::DNSSECProof(msg) => {
19721963
self.dns_resolver_handler.handle_dnssec_proof(msg, context);
19731964
},
1974-
ParsedOnionMessageContents::Custom(msg) => {
1975-
let context = match context {
1976-
None => None,
1977-
Some(MessageContext::Custom(data)) => Some(data),
1978-
_ => {
1979-
debug_assert!(false, "Checked in peel_onion_message");
1980-
return;
1981-
},
1982-
};
1983-
let response_instructions =
1984-
self.custom_handler.handle_custom_message(msg, context, responder);
1985-
if let Some((msg, instructions)) = response_instructions {
1986-
let _ = self.handle_onion_message_response(msg, instructions);
1987-
}
1988-
},
1965+
}
1966+
},
1967+
Ok(PeeledOnion::Custom(message, context, reply_path)) => {
1968+
log_receive!(message, reply_path.is_some());
1969+
let responder = reply_path.map(Responder::new);
1970+
let response_instructions =
1971+
self.custom_handler.handle_custom_message(message, context, responder);
1972+
if let Some((msg, instructions)) = response_instructions {
1973+
let _ = self.handle_onion_message_response(msg, instructions);
19891974
}
19901975
},
19911976
Ok(PeeledOnion::Forward(next_hop, onion_message)) => {

0 commit comments

Comments
 (0)