1 /* SPDX-License-Identifier: (GPL-2.0-only OR B !! 1 /* Copyright (C) 2016 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
2 /* Copyright (C) 2016-2022 Jason A. Donenfeld !! 2 *
>> 3 * This file is provided under a dual BSD/GPLv2 license.
3 * 4 *
4 * SipHash: a fast short-input PRF 5 * SipHash: a fast short-input PRF
5 * https://131002.net/siphash/ 6 * https://131002.net/siphash/
6 * 7 *
7 * This implementation is specifically for Sip 8 * This implementation is specifically for SipHash2-4 for a secure PRF
8 * and HalfSipHash1-3/SipHash1-3 for an insecu 9 * and HalfSipHash1-3/SipHash1-3 for an insecure PRF only suitable for
9 * hashtables. 10 * hashtables.
10 */ 11 */
11 12
12 #ifndef _LINUX_SIPHASH_H 13 #ifndef _LINUX_SIPHASH_H
13 #define _LINUX_SIPHASH_H 14 #define _LINUX_SIPHASH_H
14 15
15 #include <linux/types.h> 16 #include <linux/types.h>
16 #include <linux/kernel.h> 17 #include <linux/kernel.h>
17 18
18 #define SIPHASH_ALIGNMENT __alignof__(u64) 19 #define SIPHASH_ALIGNMENT __alignof__(u64)
19 typedef struct { 20 typedef struct {
20 u64 key[2]; 21 u64 key[2];
21 } siphash_key_t; 22 } siphash_key_t;
22 <<
23 #define siphash_aligned_key_t siphash_key_t __ <<
24 23
25 static inline bool siphash_key_is_zero(const s 24 static inline bool siphash_key_is_zero(const siphash_key_t *key)
26 { 25 {
27 return !(key->key[0] | key->key[1]); 26 return !(key->key[0] | key->key[1]);
28 } 27 }
29 28
30 u64 __siphash_aligned(const void *data, size_t 29 u64 __siphash_aligned(const void *data, size_t len, const siphash_key_t *key);
31 u64 __siphash_unaligned(const void *data, size 30 u64 __siphash_unaligned(const void *data, size_t len, const siphash_key_t *key);
32 31
33 u64 siphash_1u64(const u64 a, const siphash_ke 32 u64 siphash_1u64(const u64 a, const siphash_key_t *key);
34 u64 siphash_2u64(const u64 a, const u64 b, con 33 u64 siphash_2u64(const u64 a, const u64 b, const siphash_key_t *key);
35 u64 siphash_3u64(const u64 a, const u64 b, con 34 u64 siphash_3u64(const u64 a, const u64 b, const u64 c,
36 const siphash_key_t *key); 35 const siphash_key_t *key);
37 u64 siphash_4u64(const u64 a, const u64 b, con 36 u64 siphash_4u64(const u64 a, const u64 b, const u64 c, const u64 d,
38 const siphash_key_t *key); 37 const siphash_key_t *key);
39 u64 siphash_1u32(const u32 a, const siphash_ke 38 u64 siphash_1u32(const u32 a, const siphash_key_t *key);
40 u64 siphash_3u32(const u32 a, const u32 b, con 39 u64 siphash_3u32(const u32 a, const u32 b, const u32 c,
41 const siphash_key_t *key); 40 const siphash_key_t *key);
42 41
43 static inline u64 siphash_2u32(const u32 a, co 42 static inline u64 siphash_2u32(const u32 a, const u32 b,
44 const siphash_k 43 const siphash_key_t *key)
45 { 44 {
46 return siphash_1u64((u64)b << 32 | a, 45 return siphash_1u64((u64)b << 32 | a, key);
47 } 46 }
48 static inline u64 siphash_4u32(const u32 a, co 47 static inline u64 siphash_4u32(const u32 a, const u32 b, const u32 c,
49 const u32 d, co 48 const u32 d, const siphash_key_t *key)
50 { 49 {
51 return siphash_2u64((u64)b << 32 | a, 50 return siphash_2u64((u64)b << 32 | a, (u64)d << 32 | c, key);
52 } 51 }
53 52
54 53
55 static inline u64 ___siphash_aligned(const __l 54 static inline u64 ___siphash_aligned(const __le64 *data, size_t len,
56 const sip 55 const siphash_key_t *key)
57 { 56 {
58 if (__builtin_constant_p(len) && len = 57 if (__builtin_constant_p(len) && len == 4)
59 return siphash_1u32(le32_to_cp 58 return siphash_1u32(le32_to_cpup((const __le32 *)data), key);
60 if (__builtin_constant_p(len) && len = 59 if (__builtin_constant_p(len) && len == 8)
61 return siphash_1u64(le64_to_cp 60 return siphash_1u64(le64_to_cpu(data[0]), key);
62 if (__builtin_constant_p(len) && len = 61 if (__builtin_constant_p(len) && len == 16)
63 return siphash_2u64(le64_to_cp 62 return siphash_2u64(le64_to_cpu(data[0]), le64_to_cpu(data[1]),
64 key); 63 key);
65 if (__builtin_constant_p(len) && len = 64 if (__builtin_constant_p(len) && len == 24)
66 return siphash_3u64(le64_to_cp 65 return siphash_3u64(le64_to_cpu(data[0]), le64_to_cpu(data[1]),
67 le64_to_cp 66 le64_to_cpu(data[2]), key);
68 if (__builtin_constant_p(len) && len = 67 if (__builtin_constant_p(len) && len == 32)
69 return siphash_4u64(le64_to_cp 68 return siphash_4u64(le64_to_cpu(data[0]), le64_to_cpu(data[1]),
70 le64_to_cp 69 le64_to_cpu(data[2]), le64_to_cpu(data[3]),
71 key); 70 key);
72 return __siphash_aligned(data, len, ke 71 return __siphash_aligned(data, len, key);
73 } 72 }
74 73
75 /** 74 /**
76 * siphash - compute 64-bit siphash PRF value 75 * siphash - compute 64-bit siphash PRF value
77 * @data: buffer to hash 76 * @data: buffer to hash
78 * @size: size of @data 77 * @size: size of @data
79 * @key: the siphash key 78 * @key: the siphash key
80 */ 79 */
81 static inline u64 siphash(const void *data, si 80 static inline u64 siphash(const void *data, size_t len,
82 const siphash_key_t 81 const siphash_key_t *key)
83 { 82 {
84 if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_U 83 if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) ||
85 !IS_ALIGNED((unsigned long)data, S 84 !IS_ALIGNED((unsigned long)data, SIPHASH_ALIGNMENT))
86 return __siphash_unaligned(dat 85 return __siphash_unaligned(data, len, key);
87 return ___siphash_aligned(data, len, k 86 return ___siphash_aligned(data, len, key);
88 } 87 }
89 88
90 #define HSIPHASH_ALIGNMENT __alignof__(unsigne 89 #define HSIPHASH_ALIGNMENT __alignof__(unsigned long)
91 typedef struct { 90 typedef struct {
92 unsigned long key[2]; 91 unsigned long key[2];
93 } hsiphash_key_t; 92 } hsiphash_key_t;
94 93
95 u32 __hsiphash_aligned(const void *data, size_ 94 u32 __hsiphash_aligned(const void *data, size_t len,
96 const hsiphash_key_t *k 95 const hsiphash_key_t *key);
97 u32 __hsiphash_unaligned(const void *data, siz 96 u32 __hsiphash_unaligned(const void *data, size_t len,
98 const hsiphash_key_t 97 const hsiphash_key_t *key);
99 98
100 u32 hsiphash_1u32(const u32 a, const hsiphash_ 99 u32 hsiphash_1u32(const u32 a, const hsiphash_key_t *key);
101 u32 hsiphash_2u32(const u32 a, const u32 b, co 100 u32 hsiphash_2u32(const u32 a, const u32 b, const hsiphash_key_t *key);
102 u32 hsiphash_3u32(const u32 a, const u32 b, co 101 u32 hsiphash_3u32(const u32 a, const u32 b, const u32 c,
103 const hsiphash_key_t *key); 102 const hsiphash_key_t *key);
104 u32 hsiphash_4u32(const u32 a, const u32 b, co 103 u32 hsiphash_4u32(const u32 a, const u32 b, const u32 c, const u32 d,
105 const hsiphash_key_t *key); 104 const hsiphash_key_t *key);
106 105
107 static inline u32 ___hsiphash_aligned(const __ 106 static inline u32 ___hsiphash_aligned(const __le32 *data, size_t len,
108 const hs 107 const hsiphash_key_t *key)
109 { 108 {
110 if (__builtin_constant_p(len) && len = 109 if (__builtin_constant_p(len) && len == 4)
111 return hsiphash_1u32(le32_to_c 110 return hsiphash_1u32(le32_to_cpu(data[0]), key);
112 if (__builtin_constant_p(len) && len = 111 if (__builtin_constant_p(len) && len == 8)
113 return hsiphash_2u32(le32_to_c 112 return hsiphash_2u32(le32_to_cpu(data[0]), le32_to_cpu(data[1]),
114 key); 113 key);
115 if (__builtin_constant_p(len) && len = 114 if (__builtin_constant_p(len) && len == 12)
116 return hsiphash_3u32(le32_to_c 115 return hsiphash_3u32(le32_to_cpu(data[0]), le32_to_cpu(data[1]),
117 le32_to_c 116 le32_to_cpu(data[2]), key);
118 if (__builtin_constant_p(len) && len = 117 if (__builtin_constant_p(len) && len == 16)
119 return hsiphash_4u32(le32_to_c 118 return hsiphash_4u32(le32_to_cpu(data[0]), le32_to_cpu(data[1]),
120 le32_to_c 119 le32_to_cpu(data[2]), le32_to_cpu(data[3]),
121 key); 120 key);
122 return __hsiphash_aligned(data, len, k 121 return __hsiphash_aligned(data, len, key);
123 } 122 }
124 123
125 /** 124 /**
126 * hsiphash - compute 32-bit hsiphash PRF valu 125 * hsiphash - compute 32-bit hsiphash PRF value
127 * @data: buffer to hash 126 * @data: buffer to hash
128 * @size: size of @data 127 * @size: size of @data
129 * @key: the hsiphash key 128 * @key: the hsiphash key
130 */ 129 */
131 static inline u32 hsiphash(const void *data, s 130 static inline u32 hsiphash(const void *data, size_t len,
132 const hsiphash_key_ 131 const hsiphash_key_t *key)
133 { 132 {
134 if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_U 133 if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) ||
135 !IS_ALIGNED((unsigned long)data, H 134 !IS_ALIGNED((unsigned long)data, HSIPHASH_ALIGNMENT))
136 return __hsiphash_unaligned(da 135 return __hsiphash_unaligned(data, len, key);
137 return ___hsiphash_aligned(data, len, 136 return ___hsiphash_aligned(data, len, key);
138 } 137 }
139 138
140 /* 139 /*
141 * These macros expose the raw SipHash and Hal 140 * These macros expose the raw SipHash and HalfSipHash permutations.
142 * Do not use them directly! If you think you 141 * Do not use them directly! If you think you have a use for them,
143 * be sure to CC the maintainer of this file e 142 * be sure to CC the maintainer of this file explaining why.
144 */ 143 */
145 144
146 #define SIPHASH_PERMUTATION(a, b, c, d) ( \ 145 #define SIPHASH_PERMUTATION(a, b, c, d) ( \
147 (a) += (b), (b) = rol64((b), 13), (b) 146 (a) += (b), (b) = rol64((b), 13), (b) ^= (a), (a) = rol64((a), 32), \
148 (c) += (d), (d) = rol64((d), 16), (d) 147 (c) += (d), (d) = rol64((d), 16), (d) ^= (c), \
149 (a) += (d), (d) = rol64((d), 21), (d) 148 (a) += (d), (d) = rol64((d), 21), (d) ^= (a), \
150 (c) += (b), (b) = rol64((b), 17), (b) 149 (c) += (b), (b) = rol64((b), 17), (b) ^= (c), (c) = rol64((c), 32))
151 150
152 #define SIPHASH_CONST_0 0x736f6d6570736575ULL 151 #define SIPHASH_CONST_0 0x736f6d6570736575ULL
153 #define SIPHASH_CONST_1 0x646f72616e646f6dULL 152 #define SIPHASH_CONST_1 0x646f72616e646f6dULL
154 #define SIPHASH_CONST_2 0x6c7967656e657261ULL 153 #define SIPHASH_CONST_2 0x6c7967656e657261ULL
155 #define SIPHASH_CONST_3 0x7465646279746573ULL 154 #define SIPHASH_CONST_3 0x7465646279746573ULL
156 155
157 #define HSIPHASH_PERMUTATION(a, b, c, d) ( \ 156 #define HSIPHASH_PERMUTATION(a, b, c, d) ( \
158 (a) += (b), (b) = rol32((b), 5), (b) ^ 157 (a) += (b), (b) = rol32((b), 5), (b) ^= (a), (a) = rol32((a), 16), \
159 (c) += (d), (d) = rol32((d), 8), (d) ^ 158 (c) += (d), (d) = rol32((d), 8), (d) ^= (c), \
160 (a) += (d), (d) = rol32((d), 7), (d) ^ 159 (a) += (d), (d) = rol32((d), 7), (d) ^= (a), \
161 (c) += (b), (b) = rol32((b), 13), (b) 160 (c) += (b), (b) = rol32((b), 13), (b) ^= (c), (c) = rol32((c), 16))
162 161
163 #define HSIPHASH_CONST_0 0U 162 #define HSIPHASH_CONST_0 0U
164 #define HSIPHASH_CONST_1 0U 163 #define HSIPHASH_CONST_1 0U
165 #define HSIPHASH_CONST_2 0x6c796765U 164 #define HSIPHASH_CONST_2 0x6c796765U
166 #define HSIPHASH_CONST_3 0x74656462U 165 #define HSIPHASH_CONST_3 0x74656462U
167 166
168 #endif /* _LINUX_SIPHASH_H */ 167 #endif /* _LINUX_SIPHASH_H */
169 168
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.