Coverage Report

Created: 2026-04-09 06:50

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl36/crypto/siphash/siphash.c
Line
Count
Source
1
/*
2
 * Copyright 2017-2025 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
296M
#define ROTL(x, b) (uint64_t)(((x) << (b)) | ((x) >> (64 - (b))))
33
34
#define U32TO8_LE(p, v)            \
35
14.8M
    (p)[0] = (uint8_t)((v));       \
36
14.8M
    (p)[1] = (uint8_t)((v) >> 8);  \
37
14.8M
    (p)[2] = (uint8_t)((v) >> 16); \
38
14.8M
    (p)[3] = (uint8_t)((v) >> 24);
39
40
#define U64TO8_LE(p, v)              \
41
7.40M
    U32TO8_LE((p), (uint32_t)((v))); \
42
7.40M
    U32TO8_LE((p) + 4, (uint32_t)((v) >> 32));
43
44
#define U8TO64_LE(p) \
45
17.2M
    (((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))
46
47
#define SIPROUND           \
48
64.1M
    do {                   \
49
49.3M
        v0 += v1;          \
50
49.3M
        v1 = ROTL(v1, 13); \
51
49.3M
        v1 ^= v0;          \
52
49.3M
        v0 = ROTL(v0, 32); \
53
49.3M
        v2 += v3;          \
54
49.3M
        v3 = ROTL(v3, 16); \
55
49.3M
        v3 ^= v2;          \
56
49.3M
        v0 += v3;          \
57
49.3M
        v3 = ROTL(v3, 21); \
58
49.3M
        v3 ^= v0;          \
59
49.3M
        v2 += v1;          \
60
49.3M
        v1 = ROTL(v1, 17); \
61
49.3M
        v1 ^= v2;          \
62
49.3M
        v2 = ROTL(v2, 32); \
63
49.3M
    } while (0)
64
65
size_t SipHash_ctx_size(void)
66
0
{
67
0
    return sizeof(SIPHASH);
68
0
}
69
70
size_t SipHash_hash_size(SIPHASH *ctx)
71
4.28k
{
72
4.28k
    return ctx->hash_size;
73
4.28k
}
74
75
static size_t siphash_adjust_hash_size(size_t hash_size)
76
22.2M
{
77
22.2M
    if (hash_size == 0)
78
7.40M
        hash_size = SIPHASH_MAX_DIGEST_SIZE;
79
22.2M
    return hash_size;
80
22.2M
}
81
82
int SipHash_set_hash_size(SIPHASH *ctx, size_t hash_size)
83
7.40M
{
84
7.40M
    hash_size = siphash_adjust_hash_size(hash_size);
85
7.40M
    if (hash_size != SIPHASH_MIN_DIGEST_SIZE
86
177
        && hash_size != SIPHASH_MAX_DIGEST_SIZE)
87
37
        return 0;
88
89
    /*
90
     * It's possible that the key was set first.  If the hash size changes,
91
     * we need to adjust v1 (see SipHash_Init().
92
     */
93
94
    /* Start by adjusting the stored size, to make things easier */
95
7.40M
    ctx->hash_size = (unsigned int)siphash_adjust_hash_size(ctx->hash_size);
96
97
    /* Now, adjust ctx->v1 if the old and the new size differ */
98
7.40M
    if ((size_t)ctx->hash_size != hash_size) {
99
7.40M
        ctx->v1 ^= 0xee;
100
7.40M
        ctx->hash_size = (unsigned int)hash_size;
101
7.40M
    }
102
7.40M
    return 1;
103
7.40M
}
104
105
/* hash_size = crounds = drounds = 0 means SipHash24 with 16-byte output */
106
int SipHash_Init(SIPHASH *ctx, const unsigned char *k, int crounds, int drounds)
107
7.40M
{
108
7.40M
    uint64_t k0 = U8TO64_LE(k);
109
7.40M
    uint64_t k1 = U8TO64_LE(k + 8);
110
111
    /* If the hash size wasn't set, i.e. is zero */
112
7.40M
    ctx->hash_size = (unsigned int)siphash_adjust_hash_size(ctx->hash_size);
113
114
7.40M
    if (drounds == 0)
115
7.40M
        drounds = SIPHASH_D_ROUNDS;
116
7.40M
    if (crounds == 0)
117
7.40M
        crounds = SIPHASH_C_ROUNDS;
118
119
7.40M
    ctx->crounds = crounds;
120
7.40M
    ctx->drounds = drounds;
121
122
7.40M
    ctx->len = 0;
123
7.40M
    ctx->total_inlen = 0;
124
125
7.40M
    ctx->v0 = 0x736f6d6570736575ULL ^ k0;
126
7.40M
    ctx->v1 = 0x646f72616e646f6dULL ^ k1;
127
7.40M
    ctx->v2 = 0x6c7967656e657261ULL ^ k0;
128
7.40M
    ctx->v3 = 0x7465646279746573ULL ^ k1;
129
130
7.40M
    if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
131
2.17k
        ctx->v1 ^= 0xee;
132
133
7.40M
    return 1;
134
7.40M
}
135
136
void SipHash_Update(SIPHASH *ctx, const unsigned char *in, size_t inlen)
137
7.40M
{
138
7.40M
    uint64_t m;
139
7.40M
    const uint8_t *end;
140
7.40M
    int left;
141
7.40M
    unsigned int i;
142
7.40M
    uint64_t v0 = ctx->v0;
143
7.40M
    uint64_t v1 = ctx->v1;
144
7.40M
    uint64_t v2 = ctx->v2;
145
7.40M
    uint64_t v3 = ctx->v3;
146
147
7.40M
    ctx->total_inlen += inlen;
148
149
7.40M
    if (ctx->len) {
150
        /* deal with leavings */
151
70
        size_t available = SIPHASH_BLOCK_SIZE - ctx->len;
152
153
        /* not enough to fill leavings */
154
70
        if (inlen < available) {
155
0
            memcpy(&ctx->leavings[ctx->len], in, inlen);
156
0
            ctx->len += (unsigned int)inlen;
157
0
            return;
158
0
        }
159
160
        /* copy data into leavings and reduce input */
161
70
        memcpy(&ctx->leavings[ctx->len], in, available);
162
70
        inlen -= available;
163
70
        in += available;
164
165
        /* process leavings */
166
70
        m = U8TO64_LE(ctx->leavings);
167
70
        v3 ^= m;
168
210
        for (i = 0; i < ctx->crounds; ++i)
169
140
            SIPROUND;
170
70
        v0 ^= m;
171
70
    }
172
7.40M
    left = inlen & (SIPHASH_BLOCK_SIZE - 1); /* gets put into leavings */
173
7.40M
    end = in + inlen - left;
174
175
9.86M
    for (; in != end; in += 8) {
176
2.45M
        m = U8TO64_LE(in);
177
2.45M
        v3 ^= m;
178
7.37M
        for (i = 0; i < ctx->crounds; ++i)
179
4.91M
            SIPROUND;
180
2.45M
        v0 ^= m;
181
2.45M
    }
182
183
    /* save leavings and other ctx */
184
7.40M
    if (left)
185
3.06M
        memcpy(ctx->leavings, end, left);
186
7.40M
    ctx->len = left;
187
188
7.40M
    ctx->v0 = v0;
189
7.40M
    ctx->v1 = v1;
190
7.40M
    ctx->v2 = v2;
191
7.40M
    ctx->v3 = v3;
192
7.40M
}
193
194
int SipHash_Final(SIPHASH *ctx, unsigned char *out, size_t outlen)
195
7.40M
{
196
    /* finalize hash */
197
7.40M
    unsigned int i;
198
7.40M
    uint64_t b = ctx->total_inlen << 56;
199
7.40M
    uint64_t v0 = ctx->v0;
200
7.40M
    uint64_t v1 = ctx->v1;
201
7.40M
    uint64_t v2 = ctx->v2;
202
7.40M
    uint64_t v3 = ctx->v3;
203
204
7.40M
    if (ctx->crounds == 0 || outlen == 0 || outlen != (size_t)ctx->hash_size)
205
0
        return 0;
206
207
7.40M
    switch (ctx->len) {
208
120k
    case 7:
209
120k
        b |= ((uint64_t)ctx->leavings[6]) << 48;
210
        /* fall through */
211
341k
    case 6:
212
341k
        b |= ((uint64_t)ctx->leavings[5]) << 40;
213
        /* fall through */
214
589k
    case 5:
215
589k
        b |= ((uint64_t)ctx->leavings[4]) << 32;
216
        /* fall through */
217
898k
    case 4:
218
898k
        b |= ((uint64_t)ctx->leavings[3]) << 24;
219
        /* fall through */
220
2.18M
    case 3:
221
2.18M
        b |= ((uint64_t)ctx->leavings[2]) << 16;
222
        /* fall through */
223
2.37M
    case 2:
224
2.37M
        b |= ((uint64_t)ctx->leavings[1]) << 8;
225
        /* fall through */
226
3.06M
    case 1:
227
3.06M
        b |= ((uint64_t)ctx->leavings[0]);
228
7.40M
    case 0:
229
7.40M
        break;
230
7.40M
    }
231
232
7.40M
    v3 ^= b;
233
22.2M
    for (i = 0; i < ctx->crounds; ++i)
234
14.8M
        SIPROUND;
235
7.40M
    v0 ^= b;
236
7.40M
    if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
237
2.14k
        v2 ^= 0xee;
238
7.40M
    else
239
7.40M
        v2 ^= 0xff;
240
37.0M
    for (i = 0; i < ctx->drounds; ++i)
241
29.6M
        SIPROUND;
242
7.40M
    b = v0 ^ v1 ^ v2 ^ v3;
243
7.40M
    U64TO8_LE(out, b);
244
7.40M
    if (ctx->hash_size == SIPHASH_MIN_DIGEST_SIZE)
245
7.40M
        return 1;
246
2.14k
    v1 ^= 0xdd;
247
10.7k
    for (i = 0; i < ctx->drounds; ++i)
248
8.56k
        SIPROUND;
249
2.14k
    b = v0 ^ v1 ^ v2 ^ v3;
250
2.14k
    U64TO8_LE(out + 8, b);
251
2.14k
    return 1;
252
7.40M
}