2 * Copyright 2019 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
12 #include <openssl/core.h>
13 #include <openssl/core_numbers.h>
14 #include <openssl/core_names.h>
15 #include <openssl/params.h>
16 #include <openssl/err.h>
17 #include <openssl/evp.h>
18 /* TODO(3.0): Needed for dummy_evp_call(). To be removed */
19 #include <openssl/sha.h>
20 #include "internal/cryptlib.h"
21 #include "internal/property.h"
22 #include "internal/evp_int.h"
24 /* Functions provided by the core */
25 static OSSL_core_get_param_types_fn
*c_get_param_types
= NULL
;
26 static OSSL_core_get_params_fn
*c_get_params
= NULL
;
27 static OSSL_core_put_error_fn
*c_put_error
= NULL
;
28 static OSSL_core_add_error_vdata_fn
*c_add_error_vdata
= NULL
;
30 /* Parameters we provide to the core */
31 static const OSSL_ITEM fips_param_types
[] = {
32 { OSSL_PARAM_UTF8_PTR
, OSSL_PROV_PARAM_NAME
},
33 { OSSL_PARAM_UTF8_PTR
, OSSL_PROV_PARAM_VERSION
},
34 { OSSL_PARAM_UTF8_PTR
, OSSL_PROV_PARAM_BUILDINFO
},
38 /* TODO(3.0): To be removed */
39 static int dummy_evp_call(OPENSSL_CTX
*libctx
)
41 EVP_MD_CTX
*ctx
= EVP_MD_CTX_new();
42 EVP_MD
*sha256
= EVP_MD_fetch(libctx
, "SHA256", NULL
);
43 char msg
[] = "Hello World!";
44 const unsigned char exptd
[] = {
45 0x7f, 0x83, 0xb1, 0x65, 0x7f, 0xf1, 0xfc, 0x53, 0xb9, 0x2d, 0xc1, 0x81,
46 0x48, 0xa1, 0xd6, 0x5d, 0xfc, 0x2d, 0x4b, 0x1f, 0xa3, 0xd6, 0x77, 0x28,
47 0x4a, 0xdd, 0xd2, 0x00, 0x12, 0x6d, 0x90, 0x69
49 unsigned int dgstlen
= 0;
50 unsigned char dgst
[SHA256_DIGEST_LENGTH
];
53 if (ctx
== NULL
|| sha256
== NULL
)
56 if (!EVP_DigestInit_ex(ctx
, sha256
, NULL
))
58 if (!EVP_DigestUpdate(ctx
, msg
, sizeof(msg
) - 1))
60 if (!EVP_DigestFinal(ctx
, dgst
, &dgstlen
))
62 if (dgstlen
!= sizeof(exptd
) || memcmp(dgst
, exptd
, sizeof(exptd
)) != 0)
68 EVP_MD_meth_free(sha256
);
72 static const OSSL_ITEM
*fips_get_param_types(const OSSL_PROVIDER
*prov
)
74 return fips_param_types
;
77 static int fips_get_params(const OSSL_PROVIDER
*prov
,
78 const OSSL_PARAM params
[])
82 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_NAME
);
83 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, "OpenSSL FIPS Provider"))
85 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_VERSION
);
86 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_VERSION_STR
))
88 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_BUILDINFO
);
89 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_FULL_VERSION_STR
))
95 extern const OSSL_DISPATCH sha256_functions
[];
97 static const OSSL_ALGORITHM fips_digests
[] = {
98 { "SHA256", "fips=yes", sha256_functions
},
102 static const OSSL_ALGORITHM
*fips_query(OSSL_PROVIDER
*prov
,
107 switch (operation_id
) {
114 /* Functions we provide to the core */
115 static const OSSL_DISPATCH fips_dispatch_table
[] = {
117 * To release our resources we just need to free the OPENSSL_CTX so we just
118 * use OPENSSL_CTX_free directly as our teardown function
120 { OSSL_FUNC_PROVIDER_TEARDOWN
, (void (*)(void))OPENSSL_CTX_free
},
121 { OSSL_FUNC_PROVIDER_GET_PARAM_TYPES
, (void (*)(void))fips_get_param_types
},
122 { OSSL_FUNC_PROVIDER_GET_PARAMS
, (void (*)(void))fips_get_params
},
123 { OSSL_FUNC_PROVIDER_QUERY_OPERATION
, (void (*)(void))fips_query
},
127 /* Functions we provide to ourself */
128 static const OSSL_DISPATCH intern_dispatch_table
[] = {
129 { OSSL_FUNC_PROVIDER_QUERY_OPERATION
, (void (*)(void))fips_query
},
134 int OSSL_provider_init(const OSSL_PROVIDER
*provider
,
135 const OSSL_DISPATCH
*in
,
136 const OSSL_DISPATCH
**out
,
141 for (; in
->function_id
!= 0; in
++) {
142 switch (in
->function_id
) {
143 case OSSL_FUNC_CORE_GET_PARAM_TYPES
:
144 c_get_param_types
= OSSL_get_core_get_param_types(in
);
146 case OSSL_FUNC_CORE_GET_PARAMS
:
147 c_get_params
= OSSL_get_core_get_params(in
);
149 case OSSL_FUNC_CORE_PUT_ERROR
:
150 c_put_error
= OSSL_get_core_put_error(in
);
152 case OSSL_FUNC_CORE_ADD_ERROR_VDATA
:
153 c_add_error_vdata
= OSSL_get_core_add_error_vdata(in
);
155 /* Just ignore anything we don't understand */
161 ctx
= OPENSSL_CTX_new();
166 * TODO(3.0): Remove me. This is just a dummy call to demonstrate making
167 * EVP calls from within the FIPS module.
169 if (!dummy_evp_call(ctx
)) {
170 OPENSSL_CTX_free(ctx
);
174 *out
= fips_dispatch_table
;
180 * The internal init function used when the FIPS module uses EVP to call
181 * another algorithm also in the FIPS module. This is a recursive call that has
182 * been made from within the FIPS module itself. Normally we are responsible for
183 * providing our own provctx value, but in this recursive case it has been
184 * pre-populated for us with the same library context that was used in the EVP
185 * call that initiated this recursive call - so we don't need to do anything
186 * further with that parameter. This only works because we *know* in the core
187 * code that the FIPS module uses a library context for its provctx. This is
188 * not generally true for all providers.
190 OSSL_provider_init_fn fips_intern_provider_init
;
191 int fips_intern_provider_init(const OSSL_PROVIDER
*provider
,
192 const OSSL_DISPATCH
*in
,
193 const OSSL_DISPATCH
**out
,
196 *out
= intern_dispatch_table
;
200 void ERR_put_error(int lib
, int func
, int reason
, const char *file
, int line
)
203 * TODO(3.0): This works for the FIPS module because we're going to be
204 * using lib/func/reason codes that libcrypto already knows about. This
205 * won't work for third party providers that have their own error mechanisms,
206 * so we'll need to come up with something else for them.
208 c_put_error(lib
, func
, reason
, file
, line
);
211 void ERR_add_error_data(int num
, ...)
215 ERR_add_error_vdata(num
, args
);
219 void ERR_add_error_vdata(int num
, va_list args
)
221 c_add_error_vdata(num
, args
);