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>
21 DEFINE_STACK_OF_STRING()
24 #define DEFAULT_MAC_NAME "HMAC"
25 #define DEFAULT_FIPS_SECTION "fips_check_section"
27 /* Configuration file values */
28 #define VERSION_KEY "version"
29 #define VERSION_VAL "1"
30 #define INSTALL_STATUS_VAL "INSTALL_SELF_TEST_KATS_RUN"
32 static OSSL_CALLBACK self_test_events
;
33 static char *self_test_corrupt_desc
= NULL
;
34 static char *self_test_corrupt_type
= NULL
;
35 static int self_test_log
= 1;
38 typedef enum OPTION_choice
{
39 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
,
40 OPT_IN
, OPT_OUT
, OPT_MODULE
,
41 OPT_PROV_NAME
, OPT_SECTION_NAME
, OPT_MAC_NAME
, OPT_MACOPT
, OPT_VERIFY
,
42 OPT_NO_LOG
, OPT_CORRUPT_DESC
, OPT_CORRUPT_TYPE
, OPT_QUIET
45 const OPTIONS fipsinstall_options
[] = {
46 OPT_SECTION("General"),
47 {"help", OPT_HELP
, '-', "Display this summary"},
48 {"verify", OPT_VERIFY
, '-',
49 "Verify a config file instead of generating one"},
50 {"module", OPT_MODULE
, '<', "File name of the provider module"},
51 {"provider_name", OPT_PROV_NAME
, 's', "FIPS provider name"},
52 {"section_name", OPT_SECTION_NAME
, 's',
53 "FIPS Provider config section name (optional)"},
56 {"in", OPT_IN
, '<', "Input config file, used when verifying"},
58 OPT_SECTION("Output"),
59 {"out", OPT_OUT
, '>', "Output config file, used when generating"},
60 {"mac_name", OPT_MAC_NAME
, 's', "MAC name"},
61 {"macopt", OPT_MACOPT
, 's', "MAC algorithm parameters in n:v form. "
62 "See 'PARAMETER NAMES' in the EVP_MAC_ docs"},
63 {"noout", OPT_NO_LOG
, '-', "Disable logging of self test events"},
64 {"corrupt_desc", OPT_CORRUPT_DESC
, 's', "Corrupt a self test by description"},
65 {"corrupt_type", OPT_CORRUPT_TYPE
, 's', "Corrupt a self test by type"},
66 {"quiet", OPT_QUIET
, '-', "No messages, just exit status"},
70 static int do_mac(EVP_MAC_CTX
*ctx
, unsigned char *tmp
, BIO
*in
,
71 unsigned char *out
, size_t *out_len
)
75 size_t outsz
= *out_len
;
77 if (!EVP_MAC_init(ctx
))
79 if (EVP_MAC_size(ctx
) > outsz
)
81 while ((i
= BIO_read(in
, (char *)tmp
, BUFSIZE
)) != 0) {
82 if (i
< 0 || !EVP_MAC_update(ctx
, tmp
, i
))
86 if (!EVP_MAC_final(ctx
, out
, out_len
, outsz
))
93 static int load_fips_prov_and_run_self_test(const char *prov_name
)
96 OSSL_PROVIDER
*prov
= NULL
;
98 prov
= OSSL_PROVIDER_load(NULL
, prov_name
);
100 BIO_printf(bio_err
, "Failed to load FIPS module\n");
105 OSSL_PROVIDER_unload(prov
);
109 static int print_mac(BIO
*bio
, const char *label
, const unsigned char *mac
,
115 hexstr
= OPENSSL_buf2hexstr(mac
, (long)len
);
118 ret
= BIO_printf(bio
, "%s = %s\n", label
, hexstr
);
119 OPENSSL_free(hexstr
);
123 static int write_config_header(BIO
*out
, const char *prov_name
,
126 return BIO_printf(out
, "openssl_conf = openssl_init\n\n")
127 && BIO_printf(out
, "[openssl_init]\n")
128 && BIO_printf(out
, "providers = provider_section\n\n")
129 && BIO_printf(out
, "[provider_section]\n")
130 && BIO_printf(out
, "%s = %s\n\n", prov_name
, section
);
134 * Outputs a fips related config file that contains entries for the fips
135 * module checksum and the installation indicator checksum.
137 * Returns 1 if the config file is written otherwise it returns 0 on error.
139 static int write_config_fips_section(BIO
*out
, const char *section
,
140 unsigned char *module_mac
,
141 size_t module_mac_len
,
142 unsigned char *install_mac
,
143 size_t install_mac_len
)
147 if (!(BIO_printf(out
, "[%s]\n", section
) > 0
148 && BIO_printf(out
, "activate = 1\n") > 0
149 && BIO_printf(out
, "%s = %s\n", OSSL_PROV_FIPS_PARAM_INSTALL_VERSION
,
151 && print_mac(out
, OSSL_PROV_FIPS_PARAM_MODULE_MAC
, module_mac
,
155 if (install_mac
!= NULL
) {
156 if (!(print_mac(out
, OSSL_PROV_FIPS_PARAM_INSTALL_MAC
, install_mac
,
158 && BIO_printf(out
, "%s = %s\n",
159 OSSL_PROV_FIPS_PARAM_INSTALL_STATUS
,
160 INSTALL_STATUS_VAL
) > 0))
168 static CONF
*generate_config_and_load(const char *prov_name
,
170 unsigned char *module_mac
,
171 size_t module_mac_len
)
176 mem_bio
= BIO_new(BIO_s_mem());
179 if (!write_config_header(mem_bio
, prov_name
, section
)
180 || !write_config_fips_section(mem_bio
, section
, module_mac
,
181 module_mac_len
, NULL
, 0))
184 conf
= app_load_config_bio(mem_bio
, NULL
);
188 if (CONF_modules_load(conf
, NULL
, 0) <= 0)
198 static void free_config_and_unload(CONF
*conf
)
202 CONF_modules_unload(1);
207 * Returns 1 if the config file entries match the passed in module_mac and
208 * install_mac values, otherwise it returns 0.
210 static int verify_config(const char *infile
, const char *section
,
211 unsigned char *module_mac
, size_t module_mac_len
,
212 unsigned char *install_mac
, size_t install_mac_len
)
216 unsigned char *buf1
= NULL
, *buf2
= NULL
;
220 /* read in the existing values and check they match the saved values */
221 conf
= app_load_config(infile
);
225 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_INSTALL_VERSION
);
226 if (s
== NULL
|| strcmp(s
, VERSION_VAL
) != 0) {
227 BIO_printf(bio_err
, "version not found\n");
230 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_INSTALL_STATUS
);
231 if (s
== NULL
|| strcmp(s
, INSTALL_STATUS_VAL
) != 0) {
232 BIO_printf(bio_err
, "install status not found\n");
235 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_MODULE_MAC
);
237 BIO_printf(bio_err
, "Module integrity MAC not found\n");
240 buf1
= OPENSSL_hexstr2buf(s
, &len
);
242 || (size_t)len
!= module_mac_len
243 || memcmp(module_mac
, buf1
, module_mac_len
) != 0) {
244 BIO_printf(bio_err
, "Module integrity mismatch\n");
247 s
= NCONF_get_string(conf
, section
, OSSL_PROV_FIPS_PARAM_INSTALL_MAC
);
249 BIO_printf(bio_err
, "Install indicator MAC not found\n");
252 buf2
= OPENSSL_hexstr2buf(s
, &len
);
254 || (size_t)len
!= install_mac_len
255 || memcmp(install_mac
, buf2
, install_mac_len
) != 0) {
256 BIO_printf(bio_err
, "Install indicator status mismatch\n");
267 int fipsinstall_main(int argc
, char **argv
)
269 int ret
= 1, verify
= 0;
270 BIO
*module_bio
= NULL
, *mem_bio
= NULL
, *fout
= NULL
;
271 char *in_fname
= NULL
, *out_fname
= NULL
, *prog
, *section_name
= NULL
;
272 char *prov_name
= NULL
, *module_fname
= NULL
;
273 static const char *mac_name
= DEFAULT_MAC_NAME
;
274 EVP_MAC_CTX
*ctx
= NULL
, *ctx2
= NULL
;
275 STACK_OF(OPENSSL_STRING
) *opts
= NULL
;
277 unsigned char *read_buffer
= NULL
;
278 unsigned char module_mac
[EVP_MAX_MD_SIZE
];
279 size_t module_mac_len
= EVP_MAX_MD_SIZE
;
280 unsigned char install_mac
[EVP_MAX_MD_SIZE
];
281 size_t install_mac_len
= EVP_MAX_MD_SIZE
;
285 section_name
= DEFAULT_FIPS_SECTION
;
287 prog
= opt_init(argc
, argv
, fipsinstall_options
);
288 while ((o
= opt_next()) != OPT_EOF
) {
293 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
296 opt_help(fipsinstall_options
);
300 in_fname
= opt_arg();
303 out_fname
= opt_arg();
311 case OPT_CORRUPT_DESC
:
312 self_test_corrupt_desc
= opt_arg();
314 case OPT_CORRUPT_TYPE
:
315 self_test_corrupt_type
= opt_arg();
318 prov_name
= opt_arg();
321 module_fname
= opt_arg();
323 case OPT_SECTION_NAME
:
324 section_name
= opt_arg();
327 mac_name
= opt_arg();
331 opts
= sk_OPENSSL_STRING_new_null();
332 if (opts
== NULL
|| !sk_OPENSSL_STRING_push(opts
, opt_arg()))
340 argc
= opt_num_rest();
341 if (module_fname
== NULL
342 || (verify
&& in_fname
== NULL
)
343 || (!verify
&& (out_fname
== NULL
|| prov_name
== NULL
))
349 || self_test_corrupt_desc
!= NULL
350 || self_test_corrupt_type
!= NULL
)
351 OSSL_SELF_TEST_set_callback(NULL
, self_test_events
, NULL
);
353 module_bio
= bio_open_default(module_fname
, 'r', FORMAT_BINARY
);
354 if (module_bio
== NULL
) {
355 BIO_printf(bio_err
, "Failed to open module file\n");
359 read_buffer
= app_malloc(BUFSIZE
, "I/O buffer");
360 if (read_buffer
== NULL
)
363 mac
= EVP_MAC_fetch(NULL
, mac_name
, NULL
);
365 BIO_printf(bio_err
, "Unable to get MAC of type %s\n", mac_name
);
369 ctx
= EVP_MAC_new_ctx(mac
);
371 BIO_printf(bio_err
, "Unable to create MAC CTX for module check\n");
378 app_params_new_from_opts(opts
, EVP_MAC_settable_ctx_params(mac
));
383 if (!EVP_MAC_set_ctx_params(ctx
, params
)) {
384 BIO_printf(bio_err
, "MAC parameter error\n");
385 ERR_print_errors(bio_err
);
388 app_params_free(params
);
393 ctx2
= EVP_MAC_dup_ctx(ctx
);
395 BIO_printf(bio_err
, "Unable to create MAC CTX for install indicator\n");
399 if (!do_mac(ctx
, read_buffer
, module_bio
, module_mac
, &module_mac_len
))
402 mem_bio
= BIO_new_mem_buf((const void *)INSTALL_STATUS_VAL
,
403 strlen(INSTALL_STATUS_VAL
));
404 if (mem_bio
== NULL
) {
405 BIO_printf(bio_err
, "Unable to create memory BIO\n");
408 if (!do_mac(ctx2
, read_buffer
, mem_bio
, install_mac
, &install_mac_len
))
412 if (!verify_config(in_fname
, section_name
, module_mac
, module_mac_len
,
413 install_mac
, install_mac_len
))
416 BIO_printf(bio_out
, "VERIFY PASSED\n");
419 conf
= generate_config_and_load(prov_name
, section_name
, module_mac
,
423 if (!load_fips_prov_and_run_self_test(prov_name
))
426 fout
= bio_open_default(out_fname
, 'w', FORMAT_TEXT
);
428 BIO_printf(bio_err
, "Failed to open file\n");
431 if (!write_config_fips_section(fout
, section_name
, module_mac
,
432 module_mac_len
, install_mac
,
436 BIO_printf(bio_out
, "INSTALL PASSED\n");
443 BIO_printf(bio_err
, "%s FAILED\n", verify
? "VERIFY" : "INSTALL");
444 ERR_print_errors(bio_err
);
450 BIO_free(module_bio
);
451 sk_OPENSSL_STRING_free(opts
);
453 EVP_MAC_free_ctx(ctx2
);
454 EVP_MAC_free_ctx(ctx
);
455 OPENSSL_free(read_buffer
);
456 free_config_and_unload(conf
);
460 static int self_test_events(const OSSL_PARAM params
[], void *arg
)
462 const OSSL_PARAM
*p
= NULL
;
463 const char *phase
= NULL
, *type
= NULL
, *desc
= NULL
;
466 p
= OSSL_PARAM_locate_const(params
, OSSL_PROV_PARAM_SELF_TEST_PHASE
);
467 if (p
== NULL
|| p
->data_type
!= OSSL_PARAM_UTF8_STRING
)
469 phase
= (const char *)p
->data
;
471 p
= OSSL_PARAM_locate_const(params
, OSSL_PROV_PARAM_SELF_TEST_DESC
);
472 if (p
== NULL
|| p
->data_type
!= OSSL_PARAM_UTF8_STRING
)
474 desc
= (const char *)p
->data
;
476 p
= OSSL_PARAM_locate_const(params
, OSSL_PROV_PARAM_SELF_TEST_TYPE
);
477 if (p
== NULL
|| p
->data_type
!= OSSL_PARAM_UTF8_STRING
)
479 type
= (const char *)p
->data
;
482 if (strcmp(phase
, OSSL_SELF_TEST_PHASE_START
) == 0)
483 BIO_printf(bio_out
, "%s : (%s) : ", desc
, type
);
484 else if (strcmp(phase
, OSSL_SELF_TEST_PHASE_PASS
) == 0
485 || strcmp(phase
, OSSL_SELF_TEST_PHASE_FAIL
) == 0)
486 BIO_printf(bio_out
, "%s\n", phase
);
489 * The self test code will internally corrupt the KAT test result if an
490 * error is returned during the corrupt phase.
492 if (strcmp(phase
, OSSL_SELF_TEST_PHASE_CORRUPT
) == 0
493 && (self_test_corrupt_desc
!= NULL
494 || self_test_corrupt_type
!= NULL
)) {
495 if (self_test_corrupt_desc
!= NULL
496 && strcmp(self_test_corrupt_desc
, desc
) != 0)
498 if (self_test_corrupt_type
!= NULL
499 && strcmp(self_test_corrupt_type
, type
) != 0)
501 BIO_printf(bio_out
, "%s ", phase
);