X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Fser.rs;h=b02fef275d2c08d644f1f706c8440f3d688d682c;hb=f4729075cbfef9f99e8316335dd1e8d15671674d;hp=44fdd1c0cf4d3097d27e7abebb83e0a397f0ac86;hpb=569f9038bec1f0ba09cfb01c35222a9365ee77d6;p=rust-lightning diff --git a/lightning/src/util/ser.rs b/lightning/src/util/ser.rs index 44fdd1c0..b02fef27 100644 --- a/lightning/src/util/ser.rs +++ b/lightning/src/util/ser.rs @@ -1,33 +1,45 @@ +// This file is Copyright its original authors, visible in version control +// history. +// +// This file is licensed under the Apache License, Version 2.0 or the MIT license +// , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. + //! A very simple serialization framework which is used to serialize/deserialize messages as well //! as ChannelsManagers and ChannelMonitors. -use std::result::Result; +use prelude::*; use std::io::{Read, Write}; -use std::collections::HashMap; -use std::hash::Hash; +use core::hash::Hash; use std::sync::Mutex; -use std::cmp; +use core::cmp; -use secp256k1::Signature; -use secp256k1::key::{PublicKey, SecretKey}; +use bitcoin::secp256k1::Signature; +use bitcoin::secp256k1::key::{PublicKey, SecretKey}; +use bitcoin::secp256k1::constants::{PUBLIC_KEY_SIZE, SECRET_KEY_SIZE, COMPACT_SIGNATURE_SIZE}; use bitcoin::blockdata::script::Script; -use bitcoin::blockdata::transaction::{OutPoint, Transaction}; +use bitcoin::blockdata::transaction::{OutPoint, Transaction, TxOut}; use bitcoin::consensus; use bitcoin::consensus::Encodable; -use bitcoin_hashes::sha256d::Hash as Sha256dHash; -use std::marker::Sized; +use bitcoin::hashes::sha256d::Hash as Sha256dHash; +use bitcoin::hash_types::{Txid, BlockHash}; +use core::marker::Sized; use ln::msgs::DecodeError; -use ln::channelmanager::{PaymentPreimage, PaymentHash}; -use util::byte_utils; +use ln::{PaymentPreimage, PaymentHash, PaymentSecret}; -use util::byte_utils::{be64_to_array, be48_to_array, be32_to_array, be16_to_array, slice_to_be16, slice_to_be32, slice_to_be48, slice_to_be64}; +use util::byte_utils::{be48_to_array, slice_to_be48}; -const MAX_BUF_SIZE: usize = 64 * 1024; +/// serialization buffer size +pub const MAX_BUF_SIZE: usize = 64 * 1024; /// A trait that is similar to std::io::Write but has one extra function which can be used to size /// buffers being written into. /// An impl is provided for any type that also impls std::io::Write which simply ignores size /// hints. +/// +/// (C-not exported) as we only export serialization to/from byte arrays instead pub trait Writer { /// Writes the given buf out. See std::io::Write::write_all for more fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error>; @@ -47,13 +59,16 @@ impl Writer for W { pub(crate) struct WriterWriteAdaptor<'a, W: Writer + 'a>(pub &'a mut W); impl<'a, W: Writer + 'a> Write for WriterWriteAdaptor<'a, W> { + #[inline] fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> { self.0.write_all(buf) } + #[inline] fn write(&mut self, buf: &[u8]) -> Result { self.0.write_all(buf)?; Ok(buf.len()) } + #[inline] fn flush(&mut self) -> Result<(), ::std::io::Error> { Ok(()) } @@ -61,10 +76,12 @@ impl<'a, W: Writer + 'a> Write for WriterWriteAdaptor<'a, W> { pub(crate) struct VecWriter(pub Vec); impl Writer for VecWriter { + #[inline] fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> { self.0.extend_from_slice(buf); Ok(()) } + #[inline] fn size_hint(&mut self, size: usize) { self.0.reserve_exact(size); } @@ -95,10 +112,12 @@ impl FixedLengthReader { Self { read, bytes_read: 0, total_bytes } } + #[inline] pub fn bytes_remain(&mut self) -> bool { self.bytes_read != self.total_bytes } + #[inline] pub fn eat_remaining(&mut self) -> Result<(), DecodeError> { ::std::io::copy(self, &mut ::std::io::sink()).unwrap(); if self.bytes_read != self.total_bytes { @@ -109,6 +128,7 @@ impl FixedLengthReader { } } impl Read for FixedLengthReader { + #[inline] fn read(&mut self, dest: &mut [u8]) -> Result { if self.total_bytes == self.bytes_read { Ok(0) @@ -137,6 +157,7 @@ impl ReadTrackingReader { } } impl Read for ReadTrackingReader { + #[inline] fn read(&mut self, dest: &mut [u8]) -> Result { match self.read.read(dest) { Ok(0) => Ok(0), @@ -150,6 +171,8 @@ impl Read for ReadTrackingReader { } /// A trait that various rust-lightning types implement allowing them to be written out to a Writer +/// +/// (C-not exported) as we only export serialization to/from byte arrays instead pub trait Writeable { /// Writes self out to the given Writer fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error>; @@ -167,28 +190,94 @@ pub trait Writeable { 0u16.write(&mut msg).unwrap(); self.write(&mut msg).unwrap(); let len = msg.0.len(); - msg.0[..2].copy_from_slice(&byte_utils::be16_to_array(len as u16 - 2)); + msg.0[..2].copy_from_slice(&(len as u16 - 2).to_be_bytes()); msg.0 } + + /// Gets the length of this object after it has been serialized. This can be overridden to + /// optimize cases where we prepend an object with its length. + // Note that LLVM optimizes this away in most cases! Check that it isn't before you override! + #[inline] + fn serialized_length(&self) -> usize { + let mut len_calc = LengthCalculatingWriter(0); + self.write(&mut len_calc).expect("No in-memory data may fail to serialize"); + len_calc.0 + } +} + +impl<'a, T: Writeable> Writeable for &'a T { + fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { (*self).write(writer) } } /// A trait that various rust-lightning types implement allowing them to be read in from a Read -pub trait Readable - where Self: Sized, - R: Read +/// +/// (C-not exported) as we only export serialization to/from byte arrays instead +pub trait Readable + where Self: Sized { /// Reads a Self in from the given Read - fn read(reader: &mut R) -> Result; + fn read(reader: &mut R) -> Result; } /// A trait that various higher-level rust-lightning types implement allowing them to be read in /// from a Read given some additional set of arguments which is required to deserialize. -pub trait ReadableArgs - where Self: Sized, - R: Read +/// +/// (C-not exported) as we only export serialization to/from byte arrays instead +pub trait ReadableArgs

+ where Self: Sized { /// Reads a Self in from the given Read - fn read(reader: &mut R, params: P) -> Result; + fn read(reader: &mut R, params: P) -> Result; +} + +/// A trait that various rust-lightning types implement allowing them to (maybe) be read in from a Read +/// +/// (C-not exported) as we only export serialization to/from byte arrays instead +pub trait MaybeReadable + where Self: Sized +{ + /// Reads a Self in from the given Read + fn read(reader: &mut R) -> Result, DecodeError>; +} + +pub(crate) struct OptionDeserWrapper(pub Option); +impl Readable for OptionDeserWrapper { + #[inline] + fn read(reader: &mut R) -> Result { + Ok(Self(Some(Readable::read(reader)?))) + } +} + +/// Wrapper to write each element of a Vec with no length prefix +pub(crate) struct VecWriteWrapper<'a, T: Writeable>(pub &'a Vec); +impl<'a, T: Writeable> Writeable for VecWriteWrapper<'a, T> { + #[inline] + fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { + 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(pub Vec); +impl Readable for VecReadWrapper { + #[inline] + fn read(mut reader: &mut R) -> Result { + 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), + } + } + Ok(Self(values)) + } } pub(crate) struct U48(pub u64); @@ -198,9 +287,9 @@ impl Writeable for U48 { writer.write_all(&be48_to_array(self.0)) } } -impl Readable for U48 { +impl Readable for U48 { #[inline] - fn read(reader: &mut R) -> Result { + fn read(reader: &mut R) -> Result { let mut buf = [0; 6]; reader.read_exact(&mut buf)?; Ok(U48(slice_to_be48(&buf))) @@ -237,9 +326,9 @@ impl Writeable for BigSize { } } } -impl Readable for BigSize { +impl Readable for BigSize { #[inline] - fn read(reader: &mut R) -> Result { + fn read(reader: &mut R) -> Result { let n: u8 = Readable::read(reader)?; match n { 0xFF => { @@ -278,31 +367,31 @@ impl Readable for BigSize { pub(crate) struct HighZeroBytesDroppedVarInt(pub T); macro_rules! impl_writeable_primitive { - ($val_type:ty, $meth_write:ident, $len: expr, $meth_read:ident) => { + ($val_type:ty, $len: expr) => { impl Writeable for $val_type { #[inline] fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { - writer.write_all(&$meth_write(*self)) + writer.write_all(&self.to_be_bytes()) } } impl Writeable for HighZeroBytesDroppedVarInt<$val_type> { #[inline] fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { // Skip any full leading 0 bytes when writing (in BE): - writer.write_all(&$meth_write(self.0)[(self.0.leading_zeros()/8) as usize..$len]) + writer.write_all(&self.0.to_be_bytes()[(self.0.leading_zeros()/8) as usize..$len]) } } - impl Readable for $val_type { + impl Readable for $val_type { #[inline] - fn read(reader: &mut R) -> Result<$val_type, DecodeError> { + fn read(reader: &mut R) -> Result<$val_type, DecodeError> { let mut buf = [0; $len]; reader.read_exact(&mut buf)?; - Ok($meth_read(&buf)) + Ok(<$val_type>::from_be_bytes(buf)) } } - impl Readable for HighZeroBytesDroppedVarInt<$val_type> { + impl Readable for HighZeroBytesDroppedVarInt<$val_type> { #[inline] - fn read(reader: &mut R) -> Result, DecodeError> { + fn read(reader: &mut R) -> Result, DecodeError> { // We need to accept short reads (read_len == 0) as "EOF" and handle them as simply // the high bytes being dropped. To do so, we start reading into the middle of buf // and then convert the appropriate number of bytes with extra high bytes out of @@ -316,7 +405,9 @@ macro_rules! impl_writeable_primitive { } if total_read_len == 0 || buf[$len] != 0 { let first_byte = $len - ($len - total_read_len); - Ok(HighZeroBytesDroppedVarInt($meth_read(&buf[first_byte..first_byte + $len]))) + let mut bytes = [0; $len]; + bytes.copy_from_slice(&buf[first_byte..first_byte + $len]); + Ok(HighZeroBytesDroppedVarInt(<$val_type>::from_be_bytes(bytes))) } else { // If the encoding had extra zero bytes, return a failure even though we know // what they meant (as the TLV test vectors require this) @@ -327,9 +418,9 @@ macro_rules! impl_writeable_primitive { } } -impl_writeable_primitive!(u64, be64_to_array, 8, slice_to_be64); -impl_writeable_primitive!(u32, be32_to_array, 4, slice_to_be32); -impl_writeable_primitive!(u16, be16_to_array, 2, slice_to_be16); +impl_writeable_primitive!(u64, 8); +impl_writeable_primitive!(u32, 4); +impl_writeable_primitive!(u16, 2); impl Writeable for u8 { #[inline] @@ -337,9 +428,9 @@ impl Writeable for u8 { writer.write_all(&[*self]) } } -impl Readable for u8 { +impl Readable for u8 { #[inline] - fn read(reader: &mut R) -> Result { + fn read(reader: &mut R) -> Result { let mut buf = [0; 1]; reader.read_exact(&mut buf)?; Ok(buf[0]) @@ -352,9 +443,9 @@ impl Writeable for bool { writer.write_all(&[if *self {1} else {0}]) } } -impl Readable for bool { +impl Readable for bool { #[inline] - fn read(reader: &mut R) -> Result { + fn read(reader: &mut R) -> Result { let mut buf = [0; 1]; reader.read_exact(&mut buf)?; if buf[0] != 0 && buf[0] != 1 { @@ -375,10 +466,10 @@ macro_rules! impl_array { } } - impl Readable for [u8; $size] + impl Readable for [u8; $size] { #[inline] - fn read(r: &mut R) -> Result { + fn read(r: &mut R) -> Result { let mut buf = [0u8; $size]; r.read_exact(&mut buf)?; Ok(buf) @@ -393,8 +484,8 @@ impl_array!(4); // for IPv4 impl_array!(10); // for OnionV2 impl_array!(16); // for IPv6 impl_array!(32); // for channel id & hmac -impl_array!(33); // for PublicKey -impl_array!(64); // for Signature +impl_array!(PUBLIC_KEY_SIZE); // for PublicKey +impl_array!(COMPACT_SIGNATURE_SIZE); // for Signature impl_array!(1300); // for OnionPacket.hop_data // HashMap @@ -413,13 +504,12 @@ impl Writeable for HashMap } } -impl Readable for HashMap - where R: Read, - K: Readable + Eq + Hash, - V: Readable +impl Readable for HashMap + where K: Readable + Eq + Hash, + V: Readable { #[inline] - fn read(r: &mut R) -> Result { + fn read(r: &mut R) -> Result { let len: u16 = Readable::read(r)?; let mut ret = HashMap::with_capacity(len as usize); for _ in 0..len { @@ -438,9 +528,9 @@ impl Writeable for Vec { } } -impl Readable for Vec { +impl Readable for Vec { #[inline] - fn read(r: &mut R) -> Result { + fn read(r: &mut R) -> Result { let len: u16 = Readable::read(r)?; let mut ret = Vec::with_capacity(len as usize); ret.resize(len as usize, 0); @@ -459,12 +549,12 @@ impl Writeable for Vec { } } -impl Readable for Vec { +impl Readable for Vec { #[inline] - fn read(r: &mut R) -> Result { + fn read(r: &mut R) -> Result { let len: u16 = Readable::read(r)?; let byte_size = (len as usize) - .checked_mul(33) + .checked_mul(COMPACT_SIGNATURE_SIZE) .ok_or(DecodeError::BadLengthDescriptor)?; if byte_size > MAX_BUF_SIZE { return Err(DecodeError::BadLengthDescriptor); @@ -482,9 +572,9 @@ impl Writeable for Script { } } -impl Readable for Script { - fn read(r: &mut R) -> Result { - let len = >::read(r)? as usize; +impl Readable for Script { + fn read(r: &mut R) -> Result { + let len = ::read(r)? as usize; let mut buf = vec![0; len]; r.read_exact(&mut buf)?; Ok(Script::from(buf)) @@ -495,11 +585,15 @@ impl Writeable for PublicKey { fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { self.serialize().write(w) } + #[inline] + fn serialized_length(&self) -> usize { + PUBLIC_KEY_SIZE + } } -impl Readable for PublicKey { - fn read(r: &mut R) -> Result { - let buf: [u8; 33] = Readable::read(r)?; +impl Readable for PublicKey { + fn read(r: &mut R) -> Result { + let buf: [u8; PUBLIC_KEY_SIZE] = Readable::read(r)?; match PublicKey::from_slice(&buf) { Ok(key) => Ok(key), Err(_) => return Err(DecodeError::InvalidValue), @@ -509,15 +603,19 @@ impl Readable for PublicKey { impl Writeable for SecretKey { fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { - let mut ser = [0; 32]; + let mut ser = [0; SECRET_KEY_SIZE]; ser.copy_from_slice(&self[..]); ser.write(w) } + #[inline] + fn serialized_length(&self) -> usize { + SECRET_KEY_SIZE + } } -impl Readable for SecretKey { - fn read(r: &mut R) -> Result { - let buf: [u8; 32] = Readable::read(r)?; +impl Readable for SecretKey { + fn read(r: &mut R) -> Result { + let buf: [u8; SECRET_KEY_SIZE] = Readable::read(r)?; match SecretKey::from_slice(&buf) { Ok(key) => Ok(key), Err(_) => return Err(DecodeError::InvalidValue), @@ -531,9 +629,9 @@ impl Writeable for Sha256dHash { } } -impl Readable for Sha256dHash { - fn read(r: &mut R) -> Result { - use bitcoin_hashes::Hash; +impl Readable for Sha256dHash { + fn read(r: &mut R) -> Result { + use bitcoin::hashes::Hash; let buf: [u8; 32] = Readable::read(r)?; Ok(Sha256dHash::from_slice(&buf[..]).unwrap()) @@ -544,11 +642,15 @@ impl Writeable for Signature { fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { self.serialize_compact().write(w) } + #[inline] + fn serialized_length(&self) -> usize { + COMPACT_SIGNATURE_SIZE + } } -impl Readable for Signature { - fn read(r: &mut R) -> Result { - let buf: [u8; 64] = Readable::read(r)?; +impl Readable for Signature { + fn read(r: &mut R) -> Result { + let buf: [u8; COMPACT_SIGNATURE_SIZE] = Readable::read(r)?; match Signature::from_compact(&buf) { Ok(sig) => Ok(sig), Err(_) => return Err(DecodeError::InvalidValue), @@ -562,8 +664,8 @@ impl Writeable for PaymentPreimage { } } -impl Readable for PaymentPreimage { - fn read(r: &mut R) -> Result { +impl Readable for PaymentPreimage { + fn read(r: &mut R) -> Result { let buf: [u8; 32] = Readable::read(r)?; Ok(PaymentPreimage(buf)) } @@ -575,19 +677,44 @@ impl Writeable for PaymentHash { } } -impl Readable for PaymentHash { - fn read(r: &mut R) -> Result { +impl Readable for PaymentHash { + fn read(r: &mut R) -> Result { let buf: [u8; 32] = Readable::read(r)?; Ok(PaymentHash(buf)) } } +impl Writeable for PaymentSecret { + fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { + self.0.write(w) + } +} + +impl Readable for PaymentSecret { + fn read(r: &mut R) -> Result { + let buf: [u8; 32] = Readable::read(r)?; + Ok(PaymentSecret(buf)) + } +} + +impl Writeable for Box { + fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { + T::write(&**self, w) + } +} + +impl Readable for Box { + fn read(r: &mut R) -> Result { + Ok(Box::new(Readable::read(r)?)) + } +} + impl Writeable for Option { fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { match *self { None => 0u8.write(w)?, Some(ref data) => { - 1u8.write(w)?; + BigSize(data.serialized_length() as u64 + 1).write(w)?; data.write(w)?; } } @@ -595,19 +722,49 @@ impl Writeable for Option { } } -impl Readable for Option - where R: Read, - T: Readable +impl Readable for Option { - fn read(r: &mut R) -> Result { - match >::read(r)? { + fn read(r: &mut R) -> Result { + match BigSize::read(r)?.0 { 0 => Ok(None), - 1 => Ok(Some(Readable::read(r)?)), - _ => return Err(DecodeError::InvalidValue), + len => { + let mut reader = FixedLengthReader::new(r, len - 1); + Ok(Some(Readable::read(&mut reader)?)) + } } } } +impl Writeable for Txid { + fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { + w.write_all(&self[..]) + } +} + +impl Readable for Txid { + fn read(r: &mut R) -> Result { + use bitcoin::hashes::Hash; + + let buf: [u8; 32] = Readable::read(r)?; + Ok(Txid::from_slice(&buf[..]).unwrap()) + } +} + +impl Writeable for BlockHash { + fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { + w.write_all(&self[..]) + } +} + +impl Readable for BlockHash { + fn read(r: &mut R) -> Result { + use bitcoin::hashes::Hash; + + let buf: [u8; 32] = Readable::read(r)?; + Ok(BlockHash::from_slice(&buf[..]).unwrap()) + } +} + impl Writeable for OutPoint { fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { self.txid.write(w)?; @@ -616,8 +773,8 @@ impl Writeable for OutPoint { } } -impl Readable for OutPoint { - fn read(r: &mut R) -> Result { +impl Readable for OutPoint { + fn read(r: &mut R) -> Result { let txid = Readable::read(r)?; let vout = Readable::read(r)?; Ok(OutPoint { @@ -627,29 +784,34 @@ impl Readable for OutPoint { } } -impl Writeable for Transaction { - fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { - match self.consensus_encode(WriterWriteAdaptor(writer)) { - Ok(_) => Ok(()), - Err(consensus::encode::Error::Io(e)) => Err(e), - Err(_) => panic!("We shouldn't get a consensus::encode::Error unless our Write generated an std::io::Error"), +macro_rules! impl_consensus_ser { + ($bitcoin_type: ty) => { + impl Writeable for $bitcoin_type { + fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { + match self.consensus_encode(WriterWriteAdaptor(writer)) { + Ok(_) => Ok(()), + Err(e) => Err(e), + } + } } - } -} -impl Readable for Transaction { - fn read(r: &mut R) -> Result { - match consensus::encode::Decodable::consensus_decode(r) { - Ok(t) => Ok(t), - Err(consensus::encode::Error::Io(ref e)) if e.kind() == ::std::io::ErrorKind::UnexpectedEof => Err(DecodeError::ShortRead), - Err(consensus::encode::Error::Io(e)) => Err(DecodeError::Io(e)), - Err(_) => Err(DecodeError::InvalidValue), + impl Readable for $bitcoin_type { + fn read(r: &mut R) -> Result { + match consensus::encode::Decodable::consensus_decode(r) { + Ok(t) => Ok(t), + Err(consensus::encode::Error::Io(ref e)) if e.kind() == ::std::io::ErrorKind::UnexpectedEof => Err(DecodeError::ShortRead), + Err(consensus::encode::Error::Io(e)) => Err(DecodeError::Io(e.kind())), + Err(_) => Err(DecodeError::InvalidValue), + } + } } } } +impl_consensus_ser!(Transaction); +impl_consensus_ser!(TxOut); -impl> Readable for Mutex { - fn read(r: &mut R) -> Result { +impl Readable for Mutex { + fn read(r: &mut R) -> Result { let t: T = Readable::read(r)?; Ok(Mutex::new(t)) } @@ -660,8 +822,8 @@ impl Writeable for Mutex { } } -impl, B: Readable> Readable for (A, B) { - fn read(r: &mut R) -> Result { +impl Readable for (A, B) { + fn read(r: &mut R) -> Result { let a: A = Readable::read(r)?; let b: B = Readable::read(r)?; Ok((a, b)) @@ -673,3 +835,19 @@ impl Writeable for (A, B) { self.1.write(w) } } + +impl Readable for (A, B, C) { + fn read(r: &mut R) -> Result { + let a: A = Readable::read(r)?; + let b: B = Readable::read(r)?; + let c: C = Readable::read(r)?; + Ok((a, b, c)) + } +} +impl Writeable for (A, B, C) { + fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { + self.0.write(w)?; + self.1.write(w)?; + self.2.write(w) + } +}