1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Structs and enums useful for constructing and reading an onion message packet.
12 use bitcoin::secp256k1::PublicKey;
13 use bitcoin::secp256k1::ecdh::SharedSecret;
15 use crate::ln::msgs::DecodeError;
16 use crate::ln::onion_utils;
17 use super::blinded_route::{BlindedRoute, ForwardTlvs, ReceiveTlvs};
18 use crate::util::chacha20poly1305rfc::{ChaChaPolyReadAdapter, ChaChaPolyWriteAdapter};
19 use crate::util::ser::{BigSize, FixedLengthReader, LengthRead, LengthReadable, LengthReadableArgs, MaybeReadableArgs, Readable, ReadableArgs, Writeable, Writer};
22 use crate::io::{self, Read};
23 use crate::prelude::*;
25 // Per the spec, an onion message packet's `hop_data` field length should be
26 // SMALL_PACKET_HOP_DATA_LEN if it fits, else BIG_PACKET_HOP_DATA_LEN if it fits.
27 pub(super) const SMALL_PACKET_HOP_DATA_LEN: usize = 1300;
28 pub(super) const BIG_PACKET_HOP_DATA_LEN: usize = 32768;
30 #[derive(Clone, Debug, PartialEq, Eq)]
31 pub(crate) struct Packet {
32 pub(super) version: u8,
33 pub(super) public_key: PublicKey,
34 // Unlike the onion packets used for payments, onion message packets can have payloads greater
36 // TODO: if 1300 ends up being the most common size, optimize this to be:
37 // enum { ThirteenHundred([u8; 1300]), VarLen(Vec<u8>) }
38 pub(super) hop_data: Vec<u8>,
39 pub(super) hmac: [u8; 32],
42 impl onion_utils::Packet for Packet {
44 fn new(public_key: PublicKey, hop_data: Vec<u8>, hmac: [u8; 32]) -> Packet {
54 impl Writeable for Packet {
55 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
56 self.version.write(w)?;
57 self.public_key.write(w)?;
58 w.write_all(&self.hop_data)?;
64 impl LengthReadable for Packet {
65 fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
66 const READ_BUFFER_SIZE: usize = 4096;
68 let version = Readable::read(r)?;
69 let public_key = Readable::read(r)?;
71 let mut hop_data = Vec::new();
72 let hop_data_len = r.total_bytes().saturating_sub(66) as usize; // 1 (version) + 33 (pubkey) + 32 (HMAC) = 66
74 while read_idx < hop_data_len {
75 let mut read_buffer = [0; READ_BUFFER_SIZE];
76 let read_amt = cmp::min(hop_data_len - read_idx, READ_BUFFER_SIZE);
77 r.read_exact(&mut read_buffer[..read_amt])?;
78 hop_data.extend_from_slice(&read_buffer[..read_amt]);
82 let hmac = Readable::read(r)?;
92 /// Onion message payloads contain "control" TLVs and "data" TLVs. Control TLVs are used to route
93 /// the onion message from hop to hop and for path verification, whereas data TLVs contain the onion
94 /// message content itself, such as an invoice request.
95 pub(super) enum Payload<T: CustomOnionMessageContents> {
96 /// This payload is for an intermediate hop.
97 Forward(ForwardControlTlvs),
98 /// This payload is for the final hop.
100 control_tlvs: ReceiveControlTlvs,
101 reply_path: Option<BlindedRoute>,
102 message: OnionMessageContents<T>,
107 /// The contents of an onion message. In the context of offers, this would be the invoice, invoice
108 /// request, or invoice error.
109 pub enum OnionMessageContents<T> where T: CustomOnionMessageContents {
114 /// A custom onion message specified by the user.
118 impl<T> OnionMessageContents<T> where T: CustomOnionMessageContents {
119 /// Returns the type that was used to decode the message payload.
120 pub fn tlv_type(&self) -> u64 {
122 &OnionMessageContents::Custom(ref msg) => msg.tlv_type(),
127 impl<T: CustomOnionMessageContents> Writeable for OnionMessageContents<T> {
128 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
130 OnionMessageContents::Custom(msg) => Ok(msg.write(w)?),
135 /// The contents of a custom onion message. Must implement `MaybeReadableArgs<u64>` where the `u64`
136 /// is the custom TLV type attempting to be read, and return `Ok(None)` if the TLV type is unknown.
137 pub trait CustomOnionMessageContents: Writeable + MaybeReadableArgs<u64> {
138 /// Returns the TLV type identifying the message contents. MUST be >= 64.
139 fn tlv_type(&self) -> u64;
142 /// Forward control TLVs in their blinded and unblinded form.
143 pub(super) enum ForwardControlTlvs {
144 /// If we're sending to a blinded route, the node that constructed the blinded route has provided
145 /// this hop's control TLVs, already encrypted into bytes.
147 /// If we're constructing an onion message hop through an intermediate unblinded node, we'll need
148 /// to construct the intermediate hop's control TLVs in their unblinded state to avoid encoding
149 /// them into an intermediate Vec. See [`super::blinded_route::ForwardTlvs`] for more info.
150 Unblinded(ForwardTlvs),
153 /// Receive control TLVs in their blinded and unblinded form.
154 pub(super) enum ReceiveControlTlvs {
155 /// See [`ForwardControlTlvs::Blinded`].
157 /// See [`ForwardControlTlvs::Unblinded`] and [`super::blinded_route::ReceiveTlvs`].
158 Unblinded(ReceiveTlvs),
161 // Uses the provided secret to simultaneously encode and encrypt the unblinded control TLVs.
162 impl<T: CustomOnionMessageContents> Writeable for (Payload<T>, [u8; 32]) {
163 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
165 Payload::Forward(ForwardControlTlvs::Blinded(encrypted_bytes)) => {
166 encode_varint_length_prefixed_tlv!(w, {
167 (4, encrypted_bytes, vec_type)
171 control_tlvs: ReceiveControlTlvs::Blinded(encrypted_bytes), reply_path, message,
173 encode_varint_length_prefixed_tlv!(w, {
174 (2, reply_path, option),
175 (4, encrypted_bytes, vec_type),
176 (message.tlv_type(), message, required)
179 Payload::Forward(ForwardControlTlvs::Unblinded(control_tlvs)) => {
180 let write_adapter = ChaChaPolyWriteAdapter::new(self.1, &control_tlvs);
181 encode_varint_length_prefixed_tlv!(w, {
182 (4, write_adapter, required)
186 control_tlvs: ReceiveControlTlvs::Unblinded(control_tlvs), reply_path, message,
188 let write_adapter = ChaChaPolyWriteAdapter::new(self.1, &control_tlvs);
189 encode_varint_length_prefixed_tlv!(w, {
190 (2, reply_path, option),
191 (4, write_adapter, required),
192 (message.tlv_type(), message, required)
200 // Uses the provided secret to simultaneously decode and decrypt the control TLVs and data TLV.
201 impl<T: CustomOnionMessageContents> ReadableArgs<SharedSecret> for Payload<T> {
202 fn read<R: Read>(r: &mut R, encrypted_tlvs_ss: SharedSecret) -> Result<Self, DecodeError> {
203 let v: BigSize = Readable::read(r)?;
204 let mut rd = FixedLengthReader::new(r, v.0);
205 let mut reply_path: Option<BlindedRoute> = None;
206 let mut read_adapter: Option<ChaChaPolyReadAdapter<ControlTlvs>> = None;
207 let rho = onion_utils::gen_rho_from_shared_secret(&encrypted_tlvs_ss.secret_bytes());
208 let mut message_type: Option<u64> = None;
209 let mut message = None;
210 decode_tlv_stream!(&mut rd, {
211 (2, reply_path, option),
212 (4, read_adapter, (option: LengthReadableArgs, rho)),
213 }, |msg_type, msg_reader| {
214 if msg_type < 64 { return Ok(false) }
215 // Don't allow reading more than one data TLV from an onion message.
216 if message_type.is_some() { return Err(DecodeError::InvalidValue) }
218 message_type = Some(msg_type);
219 match T::read(msg_reader, msg_type) {
224 Ok(None) => Ok(false),
228 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
231 None => return Err(DecodeError::InvalidValue),
232 Some(ChaChaPolyReadAdapter { readable: ControlTlvs::Forward(tlvs)}) => {
233 if message_type.is_some() {
234 return Err(DecodeError::InvalidValue)
236 Ok(Payload::Forward(ForwardControlTlvs::Unblinded(tlvs)))
238 Some(ChaChaPolyReadAdapter { readable: ControlTlvs::Receive(tlvs)}) => {
239 if message.is_none() { return Err(DecodeError::InvalidValue) }
240 Ok(Payload::Receive {
241 control_tlvs: ReceiveControlTlvs::Unblinded(tlvs),
243 message: OnionMessageContents::Custom(message.unwrap()),
250 /// When reading a packet off the wire, we don't know a priori whether the packet is to be forwarded
251 /// or received. Thus we read a ControlTlvs rather than reading a ForwardControlTlvs or
252 /// ReceiveControlTlvs directly.
253 pub(super) enum ControlTlvs {
254 /// This onion message is intended to be forwarded.
255 Forward(ForwardTlvs),
256 /// This onion message is intended to be received.
257 Receive(ReceiveTlvs),
260 impl Readable for ControlTlvs {
261 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
262 let mut _padding: Option<Padding> = None;
263 let mut _short_channel_id: Option<u64> = None;
264 let mut next_node_id: Option<PublicKey> = None;
265 let mut path_id: Option<[u8; 32]> = None;
266 let mut next_blinding_override: Option<PublicKey> = None;
267 decode_tlv_stream!(&mut r, {
268 (1, _padding, option),
269 (2, _short_channel_id, option),
270 (4, next_node_id, option),
271 (6, path_id, option),
272 (8, next_blinding_override, option),
275 let valid_fwd_fmt = next_node_id.is_some() && path_id.is_none();
276 let valid_recv_fmt = next_node_id.is_none() && next_blinding_override.is_none();
278 let payload_fmt = if valid_fwd_fmt {
279 ControlTlvs::Forward(ForwardTlvs {
280 next_node_id: next_node_id.unwrap(),
281 next_blinding_override,
283 } else if valid_recv_fmt {
284 ControlTlvs::Receive(ReceiveTlvs {
288 return Err(DecodeError::InvalidValue)
295 /// Reads padding to the end, ignoring what's read.
296 pub(crate) struct Padding {}
297 impl Readable for Padding {
299 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
301 let mut buf = [0; 8192];
302 if reader.read(&mut buf[..])? == 0 { break; }