crypto/blake2/blake2s.c

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