2 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
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
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.
19 #include <openssl/crypto.h>
21 #include "blake2_locl.h"
22 #include "blake2_impl.h"
24 static const uint64_t blake2b_IV[8] =
26 0x6a09e667f3bcc908ULL, 0xbb67ae8584caa73bULL,
27 0x3c6ef372fe94f82bULL, 0xa54ff53a5f1d36f1ULL,
28 0x510e527fade682d1ULL, 0x9b05688c2b3e6c1fULL,
29 0x1f83d9abfb41bd6bULL, 0x5be0cd19137e2179ULL
32 static const uint8_t blake2b_sigma[12][16] =
34 { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 } ,
35 { 14, 10, 4, 8, 9, 15, 13, 6, 1, 12, 0, 2, 11, 7, 5, 3 } ,
36 { 11, 8, 12, 0, 5, 2, 15, 13, 10, 14, 3, 6, 7, 1, 9, 4 } ,
37 { 7, 9, 3, 1, 13, 12, 11, 14, 2, 6, 5, 10, 4, 0, 15, 8 } ,
38 { 9, 0, 5, 7, 2, 4, 10, 15, 14, 1, 11, 12, 6, 8, 3, 13 } ,
39 { 2, 12, 6, 10, 0, 11, 8, 3, 4, 13, 7, 5, 15, 14, 1, 9 } ,
40 { 12, 5, 1, 15, 14, 13, 4, 10, 0, 7, 6, 3, 9, 2, 8, 11 } ,
41 { 13, 11, 7, 14, 12, 1, 3, 9, 5, 0, 15, 4, 8, 6, 2, 10 } ,
42 { 6, 15, 14, 9, 11, 3, 0, 8, 12, 2, 13, 7, 1, 4, 10, 5 } ,
43 { 10, 2, 8, 4, 7, 6, 1, 5, 15, 11, 9, 14, 3, 12, 13 , 0 } ,
44 { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 } ,
45 { 14, 10, 4, 8, 9, 15, 13, 6, 1, 12, 0, 2, 11, 7, 5, 3 }
48 /* Set that it's the last block we'll compress */
49 static ossl_inline void blake2b_set_lastblock(BLAKE2B_CTX *S)
54 /* Initialize the hashing state. */
55 static ossl_inline void blake2b_init0(BLAKE2B_CTX *S)
59 memset(S, 0, sizeof(BLAKE2B_CTX));
60 for (i = 0; i < 8; ++i) {
61 S->h[i] = blake2b_IV[i];
65 /* init xors IV with input parameter block and sets the output length */
66 static void blake2b_init_param(BLAKE2B_CTX *S, const BLAKE2B_PARAM *P)
69 const uint8_t *p = (const uint8_t *)(P);
72 S->outlen = P->digest_length;
74 /* The param struct is carefully hand packed, and should be 64 bytes on
76 assert(sizeof(BLAKE2B_PARAM) == 64);
77 /* IV XOR ParamBlock */
78 for (i = 0; i < 8; ++i) {
79 S->h[i] ^= load64(p + sizeof(S->h[i]) * i);
83 /* Initialize the parameter block with default values */
84 void blake2b_param_init(BLAKE2B_PARAM *P)
86 P->digest_length = BLAKE2B_DIGEST_LENGTH;
90 store32(P->leaf_length, 0);
91 store64(P->node_offset, 0);
94 memset(P->reserved, 0, sizeof(P->reserved));
95 memset(P->salt, 0, sizeof(P->salt));
96 memset(P->personal, 0, sizeof(P->personal));
99 void blake2b_param_set_digest_length(BLAKE2B_PARAM *P, uint8_t outlen)
101 P->digest_length = outlen;
104 void blake2b_param_set_key_length(BLAKE2B_PARAM *P, uint8_t keylen)
106 P->key_length = keylen;
109 void blake2b_param_set_personal(BLAKE2B_PARAM *P, const uint8_t *personal, size_t len)
111 memcpy(P->personal, personal, len);
112 memset(P->personal + len, 0, BLAKE2B_PERSONALBYTES - len);
115 void blake2b_param_set_salt(BLAKE2B_PARAM *P, const uint8_t *salt, size_t len)
117 memcpy(P->salt, salt, len);
118 memset(P->salt + len, 0, BLAKE2B_SALTBYTES - len);
122 * Initialize the hashing context with the given parameter block.
125 int BLAKE2b_Init(BLAKE2B_CTX *c, const BLAKE2B_PARAM *P)
127 blake2b_init_param(c, P);
132 * Initialize the hashing context with the given parameter block and key.
135 int BLAKE2b_Init_key(BLAKE2B_CTX *c, const BLAKE2B_PARAM *P, const void *key)
137 blake2b_init_param(c, P);
139 /* Pad the key to form first data block */
141 uint8_t block[BLAKE2B_BLOCKBYTES] = {0};
143 memcpy(block, key, P->key_length);
144 BLAKE2b_Update(c, block, BLAKE2B_BLOCKBYTES);
145 OPENSSL_cleanse(block, BLAKE2B_BLOCKBYTES);
151 /* Permute the state while xoring in the block of data. */
152 static void blake2b_compress(BLAKE2B_CTX *S,
153 const uint8_t *blocks,
162 * There are two distinct usage vectors for this function:
164 * a) BLAKE2b_Update uses it to process complete blocks,
165 * possibly more than one at a time;
167 * b) BLAK2b_Final uses it to process last block, always
168 * single but possibly incomplete, in which case caller
169 * pads input with zeros.
171 assert(len < BLAKE2B_BLOCKBYTES || len % BLAKE2B_BLOCKBYTES == 0);
174 * Since last block is always processed with separate call,
175 * |len| not being multiple of complete blocks can be observed
176 * only with |len| being less than BLAKE2B_BLOCKBYTES ("less"
177 * including even zero), which is why following assignment doesn't
178 * have to reside inside the main loop below.
180 increment = len < BLAKE2B_BLOCKBYTES ? len : BLAKE2B_BLOCKBYTES;
182 for (i = 0; i < 8; ++i) {
187 for (i = 0; i < 16; ++i) {
188 m[i] = load64(blocks + i * sizeof(m[i]));
191 /* blake2b_increment_counter */
192 S->t[0] += increment;
193 S->t[1] += (S->t[0] < increment);
195 v[8] = blake2b_IV[0];
196 v[9] = blake2b_IV[1];
197 v[10] = blake2b_IV[2];
198 v[11] = blake2b_IV[3];
199 v[12] = S->t[0] ^ blake2b_IV[4];
200 v[13] = S->t[1] ^ blake2b_IV[5];
201 v[14] = S->f[0] ^ blake2b_IV[6];
202 v[15] = S->f[1] ^ blake2b_IV[7];
203 #define G(r,i,a,b,c,d) \
205 a = a + b + m[blake2b_sigma[r][2*i+0]]; \
206 d = rotr64(d ^ a, 32); \
208 b = rotr64(b ^ c, 24); \
209 a = a + b + m[blake2b_sigma[r][2*i+1]]; \
210 d = rotr64(d ^ a, 16); \
212 b = rotr64(b ^ c, 63); \
216 G(r,0,v[ 0],v[ 4],v[ 8],v[12]); \
217 G(r,1,v[ 1],v[ 5],v[ 9],v[13]); \
218 G(r,2,v[ 2],v[ 6],v[10],v[14]); \
219 G(r,3,v[ 3],v[ 7],v[11],v[15]); \
220 G(r,4,v[ 0],v[ 5],v[10],v[15]); \
221 G(r,5,v[ 1],v[ 6],v[11],v[12]); \
222 G(r,6,v[ 2],v[ 7],v[ 8],v[13]); \
223 G(r,7,v[ 3],v[ 4],v[ 9],v[14]); \
225 #if defined(OPENSSL_SMALL_FOOTPRINT)
226 /* 3x size reduction on x86_64, almost 7x on ARMv8, 9x on ARMv4 */
227 for (i = 0; i < 12; i++) {
245 for (i = 0; i < 8; ++i) {
246 S->h[i] = v[i] ^= v[i + 8] ^ S->h[i];
255 /* Absorb the input data into the hash state. Always returns 1. */
256 int BLAKE2b_Update(BLAKE2B_CTX *c, const void *data, size_t datalen)
258 const uint8_t *in = data;
262 * Intuitively one would expect intermediate buffer, c->buf, to
263 * store incomplete blocks. But in this case we are interested to
264 * temporarily stash even complete blocks, because last one in the
265 * stream has to be treated in special way, and at this point we
266 * don't know if last block in *this* call is last one "ever". This
267 * is the reason for why |datalen| is compared as >, and not >=.
269 fill = sizeof(c->buf) - c->buflen;
270 if (datalen > fill) {
272 memcpy(c->buf + c->buflen, in, fill); /* Fill buffer */
273 blake2b_compress(c, c->buf, BLAKE2B_BLOCKBYTES);
278 if (datalen > BLAKE2B_BLOCKBYTES) {
279 size_t stashlen = datalen % BLAKE2B_BLOCKBYTES;
281 * If |datalen| is a multiple of the blocksize, stash
282 * last complete block, it can be final one...
284 stashlen = stashlen ? stashlen : BLAKE2B_BLOCKBYTES;
286 blake2b_compress(c, in, datalen);
292 assert(datalen <= BLAKE2B_BLOCKBYTES);
294 memcpy(c->buf + c->buflen, in, datalen);
295 c->buflen += datalen; /* Be lazy, do not compress */
301 * Calculate the final hash and save it in md.
304 int BLAKE2b_Final(unsigned char *md, BLAKE2B_CTX *c)
306 uint8_t outbuffer[BLAKE2B_OUTBYTES] = {0};
307 uint8_t *target = outbuffer;
308 int iter = (c->outlen + 7) / 8;
311 /* Avoid writing to the temporary buffer if possible */
312 if ((c->outlen % sizeof(c->h[0])) == 0)
315 blake2b_set_lastblock(c);
317 memset(c->buf + c->buflen, 0, sizeof(c->buf) - c->buflen);
318 blake2b_compress(c, c->buf, c->buflen);
320 /* Output full hash to buffer */
321 for (i = 0; i < iter; ++i)
322 store64(target + sizeof(c->h[i]) * i, c->h[i]);
325 memcpy(md, target, c->outlen);
327 OPENSSL_cleanse(c, sizeof(BLAKE2B_CTX));