crypto/blake2/blake2s.c

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