providers/implementations/digests/blake2b_prov.c

   1 /*
   2  * Copyright 2016-2023 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 #include <openssl/core_names.h>
  21 #include <openssl/proverr.h>
  22 #include <openssl/err.h>
  23 #include "blake2_impl.h"
  24 #include "prov/blake2.h"
  25
  26 static const OSSL_PARAM known_blake2b_settable_ctx_params[] = {
  27     {OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0},
  28     OSSL_PARAM_END
  29 };
  30
  31 const OSSL_PARAM *ossl_blake2b_settable_ctx_params(ossl_unused void *ctx,
  32                                                    ossl_unused void *pctx)
  33 {
  34     return known_blake2b_settable_ctx_params;
  35 }
  36
  37 int ossl_blake2b_set_ctx_params(void *vctx, const OSSL_PARAM params[])
  38 {
  39     size_t xoflen;
  40     struct blake2b_md_data_st *mdctx = vctx;
  41     const OSSL_PARAM *p;
  42
  43     BLAKE2B_CTX *ctx = &mdctx->ctx;
  44
  45     if (ctx == NULL)
  46         return 0;
  47     if (params == NULL)
  48         return 1;
  49
  50     p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN);
  51     if (p != NULL) {
  52         if (!OSSL_PARAM_get_size_t(p, &xoflen)) {
  53             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
  54             return 0;
  55         }
  56         ossl_blake2b_param_set_digest_length(&mdctx->params, (uint8_t)xoflen);
  57     }
  58
  59     return 1;
  60 }
  61
  62 static const uint64_t blake2b_IV[8] =
  63 {
  64     0x6a09e667f3bcc908ULL, 0xbb67ae8584caa73bULL,
  65     0x3c6ef372fe94f82bULL, 0xa54ff53a5f1d36f1ULL,
  66     0x510e527fade682d1ULL, 0x9b05688c2b3e6c1fULL,
  67     0x1f83d9abfb41bd6bULL, 0x5be0cd19137e2179ULL
  68 };
  69
  70 static const uint8_t blake2b_sigma[12][16] =
  71 {
  72     {  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15 } ,
  73     { 14, 10,  4,  8,  9, 15, 13,  6,  1, 12,  0,  2, 11,  7,  5,  3 } ,
  74     { 11,  8, 12,  0,  5,  2, 15, 13, 10, 14,  3,  6,  7,  1,  9,  4 } ,
  75     {  7,  9,  3,  1, 13, 12, 11, 14,  2,  6,  5, 10,  4,  0, 15,  8 } ,
  76     {  9,  0,  5,  7,  2,  4, 10, 15, 14,  1, 11, 12,  6,  8,  3, 13 } ,
  77     {  2, 12,  6, 10,  0, 11,  8,  3,  4, 13,  7,  5, 15, 14,  1,  9 } ,
  78     { 12,  5,  1, 15, 14, 13,  4, 10,  0,  7,  6,  3,  9,  2,  8, 11 } ,
  79     { 13, 11,  7, 14, 12,  1,  3,  9,  5,  0, 15,  4,  8,  6,  2, 10 } ,
  80     {  6, 15, 14,  9, 11,  3,  0,  8, 12,  2, 13,  7,  1,  4, 10,  5 } ,
  81     { 10,  2,  8,  4,  7,  6,  1,  5, 15, 11,  9, 14,  3, 12, 13 , 0 } ,
  82     {  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15 } ,
  83     { 14, 10,  4,  8,  9, 15, 13,  6,  1, 12,  0,  2, 11,  7,  5,  3 }
  84 };
  85
  86 /* Set that it's the last block we'll compress */
  87 static ossl_inline void blake2b_set_lastblock(BLAKE2B_CTX *S)
  88 {
  89     S->f[0] = -1;
  90 }
  91
  92 /* Initialize the hashing state. */
  93 static ossl_inline void blake2b_init0(BLAKE2B_CTX *S)
  94 {
  95     int i;
  96
  97     memset(S, 0, sizeof(BLAKE2B_CTX));
  98     for (i = 0; i < 8; ++i) {
  99         S->h[i] = blake2b_IV[i];
 100     }
 101 }
 102
 103 /* init xors IV with input parameter block and sets the output length */
 104 static void blake2b_init_param(BLAKE2B_CTX *S, const BLAKE2B_PARAM *P)
 105 {
 106     size_t i;
 107     const uint8_t *p = (const uint8_t *)(P);
 108
 109     blake2b_init0(S);
 110     S->outlen = P->digest_length;
 111
 112     /* The param struct is carefully hand packed, and should be 64 bytes on
 113      * every platform. */
 114     assert(sizeof(BLAKE2B_PARAM) == 64);
 115     /* IV XOR ParamBlock */
 116     for (i = 0; i < 8; ++i) {
 117         S->h[i] ^= load64(p + sizeof(S->h[i]) * i);
 118     }
 119 }
 120
 121 /* Initialize the parameter block with default values */
 122 void ossl_blake2b_param_init(BLAKE2B_PARAM *P)
 123 {
 124     P->digest_length = BLAKE2B_DIGEST_LENGTH;
 125     P->key_length    = 0;
 126     P->fanout        = 1;
 127     P->depth         = 1;
 128     store32(P->leaf_length, 0);
 129     store64(P->node_offset, 0);
 130     P->node_depth    = 0;
 131     P->inner_length  = 0;
 132     memset(P->reserved, 0, sizeof(P->reserved));
 133     memset(P->salt,     0, sizeof(P->salt));
 134     memset(P->personal, 0, sizeof(P->personal));
 135 }
 136
 137 void ossl_blake2b_param_set_digest_length(BLAKE2B_PARAM *P, uint8_t outlen)
 138 {
 139     P->digest_length = outlen;
 140 }
 141
 142 void ossl_blake2b_param_set_key_length(BLAKE2B_PARAM *P, uint8_t keylen)
 143 {
 144     P->key_length = keylen;
 145 }
 146
 147 void ossl_blake2b_param_set_personal(BLAKE2B_PARAM *P, const uint8_t *personal,
 148                                      size_t len)
 149 {
 150     memcpy(P->personal, personal, len);
 151     memset(P->personal + len, 0, BLAKE2B_PERSONALBYTES - len);
 152 }
 153
 154 void ossl_blake2b_param_set_salt(BLAKE2B_PARAM *P, const uint8_t *salt,
 155                                  size_t len)
 156 {
 157     memcpy(P->salt, salt, len);
 158     memset(P->salt + len, 0, BLAKE2B_SALTBYTES - len);
 159 }
 160
 161 /*
 162  * Initialize the hashing context with the given parameter block.
 163  * Always returns 1.
 164  */
 165 int ossl_blake2b_init(BLAKE2B_CTX *c, const BLAKE2B_PARAM *P)
 166 {
 167     blake2b_init_param(c, P);
 168     return 1;
 169 }
 170
 171 /*
 172  * Initialize the hashing context with the given parameter block and key.
 173  * Always returns 1.
 174  */
 175 int ossl_blake2b_init_key(BLAKE2B_CTX *c, const BLAKE2B_PARAM *P,
 176                           const void *key)
 177 {
 178     blake2b_init_param(c, P);
 179
 180     /* Pad the key to form first data block */
 181     {
 182         uint8_t block[BLAKE2B_BLOCKBYTES] = {0};
 183
 184         memcpy(block, key, P->key_length);
 185         ossl_blake2b_update(c, block, BLAKE2B_BLOCKBYTES);
 186         OPENSSL_cleanse(block, BLAKE2B_BLOCKBYTES);
 187     }
 188
 189     return 1;
 190 }
 191
 192 /* Permute the state while xoring in the block of data. */
 193 static void blake2b_compress(BLAKE2B_CTX *S,
 194                             const uint8_t *blocks,
 195                             size_t len)
 196 {
 197     uint64_t m[16];
 198     uint64_t v[16];
 199     int i;
 200     size_t increment;
 201
 202     /*
 203      * There are two distinct usage vectors for this function:
 204      *
 205      * a) BLAKE2b_Update uses it to process complete blocks,
 206      *    possibly more than one at a time;
 207      *
 208      * b) BLAK2b_Final uses it to process last block, always
 209      *    single but possibly incomplete, in which case caller
 210      *    pads input with zeros.
 211      */
 212     assert(len < BLAKE2B_BLOCKBYTES || len % BLAKE2B_BLOCKBYTES == 0);
 213
 214     /*
 215      * Since last block is always processed with separate call,
 216      * |len| not being multiple of complete blocks can be observed
 217      * only with |len| being less than BLAKE2B_BLOCKBYTES ("less"
 218      * including even zero), which is why following assignment doesn't
 219      * have to reside inside the main loop below.
 220      */
 221     increment = len < BLAKE2B_BLOCKBYTES ? len : BLAKE2B_BLOCKBYTES;
 222
 223     for (i = 0; i < 8; ++i) {
 224         v[i] = S->h[i];
 225     }
 226
 227     do {
 228         for (i = 0; i < 16; ++i) {
 229             m[i] = load64(blocks + i * sizeof(m[i]));
 230         }
 231
 232         /* blake2b_increment_counter */
 233         S->t[0] += increment;
 234         S->t[1] += (S->t[0] < increment);
 235
 236         v[8]  = blake2b_IV[0];
 237         v[9]  = blake2b_IV[1];
 238         v[10] = blake2b_IV[2];
 239         v[11] = blake2b_IV[3];
 240         v[12] = S->t[0] ^ blake2b_IV[4];
 241         v[13] = S->t[1] ^ blake2b_IV[5];
 242         v[14] = S->f[0] ^ blake2b_IV[6];
 243         v[15] = S->f[1] ^ blake2b_IV[7];
 244 #define G(r,i,a,b,c,d) \
 245         do { \
 246             a = a + b + m[blake2b_sigma[r][2*i+0]]; \
 247             d = rotr64(d ^ a, 32); \
 248             c = c + d; \
 249             b = rotr64(b ^ c, 24); \
 250             a = a + b + m[blake2b_sigma[r][2*i+1]]; \
 251             d = rotr64(d ^ a, 16); \
 252             c = c + d; \
 253             b = rotr64(b ^ c, 63); \
 254         } while (0)
 255 #define ROUND(r)  \
 256         do { \
 257             G(r,0,v[ 0],v[ 4],v[ 8],v[12]); \
 258             G(r,1,v[ 1],v[ 5],v[ 9],v[13]); \
 259             G(r,2,v[ 2],v[ 6],v[10],v[14]); \
 260             G(r,3,v[ 3],v[ 7],v[11],v[15]); \
 261             G(r,4,v[ 0],v[ 5],v[10],v[15]); \
 262             G(r,5,v[ 1],v[ 6],v[11],v[12]); \
 263             G(r,6,v[ 2],v[ 7],v[ 8],v[13]); \
 264             G(r,7,v[ 3],v[ 4],v[ 9],v[14]); \
 265         } while (0)
 266 #if defined(OPENSSL_SMALL_FOOTPRINT)
 267         /* 3x size reduction on x86_64, almost 7x on ARMv8, 9x on ARMv4 */
 268         for (i = 0; i < 12; i++) {
 269             ROUND(i);
 270         }
 271 #else
 272         ROUND(0);
 273         ROUND(1);
 274         ROUND(2);
 275         ROUND(3);
 276         ROUND(4);
 277         ROUND(5);
 278         ROUND(6);
 279         ROUND(7);
 280         ROUND(8);
 281         ROUND(9);
 282         ROUND(10);
 283         ROUND(11);
 284 #endif
 285
 286         for (i = 0; i < 8; ++i) {
 287             S->h[i] = v[i] ^= v[i + 8] ^ S->h[i];
 288         }
 289 #undef G
 290 #undef ROUND
 291         blocks += increment;
 292         len -= increment;
 293     } while (len);
 294 }
 295
 296 /* Absorb the input data into the hash state.  Always returns 1. */
 297 int ossl_blake2b_update(BLAKE2B_CTX *c, const void *data, size_t datalen)
 298 {
 299     const uint8_t *in = data;
 300     size_t fill;
 301
 302     /*
 303      * Intuitively one would expect intermediate buffer, c->buf, to
 304      * store incomplete blocks. But in this case we are interested to
 305      * temporarily stash even complete blocks, because last one in the
 306      * stream has to be treated in special way, and at this point we
 307      * don't know if last block in *this* call is last one "ever". This
 308      * is the reason for why |datalen| is compared as >, and not >=.
 309      */
 310     fill = sizeof(c->buf) - c->buflen;
 311     if (datalen > fill) {
 312         if (c->buflen) {
 313             memcpy(c->buf + c->buflen, in, fill); /* Fill buffer */
 314             blake2b_compress(c, c->buf, BLAKE2B_BLOCKBYTES);
 315             c->buflen = 0;
 316             in += fill;
 317             datalen -= fill;
 318         }
 319         if (datalen > BLAKE2B_BLOCKBYTES) {
 320             size_t stashlen = datalen % BLAKE2B_BLOCKBYTES;
 321             /*
 322              * If |datalen| is a multiple of the blocksize, stash
 323              * last complete block, it can be final one...
 324              */
 325             stashlen = stashlen ? stashlen : BLAKE2B_BLOCKBYTES;
 326             datalen -= stashlen;
 327             blake2b_compress(c, in, datalen);
 328             in += datalen;
 329             datalen = stashlen;
 330         }
 331     }
 332
 333     assert(datalen <= BLAKE2B_BLOCKBYTES);
 334
 335     memcpy(c->buf + c->buflen, in, datalen);
 336     c->buflen += datalen; /* Be lazy, do not compress */
 337
 338     return 1;
 339 }
 340
 341 /*
 342  * Calculate the final hash and save it in md.
 343  * Always returns 1.
 344  */
 345 int ossl_blake2b_final(unsigned char *md, BLAKE2B_CTX *c)
 346 {
 347     uint8_t outbuffer[BLAKE2B_OUTBYTES] = {0};
 348     uint8_t *target = outbuffer;
 349     int iter = (c->outlen + 7) / 8;
 350     int i;
 351
 352     /* Avoid writing to the temporary buffer if possible */
 353     if ((c->outlen % sizeof(c->h[0])) == 0)
 354         target = md;
 355
 356     blake2b_set_lastblock(c);
 357     /* Padding */
 358     memset(c->buf + c->buflen, 0, sizeof(c->buf) - c->buflen);
 359     blake2b_compress(c, c->buf, c->buflen);
 360
 361     /* Output full hash to buffer */
 362     for (i = 0; i < iter; ++i)
 363         store64(target + sizeof(c->h[i]) * i, c->h[i]);
 364
 365     if (target != md)
 366         memcpy(md, target, c->outlen);
 367
 368     OPENSSL_cleanse(c, sizeof(BLAKE2B_CTX));
 369     return 1;
 370 }