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