1 /*
2 * Internal definitions for Skein hashing.
3 * Source code author: Doug Whiting, 2008.
4 * This algorithm and source code is released to the public domain.
5 *
6 * The following compile-time switches may be defined to control some
7 * tradeoffs between speed, code size, error checking, and security.
8 *
9 * The "default" note explains what happens when the switch is not defined.
10 *
11 * SKEIN_DEBUG -- make callouts from inside Skein code
12 * to examine/display intermediate values.
13 * [default: no callouts (no overhead)]
14 *
15 * SKEIN_ERR_CHECK -- how error checking is handled inside Skein
16 * code. If not defined, most error checking
17 * is disabled (for performance). Otherwise,
18 * the switch value is interpreted as:
19 * 0: use assert() to flag errors
20 * 1: return SKEIN_FAIL to flag errors
21 */
22 /* Copyright 2013 Doug Whiting. This code is released to the public domain. */
23
24 #ifndef _SKEIN_IMPL_H_
25 #define _SKEIN_IMPL_H_
26
27 #include <sys/skein.h>
28 #include "skein_port.h"
29
30 /* determine where we can get bcopy/bzero declarations */
31 #ifdef _KERNEL
32 #include <sys/systm.h>
33 #else
34 #include <strings.h>
35 #endif
36
37 /*
38 * "Internal" Skein definitions
39 * -- not needed for sequential hashing API, but will be
40 * helpful for other uses of Skein (e.g., tree hash mode).
41 * -- included here so that they can be shared between
42 * reference and optimized code.
43 */
44
45 /* tweak word T[1]: bit field starting positions */
46 /* offset 64 because it's the second word */
47 #define SKEIN_T1_BIT(BIT) ((BIT) - 64)
48
49 /* bits 112..118: level in hash tree */
50 #define SKEIN_T1_POS_TREE_LVL SKEIN_T1_BIT(112)
51 /* bit 119: partial final input byte */
52 #define SKEIN_T1_POS_BIT_PAD SKEIN_T1_BIT(119)
53 /* bits 120..125: type field */
54 #define SKEIN_T1_POS_BLK_TYPE SKEIN_T1_BIT(120)
55 /* bits 126: first block flag */
56 #define SKEIN_T1_POS_FIRST SKEIN_T1_BIT(126)
57 /* bit 127: final block flag */
58 #define SKEIN_T1_POS_FINAL SKEIN_T1_BIT(127)
59
60 /* tweak word T[1]: flag bit definition(s) */
61 #define SKEIN_T1_FLAG_FIRST (((uint64_t)1) << SKEIN_T1_POS_FIRST)
62 #define SKEIN_T1_FLAG_FINAL (((uint64_t)1) << SKEIN_T1_POS_FINAL)
63 #define SKEIN_T1_FLAG_BIT_PAD (((uint64_t)1) << SKEIN_T1_POS_BIT_PAD)
64
65 /* tweak word T[1]: tree level bit field mask */
66 #define SKEIN_T1_TREE_LVL_MASK (((uint64_t)0x7F) << SKEIN_T1_POS_TREE_LVL)
67 #define SKEIN_T1_TREE_LEVEL(n) (((uint64_t)(n)) << SKEIN_T1_POS_TREE_LVL)
68
69 /* tweak word T[1]: block type field */
70 #define SKEIN_BLK_TYPE_KEY (0) /* key, for MAC and KDF */
71 #define SKEIN_BLK_TYPE_CFG (4) /* configuration block */
72 #define SKEIN_BLK_TYPE_PERS (8) /* personalization string */
73 #define SKEIN_BLK_TYPE_PK (12) /* public key (for signature hashing) */
74 #define SKEIN_BLK_TYPE_KDF (16) /* key identifier for KDF */
75 #define SKEIN_BLK_TYPE_NONCE (20) /* nonce for PRNG */
76 #define SKEIN_BLK_TYPE_MSG (48) /* message processing */
77 #define SKEIN_BLK_TYPE_OUT (63) /* output stage */
78 #define SKEIN_BLK_TYPE_MASK (63) /* bit field mask */
79
80 #define SKEIN_T1_BLK_TYPE(T) \
81 (((uint64_t)(SKEIN_BLK_TYPE_##T)) << SKEIN_T1_POS_BLK_TYPE)
82 /* key, for MAC and KDF */
83 #define SKEIN_T1_BLK_TYPE_KEY SKEIN_T1_BLK_TYPE(KEY)
84 /* configuration block */
85 #define SKEIN_T1_BLK_TYPE_CFG SKEIN_T1_BLK_TYPE(CFG)
86 /* personalization string */
87 #define SKEIN_T1_BLK_TYPE_PERS SKEIN_T1_BLK_TYPE(PERS)
88 /* public key (for digital signature hashing) */
89 #define SKEIN_T1_BLK_TYPE_PK SKEIN_T1_BLK_TYPE(PK)
90 /* key identifier for KDF */
91 #define SKEIN_T1_BLK_TYPE_KDF SKEIN_T1_BLK_TYPE(KDF)
92 /* nonce for PRNG */
93 #define SKEIN_T1_BLK_TYPE_NONCE SKEIN_T1_BLK_TYPE(NONCE)
94 /* message processing */
95 #define SKEIN_T1_BLK_TYPE_MSG SKEIN_T1_BLK_TYPE(MSG)
96 /* output stage */
97 #define SKEIN_T1_BLK_TYPE_OUT SKEIN_T1_BLK_TYPE(OUT)
98 /* field bit mask */
99 #define SKEIN_T1_BLK_TYPE_MASK SKEIN_T1_BLK_TYPE(MASK)
100
101 #define SKEIN_T1_BLK_TYPE_CFG_FINAL \
102 (SKEIN_T1_BLK_TYPE_CFG | SKEIN_T1_FLAG_FINAL)
103 #define SKEIN_T1_BLK_TYPE_OUT_FINAL \
104 (SKEIN_T1_BLK_TYPE_OUT | SKEIN_T1_FLAG_FINAL)
105
106 #define SKEIN_VERSION (1)
107
108 #ifndef SKEIN_ID_STRING_LE /* allow compile-time personalization */
109 #define SKEIN_ID_STRING_LE (0x33414853) /* "SHA3" (little-endian) */
110 #endif
111
112 #define SKEIN_MK_64(hi32, lo32) ((lo32) + (((uint64_t)(hi32)) << 32))
113 #define SKEIN_SCHEMA_VER SKEIN_MK_64(SKEIN_VERSION, SKEIN_ID_STRING_LE)
114 #define SKEIN_KS_PARITY SKEIN_MK_64(0x1BD11BDA, 0xA9FC1A22)
115
116 #define SKEIN_CFG_STR_LEN (4*8)
117
118 /* bit field definitions in config block treeInfo word */
119 #define SKEIN_CFG_TREE_LEAF_SIZE_POS (0)
120 #define SKEIN_CFG_TREE_NODE_SIZE_POS (8)
121 #define SKEIN_CFG_TREE_MAX_LEVEL_POS (16)
122
123 #define SKEIN_CFG_TREE_LEAF_SIZE_MSK \
124 (((uint64_t)0xFF) << SKEIN_CFG_TREE_LEAF_SIZE_POS)
125 #define SKEIN_CFG_TREE_NODE_SIZE_MSK \
126 (((uint64_t)0xFF) << SKEIN_CFG_TREE_NODE_SIZE_POS)
127 #define SKEIN_CFG_TREE_MAX_LEVEL_MSK \
128 (((uint64_t)0xFF) << SKEIN_CFG_TREE_MAX_LEVEL_POS)
129
130 #define SKEIN_CFG_TREE_INFO(leaf, node, maxLvl) \
131 ((((uint64_t)(leaf)) << SKEIN_CFG_TREE_LEAF_SIZE_POS) | \
132 (((uint64_t)(node)) << SKEIN_CFG_TREE_NODE_SIZE_POS) | \
133 (((uint64_t)(maxLvl)) << SKEIN_CFG_TREE_MAX_LEVEL_POS))
134
135 /* use as treeInfo in InitExt() call for sequential processing */
136 #define SKEIN_CFG_TREE_INFO_SEQUENTIAL SKEIN_CFG_TREE_INFO(0, 0, 0)
137
138 /*
139 * Skein macros for getting/setting tweak words, etc.
140 * These are useful for partial input bytes, hash tree init/update, etc.
141 */
142 #define Skein_Get_Tweak(ctxPtr, TWK_NUM) ((ctxPtr)->h.T[TWK_NUM])
143 #define Skein_Set_Tweak(ctxPtr, TWK_NUM, tVal) \
144 do { \
145 (ctxPtr)->h.T[TWK_NUM] = (tVal); \
146 _NOTE(CONSTCOND) \
147 } while (0)
148
149 #define Skein_Get_T0(ctxPtr) Skein_Get_Tweak(ctxPtr, 0)
150 #define Skein_Get_T1(ctxPtr) Skein_Get_Tweak(ctxPtr, 1)
151 #define Skein_Set_T0(ctxPtr, T0) Skein_Set_Tweak(ctxPtr, 0, T0)
152 #define Skein_Set_T1(ctxPtr, T1) Skein_Set_Tweak(ctxPtr, 1, T1)
153
154 /* set both tweak words at once */
155 #define Skein_Set_T0_T1(ctxPtr, T0, T1) \
156 do { \
157 Skein_Set_T0(ctxPtr, (T0)); \
158 Skein_Set_T1(ctxPtr, (T1)); \
159 _NOTE(CONSTCOND) \
160 } while (0)
161
162 #define Skein_Set_Type(ctxPtr, BLK_TYPE) \
163 Skein_Set_T1(ctxPtr, SKEIN_T1_BLK_TYPE_##BLK_TYPE)
164
165 /*
166 * set up for starting with a new type: h.T[0]=0; h.T[1] = NEW_TYPE; h.bCnt=0;
167 */
168 #define Skein_Start_New_Type(ctxPtr, BLK_TYPE) \
169 do { \
170 Skein_Set_T0_T1(ctxPtr, 0, SKEIN_T1_FLAG_FIRST | \
171 SKEIN_T1_BLK_TYPE_ ## BLK_TYPE); \
172 (ctxPtr)->h.bCnt = 0; \
173 _NOTE(CONSTCOND) \
174 } while (0)
175
176 #define Skein_Clear_First_Flag(hdr) \
177 do { \
178 (hdr).T[1] &= ~SKEIN_T1_FLAG_FIRST; \
179 _NOTE(CONSTCOND) \
180 } while (0)
181 #define Skein_Set_Bit_Pad_Flag(hdr) \
182 do { \
183 (hdr).T[1] |= SKEIN_T1_FLAG_BIT_PAD; \
184 _NOTE(CONSTCOND) \
185 } while (0)
186
187 #define Skein_Set_Tree_Level(hdr, height) \
188 do { \
189 (hdr).T[1] |= SKEIN_T1_TREE_LEVEL(height); \
190 _NOTE(CONSTCOND) \
191 } while (0)
192
193 /*
194 * "Internal" Skein definitions for debugging and error checking
195 * Note: in Illumos we always disable debugging features.
196 */
197 #define Skein_Show_Block(bits, ctx, X, blkPtr, wPtr, ksEvenPtr, ksOddPtr)
198 #define Skein_Show_Round(bits, ctx, r, X)
199 #define Skein_Show_R_Ptr(bits, ctx, r, X_ptr)
200 #define Skein_Show_Final(bits, ctx, cnt, outPtr)
201 #define Skein_Show_Key(bits, ctx, key, keyBytes)
202
203 /* run-time checks (e.g., bad params, uninitialized context)? */
204 #ifndef SKEIN_ERR_CHECK
205 /* default: ignore all Asserts, for performance */
206 #define Skein_Assert(x, retCode)
207 #define Skein_assert(x)
208 #elif defined(SKEIN_ASSERT)
209 #include <sys/debug.h>
210 #define Skein_Assert(x, retCode) ASSERT(x)
211 #define Skein_assert(x) ASSERT(x)
212 #else
213 #include <sys/debug.h>
214 /* caller error */
215 #define Skein_Assert(x, retCode) \
216 do { \
217 if (!(x)) \
218 return (retCode); \
219 _NOTE(CONSTCOND) \
220 } while (0)
221 /* internal error */
222 #define Skein_assert(x) ASSERT(x)
223 #endif
224
225 /*
226 * Skein block function constants (shared across Ref and Opt code)
227 */
228 enum {
229 /* Skein_256 round rotation constants */
230 R_256_0_0 = 14, R_256_0_1 = 16,
231 R_256_1_0 = 52, R_256_1_1 = 57,
232 R_256_2_0 = 23, R_256_2_1 = 40,
233 R_256_3_0 = 5, R_256_3_1 = 37,
234 R_256_4_0 = 25, R_256_4_1 = 33,
235 R_256_5_0 = 46, R_256_5_1 = 12,
236 R_256_6_0 = 58, R_256_6_1 = 22,
237 R_256_7_0 = 32, R_256_7_1 = 32,
238
239 /* Skein_512 round rotation constants */
240 R_512_0_0 = 46, R_512_0_1 = 36, R_512_0_2 = 19, R_512_0_3 = 37,
241 R_512_1_0 = 33, R_512_1_1 = 27, R_512_1_2 = 14, R_512_1_3 = 42,
242 R_512_2_0 = 17, R_512_2_1 = 49, R_512_2_2 = 36, R_512_2_3 = 39,
243 R_512_3_0 = 44, R_512_3_1 = 9, R_512_3_2 = 54, R_512_3_3 = 56,
244 R_512_4_0 = 39, R_512_4_1 = 30, R_512_4_2 = 34, R_512_4_3 = 24,
245 R_512_5_0 = 13, R_512_5_1 = 50, R_512_5_2 = 10, R_512_5_3 = 17,
246 R_512_6_0 = 25, R_512_6_1 = 29, R_512_6_2 = 39, R_512_6_3 = 43,
247 R_512_7_0 = 8, R_512_7_1 = 35, R_512_7_2 = 56, R_512_7_3 = 22,
248
249 /* Skein1024 round rotation constants */
250 R1024_0_0 = 24, R1024_0_1 = 13, R1024_0_2 = 8, R1024_0_3 =
251 47, R1024_0_4 = 8, R1024_0_5 = 17, R1024_0_6 = 22, R1024_0_7 = 37,
252 R1024_1_0 = 38, R1024_1_1 = 19, R1024_1_2 = 10, R1024_1_3 =
253 55, R1024_1_4 = 49, R1024_1_5 = 18, R1024_1_6 = 23, R1024_1_7 = 52,
254 R1024_2_0 = 33, R1024_2_1 = 4, R1024_2_2 = 51, R1024_2_3 =
255 13, R1024_2_4 = 34, R1024_2_5 = 41, R1024_2_6 = 59, R1024_2_7 = 17,
256 R1024_3_0 = 5, R1024_3_1 = 20, R1024_3_2 = 48, R1024_3_3 =
257 41, R1024_3_4 = 47, R1024_3_5 = 28, R1024_3_6 = 16, R1024_3_7 = 25,
258 R1024_4_0 = 41, R1024_4_1 = 9, R1024_4_2 = 37, R1024_4_3 =
259 31, R1024_4_4 = 12, R1024_4_5 = 47, R1024_4_6 = 44, R1024_4_7 = 30,
260 R1024_5_0 = 16, R1024_5_1 = 34, R1024_5_2 = 56, R1024_5_3 =
261 51, R1024_5_4 = 4, R1024_5_5 = 53, R1024_5_6 = 42, R1024_5_7 = 41,
262 R1024_6_0 = 31, R1024_6_1 = 44, R1024_6_2 = 47, R1024_6_3 =
263 46, R1024_6_4 = 19, R1024_6_5 = 42, R1024_6_6 = 44, R1024_6_7 = 25,
264 R1024_7_0 = 9, R1024_7_1 = 48, R1024_7_2 = 35, R1024_7_3 =
265 52, R1024_7_4 = 23, R1024_7_5 = 31, R1024_7_6 = 37, R1024_7_7 = 20
266 };
267
268 /* number of rounds for the different block sizes */
269 #define SKEIN_256_ROUNDS_TOTAL (72)
270 #define SKEIN_512_ROUNDS_TOTAL (72)
271 #define SKEIN1024_ROUNDS_TOTAL (80)
272
273 #endif /* _SKEIN_IMPL_H_ */