b62bfeec397bca1d58cd3820c16209ebbb9f93ec
[openssl.git] / providers / fips / fipsprov.c
1 /*
2  * Copyright 2019 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 #include <string.h>
11 #include <stdio.h>
12 #include <openssl/core.h>
13 #include <openssl/core_numbers.h>
14 #include <openssl/core_names.h>
15 #include <openssl/params.h>
16 #include <openssl/err.h>
17 #include <openssl/evp.h>
18
19 /* TODO(3.0): Needed for dummy_evp_call(). To be removed */
20 #include <openssl/sha.h>
21 #include <openssl/rand_drbg.h>
22
23 #include "internal/cryptlib.h"
24 #include "internal/property.h"
25 #include "internal/evp_int.h"
26 #include "internal/provider_algs.h"
27 #include "internal/provider_ctx.h"
28 #include "internal/providercommon.h"
29
30 extern OSSL_core_thread_start_fn *c_thread_start;
31
32 /*
33  * TODO(3.0): Should these be stored in the provider side provctx? Could they
34  * ever be different from one init to the next? Unfortunately we can't do this
35  * at the moment because c_put_error/c_add_error_vdata do not provide
36  * us with the OPENSSL_CTX as a parameter.
37  */
38 /* Functions provided by the core */
39 static OSSL_core_get_param_types_fn *c_get_param_types;
40 static OSSL_core_get_params_fn *c_get_params;
41 OSSL_core_thread_start_fn *c_thread_start;
42 static OSSL_core_new_error_fn *c_new_error;
43 static OSSL_core_set_error_debug_fn *c_set_error_debug;
44 static OSSL_core_vset_error_fn *c_vset_error;
45 static OSSL_CRYPTO_malloc_fn *c_CRYPTO_malloc;
46 static OSSL_CRYPTO_zalloc_fn *c_CRYPTO_zalloc;
47 static OSSL_CRYPTO_free_fn *c_CRYPTO_free;
48 static OSSL_CRYPTO_clear_free_fn *c_CRYPTO_clear_free;
49 static OSSL_CRYPTO_realloc_fn *c_CRYPTO_realloc;
50 static OSSL_CRYPTO_clear_realloc_fn *c_CRYPTO_clear_realloc;
51 static OSSL_CRYPTO_secure_malloc_fn *c_CRYPTO_secure_malloc;
52 static OSSL_CRYPTO_secure_zalloc_fn *c_CRYPTO_secure_zalloc;
53 static OSSL_CRYPTO_secure_free_fn *c_CRYPTO_secure_free;
54 static OSSL_CRYPTO_secure_clear_free_fn *c_CRYPTO_secure_clear_free;
55 static OSSL_CRYPTO_secure_allocated_fn *c_CRYPTO_secure_allocated;
56
57 typedef struct fips_global_st {
58     const OSSL_PROVIDER *prov;
59 } FIPS_GLOBAL;
60
61 static void *fips_prov_ossl_ctx_new(OPENSSL_CTX *libctx)
62 {
63     FIPS_GLOBAL *fgbl = OPENSSL_zalloc(sizeof(*fgbl));
64
65     return fgbl;
66 }
67
68 static void fips_prov_ossl_ctx_free(void *fgbl)
69 {
70     OPENSSL_free(fgbl);
71 }
72
73 static const OPENSSL_CTX_METHOD fips_prov_ossl_ctx_method = {
74     fips_prov_ossl_ctx_new,
75     fips_prov_ossl_ctx_free,
76 };
77
78
79 /* Parameters we provide to the core */
80 static const OSSL_PARAM fips_param_types[] = {
81     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
82     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
83     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
84     OSSL_PARAM_END
85 };
86
87 /* TODO(3.0): To be removed */
88 static int dummy_evp_call(void *provctx)
89 {
90     OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
91     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
92     EVP_MD *sha256 = EVP_MD_fetch(libctx, "SHA256", NULL);
93     char msg[] = "Hello World!";
94     const unsigned char exptd[] = {
95         0x7f, 0x83, 0xb1, 0x65, 0x7f, 0xf1, 0xfc, 0x53, 0xb9, 0x2d, 0xc1, 0x81,
96         0x48, 0xa1, 0xd6, 0x5d, 0xfc, 0x2d, 0x4b, 0x1f, 0xa3, 0xd6, 0x77, 0x28,
97         0x4a, 0xdd, 0xd2, 0x00, 0x12, 0x6d, 0x90, 0x69
98     };
99     unsigned int dgstlen = 0;
100     unsigned char dgst[SHA256_DIGEST_LENGTH];
101     int ret = 0;
102     BN_CTX *bnctx = NULL;
103     BIGNUM *a = NULL, *b = NULL;
104     unsigned char randbuf[128];
105     RAND_DRBG *drbg = OPENSSL_CTX_get0_public_drbg(libctx);
106
107     if (ctx == NULL || sha256 == NULL || drbg == NULL)
108         goto err;
109
110     if (!EVP_DigestInit_ex(ctx, sha256, NULL))
111         goto err;
112     if (!EVP_DigestUpdate(ctx, msg, sizeof(msg) - 1))
113         goto err;
114     if (!EVP_DigestFinal(ctx, dgst, &dgstlen))
115         goto err;
116     if (dgstlen != sizeof(exptd) || memcmp(dgst, exptd, sizeof(exptd)) != 0)
117         goto err;
118
119     bnctx = BN_CTX_new_ex(libctx);
120     if (bnctx == NULL)
121         goto err;
122     BN_CTX_start(bnctx);
123     a = BN_CTX_get(bnctx);
124     b = BN_CTX_get(bnctx);
125     if (b == NULL)
126         goto err;
127     BN_zero(a);
128     if (!BN_one(b)
129         || !BN_add(a, a, b)
130         || BN_cmp(a, b) != 0)
131         goto err;
132
133     if (RAND_DRBG_bytes(drbg, randbuf, sizeof(randbuf)) <= 0)
134         goto err;
135
136     if (!BN_rand_ex(a, 256, BN_RAND_TOP_ANY, BN_RAND_BOTTOM_ANY, bnctx))
137         goto err;
138
139     ret = 1;
140  err:
141     BN_CTX_end(bnctx);
142     BN_CTX_free(bnctx);
143
144     EVP_MD_CTX_free(ctx);
145     EVP_MD_meth_free(sha256);
146     return ret;
147 }
148
149 static const OSSL_PARAM *fips_get_param_types(const OSSL_PROVIDER *prov)
150 {
151     return fips_param_types;
152 }
153
154 static int fips_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
155 {
156     OSSL_PARAM *p;
157
158     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
159     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL FIPS Provider"))
160         return 0;
161     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
162     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
163         return 0;
164     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
165     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
166         return 0;
167
168     return 1;
169 }
170
171 /* FIPS specific version of the function of the same name in provlib.c */
172 const char *ossl_prov_util_nid_to_name(int nid)
173 {
174     /* We don't have OBJ_nid2n() in FIPS_MODE so we have an explicit list */
175
176     switch (nid) {
177     /* Digests */
178     case NID_sha1:
179         return "SHA224";
180     case NID_sha224:
181         return "SHA224";
182     case NID_sha256:
183         return "SHA256";
184     case NID_sha384:
185         return "SHA384";
186     case NID_sha512:
187         return "SHA512";
188     case NID_sha512_224:
189         return "SHA512-224";
190     case NID_sha512_256:
191         return "SHA512-256";
192     case NID_sha3_224:
193         return "SHA3-224";
194     case NID_sha3_256:
195         return "SHA3-256";
196     case NID_sha3_384:
197         return "SHA3-384";
198     case NID_sha3_512:
199         return "SHA3-512";
200
201     /* Ciphers */
202     case NID_aes_256_ecb:
203         return "AES-256-ECB";
204     case NID_aes_192_ecb:
205         return "AES-192-ECB";
206     case NID_aes_128_ecb:
207         return "AES-128-ECB";
208     case NID_aes_256_cbc:
209         return "AES-256-CBC";
210     case NID_aes_192_cbc:
211         return "AES-192-CBC";
212     case NID_aes_128_cbc:
213         return "AES-128-CBC";
214     case NID_aes_256_ctr:
215         return "AES-256-CTR";
216     case NID_aes_192_ctr:
217         return "AES-192-CTR";
218     case NID_aes_128_ctr:
219         return "AES-128-CTR";
220     }
221
222     return NULL;
223 }
224
225 static const OSSL_ALGORITHM fips_digests[] = {
226     { "SHA1", "fips=yes", sha1_functions },
227     { "SHA224", "fips=yes", sha224_functions },
228     { "SHA256", "fips=yes", sha256_functions },
229     { "SHA384", "fips=yes", sha384_functions },
230     { "SHA512", "fips=yes", sha512_functions },
231     { "SHA512-224", "fips=yes", sha512_224_functions },
232     { "SHA512-256", "fips=yes", sha512_256_functions },
233     { "SHA3-224", "fips=yes", sha3_224_functions },
234     { "SHA3-256", "fips=yes", sha3_256_functions },
235     { "SHA3-384", "fips=yes", sha3_384_functions },
236     { "SHA3-512", "fips=yes", sha3_512_functions },
237     { "KMAC128", "fips=yes", keccak_kmac_128_functions },
238     { "KMAC256", "fips=yes", keccak_kmac_256_functions },
239
240     { NULL, NULL, NULL }
241 };
242
243 static const OSSL_ALGORITHM fips_ciphers[] = {
244     { "AES-256-ECB", "fips=yes", aes256ecb_functions },
245     { "AES-192-ECB", "fips=yes", aes192ecb_functions },
246     { "AES-128-ECB", "fips=yes", aes128ecb_functions },
247     { "AES-256-CBC", "fips=yes", aes256cbc_functions },
248     { "AES-192-CBC", "fips=yes", aes192cbc_functions },
249     { "AES-128-CBC", "fips=yes", aes128cbc_functions },
250     { "AES-256-CTR", "fips=yes", aes256ctr_functions },
251     { "AES-192-CTR", "fips=yes", aes192ctr_functions },
252     { "AES-128-CTR", "fips=yes", aes128ctr_functions },
253     { NULL, NULL, NULL }
254 };
255
256 static const OSSL_ALGORITHM *fips_query(OSSL_PROVIDER *prov,
257                                          int operation_id,
258                                          int *no_cache)
259 {
260     *no_cache = 0;
261     switch (operation_id) {
262     case OSSL_OP_DIGEST:
263         return fips_digests;
264     case OSSL_OP_CIPHER:
265         return fips_ciphers;
266     }
267     return NULL;
268 }
269
270 /* Functions we provide to the core */
271 static const OSSL_DISPATCH fips_dispatch_table[] = {
272     /*
273      * To release our resources we just need to free the OPENSSL_CTX so we just
274      * use OPENSSL_CTX_free directly as our teardown function
275      */
276     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))OPENSSL_CTX_free },
277     { OSSL_FUNC_PROVIDER_GET_PARAM_TYPES, (void (*)(void))fips_get_param_types },
278     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))fips_get_params },
279     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
280     { 0, NULL }
281 };
282
283 /* Functions we provide to ourself */
284 static const OSSL_DISPATCH intern_dispatch_table[] = {
285     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
286     { 0, NULL }
287 };
288
289
290 int OSSL_provider_init(const OSSL_PROVIDER *provider,
291                        const OSSL_DISPATCH *in,
292                        const OSSL_DISPATCH **out,
293                        void **provctx)
294 {
295     FIPS_GLOBAL *fgbl;
296     OPENSSL_CTX *ctx;
297
298     for (; in->function_id != 0; in++) {
299         switch (in->function_id) {
300         case OSSL_FUNC_CORE_GET_PARAM_TYPES:
301             c_get_param_types = OSSL_get_core_get_param_types(in);
302             break;
303         case OSSL_FUNC_CORE_GET_PARAMS:
304             c_get_params = OSSL_get_core_get_params(in);
305             break;
306         case OSSL_FUNC_CORE_THREAD_START:
307             c_thread_start = OSSL_get_core_thread_start(in);
308             break;
309         case OSSL_FUNC_CORE_NEW_ERROR:
310             c_new_error = OSSL_get_core_new_error(in);
311             break;
312         case OSSL_FUNC_CORE_SET_ERROR_DEBUG:
313             c_set_error_debug = OSSL_get_core_set_error_debug(in);
314             break;
315         case OSSL_FUNC_CORE_VSET_ERROR:
316             c_vset_error = OSSL_get_core_vset_error(in);
317             break;
318         case OSSL_FUNC_CRYPTO_MALLOC:
319             c_CRYPTO_malloc = OSSL_get_CRYPTO_malloc(in);
320             break;
321         case OSSL_FUNC_CRYPTO_ZALLOC:
322             c_CRYPTO_zalloc = OSSL_get_CRYPTO_zalloc(in);
323             break;
324         case OSSL_FUNC_CRYPTO_FREE:
325             c_CRYPTO_free = OSSL_get_CRYPTO_free(in);
326             break;
327         case OSSL_FUNC_CRYPTO_CLEAR_FREE:
328             c_CRYPTO_clear_free = OSSL_get_CRYPTO_clear_free(in);
329             break;
330         case OSSL_FUNC_CRYPTO_REALLOC:
331             c_CRYPTO_realloc = OSSL_get_CRYPTO_realloc(in);
332             break;
333         case OSSL_FUNC_CRYPTO_CLEAR_REALLOC:
334             c_CRYPTO_clear_realloc = OSSL_get_CRYPTO_clear_realloc(in);
335             break;
336         case OSSL_FUNC_CRYPTO_SECURE_MALLOC:
337             c_CRYPTO_secure_malloc = OSSL_get_CRYPTO_secure_malloc(in);
338             break;
339         case OSSL_FUNC_CRYPTO_SECURE_ZALLOC:
340             c_CRYPTO_secure_zalloc = OSSL_get_CRYPTO_secure_zalloc(in);
341             break;
342         case OSSL_FUNC_CRYPTO_SECURE_FREE:
343             c_CRYPTO_secure_free = OSSL_get_CRYPTO_secure_free(in);
344             break;
345         case OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE:
346             c_CRYPTO_secure_clear_free = OSSL_get_CRYPTO_secure_clear_free(in);
347             break;
348         case OSSL_FUNC_CRYPTO_SECURE_ALLOCATED:
349             c_CRYPTO_secure_allocated = OSSL_get_CRYPTO_secure_allocated(in);
350             break;
351         default:
352             /* Just ignore anything we don't understand */
353             break;
354         }
355     }
356
357     /*  Create a context. */
358     if ((ctx = OPENSSL_CTX_new()) == NULL)
359         return 0;
360     if ((fgbl = openssl_ctx_get_data(ctx, OPENSSL_CTX_FIPS_PROV_INDEX,
361                                      &fips_prov_ossl_ctx_method)) == NULL) {
362         OPENSSL_CTX_free(ctx);
363         return 0;
364     }
365     fgbl->prov = provider;
366     *out = fips_dispatch_table;
367     *provctx = ctx;
368
369     /*
370      * TODO(3.0): Remove me. This is just a dummy call to demonstrate making
371      * EVP calls from within the FIPS module.
372      */
373     if (!dummy_evp_call(*provctx)) {
374         OPENSSL_CTX_free(*provctx);
375         *provctx = NULL;
376         return 0;
377     }
378
379     return 1;
380 }
381
382 /*
383  * The internal init function used when the FIPS module uses EVP to call
384  * another algorithm also in the FIPS module. This is a recursive call that has
385  * been made from within the FIPS module itself. To make this work, we populate
386  * the provider context of this inner instance with the same library context
387  * that was used in the EVP call that initiated this recursive call.
388  */
389 OSSL_provider_init_fn fips_intern_provider_init;
390 int fips_intern_provider_init(const OSSL_PROVIDER *provider,
391                               const OSSL_DISPATCH *in,
392                               const OSSL_DISPATCH **out,
393                               void **provctx)
394 {
395     OSSL_core_get_library_context_fn *c_get_libctx = NULL;
396
397     for (; in->function_id != 0; in++) {
398         switch (in->function_id) {
399         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
400             c_get_libctx = OSSL_get_core_get_library_context(in);
401             break;
402         default:
403             break;
404         }
405     }
406
407     if (c_get_libctx == NULL)
408         return 0;
409
410     *provctx = c_get_libctx(provider);
411
412     /*
413      * Safety measure...  we should get the library context that was
414      * created up in OSSL_provider_init().
415      */
416     if (*provctx == NULL)
417         return 0;
418
419     *out = intern_dispatch_table;
420     return 1;
421 }
422
423 void ERR_new(void)
424 {
425     c_new_error(NULL);
426 }
427
428 void ERR_set_debug(const char *file, int line, const char *func)
429 {
430     c_set_error_debug(NULL, file, line, func);
431 }
432
433 void ERR_set_error(int lib, int reason, const char *fmt, ...)
434 {
435     va_list args;
436
437     va_start(args, fmt);
438     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
439     va_end(args);
440 }
441
442 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args)
443 {
444     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
445 }
446
447 const OSSL_PROVIDER *FIPS_get_provider(OPENSSL_CTX *ctx)
448 {
449     FIPS_GLOBAL *fgbl = openssl_ctx_get_data(ctx, OPENSSL_CTX_FIPS_PROV_INDEX,
450                                              &fips_prov_ossl_ctx_method);
451
452     if (fgbl == NULL)
453         return NULL;
454
455     return fgbl->prov;
456 }
457
458 void *CRYPTO_malloc(size_t num, const char *file, int line)
459 {
460     return c_CRYPTO_malloc(num, file, line);
461 }
462
463 void *CRYPTO_zalloc(size_t num, const char *file, int line)
464 {
465     return c_CRYPTO_zalloc(num, file, line);
466 }
467
468 void CRYPTO_free(void *ptr, const char *file, int line)
469 {
470     c_CRYPTO_free(ptr, file, line);
471 }
472
473 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line)
474 {
475     c_CRYPTO_clear_free(ptr, num, file, line);
476 }
477
478 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line)
479 {
480     return c_CRYPTO_realloc(addr, num, file, line);
481 }
482
483 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
484                            const char *file, int line)
485 {
486     return c_CRYPTO_clear_realloc(addr, old_num, num, file, line);
487 }
488
489 void *CRYPTO_secure_malloc(size_t num, const char *file, int line)
490 {
491     return c_CRYPTO_secure_malloc(num, file, line);
492 }
493
494 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line)
495 {
496     return c_CRYPTO_secure_zalloc(num, file, line);
497 }
498
499 void CRYPTO_secure_free(void *ptr, const char *file, int line)
500 {
501     c_CRYPTO_secure_free(ptr, file, line);
502 }
503
504 void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *file, int line)
505 {
506     c_CRYPTO_secure_clear_free(ptr, num, file, line);
507 }
508
509 int CRYPTO_secure_allocated(const void *ptr)
510 {
511     return c_CRYPTO_secure_allocated(ptr);
512 }