siphash.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. /* ==========================================================================
  2. * siphash.h - SipHash-2-4 in a single header file
  3. * --------------------------------------------------------------------------
  4. * Derived by William Ahern from the reference implementation[1] published[2]
  5. * by Jean-Philippe Aumasson and Daniel J. Berstein.
  6. * Minimal changes by Sebastian Pipping and Victor Stinner on top, see below.
  7. * Licensed under the CC0 Public Domain Dedication license.
  8. *
  9. * 1. https://www.131002.net/siphash/siphash24.c
  10. * 2. https://www.131002.net/siphash/
  11. * --------------------------------------------------------------------------
  12. * HISTORY:
  13. *
  14. * 2020-10-03 (Sebastian Pipping)
  15. * - Drop support for Visual Studio 9.0/2008 and earlier
  16. *
  17. * 2019-08-03 (Sebastian Pipping)
  18. * - Mark part of sip24_valid as to be excluded from clang-format
  19. * - Re-format code using clang-format 9
  20. *
  21. * 2018-07-08 (Anton Maklakov)
  22. * - Add "fall through" markers for GCC's -Wimplicit-fallthrough
  23. *
  24. * 2017-11-03 (Sebastian Pipping)
  25. * - Hide sip_tobin and sip_binof unless SIPHASH_TOBIN macro is defined
  26. *
  27. * 2017-07-25 (Vadim Zeitlin)
  28. * - Fix use of SIPHASH_MAIN macro
  29. *
  30. * 2017-07-05 (Sebastian Pipping)
  31. * - Use _SIP_ULL macro to not require a C++11 compiler if compiled as C++
  32. * - Add const qualifiers at two places
  33. * - Ensure <=80 characters line length (assuming tab width 4)
  34. *
  35. * 2017-06-23 (Victor Stinner)
  36. * - Address Win64 compile warnings
  37. *
  38. * 2017-06-18 (Sebastian Pipping)
  39. * - Clarify license note in the header
  40. * - Address C89 issues:
  41. * - Stop using inline keyword (and let compiler decide)
  42. * - Replace _Bool by int
  43. * - Turn macro siphash24 into a function
  44. * - Address invalid conversion (void pointer) by explicit cast
  45. * - Address lack of stdint.h for Visual Studio 2003 to 2008
  46. * - Always expose sip24_valid (for self-tests)
  47. *
  48. * 2012-11-04 - Born. (William Ahern)
  49. * --------------------------------------------------------------------------
  50. * USAGE:
  51. *
  52. * SipHash-2-4 takes as input two 64-bit words as the key, some number of
  53. * message bytes, and outputs a 64-bit word as the message digest. This
  54. * implementation employs two data structures: a struct sipkey for
  55. * representing the key, and a struct siphash for representing the hash
  56. * state.
  57. *
  58. * For converting a 16-byte unsigned char array to a key, use either the
  59. * macro sip_keyof or the routine sip_tokey. The former instantiates a
  60. * compound literal key, while the latter requires a key object as a
  61. * parameter.
  62. *
  63. * unsigned char secret[16];
  64. * arc4random_buf(secret, sizeof secret);
  65. * struct sipkey *key = sip_keyof(secret);
  66. *
  67. * For hashing a message, use either the convenience macro siphash24 or the
  68. * routines sip24_init, sip24_update, and sip24_final.
  69. *
  70. * struct siphash state;
  71. * void *msg;
  72. * size_t len;
  73. * uint64_t hash;
  74. *
  75. * sip24_init(&state, key);
  76. * sip24_update(&state, msg, len);
  77. * hash = sip24_final(&state);
  78. *
  79. * or
  80. *
  81. * hash = siphash24(msg, len, key);
  82. *
  83. * To convert the 64-bit hash value to a canonical 8-byte little-endian
  84. * binary representation, use either the macro sip_binof or the routine
  85. * sip_tobin. The former instantiates and returns a compound literal array,
  86. * while the latter requires an array object as a parameter.
  87. * --------------------------------------------------------------------------
  88. * NOTES:
  89. *
  90. * o Neither sip_keyof, sip_binof, nor siphash24 will work with compilers
  91. * lacking compound literal support. Instead, you must use the lower-level
  92. * interfaces which take as parameters the temporary state objects.
  93. *
  94. * o Uppercase macros may evaluate parameters more than once. Lowercase
  95. * macros should not exhibit any such side effects.
  96. * ==========================================================================
  97. */
  98. #ifndef SIPHASH_H
  99. #define SIPHASH_H
  100. #include <stddef.h> /* size_t */
  101. #include <stdint.h> /* uint64_t uint32_t uint8_t */
  102. /*
  103. * Workaround to not require a C++11 compiler for using ULL suffix
  104. * if this code is included and compiled as C++; related GCC warning is:
  105. * warning: use of C++11 long long integer constant [-Wlong-long]
  106. */
  107. #define SIP_ULL(high, low) ((((uint64_t)high) << 32) | (low))
  108. #define SIP_ROTL(x, b) (uint64_t)(((x) << (b)) | ((x) >> (64 - (b))))
  109. #define SIP_U32TO8_LE(p, v) \
  110. (p)[0] = (uint8_t)((v) >> 0); \
  111. (p)[1] = (uint8_t)((v) >> 8); \
  112. (p)[2] = (uint8_t)((v) >> 16); \
  113. (p)[3] = (uint8_t)((v) >> 24);
  114. #define SIP_U64TO8_LE(p, v) \
  115. SIP_U32TO8_LE((p) + 0, (uint32_t)((v) >> 0)); \
  116. SIP_U32TO8_LE((p) + 4, (uint32_t)((v) >> 32));
  117. #define SIP_U8TO64_LE(p) \
  118. (((uint64_t)((p)[0]) << 0) | ((uint64_t)((p)[1]) << 8) \
  119. | ((uint64_t)((p)[2]) << 16) | ((uint64_t)((p)[3]) << 24) \
  120. | ((uint64_t)((p)[4]) << 32) | ((uint64_t)((p)[5]) << 40) \
  121. | ((uint64_t)((p)[6]) << 48) | ((uint64_t)((p)[7]) << 56))
  122. #define SIPHASH_INITIALIZER {0, 0, 0, 0, {0}, 0, 0}
  123. struct siphash {
  124. uint64_t v0, v1, v2, v3;
  125. unsigned char buf[8], *p;
  126. uint64_t c;
  127. }; /* struct siphash */
  128. #define SIP_KEYLEN 16
  129. struct sipkey {
  130. uint64_t k[2];
  131. }; /* struct sipkey */
  132. #define sip_keyof(k) sip_tokey(&(struct sipkey){{0}}, (k))
  133. static struct sipkey *
  134. sip_tokey(struct sipkey *key, const void *src) {
  135. key->k[0] = SIP_U8TO64_LE((const unsigned char *)src);
  136. key->k[1] = SIP_U8TO64_LE((const unsigned char *)src + 8);
  137. return key;
  138. } /* sip_tokey() */
  139. #ifdef SIPHASH_TOBIN
  140. # define sip_binof(v) sip_tobin((unsigned char[8]){0}, (v))
  141. static void *
  142. sip_tobin(void *dst, uint64_t u64) {
  143. SIP_U64TO8_LE((unsigned char *)dst, u64);
  144. return dst;
  145. } /* sip_tobin() */
  146. #endif /* SIPHASH_TOBIN */
  147. static void
  148. sip_round(struct siphash *H, const int rounds) {
  149. int i;
  150. for (i = 0; i < rounds; i++) {
  151. H->v0 += H->v1;
  152. H->v1 = SIP_ROTL(H->v1, 13);
  153. H->v1 ^= H->v0;
  154. H->v0 = SIP_ROTL(H->v0, 32);
  155. H->v2 += H->v3;
  156. H->v3 = SIP_ROTL(H->v3, 16);
  157. H->v3 ^= H->v2;
  158. H->v0 += H->v3;
  159. H->v3 = SIP_ROTL(H->v3, 21);
  160. H->v3 ^= H->v0;
  161. H->v2 += H->v1;
  162. H->v1 = SIP_ROTL(H->v1, 17);
  163. H->v1 ^= H->v2;
  164. H->v2 = SIP_ROTL(H->v2, 32);
  165. }
  166. } /* sip_round() */
  167. static struct siphash *
  168. sip24_init(struct siphash *H, const struct sipkey *key) {
  169. H->v0 = SIP_ULL(0x736f6d65U, 0x70736575U) ^ key->k[0];
  170. H->v1 = SIP_ULL(0x646f7261U, 0x6e646f6dU) ^ key->k[1];
  171. H->v2 = SIP_ULL(0x6c796765U, 0x6e657261U) ^ key->k[0];
  172. H->v3 = SIP_ULL(0x74656462U, 0x79746573U) ^ key->k[1];
  173. H->p = H->buf;
  174. H->c = 0;
  175. return H;
  176. } /* sip24_init() */
  177. #define sip_endof(a) (&(a)[sizeof(a) / sizeof *(a)])
  178. static struct siphash *
  179. sip24_update(struct siphash *H, const void *src, size_t len) {
  180. const unsigned char *p = (const unsigned char *)src, *pe = p + len;
  181. uint64_t m;
  182. do {
  183. while (p < pe && H->p < sip_endof(H->buf))
  184. *H->p++ = *p++;
  185. if (H->p < sip_endof(H->buf))
  186. break;
  187. m = SIP_U8TO64_LE(H->buf);
  188. H->v3 ^= m;
  189. sip_round(H, 2);
  190. H->v0 ^= m;
  191. H->p = H->buf;
  192. H->c += 8;
  193. } while (p < pe);
  194. return H;
  195. } /* sip24_update() */
  196. static uint64_t
  197. sip24_final(struct siphash *H) {
  198. const char left = (char)(H->p - H->buf);
  199. uint64_t b = (H->c + left) << 56;
  200. switch (left) {
  201. case 7:
  202. b |= (uint64_t)H->buf[6] << 48;
  203. /* fall through */
  204. case 6:
  205. b |= (uint64_t)H->buf[5] << 40;
  206. /* fall through */
  207. case 5:
  208. b |= (uint64_t)H->buf[4] << 32;
  209. /* fall through */
  210. case 4:
  211. b |= (uint64_t)H->buf[3] << 24;
  212. /* fall through */
  213. case 3:
  214. b |= (uint64_t)H->buf[2] << 16;
  215. /* fall through */
  216. case 2:
  217. b |= (uint64_t)H->buf[1] << 8;
  218. /* fall through */
  219. case 1:
  220. b |= (uint64_t)H->buf[0] << 0;
  221. /* fall through */
  222. case 0:
  223. break;
  224. }
  225. H->v3 ^= b;
  226. sip_round(H, 2);
  227. H->v0 ^= b;
  228. H->v2 ^= 0xff;
  229. sip_round(H, 4);
  230. return H->v0 ^ H->v1 ^ H->v2 ^ H->v3;
  231. } /* sip24_final() */
  232. static uint64_t
  233. siphash24(const void *src, size_t len, const struct sipkey *key) {
  234. struct siphash state = SIPHASH_INITIALIZER;
  235. return sip24_final(sip24_update(sip24_init(&state, key), src, len));
  236. } /* siphash24() */
  237. /*
  238. * SipHash-2-4 output with
  239. * k = 00 01 02 ...
  240. * and
  241. * in = (empty string)
  242. * in = 00 (1 byte)
  243. * in = 00 01 (2 bytes)
  244. * in = 00 01 02 (3 bytes)
  245. * ...
  246. * in = 00 01 02 ... 3e (63 bytes)
  247. */
  248. static int
  249. sip24_valid(void) {
  250. /* clang-format off */
  251. static const unsigned char vectors[64][8] = {
  252. { 0x31, 0x0e, 0x0e, 0xdd, 0x47, 0xdb, 0x6f, 0x72, },
  253. { 0xfd, 0x67, 0xdc, 0x93, 0xc5, 0x39, 0xf8, 0x74, },
  254. { 0x5a, 0x4f, 0xa9, 0xd9, 0x09, 0x80, 0x6c, 0x0d, },
  255. { 0x2d, 0x7e, 0xfb, 0xd7, 0x96, 0x66, 0x67, 0x85, },
  256. { 0xb7, 0x87, 0x71, 0x27, 0xe0, 0x94, 0x27, 0xcf, },
  257. { 0x8d, 0xa6, 0x99, 0xcd, 0x64, 0x55, 0x76, 0x18, },
  258. { 0xce, 0xe3, 0xfe, 0x58, 0x6e, 0x46, 0xc9, 0xcb, },
  259. { 0x37, 0xd1, 0x01, 0x8b, 0xf5, 0x00, 0x02, 0xab, },
  260. { 0x62, 0x24, 0x93, 0x9a, 0x79, 0xf5, 0xf5, 0x93, },
  261. { 0xb0, 0xe4, 0xa9, 0x0b, 0xdf, 0x82, 0x00, 0x9e, },
  262. { 0xf3, 0xb9, 0xdd, 0x94, 0xc5, 0xbb, 0x5d, 0x7a, },
  263. { 0xa7, 0xad, 0x6b, 0x22, 0x46, 0x2f, 0xb3, 0xf4, },
  264. { 0xfb, 0xe5, 0x0e, 0x86, 0xbc, 0x8f, 0x1e, 0x75, },
  265. { 0x90, 0x3d, 0x84, 0xc0, 0x27, 0x56, 0xea, 0x14, },
  266. { 0xee, 0xf2, 0x7a, 0x8e, 0x90, 0xca, 0x23, 0xf7, },
  267. { 0xe5, 0x45, 0xbe, 0x49, 0x61, 0xca, 0x29, 0xa1, },
  268. { 0xdb, 0x9b, 0xc2, 0x57, 0x7f, 0xcc, 0x2a, 0x3f, },
  269. { 0x94, 0x47, 0xbe, 0x2c, 0xf5, 0xe9, 0x9a, 0x69, },
  270. { 0x9c, 0xd3, 0x8d, 0x96, 0xf0, 0xb3, 0xc1, 0x4b, },
  271. { 0xbd, 0x61, 0x79, 0xa7, 0x1d, 0xc9, 0x6d, 0xbb, },
  272. { 0x98, 0xee, 0xa2, 0x1a, 0xf2, 0x5c, 0xd6, 0xbe, },
  273. { 0xc7, 0x67, 0x3b, 0x2e, 0xb0, 0xcb, 0xf2, 0xd0, },
  274. { 0x88, 0x3e, 0xa3, 0xe3, 0x95, 0x67, 0x53, 0x93, },
  275. { 0xc8, 0xce, 0x5c, 0xcd, 0x8c, 0x03, 0x0c, 0xa8, },
  276. { 0x94, 0xaf, 0x49, 0xf6, 0xc6, 0x50, 0xad, 0xb8, },
  277. { 0xea, 0xb8, 0x85, 0x8a, 0xde, 0x92, 0xe1, 0xbc, },
  278. { 0xf3, 0x15, 0xbb, 0x5b, 0xb8, 0x35, 0xd8, 0x17, },
  279. { 0xad, 0xcf, 0x6b, 0x07, 0x63, 0x61, 0x2e, 0x2f, },
  280. { 0xa5, 0xc9, 0x1d, 0xa7, 0xac, 0xaa, 0x4d, 0xde, },
  281. { 0x71, 0x65, 0x95, 0x87, 0x66, 0x50, 0xa2, 0xa6, },
  282. { 0x28, 0xef, 0x49, 0x5c, 0x53, 0xa3, 0x87, 0xad, },
  283. { 0x42, 0xc3, 0x41, 0xd8, 0xfa, 0x92, 0xd8, 0x32, },
  284. { 0xce, 0x7c, 0xf2, 0x72, 0x2f, 0x51, 0x27, 0x71, },
  285. { 0xe3, 0x78, 0x59, 0xf9, 0x46, 0x23, 0xf3, 0xa7, },
  286. { 0x38, 0x12, 0x05, 0xbb, 0x1a, 0xb0, 0xe0, 0x12, },
  287. { 0xae, 0x97, 0xa1, 0x0f, 0xd4, 0x34, 0xe0, 0x15, },
  288. { 0xb4, 0xa3, 0x15, 0x08, 0xbe, 0xff, 0x4d, 0x31, },
  289. { 0x81, 0x39, 0x62, 0x29, 0xf0, 0x90, 0x79, 0x02, },
  290. { 0x4d, 0x0c, 0xf4, 0x9e, 0xe5, 0xd4, 0xdc, 0xca, },
  291. { 0x5c, 0x73, 0x33, 0x6a, 0x76, 0xd8, 0xbf, 0x9a, },
  292. { 0xd0, 0xa7, 0x04, 0x53, 0x6b, 0xa9, 0x3e, 0x0e, },
  293. { 0x92, 0x59, 0x58, 0xfc, 0xd6, 0x42, 0x0c, 0xad, },
  294. { 0xa9, 0x15, 0xc2, 0x9b, 0xc8, 0x06, 0x73, 0x18, },
  295. { 0x95, 0x2b, 0x79, 0xf3, 0xbc, 0x0a, 0xa6, 0xd4, },
  296. { 0xf2, 0x1d, 0xf2, 0xe4, 0x1d, 0x45, 0x35, 0xf9, },
  297. { 0x87, 0x57, 0x75, 0x19, 0x04, 0x8f, 0x53, 0xa9, },
  298. { 0x10, 0xa5, 0x6c, 0xf5, 0xdf, 0xcd, 0x9a, 0xdb, },
  299. { 0xeb, 0x75, 0x09, 0x5c, 0xcd, 0x98, 0x6c, 0xd0, },
  300. { 0x51, 0xa9, 0xcb, 0x9e, 0xcb, 0xa3, 0x12, 0xe6, },
  301. { 0x96, 0xaf, 0xad, 0xfc, 0x2c, 0xe6, 0x66, 0xc7, },
  302. { 0x72, 0xfe, 0x52, 0x97, 0x5a, 0x43, 0x64, 0xee, },
  303. { 0x5a, 0x16, 0x45, 0xb2, 0x76, 0xd5, 0x92, 0xa1, },
  304. { 0xb2, 0x74, 0xcb, 0x8e, 0xbf, 0x87, 0x87, 0x0a, },
  305. { 0x6f, 0x9b, 0xb4, 0x20, 0x3d, 0xe7, 0xb3, 0x81, },
  306. { 0xea, 0xec, 0xb2, 0xa3, 0x0b, 0x22, 0xa8, 0x7f, },
  307. { 0x99, 0x24, 0xa4, 0x3c, 0xc1, 0x31, 0x57, 0x24, },
  308. { 0xbd, 0x83, 0x8d, 0x3a, 0xaf, 0xbf, 0x8d, 0xb7, },
  309. { 0x0b, 0x1a, 0x2a, 0x32, 0x65, 0xd5, 0x1a, 0xea, },
  310. { 0x13, 0x50, 0x79, 0xa3, 0x23, 0x1c, 0xe6, 0x60, },
  311. { 0x93, 0x2b, 0x28, 0x46, 0xe4, 0xd7, 0x06, 0x66, },
  312. { 0xe1, 0x91, 0x5f, 0x5c, 0xb1, 0xec, 0xa4, 0x6c, },
  313. { 0xf3, 0x25, 0x96, 0x5c, 0xa1, 0x6d, 0x62, 0x9f, },
  314. { 0x57, 0x5f, 0xf2, 0x8e, 0x60, 0x38, 0x1b, 0xe5, },
  315. { 0x72, 0x45, 0x06, 0xeb, 0x4c, 0x32, 0x8a, 0x95, }
  316. };
  317. /* clang-format on */
  318. unsigned char in[64];
  319. struct sipkey k;
  320. size_t i;
  321. sip_tokey(&k, "\000\001\002\003\004\005\006\007\010\011"
  322. "\012\013\014\015\016\017");
  323. for (i = 0; i < sizeof in; ++i) {
  324. in[i] = (unsigned char)i;
  325. if (siphash24(in, i, &k) != SIP_U8TO64_LE(vectors[i]))
  326. return 0;
  327. }
  328. return 1;
  329. } /* sip24_valid() */
  330. #ifdef SIPHASH_MAIN
  331. # include <stdio.h>
  332. int
  333. main(void) {
  334. const int ok = sip24_valid();
  335. if (ok)
  336. puts("OK");
  337. else
  338. puts("FAIL");
  339. return ! ok;
  340. } /* main() */
  341. #endif /* SIPHASH_MAIN */
  342. #endif /* SIPHASH_H */