use bitcoin::secp256k1::PublicKey;
use bitcoin::secp256k1::ecdh::SharedSecret;
-use ln::msgs::DecodeError;
-use ln::onion_utils;
-use super::blinded_route::{BlindedRoute, ForwardTlvs, ReceiveTlvs};
-use util::chacha20poly1305rfc::{ChaChaPolyReadAdapter, ChaChaPolyWriteAdapter};
-use util::ser::{BigSize, FixedLengthReader, LengthRead, LengthReadable, LengthReadableArgs, MaybeReadableArgs, Readable, ReadableArgs, Writeable, Writer};
+use crate::blinded_path::{BlindedPath, ForwardTlvs, ReceiveTlvs};
+use crate::ln::msgs::DecodeError;
+use crate::ln::onion_utils;
+use super::messenger::CustomOnionMessageHandler;
+use super::offers::OffersMessage;
+use crate::util::chacha20poly1305rfc::{ChaChaPolyReadAdapter, ChaChaPolyWriteAdapter};
+use crate::util::logger::Logger;
+use crate::util::ser::{BigSize, FixedLengthReader, LengthRead, LengthReadable, LengthReadableArgs, Readable, ReadableArgs, Writeable, Writer};
use core::cmp;
-use io::{self, Read};
-use prelude::*;
+use crate::io::{self, Read};
+use crate::prelude::*;
// Per the spec, an onion message packet's `hop_data` field length should be
// SMALL_PACKET_HOP_DATA_LEN if it fits, else BIG_PACKET_HOP_DATA_LEN if it fits.
pub(super) const SMALL_PACKET_HOP_DATA_LEN: usize = 1300;
pub(super) const BIG_PACKET_HOP_DATA_LEN: usize = 32768;
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct Packet {
pub(super) version: u8,
pub(super) public_key: PublicKey,
/// This payload is for the final hop.
Receive {
control_tlvs: ReceiveControlTlvs,
- reply_path: Option<BlindedRoute>,
+ reply_path: Option<BlindedPath>,
message: OnionMessageContents<T>,
}
}
#[derive(Debug)]
/// The contents of an onion message. In the context of offers, this would be the invoice, invoice
/// request, or invoice error.
-pub enum OnionMessageContents<T> where T: CustomOnionMessageContents {
- // Coming soon:
- // Invoice,
- // InvoiceRequest,
- // InvoiceError,
+pub enum OnionMessageContents<T: CustomOnionMessageContents> {
+ /// A message related to BOLT 12 Offers.
+ Offers(OffersMessage),
/// A custom onion message specified by the user.
Custom(T),
}
-impl<T> OnionMessageContents<T> where T: CustomOnionMessageContents {
+impl<T: CustomOnionMessageContents> OnionMessageContents<T> {
/// Returns the type that was used to decode the message payload.
+ ///
+ /// This is not exported to bindings users as methods on non-cloneable enums are not currently exportable
pub fn tlv_type(&self) -> u64 {
match self {
+ &OnionMessageContents::Offers(ref msg) => msg.tlv_type(),
&OnionMessageContents::Custom(ref msg) => msg.tlv_type(),
}
}
}
+/// This is not exported to bindings users as methods on non-cloneable enums are not currently exportable
impl<T: CustomOnionMessageContents> Writeable for OnionMessageContents<T> {
fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
match self {
+ OnionMessageContents::Offers(msg) => Ok(msg.write(w)?),
OnionMessageContents::Custom(msg) => Ok(msg.write(w)?),
}
}
}
-/// The contents of a custom onion message. Must implement `MaybeReadableArgs<u64>` where the `u64`
-/// is the custom TLV type attempting to be read, and return `Ok(None)` if the TLV type is unknown.
-pub trait CustomOnionMessageContents: Writeable + MaybeReadableArgs<u64> {
+/// The contents of a custom onion message.
+pub trait CustomOnionMessageContents: Writeable {
/// Returns the TLV type identifying the message contents. MUST be >= 64.
fn tlv_type(&self) -> u64;
}
/// Forward control TLVs in their blinded and unblinded form.
pub(super) enum ForwardControlTlvs {
- /// If we're sending to a blinded route, the node that constructed the blinded route has provided
+ /// If we're sending to a blinded path, the node that constructed the blinded path has provided
/// this hop's control TLVs, already encrypted into bytes.
Blinded(Vec<u8>),
/// If we're constructing an onion message hop through an intermediate unblinded node, we'll need
/// to construct the intermediate hop's control TLVs in their unblinded state to avoid encoding
- /// them into an intermediate Vec. See [`super::blinded_route::ForwardTlvs`] for more info.
+ /// them into an intermediate Vec. See [`crate::blinded_path::ForwardTlvs`] for more info.
Unblinded(ForwardTlvs),
}
pub(super) enum ReceiveControlTlvs {
/// See [`ForwardControlTlvs::Blinded`].
Blinded(Vec<u8>),
- /// See [`ForwardControlTlvs::Unblinded`] and [`super::blinded_route::ReceiveTlvs`].
+ /// See [`ForwardControlTlvs::Unblinded`] and [`crate::blinded_path::ReceiveTlvs`].
Unblinded(ReceiveTlvs),
}
fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
match &self.0 {
Payload::Forward(ForwardControlTlvs::Blinded(encrypted_bytes)) => {
- encode_varint_length_prefixed_tlv!(w, {
- (4, encrypted_bytes, vec_type)
+ _encode_varint_length_prefixed_tlv!(w, {
+ (4, *encrypted_bytes, required_vec)
})
},
Payload::Receive {
control_tlvs: ReceiveControlTlvs::Blinded(encrypted_bytes), reply_path, message,
} => {
- encode_varint_length_prefixed_tlv!(w, {
+ _encode_varint_length_prefixed_tlv!(w, {
(2, reply_path, option),
- (4, encrypted_bytes, vec_type),
+ (4, *encrypted_bytes, required_vec),
(message.tlv_type(), message, required)
})
},
Payload::Forward(ForwardControlTlvs::Unblinded(control_tlvs)) => {
let write_adapter = ChaChaPolyWriteAdapter::new(self.1, &control_tlvs);
- encode_varint_length_prefixed_tlv!(w, {
+ _encode_varint_length_prefixed_tlv!(w, {
(4, write_adapter, required)
})
},
control_tlvs: ReceiveControlTlvs::Unblinded(control_tlvs), reply_path, message,
} => {
let write_adapter = ChaChaPolyWriteAdapter::new(self.1, &control_tlvs);
- encode_varint_length_prefixed_tlv!(w, {
+ _encode_varint_length_prefixed_tlv!(w, {
(2, reply_path, option),
(4, write_adapter, required),
(message.tlv_type(), message, required)
}
// Uses the provided secret to simultaneously decode and decrypt the control TLVs and data TLV.
-impl<T: CustomOnionMessageContents> ReadableArgs<SharedSecret> for Payload<T> {
- fn read<R: Read>(r: &mut R, encrypted_tlvs_ss: SharedSecret) -> Result<Self, DecodeError> {
+impl<H: CustomOnionMessageHandler + ?Sized, L: Logger + ?Sized>
+ReadableArgs<(SharedSecret, &H, &L)> for Payload<<H as CustomOnionMessageHandler>::CustomMessage> {
+ fn read<R: Read>(r: &mut R, args: (SharedSecret, &H, &L)) -> Result<Self, DecodeError> {
+ let (encrypted_tlvs_ss, handler, logger) = args;
+
let v: BigSize = Readable::read(r)?;
let mut rd = FixedLengthReader::new(r, v.0);
- let mut reply_path: Option<BlindedRoute> = None;
+ let mut reply_path: Option<BlindedPath> = None;
let mut read_adapter: Option<ChaChaPolyReadAdapter<ControlTlvs>> = None;
let rho = onion_utils::gen_rho_from_shared_secret(&encrypted_tlvs_ss.secret_bytes());
let mut message_type: Option<u64> = None;
let mut message = None;
- decode_tlv_stream!(&mut rd, {
+ decode_tlv_stream_with_custom_tlv_decode!(&mut rd, {
(2, reply_path, option),
(4, read_adapter, (option: LengthReadableArgs, rho)),
}, |msg_type, msg_reader| {
if message_type.is_some() { return Err(DecodeError::InvalidValue) }
message_type = Some(msg_type);
- match T::read(msg_reader, msg_type) {
- Ok(Some(msg)) => {
- message = Some(msg);
+ match msg_type {
+ tlv_type if OffersMessage::is_known_type(tlv_type) => {
+ let msg = OffersMessage::read(msg_reader, (tlv_type, logger))?;
+ message = Some(OnionMessageContents::Offers(msg));
Ok(true)
},
- Ok(None) => Ok(false),
- Err(e) => Err(e),
+ _ => match handler.read_custom_message(msg_type, msg_reader)? {
+ Some(msg) => {
+ message = Some(OnionMessageContents::Custom(msg));
+ Ok(true)
+ },
+ None => Ok(false),
+ },
}
});
rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
Ok(Payload::Forward(ForwardControlTlvs::Unblinded(tlvs)))
},
Some(ChaChaPolyReadAdapter { readable: ControlTlvs::Receive(tlvs)}) => {
- if message.is_none() { return Err(DecodeError::InvalidValue) }
Ok(Payload::Receive {
control_tlvs: ReceiveControlTlvs::Unblinded(tlvs),
reply_path,
- message: OnionMessageContents::Custom(message.unwrap()),
+ message: message.ok_or(DecodeError::InvalidValue)?,
})
- }
+ },
}
}
}
/// When reading a packet off the wire, we don't know a priori whether the packet is to be forwarded
/// or received. Thus we read a ControlTlvs rather than reading a ForwardControlTlvs or
/// ReceiveControlTlvs directly.
-pub(super) enum ControlTlvs {
+pub(crate) enum ControlTlvs {
/// This onion message is intended to be forwarded.
Forward(ForwardTlvs),
/// This onion message is intended to be received.
projects / rust-lightning / blobdiff