X-Git-Url: https://git.openssl.org/?a=blobdiff_plain;ds=sidebyside;f=apps%2Ffipsinstall.c;h=5198e0863e291b00aaf61228e3bfbda14061575d;hb=HEAD;hp=7efdd65d463b01b77a8af4d20b507419732644cc;hpb=5744dacb3a9d785d587afb61831cb1ff2be6ed0d;p=openssl.git diff --git a/apps/fipsinstall.c b/apps/fipsinstall.c index 7efdd65d46..d0d5716ab1 100644 --- a/apps/fipsinstall.c +++ b/apps/fipsinstall.c @@ -1,5 +1,5 @@ /* - * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved. + * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved. * * Licensed under the Apache License 2.0 (the "License"). You may not use * this file except in compliance with the License. You can obtain a copy @@ -7,7 +7,6 @@ * https://www.openssl.org/source/license.html */ -#include #include #include #include @@ -19,8 +18,6 @@ #include "apps.h" #include "progs.h" -DEFINE_STACK_OF_STRING() - #define BUFSIZE 4096 /* Configuration file values */ @@ -35,37 +32,91 @@ static int self_test_log = 1; static int quiet = 0; typedef enum OPTION_choice { - OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, - OPT_IN, OPT_OUT, OPT_MODULE, + OPT_COMMON, + OPT_IN, OPT_OUT, OPT_MODULE, OPT_PEDANTIC, OPT_PROV_NAME, OPT_SECTION_NAME, OPT_MAC_NAME, OPT_MACOPT, OPT_VERIFY, - OPT_NO_LOG, OPT_CORRUPT_DESC, OPT_CORRUPT_TYPE, OPT_QUIET + OPT_NO_LOG, OPT_CORRUPT_DESC, OPT_CORRUPT_TYPE, OPT_QUIET, OPT_CONFIG, + OPT_NO_CONDITIONAL_ERRORS, + OPT_NO_SECURITY_CHECKS, + OPT_TLS_PRF_EMS_CHECK, + OPT_DISALLOW_DRGB_TRUNC_DIGEST, + OPT_SELF_TEST_ONLOAD, OPT_SELF_TEST_ONINSTALL } OPTION_CHOICE; const OPTIONS fipsinstall_options[] = { OPT_SECTION("General"), {"help", OPT_HELP, '-', "Display this summary"}, + {"pedantic", OPT_PEDANTIC, '-', "Set options for strict FIPS compliance"}, {"verify", OPT_VERIFY, '-', "Verify a config file instead of generating one"}, {"module", OPT_MODULE, '<', "File name of the provider module"}, {"provider_name", OPT_PROV_NAME, 's', "FIPS provider name"}, {"section_name", OPT_SECTION_NAME, 's', "FIPS Provider config section name (optional)"}, - + {"no_conditional_errors", OPT_NO_CONDITIONAL_ERRORS, '-', + "Disable the ability of the fips module to enter an error state if" + " any conditional self tests fail"}, + {"no_security_checks", OPT_NO_SECURITY_CHECKS, '-', + "Disable the run-time FIPS security checks in the module"}, + {"self_test_onload", OPT_SELF_TEST_ONLOAD, '-', + "Forces self tests to always run on module load"}, + {"self_test_oninstall", OPT_SELF_TEST_ONINSTALL, '-', + "Forces self tests to run once on module installation"}, + {"ems_check", OPT_TLS_PRF_EMS_CHECK, '-', + "Enable the run-time FIPS check for EMS during TLS1_PRF"}, + {"no_drbg_truncated_digests", OPT_DISALLOW_DRGB_TRUNC_DIGEST, '-', + "Disallow truncated digests with Hash and HMAC DRBGs"}, OPT_SECTION("Input"), {"in", OPT_IN, '<', "Input config file, used when verifying"}, OPT_SECTION("Output"), {"out", OPT_OUT, '>', "Output config file, used when generating"}, {"mac_name", OPT_MAC_NAME, 's', "MAC name"}, - {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form. " - "See 'PARAMETER NAMES' in the EVP_MAC_ docs"}, + {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form."}, + {OPT_MORE_STR, 0, 0, "See 'PARAMETER NAMES' in the EVP_MAC_ docs"}, {"noout", OPT_NO_LOG, '-', "Disable logging of self test events"}, {"corrupt_desc", OPT_CORRUPT_DESC, 's', "Corrupt a self test by description"}, {"corrupt_type", OPT_CORRUPT_TYPE, 's', "Corrupt a self test by type"}, + {"config", OPT_CONFIG, '<', "The parent config to verify"}, {"quiet", OPT_QUIET, '-', "No messages, just exit status"}, {NULL} }; +typedef struct { + unsigned int self_test_onload : 1; + unsigned int conditional_errors : 1; + unsigned int security_checks : 1; + unsigned int tls_prf_ems_check : 1; + unsigned int drgb_no_trunc_dgst : 1; +} FIPS_OPTS; + +/* Pedantic FIPS compliance */ +static const FIPS_OPTS pedantic_opts = { + 1, /* self_test_onload */ + 1, /* conditional_errors */ + 1, /* security_checks */ + 1, /* tls_prf_ems_check */ + 1, /* drgb_no_trunc_dgst */ +}; + +/* Default FIPS settings for backward compatibility */ +static FIPS_OPTS fips_opts = { + 1, /* self_test_onload */ + 1, /* conditional_errors */ + 1, /* security_checks */ + 0, /* tls_prf_ems_check */ + 0, /* drgb_no_trunc_dgst */ +}; + +static int check_non_pedantic_fips(int pedantic, const char *name) +{ + if (pedantic) { + BIO_printf(bio_err, "Cannot specify -%s after -pedantic\n", name); + return 0; + } + return 1; +} + static int do_mac(EVP_MAC_CTX *ctx, unsigned char *tmp, BIO *in, unsigned char *out, size_t *out_len) { @@ -73,9 +124,9 @@ static int do_mac(EVP_MAC_CTX *ctx, unsigned char *tmp, BIO *in, int i; size_t outsz = *out_len; - if (!EVP_MAC_init(ctx)) + if (!EVP_MAC_init(ctx, NULL, 0, NULL)) goto err; - if (EVP_MAC_size(ctx) > outsz) + if (EVP_MAC_CTX_get_mac_size(ctx) > outsz) goto end; while ((i = BIO_read(in, (char *)tmp, BUFSIZE)) != 0) { if (i < 0 || !EVP_MAC_update(ctx, tmp, i)) @@ -93,12 +144,33 @@ static int load_fips_prov_and_run_self_test(const char *prov_name) { int ret = 0; OSSL_PROVIDER *prov = NULL; + OSSL_PARAM params[4], *p = params; + char *name = "", *vers = "", *build = ""; prov = OSSL_PROVIDER_load(NULL, prov_name); if (prov == NULL) { BIO_printf(bio_err, "Failed to load FIPS module\n"); goto end; } + if (!quiet) { + *p++ = OSSL_PARAM_construct_utf8_ptr(OSSL_PROV_PARAM_NAME, + &name, sizeof(name)); + *p++ = OSSL_PARAM_construct_utf8_ptr(OSSL_PROV_PARAM_VERSION, + &vers, sizeof(vers)); + *p++ = OSSL_PARAM_construct_utf8_ptr(OSSL_PROV_PARAM_BUILDINFO, + &build, sizeof(build)); + *p = OSSL_PARAM_construct_end(); + if (!OSSL_PROVIDER_get_params(prov, params)) { + BIO_printf(bio_err, "Failed to query FIPS module parameters\n"); + goto end; + } + if (OSSL_PARAM_modified(params)) + BIO_printf(bio_err, "\t%-10s\t%s\n", "name:", name); + if (OSSL_PARAM_modified(params + 1)) + BIO_printf(bio_err, "\t%-10s\t%s\n", "version:", vers); + if (OSSL_PARAM_modified(params + 2)) + BIO_printf(bio_err, "\t%-10s\t%s\n", "build:", build); + } ret = 1; end: OSSL_PROVIDER_unload(prov); @@ -131,32 +203,41 @@ static int write_config_header(BIO *out, const char *prov_name, /* * Outputs a fips related config file that contains entries for the fips - * module checksum and the installation indicator checksum. + * module checksum, installation indicator checksum and the options + * conditional_errors and security_checks. * * Returns 1 if the config file is written otherwise it returns 0 on error. */ static int write_config_fips_section(BIO *out, const char *section, unsigned char *module_mac, size_t module_mac_len, + const FIPS_OPTS *opts, unsigned char *install_mac, size_t install_mac_len) { int ret = 0; - if (!(BIO_printf(out, "[%s]\n", section) > 0 - && BIO_printf(out, "activate = 1\n") > 0 - && BIO_printf(out, "%s = %s\n", OSSL_PROV_FIPS_PARAM_INSTALL_VERSION, - VERSION_VAL) > 0 - && print_mac(out, OSSL_PROV_FIPS_PARAM_MODULE_MAC, module_mac, - module_mac_len))) + if (BIO_printf(out, "[%s]\n", section) <= 0 + || BIO_printf(out, "activate = 1\n") <= 0 + || BIO_printf(out, "%s = %s\n", OSSL_PROV_FIPS_PARAM_INSTALL_VERSION, + VERSION_VAL) <= 0 + || BIO_printf(out, "%s = %s\n", OSSL_PROV_FIPS_PARAM_CONDITIONAL_ERRORS, + opts->conditional_errors ? "1" : "0") <= 0 + || BIO_printf(out, "%s = %s\n", OSSL_PROV_FIPS_PARAM_SECURITY_CHECKS, + opts->security_checks ? "1" : "0") <= 0 + || BIO_printf(out, "%s = %s\n", OSSL_PROV_FIPS_PARAM_TLS1_PRF_EMS_CHECK, + opts->tls_prf_ems_check ? "1" : "0") <= 0 + || BIO_printf(out, "%s = %s\n", OSSL_PROV_PARAM_DRBG_TRUNC_DIGEST, + opts->drgb_no_trunc_dgst ? "1" : "0") <= 0 + || !print_mac(out, OSSL_PROV_FIPS_PARAM_MODULE_MAC, module_mac, + module_mac_len)) goto end; - if (install_mac != NULL) { - if (!(print_mac(out, OSSL_PROV_FIPS_PARAM_INSTALL_MAC, install_mac, - install_mac_len) - && BIO_printf(out, "%s = %s\n", - OSSL_PROV_FIPS_PARAM_INSTALL_STATUS, - INSTALL_STATUS_VAL) > 0)) + if (install_mac != NULL && install_mac_len > 0) { + if (!print_mac(out, OSSL_PROV_FIPS_PARAM_INSTALL_MAC, install_mac, + install_mac_len) + || BIO_printf(out, "%s = %s\n", OSSL_PROV_FIPS_PARAM_INSTALL_STATUS, + INSTALL_STATUS_VAL) <= 0) goto end; } ret = 1; @@ -167,7 +248,8 @@ end: static CONF *generate_config_and_load(const char *prov_name, const char *section, unsigned char *module_mac, - size_t module_mac_len) + size_t module_mac_len, + const FIPS_OPTS *opts) { BIO *mem_bio = NULL; CONF *conf = NULL; @@ -176,8 +258,9 @@ static CONF *generate_config_and_load(const char *prov_name, if (mem_bio == NULL) return 0; if (!write_config_header(mem_bio, prov_name, section) - || !write_config_fips_section(mem_bio, section, module_mac, - module_mac_len, NULL, 0)) + || !write_config_fips_section(mem_bio, section, + module_mac, module_mac_len, + opts, NULL, 0)) goto end; conf = app_load_config_bio(mem_bio, NULL); @@ -202,6 +285,11 @@ static void free_config_and_unload(CONF *conf) } } +static int verify_module_load(const char *parent_config_file) +{ + return OSSL_LIB_CTX_load_config(NULL, parent_config_file); +} + /* * Returns 1 if the config file entries match the passed in module_mac and * install_mac values, otherwise it returns 0. @@ -226,11 +314,6 @@ static int verify_config(const char *infile, const char *section, BIO_printf(bio_err, "version not found\n"); goto end; } - s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_STATUS); - if (s == NULL || strcmp(s, INSTALL_STATUS_VAL) != 0) { - BIO_printf(bio_err, "install status not found\n"); - goto end; - } s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_MODULE_MAC); if (s == NULL) { BIO_printf(bio_err, "Module integrity MAC not found\n"); @@ -243,17 +326,24 @@ static int verify_config(const char *infile, const char *section, BIO_printf(bio_err, "Module integrity mismatch\n"); goto end; } - s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_MAC); - if (s == NULL) { - BIO_printf(bio_err, "Install indicator MAC not found\n"); - goto end; - } - buf2 = OPENSSL_hexstr2buf(s, &len); - if (buf2 == NULL - || (size_t)len != install_mac_len - || memcmp(install_mac, buf2, install_mac_len) != 0) { - BIO_printf(bio_err, "Install indicator status mismatch\n"); - goto end; + if (install_mac != NULL && install_mac_len > 0) { + s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_STATUS); + if (s == NULL || strcmp(s, INSTALL_STATUS_VAL) != 0) { + BIO_printf(bio_err, "install status not found\n"); + goto end; + } + s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_MAC); + if (s == NULL) { + BIO_printf(bio_err, "Install indicator MAC not found\n"); + goto end; + } + buf2 = OPENSSL_hexstr2buf(s, &len); + if (buf2 == NULL + || (size_t)len != install_mac_len + || memcmp(install_mac, buf2, install_mac_len) != 0) { + BIO_printf(bio_err, "Install indicator status mismatch\n"); + goto end; + } } ret = 1; end: @@ -265,13 +355,14 @@ end: int fipsinstall_main(int argc, char **argv) { - int ret = 1, verify = 0, gotkey = 0, gotdigest = 0; + int ret = 1, verify = 0, gotkey = 0, gotdigest = 0, pedantic = 0; const char *section_name = "fips_sect"; const char *mac_name = "HMAC"; const char *prov_name = "fips"; BIO *module_bio = NULL, *mem_bio = NULL, *fout = NULL; char *in_fname = NULL, *out_fname = NULL, *prog; - char *module_fname = NULL; + char *module_fname = NULL, *parent_config = NULL, *module_path = NULL; + const char *tail; EVP_MAC_CTX *ctx = NULL, *ctx2 = NULL; STACK_OF(OPENSSL_STRING) *opts = NULL; OPTION_CHOICE o; @@ -304,6 +395,26 @@ opthelp: case OPT_OUT: out_fname = opt_arg(); break; + case OPT_PEDANTIC: + fips_opts = pedantic_opts; + pedantic = 1; + break; + case OPT_NO_CONDITIONAL_ERRORS: + if (!check_non_pedantic_fips(pedantic, "no_conditional_errors")) + goto end; + fips_opts.conditional_errors = 0; + break; + case OPT_NO_SECURITY_CHECKS: + if (!check_non_pedantic_fips(pedantic, "no_security_checks")) + goto end; + fips_opts.security_checks = 0; + break; + case OPT_TLS_PRF_EMS_CHECK: + fips_opts.tls_prf_ems_check = 1; + break; + case OPT_DISALLOW_DRGB_TRUNC_DIGEST: + fips_opts.drgb_no_trunc_dgst = 1; + break; case OPT_QUIET: quiet = 1; /* FALLTHROUGH */ @@ -328,25 +439,62 @@ opthelp: case OPT_MAC_NAME: mac_name = opt_arg(); break; + case OPT_CONFIG: + parent_config = opt_arg(); + break; case OPT_MACOPT: if (!sk_OPENSSL_STRING_push(opts, opt_arg())) goto opthelp; - if (strncmp(opt_arg(), "hexkey:", 7) == 0) + if (HAS_PREFIX(opt_arg(), "hexkey:")) gotkey = 1; - else if (strncmp(opt_arg(), "digest:", 7) == 0) + else if (HAS_PREFIX(opt_arg(), "digest:")) gotdigest = 1; break; case OPT_VERIFY: verify = 1; break; + case OPT_SELF_TEST_ONLOAD: + fips_opts.self_test_onload = 1; + break; + case OPT_SELF_TEST_ONINSTALL: + if (!check_non_pedantic_fips(pedantic, "self_test_oninstall")) + goto end; + fips_opts.self_test_onload = 0; + break; } } - argc = opt_num_rest(); - if (module_fname == NULL - || (verify && in_fname == NULL) - || (!verify && out_fname == NULL) - || argc != 0) + + /* No extra arguments. */ + if (!opt_check_rest_arg(NULL)) + goto opthelp; + if (verify && in_fname == NULL) { + BIO_printf(bio_err, "Missing -in option for -verify\n"); goto opthelp; + } + + if (parent_config != NULL) { + /* Test that a parent config can load the module */ + if (verify_module_load(parent_config)) { + ret = OSSL_PROVIDER_available(NULL, prov_name) ? 0 : 1; + if (!quiet) { + BIO_printf(bio_err, "FIPS provider is %s\n", + ret == 0 ? "available" : "not available"); + } + } + goto end; + } + if (module_fname == NULL) + goto opthelp; + + tail = opt_path_end(module_fname); + if (tail != NULL) { + module_path = OPENSSL_strdup(module_fname); + if (module_path == NULL) + goto end; + module_path[tail - module_fname] = '\0'; + if (!OSSL_PROVIDER_set_default_search_path(NULL, module_path)) + goto end; + } if (self_test_log || self_test_corrupt_desc != NULL @@ -369,13 +517,13 @@ opthelp: if (read_buffer == NULL) goto end; - mac = EVP_MAC_fetch(NULL, mac_name, NULL); + mac = EVP_MAC_fetch(app_get0_libctx(), mac_name, app_get0_propq()); if (mac == NULL) { BIO_printf(bio_err, "Unable to get MAC of type %s\n", mac_name); goto end; } - ctx = EVP_MAC_new_ctx(mac); + ctx = EVP_MAC_CTX_new(mac); if (ctx == NULL) { BIO_printf(bio_err, "Unable to create MAC CTX for module check\n"); goto end; @@ -389,7 +537,7 @@ opthelp: if (params == NULL) goto end; - if (!EVP_MAC_set_ctx_params(ctx, params)) { + if (!EVP_MAC_CTX_set_params(ctx, params)) { BIO_printf(bio_err, "MAC parameter error\n"); ERR_print_errors(bio_err); ok = 0; @@ -399,7 +547,7 @@ opthelp: goto end; } - ctx2 = EVP_MAC_dup_ctx(ctx); + ctx2 = EVP_MAC_CTX_dup(ctx); if (ctx2 == NULL) { BIO_printf(bio_err, "Unable to create MAC CTX for install indicator\n"); goto end; @@ -408,41 +556,47 @@ opthelp: if (!do_mac(ctx, read_buffer, module_bio, module_mac, &module_mac_len)) goto end; - mem_bio = BIO_new_mem_buf((const void *)INSTALL_STATUS_VAL, - strlen(INSTALL_STATUS_VAL)); - if (mem_bio == NULL) { - BIO_printf(bio_err, "Unable to create memory BIO\n"); - goto end; + if (fips_opts.self_test_onload == 0) { + mem_bio = BIO_new_mem_buf((const void *)INSTALL_STATUS_VAL, + strlen(INSTALL_STATUS_VAL)); + if (mem_bio == NULL) { + BIO_printf(bio_err, "Unable to create memory BIO\n"); + goto end; + } + if (!do_mac(ctx2, read_buffer, mem_bio, install_mac, &install_mac_len)) + goto end; + } else { + install_mac_len = 0; } - if (!do_mac(ctx2, read_buffer, mem_bio, install_mac, &install_mac_len)) - goto end; if (verify) { if (!verify_config(in_fname, section_name, module_mac, module_mac_len, install_mac, install_mac_len)) goto end; if (!quiet) - BIO_printf(bio_out, "VERIFY PASSED\n"); + BIO_printf(bio_err, "VERIFY PASSED\n"); } else { conf = generate_config_and_load(prov_name, section_name, module_mac, - module_mac_len); + module_mac_len, &fips_opts); if (conf == NULL) goto end; if (!load_fips_prov_and_run_self_test(prov_name)) goto end; - fout = bio_open_default(out_fname, 'w', FORMAT_TEXT); + fout = + out_fname == NULL ? dup_bio_out(FORMAT_TEXT) + : bio_open_default(out_fname, 'w', FORMAT_TEXT); if (fout == NULL) { BIO_printf(bio_err, "Failed to open file\n"); goto end; } - if (!write_config_fips_section(fout, section_name, module_mac, - module_mac_len, install_mac, - install_mac_len)) + if (!write_config_fips_section(fout, section_name, + module_mac, module_mac_len, &fips_opts, + install_mac, install_mac_len)) goto end; if (!quiet) - BIO_printf(bio_out, "INSTALL PASSED\n"); + BIO_printf(bio_err, "INSTALL PASSED\n"); } ret = 0; @@ -454,13 +608,14 @@ end: } cleanup: + OPENSSL_free(module_path); BIO_free(fout); BIO_free(mem_bio); BIO_free(module_bio); sk_OPENSSL_STRING_free(opts); EVP_MAC_free(mac); - EVP_MAC_free_ctx(ctx2); - EVP_MAC_free_ctx(ctx); + EVP_MAC_CTX_free(ctx2); + EVP_MAC_CTX_free(ctx); OPENSSL_free(read_buffer); free_config_and_unload(conf); return ret; @@ -489,10 +644,10 @@ static int self_test_events(const OSSL_PARAM params[], void *arg) if (self_test_log) { if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0) - BIO_printf(bio_out, "%s : (%s) : ", desc, type); + BIO_printf(bio_err, "%s : (%s) : ", desc, type); else if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0 || strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0) - BIO_printf(bio_out, "%s\n", phase); + BIO_printf(bio_err, "%s\n", phase); } /* * The self test code will internally corrupt the KAT test result if an @@ -507,7 +662,7 @@ static int self_test_events(const OSSL_PARAM params[], void *arg) if (self_test_corrupt_type != NULL && strcmp(self_test_corrupt_type, type) != 0) goto end; - BIO_printf(bio_out, "%s ", phase); + BIO_printf(bio_err, "%s ", phase); goto err; } end: