use bitcoin::secp256k1::PublicKey;
use bitcoin::secp256k1::ecdh::SharedSecret;
-use ln::msgs::DecodeError;
-use ln::onion_utils;
-use super::blinded_route::{ForwardTlvs, ReceiveTlvs};
-use util::chacha20poly1305rfc::{ChaChaPolyReadAdapter, ChaChaPolyWriteAdapter};
-use util::ser::{FixedLengthReader, LengthRead, LengthReadable, LengthReadableArgs, Readable, ReadableArgs, Writeable, Writer};
+use crate::ln::msgs::DecodeError;
+use crate::ln::onion_utils;
+use super::blinded_route::{BlindedRoute, ForwardTlvs, ReceiveTlvs};
+use crate::util::chacha20poly1305rfc::{ChaChaPolyReadAdapter, ChaChaPolyWriteAdapter};
+use crate::util::ser::{BigSize, FixedLengthReader, LengthRead, LengthReadable, LengthReadableArgs, MaybeReadableArgs, 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,
let public_key = Readable::read(r)?;
let mut hop_data = Vec::new();
- let hop_data_len = r.total_bytes() as usize - 66; // 1 (version) + 33 (pubkey) + 32 (HMAC) = 66
+ let hop_data_len = r.total_bytes().saturating_sub(66) as usize; // 1 (version) + 33 (pubkey) + 32 (HMAC) = 66
let mut read_idx = 0;
while read_idx < hop_data_len {
let mut read_buffer = [0; READ_BUFFER_SIZE];
let read_amt = cmp::min(hop_data_len - read_idx, READ_BUFFER_SIZE);
- r.read_exact(&mut read_buffer[..read_amt]);
+ r.read_exact(&mut read_buffer[..read_amt])?;
hop_data.extend_from_slice(&read_buffer[..read_amt]);
read_idx += read_amt;
}
/// Onion message payloads contain "control" TLVs and "data" TLVs. Control TLVs are used to route
/// the onion message from hop to hop and for path verification, whereas data TLVs contain the onion
/// message content itself, such as an invoice request.
-pub(super) enum Payload {
+pub(super) enum Payload<T: CustomOnionMessageContents> {
/// This payload is for an intermediate hop.
Forward(ForwardControlTlvs),
/// This payload is for the final hop.
Receive {
control_tlvs: ReceiveControlTlvs,
- // Coming soon:
- // reply_path: Option<BlindedRoute>,
- // message: Message,
+ reply_path: Option<BlindedRoute>,
+ message: OnionMessageContents<T>,
}
}
-// Coming soon:
-// enum Message {
-// InvoiceRequest(InvoiceRequest),
-// Invoice(Invoice),
-// InvoiceError(InvoiceError),
-// CustomMessage<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,
+ /// A custom onion message specified by the user.
+ Custom(T),
+}
+
+impl<T> OnionMessageContents<T> where T: CustomOnionMessageContents {
+ /// Returns the type that was used to decode the message payload.
+ pub fn tlv_type(&self) -> u64 {
+ match self {
+ &OnionMessageContents::Custom(ref msg) => msg.tlv_type(),
+ }
+ }
+}
+
+impl<T: CustomOnionMessageContents> Writeable for OnionMessageContents<T> {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
+ match self {
+ 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> {
+ /// 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 {
}
// Uses the provided secret to simultaneously encode and encrypt the unblinded control TLVs.
-impl Writeable for (Payload, [u8; 32]) {
+impl<T: CustomOnionMessageContents> Writeable for (Payload<T>, [u8; 32]) {
fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
match &self.0 {
- Payload::Forward(ForwardControlTlvs::Blinded(encrypted_bytes)) |
- Payload::Receive { control_tlvs: ReceiveControlTlvs::Blinded(encrypted_bytes)} => {
+ Payload::Forward(ForwardControlTlvs::Blinded(encrypted_bytes)) => {
encode_varint_length_prefixed_tlv!(w, {
(4, encrypted_bytes, vec_type)
})
},
+ Payload::Receive {
+ control_tlvs: ReceiveControlTlvs::Blinded(encrypted_bytes), reply_path, message,
+ } => {
+ encode_varint_length_prefixed_tlv!(w, {
+ (2, reply_path, option),
+ (4, encrypted_bytes, vec_type),
+ (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, {
(4, write_adapter, required)
})
},
- Payload::Receive { control_tlvs: ReceiveControlTlvs::Unblinded(control_tlvs)} => {
+ Payload::Receive {
+ control_tlvs: ReceiveControlTlvs::Unblinded(control_tlvs), reply_path, message,
+ } => {
let write_adapter = ChaChaPolyWriteAdapter::new(self.1, &control_tlvs);
encode_varint_length_prefixed_tlv!(w, {
- (4, write_adapter, required)
+ (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.
-impl ReadableArgs<SharedSecret> for Payload {
- fn read<R: Read>(mut r: &mut R, encrypted_tlvs_ss: SharedSecret) -> Result<Self, DecodeError> {
- use bitcoin::consensus::encode::{Decodable, Error, VarInt};
- let v: VarInt = Decodable::consensus_decode(&mut r)
- .map_err(|e| match e {
- Error::Io(ioe) => DecodeError::from(ioe),
- _ => DecodeError::InvalidValue
- })?;
-
+// 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> {
+ let v: BigSize = Readable::read(r)?;
let mut rd = FixedLengthReader::new(r, v.0);
- // TODO: support reply paths
- let mut _reply_path_bytes: Option<Vec<u8>> = Some(Vec::new());
+ let mut reply_path: Option<BlindedRoute> = 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, {
- (2, _reply_path_bytes, vec_type),
- (4, read_adapter, (option: LengthReadableArgs, rho))
+ (2, reply_path, option),
+ (4, read_adapter, (option: LengthReadableArgs, rho)),
+ }, |msg_type, msg_reader| {
+ if msg_type < 64 { return Ok(false) }
+ // Don't allow reading more than one data TLV from an onion message.
+ 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);
+ Ok(true)
+ },
+ Ok(None) => Ok(false),
+ Err(e) => Err(e),
+ }
});
rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
match read_adapter {
None => return Err(DecodeError::InvalidValue),
Some(ChaChaPolyReadAdapter { readable: ControlTlvs::Forward(tlvs)}) => {
+ if message_type.is_some() {
+ return Err(DecodeError::InvalidValue)
+ }
Ok(Payload::Forward(ForwardControlTlvs::Unblinded(tlvs)))
},
Some(ChaChaPolyReadAdapter { readable: ControlTlvs::Receive(tlvs)}) => {
- Ok(Payload::Receive { control_tlvs: ReceiveControlTlvs::Unblinded(tlvs)})
- },
+ if message.is_none() { return Err(DecodeError::InvalidValue) }
+ Ok(Payload::Receive {
+ control_tlvs: ReceiveControlTlvs::Unblinded(tlvs),
+ reply_path,
+ message: OnionMessageContents::Custom(message.unwrap()),
+ })
+ }
}
}
}
projects / rust-lightning / blobdiff