Coverage Report

Created: 2026-07-12 07:21

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl30/crypto/siphash/siphash.c
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
265M
#define ROTL(x, b) (uint64_t)(((x) << (b)) | ((x) >> (64 - (b))))
33
34
#define U32TO8_LE(p, v)            \
35
13.3M
    (p)[0] = (uint8_t)((v));       \
36
13.3M
    (p)[1] = (uint8_t)((v) >> 8);  \
37
13.3M
    (p)[2] = (uint8_t)((v) >> 16); \
38
13.3M
    (p)[3] = (uint8_t)((v) >> 24);
39
40
#define U64TO8_LE(p, v)              \
41
6.66M
    U32TO8_LE((p), (uint32_t)((v))); \
42
6.66M
    U32TO8_LE((p) + 4, (uint32_t)((v) >> 32));
43
44
#define U8TO64_LE(p) \
45
15.4M
    (((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
57.6M
    do {                   \
49
44.3M
        v0 += v1;          \
50
44.3M
        v1 = ROTL(v1, 13); \
51
44.3M
        v1 ^= v0;          \
52
44.3M
        v0 = ROTL(v0, 32); \
53
44.3M
        v2 += v3;          \
54
44.3M
        v3 = ROTL(v3, 16); \
55
44.3M
        v3 ^= v2;          \
56
44.3M
        v0 += v3;          \
57
44.3M
        v3 = ROTL(v3, 21); \
58
44.3M
        v3 ^= v0;          \
59
44.3M
        v2 += v1;          \
60
44.3M
        v1 = ROTL(v1, 17); \
61
44.3M
        v1 ^= v2;          \
62
44.3M
        v2 = ROTL(v2, 32); \
63
44.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
5.35k
{
72
5.35k
    return ctx->hash_size;
73
5.35k
}
74
75
static size_t siphash_adjust_hash_size(size_t hash_size)
76
19.9M
{
77
19.9M
    if (hash_size == 0)
78
6.66M
        hash_size = SIPHASH_MAX_DIGEST_SIZE;
79
19.9M
    return hash_size;
80
19.9M
}
81
82
int SipHash_set_hash_size(SIPHASH *ctx, size_t hash_size)
83
6.66M
{
84
6.66M
    hash_size = siphash_adjust_hash_size(hash_size);
85
6.66M
    if (hash_size != SIPHASH_MIN_DIGEST_SIZE
86
137
        && 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
6.66M
    ctx->hash_size = siphash_adjust_hash_size(ctx->hash_size);
96
97
    /* Now, adjust ctx->v1 if the old and the new size differ */
98
6.66M
    if ((size_t)ctx->hash_size != hash_size) {
99
6.66M
        ctx->v1 ^= 0xee;
100
6.66M
        ctx->hash_size = hash_size;
101
6.66M
    }
102
6.66M
    return 1;
103
6.66M
}
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
6.66M
{
108
6.66M
    uint64_t k0 = U8TO64_LE(k);
109
6.66M
    uint64_t k1 = U8TO64_LE(k + 8);
110
111
    /* If the hash size wasn't set, i.e. is zero */
112
6.66M
    ctx->hash_size = siphash_adjust_hash_size(ctx->hash_size);
113
114
6.66M
    if (drounds == 0)
115
6.66M
        drounds = SIPHASH_D_ROUNDS;
116
6.66M
    if (crounds == 0)
117
6.66M
        crounds = SIPHASH_C_ROUNDS;
118
119
6.66M
    ctx->crounds = crounds;
120
6.66M
    ctx->drounds = drounds;
121
122
6.66M
    ctx->len = 0;
123
6.66M
    ctx->total_inlen = 0;
124
125
6.66M
    ctx->v0 = 0x736f6d6570736575ULL ^ k0;
126
6.66M
    ctx->v1 = 0x646f72616e646f6dULL ^ k1;
127
6.66M
    ctx->v2 = 0x6c7967656e657261ULL ^ k0;
128
6.66M
    ctx->v3 = 0x7465646279746573ULL ^ k1;
129
130
6.66M
    if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
131
2.69k
        ctx->v1 ^= 0xee;
132
133
6.66M
    return 1;
134
6.66M
}
135
136
void SipHash_Update(SIPHASH *ctx, const unsigned char *in, size_t inlen)
137
6.66M
{
138
6.66M
    uint64_t m;
139
6.66M
    const uint8_t *end;
140
6.66M
    int left;
141
6.66M
    unsigned int i;
142
6.66M
    uint64_t v0 = ctx->v0;
143
6.66M
    uint64_t v1 = ctx->v1;
144
6.66M
    uint64_t v2 = ctx->v2;
145
6.66M
    uint64_t v3 = ctx->v3;
146
147
6.66M
    ctx->total_inlen += inlen;
148
149
6.66M
    if (ctx->len) {
150
        /* deal with leavings */
151
88
        size_t available = SIPHASH_BLOCK_SIZE - ctx->len;
152
153
        /* not enough to fill leavings */
154
88
        if (inlen < available) {
155
0
            memcpy(&ctx->leavings[ctx->len], in, inlen);
156
0
            ctx->len += inlen;
157
0
            return;
158
0
        }
159
160
        /* copy data into leavings and reduce input */
161
88
        memcpy(&ctx->leavings[ctx->len], in, available);
162
88
        inlen -= available;
163
88
        in += available;
164
165
        /* process leavings */
166
88
        m = U8TO64_LE(ctx->leavings);
167
88
        v3 ^= m;
168
264
        for (i = 0; i < ctx->crounds; ++i)
169
176
            SIPROUND;
170
88
        v0 ^= m;
171
88
    }
172
6.66M
    left = inlen & (SIPHASH_BLOCK_SIZE - 1); /* gets put into leavings */
173
6.66M
    end = in + inlen - left;
174
175
8.82M
    for (; in != end; in += 8) {
176
2.15M
        m = U8TO64_LE(in);
177
2.15M
        v3 ^= m;
178
6.46M
        for (i = 0; i < ctx->crounds; ++i)
179
4.31M
            SIPROUND;
180
2.15M
        v0 ^= m;
181
2.15M
    }
182
183
    /* save leavings and other ctx */
184
6.66M
    if (left)
185
3.04M
        memcpy(ctx->leavings, end, left);
186
6.66M
    ctx->len = left;
187
188
6.66M
    ctx->v0 = v0;
189
6.66M
    ctx->v1 = v1;
190
6.66M
    ctx->v2 = v2;
191
6.66M
    ctx->v3 = v3;
192
6.66M
}
193
194
int SipHash_Final(SIPHASH *ctx, unsigned char *out, size_t outlen)
195
6.66M
{
196
    /* finalize hash */
197
6.66M
    unsigned int i;
198
6.66M
    uint64_t b = ctx->total_inlen << 56;
199
6.66M
    uint64_t v0 = ctx->v0;
200
6.66M
    uint64_t v1 = ctx->v1;
201
6.66M
    uint64_t v2 = ctx->v2;
202
6.66M
    uint64_t v3 = ctx->v3;
203
204
6.66M
    if (ctx->crounds == 0 || outlen == 0 || outlen != (size_t)ctx->hash_size)
205
0
        return 0;
206
207
6.66M
    switch (ctx->len) {
208
56.6k
    case 7:
209
56.6k
        b |= ((uint64_t)ctx->leavings[6]) << 48;
210
        /* fall thru */
211
300k
    case 6:
212
300k
        b |= ((uint64_t)ctx->leavings[5]) << 40;
213
        /* fall thru */
214
449k
    case 5:
215
449k
        b |= ((uint64_t)ctx->leavings[4]) << 32;
216
        /* fall thru */
217
757k
    case 4:
218
757k
        b |= ((uint64_t)ctx->leavings[3]) << 24;
219
        /* fall thru */
220
2.17M
    case 3:
221
2.17M
        b |= ((uint64_t)ctx->leavings[2]) << 16;
222
        /* fall thru */
223
2.29M
    case 2:
224
2.29M
        b |= ((uint64_t)ctx->leavings[1]) << 8;
225
        /* fall thru */
226
3.04M
    case 1:
227
3.04M
        b |= ((uint64_t)ctx->leavings[0]);
228
6.66M
    case 0:
229
6.66M
        break;
230
6.66M
    }
231
232
6.66M
    v3 ^= b;
233
20.0M
    for (i = 0; i < ctx->crounds; ++i)
234
13.3M
        SIPROUND;
235
6.66M
    v0 ^= b;
236
6.66M
    if (ctx->hash_size == SIPHASH_MAX_DIGEST_SIZE)
237
2.67k
        v2 ^= 0xee;
238
6.66M
    else
239
6.66M
        v2 ^= 0xff;
240
33.3M
    for (i = 0; i < ctx->drounds; ++i)
241
26.6M
        SIPROUND;
242
6.66M
    b = v0 ^ v1 ^ v2 ^ v3;
243
6.66M
    U64TO8_LE(out, b);
244
6.66M
    if (ctx->hash_size == SIPHASH_MIN_DIGEST_SIZE)
245
6.66M
        return 1;
246
2.67k
    v1 ^= 0xdd;
247
13.3k
    for (i = 0; i < ctx->drounds; ++i)
248
10.7k
        SIPROUND;
249
2.67k
    b = v0 ^ v1 ^ v2 ^ v3;
250
2.67k
    U64TO8_LE(out + 8, b);
251
2.67k
    return 1;
252
6.66M
}