1*fb3d88abSKees Cook // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
2*fb3d88abSKees Cook /* Copyright (C) 2016-2022 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
3*fb3d88abSKees Cook *
4*fb3d88abSKees Cook * Test cases for siphash.c
5*fb3d88abSKees Cook *
6*fb3d88abSKees Cook * SipHash: a fast short-input PRF
7*fb3d88abSKees Cook * https://131002.net/siphash/
8*fb3d88abSKees Cook *
9*fb3d88abSKees Cook * This implementation is specifically for SipHash2-4 for a secure PRF
10*fb3d88abSKees Cook * and HalfSipHash1-3/SipHash1-3 for an insecure PRF only suitable for
11*fb3d88abSKees Cook * hashtables.
12*fb3d88abSKees Cook */
13*fb3d88abSKees Cook
14*fb3d88abSKees Cook #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15*fb3d88abSKees Cook
16*fb3d88abSKees Cook #include <kunit/test.h>
17*fb3d88abSKees Cook #include <linux/siphash.h>
18*fb3d88abSKees Cook #include <linux/kernel.h>
19*fb3d88abSKees Cook #include <linux/string.h>
20*fb3d88abSKees Cook #include <linux/errno.h>
21*fb3d88abSKees Cook #include <linux/module.h>
22*fb3d88abSKees Cook
23*fb3d88abSKees Cook /* Test vectors taken from reference source available at:
24*fb3d88abSKees Cook * https://github.com/veorq/SipHash
25*fb3d88abSKees Cook */
26*fb3d88abSKees Cook
27*fb3d88abSKees Cook static const siphash_key_t test_key_siphash =
28*fb3d88abSKees Cook {{ 0x0706050403020100ULL, 0x0f0e0d0c0b0a0908ULL }};
29*fb3d88abSKees Cook
30*fb3d88abSKees Cook static const u64 test_vectors_siphash[64] = {
31*fb3d88abSKees Cook 0x726fdb47dd0e0e31ULL, 0x74f839c593dc67fdULL, 0x0d6c8009d9a94f5aULL,
32*fb3d88abSKees Cook 0x85676696d7fb7e2dULL, 0xcf2794e0277187b7ULL, 0x18765564cd99a68dULL,
33*fb3d88abSKees Cook 0xcbc9466e58fee3ceULL, 0xab0200f58b01d137ULL, 0x93f5f5799a932462ULL,
34*fb3d88abSKees Cook 0x9e0082df0ba9e4b0ULL, 0x7a5dbbc594ddb9f3ULL, 0xf4b32f46226bada7ULL,
35*fb3d88abSKees Cook 0x751e8fbc860ee5fbULL, 0x14ea5627c0843d90ULL, 0xf723ca908e7af2eeULL,
36*fb3d88abSKees Cook 0xa129ca6149be45e5ULL, 0x3f2acc7f57c29bdbULL, 0x699ae9f52cbe4794ULL,
37*fb3d88abSKees Cook 0x4bc1b3f0968dd39cULL, 0xbb6dc91da77961bdULL, 0xbed65cf21aa2ee98ULL,
38*fb3d88abSKees Cook 0xd0f2cbb02e3b67c7ULL, 0x93536795e3a33e88ULL, 0xa80c038ccd5ccec8ULL,
39*fb3d88abSKees Cook 0xb8ad50c6f649af94ULL, 0xbce192de8a85b8eaULL, 0x17d835b85bbb15f3ULL,
40*fb3d88abSKees Cook 0x2f2e6163076bcfadULL, 0xde4daaaca71dc9a5ULL, 0xa6a2506687956571ULL,
41*fb3d88abSKees Cook 0xad87a3535c49ef28ULL, 0x32d892fad841c342ULL, 0x7127512f72f27cceULL,
42*fb3d88abSKees Cook 0xa7f32346f95978e3ULL, 0x12e0b01abb051238ULL, 0x15e034d40fa197aeULL,
43*fb3d88abSKees Cook 0x314dffbe0815a3b4ULL, 0x027990f029623981ULL, 0xcadcd4e59ef40c4dULL,
44*fb3d88abSKees Cook 0x9abfd8766a33735cULL, 0x0e3ea96b5304a7d0ULL, 0xad0c42d6fc585992ULL,
45*fb3d88abSKees Cook 0x187306c89bc215a9ULL, 0xd4a60abcf3792b95ULL, 0xf935451de4f21df2ULL,
46*fb3d88abSKees Cook 0xa9538f0419755787ULL, 0xdb9acddff56ca510ULL, 0xd06c98cd5c0975ebULL,
47*fb3d88abSKees Cook 0xe612a3cb9ecba951ULL, 0xc766e62cfcadaf96ULL, 0xee64435a9752fe72ULL,
48*fb3d88abSKees Cook 0xa192d576b245165aULL, 0x0a8787bf8ecb74b2ULL, 0x81b3e73d20b49b6fULL,
49*fb3d88abSKees Cook 0x7fa8220ba3b2eceaULL, 0x245731c13ca42499ULL, 0xb78dbfaf3a8d83bdULL,
50*fb3d88abSKees Cook 0xea1ad565322a1a0bULL, 0x60e61c23a3795013ULL, 0x6606d7e446282b93ULL,
51*fb3d88abSKees Cook 0x6ca4ecb15c5f91e1ULL, 0x9f626da15c9625f3ULL, 0xe51b38608ef25f57ULL,
52*fb3d88abSKees Cook 0x958a324ceb064572ULL
53*fb3d88abSKees Cook };
54*fb3d88abSKees Cook
55*fb3d88abSKees Cook #if BITS_PER_LONG == 64
56*fb3d88abSKees Cook static const hsiphash_key_t test_key_hsiphash =
57*fb3d88abSKees Cook {{ 0x0706050403020100ULL, 0x0f0e0d0c0b0a0908ULL }};
58*fb3d88abSKees Cook
59*fb3d88abSKees Cook static const u32 test_vectors_hsiphash[64] = {
60*fb3d88abSKees Cook 0x050fc4dcU, 0x7d57ca93U, 0x4dc7d44dU,
61*fb3d88abSKees Cook 0xe7ddf7fbU, 0x88d38328U, 0x49533b67U,
62*fb3d88abSKees Cook 0xc59f22a7U, 0x9bb11140U, 0x8d299a8eU,
63*fb3d88abSKees Cook 0x6c063de4U, 0x92ff097fU, 0xf94dc352U,
64*fb3d88abSKees Cook 0x57b4d9a2U, 0x1229ffa7U, 0xc0f95d34U,
65*fb3d88abSKees Cook 0x2a519956U, 0x7d908b66U, 0x63dbd80cU,
66*fb3d88abSKees Cook 0xb473e63eU, 0x8d297d1cU, 0xa6cce040U,
67*fb3d88abSKees Cook 0x2b45f844U, 0xa320872eU, 0xdae6c123U,
68*fb3d88abSKees Cook 0x67349c8cU, 0x705b0979U, 0xca9913a5U,
69*fb3d88abSKees Cook 0x4ade3b35U, 0xef6cd00dU, 0x4ab1e1f4U,
70*fb3d88abSKees Cook 0x43c5e663U, 0x8c21d1bcU, 0x16a7b60dU,
71*fb3d88abSKees Cook 0x7a8ff9bfU, 0x1f2a753eU, 0xbf186b91U,
72*fb3d88abSKees Cook 0xada26206U, 0xa3c33057U, 0xae3a36a1U,
73*fb3d88abSKees Cook 0x7b108392U, 0x99e41531U, 0x3f1ad944U,
74*fb3d88abSKees Cook 0xc8138825U, 0xc28949a6U, 0xfaf8876bU,
75*fb3d88abSKees Cook 0x9f042196U, 0x68b1d623U, 0x8b5114fdU,
76*fb3d88abSKees Cook 0xdf074c46U, 0x12cc86b3U, 0x0a52098fU,
77*fb3d88abSKees Cook 0x9d292f9aU, 0xa2f41f12U, 0x43a71ed0U,
78*fb3d88abSKees Cook 0x73f0bce6U, 0x70a7e980U, 0x243c6d75U,
79*fb3d88abSKees Cook 0xfdb71513U, 0xa67d8a08U, 0xb7e8f148U,
80*fb3d88abSKees Cook 0xf7a644eeU, 0x0f1837f2U, 0x4b6694e0U,
81*fb3d88abSKees Cook 0xb7bbb3a8U
82*fb3d88abSKees Cook };
83*fb3d88abSKees Cook #else
84*fb3d88abSKees Cook static const hsiphash_key_t test_key_hsiphash =
85*fb3d88abSKees Cook {{ 0x03020100U, 0x07060504U }};
86*fb3d88abSKees Cook
87*fb3d88abSKees Cook static const u32 test_vectors_hsiphash[64] = {
88*fb3d88abSKees Cook 0x5814c896U, 0xe7e864caU, 0xbc4b0e30U,
89*fb3d88abSKees Cook 0x01539939U, 0x7e059ea6U, 0x88e3d89bU,
90*fb3d88abSKees Cook 0xa0080b65U, 0x9d38d9d6U, 0x577999b1U,
91*fb3d88abSKees Cook 0xc839caedU, 0xe4fa32cfU, 0x959246eeU,
92*fb3d88abSKees Cook 0x6b28096cU, 0x66dd9cd6U, 0x16658a7cU,
93*fb3d88abSKees Cook 0xd0257b04U, 0x8b31d501U, 0x2b1cd04bU,
94*fb3d88abSKees Cook 0x06712339U, 0x522aca67U, 0x911bb605U,
95*fb3d88abSKees Cook 0x90a65f0eU, 0xf826ef7bU, 0x62512debU,
96*fb3d88abSKees Cook 0x57150ad7U, 0x5d473507U, 0x1ec47442U,
97*fb3d88abSKees Cook 0xab64afd3U, 0x0a4100d0U, 0x6d2ce652U,
98*fb3d88abSKees Cook 0x2331b6a3U, 0x08d8791aU, 0xbc6dda8dU,
99*fb3d88abSKees Cook 0xe0f6c934U, 0xb0652033U, 0x9b9851ccU,
100*fb3d88abSKees Cook 0x7c46fb7fU, 0x732ba8cbU, 0xf142997aU,
101*fb3d88abSKees Cook 0xfcc9aa1bU, 0x05327eb2U, 0xe110131cU,
102*fb3d88abSKees Cook 0xf9e5e7c0U, 0xa7d708a6U, 0x11795ab1U,
103*fb3d88abSKees Cook 0x65671619U, 0x9f5fff91U, 0xd89c5267U,
104*fb3d88abSKees Cook 0x007783ebU, 0x95766243U, 0xab639262U,
105*fb3d88abSKees Cook 0x9c7e1390U, 0xc368dda6U, 0x38ddc455U,
106*fb3d88abSKees Cook 0xfa13d379U, 0x979ea4e8U, 0x53ecd77eU,
107*fb3d88abSKees Cook 0x2ee80657U, 0x33dbb66aU, 0xae3f0577U,
108*fb3d88abSKees Cook 0x88b4c4ccU, 0x3e7f480bU, 0x74c1ebf8U,
109*fb3d88abSKees Cook 0x87178304U
110*fb3d88abSKees Cook };
111*fb3d88abSKees Cook #endif
112*fb3d88abSKees Cook
113*fb3d88abSKees Cook #define chk(hash, vector, fmt...) \
114*fb3d88abSKees Cook KUNIT_EXPECT_EQ_MSG(test, hash, vector, fmt)
115*fb3d88abSKees Cook
siphash_test(struct kunit * test)116*fb3d88abSKees Cook static void siphash_test(struct kunit *test)
117*fb3d88abSKees Cook {
118*fb3d88abSKees Cook u8 in[64] __aligned(SIPHASH_ALIGNMENT);
119*fb3d88abSKees Cook u8 in_unaligned[65] __aligned(SIPHASH_ALIGNMENT);
120*fb3d88abSKees Cook u8 i;
121*fb3d88abSKees Cook
122*fb3d88abSKees Cook for (i = 0; i < 64; ++i) {
123*fb3d88abSKees Cook in[i] = i;
124*fb3d88abSKees Cook in_unaligned[i + 1] = i;
125*fb3d88abSKees Cook chk(siphash(in, i, &test_key_siphash),
126*fb3d88abSKees Cook test_vectors_siphash[i],
127*fb3d88abSKees Cook "siphash self-test aligned %u: FAIL", i + 1);
128*fb3d88abSKees Cook chk(siphash(in_unaligned + 1, i, &test_key_siphash),
129*fb3d88abSKees Cook test_vectors_siphash[i],
130*fb3d88abSKees Cook "siphash self-test unaligned %u: FAIL", i + 1);
131*fb3d88abSKees Cook chk(hsiphash(in, i, &test_key_hsiphash),
132*fb3d88abSKees Cook test_vectors_hsiphash[i],
133*fb3d88abSKees Cook "hsiphash self-test aligned %u: FAIL", i + 1);
134*fb3d88abSKees Cook chk(hsiphash(in_unaligned + 1, i, &test_key_hsiphash),
135*fb3d88abSKees Cook test_vectors_hsiphash[i],
136*fb3d88abSKees Cook "hsiphash self-test unaligned %u: FAIL", i + 1);
137*fb3d88abSKees Cook }
138*fb3d88abSKees Cook chk(siphash_1u64(0x0706050403020100ULL, &test_key_siphash),
139*fb3d88abSKees Cook test_vectors_siphash[8],
140*fb3d88abSKees Cook "siphash self-test 1u64: FAIL");
141*fb3d88abSKees Cook chk(siphash_2u64(0x0706050403020100ULL, 0x0f0e0d0c0b0a0908ULL,
142*fb3d88abSKees Cook &test_key_siphash),
143*fb3d88abSKees Cook test_vectors_siphash[16],
144*fb3d88abSKees Cook "siphash self-test 2u64: FAIL");
145*fb3d88abSKees Cook chk(siphash_3u64(0x0706050403020100ULL, 0x0f0e0d0c0b0a0908ULL,
146*fb3d88abSKees Cook 0x1716151413121110ULL, &test_key_siphash),
147*fb3d88abSKees Cook test_vectors_siphash[24],
148*fb3d88abSKees Cook "siphash self-test 3u64: FAIL");
149*fb3d88abSKees Cook chk(siphash_4u64(0x0706050403020100ULL, 0x0f0e0d0c0b0a0908ULL,
150*fb3d88abSKees Cook 0x1716151413121110ULL, 0x1f1e1d1c1b1a1918ULL,
151*fb3d88abSKees Cook &test_key_siphash),
152*fb3d88abSKees Cook test_vectors_siphash[32],
153*fb3d88abSKees Cook "siphash self-test 4u64: FAIL");
154*fb3d88abSKees Cook chk(siphash_1u32(0x03020100U, &test_key_siphash),
155*fb3d88abSKees Cook test_vectors_siphash[4],
156*fb3d88abSKees Cook "siphash self-test 1u32: FAIL");
157*fb3d88abSKees Cook chk(siphash_2u32(0x03020100U, 0x07060504U, &test_key_siphash),
158*fb3d88abSKees Cook test_vectors_siphash[8],
159*fb3d88abSKees Cook "siphash self-test 2u32: FAIL");
160*fb3d88abSKees Cook chk(siphash_3u32(0x03020100U, 0x07060504U,
161*fb3d88abSKees Cook 0x0b0a0908U, &test_key_siphash),
162*fb3d88abSKees Cook test_vectors_siphash[12],
163*fb3d88abSKees Cook "siphash self-test 3u32: FAIL");
164*fb3d88abSKees Cook chk(siphash_4u32(0x03020100U, 0x07060504U,
165*fb3d88abSKees Cook 0x0b0a0908U, 0x0f0e0d0cU, &test_key_siphash),
166*fb3d88abSKees Cook test_vectors_siphash[16],
167*fb3d88abSKees Cook "siphash self-test 4u32: FAIL");
168*fb3d88abSKees Cook chk(hsiphash_1u32(0x03020100U, &test_key_hsiphash),
169*fb3d88abSKees Cook test_vectors_hsiphash[4],
170*fb3d88abSKees Cook "hsiphash self-test 1u32: FAIL");
171*fb3d88abSKees Cook chk(hsiphash_2u32(0x03020100U, 0x07060504U, &test_key_hsiphash),
172*fb3d88abSKees Cook test_vectors_hsiphash[8],
173*fb3d88abSKees Cook "hsiphash self-test 2u32: FAIL");
174*fb3d88abSKees Cook chk(hsiphash_3u32(0x03020100U, 0x07060504U,
175*fb3d88abSKees Cook 0x0b0a0908U, &test_key_hsiphash),
176*fb3d88abSKees Cook test_vectors_hsiphash[12],
177*fb3d88abSKees Cook "hsiphash self-test 3u32: FAIL");
178*fb3d88abSKees Cook chk(hsiphash_4u32(0x03020100U, 0x07060504U,
179*fb3d88abSKees Cook 0x0b0a0908U, 0x0f0e0d0cU, &test_key_hsiphash),
180*fb3d88abSKees Cook test_vectors_hsiphash[16],
181*fb3d88abSKees Cook "hsiphash self-test 4u32: FAIL");
182*fb3d88abSKees Cook }
183*fb3d88abSKees Cook
184*fb3d88abSKees Cook static struct kunit_case siphash_test_cases[] = {
185*fb3d88abSKees Cook KUNIT_CASE(siphash_test),
186*fb3d88abSKees Cook {}
187*fb3d88abSKees Cook };
188*fb3d88abSKees Cook
189*fb3d88abSKees Cook static struct kunit_suite siphash_test_suite = {
190*fb3d88abSKees Cook .name = "siphash",
191*fb3d88abSKees Cook .test_cases = siphash_test_cases,
192*fb3d88abSKees Cook };
193*fb3d88abSKees Cook
194*fb3d88abSKees Cook kunit_test_suite(siphash_test_suite);
195*fb3d88abSKees Cook
196*fb3d88abSKees Cook MODULE_AUTHOR("Jason A. Donenfeld <Jason@zx2c4.com>");
197*fb3d88abSKees Cook MODULE_LICENSE("Dual BSD/GPL");
198