Add --fips-key configuration parameter to fipsinstall application.
[openssl.git] / providers / fips / self_test.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 #include <string.h>
11 #include <openssl/evp.h>
12 #include <openssl/params.h>
13 #include <openssl/crypto.h>
14 #include <openssl/fipskey.h>
15 #include "e_os.h"
16 /*
17  * We're cheating here. Normally we don't allow RUN_ONCE usage inside the FIPS
18  * module because all such initialisation should be associated with an
19  * individual OPENSSL_CTX. That doesn't work with the self test though because
20  * it should be run once regardless of the number of OPENSSL_CTXs we have.
21  */
22 #define ALLOW_RUN_ONCE_IN_FIPS
23 #include <internal/thread_once.h>
24 #include "self_test.h"
25
26 #define FIPS_STATE_INIT     0
27 #define FIPS_STATE_SELFTEST 1
28 #define FIPS_STATE_RUNNING  2
29 #define FIPS_STATE_ERROR    3
30
31 /* The size of a temp buffer used to read in data */
32 #define INTEGRITY_BUF_SIZE (4096)
33 #define MAX_MD_SIZE 64
34 #define MAC_NAME    "HMAC"
35 #define DIGEST_NAME "SHA256"
36
37 static int FIPS_state = FIPS_STATE_INIT;
38 static CRYPTO_RWLOCK *self_test_lock = NULL;
39 static unsigned char fixed_key[32] = { FIPS_KEY_ELEMENTS };
40
41 static CRYPTO_ONCE fips_self_test_init = CRYPTO_ONCE_STATIC_INIT;
42 DEFINE_RUN_ONCE_STATIC(do_fips_self_test_init)
43 {
44     /*
45      * This lock gets freed in platform specific ways that may occur after we
46      * do mem leak checking. If we don't know how to free it for a particular
47      * platform then we just leak it deliberately. So we temporarily disable the
48      * mem leak checking while we allocate this.
49      */
50     self_test_lock = CRYPTO_THREAD_lock_new();
51     return self_test_lock != NULL;
52 }
53
54 #define DEP_DECLARE()                                                          \
55 void init(void);                                                               \
56 void cleanup(void);
57
58 /*
59  * This is the Default Entry Point (DEP) code. Every platform must have a DEP.
60  * See FIPS 140-2 IG 9.10
61  *
62  * If we're run on a platform where we don't know how to define the DEP then
63  * the self-tests will never get triggered (FIPS_state never moves to
64  * FIPS_STATE_SELFTEST). This will be detected as an error when SELF_TEST_post()
65  * is called from OSSL_provider_init(), and so the fips module will be unusable
66  * on those platforms.
67  */
68 #if defined(_WIN32) || defined(__CYGWIN__)
69 # ifdef __CYGWIN__
70 /* pick DLL_[PROCESS|THREAD]_[ATTACH|DETACH] definitions */
71 #  include <windows.h>
72 /*
73  * this has side-effect of _WIN32 getting defined, which otherwise is
74  * mutually exclusive with __CYGWIN__...
75  */
76 # endif
77
78 DEP_DECLARE()
79 # define DEP_INIT_ATTRIBUTE
80 # define DEP_FINI_ATTRIBUTE
81 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved);
82 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
83 {
84     switch (fdwReason) {
85     case DLL_PROCESS_ATTACH:
86         init();
87         break;
88     case DLL_PROCESS_DETACH:
89         cleanup();
90         break;
91     default:
92         break;
93     }
94     return TRUE;
95 }
96 #elif defined(__sun) || defined(_AIX)
97
98 DEP_DECLARE() /* must be declared before pragma */
99 # define DEP_INIT_ATTRIBUTE
100 # define DEP_FINI_ATTRIBUTE
101 # pragma init(init)
102 # pragma fini(cleanup)
103
104 #elif defined(__hpux)
105
106 DEP_DECLARE()
107 # define DEP_INIT_ATTRIBUTE
108 # define DEP_FINI_ATTRIBUTE
109 # pragma init "init"
110 # pragma fini "cleanup"
111
112 #elif defined(__GNUC__)
113 # define DEP_INIT_ATTRIBUTE static __attribute__((constructor))
114 # define DEP_FINI_ATTRIBUTE static __attribute__((destructor))
115 #endif
116
117 #if defined(DEP_INIT_ATTRIBUTE) && defined(DEP_FINI_ATTRIBUTE)
118 DEP_INIT_ATTRIBUTE void init(void)
119 {
120     FIPS_state = FIPS_STATE_SELFTEST;
121 }
122
123 DEP_FINI_ATTRIBUTE void cleanup(void)
124 {
125     CRYPTO_THREAD_lock_free(self_test_lock);
126 }
127 #endif
128
129 /*
130  * Calculate the HMAC SHA256 of data read using a BIO and read_cb, and verify
131  * the result matches the expected value.
132  * Return 1 if verified, or 0 if it fails.
133  */
134 static int verify_integrity(OSSL_CORE_BIO *bio, OSSL_FUNC_BIO_read_ex_fn read_ex_cb,
135                             unsigned char *expected, size_t expected_len,
136                             OPENSSL_CTX *libctx, OSSL_SELF_TEST *ev,
137                             const char *event_type)
138 {
139     int ret = 0, status;
140     unsigned char out[MAX_MD_SIZE];
141     unsigned char buf[INTEGRITY_BUF_SIZE];
142     size_t bytes_read = 0, out_len = 0;
143     EVP_MAC *mac = NULL;
144     EVP_MAC_CTX *ctx = NULL;
145     OSSL_PARAM params[3], *p = params;
146
147     OSSL_SELF_TEST_onbegin(ev, event_type, OSSL_SELF_TEST_DESC_INTEGRITY_HMAC);
148
149     mac = EVP_MAC_fetch(libctx, MAC_NAME, NULL);
150     ctx = EVP_MAC_new_ctx(mac);
151     if (mac == NULL || ctx == NULL)
152         goto err;
153
154     *p++ = OSSL_PARAM_construct_utf8_string("digest", DIGEST_NAME,
155                                             strlen(DIGEST_NAME) + 1);
156     *p++ = OSSL_PARAM_construct_octet_string("key", fixed_key,
157                                              sizeof(fixed_key));
158     *p = OSSL_PARAM_construct_end();
159
160     if (EVP_MAC_set_ctx_params(ctx, params) <= 0
161         || !EVP_MAC_init(ctx))
162         goto err;
163
164     while (1) {
165         status = read_ex_cb(bio, buf, sizeof(buf), &bytes_read);
166         if (status != 1)
167             break;
168         if (!EVP_MAC_update(ctx, buf, bytes_read))
169             goto err;
170     }
171     if (!EVP_MAC_final(ctx, out, &out_len, sizeof(out)))
172         goto err;
173
174     OSSL_SELF_TEST_oncorrupt_byte(ev, out);
175     if (expected_len != out_len
176             || memcmp(expected, out, out_len) != 0)
177         goto err;
178     ret = 1;
179 err:
180     OSSL_SELF_TEST_onend(ev, ret);
181     EVP_MAC_free_ctx(ctx);
182     EVP_MAC_free(mac);
183     return ret;
184 }
185
186 /* This API is triggered either on loading of the FIPS module or on demand */
187 int SELF_TEST_post(SELF_TEST_POST_PARAMS *st, int on_demand_test)
188 {
189     int ok = 0;
190     int kats_already_passed = 0;
191     long checksum_len;
192     OSSL_CORE_BIO *bio_module = NULL, *bio_indicator = NULL;
193     unsigned char *module_checksum = NULL;
194     unsigned char *indicator_checksum = NULL;
195     int loclstate;
196     OSSL_SELF_TEST *ev = NULL;
197
198     if (!RUN_ONCE(&fips_self_test_init, do_fips_self_test_init))
199         return 0;
200
201     CRYPTO_THREAD_read_lock(self_test_lock);
202     loclstate = FIPS_state;
203     CRYPTO_THREAD_unlock(self_test_lock);
204
205     if (loclstate == FIPS_STATE_RUNNING) {
206         if (!on_demand_test)
207             return 1;
208     } else if (loclstate != FIPS_STATE_SELFTEST) {
209         return 0;
210     }
211
212     CRYPTO_THREAD_write_lock(self_test_lock);
213     if (FIPS_state == FIPS_STATE_RUNNING) {
214         if (!on_demand_test) {
215             CRYPTO_THREAD_unlock(self_test_lock);
216             return 1;
217         }
218         FIPS_state = FIPS_STATE_SELFTEST;
219     } else if (FIPS_state != FIPS_STATE_SELFTEST) {
220         CRYPTO_THREAD_unlock(self_test_lock);
221         return 0;
222     }
223     if (st == NULL
224             || st->module_checksum_data == NULL)
225         goto end;
226
227     ev = OSSL_SELF_TEST_new(st->cb, st->cb_arg);
228     if (ev == NULL)
229         goto end;
230
231     module_checksum = OPENSSL_hexstr2buf(st->module_checksum_data,
232                                          &checksum_len);
233     if (module_checksum == NULL)
234         goto end;
235     bio_module = (*st->bio_new_file_cb)(st->module_filename, "rb");
236
237     /* Always check the integrity of the fips module */
238     if (bio_module == NULL
239             || !verify_integrity(bio_module, st->bio_read_ex_cb,
240                                  module_checksum, checksum_len, st->libctx,
241                                  ev, OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY))
242         goto end;
243
244     /* This will be NULL during installation - so the self test KATS will run */
245     if (st->indicator_data != NULL) {
246         /*
247          * If the kats have already passed indicator is set - then check the
248          * integrity of the indicator.
249          */
250         if (st->indicator_checksum_data == NULL)
251             goto end;
252         indicator_checksum = OPENSSL_hexstr2buf(st->indicator_checksum_data,
253                                                 &checksum_len);
254         if (indicator_checksum == NULL)
255             goto end;
256
257         bio_indicator =
258             (*st->bio_new_buffer_cb)(st->indicator_data,
259                                      strlen(st->indicator_data));
260         if (bio_indicator == NULL
261                 || !verify_integrity(bio_indicator, st->bio_read_ex_cb,
262                                      indicator_checksum, checksum_len,
263                                      st->libctx, ev,
264                                      OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY))
265             goto end;
266         else
267             kats_already_passed = 1;
268     }
269
270     /* Only runs the KAT's during installation OR on_demand() */
271     if (on_demand_test || kats_already_passed == 0) {
272         if (!SELF_TEST_kats(ev, st->libctx))
273             goto end;
274     }
275     ok = 1;
276 end:
277     OSSL_SELF_TEST_free(ev);
278     OPENSSL_free(module_checksum);
279     OPENSSL_free(indicator_checksum);
280
281     if (st != NULL) {
282         (*st->bio_free_cb)(bio_indicator);
283         (*st->bio_free_cb)(bio_module);
284     }
285     FIPS_state = ok ? FIPS_STATE_RUNNING : FIPS_STATE_ERROR;
286     CRYPTO_THREAD_unlock(self_test_lock);
287
288     return ok;
289 }