drivers/staging/skein/skein.h

   1 #ifndef _SKEIN_H_
   2 #define _SKEIN_H_     1
   3 /**************************************************************************
   4 **
   5 ** Interface declarations and internal definitions for Skein hashing.
   6 **
   7 ** Source code author: Doug Whiting, 2008.
   8 **
   9 ** This algorithm and source code is released to the public domain.
  10 **
  11 ***************************************************************************
  12 **
  13 ** The following compile-time switches may be defined to control some
  14 ** tradeoffs between speed, code size, error checking, and security.
  15 **
  16 ** The "default" note explains what happens when the switch is not defined.
  17 **
  18 **  SKEIN_DEBUG            -- make callouts from inside Skein code
  19 **                            to examine/display intermediate values.
  20 **                            [default: no callouts (no overhead)]
  21 **
  22 **  SKEIN_ERR_CHECK        -- how error checking is handled inside Skein
  23 **                            code. If not defined, most error checking
  24 **                            is disabled (for performance). Otherwise,
  25 **                            the switch value is interpreted as:
  26 **                                0: use assert()      to flag errors
  27 **                                1: return SKEIN_FAIL to flag errors
  28 **
  29 ***************************************************************************/
  30
  31 #ifndef rotl_64
  32 #define rotl_64(x, N)    (((x) << (N)) | ((x) >> (64-(N))))
  33 #endif
  34
  35 /* below two prototype assume we are handed aligned data */
  36 #define skein_put64_lsb_first(dst08, src64, b_cnt) memcpy(dst08, src64, b_cnt)
  37 #define skein_get64_lsb_first(dst64, src08, w_cnt) \
  38                 memcpy(dst64, src08, 8*(w_cnt))
  39 #define skein_swap64(w64)  (w64)
  40
  41 enum {
  42         SKEIN_SUCCESS         =      0, /* return codes from Skein calls */
  43         SKEIN_FAIL            =      1,
  44         SKEIN_BAD_HASHLEN     =      2
  45 };
  46
  47 #define  SKEIN_MODIFIER_WORDS   (2) /* number of modifier (tweak) words */
  48
  49 #define  SKEIN_256_STATE_WORDS  (4)
  50 #define  SKEIN_512_STATE_WORDS  (8)
  51 #define  SKEIN_1024_STATE_WORDS (16)
  52 #define  SKEIN_MAX_STATE_WORDS (16)
  53
  54 #define  SKEIN_256_STATE_BYTES  (8*SKEIN_256_STATE_WORDS)
  55 #define  SKEIN_512_STATE_BYTES  (8*SKEIN_512_STATE_WORDS)
  56 #define  SKEIN_1024_STATE_BYTES  (8*SKEIN_1024_STATE_WORDS)
  57
  58 #define  SKEIN_256_STATE_BITS  (64*SKEIN_256_STATE_WORDS)
  59 #define  SKEIN_512_STATE_BITS  (64*SKEIN_512_STATE_WORDS)
  60 #define  SKEIN_1024_STATE_BITS  (64*SKEIN_1024_STATE_WORDS)
  61
  62 #define  SKEIN_256_BLOCK_BYTES  (8*SKEIN_256_STATE_WORDS)
  63 #define  SKEIN_512_BLOCK_BYTES  (8*SKEIN_512_STATE_WORDS)
  64 #define  SKEIN_1024_BLOCK_BYTES  (8*SKEIN_1024_STATE_WORDS)
  65
  66 struct skein_ctx_hdr {
  67         size_t hash_bit_len;            /* size of hash result, in bits */
  68         size_t b_cnt;                   /* current byte count in buffer b[] */
  69         u64 tweak[SKEIN_MODIFIER_WORDS]; /* tweak[0]=byte cnt, tweak[1]=flags */
  70 };
  71
  72 struct skein_256_ctx { /* 256-bit Skein hash context structure */
  73         struct skein_ctx_hdr h;         /* common header context variables */
  74         u64 x[SKEIN_256_STATE_WORDS];   /* chaining variables */
  75         u8 b[SKEIN_256_BLOCK_BYTES];    /* partial block buf (8-byte aligned) */
  76 };
  77
  78 struct skein_512_ctx { /* 512-bit Skein hash context structure */
  79         struct skein_ctx_hdr h;         /* common header context variables */
  80         u64 x[SKEIN_512_STATE_WORDS];   /* chaining variables */
  81         u8 b[SKEIN_512_BLOCK_BYTES];    /* partial block buf (8-byte aligned) */
  82 };
  83
  84 struct skein_1024_ctx { /* 1024-bit Skein hash context structure */
  85         struct skein_ctx_hdr h;         /* common header context variables */
  86         u64 x[SKEIN_1024_STATE_WORDS];  /* chaining variables */
  87         u8 b[SKEIN_1024_BLOCK_BYTES];   /* partial block buf (8-byte aligned) */
  88 };
  89
  90 /* Skein APIs for (incremental) "straight hashing" */
  91 int skein_256_init(struct skein_256_ctx *ctx, size_t hash_bit_len);
  92 int skein_512_init(struct skein_512_ctx *ctx, size_t hash_bit_len);
  93 int skein_1024_init(struct skein_1024_ctx *ctx, size_t hash_bit_len);
  94
  95 int skein_256_update(struct skein_256_ctx *ctx, const u8 *msg,
  96                      size_t msg_byte_cnt);
  97 int skein_512_update(struct skein_512_ctx *ctx, const u8 *msg,
  98                      size_t msg_byte_cnt);
  99 int skein_1024_update(struct skein_1024_ctx *ctx, const u8 *msg,
 100                       size_t msg_byte_cnt);
 101
 102 int skein_256_final(struct skein_256_ctx *ctx, u8 *hash_val);
 103 int skein_512_final(struct skein_512_ctx *ctx, u8 *hash_val);
 104 int skein_1024_final(struct skein_1024_ctx *ctx, u8 *hash_val);
 105
 106 /*
 107 **   Skein APIs for "extended" initialization: MAC keys, tree hashing.
 108 **   After an init_ext() call, just use update/final calls as with init().
 109 **
 110 **   Notes: Same parameters as _init() calls, plus tree_info/key/key_bytes.
 111 **          When key_bytes == 0 and tree_info == SKEIN_SEQUENTIAL,
 112 **              the results of init_ext() are identical to calling init().
 113 **          The function init() may be called once to "precompute" the IV for
 114 **              a given hash_bit_len value, then by saving a copy of the context
 115 **              the IV computation may be avoided in later calls.
 116 **          Similarly, the function init_ext() may be called once per MAC key
 117 **              to precompute the MAC IV, then a copy of the context saved and
 118 **              reused for each new MAC computation.
 119 **/
 120 int skein_256_init_ext(struct skein_256_ctx *ctx, size_t hash_bit_len,
 121                        u64 tree_info, const u8 *key, size_t key_bytes);
 122 int skein_512_init_ext(struct skein_512_ctx *ctx, size_t hash_bit_len,
 123                        u64 tree_info, const u8 *key, size_t key_bytes);
 124 int skein_1024_init_ext(struct skein_1024_ctx *ctx, size_t hash_bit_len,
 125                         u64 tree_info, const u8 *key, size_t key_bytes);
 126
 127 /*
 128 **   Skein APIs for MAC and tree hash:
 129 **      final_pad:  pad, do final block, but no OUTPUT type
 130 **      output:     do just the output stage
 131 */
 132 int skein_256_final_pad(struct skein_256_ctx *ctx, u8 *hash_val);
 133 int skein_512_final_pad(struct skein_512_ctx *ctx, u8 *hash_val);
 134 int skein_1024_final_pad(struct skein_1024_ctx *ctx, u8 *hash_val);
 135
 136 #ifndef SKEIN_TREE_HASH
 137 #define SKEIN_TREE_HASH (1)
 138 #endif
 139 #if  SKEIN_TREE_HASH
 140 int skein_256_output(struct skein_256_ctx *ctx, u8 *hash_val);
 141 int skein_512_output(struct skein_512_ctx *ctx, u8 *hash_val);
 142 int skein_1024_output(struct skein_1024_ctx *ctx, u8 *hash_val);
 143 #endif
 144
 145 /*****************************************************************
 146 ** "Internal" Skein definitions
 147 **    -- not needed for sequential hashing API, but will be
 148 **           helpful for other uses of Skein (e.g., tree hash mode).
 149 **    -- included here so that they can be shared between
 150 **           reference and optimized code.
 151 ******************************************************************/
 152
 153 /* tweak word tweak[1]: bit field starting positions */
 154 #define SKEIN_T1_BIT(BIT)       ((BIT) - 64)      /* second word  */
 155
 156 #define SKEIN_T1_POS_TREE_LVL   SKEIN_T1_BIT(112) /* 112..118 hash tree level */
 157 #define SKEIN_T1_POS_BIT_PAD    SKEIN_T1_BIT(119) /* 119 part. final in byte */
 158 #define SKEIN_T1_POS_BLK_TYPE   SKEIN_T1_BIT(120) /* 120..125 type field `*/
 159 #define SKEIN_T1_POS_FIRST      SKEIN_T1_BIT(126) /* 126      first blk flag */
 160 #define SKEIN_T1_POS_FINAL      SKEIN_T1_BIT(127) /* 127      final blk flag */
 161
 162 /* tweak word tweak[1]: flag bit definition(s) */
 163 #define SKEIN_T1_FLAG_FIRST     (((u64)  1) << SKEIN_T1_POS_FIRST)
 164 #define SKEIN_T1_FLAG_FINAL     (((u64)  1) << SKEIN_T1_POS_FINAL)
 165 #define SKEIN_T1_FLAG_BIT_PAD   (((u64)  1) << SKEIN_T1_POS_BIT_PAD)
 166
 167 /* tweak word tweak[1]: tree level bit field mask */
 168 #define SKEIN_T1_TREE_LVL_MASK  (((u64)0x7F) << SKEIN_T1_POS_TREE_LVL)
 169 #define SKEIN_T1_TREE_LEVEL(n)  (((u64) (n)) << SKEIN_T1_POS_TREE_LVL)
 170
 171 /* tweak word tweak[1]: block type field */
 172 #define SKEIN_BLK_TYPE_KEY       (0) /* key, for MAC and KDF */
 173 #define SKEIN_BLK_TYPE_CFG       (4) /* configuration block */
 174 #define SKEIN_BLK_TYPE_PERS      (8) /* personalization string */
 175 #define SKEIN_BLK_TYPE_PK       (12) /* pubkey (for digital sigs) */
 176 #define SKEIN_BLK_TYPE_KDF      (16) /* key identifier for KDF */
 177 #define SKEIN_BLK_TYPE_NONCE    (20) /* nonce for PRNG */
 178 #define SKEIN_BLK_TYPE_MSG      (48) /* message processing */
 179 #define SKEIN_BLK_TYPE_OUT      (63) /* output stage */
 180 #define SKEIN_BLK_TYPE_MASK     (63) /* bit field mask */
 181
 182 #define SKEIN_T1_BLK_TYPE(T)   (((u64) (SKEIN_BLK_TYPE_##T)) << \
 183                                         SKEIN_T1_POS_BLK_TYPE)
 184 #define SKEIN_T1_BLK_TYPE_KEY   SKEIN_T1_BLK_TYPE(KEY)  /* for MAC and KDF */
 185 #define SKEIN_T1_BLK_TYPE_CFG   SKEIN_T1_BLK_TYPE(CFG)  /* config block */
 186 #define SKEIN_T1_BLK_TYPE_PERS  SKEIN_T1_BLK_TYPE(PERS) /* personalization */
 187 #define SKEIN_T1_BLK_TYPE_PK    SKEIN_T1_BLK_TYPE(PK)   /* pubkey (for sigs) */
 188 #define SKEIN_T1_BLK_TYPE_KDF   SKEIN_T1_BLK_TYPE(KDF)  /* key ident for KDF */
 189 #define SKEIN_T1_BLK_TYPE_NONCE SKEIN_T1_BLK_TYPE(NONCE)/* nonce for PRNG */
 190 #define SKEIN_T1_BLK_TYPE_MSG   SKEIN_T1_BLK_TYPE(MSG)  /* message processing */
 191 #define SKEIN_T1_BLK_TYPE_OUT   SKEIN_T1_BLK_TYPE(OUT)  /* output stage */
 192 #define SKEIN_T1_BLK_TYPE_MASK  SKEIN_T1_BLK_TYPE(MASK) /* field bit mask */
 193
 194 #define SKEIN_T1_BLK_TYPE_CFG_FINAL    (SKEIN_T1_BLK_TYPE_CFG | \
 195                                         SKEIN_T1_FLAG_FINAL)
 196 #define SKEIN_T1_BLK_TYPE_OUT_FINAL    (SKEIN_T1_BLK_TYPE_OUT | \
 197                                         SKEIN_T1_FLAG_FINAL)
 198
 199 #define SKEIN_VERSION           (1)
 200
 201 #ifndef SKEIN_ID_STRING_LE      /* allow compile-time personalization */
 202 #define SKEIN_ID_STRING_LE      (0x33414853) /* "SHA3" (little-endian)*/
 203 #endif
 204
 205 #define SKEIN_MK_64(hi32, lo32)  ((lo32) + (((u64) (hi32)) << 32))
 206 #define SKEIN_SCHEMA_VER        SKEIN_MK_64(SKEIN_VERSION, SKEIN_ID_STRING_LE)
 207 #define SKEIN_KS_PARITY         SKEIN_MK_64(0x1BD11BDA, 0xA9FC1A22)
 208
 209 #define SKEIN_CFG_STR_LEN       (4*8)
 210
 211 /* bit field definitions in config block tree_info word */
 212 #define SKEIN_CFG_TREE_LEAF_SIZE_POS  (0)
 213 #define SKEIN_CFG_TREE_NODE_SIZE_POS  (8)
 214 #define SKEIN_CFG_TREE_MAX_LEVEL_POS  (16)
 215
 216 #define SKEIN_CFG_TREE_LEAF_SIZE_MSK (((u64)0xFF) << \
 217                                         SKEIN_CFG_TREE_LEAF_SIZE_POS)
 218 #define SKEIN_CFG_TREE_NODE_SIZE_MSK (((u64)0xFF) << \
 219                                         SKEIN_CFG_TREE_NODE_SIZE_POS)
 220 #define SKEIN_CFG_TREE_MAX_LEVEL_MSK (((u64)0xFF) << \
 221                                         SKEIN_CFG_TREE_MAX_LEVEL_POS)
 222
 223 #define SKEIN_CFG_TREE_INFO(leaf, node, max_lvl)                   \
 224         ((((u64)(leaf))   << SKEIN_CFG_TREE_LEAF_SIZE_POS) |    \
 225          (((u64)(node))   << SKEIN_CFG_TREE_NODE_SIZE_POS) |    \
 226          (((u64)(max_lvl)) << SKEIN_CFG_TREE_MAX_LEVEL_POS))
 227
 228 /* use as tree_info in InitExt() call for sequential processing */
 229 #define SKEIN_CFG_TREE_INFO_SEQUENTIAL SKEIN_CFG_TREE_INFO(0, 0, 0)
 230
 231 /*
 232 **   Skein macros for getting/setting tweak words, etc.
 233 **   These are useful for partial input bytes, hash tree init/update, etc.
 234 **/
 235 #define skein_get_tweak(ctx_ptr, TWK_NUM)          ((ctx_ptr)->h.tweak[TWK_NUM])
 236 #define skein_set_tweak(ctx_ptr, TWK_NUM, t_val) { \
 237                 (ctx_ptr)->h.tweak[TWK_NUM] = (t_val); \
 238         }
 239
 240 #define skein_get_T0(ctx_ptr)     skein_get_tweak(ctx_ptr, 0)
 241 #define skein_get_T1(ctx_ptr)     skein_get_tweak(ctx_ptr, 1)
 242 #define skein_set_T0(ctx_ptr, T0) skein_set_tweak(ctx_ptr, 0, T0)
 243 #define skein_set_T1(ctx_ptr, T1) skein_set_tweak(ctx_ptr, 1, T1)
 244
 245 /* set both tweak words at once */
 246 #define skein_set_T0_T1(ctx_ptr, T0, T1)           \
 247         {                                          \
 248         skein_set_T0(ctx_ptr, (T0));               \
 249         skein_set_T1(ctx_ptr, (T1));               \
 250         }
 251
 252 #define skein_set_type(ctx_ptr, BLK_TYPE)         \
 253         skein_set_T1(ctx_ptr, SKEIN_T1_BLK_TYPE_##BLK_TYPE)
 254
 255 /*
 256  * setup for starting with a new type:
 257  * h.tweak[0]=0; h.tweak[1] = NEW_TYPE; h.b_cnt=0;
 258  */
 259 #define skein_start_new_type(ctx_ptr, BLK_TYPE) { \
 260                 skein_set_T0_T1(ctx_ptr, 0, SKEIN_T1_FLAG_FIRST | \
 261                                 SKEIN_T1_BLK_TYPE_##BLK_TYPE); \
 262                 (ctx_ptr)->h.b_cnt = 0; \
 263         }
 264
 265 #define skein_clear_first_flag(hdr) { \
 266                 (hdr).tweak[1] &= ~SKEIN_T1_FLAG_FIRST; \
 267         }
 268 #define skein_set_bit_pad_flag(hdr) { \
 269                 (hdr).tweak[1] |=  SKEIN_T1_FLAG_BIT_PAD; \
 270         }
 271
 272 #define skein_set_tree_level(hdr, height) { \
 273                 (hdr).tweak[1] |= SKEIN_T1_TREE_LEVEL(height); \
 274         }
 275
 276 /*****************************************************************
 277 ** "Internal" Skein definitions for debugging and error checking
 278 ******************************************************************/
 279 #ifdef SKEIN_DEBUG             /* examine/display intermediate values? */
 280 #include "skein_debug.h"
 281 #else                           /* default is no callouts */
 282 #define skein_show_block(bits, ctx, x, blk_ptr, w_ptr, ks_event_ptr, ks_odd_ptr)
 283 #define skein_show_round(bits, ctx, r, x)
 284 #define skein_show_r_ptr(bits, ctx, r, x_ptr)
 285 #define skein_show_final(bits, ctx, cnt, out_ptr)
 286 #define skein_show_key(bits, ctx, key, key_bytes)
 287 #endif
 288
 289 /* ignore all asserts, for performance */
 290 #define skein_assert_ret(x, ret_code)
 291 #define skein_assert(x)
 292
 293 /*****************************************************************
 294 ** Skein block function constants (shared across Ref and Opt code)
 295 ******************************************************************/
 296 enum {
 297             /* SKEIN_256 round rotation constants */
 298         R_256_0_0 = 14, R_256_0_1 = 16,
 299         R_256_1_0 = 52, R_256_1_1 = 57,
 300         R_256_2_0 = 23, R_256_2_1 = 40,
 301         R_256_3_0 =  5, R_256_3_1 = 37,
 302         R_256_4_0 = 25, R_256_4_1 = 33,
 303         R_256_5_0 = 46, R_256_5_1 = 12,
 304         R_256_6_0 = 58, R_256_6_1 = 22,
 305         R_256_7_0 = 32, R_256_7_1 = 32,
 306
 307             /* SKEIN_512 round rotation constants */
 308         R_512_0_0 = 46, R_512_0_1 = 36, R_512_0_2 = 19, R_512_0_3 = 37,
 309         R_512_1_0 = 33, R_512_1_1 = 27, R_512_1_2 = 14, R_512_1_3 = 42,
 310         R_512_2_0 = 17, R_512_2_1 = 49, R_512_2_2 = 36, R_512_2_3 = 39,
 311         R_512_3_0 = 44, R_512_3_1 =  9, R_512_3_2 = 54, R_512_3_3 = 56,
 312         R_512_4_0 = 39, R_512_4_1 = 30, R_512_4_2 = 34, R_512_4_3 = 24,
 313         R_512_5_0 = 13, R_512_5_1 = 50, R_512_5_2 = 10, R_512_5_3 = 17,
 314         R_512_6_0 = 25, R_512_6_1 = 29, R_512_6_2 = 39, R_512_6_3 = 43,
 315         R_512_7_0 =  8, R_512_7_1 = 35, R_512_7_2 = 56, R_512_7_3 = 22,
 316
 317             /* SKEIN_1024 round rotation constants */
 318         R1024_0_0 = 24, R1024_0_1 = 13, R1024_0_2 =  8, R1024_0_3 = 47,
 319         R1024_0_4 =  8, R1024_0_5 = 17, R1024_0_6 = 22, R1024_0_7 = 37,
 320         R1024_1_0 = 38, R1024_1_1 = 19, R1024_1_2 = 10, R1024_1_3 = 55,
 321         R1024_1_4 = 49, R1024_1_5 = 18, R1024_1_6 = 23, R1024_1_7 = 52,
 322         R1024_2_0 = 33, R1024_2_1 =  4, R1024_2_2 = 51, R1024_2_3 = 13,
 323         R1024_2_4 = 34, R1024_2_5 = 41, R1024_2_6 = 59, R1024_2_7 = 17,
 324         R1024_3_0 =  5, R1024_3_1 = 20, R1024_3_2 = 48, R1024_3_3 = 41,
 325         R1024_3_4 = 47, R1024_3_5 = 28, R1024_3_6 = 16, R1024_3_7 = 25,
 326         R1024_4_0 = 41, R1024_4_1 =  9, R1024_4_2 = 37, R1024_4_3 = 31,
 327         R1024_4_4 = 12, R1024_4_5 = 47, R1024_4_6 = 44, R1024_4_7 = 30,
 328         R1024_5_0 = 16, R1024_5_1 = 34, R1024_5_2 = 56, R1024_5_3 = 51,
 329         R1024_5_4 =  4, R1024_5_5 = 53, R1024_5_6 = 42, R1024_5_7 = 41,
 330         R1024_6_0 = 31, R1024_6_1 = 44, R1024_6_2 = 47, R1024_6_3 = 46,
 331         R1024_6_4 = 19, R1024_6_5 = 42, R1024_6_6 = 44, R1024_6_7 = 25,
 332         R1024_7_0 =  9, R1024_7_1 = 48, R1024_7_2 = 35, R1024_7_3 = 52,
 333         R1024_7_4 = 23, R1024_7_5 = 31, R1024_7_6 = 37, R1024_7_7 = 20
 334 };
 335
 336 #ifndef SKEIN_ROUNDS
 337 #define SKEIN_256_ROUNDS_TOTAL (72)     /* # rounds for diff block sizes */
 338 #define SKEIN_512_ROUNDS_TOTAL (72)
 339 #define SKEIN_1024_ROUNDS_TOTAL (80)
 340 #else                   /* allow command-line define in range 8*(5..14)   */
 341 #define SKEIN_256_ROUNDS_TOTAL (8*((((SKEIN_ROUNDS/100) + 5) % 10) + 5))
 342 #define SKEIN_512_ROUNDS_TOTAL (8*((((SKEIN_ROUNDS/10)  + 5) % 10) + 5))
 343 #define SKEIN_1024_ROUNDS_TOTAL (8*((((SKEIN_ROUNDS)     + 5) % 10) + 5))
 344 #endif
 345
 346 #endif  /* ifndef _SKEIN_H_ */