/src/openssl35/crypto/siphash/siphash.c

Source
/*
 * Copyright 2017-2022 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/* Based on https://131002.net/siphash C reference implementation */
/*
   SipHash reference C implementation

   Copyright (c) 2012-2016 Jean-Philippe Aumasson
   Copyright (c) 2012-2014 Daniel J. Bernstein

   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/>.
 */

#include <stdlib.h>
#include <string.h>
#include <openssl/crypto.h>

#include "crypto/siphash.h"

#define ROTL(x, b) (uint64_t)(((x) << (b)) | ((x) >> (64 - (b))))

#define U32TO8_LE(p, v)                                                        \
    (p)[0] = (uint8_t)((v));                                                   \
    (p)[1] = (uint8_t)((v) >> 8);                                              \
    (p)[2] = (uint8_t)((v) >> 16);                                             \
    (p)[3] = (uint8_t)((v) >> 24);

#define U64TO8_LE(p, v)                                                        \
    U32TO8_LE((p), (uint32_t)((v)));                                           \
    U32TO8_LE((p) + 4, (uint32_t)((v) >> 32));

#define U8TO64_LE(p)                                                           \
    (((uint64_t)((p)[0])) | ((uint64_t)((p)[1]) << 8) |                        \
     ((uint64_t)((p)[2]) << 16) | ((uint64_t)((p)[3]) << 24) |                 \
     ((uint64_t)((p)[4]) << 32) | ((uint64_t)((p)[5]) << 40) |                 \
     ((uint64_t)((p)[6]) << 48) | ((uint64_t)((p)[7]) << 56))

#define SIPROUND                                                               \
    do {                                                                       \
        v0 += v1;                                                              \
        v1 = ROTL(v1, 13);                                                     \
        v1 ^= v0;                                                              \
        v0 = ROTL(v0, 32);                                                     \
        v2 += v3;                                                              \
        v3 = ROTL(v3, 16);                                                     \
        v3 ^= v2;                                                              \
        v0 += v3;                                                              \
        v3 = ROTL(v3, 21);                                                     \
        v3 ^= v0;                                                              \
        v2 += v1;                                                              \
        v1 = ROTL(v1, 17);                                                     \
        v1 ^= v2;                                                              \
        v2 = ROTL(v2, 32);                                                     \
    } while (0)

size_t SipHash_ctx_size(void)
{
    return sizeof(SIPHASH);
}

size_t SipHash_hash_size(SIPHASH *ctx)
{
    return ctx->hash_size;
}

static size_t siphash_adjust_hash_size(size_t hash_size)
{
    if (hash_size == 0)
        hash_size = SIPHASH_MAX_DIGEST_SIZE;
    return hash_size;
}

int SipHash_set_hash_size(SIPHASH *ctx, size_t hash_size)
{
    hash_size = siphash_adjust_hash_size(hash_size);
    if (hash_size != SIPHASH_MIN_DIGEST_SIZE
        && hash_size != SIPHASH_MAX_DIGEST_SIZE)
        return 0;

    /*
     * It's possible that the key was set first.  If the hash size changes,
     * we need to adjust v1 (see SipHash_Init().
     */

    /* Start by adjusting the stored size, to make things easier */
    ctx->hash_size = siphash_adjust_hash_size(ctx->hash_size);

    /* Now, adjust ctx->v1 if the old and the new size differ */
    if ((size_t)ctx->hash_size != hash_size) {
        ctx->v1 ^= 0xee;
        ctx->hash_size = hash_size;
    }
    return 1;
}

/* hash_size = crounds = drounds = 0 means SipHash24 with 16-byte output */
int SipHash_Init(SIPHASH *ctx, const unsigned char *k, int crounds, int drounds)
{
    uint64_t k0 = U8TO64_LE(k);
    uint64_t k1 = U8TO64_LE(k + 8);

    /* If the hash size wasn't set, i.e. is zero */
    ctx->hash_size = siphash_adjust_hash_size(ctx->hash_size);

    if (drounds == 0)
        drounds = SIPHASH_D_ROUNDS;
    if (crounds == 0)
        crounds = SIPHASH_C_ROUNDS;

    ctx->crounds = crounds;
    ctx->drounds = drounds;

    ctx->len = 0;
    ctx->total_inlen = 0;

    ctx->v0 = 0x736f6d6570736575ULL ^ k0;
    ctx->v1 = 0x646f72616e646f6dULL ^ k1;
    ctx->v2 = 0x6c7967656e657261ULL ^ k0;
    ctx->v3 = 0x7465646279746573ULL ^ k1;

    if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
        ctx->v1 ^= 0xee;

    return 1;
}

void SipHash_Update(SIPHASH *ctx, const unsigned char *in, size_t inlen)
{
    uint64_t m;
    const uint8_t *end;
    int left;
    unsigned int i;
    uint64_t v0 = ctx->v0;
    uint64_t v1 = ctx->v1;
    uint64_t v2 = ctx->v2;
    uint64_t v3 = ctx->v3;

    ctx->total_inlen += inlen;

    if (ctx->len) {
        /* deal with leavings */
        size_t available = SIPHASH_BLOCK_SIZE - ctx->len;

        /* not enough to fill leavings */
        if (inlen < available) {
            memcpy(&ctx->leavings[ctx->len], in, inlen);
            ctx->len += inlen;
            return;
        }

        /* copy data into leavings and reduce input */
        memcpy(&ctx->leavings[ctx->len], in, available);
        inlen -= available;
        in += available;

        /* process leavings */
        m = U8TO64_LE(ctx->leavings);
        v3 ^= m;
        for (i = 0; i < ctx->crounds; ++i)
            SIPROUND;
        v0 ^= m;
    }
    left = inlen & (SIPHASH_BLOCK_SIZE-1); /* gets put into leavings */
    end = in + inlen - left;

    for (; in != end; in += 8) {
        m = U8TO64_LE(in);
        v3 ^= m;
        for (i = 0; i < ctx->crounds; ++i)
            SIPROUND;
        v0 ^= m;
    }

    /* save leavings and other ctx */
    if (left)
        memcpy(ctx->leavings, end, left);
    ctx->len = left;

    ctx->v0 = v0;
    ctx->v1 = v1;
    ctx->v2 = v2;
    ctx->v3 = v3;
}

int SipHash_Final(SIPHASH *ctx, unsigned char *out, size_t outlen)
{
    /* finalize hash */
    unsigned int i;
    uint64_t b = ctx->total_inlen << 56;
    uint64_t v0 = ctx->v0;
    uint64_t v1 = ctx->v1;
    uint64_t v2 = ctx->v2;
    uint64_t v3 = ctx->v3;

    if (ctx->crounds == 0 || outlen == 0 || outlen != (size_t)ctx->hash_size)
        return 0;

    switch (ctx->len) {
    case 7:
        b |= ((uint64_t)ctx->leavings[6]) << 48;
        /* fall through */
    case 6:
        b |= ((uint64_t)ctx->leavings[5]) << 40;
        /* fall through */
    case 5:
        b |= ((uint64_t)ctx->leavings[4]) << 32;
        /* fall through */
    case 4:
        b |= ((uint64_t)ctx->leavings[3]) << 24;
        /* fall through */
    case 3:
        b |= ((uint64_t)ctx->leavings[2]) << 16;
        /* fall through */
    case 2:
        b |= ((uint64_t)ctx->leavings[1]) <<  8;
        /* fall through */
    case 1:
        b |= ((uint64_t)ctx->leavings[0]);
    case 0:
        break;
    }

    v3 ^= b;
    for (i = 0; i < ctx->crounds; ++i)
        SIPROUND;
    v0 ^= b;
    if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
        v2 ^= 0xee;
    else
        v2 ^= 0xff;
    for (i = 0; i < ctx->drounds; ++i)
        SIPROUND;
    b = v0 ^ v1 ^ v2  ^ v3;
    U64TO8_LE(out, b);
    if (ctx->hash_size == SIPHASH_MIN_DIGEST_SIZE)
        return 1;
    v1 ^= 0xdd;
    for (i = 0; i < ctx->drounds; ++i)
        SIPROUND;
    b = v0 ^ v1 ^ v2  ^ v3;
    U64TO8_LE(out + 8, b);
    return 1;
}

Coverage Report

Created: 2025-12-04 06:33

Line	Count	Source
1		/*
2		* Copyright 2017-2022 The OpenSSL Project Authors. All Rights Reserved.
3		*
4		* Licensed under the Apache License 2.0 (the "License"). You may not use
5		* this file except in compliance with the License. You can obtain a copy
6		* in the file LICENSE in the source distribution or at
7		* https://www.openssl.org/source/license.html
8		*/
9
10		/* Based on https://131002.net/siphash C reference implementation */
11		/*
12		SipHash reference C implementation
13
14		Copyright (c) 2012-2016 Jean-Philippe Aumasson
15		Copyright (c) 2012-2014 Daniel J. Bernstein
16
17		To the extent possible under law, the author(s) have dedicated all copyright
18		and related and neighboring rights to this software to the public domain
19		worldwide. This software is distributed without any warranty.
20
21		You should have received a copy of the CC0 Public Domain Dedication along
22		with this software. If not, see
23		<http://creativecommons.org/publicdomain/zero/1.0/>.
24		*/
25
26		#include <stdlib.h>
27		#include <string.h>
28		#include <openssl/crypto.h>
29
30		#include "crypto/siphash.h"
31
32	247M	#define ROTL(x, b) (uint64_t)(((x) << (b)) \| ((x) >> (64 - (b))))
33
34		#define U32TO8_LE(p, v) \
35	11.9M	(p)[0] = (uint8_t)((v)); \
36	11.9M	(p)[1] = (uint8_t)((v) >> 8); \
37	11.9M	(p)[2] = (uint8_t)((v) >> 16); \
38	11.9M	(p)[3] = (uint8_t)((v) >> 24);
39
40		#define U64TO8_LE(p, v) \
41	5.96M	U32TO8_LE((p), (uint32_t)((v))); \
42	5.96M	U32TO8_LE((p) + 4, (uint32_t)((v) >> 32));
43
44		#define U8TO64_LE(p) \
45	14.6M	(((uint64_t)((p)[0])) \| ((uint64_t)((p)[1]) << 8) \| \
46	14.6M	((uint64_t)((p)[2]) << 16) \| ((uint64_t)((p)[3]) << 24) \| \
47	14.6M	((uint64_t)((p)[4]) << 32) \| ((uint64_t)((p)[5]) << 40) \| \
48	14.6M	((uint64_t)((p)[6]) << 48) \| ((uint64_t)((p)[7]) << 56))
49
50		#define SIPROUND \
51	53.2M	do { \
52	41.2M	v0 += v1; \
53	41.2M	v1 = ROTL(v1, 13); \
54	41.2M	v1 ^= v0; \
55	41.2M	v0 = ROTL(v0, 32); \
56	41.2M	v2 += v3; \
57	41.2M	v3 = ROTL(v3, 16); \
58	41.2M	v3 ^= v2; \
59	41.2M	v0 += v3; \
60	41.2M	v3 = ROTL(v3, 21); \
61	41.2M	v3 ^= v0; \
62	41.2M	v2 += v1; \
63	41.2M	v1 = ROTL(v1, 17); \
64	41.2M	v1 ^= v2; \
65	41.2M	v2 = ROTL(v2, 32); \
66	41.2M	} while (0)
67
68		size_t SipHash_ctx_size(void)
69	0	{
70	0	return sizeof(SIPHASH);
71	0	}
72
73		size_t SipHash_hash_size(SIPHASH *ctx)
74	4.28k	{
75	4.28k	return ctx->hash_size;
76	4.28k	}
77
78		static size_t siphash_adjust_hash_size(size_t hash_size)
79	17.8M	{
80	17.8M	if (hash_size == 0)
81	5.96M	hash_size = SIPHASH_MAX_DIGEST_SIZE;
82	17.8M	return hash_size;
83	17.8M	}
84
85		int SipHash_set_hash_size(SIPHASH *ctx, size_t hash_size)
86	5.96M	{
87	5.96M	hash_size = siphash_adjust_hash_size(hash_size);
88	5.96M	if (hash_size != SIPHASH_MIN_DIGEST_SIZE
89	165	&& hash_size != SIPHASH_MAX_DIGEST_SIZE)
90	37	return 0;
91
92		/*
93		* It's possible that the key was set first. If the hash size changes,
94		* we need to adjust v1 (see SipHash_Init().
95		*/
96
97		/* Start by adjusting the stored size, to make things easier */
98	5.96M	ctx->hash_size = siphash_adjust_hash_size(ctx->hash_size);
99
100		/* Now, adjust ctx->v1 if the old and the new size differ */
101	5.96M	if ((size_t)ctx->hash_size != hash_size) {
102	5.96M	ctx->v1 ^= 0xee;
103	5.96M	ctx->hash_size = hash_size;
104	5.96M	}
105	5.96M	return 1;
106	5.96M	}
107
108		/* hash_size = crounds = drounds = 0 means SipHash24 with 16-byte output */
109		int SipHash_Init(SIPHASH ctx, const unsigned char k, int crounds, int drounds)
110	5.96M	{
111	5.96M	uint64_t k0 = U8TO64_LE(k);
112	5.96M	uint64_t k1 = U8TO64_LE(k + 8);
113
114		/* If the hash size wasn't set, i.e. is zero */
115	5.96M	ctx->hash_size = siphash_adjust_hash_size(ctx->hash_size);
116
117	5.96M	if (drounds == 0)
118	5.96M	drounds = SIPHASH_D_ROUNDS;
119	5.96M	if (crounds == 0)
120	5.96M	crounds = SIPHASH_C_ROUNDS;
121
122	5.96M	ctx->crounds = crounds;
123	5.96M	ctx->drounds = drounds;
124
125	5.96M	ctx->len = 0;
126	5.96M	ctx->total_inlen = 0;
127
128	5.96M	ctx->v0 = 0x736f6d6570736575ULL ^ k0;
129	5.96M	ctx->v1 = 0x646f72616e646f6dULL ^ k1;
130	5.96M	ctx->v2 = 0x6c7967656e657261ULL ^ k0;
131	5.96M	ctx->v3 = 0x7465646279746573ULL ^ k1;
132
133	5.96M	if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
134	2.17k	ctx->v1 ^= 0xee;
135
136	5.96M	return 1;
137	5.96M	}
138
139		void SipHash_Update(SIPHASH ctx, const unsigned char in, size_t inlen)
140	5.96M	{
141	5.96M	uint64_t m;
142	5.96M	const uint8_t *end;
143	5.96M	int left;
144	5.96M	unsigned int i;
145	5.96M	uint64_t v0 = ctx->v0;
146	5.96M	uint64_t v1 = ctx->v1;
147	5.96M	uint64_t v2 = ctx->v2;
148	5.96M	uint64_t v3 = ctx->v3;
149
150	5.96M	ctx->total_inlen += inlen;
151
152	5.96M	if (ctx->len) {
153		/* deal with leavings */
154	72	size_t available = SIPHASH_BLOCK_SIZE - ctx->len;
155
156		/* not enough to fill leavings */
157	72	if (inlen < available) {
158	0	memcpy(&ctx->leavings[ctx->len], in, inlen);
159	0	ctx->len += inlen;
160	0	return;
161	0	}
162
163		/* copy data into leavings and reduce input */
164	72	memcpy(&ctx->leavings[ctx->len], in, available);
165	72	inlen -= available;
166	72	in += available;
167
168		/* process leavings */
169	72	m = U8TO64_LE(ctx->leavings);
170	72	v3 ^= m;
171	216	for (i = 0; i < ctx->crounds; ++i)
172	144	SIPROUND;
173	72	v0 ^= m;
174	72	}
175	5.96M	left = inlen & (SIPHASH_BLOCK_SIZE-1); /* gets put into leavings */
176	5.96M	end = in + inlen - left;
177
178	8.71M	for (; in != end; in += 8) {
179	2.75M	m = U8TO64_LE(in);
180	2.75M	v3 ^= m;
181	8.25M	for (i = 0; i < ctx->crounds; ++i)
182	5.50M	SIPROUND;
183	2.75M	v0 ^= m;
184	2.75M	}
185
186		/* save leavings and other ctx */
187	5.96M	if (left)
188	2.59M	memcpy(ctx->leavings, end, left);
189	5.96M	ctx->len = left;
190
191	5.96M	ctx->v0 = v0;
192	5.96M	ctx->v1 = v1;
193	5.96M	ctx->v2 = v2;
194	5.96M	ctx->v3 = v3;
195	5.96M	}
196
197		int SipHash_Final(SIPHASH ctx, unsigned char out, size_t outlen)
198	5.96M	{
199		/* finalize hash */
200	5.96M	unsigned int i;
201	5.96M	uint64_t b = ctx->total_inlen << 56;
202	5.96M	uint64_t v0 = ctx->v0;
203	5.96M	uint64_t v1 = ctx->v1;
204	5.96M	uint64_t v2 = ctx->v2;
205	5.96M	uint64_t v3 = ctx->v3;
206
207	5.96M	if (ctx->crounds == 0 \|\| outlen == 0 \|\| outlen != (size_t)ctx->hash_size)
208	0	return 0;
209
210	5.96M	switch (ctx->len) {
211	94.6k	case 7:
212	94.6k	b \|= ((uint64_t)ctx->leavings[6]) << 48;
213		/* fall through */
214	211k	case 6:
215	211k	b \|= ((uint64_t)ctx->leavings[5]) << 40;
216		/* fall through */
217	378k	case 5:
218	378k	b \|= ((uint64_t)ctx->leavings[4]) << 32;
219		/* fall through */
220	744k	case 4:
221	744k	b \|= ((uint64_t)ctx->leavings[3]) << 24;
222		/* fall through */
223	1.59M	case 3:
224	1.59M	b \|= ((uint64_t)ctx->leavings[2]) << 16;
225		/* fall through */
226	1.77M	case 2:
227	1.77M	b \|= ((uint64_t)ctx->leavings[1]) << 8;
228		/* fall through */
229	2.59M	case 1:
230	2.59M	b \|= ((uint64_t)ctx->leavings[0]);
231	5.96M	case 0:
232	5.96M	break;
233	5.96M	}
234
235	5.96M	v3 ^= b;
236	17.8M	for (i = 0; i < ctx->crounds; ++i)
237	11.9M	SIPROUND;
238	5.96M	v0 ^= b;
239	5.96M	if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
240	2.14k	v2 ^= 0xee;
241	5.96M	else
242	5.96M	v2 ^= 0xff;
243	29.8M	for (i = 0; i < ctx->drounds; ++i)
244	23.8M	SIPROUND;
245	5.96M	b = v0 ^ v1 ^ v2 ^ v3;
246	5.96M	U64TO8_LE(out, b);
247	5.96M	if (ctx->hash_size == SIPHASH_MIN_DIGEST_SIZE)
248	5.96M	return 1;
249	2.14k	v1 ^= 0xdd;
250	10.7k	for (i = 0; i < ctx->drounds; ++i)
251	8.57k	SIPROUND;
252	2.14k	b = v0 ^ v1 ^ v2 ^ v3;
253	2.14k	U64TO8_LE(out + 8, b);
254	2.14k	return 1;
255	5.96M	}