xref: /freebsd/crypto/openssl/include/openssl/fips_names.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*
2  * Copyright 2019-2021 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 #ifndef OPENSSL_FIPS_NAMES_H
11 # define OPENSSL_FIPS_NAMES_H
12 # pragma once
13 
14 # ifdef __cplusplus
15 extern "C" {
16 # endif
17 
18 /*
19  * Parameter names that the FIPS Provider defines
20  */
21 
22 /*
23  * The calculated MAC of the module file (Used for FIPS Self Testing)
24  * Type: OSSL_PARAM_UTF8_STRING
25  */
26 # define OSSL_PROV_FIPS_PARAM_MODULE_MAC      "module-mac"
27 /*
28  * A version number for the fips install process (Used for FIPS Self Testing)
29  * Type: OSSL_PARAM_UTF8_STRING
30  */
31 # define OSSL_PROV_FIPS_PARAM_INSTALL_VERSION "install-version"
32 /*
33  * The calculated MAC of the install status indicator (Used for FIPS Self Testing)
34  * Type: OSSL_PARAM_UTF8_STRING
35  */
36 # define OSSL_PROV_FIPS_PARAM_INSTALL_MAC     "install-mac"
37 /*
38  * The install status indicator (Used for FIPS Self Testing)
39  * Type: OSSL_PARAM_UTF8_STRING
40  */
41 # define OSSL_PROV_FIPS_PARAM_INSTALL_STATUS  "install-status"
42 
43 /*
44  * A boolean that determines if the FIPS conditional test errors result in
45  * the module entering an error state.
46  * Type: OSSL_PARAM_UTF8_STRING
47  */
48 # define OSSL_PROV_FIPS_PARAM_CONDITIONAL_ERRORS "conditional-errors"
49 
50 /*
51  * A boolean that determines if the runtime FIPS security checks are performed.
52  * Type: OSSL_PARAM_UTF8_STRING
53  */
54 # define OSSL_PROV_FIPS_PARAM_SECURITY_CHECKS "security-checks"
55 
56 # ifdef __cplusplus
57 }
58 # endif
59 
60 #endif /* OPENSSL_FIPS_NAMES_H */
61