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