3 /**************************************************************************
\r
5 ** Interface declarations and internal definitions for Skein hashing.
\r
7 ** Source code author: Doug Whiting, 2008.
\r
9 ** This algorithm and source code is released to the public domain.
\r
11 ***************************************************************************
\r
13 ** The following compile-time switches may be defined to control some
\r
14 ** tradeoffs between speed, code size, error checking, and security.
\r
16 ** The "default" note explains what happens when the switch is not defined.
\r
18 ** SKEIN_DEBUG -- make callouts from inside Skein code
\r
19 ** to examine/display intermediate values.
\r
20 ** [default: no callouts (no overhead)]
\r
22 ** SKEIN_ERR_CHECK -- how error checking is handled inside Skein
\r
23 ** code. If not defined, most error checking
\r
24 ** is disabled (for performance). Otherwise,
\r
25 ** the switch value is interpreted as:
\r
26 ** 0: use assert() to flag errors
\r
27 ** 1: return SKEIN_FAIL to flag errors
\r
29 ***************************************************************************/
\r
35 #include <stddef.h> /* get size_t definition */
\r
36 #include "skein_port.h" /* get platform-specific definitions */
\r
40 SKEIN_SUCCESS = 0, /* return codes from Skein calls */
\r
42 SKEIN_BAD_HASHLEN = 2
\r
45 #define SKEIN_MODIFIER_WORDS ( 2) /* number of modifier (tweak) words */
\r
47 #define SKEIN_256_STATE_WORDS ( 4)
\r
48 #define SKEIN_512_STATE_WORDS ( 8)
\r
49 #define SKEIN1024_STATE_WORDS (16)
\r
50 #define SKEIN_MAX_STATE_WORDS (16)
\r
52 #define SKEIN_256_STATE_BYTES ( 8*SKEIN_256_STATE_WORDS)
\r
53 #define SKEIN_512_STATE_BYTES ( 8*SKEIN_512_STATE_WORDS)
\r
54 #define SKEIN1024_STATE_BYTES ( 8*SKEIN1024_STATE_WORDS)
\r
56 #define SKEIN_256_STATE_BITS (64*SKEIN_256_STATE_WORDS)
\r
57 #define SKEIN_512_STATE_BITS (64*SKEIN_512_STATE_WORDS)
\r
58 #define SKEIN1024_STATE_BITS (64*SKEIN1024_STATE_WORDS)
\r
60 #define SKEIN_256_BLOCK_BYTES ( 8*SKEIN_256_STATE_WORDS)
\r
61 #define SKEIN_512_BLOCK_BYTES ( 8*SKEIN_512_STATE_WORDS)
\r
62 #define SKEIN1024_BLOCK_BYTES ( 8*SKEIN1024_STATE_WORDS)
\r
66 size_t hashBitLen; /* size of hash result, in bits */
\r
67 size_t bCnt; /* current byte count in buffer b[] */
\r
68 u64b_t T[SKEIN_MODIFIER_WORDS]; /* tweak words: T[0]=byte cnt, T[1]=flags */
\r
71 typedef struct /* 256-bit Skein hash context structure */
\r
73 Skein_Ctxt_Hdr_t h; /* common header context variables */
\r
74 u64b_t X[SKEIN_256_STATE_WORDS]; /* chaining variables */
\r
75 u08b_t b[SKEIN_256_BLOCK_BYTES]; /* partial block buffer (8-byte aligned) */
\r
78 typedef struct /* 512-bit Skein hash context structure */
\r
80 Skein_Ctxt_Hdr_t h; /* common header context variables */
\r
81 u64b_t X[SKEIN_512_STATE_WORDS]; /* chaining variables */
\r
82 u08b_t b[SKEIN_512_BLOCK_BYTES]; /* partial block buffer (8-byte aligned) */
\r
85 typedef struct /* 1024-bit Skein hash context structure */
\r
87 Skein_Ctxt_Hdr_t h; /* common header context variables */
\r
88 u64b_t X[SKEIN1024_STATE_WORDS]; /* chaining variables */
\r
89 u08b_t b[SKEIN1024_BLOCK_BYTES]; /* partial block buffer (8-byte aligned) */
\r
92 /* Skein APIs for (incremental) "straight hashing" */
\r
93 int Skein_256_Init (Skein_256_Ctxt_t *ctx, size_t hashBitLen);
\r
94 int Skein_512_Init (Skein_512_Ctxt_t *ctx, size_t hashBitLen);
\r
95 int Skein1024_Init (Skein1024_Ctxt_t *ctx, size_t hashBitLen);
\r
97 int Skein_256_Update(Skein_256_Ctxt_t *ctx, const u08b_t *msg, size_t msgByteCnt);
\r
98 int Skein_512_Update(Skein_512_Ctxt_t *ctx, const u08b_t *msg, size_t msgByteCnt);
\r
99 int Skein1024_Update(Skein1024_Ctxt_t *ctx, const u08b_t *msg, size_t msgByteCnt);
\r
101 int Skein_256_Final (Skein_256_Ctxt_t *ctx, u08b_t * hashVal);
\r
102 int Skein_512_Final (Skein_512_Ctxt_t *ctx, u08b_t * hashVal);
\r
103 int Skein1024_Final (Skein1024_Ctxt_t *ctx, u08b_t * hashVal);
\r
106 ** Skein APIs for "extended" initialization: MAC keys, tree hashing.
\r
107 ** After an InitExt() call, just use Update/Final calls as with Init().
\r
109 ** Notes: Same parameters as _Init() calls, plus treeInfo/key/keyBytes.
\r
110 ** When keyBytes == 0 and treeInfo == SKEIN_SEQUENTIAL,
\r
111 ** the results of InitExt() are identical to calling Init().
\r
112 ** The function Init() may be called once to "precompute" the IV for
\r
113 ** a given hashBitLen value, then by saving a copy of the context
\r
114 ** the IV computation may be avoided in later calls.
\r
115 ** Similarly, the function InitExt() may be called once per MAC key
\r
116 ** to precompute the MAC IV, then a copy of the context saved and
\r
117 ** reused for each new MAC computation.
\r
119 int Skein_256_InitExt(Skein_256_Ctxt_t *ctx, size_t hashBitLen, u64b_t treeInfo, const u08b_t *key, size_t keyBytes);
\r
120 int Skein_512_InitExt(Skein_512_Ctxt_t *ctx, size_t hashBitLen, u64b_t treeInfo, const u08b_t *key, size_t keyBytes);
\r
121 int Skein1024_InitExt(Skein1024_Ctxt_t *ctx, size_t hashBitLen, u64b_t treeInfo, const u08b_t *key, size_t keyBytes);
\r
124 ** Skein APIs for MAC and tree hash:
\r
125 ** Final_Pad: pad, do final block, but no OUTPUT type
\r
126 ** Output: do just the output stage
\r
128 int Skein_256_Final_Pad(Skein_256_Ctxt_t *ctx, u08b_t * hashVal);
\r
129 int Skein_512_Final_Pad(Skein_512_Ctxt_t *ctx, u08b_t * hashVal);
\r
130 int Skein1024_Final_Pad(Skein1024_Ctxt_t *ctx, u08b_t * hashVal);
\r
132 #ifndef SKEIN_TREE_HASH
\r
133 #define SKEIN_TREE_HASH (1)
\r
135 #if SKEIN_TREE_HASH
\r
136 int Skein_256_Output (Skein_256_Ctxt_t *ctx, u08b_t * hashVal);
\r
137 int Skein_512_Output (Skein_512_Ctxt_t *ctx, u08b_t * hashVal);
\r
138 int Skein1024_Output (Skein1024_Ctxt_t *ctx, u08b_t * hashVal);
\r
141 /*****************************************************************
\r
142 ** "Internal" Skein definitions
\r
143 ** -- not needed for sequential hashing API, but will be
\r
144 ** helpful for other uses of Skein (e.g., tree hash mode).
\r
145 ** -- included here so that they can be shared between
\r
146 ** reference and optimized code.
\r
147 ******************************************************************/
\r
149 /* tweak word T[1]: bit field starting positions */
\r
150 #define SKEIN_T1_BIT(BIT) ((BIT) - 64) /* offset 64 because it's the second word */
\r
152 #define SKEIN_T1_POS_TREE_LVL SKEIN_T1_BIT(112) /* bits 112..118: level in hash tree */
\r
153 #define SKEIN_T1_POS_BIT_PAD SKEIN_T1_BIT(119) /* bit 119 : partial final input byte */
\r
154 #define SKEIN_T1_POS_BLK_TYPE SKEIN_T1_BIT(120) /* bits 120..125: type field */
\r
155 #define SKEIN_T1_POS_FIRST SKEIN_T1_BIT(126) /* bits 126 : first block flag */
\r
156 #define SKEIN_T1_POS_FINAL SKEIN_T1_BIT(127) /* bit 127 : final block flag */
\r
158 /* tweak word T[1]: flag bit definition(s) */
\r
159 #define SKEIN_T1_FLAG_FIRST (((u64b_t) 1 ) << SKEIN_T1_POS_FIRST)
\r
160 #define SKEIN_T1_FLAG_FINAL (((u64b_t) 1 ) << SKEIN_T1_POS_FINAL)
\r
161 #define SKEIN_T1_FLAG_BIT_PAD (((u64b_t) 1 ) << SKEIN_T1_POS_BIT_PAD)
\r
163 /* tweak word T[1]: tree level bit field mask */
\r
164 #define SKEIN_T1_TREE_LVL_MASK (((u64b_t)0x7F) << SKEIN_T1_POS_TREE_LVL)
\r
165 #define SKEIN_T1_TREE_LEVEL(n) (((u64b_t) (n)) << SKEIN_T1_POS_TREE_LVL)
\r
167 /* tweak word T[1]: block type field */
\r
168 #define SKEIN_BLK_TYPE_KEY ( 0) /* key, for MAC and KDF */
\r
169 #define SKEIN_BLK_TYPE_CFG ( 4) /* configuration block */
\r
170 #define SKEIN_BLK_TYPE_PERS ( 8) /* personalization string */
\r
171 #define SKEIN_BLK_TYPE_PK (12) /* public key (for digital signature hashing) */
\r
172 #define SKEIN_BLK_TYPE_KDF (16) /* key identifier for KDF */
\r
173 #define SKEIN_BLK_TYPE_NONCE (20) /* nonce for PRNG */
\r
174 #define SKEIN_BLK_TYPE_MSG (48) /* message processing */
\r
175 #define SKEIN_BLK_TYPE_OUT (63) /* output stage */
\r
176 #define SKEIN_BLK_TYPE_MASK (63) /* bit field mask */
\r
178 #define SKEIN_T1_BLK_TYPE(T) (((u64b_t) (SKEIN_BLK_TYPE_##T)) << SKEIN_T1_POS_BLK_TYPE)
\r
179 #define SKEIN_T1_BLK_TYPE_KEY SKEIN_T1_BLK_TYPE(KEY) /* key, for MAC and KDF */
\r
180 #define SKEIN_T1_BLK_TYPE_CFG SKEIN_T1_BLK_TYPE(CFG) /* configuration block */
\r
181 #define SKEIN_T1_BLK_TYPE_PERS SKEIN_T1_BLK_TYPE(PERS) /* personalization string */
\r
182 #define SKEIN_T1_BLK_TYPE_PK SKEIN_T1_BLK_TYPE(PK) /* public key (for digital signature hashing) */
\r
183 #define SKEIN_T1_BLK_TYPE_KDF SKEIN_T1_BLK_TYPE(KDF) /* key identifier for KDF */
\r
184 #define SKEIN_T1_BLK_TYPE_NONCE SKEIN_T1_BLK_TYPE(NONCE)/* nonce for PRNG */
\r
185 #define SKEIN_T1_BLK_TYPE_MSG SKEIN_T1_BLK_TYPE(MSG) /* message processing */
\r
186 #define SKEIN_T1_BLK_TYPE_OUT SKEIN_T1_BLK_TYPE(OUT) /* output stage */
\r
187 #define SKEIN_T1_BLK_TYPE_MASK SKEIN_T1_BLK_TYPE(MASK) /* field bit mask */
\r
189 #define SKEIN_T1_BLK_TYPE_CFG_FINAL (SKEIN_T1_BLK_TYPE_CFG | SKEIN_T1_FLAG_FINAL)
\r
190 #define SKEIN_T1_BLK_TYPE_OUT_FINAL (SKEIN_T1_BLK_TYPE_OUT | SKEIN_T1_FLAG_FINAL)
\r
192 #define SKEIN_VERSION (1)
\r
194 #ifndef SKEIN_ID_STRING_LE /* allow compile-time personalization */
\r
195 #define SKEIN_ID_STRING_LE (0x33414853) /* "SHA3" (little-endian)*/
\r
198 #define SKEIN_MK_64(hi32,lo32) ((lo32) + (((u64b_t) (hi32)) << 32))
\r
199 #define SKEIN_SCHEMA_VER SKEIN_MK_64(SKEIN_VERSION,SKEIN_ID_STRING_LE)
\r
200 #define SKEIN_KS_PARITY SKEIN_MK_64(0x1BD11BDA,0xA9FC1A22)
\r
202 #define SKEIN_CFG_STR_LEN (4*8)
\r
204 /* bit field definitions in config block treeInfo word */
\r
205 #define SKEIN_CFG_TREE_LEAF_SIZE_POS ( 0)
\r
206 #define SKEIN_CFG_TREE_NODE_SIZE_POS ( 8)
\r
207 #define SKEIN_CFG_TREE_MAX_LEVEL_POS (16)
\r
209 #define SKEIN_CFG_TREE_LEAF_SIZE_MSK (((u64b_t) 0xFF) << SKEIN_CFG_TREE_LEAF_SIZE_POS)
\r
210 #define SKEIN_CFG_TREE_NODE_SIZE_MSK (((u64b_t) 0xFF) << SKEIN_CFG_TREE_NODE_SIZE_POS)
\r
211 #define SKEIN_CFG_TREE_MAX_LEVEL_MSK (((u64b_t) 0xFF) << SKEIN_CFG_TREE_MAX_LEVEL_POS)
\r
213 #define SKEIN_CFG_TREE_INFO(leaf,node,maxLvl) \
\r
214 ( (((u64b_t)(leaf )) << SKEIN_CFG_TREE_LEAF_SIZE_POS) | \
\r
215 (((u64b_t)(node )) << SKEIN_CFG_TREE_NODE_SIZE_POS) | \
\r
216 (((u64b_t)(maxLvl)) << SKEIN_CFG_TREE_MAX_LEVEL_POS) )
\r
218 #define SKEIN_CFG_TREE_INFO_SEQUENTIAL SKEIN_CFG_TREE_INFO(0,0,0) /* use as treeInfo in InitExt() call for sequential processing */
\r
221 ** Skein macros for getting/setting tweak words, etc.
\r
222 ** These are useful for partial input bytes, hash tree init/update, etc.
\r
224 #define Skein_Get_Tweak(ctxPtr,TWK_NUM) ((ctxPtr)->h.T[TWK_NUM])
\r
225 #define Skein_Set_Tweak(ctxPtr,TWK_NUM,tVal) {(ctxPtr)->h.T[TWK_NUM] = (tVal);}
\r
227 #define Skein_Get_T0(ctxPtr) Skein_Get_Tweak(ctxPtr,0)
\r
228 #define Skein_Get_T1(ctxPtr) Skein_Get_Tweak(ctxPtr,1)
\r
229 #define Skein_Set_T0(ctxPtr,T0) Skein_Set_Tweak(ctxPtr,0,T0)
\r
230 #define Skein_Set_T1(ctxPtr,T1) Skein_Set_Tweak(ctxPtr,1,T1)
\r
232 /* set both tweak words at once */
\r
233 #define Skein_Set_T0_T1(ctxPtr,T0,T1) \
\r
235 Skein_Set_T0(ctxPtr,(T0)); \
\r
236 Skein_Set_T1(ctxPtr,(T1)); \
\r
239 #define Skein_Set_Type(ctxPtr,BLK_TYPE) \
\r
240 Skein_Set_T1(ctxPtr,SKEIN_T1_BLK_TYPE_##BLK_TYPE)
\r
242 /* set up for starting with a new type: h.T[0]=0; h.T[1] = NEW_TYPE; h.bCnt=0; */
\r
243 #define Skein_Start_New_Type(ctxPtr,BLK_TYPE) \
\r
244 { Skein_Set_T0_T1(ctxPtr,0,SKEIN_T1_FLAG_FIRST | SKEIN_T1_BLK_TYPE_##BLK_TYPE); (ctxPtr)->h.bCnt=0; }
\r
246 #define Skein_Clear_First_Flag(hdr) { (hdr).T[1] &= ~SKEIN_T1_FLAG_FIRST; }
\r
247 #define Skein_Set_Bit_Pad_Flag(hdr) { (hdr).T[1] |= SKEIN_T1_FLAG_BIT_PAD; }
\r
249 #define Skein_Set_Tree_Level(hdr,height) { (hdr).T[1] |= SKEIN_T1_TREE_LEVEL(height);}
\r
251 /*****************************************************************
\r
252 ** "Internal" Skein definitions for debugging and error checking
\r
253 ******************************************************************/
\r
254 #ifdef SKEIN_DEBUG /* examine/display intermediate values? */
\r
255 #include "skein_debug.h"
\r
256 #else /* default is no callouts */
\r
257 #define Skein_Show_Block(bits,ctx,X,blkPtr,wPtr,ksEvenPtr,ksOddPtr)
\r
258 #define Skein_Show_Round(bits,ctx,r,X)
\r
259 #define Skein_Show_R_Ptr(bits,ctx,r,X_ptr)
\r
260 #define Skein_Show_Final(bits,ctx,cnt,outPtr)
\r
261 #define Skein_Show_Key(bits,ctx,key,keyBytes)
\r
264 #ifndef SKEIN_ERR_CHECK /* run-time checks (e.g., bad params, uninitialized context)? */
\r
265 #define Skein_Assert(x,retCode)/* default: ignore all Asserts, for performance */
\r
266 #define Skein_assert(x)
\r
267 #elif defined(SKEIN_ASSERT)
\r
268 #include <assert.h>
\r
269 #define Skein_Assert(x,retCode) assert(x)
\r
270 #define Skein_assert(x) assert(x)
\r
272 #include <assert.h>
\r
273 #define Skein_Assert(x,retCode) { if (!(x)) return retCode; } /* caller error */
\r
274 #define Skein_assert(x) assert(x) /* internal error */
\r
277 /*****************************************************************
\r
278 ** Skein block function constants (shared across Ref and Opt code)
\r
279 ******************************************************************/
\r
282 /* Skein_256 round rotation constants */
\r
283 R_256_0_0=14, R_256_0_1=16,
\r
284 R_256_1_0=52, R_256_1_1=57,
\r
285 R_256_2_0=23, R_256_2_1=40,
\r
286 R_256_3_0= 5, R_256_3_1=37,
\r
287 R_256_4_0=25, R_256_4_1=33,
\r
288 R_256_5_0=46, R_256_5_1=12,
\r
289 R_256_6_0=58, R_256_6_1=22,
\r
290 R_256_7_0=32, R_256_7_1=32,
\r
292 /* Skein_512 round rotation constants */
\r
293 R_512_0_0=46, R_512_0_1=36, R_512_0_2=19, R_512_0_3=37,
\r
294 R_512_1_0=33, R_512_1_1=27, R_512_1_2=14, R_512_1_3=42,
\r
295 R_512_2_0=17, R_512_2_1=49, R_512_2_2=36, R_512_2_3=39,
\r
296 R_512_3_0=44, R_512_3_1= 9, R_512_3_2=54, R_512_3_3=56,
\r
297 R_512_4_0=39, R_512_4_1=30, R_512_4_2=34, R_512_4_3=24,
\r
298 R_512_5_0=13, R_512_5_1=50, R_512_5_2=10, R_512_5_3=17,
\r
299 R_512_6_0=25, R_512_6_1=29, R_512_6_2=39, R_512_6_3=43,
\r
300 R_512_7_0= 8, R_512_7_1=35, R_512_7_2=56, R_512_7_3=22,
\r
302 /* Skein1024 round rotation constants */
\r
303 R1024_0_0=24, R1024_0_1=13, R1024_0_2= 8, R1024_0_3=47, R1024_0_4= 8, R1024_0_5=17, R1024_0_6=22, R1024_0_7=37,
\r
304 R1024_1_0=38, R1024_1_1=19, R1024_1_2=10, R1024_1_3=55, R1024_1_4=49, R1024_1_5=18, R1024_1_6=23, R1024_1_7=52,
\r
305 R1024_2_0=33, R1024_2_1= 4, R1024_2_2=51, R1024_2_3=13, R1024_2_4=34, R1024_2_5=41, R1024_2_6=59, R1024_2_7=17,
\r
306 R1024_3_0= 5, R1024_3_1=20, R1024_3_2=48, R1024_3_3=41, R1024_3_4=47, R1024_3_5=28, R1024_3_6=16, R1024_3_7=25,
\r
307 R1024_4_0=41, R1024_4_1= 9, R1024_4_2=37, R1024_4_3=31, R1024_4_4=12, R1024_4_5=47, R1024_4_6=44, R1024_4_7=30,
\r
308 R1024_5_0=16, R1024_5_1=34, R1024_5_2=56, R1024_5_3=51, R1024_5_4= 4, R1024_5_5=53, R1024_5_6=42, R1024_5_7=41,
\r
309 R1024_6_0=31, R1024_6_1=44, R1024_6_2=47, R1024_6_3=46, R1024_6_4=19, R1024_6_5=42, R1024_6_6=44, R1024_6_7=25,
\r
310 R1024_7_0= 9, R1024_7_1=48, R1024_7_2=35, R1024_7_3=52, R1024_7_4=23, R1024_7_5=31, R1024_7_6=37, R1024_7_7=20
\r
313 #ifndef SKEIN_ROUNDS
\r
314 #define SKEIN_256_ROUNDS_TOTAL (72) /* number of rounds for the different block sizes */
\r
315 #define SKEIN_512_ROUNDS_TOTAL (72)
\r
316 #define SKEIN1024_ROUNDS_TOTAL (80)
\r
317 #else /* allow command-line define in range 8*(5..14) */
\r
318 #define SKEIN_256_ROUNDS_TOTAL (8*((((SKEIN_ROUNDS/100) + 5) % 10) + 5))
\r
319 #define SKEIN_512_ROUNDS_TOTAL (8*((((SKEIN_ROUNDS/ 10) + 5) % 10) + 5))
\r
320 #define SKEIN1024_ROUNDS_TOTAL (8*((((SKEIN_ROUNDS ) + 5) % 10) + 5))
\r
327 #endif /* ifndef _SKEIN_H_ */
\r