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 <openssl/err.h>
  16 #include "e_os.h"
  17 #include "prov/providercommonerr.h"
  18 #include "prov/providercommon.h"
  19
  20 /*
  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.
  25  */
  26 #define ALLOW_RUN_ONCE_IN_FIPS
  27 #include <internal/thread_once.h>
  28 #include "self_test.h"
  29
  30 #define FIPS_STATE_INIT     0
  31 #define FIPS_STATE_SELFTEST 1
  32 #define FIPS_STATE_RUNNING  2
  33 #define FIPS_STATE_ERROR    3
  34
  35 /*
  36  * The number of times the module will report it is in the error state
  37  * before going quiet.
  38  */
  39 #define FIPS_ERROR_REPORTING_RATE_LIMIT     10
  40
  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"
  46
  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 };
  51
  52 static CRYPTO_ONCE fips_self_test_init = CRYPTO_ONCE_STATIC_INIT;
  53 DEFINE_RUN_ONCE_STATIC(do_fips_self_test_init)
  54 {
  55     /*
  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.
  60      */
  61     self_test_lock = CRYPTO_THREAD_lock_new();
  62     return self_test_lock != NULL;
  63 }
  64
  65 #define DEP_DECLARE()                                                          \
  66 void init(void);                                                               \
  67 void cleanup(void);
  68
  69 /*
  70  * This is the Default Entry Point (DEP) code. Every platform must have a DEP.
  71  * See FIPS 140-2 IG 9.10
  72  *
  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
  77  * on those platforms.
  78  */
  79 #if defined(_WIN32) || defined(__CYGWIN__)
  80 # ifdef __CYGWIN__
  81 /* pick DLL_[PROCESS|THREAD]_[ATTACH|DETACH] definitions */
  82 #  include <windows.h>
  83 /*
  84  * this has side-effect of _WIN32 getting defined, which otherwise is
  85  * mutually exclusive with __CYGWIN__...
  86  */
  87 # endif
  88
  89 DEP_DECLARE()
  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)
  94 {
  95     switch (fdwReason) {
  96     case DLL_PROCESS_ATTACH:
  97         init();
  98         break;
  99     case DLL_PROCESS_DETACH:
 100         cleanup();
 101         break;
 102     default:
 103         break;
 104     }
 105     return TRUE;
 106 }
 107 #elif defined(__sun) || defined(_AIX)
 108
 109 DEP_DECLARE() /* must be declared before pragma */
 110 # define DEP_INIT_ATTRIBUTE
 111 # define DEP_FINI_ATTRIBUTE
 112 # pragma init(init)
 113 # pragma fini(cleanup)
 114
 115 #elif defined(__hpux)
 116
 117 DEP_DECLARE()
 118 # define DEP_INIT_ATTRIBUTE
 119 # define DEP_FINI_ATTRIBUTE
 120 # pragma init "init"
 121 # pragma fini "cleanup"
 122
 123 #elif defined(__GNUC__)
 124 # define DEP_INIT_ATTRIBUTE static __attribute__((constructor))
 125 # define DEP_FINI_ATTRIBUTE static __attribute__((destructor))
 126 #endif
 127
 128 #if defined(DEP_INIT_ATTRIBUTE) && defined(DEP_FINI_ATTRIBUTE)
 129 DEP_INIT_ATTRIBUTE void init(void)
 130 {
 131     FIPS_state = FIPS_STATE_SELFTEST;
 132 }
 133
 134 DEP_FINI_ATTRIBUTE void cleanup(void)
 135 {
 136     CRYPTO_THREAD_lock_free(self_test_lock);
 137 }
 138 #endif
 139
 140 /*
 141  * Calculate the HMAC SHA256 of data read using a BIO and read_cb, and verify
 142  * the result matches the expected value.
 143  * Return 1 if verified, or 0 if it fails.
 144  */
 145 static int verify_integrity(OSSL_CORE_BIO *bio, OSSL_FUNC_BIO_read_ex_fn read_ex_cb,
 146                             unsigned char *expected, size_t expected_len,
 147                             OPENSSL_CTX *libctx, OSSL_SELF_TEST *ev,
 148                             const char *event_type)
 149 {
 150     int ret = 0, status;
 151     unsigned char out[MAX_MD_SIZE];
 152     unsigned char buf[INTEGRITY_BUF_SIZE];
 153     size_t bytes_read = 0, out_len = 0;
 154     EVP_MAC *mac = NULL;
 155     EVP_MAC_CTX *ctx = NULL;
 156     OSSL_PARAM params[3], *p = params;
 157
 158     OSSL_SELF_TEST_onbegin(ev, event_type, OSSL_SELF_TEST_DESC_INTEGRITY_HMAC);
 159
 160     mac = EVP_MAC_fetch(libctx, MAC_NAME, NULL);
 161     ctx = EVP_MAC_CTX_new(mac);
 162     if (mac == NULL || ctx == NULL)
 163         goto err;
 164
 165     *p++ = OSSL_PARAM_construct_utf8_string("digest", DIGEST_NAME,
 166                                             strlen(DIGEST_NAME) + 1);
 167     *p++ = OSSL_PARAM_construct_octet_string("key", fixed_key,
 168                                              sizeof(fixed_key));
 169     *p = OSSL_PARAM_construct_end();
 170
 171     if (EVP_MAC_CTX_set_params(ctx, params) <= 0
 172         || !EVP_MAC_init(ctx))
 173         goto err;
 174
 175     while (1) {
 176         status = read_ex_cb(bio, buf, sizeof(buf), &bytes_read);
 177         if (status != 1)
 178             break;
 179         if (!EVP_MAC_update(ctx, buf, bytes_read))
 180             goto err;
 181     }
 182     if (!EVP_MAC_final(ctx, out, &out_len, sizeof(out)))
 183         goto err;
 184
 185     OSSL_SELF_TEST_oncorrupt_byte(ev, out);
 186     if (expected_len != out_len
 187             || memcmp(expected, out, out_len) != 0)
 188         goto err;
 189     ret = 1;
 190 err:
 191     OSSL_SELF_TEST_onend(ev, ret);
 192     EVP_MAC_CTX_free(ctx);
 193     EVP_MAC_free(mac);
 194     return ret;
 195 }
 196
 197 /* This API is triggered either on loading of the FIPS module or on demand */
 198 int SELF_TEST_post(SELF_TEST_POST_PARAMS *st, int on_demand_test)
 199 {
 200     int ok = 0;
 201     int kats_already_passed = 0;
 202     long checksum_len;
 203     OSSL_CORE_BIO *bio_module = NULL, *bio_indicator = NULL;
 204     unsigned char *module_checksum = NULL;
 205     unsigned char *indicator_checksum = NULL;
 206     int loclstate;
 207     OSSL_SELF_TEST *ev = NULL;
 208
 209     if (!RUN_ONCE(&fips_self_test_init, do_fips_self_test_init))
 210         return 0;
 211
 212     CRYPTO_THREAD_read_lock(self_test_lock);
 213     loclstate = FIPS_state;
 214     CRYPTO_THREAD_unlock(self_test_lock);
 215
 216     if (loclstate == FIPS_STATE_RUNNING) {
 217         if (!on_demand_test)
 218             return 1;
 219     } else if (loclstate != FIPS_STATE_SELFTEST) {
 220         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_STATE);
 221         return 0;
 222     }
 223
 224     CRYPTO_THREAD_write_lock(self_test_lock);
 225     if (FIPS_state == FIPS_STATE_RUNNING) {
 226         if (!on_demand_test) {
 227             CRYPTO_THREAD_unlock(self_test_lock);
 228             return 1;
 229         }
 230         FIPS_state = FIPS_STATE_SELFTEST;
 231     } else if (FIPS_state != FIPS_STATE_SELFTEST) {
 232         CRYPTO_THREAD_unlock(self_test_lock);
 233         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_STATE);
 234         return 0;
 235     }
 236     if (st == NULL
 237             || st->module_checksum_data == NULL) {
 238         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CONFIG_DATA);
 239         goto end;
 240     }
 241
 242     ev = OSSL_SELF_TEST_new(st->cb, st->cb_arg);
 243     if (ev == NULL)
 244         goto end;
 245
 246     module_checksum = OPENSSL_hexstr2buf(st->module_checksum_data,
 247                                          &checksum_len);
 248     if (module_checksum == NULL) {
 249         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CONFIG_DATA);
 250         goto end;
 251     }
 252     bio_module = (*st->bio_new_file_cb)(st->module_filename, "rb");
 253
 254     /* Always check the integrity of the fips module */
 255     if (bio_module == NULL
 256             || !verify_integrity(bio_module, st->bio_read_ex_cb,
 257                                  module_checksum, checksum_len, st->libctx,
 258                                  ev, OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY)) {
 259         ERR_raise(ERR_LIB_PROV, PROV_R_MODULE_INTEGRITY_FAILURE);
 260         goto end;
 261     }
 262
 263     /* This will be NULL during installation - so the self test KATS will run */
 264     if (st->indicator_data != NULL) {
 265         /*
 266          * If the kats have already passed indicator is set - then check the
 267          * integrity of the indicator.
 268          */
 269         if (st->indicator_checksum_data == NULL) {
 270             ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CONFIG_DATA);
 271             goto end;
 272         }
 273         indicator_checksum = OPENSSL_hexstr2buf(st->indicator_checksum_data,
 274                                                 &checksum_len);
 275         if (indicator_checksum == NULL) {
 276             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CONFIG_DATA);
 277             goto end;
 278         }
 279
 280         bio_indicator =
 281             (*st->bio_new_buffer_cb)(st->indicator_data,
 282                                      strlen(st->indicator_data));
 283         if (bio_indicator == NULL
 284                 || !verify_integrity(bio_indicator, st->bio_read_ex_cb,
 285                                      indicator_checksum, checksum_len,
 286                                      st->libctx, ev,
 287                                      OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY)) {
 288             ERR_raise(ERR_LIB_PROV, PROV_R_INDICATOR_INTEGRITY_FAILURE);
 289             goto end;
 290         } else {
 291             kats_already_passed = 1;
 292         }
 293     }
 294
 295     /* Only runs the KAT's during installation OR on_demand() */
 296     if (on_demand_test || kats_already_passed == 0) {
 297         if (!SELF_TEST_kats(ev, st->libctx)) {
 298             ERR_raise(ERR_LIB_PROV, PROV_R_SELF_TEST_KAT_FAILURE);
 299             goto end;
 300         }
 301     }
 302     ok = 1;
 303 end:
 304     OSSL_SELF_TEST_free(ev);
 305     OPENSSL_free(module_checksum);
 306     OPENSSL_free(indicator_checksum);
 307
 308     if (st != NULL) {
 309         (*st->bio_free_cb)(bio_indicator);
 310         (*st->bio_free_cb)(bio_module);
 311     }
 312     if (ok)
 313         FIPS_state = FIPS_STATE_RUNNING;
 314     else
 315         ossl_set_error_state(OSSL_SELF_TEST_TYPE_NONE);
 316     CRYPTO_THREAD_unlock(self_test_lock);
 317
 318     return ok;
 319 }
 320
 321 void SELF_TEST_disable_conditional_error_state(void)
 322 {
 323     FIPS_conditional_error_check = 0;
 324 }
 325
 326 void ossl_set_error_state(const char *type)
 327 {
 328     int cond_test = (type != NULL && strcmp(type, OSSL_SELF_TEST_TYPE_PCT) == 0);
 329
 330     if (!cond_test || (FIPS_conditional_error_check == 1)) {
 331         FIPS_state = FIPS_STATE_ERROR;
 332         ERR_raise(ERR_LIB_PROV, PROV_R_FIPS_MODULE_ENTERING_ERROR_STATE);
 333     } else {
 334         ERR_raise(ERR_LIB_PROV, PROV_R_FIPS_MODULE_CONDITIONAL_ERROR);
 335     }
 336 }
 337
 338 int ossl_prov_is_running(void)
 339 {
 340     const int res = FIPS_state == FIPS_STATE_RUNNING
 341                     || FIPS_state == FIPS_STATE_SELFTEST;
 342     static unsigned int rate_limit = 0;
 343
 344     if (res) {
 345         rate_limit = 0;
 346     } else if (FIPS_state == FIPS_STATE_ERROR) {
 347         if (rate_limit++ < FIPS_ERROR_REPORTING_RATE_LIMIT)
 348             ERR_raise(ERR_LIB_PROV, PROV_R_FIPS_MODULE_IN_ERROR_STATE);
 349     }
 350     return res;
 351 }