crypto/blake2/blake2s.c

   1 /*
   2  * Copyright 2012, Samuel Neves <sneves@dei.uc.pt>.
   3  * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
   4  *
   5  * Licensed under the OpenSSL licenses, (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  * https://www.openssl.org/source/license.html
   9  * or in the file LICENSE in the source distribution.
  10  */
  11
  12 /*
  13  * Derived from the BLAKE2 reference implementation written by Samuel Neves.
  14  * More information about the BLAKE2 hash function and its implementations
  15  * can be found at https://blake2.net.
  16  */
  17
  18 #ifndef BLAKE_DEBUG
  19 # undef NDEBUG                  /* avoid conflicting definitions */
  20 # define NDEBUG
  21 #endif
  22
  23 #include <assert.h>
  24 #include <string.h>
  25 #include <openssl/crypto.h>
  26 #include "e_os.h"
  27
  28 #include "blake2_locl.h"
  29 #include "blake2_impl.h"
  30
  31 static const uint32_t blake2s_IV[8] =
  32 {
  33     0x6A09E667U, 0xBB67AE85U, 0x3C6EF372U, 0xA54FF53AU,
  34     0x510E527FU, 0x9B05688CU, 0x1F83D9ABU, 0x5BE0CD19U
  35 };
  36
  37 static const uint8_t blake2s_sigma[10][16] =
  38 {
  39     {  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15 } ,
  40     { 14, 10,  4,  8,  9, 15, 13,  6,  1, 12,  0,  2, 11,  7,  5,  3 } ,
  41     { 11,  8, 12,  0,  5,  2, 15, 13, 10, 14,  3,  6,  7,  1,  9,  4 } ,
  42     {  7,  9,  3,  1, 13, 12, 11, 14,  2,  6,  5, 10,  4,  0, 15,  8 } ,
  43     {  9,  0,  5,  7,  2,  4, 10, 15, 14,  1, 11, 12,  6,  8,  3, 13 } ,
  44     {  2, 12,  6, 10,  0, 11,  8,  3,  4, 13,  7,  5, 15, 14,  1,  9 } ,
  45     { 12,  5,  1, 15, 14, 13,  4, 10,  0,  7,  6,  3,  9,  2,  8, 11 } ,
  46     { 13, 11,  7, 14, 12,  1,  3,  9,  5,  0, 15,  4,  8,  6,  2, 10 } ,
  47     {  6, 15, 14,  9, 11,  3,  0,  8, 12,  2, 13,  7,  1,  4, 10,  5 } ,
  48     { 10,  2,  8,  4,  7,  6,  1,  5, 15, 11,  9, 14,  3, 12, 13 , 0 } ,
  49 };
  50
  51 /* Set that it's the last block we'll compress */
  52 static ossl_inline void blake2s_set_lastblock(BLAKE2S_CTX *S)
  53 {
  54     S->f[0] = -1;
  55 }
  56
  57 /* Initialize the hashing state. */
  58 static ossl_inline void blake2s_init0(BLAKE2S_CTX *S)
  59 {
  60     int i;
  61
  62     memset(S, 0, sizeof(BLAKE2S_CTX));
  63     for (i = 0; i < 8; ++i) {
  64         S->h[i] = blake2s_IV[i];
  65     }
  66 }
  67
  68 /* init2 xors IV with input parameter block */
  69 static void blake2s_init_param(BLAKE2S_CTX *S, const BLAKE2S_PARAM *P)
  70 {
  71     const uint8_t *p = (const uint8_t *)(P);
  72     size_t i;
  73
  74     /* The param struct is carefully hand packed, and should be 32 bytes on
  75      * every platform. */
  76     assert(sizeof(BLAKE2S_PARAM) == 32);
  77     blake2s_init0(S);
  78     /* IV XOR ParamBlock */
  79     for (i = 0; i < 8; ++i) {
  80         S->h[i] ^= load32(&p[i*4]);
  81     }
  82 }
  83
  84 /* Initialize the hashing context.  Always returns 1. */
  85 int BLAKE2s_Init(BLAKE2S_CTX *c)
  86 {
  87     BLAKE2S_PARAM P[1];
  88
  89     P->digest_length = BLAKE2S_DIGEST_LENGTH;
  90     P->key_length    = 0;
  91     P->fanout        = 1;
  92     P->depth         = 1;
  93     store32(P->leaf_length, 0);
  94     store48(P->node_offset, 0);
  95     P->node_depth    = 0;
  96     P->inner_length  = 0;
  97     memset(P->salt,     0, sizeof(P->salt));
  98     memset(P->personal, 0, sizeof(P->personal));
  99     blake2s_init_param(c, P);
 100     return 1;
 101 }
 102
 103 /* Permute the state while xoring in the block of data. */
 104 static void blake2s_compress(BLAKE2S_CTX *S,
 105                             const uint8_t *blocks,
 106                             size_t len)
 107 {
 108     uint32_t m[16];
 109     uint32_t v[16];
 110     size_t i;
 111     size_t increment;
 112
 113     /*
 114      * There are two distinct usage vectors for this function:
 115      *
 116      * a) BLAKE2s_Update uses it to process complete blocks,
 117      *    possibly more than one at a time;
 118      *
 119      * b) BLAK2s_Final uses it to process last block, always
 120      *    single but possibly incomplete, in which case caller
 121      *    pads input with zeros.
 122      */
 123     assert(len < BLAKE2S_BLOCKBYTES || len % BLAKE2S_BLOCKBYTES == 0);
 124
 125     /*
 126      * Since last block is always processed with separate call,
 127      * |len| not being multiple of complete blocks can be observed
 128      * only with |len| being less than BLAKE2S_BLOCKBYTES ("less"
 129      * including even zero), which is why following assignment doesn't
 130      * have to reside inside the main loop below.
 131      */
 132     increment = len < BLAKE2S_BLOCKBYTES ? len : BLAKE2S_BLOCKBYTES;
 133
 134     for (i = 0; i < 8; ++i) {
 135         v[i] = S->h[i];
 136     }
 137
 138     do {
 139         for (i = 0; i < 16; ++i) {
 140             m[i] = load32(blocks + i * sizeof(m[i]));
 141         }
 142
 143         /* blake2s_increment_counter */
 144         S->t[0] += increment;
 145         S->t[1] += (S->t[0] < increment);
 146
 147         v[ 8] = blake2s_IV[0];
 148         v[ 9] = blake2s_IV[1];
 149         v[10] = blake2s_IV[2];
 150         v[11] = blake2s_IV[3];
 151         v[12] = S->t[0] ^ blake2s_IV[4];
 152         v[13] = S->t[1] ^ blake2s_IV[5];
 153         v[14] = S->f[0] ^ blake2s_IV[6];
 154         v[15] = S->f[1] ^ blake2s_IV[7];
 155 #define G(r,i,a,b,c,d) \
 156         do { \
 157             a = a + b + m[blake2s_sigma[r][2*i+0]]; \
 158             d = rotr32(d ^ a, 16); \
 159             c = c + d; \
 160             b = rotr32(b ^ c, 12); \
 161             a = a + b + m[blake2s_sigma[r][2*i+1]]; \
 162             d = rotr32(d ^ a, 8); \
 163             c = c + d; \
 164             b = rotr32(b ^ c, 7); \
 165         } while (0)
 166 #define ROUND(r)  \
 167         do { \
 168             G(r,0,v[ 0],v[ 4],v[ 8],v[12]); \
 169             G(r,1,v[ 1],v[ 5],v[ 9],v[13]); \
 170             G(r,2,v[ 2],v[ 6],v[10],v[14]); \
 171             G(r,3,v[ 3],v[ 7],v[11],v[15]); \
 172             G(r,4,v[ 0],v[ 5],v[10],v[15]); \
 173             G(r,5,v[ 1],v[ 6],v[11],v[12]); \
 174             G(r,6,v[ 2],v[ 7],v[ 8],v[13]); \
 175             G(r,7,v[ 3],v[ 4],v[ 9],v[14]); \
 176         } while (0)
 177 #if defined(OPENSSL_SMALL_FOOTPRINT)
 178         /* almost 3x reduction on x86_64, 4.5x on ARMv8, 4x on ARMv4 */
 179         for (i = 0; i < 10; i++) {
 180             ROUND(i);
 181         }
 182 #else
 183         ROUND(0);
 184         ROUND(1);
 185         ROUND(2);
 186         ROUND(3);
 187         ROUND(4);
 188         ROUND(5);
 189         ROUND(6);
 190         ROUND(7);
 191         ROUND(8);
 192         ROUND(9);
 193 #endif
 194
 195         for (i = 0; i < 8; ++i) {
 196             S->h[i] = v[i] ^= v[i + 8] ^ S->h[i];
 197         }
 198 #undef G
 199 #undef ROUND
 200         blocks += increment;
 201         len -= increment;
 202     } while (len);
 203 }
 204
 205 /* Absorb the input data into the hash state.  Always returns 1. */
 206 int BLAKE2s_Update(BLAKE2S_CTX *c, const void *data, size_t datalen)
 207 {
 208     const uint8_t *in = data;
 209     size_t fill;
 210
 211     /*
 212      * Intuitively one would expect intermediate buffer, c->buf, to
 213      * store incomplete blocks. But in this case we are interested to
 214      * temporarily stash even complete blocks, because last one in the
 215      * stream has to be treated in special way, and at this point we
 216      * don't know if last block in *this* call is last one "ever". This
 217      * is the reason for why |datalen| is compared as >, and not >=.
 218      */
 219     fill = sizeof(c->buf) - c->buflen;
 220     if (datalen > fill) {
 221         if (c->buflen) {
 222             memcpy(c->buf + c->buflen, in, fill); /* Fill buffer */
 223             blake2s_compress(c, c->buf, BLAKE2S_BLOCKBYTES);
 224             c->buflen = 0;
 225             in += fill;
 226             datalen -= fill;
 227         }
 228         if (datalen > BLAKE2S_BLOCKBYTES)  {
 229             size_t stashlen = datalen % BLAKE2S_BLOCKBYTES;
 230             /*
 231              * If |datalen| is a multiple of the blocksize, stash
 232              * last complete block, it can be final one...
 233              */
 234             stashlen = stashlen ? stashlen : BLAKE2S_BLOCKBYTES;
 235             datalen -= stashlen;
 236             blake2s_compress(c, in, datalen);
 237             in += datalen;
 238             datalen = stashlen;
 239         }
 240     }
 241
 242     assert(datalen <= BLAKE2S_BLOCKBYTES);
 243
 244     memcpy(c->buf + c->buflen, in, datalen);
 245     c->buflen += datalen; /* Be lazy, do not compress */
 246
 247     return 1;
 248 }
 249
 250 /*
 251  * Calculate the final hash and save it in md.
 252  * Always returns 1.
 253  */
 254 int BLAKE2s_Final(unsigned char *md, BLAKE2S_CTX *c)
 255 {
 256     int i;
 257
 258     blake2s_set_lastblock(c);
 259     /* Padding */
 260     memset(c->buf + c->buflen, 0, sizeof(c->buf) - c->buflen);
 261     blake2s_compress(c, c->buf, c->buflen);
 262
 263     /* Output full hash to temp buffer */
 264     for (i = 0; i < 8; ++i) {
 265         store32(md + sizeof(c->h[i]) * i, c->h[i]);
 266     }
 267
 268     OPENSSL_cleanse(c, sizeof(BLAKE2S_CTX));
 269     return 1;
 270 }