2 * Copyright (c) 2013 Andre Oppermann <andre@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote
14 * products derived from this software without specific prior written
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SipHash is a family of pseudorandom functions (a.k.a. keyed hash functions)
34 * optimized for speed on short messages returning a 64bit hash/digest value.
36 * The number of rounds is defined during the initialization:
37 * SipHash24_Init() for the fast and resonable strong version
38 * SipHash48_Init() for the strong version (half as fast)
40 * struct SIPHASH_CTX ctx;
41 * SipHash24_Init(&ctx);
42 * SipHash_SetKey(&ctx, "16bytes long key");
43 * SipHash_Update(&ctx, pointer_to_string, length_of_string);
44 * SipHash_Final(output, &ctx);
50 #define SIPHASH_BLOCK_LENGTH 8
51 #define SIPHASH_KEY_LENGTH 16
52 #define SIPHASH_DIGEST_LENGTH 8
54 typedef struct _SIPHASH_CTX {
68 #define SipHash24_Init(x) SipHash_InitX((x), 2, 4)
69 #define SipHash48_Init(x) SipHash_InitX((x), 4, 8)
70 void SipHash_InitX(SIPHASH_CTX *, int, int);
71 void SipHash_SetKey(SIPHASH_CTX *,
72 const uint8_t[__min_size(SIPHASH_KEY_LENGTH)]);
73 void SipHash_Update(SIPHASH_CTX *, const void *, size_t);
74 void SipHash_Final(uint8_t[__min_size(SIPHASH_DIGEST_LENGTH)], SIPHASH_CTX *);
75 uint64_t SipHash_End(SIPHASH_CTX *);
77 #define SipHash24(x, y, z, i) SipHashX((x), 2, 4, (y), (z), (i));
78 #define SipHash48(x, y, z, i) SipHashX((x), 4, 8, (y), (z), (i));
79 uint64_t SipHashX(SIPHASH_CTX *, int, int,
80 const uint8_t[__min_size(SIPHASH_KEY_LENGTH)], const void *, size_t);
82 int SipHash24_TestVectors(void);
84 #endif /* _SIPHASH_H_ */