[thirdparty/openssl.git] / apps / fipsinstall.c

/*
 * Copyright 2019-2020 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
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <string.h>
#include <openssl/evp.h>
#include <openssl/err.h>
#include <openssl/provider.h>
#include <openssl/params.h>
#include <openssl/fips_names.h>
#include <openssl/core_names.h>
#include <openssl/self_test.h>
#include <openssl/fipskey.h>
#include "apps.h"
#include "progs.h"

DEFINE_STACK_OF_STRING()

#define BUFSIZE 4096
#define DEFAULT_MAC_NAME "HMAC"
#define DEFAULT_FIPS_SECTION "fips_check_section"

/* Configuration file values */
#define VERSION_KEY  "version"
#define VERSION_VAL  "1"
#define INSTALL_STATUS_VAL "INSTALL_SELF_TEST_KATS_RUN"

static OSSL_CALLBACK self_test_events;
static char *self_test_corrupt_desc = NULL;
static char *self_test_corrupt_type = NULL;
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_PROV_NAME, OPT_SECTION_NAME, OPT_MAC_NAME, OPT_MACOPT, OPT_VERIFY,
    OPT_NO_LOG, OPT_CORRUPT_DESC, OPT_CORRUPT_TYPE, OPT_QUIET
} OPTION_CHOICE;

const OPTIONS fipsinstall_options[] = {
    OPT_SECTION("General"),
    {"help", OPT_HELP, '-', "Display this summary"},
    {"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)"},

    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"},
    {"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"},
    {"quiet", OPT_QUIET, '-', "No messages, just exit status"},
    {NULL}
};

static int do_mac(EVP_MAC_CTX *ctx, unsigned char *tmp, BIO *in,
                  unsigned char *out, size_t *out_len)
{
    int ret = 0;
    int i;
    size_t outsz = *out_len;

    if (!EVP_MAC_init(ctx))
        goto err;
    if (EVP_MAC_size(ctx) > outsz)
        goto end;
    while ((i = BIO_read(in, (char *)tmp, BUFSIZE)) != 0) {
        if (i < 0 || !EVP_MAC_update(ctx, tmp, i))
            goto err;
    }
end:
    if (!EVP_MAC_final(ctx, out, out_len, outsz))
        goto err;
    ret = 1;
err:
    return ret;
}

static int load_fips_prov_and_run_self_test(const char *prov_name)
{
    int ret = 0;
    OSSL_PROVIDER *prov = NULL;

    prov = OSSL_PROVIDER_load(NULL, prov_name);
    if (prov == NULL) {
        BIO_printf(bio_err, "Failed to load FIPS module\n");
        goto end;
    }
    ret = 1;
end:
    OSSL_PROVIDER_unload(prov);
    return ret;
}

static int print_mac(BIO *bio, const char *label, const unsigned char *mac,
                     size_t len)
{
    int ret;
    char *hexstr = NULL;

    hexstr = OPENSSL_buf2hexstr(mac, (long)len);
    if (hexstr == NULL)
        return 0;
    ret = BIO_printf(bio, "%s = %s\n", label, hexstr);
    OPENSSL_free(hexstr);
    return ret;
}

static int write_config_header(BIO *out, const char *prov_name,
                               const char *section)
{
    return BIO_printf(out, "openssl_conf = openssl_init\n\n")
           && BIO_printf(out, "[openssl_init]\n")
           && BIO_printf(out, "providers = provider_section\n\n")
           && BIO_printf(out, "[provider_section]\n")
           && BIO_printf(out, "%s = %s\n\n", prov_name, section);
}

/*
 * Outputs a fips related config file that contains entries for the fips
 * module checksum and the installation indicator checksum.
 *
 * 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,
                                     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)))
        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))
        goto end;
    }
    ret = 1;
end:
    return ret;
}

static CONF *generate_config_and_load(const char *prov_name,
                                      const char *section,
                                      unsigned char *module_mac,
                                      size_t module_mac_len)
{
    BIO *mem_bio = NULL;
    CONF *conf = NULL;

    mem_bio = BIO_new(BIO_s_mem());
    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))
        goto end;

    conf = app_load_config_bio(mem_bio, NULL);
    if (conf == NULL)
        goto end;

    if (CONF_modules_load(conf, NULL, 0) <= 0)
        goto end;
    BIO_free(mem_bio);
    return conf;
end:
    NCONF_free(conf);
    BIO_free(mem_bio);
    return NULL;
}

static void free_config_and_unload(CONF *conf)
{
    if (conf != NULL) {
        NCONF_free(conf);
        CONF_modules_unload(1);
    }
}

/*
 * Returns 1 if the config file entries match the passed in module_mac and
 * install_mac values, otherwise it returns 0.
 */
static int verify_config(const char *infile, const char *section,
                         unsigned char *module_mac, size_t module_mac_len,
                         unsigned char *install_mac, size_t install_mac_len)
{
    int ret = 0;
    char *s = NULL;
    unsigned char *buf1 = NULL, *buf2 = NULL;
    long len;
    CONF *conf = NULL;

    /* read in the existing values and check they match the saved values */
    conf = app_load_config(infile);
    if (conf == NULL)
        goto end;

    s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_VERSION);
    if (s == NULL || strcmp(s, VERSION_VAL) != 0) {
        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");
        goto end;
    }
    buf1 = OPENSSL_hexstr2buf(s, &len);
    if (buf1 == NULL
            || (size_t)len != module_mac_len
            || memcmp(module_mac, buf1, module_mac_len) != 0) {
        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;
    }
    ret = 1;
end:
    OPENSSL_free(buf1);
    OPENSSL_free(buf2);
    NCONF_free(conf);
    return ret;
}

int fipsinstall_main(int argc, char **argv)
{
    int ret = 1, verify = 0, gotkey = 0, gotdigest = 0;
    BIO *module_bio = NULL, *mem_bio = NULL, *fout = NULL;
    char *in_fname = NULL, *out_fname = NULL, *prog, *section_name = NULL;
    char *prov_name = NULL, *module_fname = NULL;
    static const char *mac_name = DEFAULT_MAC_NAME;
    EVP_MAC_CTX *ctx = NULL, *ctx2 = NULL;
    STACK_OF(OPENSSL_STRING) *opts = NULL;
    OPTION_CHOICE o;
    unsigned char *read_buffer = NULL;
    unsigned char module_mac[EVP_MAX_MD_SIZE];
    size_t module_mac_len = EVP_MAX_MD_SIZE;
    unsigned char install_mac[EVP_MAX_MD_SIZE];
    size_t install_mac_len = EVP_MAX_MD_SIZE;
    EVP_MAC *mac = NULL;
    CONF *conf = NULL;

    section_name = DEFAULT_FIPS_SECTION;
    if ((opts = sk_OPENSSL_STRING_new_null()) == NULL)
        goto end;

    prog = opt_init(argc, argv, fipsinstall_options);
    while ((o = opt_next()) != OPT_EOF) {
        switch (o) {
        case OPT_EOF:
        case OPT_ERR:
opthelp:
            BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
            goto cleanup;
        case OPT_HELP:
            opt_help(fipsinstall_options);
            ret = 0;
            goto end;
        case OPT_IN:
            in_fname = opt_arg();
            break;
        case OPT_OUT:
            out_fname = opt_arg();
            break;
        case OPT_QUIET:
            quiet = 1;
            /* FALLTHROUGH */
        case OPT_NO_LOG:
            self_test_log = 0;
            break;
        case OPT_CORRUPT_DESC:
            self_test_corrupt_desc = opt_arg();
            break;
        case OPT_CORRUPT_TYPE:
            self_test_corrupt_type = opt_arg();
            break;
        case OPT_PROV_NAME:
            prov_name = opt_arg();
            break;
        case OPT_MODULE:
            module_fname = opt_arg();
            break;
        case OPT_SECTION_NAME:
            section_name = opt_arg();
            break;
        case OPT_MAC_NAME:
            mac_name = opt_arg();
            break;
        case OPT_MACOPT:
            if (!sk_OPENSSL_STRING_push(opts, opt_arg()))
                goto opthelp;
            if (strncmp(opt_arg(), "hexkey:", 7) == 0)
                gotkey = 1;
            else if (strncmp(opt_arg(), "digest:", 7) == 0)
                gotdigest = 1;
            break;
        case OPT_VERIFY:
            verify = 1;
            break;
        }
    }
    argc = opt_num_rest();
    if (module_fname == NULL
        || (verify && in_fname == NULL)
        || (!verify && (out_fname == NULL || prov_name == NULL))
        || argc != 0)
        goto opthelp;

    if (self_test_log
            || self_test_corrupt_desc != NULL
            || self_test_corrupt_type != NULL)
        OSSL_SELF_TEST_set_callback(NULL, self_test_events, NULL);

    /* Use the default FIPS HMAC digest and key if not specified. */
    if (!gotdigest && !sk_OPENSSL_STRING_push(opts, "digest:SHA256"))
        goto end;
    /* Use the default FIPS HMAC key if not specified. */
    if (!gotkey && !sk_OPENSSL_STRING_push(opts, "hexkey:" FIPS_KEY_STRING))
        goto end;

    module_bio = bio_open_default(module_fname, 'r', FORMAT_BINARY);
    if (module_bio == NULL) {
        BIO_printf(bio_err, "Failed to open module file\n");
        goto end;
    }

    read_buffer = app_malloc(BUFSIZE, "I/O buffer");
    if (read_buffer == NULL)
        goto end;

    mac = EVP_MAC_fetch(NULL, mac_name, NULL);
    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);
    if (ctx == NULL) {
        BIO_printf(bio_err, "Unable to create MAC CTX for module check\n");
        goto end;
    }

    if (opts != NULL) {
        int ok = 1;
        OSSL_PARAM *params =
            app_params_new_from_opts(opts, EVP_MAC_settable_ctx_params(mac));

        if (params == NULL)
            goto end;

        if (!EVP_MAC_set_ctx_params(ctx, params)) {
            BIO_printf(bio_err, "MAC parameter error\n");
            ERR_print_errors(bio_err);
            ok = 0;
        }
        app_params_free(params);
        if (!ok)
            goto end;
    }

    ctx2 = EVP_MAC_dup_ctx(ctx);
    if (ctx2 == NULL) {
        BIO_printf(bio_err, "Unable to create MAC CTX for install indicator\n");
        goto end;
    }

    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 (!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");
    } else {

        conf = generate_config_and_load(prov_name, section_name, module_mac,
                                        module_mac_len);
        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);
        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))
            goto end;
        if (!quiet)
            BIO_printf(bio_out, "INSTALL PASSED\n");
    }

    ret = 0;
end:
    if (ret == 1) {
        if (!quiet)
            BIO_printf(bio_err, "%s FAILED\n", verify ? "VERIFY" : "INSTALL");
        ERR_print_errors(bio_err);
    }

cleanup:
    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);
    OPENSSL_free(read_buffer);
    free_config_and_unload(conf);
    return ret;
}

static int self_test_events(const OSSL_PARAM params[], void *arg)
{
    const OSSL_PARAM *p = NULL;
    const char *phase = NULL, *type = NULL, *desc = NULL;
    int ret = 0;

    p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
    if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
        goto err;
    phase = (const char *)p->data;

    p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC);
    if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
        goto err;
    desc = (const char *)p->data;

    p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
    if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
        goto err;
    type = (const char *)p->data;

    if (self_test_log) {
        if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0)
            BIO_printf(bio_out, "%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);
    }
    /*
     * The self test code will internally corrupt the KAT test result if an
     * error is returned during the corrupt phase.
     */
    if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0
            && (self_test_corrupt_desc != NULL
                || self_test_corrupt_type != NULL)) {
        if (self_test_corrupt_desc != NULL
                && strcmp(self_test_corrupt_desc, desc) != 0)
            goto end;
        if (self_test_corrupt_type != NULL
                && strcmp(self_test_corrupt_type, type) != 0)
            goto end;
        BIO_printf(bio_out, "%s ", phase);
        goto err;
    }
end:
    ret = 1;
err:
    return ret;
}
Commit	Line	Data
95214b43	1	/*
33388b44	2	* Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
95214b43 SL	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/err.h>
	13	#include <openssl/provider.h>
	14	#include <openssl/params.h>
	15	#include <openssl/fips_names.h>
36fc5fc6 SL	16	#include <openssl/core_names.h>
36fc5fc6 SL	17	#include <openssl/self_test.h>
31214258	18	#include <openssl/fipskey.h>
95214b43 SL	19	#include "apps.h"
	20	#include "progs.h"
	21
852c2ed2 RS	22	DEFINE_STACK_OF_STRING()
852c2ed2 RS	23
95214b43 SL	24	#define BUFSIZE 4096
	25	#define DEFAULT_MAC_NAME "HMAC"
	26	#define DEFAULT_FIPS_SECTION "fips_check_section"
	27
	28	/* Configuration file values */
	29	#define VERSION_KEY "version"
	30	#define VERSION_VAL "1"
	31	#define INSTALL_STATUS_VAL "INSTALL_SELF_TEST_KATS_RUN"
	32
36fc5fc6 SL	33	static OSSL_CALLBACK self_test_events;
	34	static char *self_test_corrupt_desc = NULL;
	35	static char *self_test_corrupt_type = NULL;
	36	static int self_test_log = 1;
1cd2c1f8	37	static int quiet = 0;
36fc5fc6	38
95214b43 SL	39	typedef enum OPTION_choice {
	40	OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
	41	OPT_IN, OPT_OUT, OPT_MODULE,
36fc5fc6	42	OPT_PROV_NAME, OPT_SECTION_NAME, OPT_MAC_NAME, OPT_MACOPT, OPT_VERIFY,
1cd2c1f8	43	OPT_NO_LOG, OPT_CORRUPT_DESC, OPT_CORRUPT_TYPE, OPT_QUIET
95214b43 SL	44	} OPTION_CHOICE;
	45
	46	const OPTIONS fipsinstall_options[] = {
5388f986	47	OPT_SECTION("General"),
95214b43	48	{"help", OPT_HELP, '-', "Display this summary"},
92de469f RS	49	{"verify", OPT_VERIFY, '-',
92de469f RS	50	"Verify a config file instead of generating one"},
95214b43 SL	51	{"module", OPT_MODULE, '<', "File name of the provider module"},
	52	{"provider_name", OPT_PROV_NAME, 's', "FIPS provider name"},
	53	{"section_name", OPT_SECTION_NAME, 's',
	54	"FIPS Provider config section name (optional)"},
5388f986 RS	55
	56	OPT_SECTION("Input"),
	57	{"in", OPT_IN, '<', "Input config file, used when verifying"},
	58
	59	OPT_SECTION("Output"),
	60	{"out", OPT_OUT, '>', "Output config file, used when generating"},
95214b43 SL	61	{"mac_name", OPT_MAC_NAME, 's', "MAC name"},
	62	{"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form. "
	63	"See 'PARAMETER NAMES' in the EVP_MAC_ docs"},
36fc5fc6 SL	64	{"noout", OPT_NO_LOG, '-', "Disable logging of self test events"},
	65	{"corrupt_desc", OPT_CORRUPT_DESC, 's', "Corrupt a self test by description"},
	66	{"corrupt_type", OPT_CORRUPT_TYPE, 's', "Corrupt a self test by type"},
1cd2c1f8	67	{"quiet", OPT_QUIET, '-', "No messages, just exit status"},
95214b43 SL	68	{NULL}
	69	};
	70
	71	static int do_mac(EVP_MAC_CTX ctx, unsigned char tmp, BIO *in,
	72	unsigned char out, size_t out_len)
	73	{
	74	int ret = 0;
	75	int i;
	76	size_t outsz = *out_len;
	77
	78	if (!EVP_MAC_init(ctx))
	79	goto err;
	80	if (EVP_MAC_size(ctx) > outsz)
	81	goto end;
	82	while ((i = BIO_read(in, (char *)tmp, BUFSIZE)) != 0) {
	83	if (i < 0 \|\| !EVP_MAC_update(ctx, tmp, i))
	84	goto err;
	85	}
	86	end:
	87	if (!EVP_MAC_final(ctx, out, out_len, outsz))
	88	goto err;
	89	ret = 1;
	90	err:
	91	return ret;
	92	}
	93
	94	static int load_fips_prov_and_run_self_test(const char *prov_name)
	95	{
	96	int ret = 0;
	97	OSSL_PROVIDER *prov = NULL;
	98
	99	prov = OSSL_PROVIDER_load(NULL, prov_name);
	100	if (prov == NULL) {
	101	BIO_printf(bio_err, "Failed to load FIPS module\n");
	102	goto end;
	103	}
	104	ret = 1;
	105	end:
	106	OSSL_PROVIDER_unload(prov);
	107	return ret;
	108	}
	109
	110	static int print_mac(BIO bio, const char label, const unsigned char *mac,
	111	size_t len)
	112	{
	113	int ret;
	114	char *hexstr = NULL;
	115
	116	hexstr = OPENSSL_buf2hexstr(mac, (long)len);
	117	if (hexstr == NULL)
	118	return 0;
	119	ret = BIO_printf(bio, "%s = %s\n", label, hexstr);
	120	OPENSSL_free(hexstr);
	121	return ret;
	122	}
	123
	124	static int write_config_header(BIO out, const char prov_name,
	125	const char *section)
	126	{
	127	return BIO_printf(out, "openssl_conf = openssl_init\n\n")
	128	&& BIO_printf(out, "[openssl_init]\n")
	129	&& BIO_printf(out, "providers = provider_section\n\n")
	130	&& BIO_printf(out, "[provider_section]\n")
	131	&& BIO_printf(out, "%s = %s\n\n", prov_name, section);
132	}
133
134	/*
135	* Outputs a fips related config file that contains entries for the fips
136	* module checksum and the installation indicator checksum.
137	*
138	* Returns 1 if the config file is written otherwise it returns 0 on error.
139	*/
140	static int write_config_fips_section(BIO out, const char section,
141	unsigned char *module_mac,
142	size_t module_mac_len,
143	unsigned char *install_mac,
144	size_t install_mac_len)
145	{
146	int ret = 0;
147
148	if (!(BIO_printf(out, "[%s]\n", section) > 0
7bb82f92	149	&& BIO_printf(out, "activate = 1\n") > 0
95214b43 SL	150	&& BIO_printf(out, "%s = %s\n", OSSL_PROV_FIPS_PARAM_INSTALL_VERSION,
	151	VERSION_VAL) > 0
	152	&& print_mac(out, OSSL_PROV_FIPS_PARAM_MODULE_MAC, module_mac,
	153	module_mac_len)))
	154	goto end;
	155
	156	if (install_mac != NULL) {
	157	if (!(print_mac(out, OSSL_PROV_FIPS_PARAM_INSTALL_MAC, install_mac,
	158	install_mac_len)
	159	&& BIO_printf(out, "%s = %s\n",
	160	OSSL_PROV_FIPS_PARAM_INSTALL_STATUS,
	161	INSTALL_STATUS_VAL) > 0))
	162	goto end;
	163	}
	164	ret = 1;
	165	end:
	166	return ret;
	167	}
	168
	169	static CONF generate_config_and_load(const char prov_name,
	170	const char *section,
	171	unsigned char *module_mac,
	172	size_t module_mac_len)
	173	{
	174	BIO *mem_bio = NULL;
	175	CONF *conf = NULL;
	176
	177	mem_bio = BIO_new(BIO_s_mem());
	178	if (mem_bio == NULL)
	179	return 0;
	180	if (!write_config_header(mem_bio, prov_name, section)
	181	\|\| !write_config_fips_section(mem_bio, section, module_mac,
	182	module_mac_len, NULL, 0))
	183	goto end;
	184
	185	conf = app_load_config_bio(mem_bio, NULL);
	186	if (conf == NULL)
	187	goto end;
	188
e683582b	189	if (CONF_modules_load(conf, NULL, 0) <= 0)
95214b43 SL	190	goto end;
	191	BIO_free(mem_bio);
	192	return conf;
	193	end:
	194	NCONF_free(conf);
	195	BIO_free(mem_bio);
	196	return NULL;
	197	}
	198
	199	static void free_config_and_unload(CONF *conf)
	200	{
	201	if (conf != NULL) {
	202	NCONF_free(conf);
	203	CONF_modules_unload(1);
	204	}
	205	}
	206
	207	/*
	208	* Returns 1 if the config file entries match the passed in module_mac and
	209	* install_mac values, otherwise it returns 0.
	210	*/
	211	static int verify_config(const char infile, const char section,
	212	unsigned char *module_mac, size_t module_mac_len,
	213	unsigned char *install_mac, size_t install_mac_len)
	214	{
	215	int ret = 0;
	216	char *s = NULL;
	217	unsigned char buf1 = NULL, buf2 = NULL;
	218	long len;
	219	CONF *conf = NULL;
	220
	221	/* read in the existing values and check they match the saved values */
	222	conf = app_load_config(infile);
	223	if (conf == NULL)
	224	goto end;
	225
	226	s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_VERSION);
	227	if (s == NULL \|\| strcmp(s, VERSION_VAL) != 0) {
	228	BIO_printf(bio_err, "version not found\n");
	229	goto end;
	230	}
	231	s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_STATUS);
	232	if (s == NULL \|\| strcmp(s, INSTALL_STATUS_VAL) != 0) {
	233	BIO_printf(bio_err, "install status not found\n");
	234	goto end;
	235	}
	236	s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_MODULE_MAC);
	237	if (s == NULL) {
	238	BIO_printf(bio_err, "Module integrity MAC not found\n");
	239	goto end;
	240	}
	241	buf1 = OPENSSL_hexstr2buf(s, &len);
	242	if (buf1 == NULL
	243	\|\| (size_t)len != module_mac_len
	244	\|\| memcmp(module_mac, buf1, module_mac_len) != 0) {
	245	BIO_printf(bio_err, "Module integrity mismatch\n");
	246	goto end;
	247	}
	248	s = NCONF_get_string(conf, section, OSSL_PROV_FIPS_PARAM_INSTALL_MAC);
	249	if (s == NULL) {
	250	BIO_printf(bio_err, "Install indicator MAC not found\n");
	251	goto end;
	252	}
	253	buf2 = OPENSSL_hexstr2buf(s, &len);
254	if (buf2 == NULL
255	\|\| (size_t)len != install_mac_len
256	\|\| memcmp(install_mac, buf2, install_mac_len) != 0) {
257	BIO_printf(bio_err, "Install indicator status mismatch\n");
258	goto end;
259	}
260	ret = 1;
261	end:
262	OPENSSL_free(buf1);
263	OPENSSL_free(buf2);
264	NCONF_free(conf);
265	return ret;
266	}
267
268	int fipsinstall_main(int argc, char **argv)
269	{
31214258	270	int ret = 1, verify = 0, gotkey = 0, gotdigest = 0;
95214b43 SL	271	BIO module_bio = NULL, mem_bio = NULL, *fout = NULL;
	272	char in_fname = NULL, out_fname = NULL, prog, section_name = NULL;
	273	char prov_name = NULL, module_fname = NULL;
	274	static const char *mac_name = DEFAULT_MAC_NAME;
	275	EVP_MAC_CTX ctx = NULL, ctx2 = NULL;
	276	STACK_OF(OPENSSL_STRING) *opts = NULL;
	277	OPTION_CHOICE o;
	278	unsigned char *read_buffer = NULL;
	279	unsigned char module_mac[EVP_MAX_MD_SIZE];
	280	size_t module_mac_len = EVP_MAX_MD_SIZE;
	281	unsigned char install_mac[EVP_MAX_MD_SIZE];
	282	size_t install_mac_len = EVP_MAX_MD_SIZE;
	283	EVP_MAC *mac = NULL;
	284	CONF *conf = NULL;
	285
	286	section_name = DEFAULT_FIPS_SECTION;
31214258 RS	287	if ((opts = sk_OPENSSL_STRING_new_null()) == NULL)
31214258 RS	288	goto end;
95214b43 SL	289
	290	prog = opt_init(argc, argv, fipsinstall_options);
	291	while ((o = opt_next()) != OPT_EOF) {
	292	switch (o) {
	293	case OPT_EOF:
	294	case OPT_ERR:
	295	opthelp:
	296	BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
1cd2c1f8	297	goto cleanup;
95214b43 SL	298	case OPT_HELP:
	299	opt_help(fipsinstall_options);
	300	ret = 0;
	301	goto end;
	302	case OPT_IN:
	303	in_fname = opt_arg();
	304	break;
	305	case OPT_OUT:
	306	out_fname = opt_arg();
	307	break;
1cd2c1f8 RS	308	case OPT_QUIET:
	309	quiet = 1;
	310	/* FALLTHROUGH */
36fc5fc6 SL	311	case OPT_NO_LOG:
	312	self_test_log = 0;
	313	break;
	314	case OPT_CORRUPT_DESC:
	315	self_test_corrupt_desc = opt_arg();
	316	break;
	317	case OPT_CORRUPT_TYPE:
	318	self_test_corrupt_type = opt_arg();
	319	break;
95214b43 SL	320	case OPT_PROV_NAME:
	321	prov_name = opt_arg();
	322	break;
	323	case OPT_MODULE:
	324	module_fname = opt_arg();
	325	break;
	326	case OPT_SECTION_NAME:
	327	section_name = opt_arg();
	328	break;
	329	case OPT_MAC_NAME:
	330	mac_name = opt_arg();
	331	break;
	332	case OPT_MACOPT:
31214258	333	if (!sk_OPENSSL_STRING_push(opts, opt_arg()))
95214b43	334	goto opthelp;
31214258 RS	335	if (strncmp(opt_arg(), "hexkey:", 7) == 0)
	336	gotkey = 1;
	337	else if (strncmp(opt_arg(), "digest:", 7) == 0)
	338	gotdigest = 1;
95214b43 SL	339	break;
	340	case OPT_VERIFY:
	341	verify = 1;
	342	break;
	343	}
	344	}
	345	argc = opt_num_rest();
	346	if (module_fname == NULL
	347	\|\| (verify && in_fname == NULL)
	348	\|\| (!verify && (out_fname == NULL \|\| prov_name == NULL))
95214b43 SL	349	\|\| argc != 0)
	350	goto opthelp;
	351
36fc5fc6 SL	352	if (self_test_log
	353	\|\| self_test_corrupt_desc != NULL
	354	\|\| self_test_corrupt_type != NULL)
	355	OSSL_SELF_TEST_set_callback(NULL, self_test_events, NULL);
	356
31214258 RS	357	/* Use the default FIPS HMAC digest and key if not specified. */
	358	if (!gotdigest && !sk_OPENSSL_STRING_push(opts, "digest:SHA256"))
	359	goto end;
d3b243d1	360	/* Use the default FIPS HMAC key if not specified. */
31214258 RS	361	if (!gotkey && !sk_OPENSSL_STRING_push(opts, "hexkey:" FIPS_KEY_STRING))
	362	goto end;
	363
95214b43 SL	364	module_bio = bio_open_default(module_fname, 'r', FORMAT_BINARY);
	365	if (module_bio == NULL) {
	366	BIO_printf(bio_err, "Failed to open module file\n");
	367	goto end;
	368	}
	369
	370	read_buffer = app_malloc(BUFSIZE, "I/O buffer");
	371	if (read_buffer == NULL)
	372	goto end;
	373
	374	mac = EVP_MAC_fetch(NULL, mac_name, NULL);
	375	if (mac == NULL) {
	376	BIO_printf(bio_err, "Unable to get MAC of type %s\n", mac_name);
	377	goto end;
	378	}
	379
d9c2fd51	380	ctx = EVP_MAC_new_ctx(mac);
95214b43 SL	381	if (ctx == NULL) {
	382	BIO_printf(bio_err, "Unable to create MAC CTX for module check\n");
	383	goto end;
	384	}
	385
	386	if (opts != NULL) {
	387	int ok = 1;
	388	OSSL_PARAM *params =
41f7ecf3	389	app_params_new_from_opts(opts, EVP_MAC_settable_ctx_params(mac));
95214b43 SL	390
	391	if (params == NULL)
	392	goto end;
	393
d9c2fd51	394	if (!EVP_MAC_set_ctx_params(ctx, params)) {
95214b43 SL	395	BIO_printf(bio_err, "MAC parameter error\n");
	396	ERR_print_errors(bio_err);
	397	ok = 0;
	398	}
	399	app_params_free(params);
	400	if (!ok)
	401	goto end;
	402	}
	403
d9c2fd51	404	ctx2 = EVP_MAC_dup_ctx(ctx);
95214b43 SL	405	if (ctx2 == NULL) {
	406	BIO_printf(bio_err, "Unable to create MAC CTX for install indicator\n");
	407	goto end;
	408	}
	409
	410	if (!do_mac(ctx, read_buffer, module_bio, module_mac, &module_mac_len))
	411	goto end;
	412
	413	mem_bio = BIO_new_mem_buf((const void *)INSTALL_STATUS_VAL,
	414	strlen(INSTALL_STATUS_VAL));
	415	if (mem_bio == NULL) {
	416	BIO_printf(bio_err, "Unable to create memory BIO\n");
	417	goto end;
	418	}
	419	if (!do_mac(ctx2, read_buffer, mem_bio, install_mac, &install_mac_len))
	420	goto end;
	421
	422	if (verify) {
	423	if (!verify_config(in_fname, section_name, module_mac, module_mac_len,
	424	install_mac, install_mac_len))
	425	goto end;
1cd2c1f8 RS	426	if (!quiet)
1cd2c1f8 RS	427	BIO_printf(bio_out, "VERIFY PASSED\n");
95214b43 SL	428	} else {
	429
	430	conf = generate_config_and_load(prov_name, section_name, module_mac,
	431	module_mac_len);
	432	if (conf == NULL)
	433	goto end;
	434	if (!load_fips_prov_and_run_self_test(prov_name))
	435	goto end;
	436
	437	fout = bio_open_default(out_fname, 'w', FORMAT_TEXT);
	438	if (fout == NULL) {
	439	BIO_printf(bio_err, "Failed to open file\n");
	440	goto end;
	441	}
	442	if (!write_config_fips_section(fout, section_name, module_mac,
	443	module_mac_len, install_mac,
	444	install_mac_len))
	445	goto end;
1cd2c1f8 RS	446	if (!quiet)
1cd2c1f8 RS	447	BIO_printf(bio_out, "INSTALL PASSED\n");
95214b43 SL	448	}
	449
	450	ret = 0;
	451	end:
	452	if (ret == 1) {
1cd2c1f8 RS	453	if (!quiet)
1cd2c1f8 RS	454	BIO_printf(bio_err, "%s FAILED\n", verify ? "VERIFY" : "INSTALL");
95214b43 SL	455	ERR_print_errors(bio_err);
	456	}
	457
1cd2c1f8	458	cleanup:
95214b43 SL	459	BIO_free(fout);
	460	BIO_free(mem_bio);
	461	BIO_free(module_bio);
	462	sk_OPENSSL_STRING_free(opts);
	463	EVP_MAC_free(mac);
d9c2fd51 P	464	EVP_MAC_free_ctx(ctx2);
d9c2fd51 P	465	EVP_MAC_free_ctx(ctx);
95214b43 SL	466	OPENSSL_free(read_buffer);
	467	free_config_and_unload(conf);
	468	return ret;
	469	}
36fc5fc6 SL	470
	471	static int self_test_events(const OSSL_PARAM params[], void *arg)
	472	{
	473	const OSSL_PARAM *p = NULL;
	474	const char phase = NULL, type = NULL, *desc = NULL;
	475	int ret = 0;
	476
	477	p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
	478	if (p == NULL \|\| p->data_type != OSSL_PARAM_UTF8_STRING)
	479	goto err;
	480	phase = (const char *)p->data;
	481
	482	p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC);
	483	if (p == NULL \|\| p->data_type != OSSL_PARAM_UTF8_STRING)
	484	goto err;
	485	desc = (const char *)p->data;
	486
	487	p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
	488	if (p == NULL \|\| p->data_type != OSSL_PARAM_UTF8_STRING)
	489	goto err;
	490	type = (const char *)p->data;
	491
	492	if (self_test_log) {
	493	if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0)
	494	BIO_printf(bio_out, "%s : (%s) : ", desc, type);
	495	else if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0
	496	\|\| strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0)
	497	BIO_printf(bio_out, "%s\n", phase);
	498	}
	499	/*
	500	* The self test code will internally corrupt the KAT test result if an
	501	* error is returned during the corrupt phase.
	502	*/
	503	if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0
	504	&& (self_test_corrupt_desc != NULL
	505	\|\| self_test_corrupt_type != NULL)) {
	506	if (self_test_corrupt_desc != NULL
	507	&& strcmp(self_test_corrupt_desc, desc) != 0)
	508	goto end;
	509	if (self_test_corrupt_type != NULL
	510	&& strcmp(self_test_corrupt_type, type) != 0)
	511	goto end;
	512	BIO_printf(bio_out, "%s ", phase);
	513	goto err;
	514	}
	515	end:
	516	ret = 1;
	517	err:
	518	return ret;
	519	}