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