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