2 * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
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
11 #include <openssl/evp.h>
12 #include <openssl/params.h>
13 #include <openssl/crypto.h>
14 #include <openssl/fipskey.h>
15 #include <openssl/err.h>
17 #include "prov/providercommonerr.h"
18 #include "prov/providercommon.h"
21 * We're cheating here. Normally we don't allow RUN_ONCE usage inside the FIPS
22 * module because all such initialisation should be associated with an
23 * individual OPENSSL_CTX. That doesn't work with the self test though because
24 * it should be run once regardless of the number of OPENSSL_CTXs we have.
26 #define ALLOW_RUN_ONCE_IN_FIPS
27 #include <internal/thread_once.h>
28 #include "self_test.h"
30 #define FIPS_STATE_INIT 0
31 #define FIPS_STATE_SELFTEST 1
32 #define FIPS_STATE_RUNNING 2
33 #define FIPS_STATE_ERROR 3
36 * The number of times the module will report it is in the error state
39 #define FIPS_ERROR_REPORTING_RATE_LIMIT 10
41 /* The size of a temp buffer used to read in data */
42 #define INTEGRITY_BUF_SIZE (4096)
43 #define MAX_MD_SIZE 64
44 #define MAC_NAME "HMAC"
45 #define DIGEST_NAME "SHA256"
47 static int FIPS_conditional_error_check = 1;
48 static int FIPS_state = FIPS_STATE_INIT;
49 static CRYPTO_RWLOCK *self_test_lock = NULL;
50 static unsigned char fixed_key[32] = { FIPS_KEY_ELEMENTS };
52 static CRYPTO_ONCE fips_self_test_init = CRYPTO_ONCE_STATIC_INIT;
53 DEFINE_RUN_ONCE_STATIC(do_fips_self_test_init)
56 * This lock gets freed in platform specific ways that may occur after we
57 * do mem leak checking. If we don't know how to free it for a particular
58 * platform then we just leak it deliberately. So we temporarily disable the
59 * mem leak checking while we allocate this.
61 self_test_lock = CRYPTO_THREAD_lock_new();
62 return self_test_lock != NULL;
65 #define DEP_DECLARE() \
70 * This is the Default Entry Point (DEP) code. Every platform must have a DEP.
71 * See FIPS 140-2 IG 9.10
73 * If we're run on a platform where we don't know how to define the DEP then
74 * the self-tests will never get triggered (FIPS_state never moves to
75 * FIPS_STATE_SELFTEST). This will be detected as an error when SELF_TEST_post()
76 * is called from OSSL_provider_init(), and so the fips module will be unusable
79 #if defined(_WIN32) || defined(__CYGWIN__)
81 /* pick DLL_[PROCESS|THREAD]_[ATTACH|DETACH] definitions */
84 * this has side-effect of _WIN32 getting defined, which otherwise is
85 * mutually exclusive with __CYGWIN__...
90 # define DEP_INIT_ATTRIBUTE
91 # define DEP_FINI_ATTRIBUTE
92 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved);
93 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
96 case DLL_PROCESS_ATTACH:
99 case DLL_PROCESS_DETACH:
107 #elif defined(__sun) || defined(_AIX)
109 DEP_DECLARE() /* must be declared before pragma */
110 # define DEP_INIT_ATTRIBUTE
111 # define DEP_FINI_ATTRIBUTE
113 # pragma fini(cleanup)
115 #elif defined(__hpux)
118 # define DEP_INIT_ATTRIBUTE
119 # define DEP_FINI_ATTRIBUTE
121 # pragma fini "cleanup"
123 #elif defined(__GNUC__)
124 # define DEP_INIT_ATTRIBUTE static __attribute__((constructor))
125 # define DEP_FINI_ATTRIBUTE static __attribute__((destructor))
127 #elif defined(__TANDEM)
128 DEP_DECLARE() /* must be declared before calling init() or cleanup() */
129 # define DEP_INIT_ATTRIBUTE
130 # define DEP_FINI_ATTRIBUTE
132 /* Method automatically called by the NonStop OS when the DLL loads */
133 void __INIT__init(void) {
137 /* Method automatically called by the NonStop OS prior to unloading the DLL */
138 void __TERM__cleanup(void) {
144 #if defined(DEP_INIT_ATTRIBUTE) && defined(DEP_FINI_ATTRIBUTE)
145 DEP_INIT_ATTRIBUTE void init(void)
147 FIPS_state = FIPS_STATE_SELFTEST;
150 DEP_FINI_ATTRIBUTE void cleanup(void)
152 CRYPTO_THREAD_lock_free(self_test_lock);
157 * Calculate the HMAC SHA256 of data read using a BIO and read_cb, and verify
158 * the result matches the expected value.
159 * Return 1 if verified, or 0 if it fails.
161 static int verify_integrity(OSSL_CORE_BIO *bio, OSSL_FUNC_BIO_read_ex_fn read_ex_cb,
162 unsigned char *expected, size_t expected_len,
163 OPENSSL_CTX *libctx, OSSL_SELF_TEST *ev,
164 const char *event_type)
167 unsigned char out[MAX_MD_SIZE];
168 unsigned char buf[INTEGRITY_BUF_SIZE];
169 size_t bytes_read = 0, out_len = 0;
171 EVP_MAC_CTX *ctx = NULL;
172 OSSL_PARAM params[3], *p = params;
174 OSSL_SELF_TEST_onbegin(ev, event_type, OSSL_SELF_TEST_DESC_INTEGRITY_HMAC);
176 mac = EVP_MAC_fetch(libctx, MAC_NAME, NULL);
179 ctx = EVP_MAC_CTX_new(mac);
183 *p++ = OSSL_PARAM_construct_utf8_string("digest", DIGEST_NAME,
184 strlen(DIGEST_NAME) + 1);
185 *p++ = OSSL_PARAM_construct_octet_string("key", fixed_key,
187 *p = OSSL_PARAM_construct_end();
189 if (EVP_MAC_CTX_set_params(ctx, params) <= 0
190 || !EVP_MAC_init(ctx))
194 status = read_ex_cb(bio, buf, sizeof(buf), &bytes_read);
197 if (!EVP_MAC_update(ctx, buf, bytes_read))
200 if (!EVP_MAC_final(ctx, out, &out_len, sizeof(out)))
203 OSSL_SELF_TEST_oncorrupt_byte(ev, out);
204 if (expected_len != out_len
205 || memcmp(expected, out, out_len) != 0)
209 OSSL_SELF_TEST_onend(ev, ret);
210 EVP_MAC_CTX_free(ctx);
215 /* This API is triggered either on loading of the FIPS module or on demand */
216 int SELF_TEST_post(SELF_TEST_POST_PARAMS *st, int on_demand_test)
219 int kats_already_passed = 0;
221 OSSL_CORE_BIO *bio_module = NULL, *bio_indicator = NULL;
222 unsigned char *module_checksum = NULL;
223 unsigned char *indicator_checksum = NULL;
225 OSSL_SELF_TEST *ev = NULL;
227 if (!RUN_ONCE(&fips_self_test_init, do_fips_self_test_init))
230 CRYPTO_THREAD_read_lock(self_test_lock);
231 loclstate = FIPS_state;
232 CRYPTO_THREAD_unlock(self_test_lock);
234 if (loclstate == FIPS_STATE_RUNNING) {
237 } else if (loclstate != FIPS_STATE_SELFTEST) {
238 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_STATE);
242 CRYPTO_THREAD_write_lock(self_test_lock);
243 if (FIPS_state == FIPS_STATE_RUNNING) {
244 if (!on_demand_test) {
245 CRYPTO_THREAD_unlock(self_test_lock);
248 FIPS_state = FIPS_STATE_SELFTEST;
249 } else if (FIPS_state != FIPS_STATE_SELFTEST) {
250 CRYPTO_THREAD_unlock(self_test_lock);
251 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_STATE);
255 || st->module_checksum_data == NULL) {
256 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CONFIG_DATA);
260 ev = OSSL_SELF_TEST_new(st->cb, st->cb_arg);
264 module_checksum = OPENSSL_hexstr2buf(st->module_checksum_data,
266 if (module_checksum == NULL) {
267 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CONFIG_DATA);
270 bio_module = (*st->bio_new_file_cb)(st->module_filename, "rb");
272 /* Always check the integrity of the fips module */
273 if (bio_module == NULL
274 || !verify_integrity(bio_module, st->bio_read_ex_cb,
275 module_checksum, checksum_len, st->libctx,
276 ev, OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY)) {
277 ERR_raise(ERR_LIB_PROV, PROV_R_MODULE_INTEGRITY_FAILURE);
281 /* This will be NULL during installation - so the self test KATS will run */
282 if (st->indicator_data != NULL) {
284 * If the kats have already passed indicator is set - then check the
285 * integrity of the indicator.
287 if (st->indicator_checksum_data == NULL) {
288 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CONFIG_DATA);
291 indicator_checksum = OPENSSL_hexstr2buf(st->indicator_checksum_data,
293 if (indicator_checksum == NULL) {
294 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CONFIG_DATA);
299 (*st->bio_new_buffer_cb)(st->indicator_data,
300 strlen(st->indicator_data));
301 if (bio_indicator == NULL
302 || !verify_integrity(bio_indicator, st->bio_read_ex_cb,
303 indicator_checksum, checksum_len,
305 OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY)) {
306 ERR_raise(ERR_LIB_PROV, PROV_R_INDICATOR_INTEGRITY_FAILURE);
309 kats_already_passed = 1;
313 /* Only runs the KAT's during installation OR on_demand() */
314 if (on_demand_test || kats_already_passed == 0) {
315 if (!SELF_TEST_kats(ev, st->libctx)) {
316 ERR_raise(ERR_LIB_PROV, PROV_R_SELF_TEST_KAT_FAILURE);
322 OSSL_SELF_TEST_free(ev);
323 OPENSSL_free(module_checksum);
324 OPENSSL_free(indicator_checksum);
327 (*st->bio_free_cb)(bio_indicator);
328 (*st->bio_free_cb)(bio_module);
331 FIPS_state = FIPS_STATE_RUNNING;
333 ossl_set_error_state(OSSL_SELF_TEST_TYPE_NONE);
334 CRYPTO_THREAD_unlock(self_test_lock);
339 void SELF_TEST_disable_conditional_error_state(void)
341 FIPS_conditional_error_check = 0;
344 void ossl_set_error_state(const char *type)
346 int cond_test = (type != NULL && strcmp(type, OSSL_SELF_TEST_TYPE_PCT) == 0);
348 if (!cond_test || (FIPS_conditional_error_check == 1)) {
349 FIPS_state = FIPS_STATE_ERROR;
350 ERR_raise(ERR_LIB_PROV, PROV_R_FIPS_MODULE_ENTERING_ERROR_STATE);
352 ERR_raise(ERR_LIB_PROV, PROV_R_FIPS_MODULE_CONDITIONAL_ERROR);
356 int ossl_prov_is_running(void)
358 const int res = FIPS_state == FIPS_STATE_RUNNING
359 || FIPS_state == FIPS_STATE_SELFTEST;
360 static unsigned int rate_limit = 0;
364 } else if (FIPS_state == FIPS_STATE_ERROR) {
365 if (rate_limit++ < FIPS_ERROR_REPORTING_RATE_LIMIT)
366 ERR_raise(ERR_LIB_PROV, PROV_R_FIPS_MODULE_IN_ERROR_STATE);