src/libcore/hash/sip.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! An implementation of SipHash 2-4.
  12
  13 #![allow(deprecated)] // until the next snapshot for inherent wrapping ops
  14
  15 use prelude::*;
  16 use default::Default;
  17 use super::Hasher;
  18
  19 /// An implementation of SipHash 2-4.
  20 ///
  21 /// See: http://131002.net/siphash/
  22 ///
  23 /// Consider this as a main "general-purpose" hash for all hashtables: it
  24 /// runs at good speed (competitive with spooky and city) and permits
  25 /// strong _keyed_ hashing. Key your hashtables from a strong RNG,
  26 /// such as `rand::Rng`.
  27 ///
  28 /// Although the SipHash algorithm is considered to be cryptographically
  29 /// strong, this implementation has not been reviewed for such purposes.
  30 /// As such, all cryptographic uses of this implementation are strongly
  31 /// discouraged.
  32 #[stable(feature = "rust1", since = "1.0.0")]
  33 pub struct SipHasher {
  34     k0: u64,
  35     k1: u64,
  36     length: usize, // how many bytes we've processed
  37     v0: u64,      // hash state
  38     v1: u64,
  39     v2: u64,
  40     v3: u64,
  41     tail: u64, // unprocessed bytes le
  42     ntail: usize,  // how many bytes in tail are valid
  43 }
  44
  45 // sadly, these macro definitions can't appear later,
  46 // because they're needed in the following defs;
  47 // this design could be improved.
  48
  49 macro_rules! u8to64_le {
  50     ($buf:expr, $i:expr) =>
  51     ($buf[0+$i] as u64 |
  52      ($buf[1+$i] as u64) << 8 |
  53      ($buf[2+$i] as u64) << 16 |
  54      ($buf[3+$i] as u64) << 24 |
  55      ($buf[4+$i] as u64) << 32 |
  56      ($buf[5+$i] as u64) << 40 |
  57      ($buf[6+$i] as u64) << 48 |
  58      ($buf[7+$i] as u64) << 56);
  59     ($buf:expr, $i:expr, $len:expr) =>
  60     ({
  61         let mut t = 0;
  62         let mut out = 0;
  63         while t < $len {
  64             out |= ($buf[t+$i] as u64) << t*8;
  65             t += 1;
  66         }
  67         out
  68     });
  69 }
  70
  71 macro_rules! rotl {
  72     ($x:expr, $b:expr) =>
  73     (($x << $b) | ($x >> (64_i32.wrapping_sub($b))))
  74 }
  75
  76 macro_rules! compress {
  77     ($v0:expr, $v1:expr, $v2:expr, $v3:expr) =>
  78     ({
  79         $v0 = $v0.wrapping_add($v1); $v1 = rotl!($v1, 13); $v1 ^= $v0;
  80         $v0 = rotl!($v0, 32);
  81         $v2 = $v2.wrapping_add($v3); $v3 = rotl!($v3, 16); $v3 ^= $v2;
  82         $v0 = $v0.wrapping_add($v3); $v3 = rotl!($v3, 21); $v3 ^= $v0;
  83         $v2 = $v2.wrapping_add($v1); $v1 = rotl!($v1, 17); $v1 ^= $v2;
  84         $v2 = rotl!($v2, 32);
  85     })
  86 }
  87
  88 impl SipHasher {
  89     /// Creates a new `SipHasher` with the two initial keys set to 0.
  90     #[inline]
  91     #[stable(feature = "rust1", since = "1.0.0")]
  92     pub fn new() -> SipHasher {
  93         SipHasher::new_with_keys(0, 0)
  94     }
  95
  96     /// Creates a `SipHasher` that is keyed off the provided keys.
  97     #[inline]
  98     #[stable(feature = "rust1", since = "1.0.0")]
  99     pub fn new_with_keys(key0: u64, key1: u64) -> SipHasher {
 100         let mut state = SipHasher {
 101             k0: key0,
 102             k1: key1,
 103             length: 0,
 104             v0: 0,
 105             v1: 0,
 106             v2: 0,
 107             v3: 0,
 108             tail: 0,
 109             ntail: 0,
 110         };
 111         state.reset();
 112         state
 113     }
 114
 115     fn reset(&mut self) {
 116         self.length = 0;
 117         self.v0 = self.k0 ^ 0x736f6d6570736575;
 118         self.v1 = self.k1 ^ 0x646f72616e646f6d;
 119         self.v2 = self.k0 ^ 0x6c7967656e657261;
 120         self.v3 = self.k1 ^ 0x7465646279746573;
 121         self.ntail = 0;
 122     }
 123
 124     fn write(&mut self, msg: &[u8]) {
 125         let length = msg.len();
 126         self.length += length;
 127
 128         let mut needed = 0;
 129
 130         if self.ntail != 0 {
 131             needed = 8 - self.ntail;
 132             if length < needed {
 133                 self.tail |= u8to64_le!(msg, 0, length) << 8*self.ntail;
 134                 self.ntail += length;
 135                 return
 136             }
 137
 138             let m = self.tail | u8to64_le!(msg, 0, needed) << 8*self.ntail;
 139
 140             self.v3 ^= m;
 141             compress!(self.v0, self.v1, self.v2, self.v3);
 142             compress!(self.v0, self.v1, self.v2, self.v3);
 143             self.v0 ^= m;
 144
 145             self.ntail = 0;
 146         }
 147
 148         // Buffered tail is now flushed, process new input.
 149         let len = length - needed;
 150         let end = len & (!0x7);
 151         let left = len & 0x7;
 152
 153         let mut i = needed;
 154         while i < end {
 155             let mi = u8to64_le!(msg, i);
 156
 157             self.v3 ^= mi;
 158             compress!(self.v0, self.v1, self.v2, self.v3);
 159             compress!(self.v0, self.v1, self.v2, self.v3);
 160             self.v0 ^= mi;
 161
 162             i += 8;
 163         }
 164
 165         self.tail = u8to64_le!(msg, i, left);
 166         self.ntail = left;
 167     }
 168 }
 169
 170 #[stable(feature = "rust1", since = "1.0.0")]
 171 impl Hasher for SipHasher {
 172     #[inline]
 173     fn write(&mut self, msg: &[u8]) {
 174         self.write(msg)
 175     }
 176
 177     fn finish(&self) -> u64 {
 178         let mut v0 = self.v0;
 179         let mut v1 = self.v1;
 180         let mut v2 = self.v2;
 181         let mut v3 = self.v3;
 182
 183         let b: u64 = ((self.length as u64 & 0xff) << 56) | self.tail;
 184
 185         v3 ^= b;
 186         compress!(v0, v1, v2, v3);
 187         compress!(v0, v1, v2, v3);
 188         v0 ^= b;
 189
 190         v2 ^= 0xff;
 191         compress!(v0, v1, v2, v3);
 192         compress!(v0, v1, v2, v3);
 193         compress!(v0, v1, v2, v3);
 194         compress!(v0, v1, v2, v3);
 195
 196         v0 ^ v1 ^ v2 ^ v3
 197     }
 198 }
 199
 200 #[stable(feature = "rust1", since = "1.0.0")]
 201 impl Clone for SipHasher {
 202     #[inline]
 203     fn clone(&self) -> SipHasher {
 204         SipHasher {
 205             k0: self.k0,
 206             k1: self.k1,
 207             length: self.length,
 208             v0: self.v0,
 209             v1: self.v1,
 210             v2: self.v2,
 211             v3: self.v3,
 212             tail: self.tail,
 213             ntail: self.ntail,
 214         }
 215     }
 216 }
 217
 218 #[stable(feature = "rust1", since = "1.0.0")]
 219 impl Default for SipHasher {
 220     fn default() -> SipHasher {
 221         SipHasher::new()
 222     }
 223 }