1 /* ====================================================================
2 * Copyright (c) 2011 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
16 * 3. All advertising materials mentioning features or use of this
17 * software must display the following acknowledgment:
18 * "This product includes software developed by the OpenSSL Project
19 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22 * endorse or promote products derived from this software without
23 * prior written permission. For written permission, please contact
24 * openssl-core@openssl.org.
26 * 5. Products derived from this software may not be called "OpenSSL"
27 * nor may "OpenSSL" appear in their names without prior written
28 * permission of the OpenSSL Project.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 #include <openssl/opensslconf.h>
54 #error FIPS is disabled.
63 #ifndef OPENSSL_FIPSCANISTER
64 #define OPENSSL_FIPSCAPABLE
74 struct evp_cipher_ctx_st;
81 unsigned long FIPS_module_version(void);
82 const char *FIPS_module_version_text(void);
84 int FIPS_module_mode_set(int onoff);
85 int FIPS_module_mode(void);
86 const void *FIPS_rand_check(void);
87 int FIPS_selftest(void);
88 int FIPS_selftest_failed(void);
89 void FIPS_selftest_check(void);
90 int FIPS_selftest_sha1(void);
91 int FIPS_selftest_aes_ccm(void);
92 int FIPS_selftest_aes_gcm(void);
93 int FIPS_selftest_aes_xts(void);
94 int FIPS_selftest_aes(void);
95 int FIPS_selftest_des(void);
96 int FIPS_selftest_rsa(void);
97 int FIPS_selftest_dsa(void);
98 int FIPS_selftest_ecdsa(void);
99 void FIPS_corrupt_drbg(void);
100 void FIPS_x931_stick(void);
101 void FIPS_drbg_stick(void);
102 int FIPS_selftest_x931(void);
103 int FIPS_selftest_hmac(void);
104 int FIPS_selftest_drbg(void);
105 int FIPS_selftest_cmac(void);
107 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len);
108 int FIPS_check_incore_fingerprint(void);
110 void fips_set_selftest_fail(void);
111 int fips_check_rsa(struct rsa_st *rsa);
112 int fips_check_rsa_prng(struct rsa_st *rsa, int bits);
113 int fips_check_dsa_prng(struct dsa_st *dsa, size_t L, size_t N);
114 int fips_check_ec_prng(struct ec_key_st *ec);
116 void FIPS_set_locking_callbacks(void (*func)(int mode, int type,
117 const char *file,int line),
118 int (*add_cb)(int *pointer, int amount,
119 int type, const char *file, int line));
121 void FIPS_set_error_callbacks(
122 void (*put_cb)(int lib, int func,int reason,const char *file,int line),
123 void (*add_cb)(int num, va_list args) );
125 void FIPS_set_malloc_callbacks(
126 void *(*malloc_cb)(int num, const char *file, int line),
127 void (*free_cb)(void *));
129 void FIPS_get_timevec(unsigned char *buf, unsigned long *pctr);
131 /* POST callback operation value: */
132 /* All tests started */
133 #define FIPS_POST_BEGIN 1
134 /* All tests end: result in id */
135 #define FIPS_POST_END 2
136 /* One individual test started */
137 #define FIPS_POST_STARTED 3
138 /* Individual test success */
139 #define FIPS_POST_SUCCESS 4
140 /* Individual test failure */
141 #define FIPS_POST_FAIL 5
142 /* Induce failure in test if zero return */
143 #define FIPS_POST_CORRUPT 6
146 /* HMAC integrity test */
147 #define FIPS_TEST_INTEGRITY 1
149 #define FIPS_TEST_DIGEST 2
150 /* Symmetric cipher test */
151 #define FIPS_TEST_CIPHER 3
152 /* Public key signature test */
153 #define FIPS_TEST_SIGNATURE 4
155 #define FIPS_TEST_HMAC 5
157 #define FIPS_TEST_CMAC 6
159 #define FIPS_TEST_GCM 7
161 #define FIPS_TEST_CCM 8
163 #define FIPS_TEST_XTS 9
165 #define FIPS_TEST_X931 10
167 #define FIPS_TEST_DRBG 11
168 /* Keygen pairwise consistency test */
169 #define FIPS_TEST_PAIRWISE 12
170 /* Continuous PRNG test */
171 #define FIPS_TEST_CONTINUOUS 13
173 void FIPS_post_set_callback(
174 int (*post_cb)(int op, int id, int subid, void *ex));
176 #define FIPS_ERROR_IGNORED(alg) OpenSSLDie(__FILE__, __LINE__, \
177 alg " previous FIPS forbidden algorithm error ignored");
179 int fips_pkey_signature_test(int id, struct evp_pkey_st *pkey,
180 const unsigned char *tbs, size_t tbslen,
181 const unsigned char *kat, size_t katlen,
182 const struct env_md_st *digest, int pad_mode,
183 const char *fail_str);
185 int fips_cipher_test(int id, struct evp_cipher_ctx_st *ctx,
186 const struct evp_cipher_st *cipher,
187 const unsigned char *key,
188 const unsigned char *iv,
189 const unsigned char *plaintext,
190 const unsigned char *ciphertext,
193 const struct env_md_st *FIPS_get_digestbynid(int nid);
195 struct rsa_st *FIPS_rsa_new(void);
196 void FIPS_rsa_free(struct rsa_st *r);
197 int FIPS_rsa_sign_ctx(struct rsa_st *rsa, struct env_md_ctx_st *ctx,
198 int rsa_pad_mode, int saltlen,
199 const struct env_md_st *mgf1Hash,
200 unsigned char *sigret, unsigned int *siglen);
201 int FIPS_rsa_sign_digest(struct rsa_st *rsa,
202 const unsigned char *md, int md_len,
203 const struct env_md_st *mhash,
204 int rsa_pad_mode, int saltlen,
205 const struct env_md_st *mgf1Hash,
206 unsigned char *sigret, unsigned int *siglen);
207 int FIPS_rsa_verify_ctx(struct rsa_st *rsa, struct env_md_ctx_st *ctx,
208 int rsa_pad_mode, int saltlen,
209 const struct env_md_st *mgf1Hash,
210 const unsigned char *sigbuf, unsigned int siglen);
211 int FIPS_rsa_verify_digest(struct rsa_st *rsa,
212 const unsigned char *dig, int diglen,
213 const struct env_md_st *mhash,
214 int rsa_pad_mode, int saltlen,
215 const struct env_md_st *mgf1Hash,
216 const unsigned char *sigbuf, unsigned int siglen);
218 #ifdef OPENSSL_FIPSCAPABLE
220 int FIPS_digestinit(EVP_MD_CTX *ctx, const EVP_MD *type);
221 int FIPS_digestupdate(EVP_MD_CTX *ctx, const void *data, size_t count);
222 int FIPS_digestfinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size);
223 int FIPS_md_ctx_cleanup(EVP_MD_CTX *ctx);
225 int FIPS_cipherinit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
226 const unsigned char *key, const unsigned char *iv, int enc);
227 int FIPS_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
228 const unsigned char *in, unsigned int inl);
229 int FIPS_cipher_ctx_cleanup(EVP_CIPHER_CTX *c);
231 const EVP_CIPHER *FIPS_evp_aes_128_cbc(void);
232 const EVP_CIPHER *FIPS_evp_aes_128_ccm(void);
233 const EVP_CIPHER *FIPS_evp_aes_128_cfb1(void);
234 const EVP_CIPHER *FIPS_evp_aes_128_cfb128(void);
235 const EVP_CIPHER *FIPS_evp_aes_128_cfb8(void);
236 const EVP_CIPHER *FIPS_evp_aes_128_ctr(void);
237 const EVP_CIPHER *FIPS_evp_aes_128_ecb(void);
238 const EVP_CIPHER *FIPS_evp_aes_128_gcm(void);
239 const EVP_CIPHER *FIPS_evp_aes_128_ofb(void);
240 const EVP_CIPHER *FIPS_evp_aes_128_xts(void);
241 const EVP_CIPHER *FIPS_evp_aes_192_cbc(void);
242 const EVP_CIPHER *FIPS_evp_aes_192_ccm(void);
243 const EVP_CIPHER *FIPS_evp_aes_192_cfb1(void);
244 const EVP_CIPHER *FIPS_evp_aes_192_cfb128(void);
245 const EVP_CIPHER *FIPS_evp_aes_192_cfb8(void);
246 const EVP_CIPHER *FIPS_evp_aes_192_ctr(void);
247 const EVP_CIPHER *FIPS_evp_aes_192_ecb(void);
248 const EVP_CIPHER *FIPS_evp_aes_192_gcm(void);
249 const EVP_CIPHER *FIPS_evp_aes_192_ofb(void);
250 const EVP_CIPHER *FIPS_evp_aes_256_cbc(void);
251 const EVP_CIPHER *FIPS_evp_aes_256_ccm(void);
252 const EVP_CIPHER *FIPS_evp_aes_256_cfb1(void);
253 const EVP_CIPHER *FIPS_evp_aes_256_cfb128(void);
254 const EVP_CIPHER *FIPS_evp_aes_256_cfb8(void);
255 const EVP_CIPHER *FIPS_evp_aes_256_ctr(void);
256 const EVP_CIPHER *FIPS_evp_aes_256_ecb(void);
257 const EVP_CIPHER *FIPS_evp_aes_256_gcm(void);
258 const EVP_CIPHER *FIPS_evp_aes_256_ofb(void);
259 const EVP_CIPHER *FIPS_evp_aes_256_xts(void);
260 const EVP_CIPHER *FIPS_evp_des_ede(void);
261 const EVP_CIPHER *FIPS_evp_des_ede3(void);
262 const EVP_CIPHER *FIPS_evp_des_ede3_cbc(void);
263 const EVP_CIPHER *FIPS_evp_des_ede3_cfb1(void);
264 const EVP_CIPHER *FIPS_evp_des_ede3_cfb64(void);
265 const EVP_CIPHER *FIPS_evp_des_ede3_cfb8(void);
266 const EVP_CIPHER *FIPS_evp_des_ede3_ecb(void);
267 const EVP_CIPHER *FIPS_evp_des_ede3_ofb(void);
268 const EVP_CIPHER *FIPS_evp_des_ede_cbc(void);
269 const EVP_CIPHER *FIPS_evp_des_ede_cfb64(void);
270 const EVP_CIPHER *FIPS_evp_des_ede_ecb(void);
271 const EVP_CIPHER *FIPS_evp_des_ede_ofb(void);
272 const EVP_CIPHER *FIPS_evp_enc_null(void);
273 const EVP_MD *FIPS_evp_sha1(void);
274 const EVP_MD *FIPS_evp_sha224(void);
275 const EVP_MD *FIPS_evp_sha256(void);
276 const EVP_MD *FIPS_evp_sha384(void);
277 const EVP_MD *FIPS_evp_sha512(void);
278 const EVP_MD *FIPS_evp_dss1(void);
279 const EVP_MD *FIPS_evp_dss(void);
280 const EVP_MD *FIPS_evp_ecdsa(void);
282 const RSA_METHOD *FIPS_rsa_pkcs1_ssleay(void);
283 int FIPS_rsa_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
285 const struct dsa_method *FIPS_dsa_openssl(void);
286 int FIPS_dsa_generate_key(DSA *dsa);
287 int FIPS_dsa_generate_parameters_ex(DSA *dsa, int bits,
288 const unsigned char *seed,int seed_len,
289 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
291 int fips_dsa_builtin_paramgen2(DSA *ret, size_t L, size_t N,
292 const EVP_MD *evpmd, const unsigned char *seed_in, size_t seed_len,
293 unsigned char *seed_out,
294 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
296 const struct ec_method_st *fips_ec_gf2m_simple_method(void);
297 const struct ec_method_st *fips_ec_gfp_simple_method(void);
298 const struct ec_method_st *fips_ec_gfp_mont_method(void);
299 const struct ec_method_st *fips_ec_gfp_nist_method(void);
301 const struct ecdsa_method *FIPS_ecdsa_openssl(void);
302 const struct ecdh_method *FIPS_ecdh_openssl(void);
304 int FIPS_ec_key_generate_key(struct ec_key_st *key);
306 const struct dh_method *FIPS_dh_openssl(void);
307 int FIPS_dh_generate_parameters_ex(DH *dh, int prime_len,
308 int generator, BN_GENCB *cb);
310 int FIPS_cmac_init(struct CMAC_CTX_st *ctx, const void *key, size_t keylen,
311 const EVP_CIPHER *cipher, ENGINE *impl);
312 int FIPS_cmac_update(struct CMAC_CTX_st *ctx, const void *in, size_t dlen);
313 int FIPS_cmac_final(struct CMAC_CTX_st *ctx, unsigned char *out,
315 void FIPS_cmac_ctx_cleanup(struct CMAC_CTX_st *ctx);
317 void FIPS_hmac_ctx_cleanup(struct hmac_ctx_st *ctx);
318 int FIPS_hmac_init_ex(struct hmac_ctx_st *ctx, const void *key, int len,
319 const EVP_MD *md, ENGINE *impl);
320 int FIPS_hmac_update(struct hmac_ctx_st *ctx,
321 const unsigned char *data, size_t len);
322 int FIPS_hmac_final(struct hmac_ctx_st *ctx,
323 unsigned char *md, unsigned int *len);
327 /* BEGIN ERROR CODES */
328 /* The following lines are auto generated by the script mkerr.pl. Any changes
329 * made after this point may be overwritten when the script is next run.
331 void ERR_load_FIPS_strings(void);
333 /* Error codes for the FIPS functions. */
335 /* Function codes. */
336 #define FIPS_F_DH_BUILTIN_GENPARAMS 100
337 #define FIPS_F_DH_INIT 148
338 #define FIPS_F_DSA_BUILTIN_PARAMGEN 101
339 #define FIPS_F_DSA_BUILTIN_PARAMGEN2 102
340 #define FIPS_F_DSA_DO_SIGN 103
341 #define FIPS_F_DSA_DO_VERIFY 104
342 #define FIPS_F_FIPS_CHECK_DSA 105
343 #define FIPS_F_FIPS_CHECK_DSA_PRNG 151
344 #define FIPS_F_FIPS_CHECK_EC 106
345 #define FIPS_F_FIPS_CHECK_EC_PRNG 152
346 #define FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT 107
347 #define FIPS_F_FIPS_CHECK_RSA 108
348 #define FIPS_F_FIPS_CHECK_RSA_PRNG 150
349 #define FIPS_F_FIPS_CIPHER 160
350 #define FIPS_F_FIPS_CIPHERINIT 109
351 #define FIPS_F_FIPS_CIPHER_CTX_CTRL 161
352 #define FIPS_F_FIPS_DIGESTFINAL 158
353 #define FIPS_F_FIPS_DIGESTINIT 110
354 #define FIPS_F_FIPS_DIGESTUPDATE 159
355 #define FIPS_F_FIPS_DRBG_BYTES 111
356 #define FIPS_F_FIPS_DRBG_CHECK 146
357 #define FIPS_F_FIPS_DRBG_CPRNG_TEST 112
358 #define FIPS_F_FIPS_DRBG_GENERATE 113
359 #define FIPS_F_FIPS_DRBG_HEALTH_CHECK 114
360 #define FIPS_F_FIPS_DRBG_INIT 115
361 #define FIPS_F_FIPS_DRBG_INSTANTIATE 116
362 #define FIPS_F_FIPS_DRBG_NEW 117
363 #define FIPS_F_FIPS_DRBG_RESEED 118
364 #define FIPS_F_FIPS_DRBG_SINGLE_KAT 119
365 #define FIPS_F_FIPS_DSA_SIGN_DIGEST 154
366 #define FIPS_F_FIPS_DSA_VERIFY_DIGEST 155
367 #define FIPS_F_FIPS_GET_ENTROPY 147
368 #define FIPS_F_FIPS_MODULE_MODE_SET 120
369 #define FIPS_F_FIPS_PKEY_SIGNATURE_TEST 121
370 #define FIPS_F_FIPS_RAND_ADD 122
371 #define FIPS_F_FIPS_RAND_BYTES 123
372 #define FIPS_F_FIPS_RAND_PSEUDO_BYTES 124
373 #define FIPS_F_FIPS_RAND_SEED 125
374 #define FIPS_F_FIPS_RAND_SET_METHOD 126
375 #define FIPS_F_FIPS_RAND_STATUS 127
376 #define FIPS_F_FIPS_RSA_SIGN_DIGEST 156
377 #define FIPS_F_FIPS_RSA_VERIFY_DIGEST 157
378 #define FIPS_F_FIPS_SELFTEST_AES 128
379 #define FIPS_F_FIPS_SELFTEST_AES_CCM 145
380 #define FIPS_F_FIPS_SELFTEST_AES_GCM 129
381 #define FIPS_F_FIPS_SELFTEST_AES_XTS 144
382 #define FIPS_F_FIPS_SELFTEST_CMAC 130
383 #define FIPS_F_FIPS_SELFTEST_DES 131
384 #define FIPS_F_FIPS_SELFTEST_DSA 132
385 #define FIPS_F_FIPS_SELFTEST_ECDSA 133
386 #define FIPS_F_FIPS_SELFTEST_HMAC 134
387 #define FIPS_F_FIPS_SELFTEST_SHA1 135
388 #define FIPS_F_FIPS_SELFTEST_X931 136
389 #define FIPS_F_FIPS_SET_PRNG_KEY 153
390 #define FIPS_F_HASH_FINAL 137
391 #define FIPS_F_RSA_BUILTIN_KEYGEN 138
392 #define FIPS_F_RSA_EAY_INIT 149
393 #define FIPS_F_RSA_EAY_PRIVATE_DECRYPT 139
394 #define FIPS_F_RSA_EAY_PRIVATE_ENCRYPT 140
395 #define FIPS_F_RSA_EAY_PUBLIC_DECRYPT 141
396 #define FIPS_F_RSA_EAY_PUBLIC_ENCRYPT 142
397 #define FIPS_F_RSA_X931_GENERATE_KEY_EX 143
400 #define FIPS_R_ADDITIONAL_INPUT_TOO_LONG 100
401 #define FIPS_R_ALREADY_INSTANTIATED 101
402 #define FIPS_R_CONTRADICTING_EVIDENCE 102
403 #define FIPS_R_DRBG_STUCK 103
404 #define FIPS_R_ENTROPY_ERROR_UNDETECTED 104
405 #define FIPS_R_ENTROPY_NOT_REQUESTED_FOR_RESEED 105
406 #define FIPS_R_ENTROPY_SOURCE_STUCK 142
407 #define FIPS_R_ERROR_INITIALISING_DRBG 106
408 #define FIPS_R_ERROR_INSTANTIATING_DRBG 107
409 #define FIPS_R_ERROR_RETRIEVING_ADDITIONAL_INPUT 108
410 #define FIPS_R_ERROR_RETRIEVING_ENTROPY 109
411 #define FIPS_R_ERROR_RETRIEVING_NONCE 110
412 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH 111
413 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED 112
414 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING 113
415 #define FIPS_R_FIPS_MODE_ALREADY_SET 114
416 #define FIPS_R_FIPS_SELFTEST_FAILED 115
417 #define FIPS_R_FUNCTION_ERROR 116
418 #define FIPS_R_GENERATE_ERROR 117
419 #define FIPS_R_GENERATE_ERROR_UNDETECTED 118
420 #define FIPS_R_INSTANTIATE_ERROR 119
421 #define FIPS_R_INSUFFICIENT_SECURITY_STRENGTH 120
422 #define FIPS_R_INTERNAL_ERROR 121
423 #define FIPS_R_INVALID_KEY_LENGTH 122
424 #define FIPS_R_INVALID_PARAMETERS 144
425 #define FIPS_R_IN_ERROR_STATE 123
426 #define FIPS_R_KEY_TOO_SHORT 124
427 #define FIPS_R_NON_FIPS_METHOD 125
428 #define FIPS_R_NOT_INSTANTIATED 126
429 #define FIPS_R_PAIRWISE_TEST_FAILED 127
430 #define FIPS_R_PERSONALISATION_ERROR_UNDETECTED 128
431 #define FIPS_R_PERSONALISATION_STRING_TOO_LONG 129
432 #define FIPS_R_PRNG_STRENGTH_TOO_LOW 143
433 #define FIPS_R_REQUEST_LENGTH_ERROR_UNDETECTED 130
434 #define FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG 131
435 #define FIPS_R_RESEED_COUNTER_ERROR 132
436 #define FIPS_R_RESEED_ERROR 133
437 #define FIPS_R_SELFTEST_FAILED 134
438 #define FIPS_R_SELFTEST_FAILURE 135
439 #define FIPS_R_STRENGTH_ERROR_UNDETECTED 136
440 #define FIPS_R_TEST_FAILURE 137
441 #define FIPS_R_UNINSTANTIATE_ERROR 141
442 #define FIPS_R_UNINSTANTIATE_ZEROISE_ERROR 138
443 #define FIPS_R_UNSUPPORTED_DRBG_TYPE 139
444 #define FIPS_R_UNSUPPORTED_PLATFORM 140