xref: /freebsd/crypto/openssl/include/openssl/fips_names.h (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery /*
2*b077aed3SPierre Pronchery  * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
3*b077aed3SPierre Pronchery  *
4*b077aed3SPierre Pronchery  * Licensed under the Apache License 2.0 (the "License").  You may not use
5*b077aed3SPierre Pronchery  * this file except in compliance with the License.  You can obtain a copy
6*b077aed3SPierre Pronchery  * in the file LICENSE in the source distribution or at
7*b077aed3SPierre Pronchery  * https://www.openssl.org/source/license.html
8*b077aed3SPierre Pronchery  */
9*b077aed3SPierre Pronchery 
10*b077aed3SPierre Pronchery #ifndef OPENSSL_FIPS_NAMES_H
11*b077aed3SPierre Pronchery # define OPENSSL_FIPS_NAMES_H
12*b077aed3SPierre Pronchery # pragma once
13*b077aed3SPierre Pronchery 
14*b077aed3SPierre Pronchery # ifdef __cplusplus
15*b077aed3SPierre Pronchery extern "C" {
16*b077aed3SPierre Pronchery # endif
17*b077aed3SPierre Pronchery 
18*b077aed3SPierre Pronchery /*
19*b077aed3SPierre Pronchery  * Parameter names that the FIPS Provider defines
20*b077aed3SPierre Pronchery  */
21*b077aed3SPierre Pronchery 
22*b077aed3SPierre Pronchery /*
23*b077aed3SPierre Pronchery  * The calculated MAC of the module file (Used for FIPS Self Testing)
24*b077aed3SPierre Pronchery  * Type: OSSL_PARAM_UTF8_STRING
25*b077aed3SPierre Pronchery  */
26*b077aed3SPierre Pronchery # define OSSL_PROV_FIPS_PARAM_MODULE_MAC      "module-mac"
27*b077aed3SPierre Pronchery /*
28*b077aed3SPierre Pronchery  * A version number for the fips install process (Used for FIPS Self Testing)
29*b077aed3SPierre Pronchery  * Type: OSSL_PARAM_UTF8_STRING
30*b077aed3SPierre Pronchery  */
31*b077aed3SPierre Pronchery # define OSSL_PROV_FIPS_PARAM_INSTALL_VERSION "install-version"
32*b077aed3SPierre Pronchery /*
33*b077aed3SPierre Pronchery  * The calculated MAC of the install status indicator (Used for FIPS Self Testing)
34*b077aed3SPierre Pronchery  * Type: OSSL_PARAM_UTF8_STRING
35*b077aed3SPierre Pronchery  */
36*b077aed3SPierre Pronchery # define OSSL_PROV_FIPS_PARAM_INSTALL_MAC     "install-mac"
37*b077aed3SPierre Pronchery /*
38*b077aed3SPierre Pronchery  * The install status indicator (Used for FIPS Self Testing)
39*b077aed3SPierre Pronchery  * Type: OSSL_PARAM_UTF8_STRING
40*b077aed3SPierre Pronchery  */
41*b077aed3SPierre Pronchery # define OSSL_PROV_FIPS_PARAM_INSTALL_STATUS  "install-status"
42*b077aed3SPierre Pronchery 
43*b077aed3SPierre Pronchery /*
44*b077aed3SPierre Pronchery  * A boolean that determines if the FIPS conditional test errors result in
45*b077aed3SPierre Pronchery  * the module entering an error state.
46*b077aed3SPierre Pronchery  * Type: OSSL_PARAM_UTF8_STRING
47*b077aed3SPierre Pronchery  */
48*b077aed3SPierre Pronchery # define OSSL_PROV_FIPS_PARAM_CONDITIONAL_ERRORS "conditional-errors"
49*b077aed3SPierre Pronchery 
50*b077aed3SPierre Pronchery /*
51*b077aed3SPierre Pronchery  * A boolean that determines if the runtime FIPS security checks are performed.
52*b077aed3SPierre Pronchery  * Type: OSSL_PARAM_UTF8_STRING
53*b077aed3SPierre Pronchery  */
54*b077aed3SPierre Pronchery # define OSSL_PROV_FIPS_PARAM_SECURITY_CHECKS "security-checks"
55*b077aed3SPierre Pronchery 
56*b077aed3SPierre Pronchery # ifdef __cplusplus
57*b077aed3SPierre Pronchery }
58*b077aed3SPierre Pronchery # endif
59*b077aed3SPierre Pronchery 
60*b077aed3SPierre Pronchery #endif /* OPENSSL_FIPS_NAMES_H */
61