rust-bitcoin-unsafe-fast/src/util/hash.rs

// Rust Bitcoin Library
// Written in 2014 by
//   Andrew Poelstra <apoelstra@wpsoftware.net>
// To the extent possible under law, the author(s) have dedicated all
// copyright and related and neighboring rights to this software to
// the public domain worldwide. This software is distributed without
// any warranty.
//
// You should have received a copy of the CC0 Public Domain Dedication
// along with this software.
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
//

//! # Hash functions
//!
//! Utility functions related to hashing data, including merkleization

use core::char::from_digit;
use core::cmp::min;
use std::default::Default;
use std::fmt;
use std::io::Cursor;
use std::mem::transmute;
use std::hash;
use serialize::json::{self, ToJson};

use byteorder::{ByteOrder, LittleEndian};
use crypto::digest::Digest;
use crypto::sha2::Sha256;
use crypto::ripemd160::Ripemd160;

use network::encodable::{ConsensusDecodable, ConsensusEncodable};
use network::serialize::{RawEncoder, BitcoinHash, SimpleDecoder};
use util::uint::Uint256;

/// A Bitcoin hash, 32-bytes, computed from x as SHA256(SHA256(x))
pub struct Sha256dHash([u8; 32]);
impl_array_newtype!(Sha256dHash, u8, 32);

impl ::std::fmt::Debug for Sha256dHash {
  fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
    write!(f, "{}", self.be_hex_string().as_slice())
  }
}

/// A RIPEMD-160 hash
pub struct Ripemd160Hash([u8; 20]);
impl_array_newtype!(Ripemd160Hash, u8, 20);

/// A "hasher" which just truncates and adds data to its state. Should
/// only be used for hashtables indexed by "already random" data such
/// as SHA2 hashes
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct DumbHasher;

/// The state of a `DumbHasher`
pub struct DumbHasherState([u8; 8]);

/// A 32-bit hash obtained by truncating a real hash
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Hash32((u8, u8, u8, u8));

/// A 48-bit hash obtained by truncating a real hash
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Hash48((u8, u8, u8, u8, u8, u8));

/// A 64-bit hash obtained by truncating a real hash
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Hash64((u8, u8, u8, u8, u8, u8, u8, u8));


// Allow these to be used as a key for Rust's HashMap et. al.
impl hash::Hash<DumbHasherState> for Sha256dHash {
  #[inline]
  fn hash(&self, state: &mut DumbHasherState) {
    let &Sha256dHash(ref hash) = self;
    let &DumbHasherState(ref mut arr) = state;
    for i in range(0, 8) {
      arr[i] += hash[i];
    }
  }
}

impl hash::Hasher<DumbHasherState> for DumbHasher {
  #[inline]
  fn hash<T: hash::Hash<DumbHasherState>>(&self, value: &T) -> u64 {
    let mut ret = DumbHasherState([0; 8]);
    value.hash(&mut ret);
    let DumbHasherState(res) = ret;
    LittleEndian::read_u64(&res[0..8])
  }
}

impl hash::Writer for DumbHasherState {
  #[inline]
  fn write(&mut self, msg: &[u8]) {
    let &DumbHasherState(ref mut arr) = self;
    for (n, &ch) in msg.iter().enumerate() {
      arr[n % 8] += ch;
    }
  }
}

impl Default for DumbHasher {
  #[inline]
  fn default() -> DumbHasher { DumbHasher }
}

impl Ripemd160Hash {
  /// Create a hash by hashing some data
  pub fn from_data(data: &[u8]) -> Ripemd160Hash {
    let mut ret = [0; 20];
    let mut rmd = Ripemd160::new();
    rmd.input(data);
    rmd.result(ret.as_mut_slice());
    Ripemd160Hash(ret)
  }
}

// This doesn't make much sense to me, but is implicit behaviour
// in the C++ reference client
impl Default for Sha256dHash {
  #[inline]
  fn default() -> Sha256dHash { Sha256dHash([0u8; 32]) }
}

impl Sha256dHash {
  /// Create a hash by hashing some data
  pub fn from_data(data: &[u8]) -> Sha256dHash {
    let Sha256dHash(mut ret): Sha256dHash = Default::default();
    let mut sha2 = Sha256::new();
    sha2.input(data);
    sha2.result(ret.as_mut_slice());
    sha2.reset();
    sha2.input(ret.as_slice());
    sha2.result(ret.as_mut_slice());
    Sha256dHash(ret)
  }

  /// Converts a hash to a little-endian Uint256
  #[inline]
  pub fn into_le(self) -> Uint256 {
    let Sha256dHash(data) = self;
    let mut ret: [u64; 4] = unsafe { transmute(data) };
    for x in ret.as_mut_slice().iter_mut() { *x = x.to_le(); }
    Uint256(ret)
  }

  /// Converts a hash to a big-endian Uint256
  #[inline]
  pub fn into_be(self) -> Uint256 {
    let Sha256dHash(mut data) = self;
    data.reverse();
    let mut ret: [u64; 4] = unsafe { transmute(data) };
    for x in ret.iter_mut() { *x = x.to_be(); }
    Uint256(ret)
  }

  /// Converts a hash to a Hash32 by truncation
  #[inline]
  pub fn into_hash32(self) -> Hash32 {
    let Sha256dHash(data) = self;
    unsafe { transmute([data[0], data[8], data[16], data[24]]) }
  }

  /// Converts a hash to a Hash48 by truncation
  #[inline]
  pub fn into_hash48(self) -> Hash48 {
    let Sha256dHash(data) = self;
    unsafe { transmute([data[0], data[6], data[12], data[18], data[24], data[30]]) }
  }

  /// Human-readable hex output

  /// Converts a hash to a Hash64 by truncation
  #[inline]
  pub fn into_hash64(self) -> Hash64 {
    let Sha256dHash(data) = self;
    unsafe { transmute([data[0], data[4], data[8], data[12],
                        data[16], data[20], data[24], data[28]]) }
  }

  /// Human-readable hex output
  pub fn le_hex_string(&self) -> String {
    let &Sha256dHash(data) = self;
    let mut ret = String::with_capacity(64);
    for i in range(0, 32) {
      ret.push_char(from_digit((data[i] / 0x10) as usize, 16).unwrap());
      ret.push_char(from_digit((data[i] & 0x0f) as usize, 16).unwrap());
    }
    ret
  }

  /// Human-readable hex output
  pub fn be_hex_string(&self) -> String {
    let &Sha256dHash(data) = self;
    let mut ret = String::with_capacity(64);
    for i in range(0, 32).rev() {
      ret.push_char(from_digit((data[i] / 0x10) as usize, 16).unwrap());
      ret.push_char(from_digit((data[i] & 0x0f) as usize, 16).unwrap());
    }
    ret
  }
}

// Note that this outputs hashes as big endian hex numbers, so this should be
// used only for user-facing stuff. Internal and network serialization is
// little-endian and should be done using the consensus `encodable::ConsensusEncodable`
// interface.
impl ToJson for Sha256dHash {
  #[inline]
  fn to_json(&self) -> json::Json {
    json::String(self.be_hex_string())
  }
}

// Non-consensus encoding (big-endian hex string)
impl<S: ::serialize::Encoder<E>, E> ::serialize::Encodable<S, E> for Sha256dHash {
  #[inline]
  fn encode(&self, s: &mut S) -> Result<(), E> {
    s.emit_str(self.be_hex_string().as_slice())
  }
}

impl<D: ::serialize::Decoder<E>, E> ::serialize::Decodable<D, E> for Sha256dHash {
  #[inline]
  fn decode(d: &mut D) -> Result<Sha256dHash, E> {
    use serialize::hex::FromHex;

    let hex_str = try!(d.read_str());
    if hex_str.len() != 64 {
      d.error("incorrect hash length");
    }
    let raw_str = try!(hex_str.as_slice().from_hex()
                         .map_err(|_| d.error("non-hexadecimal hash string")));
    let mut ret = [0u8; 32];
    for i in range(0, 32) {
      ret[i] = raw_str[31 - i];
    }
    Ok(Sha256dHash(ret))
  }
}

// Consensus encoding (little-endian)
impl_newtype_consensus_encoding!(Hash32);
impl_newtype_consensus_encoding!(Hash48);
impl_newtype_consensus_encoding!(Hash64);
impl_newtype_consensus_encoding!(Sha256dHash);

impl fmt::LowerHex for Sha256dHash {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    let &Sha256dHash(data) = self;
    let mut rv = [0; 64];
    let mut hex = data.iter().rev().map(|n| *n).enumerate();
    for (i, ch) in hex {
      rv[2*i]     = from_digit(ch as usize / 16, 16).unwrap() as u8;
      rv[2*i + 1] = from_digit(ch as usize % 16, 16).unwrap() as u8;
    }
    f.write(rv.as_slice())
  }
}

/// Any collection of objects for which a merkle root makes sense to calculate
pub trait MerkleRoot {
  /// Construct a merkle tree from a collection, with elements ordered as
  /// they were in the original collection, and return the merkle root.
  fn merkle_root(&self) -> Sha256dHash;
}

impl<'a, T: BitcoinHash> MerkleRoot for &'a [T] {
  fn merkle_root(&self) -> Sha256dHash {
    fn merkle_root(data: Vec<Sha256dHash>) -> Sha256dHash {
      // Base case
      if data.len() < 1 {
        return Default::default();
      }
      if data.len() < 2 {
        return data[0];
      }
      // Recursion
      let mut next = vec![];
      for idx in range(0, (data.len() + 1) / 2) {
        let idx1 = 2 * idx;
        let idx2 = min(idx1 + 1, data.len() - 1);
        let mut encoder = RawEncoder::new(Cursor::new(vec![]));
        data[idx1].consensus_encode(&mut encoder).unwrap();
        data[idx2].consensus_encode(&mut encoder).unwrap();
        next.push(encoder.unwrap().unwrap().bitcoin_hash());
      }
      merkle_root(next)
    }
    merkle_root(self.iter().map(|obj| obj.bitcoin_hash()).collect())
  }
}

impl <T: BitcoinHash> MerkleRoot for Vec<T> {
  fn merkle_root(&self) -> Sha256dHash {
    self.as_slice().merkle_root()
  }
}


#[cfg(test)]
mod tests {
  use std::prelude::*;
  use std::io::Cursor;
  use std::str::from_utf8;
  use serialize::Encodable;
  use serialize::json;

  use network::serialize::{serialize, deserialize};
  use util::hash::Sha256dHash;

  #[test]
  fn test_sha256d() {
    // nb the 5df6... output is the one you get from sha256sum. this is the
    // "little-endian" hex string since it matches the in-memory representation
    // of a Uint256 (which is little-endian) after transmutation
    assert_eq!(Sha256dHash::from_data(&[]).le_hex_string(),
               "5df6e0e2761359d30a8275058e299fcc0381534545f55cf43e41983f5d4c9456".to_string());
    assert_eq!(Sha256dHash::from_data(&[]).be_hex_string(),
               "56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d".to_string());
  }

  #[test]
  fn test_consenus_encode_roundtrip() {
    let hash = Sha256dHash::from_data(&[]);
    let serial = serialize(&hash).unwrap();
    let deserial = deserialize(serial).unwrap();
    assert_eq!(hash, deserial);
  }

  #[test]
  fn test_hash_encode_decode() {
    let hash = Sha256dHash::from_data(&[]);
    let mut writer = Cursor::new(vec![]);
    {
      let mut encoder = json::Encoder::new(&mut writer);
      assert!(hash.encode(&mut encoder).is_ok());
    }
    let res = writer.unwrap();
    assert_eq!(res.as_slice(),
               "\"56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d\"".as_bytes());
    assert_eq!(json::decode(from_utf8(res.as_slice()).unwrap()), Ok(hash));
  }

  #[test]
  fn test_sighash_single_vec() {
    let one = Sha256dHash([1, 0, 0, 0, 0, 0, 0, 0,
                           0, 0, 0, 0, 0, 0, 0, 0,
                           0, 0, 0, 0, 0, 0, 0, 0,
                           0, 0, 0, 0, 0, 0, 0, 0]);
    assert_eq!(Some(one.into_le()), FromPrimitive::from_u64(1));
    assert_eq!(Some(one.into_le().low_128()), FromPrimitive::from_u64(1));
  }
}