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>
16 * We're cheating here. Normally we don't allow RUN_ONCE usage inside the FIPS
17 * module because all such initialisation should be associated with an
18 * individual OPENSSL_CTX. That doesn't work with the self test though because
19 * it should be run once regardless of the number of OPENSSL_CTXs we have.
21 #define ALLOW_RUN_ONCE_IN_FIPS
22 #include <internal/thread_once.h>
23 #include "self_test.h"
25 #define FIPS_STATE_INIT 0
26 #define FIPS_STATE_SELFTEST 1
27 #define FIPS_STATE_RUNNING 2
28 #define FIPS_STATE_ERROR 3
30 /* The size of a temp buffer used to read in data */
31 #define INTEGRITY_BUF_SIZE (4096)
32 #define MAX_MD_SIZE 64
33 #define MAC_NAME "HMAC"
34 #define DIGEST_NAME "SHA256"
36 static int FIPS_state = FIPS_STATE_INIT;
37 static CRYPTO_RWLOCK *self_test_lock = NULL;
38 static unsigned char fixed_key[32] = { 0 };
40 static CRYPTO_ONCE fips_self_test_init = CRYPTO_ONCE_STATIC_INIT;
41 DEFINE_RUN_ONCE_STATIC(do_fips_self_test_init)
44 * This lock gets freed in platform specific ways that may occur after we
45 * do mem leak checking. If we don't know how to free it for a particular
46 * platform then we just leak it deliberately. So we temporarily disable the
47 * mem leak checking while we allocate this.
49 self_test_lock = CRYPTO_THREAD_lock_new();
50 return self_test_lock != NULL;
53 #define DEP_DECLARE() \
58 * This is the Default Entry Point (DEP) code. Every platform must have a DEP.
59 * See FIPS 140-2 IG 9.10
61 * If we're run on a platform where we don't know how to define the DEP then
62 * the self-tests will never get triggered (FIPS_state never moves to
63 * FIPS_STATE_SELFTEST). This will be detected as an error when SELF_TEST_post()
64 * is called from OSSL_provider_init(), and so the fips module will be unusable
67 #if defined(_WIN32) || defined(__CYGWIN__)
69 /* pick DLL_[PROCESS|THREAD]_[ATTACH|DETACH] definitions */
72 * this has side-effect of _WIN32 getting defined, which otherwise is
73 * mutually exclusive with __CYGWIN__...
78 # define DEP_INIT_ATTRIBUTE
79 # define DEP_FINI_ATTRIBUTE
80 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved);
81 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
84 case DLL_PROCESS_ATTACH:
87 case DLL_PROCESS_DETACH:
95 #elif defined(__sun) || defined(_AIX)
97 DEP_DECLARE() /* must be declared before pragma */
98 # define DEP_INIT_ATTRIBUTE
99 # define DEP_FINI_ATTRIBUTE
101 # pragma fini(cleanup)
103 #elif defined(__hpux)
106 # define DEP_INIT_ATTRIBUTE
107 # define DEP_FINI_ATTRIBUTE
109 # pragma fini "cleanup"
111 #elif defined(__GNUC__)
112 # define DEP_INIT_ATTRIBUTE static __attribute__((constructor))
113 # define DEP_FINI_ATTRIBUTE static __attribute__((destructor))
116 #if defined(DEP_INIT_ATTRIBUTE) && defined(DEP_FINI_ATTRIBUTE)
117 DEP_INIT_ATTRIBUTE void init(void)
119 FIPS_state = FIPS_STATE_SELFTEST;
122 DEP_FINI_ATTRIBUTE void cleanup(void)
124 CRYPTO_THREAD_lock_free(self_test_lock);
129 * Calculate the HMAC SHA256 of data read using a BIO and read_cb, and verify
130 * the result matches the expected value.
131 * Return 1 if verified, or 0 if it fails.
133 static int verify_integrity(OSSL_CORE_BIO *bio, OSSL_BIO_read_ex_fn read_ex_cb,
134 unsigned char *expected, size_t expected_len,
135 OPENSSL_CTX *libctx, OSSL_SELF_TEST *ev,
136 const char *event_type)
139 unsigned char out[MAX_MD_SIZE];
140 unsigned char buf[INTEGRITY_BUF_SIZE];
141 size_t bytes_read = 0, out_len = 0;
143 EVP_MAC_CTX *ctx = NULL;
144 OSSL_PARAM params[3], *p = params;
146 OSSL_SELF_TEST_onbegin(ev, event_type, OSSL_SELF_TEST_DESC_INTEGRITY_HMAC);
148 mac = EVP_MAC_fetch(libctx, MAC_NAME, NULL);
149 ctx = EVP_MAC_new_ctx(mac);
150 if (mac == NULL || ctx == NULL)
153 *p++ = OSSL_PARAM_construct_utf8_string("digest", DIGEST_NAME,
154 strlen(DIGEST_NAME) + 1);
155 *p++ = OSSL_PARAM_construct_octet_string("key", fixed_key,
157 *p = OSSL_PARAM_construct_end();
159 if (EVP_MAC_set_ctx_params(ctx, params) <= 0
160 || !EVP_MAC_init(ctx))
164 status = read_ex_cb(bio, buf, sizeof(buf), &bytes_read);
167 if (!EVP_MAC_update(ctx, buf, bytes_read))
170 if (!EVP_MAC_final(ctx, out, &out_len, sizeof(out)))
173 OSSL_SELF_TEST_oncorrupt_byte(ev, out);
174 if (expected_len != out_len
175 || memcmp(expected, out, out_len) != 0)
179 OSSL_SELF_TEST_onend(ev, ret);
180 EVP_MAC_free_ctx(ctx);
185 /* This API is triggered either on loading of the FIPS module or on demand */
186 int SELF_TEST_post(SELF_TEST_POST_PARAMS *st, int on_demand_test)
189 int kats_already_passed = 0;
191 OSSL_CORE_BIO *bio_module = NULL, *bio_indicator = NULL;
192 unsigned char *module_checksum = NULL;
193 unsigned char *indicator_checksum = NULL;
195 OSSL_SELF_TEST *ev = NULL;
197 if (!RUN_ONCE(&fips_self_test_init, do_fips_self_test_init))
200 CRYPTO_THREAD_read_lock(self_test_lock);
201 loclstate = FIPS_state;
202 CRYPTO_THREAD_unlock(self_test_lock);
204 if (loclstate == FIPS_STATE_RUNNING) {
207 } else if (loclstate != FIPS_STATE_SELFTEST) {
211 CRYPTO_THREAD_write_lock(self_test_lock);
212 if (FIPS_state == FIPS_STATE_RUNNING) {
213 if (!on_demand_test) {
214 CRYPTO_THREAD_unlock(self_test_lock);
217 FIPS_state = FIPS_STATE_SELFTEST;
218 } else if (FIPS_state != FIPS_STATE_SELFTEST) {
219 CRYPTO_THREAD_unlock(self_test_lock);
223 || st->module_checksum_data == NULL)
226 ev = OSSL_SELF_TEST_new(st->cb, st->cb_arg);
230 module_checksum = OPENSSL_hexstr2buf(st->module_checksum_data,
232 if (module_checksum == NULL)
234 bio_module = (*st->bio_new_file_cb)(st->module_filename, "rb");
236 /* Always check the integrity of the fips module */
237 if (bio_module == NULL
238 || !verify_integrity(bio_module, st->bio_read_ex_cb,
239 module_checksum, checksum_len, st->libctx,
240 ev, OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY))
243 /* This will be NULL during installation - so the self test KATS will run */
244 if (st->indicator_data != NULL) {
246 * If the kats have already passed indicator is set - then check the
247 * integrity of the indicator.
249 if (st->indicator_checksum_data == NULL)
251 indicator_checksum = OPENSSL_hexstr2buf(st->indicator_checksum_data,
253 if (indicator_checksum == NULL)
257 (*st->bio_new_buffer_cb)(st->indicator_data,
258 strlen(st->indicator_data));
259 if (bio_indicator == NULL
260 || !verify_integrity(bio_indicator, st->bio_read_ex_cb,
261 indicator_checksum, checksum_len,
263 OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY))
266 kats_already_passed = 1;
269 /* Only runs the KAT's during installation OR on_demand() */
270 if (on_demand_test || kats_already_passed == 0) {
271 if (!SELF_TEST_kats(ev, st->libctx))
276 OSSL_SELF_TEST_free(ev);
277 OPENSSL_free(module_checksum);
278 OPENSSL_free(indicator_checksum);
281 (*st->bio_free_cb)(bio_indicator);
282 (*st->bio_free_cb)(bio_module);
284 FIPS_state = ok ? FIPS_STATE_RUNNING : FIPS_STATE_ERROR;
285 CRYPTO_THREAD_unlock(self_test_lock);