06fbbd07aaf6b68a744c6bb676b3f8e00dd8fe44
[openssl.git] / providers / implementations / ciphers / ciphercommon_gcm.c
1 /*
2  * Copyright 2019-2020 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 /* Dispatch functions for gcm mode */
11
12 #include "prov/ciphercommon.h"
13 #include "prov/ciphercommon_gcm.h"
14 #include "prov/providercommonerr.h"
15 #include <openssl/rand.h>
16 #include "prov/provider_ctx.h"
17
18 static int gcm_tls_init(PROV_GCM_CTX *dat, unsigned char *aad, size_t aad_len);
19 static int gcm_tls_iv_set_fixed(PROV_GCM_CTX *ctx, unsigned char *iv,
20                                 size_t len);
21 static int gcm_tls_cipher(PROV_GCM_CTX *ctx, unsigned char *out, size_t *padlen,
22                           const unsigned char *in, size_t len);
23 static int gcm_cipher_internal(PROV_GCM_CTX *ctx, unsigned char *out,
24                                size_t *padlen, const unsigned char *in,
25                                size_t len);
26
27 void gcm_initctx(void *provctx, PROV_GCM_CTX *ctx, size_t keybits,
28                  const PROV_GCM_HW *hw, size_t ivlen_min)
29 {
30     ctx->pad = 1;
31     ctx->mode = EVP_CIPH_GCM_MODE;
32     ctx->taglen = UNINITIALISED_SIZET;
33     ctx->tls_aad_len = UNINITIALISED_SIZET;
34     ctx->ivlen_min = ivlen_min;
35     ctx->ivlen = (EVP_GCM_TLS_FIXED_IV_LEN + EVP_GCM_TLS_EXPLICIT_IV_LEN);
36     ctx->keylen = keybits / 8;
37     ctx->hw = hw;
38     ctx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
39 }
40
41 static int gcm_init(void *vctx, const unsigned char *key, size_t keylen,
42                     const unsigned char *iv, size_t ivlen, int enc)
43 {
44     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
45
46     ctx->enc = enc;
47
48     if (iv != NULL) {
49         if (ivlen < ctx->ivlen_min || ivlen > sizeof(ctx->iv)) {
50             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
51             return 0;
52         }
53         ctx->ivlen = ivlen;
54         memcpy(ctx->iv, iv, ivlen);
55         ctx->iv_state = IV_STATE_BUFFERED;
56     }
57
58     if (key != NULL) {
59         if (keylen != ctx->keylen) {
60             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
61             return 0;
62         }
63         return ctx->hw->setkey(ctx, key, ctx->keylen);
64     }
65     return 1;
66 }
67
68 int gcm_einit(void *vctx, const unsigned char *key, size_t keylen,
69               const unsigned char *iv, size_t ivlen)
70 {
71     return gcm_init(vctx, key, keylen, iv, ivlen, 1);
72 }
73
74 int gcm_dinit(void *vctx, const unsigned char *key, size_t keylen,
75               const unsigned char *iv, size_t ivlen)
76 {
77     return gcm_init(vctx, key, keylen, iv, ivlen, 0);
78 }
79
80 /* increment counter (64-bit int) by 1 */
81 static void ctr64_inc(unsigned char *counter)
82 {
83     int n = 8;
84     unsigned char c;
85
86     do {
87         --n;
88         c = counter[n];
89         ++c;
90         counter[n] = c;
91         if (c > 0)
92             return;
93     } while (n > 0);
94 }
95
96 static int getivgen(PROV_GCM_CTX *ctx, unsigned char *out, size_t olen)
97 {
98     if (!ctx->iv_gen
99         || !ctx->key_set
100         || !ctx->hw->setiv(ctx, ctx->iv, ctx->ivlen))
101         return 0;
102     if (olen == 0 || olen > ctx->ivlen)
103         olen = ctx->ivlen;
104     memcpy(out, ctx->iv + ctx->ivlen - olen, olen);
105     /*
106      * Invocation field will be at least 8 bytes in size and so no need
107      * to check wrap around or increment more than last 8 bytes.
108      */
109     ctr64_inc(ctx->iv + ctx->ivlen - 8);
110     ctx->iv_state = IV_STATE_COPIED;
111     return 1;
112 }
113
114 static int setivinv(PROV_GCM_CTX *ctx, unsigned char *in, size_t inl)
115 {
116     if (!ctx->iv_gen
117         || !ctx->key_set
118         || ctx->enc)
119         return 0;
120
121     memcpy(ctx->iv + ctx->ivlen - inl, in, inl);
122     if (!ctx->hw->setiv(ctx, ctx->iv, ctx->ivlen))
123         return 0;
124     ctx->iv_state = IV_STATE_COPIED;
125     return 1;
126 }
127
128 int gcm_get_ctx_params(void *vctx, OSSL_PARAM params[])
129 {
130     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
131     OSSL_PARAM *p;
132     size_t sz;
133
134     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
135     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->ivlen)) {
136         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
137         return 0;
138     }
139     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
140     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
141         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
142         return 0;
143     }
144     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
145     if (p != NULL) {
146         size_t taglen = (ctx->taglen != UNINITIALISED_SIZET) ? ctx->taglen :
147                          GCM_TAG_MAX_SIZE;
148
149         if (!OSSL_PARAM_set_size_t(p, taglen)) {
150             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
151             return 0;
152         }
153     }
154
155     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
156     if (p != NULL) {
157         if (ctx->iv_gen != 1 && ctx->iv_gen_rand != 1)
158             return 0;
159         if (ctx->ivlen != p->data_size) {
160             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
161             return 0;
162         }
163         if (!OSSL_PARAM_set_octet_string(p, ctx->iv, ctx->ivlen)
164             && !OSSL_PARAM_set_octet_ptr(p, &ctx->iv, ctx->ivlen)) {
165             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
166             return 0;
167         }
168     }
169
170     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD);
171     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->tls_aad_pad_sz)) {
172         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
173         return 0;
174     }
175     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
176     if (p != NULL) {
177         sz = p->data_size;
178         if (sz == 0
179             || sz > EVP_GCM_TLS_TAG_LEN
180             || !ctx->enc
181             || ctx->taglen == UNINITIALISED_SIZET) {
182             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG);
183             return 0;
184         }
185         if (!OSSL_PARAM_set_octet_string(p, ctx->buf, sz)) {
186             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
187             return 0;
188         }
189     }
190     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN);
191     if (p != NULL) {
192         if (p->data == NULL
193             || p->data_type != OSSL_PARAM_OCTET_STRING
194             || !getivgen(ctx, p->data, p->data_size))
195             return 0;
196     }
197     return 1;
198 }
199
200 int gcm_set_ctx_params(void *vctx, const OSSL_PARAM params[])
201 {
202     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
203     const OSSL_PARAM *p;
204     size_t sz;
205     void *vp;
206
207     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
208     if (p != NULL) {
209         vp = ctx->buf;
210         if (!OSSL_PARAM_get_octet_string(p, &vp, EVP_GCM_TLS_TAG_LEN, &sz)) {
211             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
212             return 0;
213         }
214         if (sz == 0 || ctx->enc) {
215             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG);
216             return 0;
217         }
218         ctx->taglen = sz;
219     }
220
221     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_IVLEN);
222     if (p != NULL) {
223         if (!OSSL_PARAM_get_size_t(p, &sz)) {
224             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
225             return 0;
226         }
227         if (sz == 0 || sz > sizeof(ctx->iv)) {
228             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
229             return 0;
230         }
231         ctx->ivlen = sz;
232     }
233
234     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD);
235     if (p != NULL) {
236         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
237             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
238             return 0;
239         }
240         sz = gcm_tls_init(ctx, p->data, p->data_size);
241         if (sz == 0) {
242             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_AAD);
243             return 0;
244         }
245         ctx->tls_aad_pad_sz = sz;
246     }
247
248     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED);
249     if (p != NULL) {
250         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
251             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
252             return 0;
253         }
254         if (gcm_tls_iv_set_fixed(ctx, p->data, p->data_size) == 0) {
255             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
256             return 0;
257         }
258     }
259     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV);
260     if (p != NULL) {
261         if (p->data == NULL
262             || p->data_type != OSSL_PARAM_OCTET_STRING
263             || !setivinv(ctx, p->data, p->data_size))
264             return 0;
265     }
266
267
268     return 1;
269 }
270
271 int gcm_stream_update(void *vctx, unsigned char *out, size_t *outl,
272                       size_t outsize, const unsigned char *in, size_t inl)
273 {
274     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
275
276     if (inl == 0) {
277         *outl = 0;
278         return 1;
279     }
280
281     if (outsize < inl) {
282         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
283         return -1;
284     }
285
286     if (gcm_cipher_internal(ctx, out, outl, in, inl) <= 0) {
287         ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
288         return -1;
289     }
290     return 1;
291 }
292
293 int gcm_stream_final(void *vctx, unsigned char *out, size_t *outl,
294                      size_t outsize)
295 {
296     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
297     int i;
298
299     i = gcm_cipher_internal(ctx, out, outl, NULL, 0);
300     if (i <= 0)
301         return 0;
302
303     *outl = 0;
304     return 1;
305 }
306
307 int gcm_cipher(void *vctx,
308                unsigned char *out, size_t *outl, size_t outsize,
309                const unsigned char *in, size_t inl)
310 {
311     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
312
313     if (outsize < inl) {
314         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
315         return 0;
316     }
317
318     if (gcm_cipher_internal(ctx, out, outl, in, inl) <= 0)
319         return 0;
320
321     *outl = inl;
322     return 1;
323 }
324
325 /*
326  * See SP800-38D (GCM) Section 8 "Uniqueness requirement on IVS and keys"
327  *
328  * See also 8.2.2 RBG-based construction.
329  * Random construction consists of a free field (which can be NULL) and a
330  * random field which will use a DRBG that can return at least 96 bits of
331  * entropy strength. (The DRBG must be seeded by the FIPS module).
332  */
333 static int gcm_iv_generate(PROV_GCM_CTX *ctx, int offset)
334 {
335     int sz = ctx->ivlen - offset;
336
337     /* Must be at least 96 bits */
338     if (sz <= 0 || ctx->ivlen < GCM_IV_DEFAULT_SIZE)
339         return 0;
340
341     /* Use DRBG to generate random iv */
342     if (RAND_bytes_ex(ctx->libctx, ctx->iv + offset, sz) <= 0)
343         return 0;
344     ctx->iv_state = IV_STATE_BUFFERED;
345     ctx->iv_gen_rand = 1;
346     return 1;
347 }
348
349 static int gcm_cipher_internal(PROV_GCM_CTX *ctx, unsigned char *out,
350                                size_t *padlen, const unsigned char *in,
351                                size_t len)
352 {
353     size_t olen = 0;
354     int rv = 0;
355     const PROV_GCM_HW *hw = ctx->hw;
356
357     if (ctx->tls_aad_len != UNINITIALISED_SIZET)
358         return gcm_tls_cipher(ctx, out, padlen, in, len);
359
360     if (!ctx->key_set || ctx->iv_state == IV_STATE_FINISHED)
361         goto err;
362
363     /*
364      * FIPS requires generation of AES-GCM IV's inside the FIPS module.
365      * The IV can still be set externally (the security policy will state that
366      * this is not FIPS compliant). There are some applications
367      * where setting the IV externally is the only option available.
368      */
369     if (ctx->iv_state == IV_STATE_UNINITIALISED) {
370         if (!ctx->enc || !gcm_iv_generate(ctx, 0))
371             goto err;
372     }
373
374     if (ctx->iv_state == IV_STATE_BUFFERED) {
375         if (!hw->setiv(ctx, ctx->iv, ctx->ivlen))
376             goto err;
377         ctx->iv_state = IV_STATE_COPIED;
378     }
379
380     if (in != NULL) {
381         /*  The input is AAD if out is NULL */
382         if (out == NULL) {
383             if (!hw->aadupdate(ctx, in, len))
384                 goto err;
385         } else {
386             /* The input is ciphertext OR plaintext */
387             if (!hw->cipherupdate(ctx, in, len, out))
388                 goto err;
389         }
390     } else {
391         /* The tag must be set before actually decrypting data */
392         if (!ctx->enc && ctx->taglen == UNINITIALISED_SIZET)
393             goto err;
394         if (!hw->cipherfinal(ctx, ctx->buf))
395             goto err;
396         ctx->iv_state = IV_STATE_FINISHED; /* Don't reuse the IV */
397         goto finish;
398     }
399     olen = len;
400 finish:
401     rv = 1;
402 err:
403     *padlen = olen;
404     return rv;
405 }
406
407 static int gcm_tls_init(PROV_GCM_CTX *dat, unsigned char *aad, size_t aad_len)
408 {
409     unsigned char *buf;
410     size_t len;
411
412     if (aad_len != EVP_AEAD_TLS1_AAD_LEN)
413        return 0;
414
415     /* Save the aad for later use. */
416     buf = dat->buf;
417     memcpy(buf, aad, aad_len);
418     dat->tls_aad_len = aad_len;
419     dat->tls_enc_records = 0;
420
421     len = buf[aad_len - 2] << 8 | buf[aad_len - 1];
422     /* Correct length for explicit iv. */
423     if (len < EVP_GCM_TLS_EXPLICIT_IV_LEN)
424         return 0;
425     len -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
426
427     /* If decrypting correct for tag too. */
428     if (!dat->enc) {
429         if (len < EVP_GCM_TLS_TAG_LEN)
430             return 0;
431         len -= EVP_GCM_TLS_TAG_LEN;
432     }
433     buf[aad_len - 2] = (unsigned char)(len >> 8);
434     buf[aad_len - 1] = (unsigned char)(len & 0xff);
435     /* Extra padding: tag appended to record. */
436     return EVP_GCM_TLS_TAG_LEN;
437 }
438
439 static int gcm_tls_iv_set_fixed(PROV_GCM_CTX *ctx, unsigned char *iv,
440                                 size_t len)
441 {
442     /* Special case: -1 length restores whole IV */
443     if (len == (size_t)-1) {
444         memcpy(ctx->iv, iv, ctx->ivlen);
445         ctx->iv_gen = 1;
446         ctx->iv_state = IV_STATE_BUFFERED;
447         return 1;
448     }
449     /* Fixed field must be at least 4 bytes and invocation field at least 8 */
450     if ((len < EVP_GCM_TLS_FIXED_IV_LEN)
451         || (ctx->ivlen - (int)len) < EVP_GCM_TLS_EXPLICIT_IV_LEN)
452             return 0;
453     if (len > 0)
454         memcpy(ctx->iv, iv, len);
455     if (ctx->enc
456         && RAND_bytes_ex(ctx->libctx, ctx->iv + len, ctx->ivlen - len) <= 0)
457             return 0;
458     ctx->iv_gen = 1;
459     ctx->iv_state = IV_STATE_BUFFERED;
460     return 1;
461 }
462
463 /*
464  * Handle TLS GCM packet format. This consists of the last portion of the IV
465  * followed by the payload and finally the tag. On encrypt generate IV,
466  * encrypt payload and write the tag. On verify retrieve IV, decrypt payload
467  * and verify tag.
468  */
469 static int gcm_tls_cipher(PROV_GCM_CTX *ctx, unsigned char *out, size_t *padlen,
470                           const unsigned char *in, size_t len)
471 {
472     int rv = 0;
473     size_t arg = EVP_GCM_TLS_EXPLICIT_IV_LEN;
474     size_t plen = 0;
475     unsigned char *tag = NULL;
476
477     if (!ctx->key_set)
478         goto err;
479
480     /* Encrypt/decrypt must be performed in place */
481     if (out != in || len < (EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN))
482         goto err;
483
484     /*
485      * Check for too many keys as per FIPS 140-2 IG A.5 "Key/IV Pair Uniqueness
486      * Requirements from SP 800-38D".  The requirements is for one party to the
487      * communication to fail after 2^64 - 1 keys.  We do this on the encrypting
488      * side only.
489      */
490     if (ctx->enc && ++ctx->tls_enc_records == 0) {
491         ERR_raise(ERR_LIB_PROV, EVP_R_TOO_MANY_RECORDS);
492         goto err;
493     }
494
495     /*
496      * Set IV from start of buffer or generate IV and write to start of
497      * buffer.
498      */
499     if (ctx->enc) {
500         if (!getivgen(ctx, out, arg))
501             goto err;
502     } else {
503         if (!setivinv(ctx, out, arg))
504             goto err;
505     }
506
507     /* Fix buffer and length to point to payload */
508     in += EVP_GCM_TLS_EXPLICIT_IV_LEN;
509     out += EVP_GCM_TLS_EXPLICIT_IV_LEN;
510     len -= EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
511
512     tag = ctx->enc ? out + len : (unsigned char *)in + len;
513     if (!ctx->hw->oneshot(ctx, ctx->buf, ctx->tls_aad_len, in, len, out, tag,
514                           EVP_GCM_TLS_TAG_LEN)) {
515         if (!ctx->enc)
516             OPENSSL_cleanse(out, len);
517         goto err;
518     }
519     if (ctx->enc)
520         plen =  len + EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
521     else
522         plen = len;
523
524     rv = 1;
525 err:
526     ctx->iv_state = IV_STATE_FINISHED;
527     ctx->tls_aad_len = UNINITIALISED_SIZET;
528     *padlen = plen;
529     return rv;
530 }
531