_ Git - rust-lightning/blob - lightning/src/util/ser.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! A very simple serialization framework which is used to serialize/deserialize messages as well
  11 //! as ChannelsManagers and ChannelMonitors.
  12
  13 use prelude::*;
  14 use io::{self, Read, Write};
  15 use io_extras::{copy, sink};
  16 use core::hash::Hash;
  17 use sync::Mutex;
  18 use core::cmp;
  19 use core::convert::TryFrom;
  20 use core::ops::Deref;
  21
  22 use bitcoin::secp256k1::{PublicKey, SecretKey};
  23 use bitcoin::secp256k1::constants::{PUBLIC_KEY_SIZE, SECRET_KEY_SIZE, COMPACT_SIGNATURE_SIZE};
  24 use bitcoin::secp256k1::ecdsa::Signature;
  25 use bitcoin::blockdata::script::Script;
  26 use bitcoin::blockdata::transaction::{OutPoint, Transaction, TxOut};
  27 use bitcoin::consensus;
  28 use bitcoin::consensus::Encodable;
  29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  30 use bitcoin::hash_types::{Txid, BlockHash};
  31 use core::marker::Sized;
  32 use core::time::Duration;
  33 use ln::msgs::DecodeError;
  34 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  35
  36 use util::byte_utils::{be48_to_array, slice_to_be48};
  37
  38 /// serialization buffer size
  39 pub const MAX_BUF_SIZE: usize = 64 * 1024;
  40
  41 /// A simplified version of std::io::Write that exists largely for backwards compatibility.
  42 /// An impl is provided for any type that also impls std::io::Write.
  43 ///
  44 /// (C-not exported) as we only export serialization to/from byte arrays instead
  45 pub trait Writer {
  46         /// Writes the given buf out. See std::io::Write::write_all for more
  47         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error>;
  48 }
  49
  50 impl<W: Write> Writer for W {
  51         #[inline]
  52         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  53                 <Self as io::Write>::write_all(self, buf)
  54         }
  55 }
  56
  57 pub(crate) struct WriterWriteAdaptor<'a, W: Writer + 'a>(pub &'a mut W);
  58 impl<'a, W: Writer + 'a> Write for WriterWriteAdaptor<'a, W> {
  59         #[inline]
  60         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  61                 self.0.write_all(buf)
  62         }
  63         #[inline]
  64         fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
  65                 self.0.write_all(buf)?;
  66                 Ok(buf.len())
  67         }
  68         #[inline]
  69         fn flush(&mut self) -> Result<(), io::Error> {
  70                 Ok(())
  71         }
  72 }
  73
  74 pub(crate) struct VecWriter(pub Vec<u8>);
  75 impl Writer for VecWriter {
  76         #[inline]
  77         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  78                 self.0.extend_from_slice(buf);
  79                 Ok(())
  80         }
  81 }
  82
  83 /// Writer that only tracks the amount of data written - useful if you need to calculate the length
  84 /// of some data when serialized but don't yet need the full data.
  85 pub(crate) struct LengthCalculatingWriter(pub usize);
  86 impl Writer for LengthCalculatingWriter {
  87         #[inline]
  88         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  89                 self.0 += buf.len();
  90                 Ok(())
  91         }
  92 }
  93
  94 /// Essentially std::io::Take but a bit simpler and with a method to walk the underlying stream
  95 /// forward to ensure we always consume exactly the fixed length specified.
  96 pub(crate) struct FixedLengthReader<R: Read> {
  97         read: R,
  98         bytes_read: u64,
  99         total_bytes: u64,
 100 }
 101 impl<R: Read> FixedLengthReader<R> {
 102         pub fn new(read: R, total_bytes: u64) -> Self {
 103                 Self { read, bytes_read: 0, total_bytes }
 104         }
 105
 106         #[inline]
 107         pub fn bytes_remain(&mut self) -> bool {
 108                 self.bytes_read != self.total_bytes
 109         }
 110
 111         #[inline]
 112         pub fn eat_remaining(&mut self) -> Result<(), DecodeError> {
 113                 copy(self, &mut sink()).unwrap();
 114                 if self.bytes_read != self.total_bytes {
 115                         Err(DecodeError::ShortRead)
 116                 } else {
 117                         Ok(())
 118                 }
 119         }
 120 }
 121 impl<R: Read> Read for FixedLengthReader<R> {
 122         #[inline]
 123         fn read(&mut self, dest: &mut [u8]) -> Result<usize, io::Error> {
 124                 if self.total_bytes == self.bytes_read {
 125                         Ok(0)
 126                 } else {
 127                         let read_len = cmp::min(dest.len() as u64, self.total_bytes - self.bytes_read);
 128                         match self.read.read(&mut dest[0..(read_len as usize)]) {
 129                                 Ok(v) => {
 130                                         self.bytes_read += v as u64;
 131                                         Ok(v)
 132                                 },
 133                                 Err(e) => Err(e),
 134                         }
 135                 }
 136         }
 137 }
 138
 139 impl<R: Read> LengthRead for FixedLengthReader<R> {
 140         #[inline]
 141         fn total_bytes(&self) -> u64 {
 142                 self.total_bytes
 143         }
 144 }
 145
 146 /// A Read which tracks whether any bytes have been read at all. This allows us to distinguish
 147 /// between "EOF reached before we started" and "EOF reached mid-read".
 148 pub(crate) struct ReadTrackingReader<R: Read> {
 149         read: R,
 150         pub have_read: bool,
 151 }
 152 impl<R: Read> ReadTrackingReader<R> {
 153         pub fn new(read: R) -> Self {
 154                 Self { read, have_read: false }
 155         }
 156 }
 157 impl<R: Read> Read for ReadTrackingReader<R> {
 158         #[inline]
 159         fn read(&mut self, dest: &mut [u8]) -> Result<usize, io::Error> {
 160                 match self.read.read(dest) {
 161                         Ok(0) => Ok(0),
 162                         Ok(len) => {
 163                                 self.have_read = true;
 164                                 Ok(len)
 165                         },
 166                         Err(e) => Err(e),
 167                 }
 168         }
 169 }
 170
 171 /// A trait that various rust-lightning types implement allowing them to be written out to a Writer
 172 ///
 173 /// (C-not exported) as we only export serialization to/from byte arrays instead
 174 pub trait Writeable {
 175         /// Writes self out to the given Writer
 176         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error>;
 177
 178         /// Writes self out to a Vec<u8>
 179         fn encode(&self) -> Vec<u8> {
 180                 let mut msg = VecWriter(Vec::new());
 181                 self.write(&mut msg).unwrap();
 182                 msg.0
 183         }
 184
 185         /// Writes self out to a Vec<u8>
 186         #[cfg(test)]
 187         fn encode_with_len(&self) -> Vec<u8> {
 188                 let mut msg = VecWriter(Vec::new());
 189                 0u16.write(&mut msg).unwrap();
 190                 self.write(&mut msg).unwrap();
 191                 let len = msg.0.len();
 192                 msg.0[..2].copy_from_slice(&(len as u16 - 2).to_be_bytes());
 193                 msg.0
 194         }
 195
 196         /// Gets the length of this object after it has been serialized. This can be overridden to
 197         /// optimize cases where we prepend an object with its length.
 198         // Note that LLVM optimizes this away in most cases! Check that it isn't before you override!
 199         #[inline]
 200         fn serialized_length(&self) -> usize {
 201                 let mut len_calc = LengthCalculatingWriter(0);
 202                 self.write(&mut len_calc).expect("No in-memory data may fail to serialize");
 203                 len_calc.0
 204         }
 205 }
 206
 207 impl<'a, T: Writeable> Writeable for &'a T {
 208         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> { (*self).write(writer) }
 209 }
 210
 211 /// A trait that various rust-lightning types implement allowing them to be read in from a Read
 212 ///
 213 /// (C-not exported) as we only export serialization to/from byte arrays instead
 214 pub trait Readable
 215         where Self: Sized
 216 {
 217         /// Reads a Self in from the given Read
 218         fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>;
 219 }
 220
 221 /// A trait that various higher-level rust-lightning types implement allowing them to be read in
 222 /// from a Read given some additional set of arguments which is required to deserialize.
 223 ///
 224 /// (C-not exported) as we only export serialization to/from byte arrays instead
 225 pub trait ReadableArgs<P>
 226         where Self: Sized
 227 {
 228         /// Reads a Self in from the given Read
 229         fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
 230 }
 231
 232 /// A std::io::Read that also provides the total bytes available to read.
 233 pub(crate) trait LengthRead: Read {
 234         /// The total number of bytes available to read.
 235         fn total_bytes(&self) -> u64;
 236 }
 237
 238 /// A trait that various higher-level rust-lightning types implement allowing them to be read in
 239 /// from a Read given some additional set of arguments which is required to deserialize, requiring
 240 /// the implementer to provide the total length of the read.
 241 pub(crate) trait LengthReadableArgs<P> where Self: Sized
 242 {
 243         /// Reads a Self in from the given LengthRead
 244         fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
 245 }
 246
 247 /// A trait that various higher-level rust-lightning types implement allowing them to be read in
 248 /// from a Read, requiring the implementer to provide the total length of the read.
 249 pub(crate) trait LengthReadable where Self: Sized
 250 {
 251         /// Reads a Self in from the given LengthRead
 252         fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
 253 }
 254
 255 /// A trait that various rust-lightning types implement allowing them to (maybe) be read in from a Read
 256 ///
 257 /// (C-not exported) as we only export serialization to/from byte arrays instead
 258 pub trait MaybeReadable
 259         where Self: Sized
 260 {
 261         /// Reads a Self in from the given Read
 262         fn read<R: Read>(reader: &mut R) -> Result<Option<Self>, DecodeError>;
 263 }
 264
 265 impl<T: Readable> MaybeReadable for T {
 266         #[inline]
 267         fn read<R: Read>(reader: &mut R) -> Result<Option<T>, DecodeError> {
 268                 Ok(Some(Readable::read(reader)?))
 269         }
 270 }
 271
 272 pub(crate) struct OptionDeserWrapper<T: Readable>(pub Option<T>);
 273 impl<T: Readable> Readable for OptionDeserWrapper<T> {
 274         #[inline]
 275         fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
 276                 Ok(Self(Some(Readable::read(reader)?)))
 277         }
 278 }
 279 /// When handling default_values, we want to map the default-value T directly
 280 /// to a OptionDeserWrapper<T> in a way that works for `field: T = t;` as
 281 /// well. Thus, we assume `Into<T> for T` does nothing and use that.
 282 impl<T: Readable> From<T> for OptionDeserWrapper<T> {
 283         fn from(t: T) -> OptionDeserWrapper<T> { OptionDeserWrapper(Some(t)) }
 284 }
 285
 286 /// Wrapper to write each element of a Vec with no length prefix
 287 pub(crate) struct VecWriteWrapper<'a, T: Writeable>(pub &'a Vec<T>);
 288 impl<'a, T: Writeable> Writeable for VecWriteWrapper<'a, T> {
 289         #[inline]
 290         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 291                 for ref v in self.0.iter() {
 292                         v.write(writer)?;
 293                 }
 294                 Ok(())
 295         }
 296 }
 297
 298 /// Wrapper to read elements from a given stream until it reaches the end of the stream.
 299 pub(crate) struct VecReadWrapper<T>(pub Vec<T>);
 300 impl<T: MaybeReadable> Readable for VecReadWrapper<T> {
 301         #[inline]
 302         fn read<R: Read>(mut reader: &mut R) -> Result<Self, DecodeError> {
 303                 let mut values = Vec::new();
 304                 loop {
 305                         let mut track_read = ReadTrackingReader::new(&mut reader);
 306                         match MaybeReadable::read(&mut track_read) {
 307                                 Ok(Some(v)) => { values.push(v); },
 308                                 Ok(None) => { },
 309                                 // If we failed to read any bytes at all, we reached the end of our TLV
 310                                 // stream and have simply exhausted all entries.
 311                                 Err(ref e) if e == &DecodeError::ShortRead && !track_read.have_read => break,
 312                                 Err(e) => return Err(e),
 313                         }
 314                 }
 315                 Ok(Self(values))
 316         }
 317 }
 318
 319 pub(crate) struct U48(pub u64);
 320 impl Writeable for U48 {
 321         #[inline]
 322         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 323                 writer.write_all(&be48_to_array(self.0))
 324         }
 325 }
 326 impl Readable for U48 {
 327         #[inline]
 328         fn read<R: Read>(reader: &mut R) -> Result<U48, DecodeError> {
 329                 let mut buf = [0; 6];
 330                 reader.read_exact(&mut buf)?;
 331                 Ok(U48(slice_to_be48(&buf)))
 332         }
 333 }
 334
 335 /// Lightning TLV uses a custom variable-length integer called BigSize. It is similar to Bitcoin's
 336 /// variable-length integers except that it is serialized in big-endian instead of little-endian.
 337 ///
 338 /// Like Bitcoin's variable-length integer, it exhibits ambiguity in that certain values can be
 339 /// encoded in several different ways, which we must check for at deserialization-time. Thus, if
 340 /// you're looking for an example of a variable-length integer to use for your own project, move
 341 /// along, this is a rather poor design.
 342 pub struct BigSize(pub u64);
 343 impl Writeable for BigSize {
 344         #[inline]
 345         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 346                 match self.0 {
 347                         0...0xFC => {
 348                                 (self.0 as u8).write(writer)
 349                         },
 350                         0xFD...0xFFFF => {
 351                                 0xFDu8.write(writer)?;
 352                                 (self.0 as u16).write(writer)
 353                         },
 354                         0x10000...0xFFFFFFFF => {
 355                                 0xFEu8.write(writer)?;
 356                                 (self.0 as u32).write(writer)
 357                         },
 358                         _ => {
 359                                 0xFFu8.write(writer)?;
 360                                 (self.0 as u64).write(writer)
 361                         },
 362                 }
 363         }
 364 }
 365 impl Readable for BigSize {
 366         #[inline]
 367         fn read<R: Read>(reader: &mut R) -> Result<BigSize, DecodeError> {
 368                 let n: u8 = Readable::read(reader)?;
 369                 match n {
 370                         0xFF => {
 371                                 let x: u64 = Readable::read(reader)?;
 372                                 if x < 0x100000000 {
 373                                         Err(DecodeError::InvalidValue)
 374                                 } else {
 375                                         Ok(BigSize(x))
 376                                 }
 377                         }
 378                         0xFE => {
 379                                 let x: u32 = Readable::read(reader)?;
 380                                 if x < 0x10000 {
 381                                         Err(DecodeError::InvalidValue)
 382                                 } else {
 383                                         Ok(BigSize(x as u64))
 384                                 }
 385                         }
 386                         0xFD => {
 387                                 let x: u16 = Readable::read(reader)?;
 388                                 if x < 0xFD {
 389                                         Err(DecodeError::InvalidValue)
 390                                 } else {
 391                                         Ok(BigSize(x as u64))
 392                                 }
 393                         }
 394                         n => Ok(BigSize(n as u64))
 395                 }
 396         }
 397 }
 398
 399 /// In TLV we occasionally send fields which only consist of, or potentially end with, a
 400 /// variable-length integer which is simply truncated by skipping high zero bytes. This type
 401 /// encapsulates such integers implementing Readable/Writeable for them.
 402 #[cfg_attr(test, derive(PartialEq, Debug))]
 403 pub(crate) struct HighZeroBytesDroppedBigSize<T>(pub T);
 404
 405 macro_rules! impl_writeable_primitive {
 406         ($val_type:ty, $len: expr) => {
 407                 impl Writeable for $val_type {
 408                         #[inline]
 409                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 410                                 writer.write_all(&self.to_be_bytes())
 411                         }
 412                 }
 413                 impl Writeable for HighZeroBytesDroppedBigSize<$val_type> {
 414                         #[inline]
 415                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 416                                 // Skip any full leading 0 bytes when writing (in BE):
 417                                 writer.write_all(&self.0.to_be_bytes()[(self.0.leading_zeros()/8) as usize..$len])
 418                         }
 419                 }
 420                 impl Readable for $val_type {
 421                         #[inline]
 422                         fn read<R: Read>(reader: &mut R) -> Result<$val_type, DecodeError> {
 423                                 let mut buf = [0; $len];
 424                                 reader.read_exact(&mut buf)?;
 425                                 Ok(<$val_type>::from_be_bytes(buf))
 426                         }
 427                 }
 428                 impl Readable for HighZeroBytesDroppedBigSize<$val_type> {
 429                         #[inline]
 430                         fn read<R: Read>(reader: &mut R) -> Result<HighZeroBytesDroppedBigSize<$val_type>, DecodeError> {
 431                                 // We need to accept short reads (read_len == 0) as "EOF" and handle them as simply
 432                                 // the high bytes being dropped. To do so, we start reading into the middle of buf
 433                                 // and then convert the appropriate number of bytes with extra high bytes out of
 434                                 // buf.
 435                                 let mut buf = [0; $len*2];
 436                                 let mut read_len = reader.read(&mut buf[$len..])?;
 437                                 let mut total_read_len = read_len;
 438                                 while read_len != 0 && total_read_len != $len {
 439                                         read_len = reader.read(&mut buf[($len + total_read_len)..])?;
 440                                         total_read_len += read_len;
 441                                 }
 442                                 if total_read_len == 0 || buf[$len] != 0 {
 443                                         let first_byte = $len - ($len - total_read_len);
 444                                         let mut bytes = [0; $len];
 445                                         bytes.copy_from_slice(&buf[first_byte..first_byte + $len]);
 446                                         Ok(HighZeroBytesDroppedBigSize(<$val_type>::from_be_bytes(bytes)))
 447                                 } else {
 448                                         // If the encoding had extra zero bytes, return a failure even though we know
 449                                         // what they meant (as the TLV test vectors require this)
 450                                         Err(DecodeError::InvalidValue)
 451                                 }
 452                         }
 453                 }
 454         }
 455 }
 456
 457 impl_writeable_primitive!(u64, 8);
 458 impl_writeable_primitive!(u32, 4);
 459 impl_writeable_primitive!(u16, 2);
 460
 461 impl Writeable for u8 {
 462         #[inline]
 463         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 464                 writer.write_all(&[*self])
 465         }
 466 }
 467 impl Readable for u8 {
 468         #[inline]
 469         fn read<R: Read>(reader: &mut R) -> Result<u8, DecodeError> {
 470                 let mut buf = [0; 1];
 471                 reader.read_exact(&mut buf)?;
 472                 Ok(buf[0])
 473         }
 474 }
 475
 476 impl Writeable for bool {
 477         #[inline]
 478         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 479                 writer.write_all(&[if *self {1} else {0}])
 480         }
 481 }
 482 impl Readable for bool {
 483         #[inline]
 484         fn read<R: Read>(reader: &mut R) -> Result<bool, DecodeError> {
 485                 let mut buf = [0; 1];
 486                 reader.read_exact(&mut buf)?;
 487                 if buf[0] != 0 && buf[0] != 1 {
 488                         return Err(DecodeError::InvalidValue);
 489                 }
 490                 Ok(buf[0] == 1)
 491         }
 492 }
 493
 494 // u8 arrays
 495 macro_rules! impl_array {
 496         ( $size:expr ) => (
 497                 impl Writeable for [u8; $size]
 498                 {
 499                         #[inline]
 500                         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 501                                 w.write_all(self)
 502                         }
 503                 }
 504
 505                 impl Readable for [u8; $size]
 506                 {
 507                         #[inline]
 508                         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 509                                 let mut buf = [0u8; $size];
 510                                 r.read_exact(&mut buf)?;
 511                                 Ok(buf)
 512                         }
 513                 }
 514         );
 515 }
 516
 517 impl_array!(3); // for rgb
 518 impl_array!(4); // for IPv4
 519 impl_array!(12); // for OnionV2
 520 impl_array!(16); // for IPv6
 521 impl_array!(32); // for channel id & hmac
 522 impl_array!(PUBLIC_KEY_SIZE); // for PublicKey
 523 impl_array!(COMPACT_SIGNATURE_SIZE); // for Signature
 524 impl_array!(1300); // for OnionPacket.hop_data
 525
 526 impl Writeable for [u16; 8] {
 527         #[inline]
 528         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 529                 for v in self.iter() {
 530                         w.write_all(&v.to_be_bytes())?
 531                 }
 532                 Ok(())
 533         }
 534 }
 535
 536 impl Readable for [u16; 8] {
 537         #[inline]
 538         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 539                 let mut buf = [0u8; 16];
 540                 r.read_exact(&mut buf)?;
 541                 let mut res = [0u16; 8];
 542                 for (idx, v) in res.iter_mut().enumerate() {
 543                         *v = (buf[idx] as u16) << 8 | (buf[idx + 1] as u16)
 544                 }
 545                 Ok(res)
 546         }
 547 }
 548
 549 // HashMap
 550 impl<K, V> Writeable for HashMap<K, V>
 551         where K: Writeable + Eq + Hash,
 552               V: Writeable
 553 {
 554         #[inline]
 555         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 556         (self.len() as u16).write(w)?;
 557                 for (key, value) in self.iter() {
 558                         key.write(w)?;
 559                         value.write(w)?;
 560                 }
 561                 Ok(())
 562         }
 563 }
 564
 565 impl<K, V> Readable for HashMap<K, V>
 566         where K: Readable + Eq + Hash,
 567               V: MaybeReadable
 568 {
 569         #[inline]
 570         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 571                 let len: u16 = Readable::read(r)?;
 572                 let mut ret = HashMap::with_capacity(len as usize);
 573                 for _ in 0..len {
 574                         let k = K::read(r)?;
 575                         let v_opt = V::read(r)?;
 576                         if let Some(v) = v_opt {
 577                                 if ret.insert(k, v).is_some() {
 578                                         return Err(DecodeError::InvalidValue);
 579                                 }
 580                         }
 581                 }
 582                 Ok(ret)
 583         }
 584 }
 585
 586 // HashSet
 587 impl<T> Writeable for HashSet<T>
 588 where T: Writeable + Eq + Hash
 589 {
 590         #[inline]
 591         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 592                 (self.len() as u16).write(w)?;
 593                 for item in self.iter() {
 594                         item.write(w)?;
 595                 }
 596                 Ok(())
 597         }
 598 }
 599
 600 impl<T> Readable for HashSet<T>
 601 where T: Readable + Eq + Hash
 602 {
 603         #[inline]
 604         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 605                 let len: u16 = Readable::read(r)?;
 606                 let mut ret = HashSet::with_capacity(len as usize);
 607                 for _ in 0..len {
 608                         if !ret.insert(T::read(r)?) {
 609                                 return Err(DecodeError::InvalidValue)
 610                         }
 611                 }
 612                 Ok(ret)
 613         }
 614 }
 615
 616 // Vectors
 617 impl Writeable for Vec<u8> {
 618         #[inline]
 619         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 620                 (self.len() as u16).write(w)?;
 621                 w.write_all(&self)
 622         }
 623 }
 624
 625 impl Readable for Vec<u8> {
 626         #[inline]
 627         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 628                 let len: u16 = Readable::read(r)?;
 629                 let mut ret = Vec::with_capacity(len as usize);
 630                 ret.resize(len as usize, 0);
 631                 r.read_exact(&mut ret)?;
 632                 Ok(ret)
 633         }
 634 }
 635 impl Writeable for Vec<Signature> {
 636         #[inline]
 637         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 638                 (self.len() as u16).write(w)?;
 639                 for e in self.iter() {
 640                         e.write(w)?;
 641                 }
 642                 Ok(())
 643         }
 644 }
 645
 646 impl Readable for Vec<Signature> {
 647         #[inline]
 648         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 649                 let len: u16 = Readable::read(r)?;
 650                 let byte_size = (len as usize)
 651                                 .checked_mul(COMPACT_SIGNATURE_SIZE)
 652                                 .ok_or(DecodeError::BadLengthDescriptor)?;
 653                 if byte_size > MAX_BUF_SIZE {
 654                         return Err(DecodeError::BadLengthDescriptor);
 655                 }
 656                 let mut ret = Vec::with_capacity(len as usize);
 657                 for _ in 0..len { ret.push(Readable::read(r)?); }
 658                 Ok(ret)
 659         }
 660 }
 661
 662 impl Writeable for Script {
 663         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 664                 (self.len() as u16).write(w)?;
 665                 w.write_all(self.as_bytes())
 666         }
 667 }
 668
 669 impl Readable for Script {
 670         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 671                 let len = <u16 as Readable>::read(r)? as usize;
 672                 let mut buf = vec![0; len];
 673                 r.read_exact(&mut buf)?;
 674                 Ok(Script::from(buf))
 675         }
 676 }
 677
 678 impl Writeable for PublicKey {
 679         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 680                 self.serialize().write(w)
 681         }
 682         #[inline]
 683         fn serialized_length(&self) -> usize {
 684                 PUBLIC_KEY_SIZE
 685         }
 686 }
 687
 688 impl Readable for PublicKey {
 689         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 690                 let buf: [u8; PUBLIC_KEY_SIZE] = Readable::read(r)?;
 691                 match PublicKey::from_slice(&buf) {
 692                         Ok(key) => Ok(key),
 693                         Err(_) => return Err(DecodeError::InvalidValue),
 694                 }
 695         }
 696 }
 697
 698 impl Writeable for SecretKey {
 699         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 700                 let mut ser = [0; SECRET_KEY_SIZE];
 701                 ser.copy_from_slice(&self[..]);
 702                 ser.write(w)
 703         }
 704         #[inline]
 705         fn serialized_length(&self) -> usize {
 706                 SECRET_KEY_SIZE
 707         }
 708 }
 709
 710 impl Readable for SecretKey {
 711         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 712                 let buf: [u8; SECRET_KEY_SIZE] = Readable::read(r)?;
 713                 match SecretKey::from_slice(&buf) {
 714                         Ok(key) => Ok(key),
 715                         Err(_) => return Err(DecodeError::InvalidValue),
 716                 }
 717         }
 718 }
 719
 720 impl Writeable for Sha256dHash {
 721         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 722                 w.write_all(&self[..])
 723         }
 724 }
 725
 726 impl Readable for Sha256dHash {
 727         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 728                 use bitcoin::hashes::Hash;
 729
 730                 let buf: [u8; 32] = Readable::read(r)?;
 731                 Ok(Sha256dHash::from_slice(&buf[..]).unwrap())
 732         }
 733 }
 734
 735 impl Writeable for Signature {
 736         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 737                 self.serialize_compact().write(w)
 738         }
 739         #[inline]
 740         fn serialized_length(&self) -> usize {
 741                 COMPACT_SIGNATURE_SIZE
 742         }
 743 }
 744
 745 impl Readable for Signature {
 746         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 747                 let buf: [u8; COMPACT_SIGNATURE_SIZE] = Readable::read(r)?;
 748                 match Signature::from_compact(&buf) {
 749                         Ok(sig) => Ok(sig),
 750                         Err(_) => return Err(DecodeError::InvalidValue),
 751                 }
 752         }
 753 }
 754
 755 impl Writeable for PaymentPreimage {
 756         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 757                 self.0.write(w)
 758         }
 759 }
 760
 761 impl Readable for PaymentPreimage {
 762         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 763                 let buf: [u8; 32] = Readable::read(r)?;
 764                 Ok(PaymentPreimage(buf))
 765         }
 766 }
 767
 768 impl Writeable for PaymentHash {
 769         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 770                 self.0.write(w)
 771         }
 772 }
 773
 774 impl Readable for PaymentHash {
 775         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 776                 let buf: [u8; 32] = Readable::read(r)?;
 777                 Ok(PaymentHash(buf))
 778         }
 779 }
 780
 781 impl Writeable for PaymentSecret {
 782         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 783                 self.0.write(w)
 784         }
 785 }
 786
 787 impl Readable for PaymentSecret {
 788         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 789                 let buf: [u8; 32] = Readable::read(r)?;
 790                 Ok(PaymentSecret(buf))
 791         }
 792 }
 793
 794 impl<T: Writeable> Writeable for Box<T> {
 795         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 796                 T::write(&**self, w)
 797         }
 798 }
 799
 800 impl<T: Readable> Readable for Box<T> {
 801         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 802                 Ok(Box::new(Readable::read(r)?))
 803         }
 804 }
 805
 806 impl<T: Writeable> Writeable for Option<T> {
 807         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 808                 match *self {
 809                         None => 0u8.write(w)?,
 810                         Some(ref data) => {
 811                                 BigSize(data.serialized_length() as u64 + 1).write(w)?;
 812                                 data.write(w)?;
 813                         }
 814                 }
 815                 Ok(())
 816         }
 817 }
 818
 819 impl<T: Readable> Readable for Option<T>
 820 {
 821         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 822                 let len: BigSize = Readable::read(r)?;
 823                 match len.0 {
 824                         0 => Ok(None),
 825                         len => {
 826                                 let mut reader = FixedLengthReader::new(r, len - 1);
 827                                 Ok(Some(Readable::read(&mut reader)?))
 828                         }
 829                 }
 830         }
 831 }
 832
 833 impl Writeable for Txid {
 834         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 835                 w.write_all(&self[..])
 836         }
 837 }
 838
 839 impl Readable for Txid {
 840         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 841                 use bitcoin::hashes::Hash;
 842
 843                 let buf: [u8; 32] = Readable::read(r)?;
 844                 Ok(Txid::from_slice(&buf[..]).unwrap())
 845         }
 846 }
 847
 848 impl Writeable for BlockHash {
 849         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 850                 w.write_all(&self[..])
 851         }
 852 }
 853
 854 impl Readable for BlockHash {
 855         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 856                 use bitcoin::hashes::Hash;
 857
 858                 let buf: [u8; 32] = Readable::read(r)?;
 859                 Ok(BlockHash::from_slice(&buf[..]).unwrap())
 860         }
 861 }
 862
 863 impl Writeable for OutPoint {
 864         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 865                 self.txid.write(w)?;
 866                 self.vout.write(w)?;
 867                 Ok(())
 868         }
 869 }
 870
 871 impl Readable for OutPoint {
 872         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 873                 let txid = Readable::read(r)?;
 874                 let vout = Readable::read(r)?;
 875                 Ok(OutPoint {
 876                         txid,
 877                         vout,
 878                 })
 879         }
 880 }
 881
 882 macro_rules! impl_consensus_ser {
 883         ($bitcoin_type: ty) => {
 884                 impl Writeable for $bitcoin_type {
 885                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 886                                 match self.consensus_encode(&mut WriterWriteAdaptor(writer)) {
 887                                         Ok(_) => Ok(()),
 888                                         Err(e) => Err(e),
 889                                 }
 890                         }
 891                 }
 892
 893                 impl Readable for $bitcoin_type {
 894                         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 895                                 match consensus::encode::Decodable::consensus_decode(r) {
 896                                         Ok(t) => Ok(t),
 897                                         Err(consensus::encode::Error::Io(ref e)) if e.kind() == io::ErrorKind::UnexpectedEof => Err(DecodeError::ShortRead),
 898                                         Err(consensus::encode::Error::Io(e)) => Err(DecodeError::Io(e.kind())),
 899                                         Err(_) => Err(DecodeError::InvalidValue),
 900                                 }
 901                         }
 902                 }
 903         }
 904 }
 905 impl_consensus_ser!(Transaction);
 906 impl_consensus_ser!(TxOut);
 907
 908 impl<T: Readable> Readable for Mutex<T> {
 909         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 910                 let t: T = Readable::read(r)?;
 911                 Ok(Mutex::new(t))
 912         }
 913 }
 914 impl<T: Writeable> Writeable for Mutex<T> {
 915         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 916                 self.lock().unwrap().write(w)
 917         }
 918 }
 919
 920 impl<A: Readable, B: Readable> Readable for (A, B) {
 921         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 922                 let a: A = Readable::read(r)?;
 923                 let b: B = Readable::read(r)?;
 924                 Ok((a, b))
 925         }
 926 }
 927 impl<A: Writeable, B: Writeable> Writeable for (A, B) {
 928         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 929                 self.0.write(w)?;
 930                 self.1.write(w)
 931         }
 932 }
 933
 934 impl<A: Readable, B: Readable, C: Readable> Readable for (A, B, C) {
 935         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 936                 let a: A = Readable::read(r)?;
 937                 let b: B = Readable::read(r)?;
 938                 let c: C = Readable::read(r)?;
 939                 Ok((a, b, c))
 940         }
 941 }
 942 impl<A: Writeable, B: Writeable, C: Writeable> Writeable for (A, B, C) {
 943         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 944                 self.0.write(w)?;
 945                 self.1.write(w)?;
 946                 self.2.write(w)
 947         }
 948 }
 949
 950 impl Writeable for () {
 951         fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
 952                 Ok(())
 953         }
 954 }
 955 impl Readable for () {
 956         fn read<R: Read>(_r: &mut R) -> Result<Self, DecodeError> {
 957                 Ok(())
 958         }
 959 }
 960
 961 impl Writeable for String {
 962         #[inline]
 963         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 964                 (self.len() as u16).write(w)?;
 965                 w.write_all(self.as_bytes())
 966         }
 967 }
 968 impl Readable for String {
 969         #[inline]
 970         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 971                 let v: Vec<u8> = Readable::read(r)?;
 972                 let ret = String::from_utf8(v).map_err(|_| DecodeError::InvalidValue)?;
 973                 Ok(ret)
 974         }
 975 }
 976
 977 /// Represents a hostname for serialization purposes.
 978 /// Only the character set and length will be validated.
 979 /// The character set consists of ASCII alphanumeric characters, hyphens, and periods.
 980 /// Its length is guaranteed to be representable by a single byte.
 981 /// This serialization is used by BOLT 7 hostnames.
 982 #[derive(Clone, Debug, PartialEq)]
 983 pub struct Hostname(String);
 984 impl Hostname {
 985         /// Returns the length of the hostname.
 986         pub fn len(&self) -> u8 {
 987                 (&self.0).len() as u8
 988         }
 989 }
 990 impl Deref for Hostname {
 991         type Target = String;
 992
 993         fn deref(&self) -> &Self::Target {
 994                 &self.0
 995         }
 996 }
 997 impl From<Hostname> for String {
 998         fn from(hostname: Hostname) -> Self {
 999                 hostname.0
1000         }
1001 }
1002 impl TryFrom<Vec<u8>> for Hostname {
1003         type Error = ();
1004
1005         fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1006                 if let Ok(s) = String::from_utf8(bytes) {
1007                         Hostname::try_from(s)
1008                 } else {
1009                         Err(())
1010                 }
1011         }
1012 }
1013 impl TryFrom<String> for Hostname {
1014         type Error = ();
1015
1016         fn try_from(s: String) -> Result<Self, Self::Error> {
1017                 if s.len() <= 255 && s.chars().all(|c|
1018                         c.is_ascii_alphanumeric() ||
1019                         c == '.' ||
1020                         c == '-'
1021                 ) {
1022                         Ok(Hostname(s))
1023                 } else {
1024                         Err(())
1025                 }
1026         }
1027 }
1028 impl Writeable for Hostname {
1029         #[inline]
1030         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1031                 self.len().write(w)?;
1032                 w.write_all(self.as_bytes())
1033         }
1034 }
1035 impl Readable for Hostname {
1036         #[inline]
1037         fn read<R: Read>(r: &mut R) -> Result<Hostname, DecodeError> {
1038                 let len: u8 = Readable::read(r)?;
1039                 let mut vec = Vec::with_capacity(len.into());
1040                 vec.resize(len.into(), 0);
1041                 r.read_exact(&mut vec)?;
1042                 Hostname::try_from(vec).map_err(|_| DecodeError::InvalidValue)
1043         }
1044 }
1045
1046 impl Writeable for Duration {
1047         #[inline]
1048         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1049                 self.as_secs().write(w)?;
1050                 self.subsec_nanos().write(w)
1051         }
1052 }
1053 impl Readable for Duration {
1054         #[inline]
1055         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1056                 let secs = Readable::read(r)?;
1057                 let nanos = Readable::read(r)?;
1058                 Ok(Duration::new(secs, nanos))
1059         }
1060 }
1061
1062 #[cfg(test)]
1063 mod tests {
1064         use core::convert::TryFrom;
1065         use util::ser::{Readable, Hostname, Writeable};
1066
1067         #[test]
1068         fn hostname_conversion() {
1069                 assert_eq!(Hostname::try_from(String::from("a-test.com")).unwrap().as_str(), "a-test.com");
1070
1071                 assert!(Hostname::try_from(String::from("\"")).is_err());
1072                 assert!(Hostname::try_from(String::from("$")).is_err());
1073                 assert!(Hostname::try_from(String::from("⚡")).is_err());
1074                 let mut large_vec = Vec::with_capacity(256);
1075                 large_vec.resize(256, b'A');
1076                 assert!(Hostname::try_from(String::from_utf8(large_vec).unwrap()).is_err());
1077         }
1078
1079         #[test]
1080         fn hostname_serialization() {
1081                 let hostname = Hostname::try_from(String::from("test")).unwrap();
1082                 let mut buf: Vec<u8> = Vec::new();
1083                 hostname.write(&mut buf).unwrap();
1084                 assert_eq!(Hostname::read(&mut buf.as_slice()).unwrap().as_str(), "test");
1085         }
1086 }