45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * Internal definitions for Skein hashing.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * Source code author: Doug Whiting, 2008.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * This algorithm and source code is released to the public domain.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * The following compile-time switches may be defined to control some
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * tradeoffs between speed, code size, error checking, and security.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * The "default" note explains what happens when the switch is not defined.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * SKEIN_DEBUG -- make callouts from inside Skein code
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * to examine/display intermediate values.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * [default: no callouts (no overhead)]
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * SKEIN_ERR_CHECK -- how error checking is handled inside Skein
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * code. If not defined, most error checking
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * is disabled (for performance). Otherwise,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * the switch value is interpreted as:
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * 0: use assert() to flag errors
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * 1: return SKEIN_FAIL to flag errors
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* Copyright 2013 Doug Whiting. This code is released to the public domain. */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* determine where we can get bcopy/bzero declarations */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * "Internal" Skein definitions
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * -- not needed for sequential hashing API, but will be
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * helpful for other uses of Skein (e.g., tree hash mode).
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * -- included here so that they can be shared between
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * reference and optimized code.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* tweak word T[1]: bit field starting positions */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* offset 64 because it's the second word */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* bits 112..118: level in hash tree */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_POS_TREE_LVL SKEIN_T1_BIT(112)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* bit 119: partial final input byte */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_POS_BIT_PAD SKEIN_T1_BIT(119)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* bits 120..125: type field */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_POS_BLK_TYPE SKEIN_T1_BIT(120)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* bits 126: first block flag */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* bit 127: final block flag */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* tweak word T[1]: flag bit definition(s) */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_FLAG_FIRST (((uint64_t)1) << SKEIN_T1_POS_FIRST)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_FLAG_FINAL (((uint64_t)1) << SKEIN_T1_POS_FINAL)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_FLAG_BIT_PAD (((uint64_t)1) << SKEIN_T1_POS_BIT_PAD)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* tweak word T[1]: tree level bit field mask */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_TREE_LVL_MASK (((uint64_t)0x7F) << SKEIN_T1_POS_TREE_LVL)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_TREE_LEVEL(n) (((uint64_t)(n)) << SKEIN_T1_POS_TREE_LVL)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* tweak word T[1]: block type field */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_KEY (0) /* key, for MAC and KDF */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_CFG (4) /* configuration block */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_PERS (8) /* personalization string */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_PK (12) /* public key (for signature hashing) */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_KDF (16) /* key identifier for KDF */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_NONCE (20) /* nonce for PRNG */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_MSG (48) /* message processing */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_OUT (63) /* output stage */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_BLK_TYPE_MASK (63) /* bit field mask */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (((uint64_t)(SKEIN_BLK_TYPE_##T)) << SKEIN_T1_POS_BLK_TYPE)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* key, for MAC and KDF */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_KEY SKEIN_T1_BLK_TYPE(KEY)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* configuration block */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_CFG SKEIN_T1_BLK_TYPE(CFG)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* personalization string */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_PERS SKEIN_T1_BLK_TYPE(PERS)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* public key (for digital signature hashing) */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_PK SKEIN_T1_BLK_TYPE(PK)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* key identifier for KDF */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_KDF SKEIN_T1_BLK_TYPE(KDF)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* nonce for PRNG */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_NONCE SKEIN_T1_BLK_TYPE(NONCE)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* message processing */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_MSG SKEIN_T1_BLK_TYPE(MSG)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* output stage */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_OUT SKEIN_T1_BLK_TYPE(OUT)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* field bit mask */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_T1_BLK_TYPE_MASK SKEIN_T1_BLK_TYPE(MASK)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (SKEIN_T1_BLK_TYPE_CFG | SKEIN_T1_FLAG_FINAL)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (SKEIN_T1_BLK_TYPE_OUT | SKEIN_T1_FLAG_FINAL)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#ifndef SKEIN_ID_STRING_LE /* allow compile-time personalization */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_ID_STRING_LE (0x33414853) /* "SHA3" (little-endian) */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_MK_64(hi32, lo32) ((lo32) + (((uint64_t)(hi32)) << 32))
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_SCHEMA_VER SKEIN_MK_64(SKEIN_VERSION, SKEIN_ID_STRING_LE)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_KS_PARITY SKEIN_MK_64(0x1BD11BDA, 0xA9FC1A22)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* bit field definitions in config block treeInfo word */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (((uint64_t)0xFF) << SKEIN_CFG_TREE_LEAF_SIZE_POS)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (((uint64_t)0xFF) << SKEIN_CFG_TREE_NODE_SIZE_POS)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (((uint64_t)0xFF) << SKEIN_CFG_TREE_MAX_LEVEL_POS)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_CFG_TREE_INFO(leaf, node, maxLvl) \
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens ((((uint64_t)(leaf)) << SKEIN_CFG_TREE_LEAF_SIZE_POS) | \
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (((uint64_t)(node)) << SKEIN_CFG_TREE_NODE_SIZE_POS) | \
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens (((uint64_t)(maxLvl)) << SKEIN_CFG_TREE_MAX_LEVEL_POS))
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* use as treeInfo in InitExt() call for sequential processing */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define SKEIN_CFG_TREE_INFO_SEQUENTIAL SKEIN_CFG_TREE_INFO(0, 0, 0)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * Skein macros for getting/setting tweak words, etc.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * These are useful for partial input bytes, hash tree init/update, etc.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Get_Tweak(ctxPtr, TWK_NUM) ((ctxPtr)->h.T[TWK_NUM])
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Set_Tweak(ctxPtr, TWK_NUM, tVal) \
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Get_T0(ctxPtr) Skein_Get_Tweak(ctxPtr, 0)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Get_T1(ctxPtr) Skein_Get_Tweak(ctxPtr, 1)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Set_T0(ctxPtr, T0) Skein_Set_Tweak(ctxPtr, 0, T0)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Set_T1(ctxPtr, T1) Skein_Set_Tweak(ctxPtr, 1, T1)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* set both tweak words at once */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens Skein_Set_T1(ctxPtr, SKEIN_T1_BLK_TYPE_##BLK_TYPE)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * set up for starting with a new type: h.T[0]=0; h.T[1] = NEW_TYPE; h.bCnt=0;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Start_New_Type(ctxPtr, BLK_TYPE) \
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens Skein_Set_T0_T1(ctxPtr, 0, SKEIN_T1_FLAG_FIRST | \
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * "Internal" Skein definitions for debugging and error checking
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * Note: in Illumos we always disable debugging features.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Show_Block(bits, ctx, X, blkPtr, wPtr, ksEvenPtr, ksOddPtr)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Show_Final(bits, ctx, cnt, outPtr)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#define Skein_Show_Key(bits, ctx, key, keyBytes)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* run-time checks (e.g., bad params, uninitialized context)? */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* default: ignore all Asserts, for performance */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* caller error */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* internal error */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * Skein block function constants (shared across Ref and Opt code)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* Skein_256 round rotation constants */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* Skein_512 round rotation constants */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_0_0 = 46, R_512_0_1 = 36, R_512_0_2 = 19, R_512_0_3 = 37,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_1_0 = 33, R_512_1_1 = 27, R_512_1_2 = 14, R_512_1_3 = 42,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_2_0 = 17, R_512_2_1 = 49, R_512_2_2 = 36, R_512_2_3 = 39,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_3_0 = 44, R_512_3_1 = 9, R_512_3_2 = 54, R_512_3_3 = 56,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_4_0 = 39, R_512_4_1 = 30, R_512_4_2 = 34, R_512_4_3 = 24,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_5_0 = 13, R_512_5_1 = 50, R_512_5_2 = 10, R_512_5_3 = 17,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_6_0 = 25, R_512_6_1 = 29, R_512_6_2 = 39, R_512_6_3 = 43,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R_512_7_0 = 8, R_512_7_1 = 35, R_512_7_2 = 56, R_512_7_3 = 22,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* Skein1024 round rotation constants */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_0_0 = 24, R1024_0_1 = 13, R1024_0_2 = 8, R1024_0_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 47, R1024_0_4 = 8, R1024_0_5 = 17, R1024_0_6 = 22, R1024_0_7 = 37,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_1_0 = 38, R1024_1_1 = 19, R1024_1_2 = 10, R1024_1_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 55, R1024_1_4 = 49, R1024_1_5 = 18, R1024_1_6 = 23, R1024_1_7 = 52,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_2_0 = 33, R1024_2_1 = 4, R1024_2_2 = 51, R1024_2_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 13, R1024_2_4 = 34, R1024_2_5 = 41, R1024_2_6 = 59, R1024_2_7 = 17,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_3_0 = 5, R1024_3_1 = 20, R1024_3_2 = 48, R1024_3_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 41, R1024_3_4 = 47, R1024_3_5 = 28, R1024_3_6 = 16, R1024_3_7 = 25,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_4_0 = 41, R1024_4_1 = 9, R1024_4_2 = 37, R1024_4_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 31, R1024_4_4 = 12, R1024_4_5 = 47, R1024_4_6 = 44, R1024_4_7 = 30,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_5_0 = 16, R1024_5_1 = 34, R1024_5_2 = 56, R1024_5_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 51, R1024_5_4 = 4, R1024_5_5 = 53, R1024_5_6 = 42, R1024_5_7 = 41,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_6_0 = 31, R1024_6_1 = 44, R1024_6_2 = 47, R1024_6_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 46, R1024_6_4 = 19, R1024_6_5 = 42, R1024_6_6 = 44, R1024_6_7 = 25,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens R1024_7_0 = 9, R1024_7_1 = 48, R1024_7_2 = 35, R1024_7_3 =
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens 52, R1024_7_4 = 23, R1024_7_5 = 31, R1024_7_6 = 37, R1024_7_7 = 20
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* number of rounds for the different block sizes */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#endif /* _SKEIN_IMPL_H_ */