1/*-
2 * Copyright (c) 2013 Andre Oppermann <andre@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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
15 * permission.
16 *
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
27 * SUCH DAMAGE.
28 *
29 * $OpenBSD: siphash.h,v 1.5 2025/04/14 08:28:24 claudio Exp $
30 */
31
32/*
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.
35 *
36 * The number of rounds is defined during the initialization:
37 * SipHash24_Init() for the fast and reasonable strong version
38 * SipHash48_Init() for the strong version (half as fast)
39 *
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);
45 */
46
47#ifndef _SIPHASH_H_
48#define _SIPHASH_H_
49
50#include <stddef.h>
51#include <stdint.h>
52
53#define SIPHASH_BLOCK_LENGTH 8
54#define SIPHASH_KEY_LENGTH 16
55#define SIPHASH_DIGEST_LENGTH 8
56
57typedef struct _SIPHASH_CTX {
58 uint64_t v[4];
59 uint8_t buf[SIPHASH_BLOCK_LENGTH];
60 uint32_t bytes;
61} SIPHASH_CTX;
62
63typedef struct {
64 uint64_t k0;
65 uint64_t k1;
66} SIPHASH_KEY;
67
68void SipHash_Init(SIPHASH_CTX *, const SIPHASH_KEY *);
69void SipHash_Update(SIPHASH_CTX *, int, int, const void *, size_t);
70uint64_t SipHash_End(SIPHASH_CTX *, int, int);
71void SipHash_Final(void *, SIPHASH_CTX *, int, int);
72uint64_t SipHash(const SIPHASH_KEY *, int, int, const void *, size_t);
73
74#define SipHash24_Init(_c, _k) SipHash_Init((_c), (_k))
75#define SipHash24_Update(_c, _p, _l) SipHash_Update((_c), 2, 4, (_p), (_l))
76#define SipHash24_End(_d) SipHash_End((_d), 2, 4)
77#define SipHash24_Final(_d, _c) SipHash_Final((_d), (_c), 2, 4)
78#define SipHash24(_k, _p, _l) SipHash((_k), 2, 4, (_p), (_l))
79
80#define SipHash48_Init(_c, _k) SipHash_Init((_c), (_k))
81#define SipHash48_Update(_c, _p, _l) SipHash_Update((_c), 4, 8, (_p), (_l))
82#define SipHash48_End(_d) SipHash_End((_d), 4, 8)
83#define SipHash48_Final(_d, _c) SipHash_Final((_d), (_c), 4, 8)
84#define SipHash48(_k, _p, _l) SipHash((_k), 4, 8, (_p), (_l))
85
86#endif /* _SIPHASH_H_ */