Use TLV instead of explicit length for VecReadWrapper termination
authorMatt Corallo <git@bluematt.me>
Sun, 30 May 2021 23:24:43 +0000 (23:24 +0000)
committerMatt Corallo <git@bluematt.me>
Tue, 1 Jun 2021 21:53:06 +0000 (21:53 +0000)
VecReadWrapper is only used in TLVs so there is no need to prepend
a length before writing/reading the objects - we can instead simply
read until we reach the end of the TLV stream.

lightning/src/ln/msgs.rs
lightning/src/util/ser.rs

index eec1a053802fd7476ce1b43f0518b4ef339c1dfb..f02a478357b8c32598ad5c4096abe905482d5c8e 100644 (file)
@@ -46,7 +46,7 @@ use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
 
 /// An error in decoding a message or struct.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq)]
 pub enum DecodeError {
        /// A version byte specified something we don't know how to handle.
        /// Includes unknown realm byte in an OnionHopData packet
index 7bc09e7f8da00c4bc62c5a9944a1f0f8f3cf2e0d..a49b033db3d51010073260f8d0023dac5e6a5c1c 100644 (file)
@@ -249,28 +249,31 @@ impl<T: Readable> Readable for OptionDeserWrapper<T> {
        }
 }
 
-const MAX_ALLOC_SIZE: u64 = 64*1024;
-
+/// Wrapper to write each element of a Vec with no length prefix
 pub(crate) struct VecWriteWrapper<'a, T: Writeable>(pub &'a Vec<T>);
 impl<'a, T: Writeable> Writeable for VecWriteWrapper<'a, T> {
        #[inline]
        fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
-               (self.0.len() as u64).write(writer)?;
                for ref v in self.0.iter() {
                        v.write(writer)?;
                }
                Ok(())
        }
 }
+
+/// Wrapper to read elements from a given stream until it reaches the end of the stream.
 pub(crate) struct VecReadWrapper<T: Readable>(pub Vec<T>);
 impl<T: Readable> Readable for VecReadWrapper<T> {
        #[inline]
-       fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
-               let count: u64 = Readable::read(reader)?;
-               let mut values = Vec::with_capacity(cmp::min(count, MAX_ALLOC_SIZE / (core::mem::size_of::<T>() as u64)) as usize);
-               for _ in 0..count {
-                       match Readable::read(reader) {
+       fn read<R: Read>(mut reader: &mut R) -> Result<Self, DecodeError> {
+               let mut values = Vec::new();
+               loop {
+                       let mut track_read = ReadTrackingReader::new(&mut reader);
+                       match Readable::read(&mut track_read) {
                                Ok(v) => { values.push(v); },
+                               // If we failed to read any bytes at all, we reached the end of our TLV
+                               // stream and have simply exhausted all entries.
+                               Err(ref e) if e == &DecodeError::ShortRead && !track_read.have_read => break,
                                Err(e) => return Err(e),
                        }
                }