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/err.h>
13 #include <openssl/provider.h>
14 #include <openssl/params.h>
15 #include <openssl/fips_names.h>
16 #include <openssl/core_names.h>
17 #include <openssl/self_test.h>
18 #include <openssl/fipskey.h>
22 DEFINE_STACK_OF_STRING()
26 /* Configuration file values */
27 #define VERSION_KEY "version"
28 #define VERSION_VAL "1"
29 #define INSTALL_STATUS_VAL "INSTALL_SELF_TEST_KATS_RUN"
31 static OSSL_CALLBACK self_test_events
;
32 static char *self_test_corrupt_desc
= NULL
;
33 static char *self_test_corrupt_type
= NULL
;
34 static int self_test_log
= 1;
37 typedef enum OPTION_choice
{
38 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
,
39 OPT_IN
, OPT_OUT
, OPT_MODULE
,
40 OPT_PROV_NAME
, OPT_SECTION_NAME
, OPT_MAC_NAME
, OPT_MACOPT
, OPT_VERIFY
,
41 OPT_NO_LOG
, OPT_CORRUPT_DESC
, OPT_CORRUPT_TYPE
, OPT_QUIET
44 const OPTIONS fipsinstall_options
[] = {
45 OPT_SECTION("General"),
46 {"help", OPT_HELP
, '-', "Display this summary"},
47 {"verify", OPT_VERIFY
, '-',
48 "Verify a config file instead of generating one"},
49 {"module", OPT_MODULE
, '<', "File name of the provider module"},
50 {"provider_name", OPT_PROV_NAME
, 's', "FIPS provider name"},
51 {"section_name", OPT_SECTION_NAME
, 's',
52 "FIPS Provider config section name (optional)"},
55 {"in", OPT_IN
, '<', "Input config file, used when verifying"},
57 OPT_SECTION("Output"),
58 {"out", OPT_OUT
, '>', "Output config file, used when generating"},
59 {"mac_name", OPT_MAC_NAME
, 's', "MAC name"},
60 {"macopt", OPT_MACOPT
, 's', "MAC algorithm parameters in n:v form. "
61 "See 'PARAMETER NAMES' in the EVP_MAC_ docs"},
62 {"noout", OPT_NO_LOG
, '-', "Disable logging of self test events"},
63 {"corrupt_desc", OPT_CORRUPT_DESC
, 's', "Corrupt a self test by description"},
64 {"corrupt_type", OPT_CORRUPT_TYPE
, 's', "Corrupt a self test by type"},
65 {"quiet", OPT_QUIET
, '-', "No messages, just exit status"},
69 static int do_mac(EVP_MAC_CTX
*ctx
, unsigned char *tmp
, BIO
*in
,
70 unsigned char *out
, size_t *out_len
)
74 size_t outsz
= *out_len
;
76 if (!EVP_MAC_init(ctx
))
78 if (EVP_MAC_size(ctx
) > outsz
)
80 while ((i
= BIO_read(in
, (char *)tmp
, BUFSIZE
)) != 0) {
81 if (i
< 0 || !EVP_MAC_update(ctx
, tmp
, i
))
85 if (!EVP_MAC_final(ctx
, out
, out_len
, outsz
))
92 static int load_fips_prov_and_run_self_test(const char *prov_name
)
95 OSSL_PROVIDER
*prov
= NULL
;
97 prov
= OSSL_PROVIDER_load(NULL
, prov_name
);
99 BIO_printf(bio_err
, "Failed to load FIPS module\n");
104 OSSL_PROVIDER_unload(prov
);
108 static int print_mac(BIO
*bio
, const char *label
, const unsigned char *mac
,
114 hexstr
= OPENSSL_buf2hexstr(mac
, (long)len
);
117 ret
= BIO_printf(bio
, "%s = %s\n", label
, hexstr
);
118 OPENSSL_free(hexstr
);
122 static int write_config_header(BIO
*out
, const char *prov_name
,
125 return BIO_printf(out
, "openssl_conf = openssl_init\n\n")
126 && BIO_printf(out
, "[openssl_init]\n")
127 && BIO_printf(out
, "providers = provider_section\n\n")
128 && BIO_printf(out
, "[provider_section]\n")
129 && BIO_printf(out
, "%s = %s\n\n", prov_name
, section
);
133 * Outputs a fips related config file that contains entries for the fips
134 * module checksum and the installation indicator checksum.
136 * Returns 1 if the config file is written otherwise it returns 0 on error.
138 static int write_config_fips_section(BIO
*out
, const char *section
,
139 unsigned char *module_mac
,
140 size_t module_mac_len
,
141 unsigned char *install_mac
,
142 size_t install_mac_len
)
146 if (!(BIO_printf(out
, "[%s]\n", section
) > 0
147 && BIO_printf(out
, "activate = 1\n") > 0
148 && BIO_printf(out
, "%s = %s\n", OSSL_PROV_FIPS_PARAM_INSTALL_VERSION
,
150 && print_mac(out
, OSSL_PROV_FIPS_PARAM_MODULE_MAC
, module_mac
,
154 if (install_mac
!= NULL
) {
155 if (!(print_mac(out
, OSSL_PROV_FIPS_PARAM_INSTALL_MAC
, install_mac
,
157 && BIO_printf(out
, "%s = %s\n",
158 OSSL_PROV_FIPS_PARAM_INSTALL_STATUS
,
159 INSTALL_STATUS_VAL
) > 0))
167 static CONF
*generate_config_and_load(const char *prov_name
,
169 unsigned char *module_mac
,
170 size_t module_mac_len
)
175 mem_bio
= BIO_new(BIO_s_mem());
178 if (!write_config_header(mem_bio
, prov_name
, section
)
179 || !write_config_fips_section(mem_bio
, section
, module_mac
,
180 module_mac_len
, NULL
, 0))
183 conf
= app_load_config_bio(mem_bio
, NULL
);
187 if (CONF_modules_load(conf
, NULL
, 0) <= 0)
197 static void free_config_and_unload(CONF
*conf
)
201 CONF_modules_unload(1);
206 * Returns 1 if the config file entries match the passed in module_mac and
207 * install_mac values, otherwise it returns 0.
209 static int verify_config(const char *infile
, const char *section
,
210 unsigned char *module_mac
, size_t module_mac_len
,
211 unsigned char *install_mac
, size_t install_mac_len
)
215 unsigned char *buf1
= NULL
, *buf2
= NULL
;
219 /* read in the existing values and check they match the saved values */
220 conf
= app_load_config(infile
);
224 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_INSTALL_VERSION
);
225 if (s
== NULL
|| strcmp(s
, VERSION_VAL
) != 0) {
226 BIO_printf(bio_err
, "version not found\n");
229 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_INSTALL_STATUS
);
230 if (s
== NULL
|| strcmp(s
, INSTALL_STATUS_VAL
) != 0) {
231 BIO_printf(bio_err
, "install status not found\n");
234 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_MODULE_MAC
);
236 BIO_printf(bio_err
, "Module integrity MAC not found\n");
239 buf1
= OPENSSL_hexstr2buf(s
, &len
);
241 || (size_t)len
!= module_mac_len
242 || memcmp(module_mac
, buf1
, module_mac_len
) != 0) {
243 BIO_printf(bio_err
, "Module integrity mismatch\n");
246 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_INSTALL_MAC
);
248 BIO_printf(bio_err
, "Install indicator MAC not found\n");
251 buf2
= OPENSSL_hexstr2buf(s
, &len
);
253 || (size_t)len
!= install_mac_len
254 || memcmp(install_mac
, buf2
, install_mac_len
) != 0) {
255 BIO_printf(bio_err
, "Install indicator status mismatch\n");
266 int fipsinstall_main(int argc
, char **argv
)
268 int ret
= 1, verify
= 0, gotkey
= 0, gotdigest
= 0;
269 const char *section_name
= "fips_sect";
270 const char *mac_name
= "HMAC";
271 const char *prov_name
= "fips";
272 BIO
*module_bio
= NULL
, *mem_bio
= NULL
, *fout
= NULL
;
273 char *in_fname
= NULL
, *out_fname
= NULL
, *prog
;
274 char *module_fname
= NULL
;
275 EVP_MAC_CTX
*ctx
= NULL
, *ctx2
= NULL
;
276 STACK_OF(OPENSSL_STRING
) *opts
= NULL
;
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
;
286 if ((opts
= sk_OPENSSL_STRING_new_null()) == NULL
)
289 prog
= opt_init(argc
, argv
, fipsinstall_options
);
290 while ((o
= opt_next()) != OPT_EOF
) {
295 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
298 opt_help(fipsinstall_options
);
302 in_fname
= opt_arg();
305 out_fname
= opt_arg();
313 case OPT_CORRUPT_DESC
:
314 self_test_corrupt_desc
= opt_arg();
316 case OPT_CORRUPT_TYPE
:
317 self_test_corrupt_type
= opt_arg();
320 prov_name
= opt_arg();
323 module_fname
= opt_arg();
325 case OPT_SECTION_NAME
:
326 section_name
= opt_arg();
329 mac_name
= opt_arg();
332 if (!sk_OPENSSL_STRING_push(opts
, opt_arg()))
334 if (strncmp(opt_arg(), "hexkey:", 7) == 0)
336 else if (strncmp(opt_arg(), "digest:", 7) == 0)
344 argc
= opt_num_rest();
345 if (module_fname
== NULL
346 || (verify
&& in_fname
== NULL
)
347 || (!verify
&& out_fname
== NULL
)
352 || self_test_corrupt_desc
!= NULL
353 || self_test_corrupt_type
!= NULL
)
354 OSSL_SELF_TEST_set_callback(NULL
, self_test_events
, NULL
);
356 /* Use the default FIPS HMAC digest and key if not specified. */
357 if (!gotdigest
&& !sk_OPENSSL_STRING_push(opts
, "digest:SHA256"))
359 if (!gotkey
&& !sk_OPENSSL_STRING_push(opts
, "hexkey:" FIPS_KEY_STRING
))
362 module_bio
= bio_open_default(module_fname
, 'r', FORMAT_BINARY
);
363 if (module_bio
== NULL
) {
364 BIO_printf(bio_err
, "Failed to open module file\n");
368 read_buffer
= app_malloc(BUFSIZE
, "I/O buffer");
369 if (read_buffer
== NULL
)
372 mac
= EVP_MAC_fetch(NULL
, mac_name
, NULL
);
374 BIO_printf(bio_err
, "Unable to get MAC of type %s\n", mac_name
);
378 ctx
= EVP_MAC_CTX_new(mac
);
380 BIO_printf(bio_err
, "Unable to create MAC CTX for module check\n");
387 app_params_new_from_opts(opts
, EVP_MAC_settable_ctx_params(mac
));
392 if (!EVP_MAC_CTX_set_params(ctx
, params
)) {
393 BIO_printf(bio_err
, "MAC parameter error\n");
394 ERR_print_errors(bio_err
);
397 app_params_free(params
);
402 ctx2
= EVP_MAC_CTX_dup(ctx
);
404 BIO_printf(bio_err
, "Unable to create MAC CTX for install indicator\n");
408 if (!do_mac(ctx
, read_buffer
, module_bio
, module_mac
, &module_mac_len
))
411 mem_bio
= BIO_new_mem_buf((const void *)INSTALL_STATUS_VAL
,
412 strlen(INSTALL_STATUS_VAL
));
413 if (mem_bio
== NULL
) {
414 BIO_printf(bio_err
, "Unable to create memory BIO\n");
417 if (!do_mac(ctx2
, read_buffer
, mem_bio
, install_mac
, &install_mac_len
))
421 if (!verify_config(in_fname
, section_name
, module_mac
, module_mac_len
,
422 install_mac
, install_mac_len
))
425 BIO_printf(bio_out
, "VERIFY PASSED\n");
428 conf
= generate_config_and_load(prov_name
, section_name
, module_mac
,
432 if (!load_fips_prov_and_run_self_test(prov_name
))
435 fout
= bio_open_default(out_fname
, 'w', FORMAT_TEXT
);
437 BIO_printf(bio_err
, "Failed to open file\n");
440 if (!write_config_fips_section(fout
, section_name
, module_mac
,
441 module_mac_len
, install_mac
,
445 BIO_printf(bio_out
, "INSTALL PASSED\n");
452 BIO_printf(bio_err
, "%s FAILED\n", verify
? "VERIFY" : "INSTALL");
453 ERR_print_errors(bio_err
);
459 BIO_free(module_bio
);
460 sk_OPENSSL_STRING_free(opts
);
462 EVP_MAC_CTX_free(ctx2
);
463 EVP_MAC_CTX_free(ctx
);
464 OPENSSL_free(read_buffer
);
465 free_config_and_unload(conf
);
469 static int self_test_events(const OSSL_PARAM params
[], void *arg
)
471 const OSSL_PARAM
*p
= NULL
;
472 const char *phase
= NULL
, *type
= NULL
, *desc
= NULL
;
475 p
= OSSL_PARAM_locate_const(params
, OSSL_PROV_PARAM_SELF_TEST_PHASE
);
476 if (p
== NULL
|| p
->data_type
!= OSSL_PARAM_UTF8_STRING
)
478 phase
= (const char *)p
->data
;
480 p
= OSSL_PARAM_locate_const(params
, OSSL_PROV_PARAM_SELF_TEST_DESC
);
481 if (p
== NULL
|| p
->data_type
!= OSSL_PARAM_UTF8_STRING
)
483 desc
= (const char *)p
->data
;
485 p
= OSSL_PARAM_locate_const(params
, OSSL_PROV_PARAM_SELF_TEST_TYPE
);
486 if (p
== NULL
|| p
->data_type
!= OSSL_PARAM_UTF8_STRING
)
488 type
= (const char *)p
->data
;
491 if (strcmp(phase
, OSSL_SELF_TEST_PHASE_START
) == 0)
492 BIO_printf(bio_out
, "%s : (%s) : ", desc
, type
);
493 else if (strcmp(phase
, OSSL_SELF_TEST_PHASE_PASS
) == 0
494 || strcmp(phase
, OSSL_SELF_TEST_PHASE_FAIL
) == 0)
495 BIO_printf(bio_out
, "%s\n", phase
);
498 * The self test code will internally corrupt the KAT test result if an
499 * error is returned during the corrupt phase.
501 if (strcmp(phase
, OSSL_SELF_TEST_PHASE_CORRUPT
) == 0
502 && (self_test_corrupt_desc
!= NULL
503 || self_test_corrupt_type
!= NULL
)) {
504 if (self_test_corrupt_desc
!= NULL
505 && strcmp(self_test_corrupt_desc
, desc
) != 0)
507 if (self_test_corrupt_type
!= NULL
508 && strcmp(self_test_corrupt_type
, type
) != 0)
510 BIO_printf(bio_out
, "%s ", phase
);