Make basic AES ciphers available from within the FIPS providers
[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 /* TODO(3.0): Needed for dummy_evp_call(). To be removed */
19 #include <openssl/sha.h>
20 #include "internal/cryptlib.h"
21 #include "internal/property.h"
22 #include "internal/evp_int.h"
23 #include "internal/provider_algs.h"
24
25 /* Functions provided by the core */
26 static OSSL_core_get_param_types_fn *c_get_param_types = NULL;
27 static OSSL_core_get_params_fn *c_get_params = NULL;
28 static OSSL_core_put_error_fn *c_put_error = NULL;
29 static OSSL_core_add_error_vdata_fn *c_add_error_vdata = NULL;
30
31 /* Parameters we provide to the core */
32 static const OSSL_ITEM fips_param_types[] = {
33     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_NAME },
34     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_VERSION },
35     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_BUILDINFO },
36     { 0, NULL }
37 };
38
39 /* TODO(3.0): To be removed */
40 static int dummy_evp_call(OPENSSL_CTX *libctx)
41 {
42     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
43     EVP_MD *sha256 = EVP_MD_fetch(libctx, "SHA256", NULL);
44     char msg[] = "Hello World!";
45     const unsigned char exptd[] = {
46         0x7f, 0x83, 0xb1, 0x65, 0x7f, 0xf1, 0xfc, 0x53, 0xb9, 0x2d, 0xc1, 0x81,
47         0x48, 0xa1, 0xd6, 0x5d, 0xfc, 0x2d, 0x4b, 0x1f, 0xa3, 0xd6, 0x77, 0x28,
48         0x4a, 0xdd, 0xd2, 0x00, 0x12, 0x6d, 0x90, 0x69
49     };
50     unsigned int dgstlen = 0;
51     unsigned char dgst[SHA256_DIGEST_LENGTH];
52     int ret = 0;
53
54     if (ctx == NULL || sha256 == NULL)
55         goto err;
56
57     if (!EVP_DigestInit_ex(ctx, sha256, NULL))
58         goto err;
59     if (!EVP_DigestUpdate(ctx, msg, sizeof(msg) - 1))
60         goto err;
61     if (!EVP_DigestFinal(ctx, dgst, &dgstlen))
62         goto err;
63     if (dgstlen != sizeof(exptd) || memcmp(dgst, exptd, sizeof(exptd)) != 0)
64         goto err;
65
66     ret = 1;
67  err:
68     EVP_MD_CTX_free(ctx);
69     EVP_MD_meth_free(sha256);
70     return ret;
71 }
72
73 static const OSSL_ITEM *fips_get_param_types(const OSSL_PROVIDER *prov)
74 {
75     return fips_param_types;
76 }
77
78 static int fips_get_params(const OSSL_PROVIDER *prov,
79                             const OSSL_PARAM params[])
80 {
81     const OSSL_PARAM *p;
82
83     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
84     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL FIPS Provider"))
85         return 0;
86     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
87     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
88         return 0;
89     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
90     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
91         return 0;
92
93     return 1;
94 }
95
96 static const OSSL_ALGORITHM fips_digests[] = {
97     { "SHA256", "fips=yes", sha256_functions },
98     { NULL, NULL, NULL }
99 };
100
101 static const OSSL_ALGORITHM fips_ciphers[] = {
102     { "AES-256-ECB", "fips=yes", aes256ecb_functions },
103     { "AES-192-ECB", "fips=yes", aes192ecb_functions },
104     { "AES-128-ECB", "fips=yes", aes128ecb_functions },
105     { "AES-256-CBC", "fips=yes", aes256cbc_functions },
106     { "AES-192-CBC", "fips=yes", aes192cbc_functions },
107     { "AES-128-CBC", "fips=yes", aes128cbc_functions },
108     { "AES-256-CTR", "fips=yes", aes256ctr_functions },
109     { "AES-192-CTR", "fips=yes", aes192ctr_functions },
110     { "AES-128-CTR", "fips=yes", aes128ctr_functions },
111     { NULL, NULL, NULL }
112 };
113
114 static const OSSL_ALGORITHM *fips_query(OSSL_PROVIDER *prov,
115                                          int operation_id,
116                                          int *no_cache)
117 {
118     *no_cache = 0;
119     switch (operation_id) {
120     case OSSL_OP_DIGEST:
121         return fips_digests;
122     case OSSL_OP_CIPHER:
123         return fips_ciphers;
124     }
125     return NULL;
126 }
127
128 /* Functions we provide to the core */
129 static const OSSL_DISPATCH fips_dispatch_table[] = {
130     /*
131      * To release our resources we just need to free the OPENSSL_CTX so we just
132      * use OPENSSL_CTX_free directly as our teardown function
133      */
134     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))OPENSSL_CTX_free },
135     { OSSL_FUNC_PROVIDER_GET_PARAM_TYPES, (void (*)(void))fips_get_param_types },
136     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))fips_get_params },
137     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
138     { 0, NULL }
139 };
140
141 /* Functions we provide to ourself */
142 static const OSSL_DISPATCH intern_dispatch_table[] = {
143     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
144     { 0, NULL }
145 };
146
147
148 int OSSL_provider_init(const OSSL_PROVIDER *provider,
149                        const OSSL_DISPATCH *in,
150                        const OSSL_DISPATCH **out,
151                        void **provctx)
152 {
153     OPENSSL_CTX *ctx;
154
155     for (; in->function_id != 0; in++) {
156         switch (in->function_id) {
157         case OSSL_FUNC_CORE_GET_PARAM_TYPES:
158             c_get_param_types = OSSL_get_core_get_param_types(in);
159             break;
160         case OSSL_FUNC_CORE_GET_PARAMS:
161             c_get_params = OSSL_get_core_get_params(in);
162             break;
163         case OSSL_FUNC_CORE_PUT_ERROR:
164             c_put_error = OSSL_get_core_put_error(in);
165             break;
166         case OSSL_FUNC_CORE_ADD_ERROR_VDATA:
167             c_add_error_vdata = OSSL_get_core_add_error_vdata(in);
168             break;
169         /* Just ignore anything we don't understand */
170         default:
171             break;
172         }
173     }
174
175     ctx = OPENSSL_CTX_new();
176     if (ctx == NULL)
177         return 0;
178
179     /*
180      * TODO(3.0): Remove me. This is just a dummy call to demonstrate making
181      * EVP calls from within the FIPS module.
182      */
183     if (!dummy_evp_call(ctx)) {
184         OPENSSL_CTX_free(ctx);
185         return 0;
186     }
187
188     *out = fips_dispatch_table;
189     *provctx = ctx;
190     return 1;
191 }
192
193 /*
194  * The internal init function used when the FIPS module uses EVP to call
195  * another algorithm also in the FIPS module. This is a recursive call that has
196  * been made from within the FIPS module itself. Normally we are responsible for
197  * providing our own provctx value, but in this recursive case it has been
198  * pre-populated for us with the same library context that was used in the EVP
199  * call that initiated this recursive call - so we don't need to do anything
200  * further with that parameter. This only works because we *know* in the core
201  * code that the FIPS module uses a library context for its provctx. This is
202  * not generally true for all providers.
203  */
204 OSSL_provider_init_fn fips_intern_provider_init;
205 int fips_intern_provider_init(const OSSL_PROVIDER *provider,
206                               const OSSL_DISPATCH *in,
207                               const OSSL_DISPATCH **out,
208                               void **provctx)
209 {
210     *out = intern_dispatch_table;
211     return 1;
212 }
213
214 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
215 {
216     /*
217      * TODO(3.0): This works for the FIPS module because we're going to be
218      * using lib/func/reason codes that libcrypto already knows about. This
219      * won't work for third party providers that have their own error mechanisms,
220      * so we'll need to come up with something else for them.
221      */
222     c_put_error(lib, func, reason, file, line);
223 }
224
225 void ERR_add_error_data(int num, ...)
226 {
227     va_list args;
228     va_start(args, num);
229     ERR_add_error_vdata(num, args);
230     va_end(args);
231 }
232
233 void ERR_add_error_vdata(int num, va_list args)
234 {
235     c_add_error_vdata(num, args);
236 }