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>
53 #error FIPS is disabled.
69 struct evp_cipher_ctx_st;
71 int FIPS_module_mode_set(int onoff);
72 int FIPS_module_mode(void);
73 const void *FIPS_rand_check(void);
74 int FIPS_selftest(void);
75 int FIPS_selftest_failed(void);
76 void FIPS_selftest_check(void);
77 int FIPS_selftest_sha1(void);
78 int FIPS_selftest_aes_ccm(void);
79 int FIPS_selftest_aes_gcm(void);
80 int FIPS_selftest_aes_xts(void);
81 int FIPS_selftest_aes(void);
82 int FIPS_selftest_des(void);
83 int FIPS_selftest_rsa(void);
84 int FIPS_selftest_dsa(void);
85 int FIPS_selftest_ecdsa(void);
86 void FIPS_corrupt_drbg(void);
87 void FIPS_x931_stick(void);
88 void FIPS_drbg_stick(void);
89 int FIPS_selftest_x931(void);
90 int FIPS_selftest_hmac(void);
91 int FIPS_selftest_drbg(void);
92 int FIPS_selftest_cmac(void);
94 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len);
95 int FIPS_check_incore_fingerprint(void);
97 void fips_set_selftest_fail(void);
98 int fips_check_rsa(struct rsa_st *rsa);
99 int fips_check_rsa_prng(struct rsa_st *rsa, int bits);
100 int fips_check_dsa_prng(struct dsa_st *dsa, size_t L, size_t N);
101 int fips_check_ec_prng(struct ec_key_st *ec);
103 void FIPS_set_locking_callbacks(void (*func)(int mode, int type,
104 const char *file,int line),
105 int (*add_cb)(int *pointer, int amount,
106 int type, const char *file, int line));
108 void FIPS_set_malloc_callbacks(
109 void *(*malloc_cb)(int num, const char *file, int line),
110 void (*free_cb)(void *));
112 void FIPS_get_timevec(unsigned char *buf, unsigned long *pctr);
114 /* POST callback operation value: */
115 /* All tests started */
116 #define FIPS_POST_BEGIN 1
117 /* All tests end: result in id */
118 #define FIPS_POST_END 2
119 /* One individual test started */
120 #define FIPS_POST_STARTED 3
121 /* Individual test success */
122 #define FIPS_POST_SUCCESS 4
123 /* Individual test failure */
124 #define FIPS_POST_FAIL 5
125 /* Induce failure in test if zero return */
126 #define FIPS_POST_CORRUPT 6
129 /* HMAC integrity test */
130 #define FIPS_TEST_INTEGRITY 1
132 #define FIPS_TEST_DIGEST 2
133 /* Symmetric cipher test */
134 #define FIPS_TEST_CIPHER 3
135 /* Public key signature test */
136 #define FIPS_TEST_SIGNATURE 4
138 #define FIPS_TEST_HMAC 5
140 #define FIPS_TEST_CMAC 6
142 #define FIPS_TEST_GCM 7
144 #define FIPS_TEST_CCM 8
146 #define FIPS_TEST_XTS 9
148 #define FIPS_TEST_X931 10
150 #define FIPS_TEST_DRBG 11
151 /* Keygen pairwise consistency test */
152 #define FIPS_TEST_PAIRWISE 12
153 /* Continuous PRNG test */
154 #define FIPS_TEST_CONTINUOUS 13
156 void FIPS_post_set_callback(
157 int (*post_cb)(int op, int id, int subid, void *ex));
159 #define FIPS_ERROR_IGNORED(alg) OpenSSLDie(__FILE__, __LINE__, \
160 alg " previous FIPS forbidden algorithm error ignored");
162 int fips_pkey_signature_test(int id, struct evp_pkey_st *pkey,
163 const unsigned char *tbs, size_t tbslen,
164 const unsigned char *kat, size_t katlen,
165 const struct env_md_st *digest, int pad_mode,
166 const char *fail_str);
168 int fips_cipher_test(int id, struct evp_cipher_ctx_st *ctx,
169 const struct evp_cipher_st *cipher,
170 const unsigned char *key,
171 const unsigned char *iv,
172 const unsigned char *plaintext,
173 const unsigned char *ciphertext,
176 const struct env_md_st *FIPS_get_digestbynid(int nid);
178 struct rsa_st *FIPS_rsa_new(void);
179 void FIPS_rsa_free(struct rsa_st *r);
180 int FIPS_rsa_sign_ctx(struct rsa_st *rsa, struct env_md_ctx_st *ctx,
181 int rsa_pad_mode, int saltlen,
182 const struct env_md_st *mgf1Hash,
183 unsigned char *sigret, unsigned int *siglen);
184 int FIPS_rsa_sign_digest(struct rsa_st *rsa,
185 const unsigned char *md, int md_len,
186 const struct env_md_st *mhash,
187 int rsa_pad_mode, int saltlen,
188 const struct env_md_st *mgf1Hash,
189 unsigned char *sigret, unsigned int *siglen);
190 int FIPS_rsa_verify_ctx(struct rsa_st *rsa, struct env_md_ctx_st *ctx,
191 int rsa_pad_mode, int saltlen,
192 const struct env_md_st *mgf1Hash,
193 const unsigned char *sigbuf, unsigned int siglen);
194 int FIPS_rsa_verify_digest(struct rsa_st *rsa,
195 const unsigned char *dig, int diglen,
196 const struct env_md_st *mhash,
197 int rsa_pad_mode, int saltlen,
198 const struct env_md_st *mgf1Hash,
199 const unsigned char *sigbuf, unsigned int siglen);
201 #ifndef OPENSSL_FIPSCANISTER
203 int FIPS_digestinit(EVP_MD_CTX *ctx, const EVP_MD *type);
204 int FIPS_digestupdate(EVP_MD_CTX *ctx, const void *data, size_t count);
205 int FIPS_digestfinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size);
206 int FIPS_md_ctx_cleanup(EVP_MD_CTX *ctx);
208 int FIPS_cipherinit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
209 const unsigned char *key, const unsigned char *iv, int enc);
210 int FIPS_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
211 const unsigned char *in, unsigned int inl);
212 int FIPS_cipher_ctx_cleanup(EVP_CIPHER_CTX *c);
214 const EVP_CIPHER *FIPS_evp_aes_128_cbc(void);
215 const EVP_CIPHER *FIPS_evp_aes_128_ccm(void);
216 const EVP_CIPHER *FIPS_evp_aes_128_cfb1(void);
217 const EVP_CIPHER *FIPS_evp_aes_128_cfb128(void);
218 const EVP_CIPHER *FIPS_evp_aes_128_cfb8(void);
219 const EVP_CIPHER *FIPS_evp_aes_128_ctr(void);
220 const EVP_CIPHER *FIPS_evp_aes_128_ecb(void);
221 const EVP_CIPHER *FIPS_evp_aes_128_gcm(void);
222 const EVP_CIPHER *FIPS_evp_aes_128_ofb(void);
223 const EVP_CIPHER *FIPS_evp_aes_128_xts(void);
224 const EVP_CIPHER *FIPS_evp_aes_192_cbc(void);
225 const EVP_CIPHER *FIPS_evp_aes_192_ccm(void);
226 const EVP_CIPHER *FIPS_evp_aes_192_cfb1(void);
227 const EVP_CIPHER *FIPS_evp_aes_192_cfb128(void);
228 const EVP_CIPHER *FIPS_evp_aes_192_cfb8(void);
229 const EVP_CIPHER *FIPS_evp_aes_192_ctr(void);
230 const EVP_CIPHER *FIPS_evp_aes_192_ecb(void);
231 const EVP_CIPHER *FIPS_evp_aes_192_gcm(void);
232 const EVP_CIPHER *FIPS_evp_aes_192_ofb(void);
233 const EVP_CIPHER *FIPS_evp_aes_256_cbc(void);
234 const EVP_CIPHER *FIPS_evp_aes_256_ccm(void);
235 const EVP_CIPHER *FIPS_evp_aes_256_cfb1(void);
236 const EVP_CIPHER *FIPS_evp_aes_256_cfb128(void);
237 const EVP_CIPHER *FIPS_evp_aes_256_cfb8(void);
238 const EVP_CIPHER *FIPS_evp_aes_256_ctr(void);
239 const EVP_CIPHER *FIPS_evp_aes_256_ecb(void);
240 const EVP_CIPHER *FIPS_evp_aes_256_gcm(void);
241 const EVP_CIPHER *FIPS_evp_aes_256_ofb(void);
242 const EVP_CIPHER *FIPS_evp_aes_256_xts(void);
243 const EVP_CIPHER *FIPS_evp_des_ede(void);
244 const EVP_CIPHER *FIPS_evp_des_ede3(void);
245 const EVP_CIPHER *FIPS_evp_des_ede3_cbc(void);
246 const EVP_CIPHER *FIPS_evp_des_ede3_cfb1(void);
247 const EVP_CIPHER *FIPS_evp_des_ede3_cfb64(void);
248 const EVP_CIPHER *FIPS_evp_des_ede3_cfb8(void);
249 const EVP_CIPHER *FIPS_evp_des_ede3_ecb(void);
250 const EVP_CIPHER *FIPS_evp_des_ede3_ofb(void);
251 const EVP_CIPHER *FIPS_evp_des_ede_cbc(void);
252 const EVP_CIPHER *FIPS_evp_des_ede_cfb64(void);
253 const EVP_CIPHER *FIPS_evp_des_ede_ecb(void);
254 const EVP_CIPHER *FIPS_evp_des_ede_ofb(void);
255 const EVP_MD *FIPS_evp_sha1(void);
256 const EVP_MD *FIPS_evp_sha224(void);
257 const EVP_MD *FIPS_evp_sha256(void);
258 const EVP_MD *FIPS_evp_sha384(void);
259 const EVP_MD *FIPS_evp_sha512(void);
260 const EVP_MD *FIPS_evp_dss1(void);
261 const EVP_MD *FIPS_evp_dss(void);
262 const EVP_MD *FIPS_evp_ecdsa(void);
264 const RSA_METHOD *FIPS_rsa_pkcs1_ssleay(void);
268 /* Where necessary redirect standard OpenSSL APIs to FIPS versions */
270 #if defined(OPENSSL_FIPSCANISTER) && defined(OPENSSL_FIPSAPI)
272 #define CRYPTO_lock FIPS_lock
273 #define CRYPTO_add_lock FIPS_add_lock
274 #define CRYPTO_malloc FIPS_malloc
275 #define CRYPTO_free FIPS_free
277 #define ERR_put_error FIPS_put_error
278 #define ERR_add_error_data FIPS_add_error_data
280 #define EVP_MD_CTX_init FIPS_md_ctx_init
281 #define EVP_MD_CTX_cleanup FIPS_md_ctx_cleanup
282 #define EVP_MD_CTX_create FIPS_md_ctx_create
283 #define EVP_MD_CTX_destroy FIPS_md_ctx_destroy
284 #define EVP_DigestInit_ex(ctx, type, impl) FIPS_digestinit(ctx, type)
285 #define EVP_DigestInit FIPS_digestinit
286 #define EVP_DigestUpdate FIPS_digestupdate
287 #define EVP_Digest(data, count, md, size, type, impl) \
288 FIPS_digest(data, count, md, size, type)
289 #define EVP_DigestFinal_ex FIPS_digestfinal
290 #define EVP_MD_CTX_copy_ex FIPS_md_ctx_copy
292 #define EVP_CipherInit_ex(ctx, cipher, impl, key, iv, enc) \
293 FIPS_cipherinit(ctx, cipher, key, iv, enc)
295 #define EVP_CipherInit FIPS_cipherinit
297 #define EVP_CIPHER_CTX_init FIPS_cipher_ctx_init
298 #define EVP_CIPHER_CTX_cleanup FIPS_cipher_ctx_cleanup
299 #define EVP_Cipher FIPS_cipher
300 #define EVP_CIPHER_CTX_ctrl FIPS_cipher_ctx_ctrl
301 #define EVP_CIPHER_CTX_new FIPS_cipher_ctx_new
302 #define EVP_CIPHER_CTX_free FIPS_cipher_ctx_free
303 #define EVP_CIPHER_CTX_copy FIPS_cipher_ctx_copy
304 #define EVP_CIPHER_CTX_set_key_length FIPS_cipher_ctx_set_key_length
306 #define DSA_SIG_new FIPS_dsa_sig_new
307 #define DSA_SIG_free FIPS_dsa_sig_free
309 #define ECDSA_SIG_new FIPS_ecdsa_sig_new
310 #define ECDSA_SIG_free FIPS_ecdsa_sig_free
312 #define ecdsa_check fips_ecdsa_check
313 #define ecdh_check fips_ecdh_check
315 #define RAND_bytes FIPS_rand_bytes
316 #define RAND_pseudo_bytes FIPS_rand_pseudo_bytes
317 #define RAND_add FIPS_rand_add
318 #define RAND_seed FIPS_rand_seed
319 #define RAND_status FIPS_rand_status
323 /* BEGIN ERROR CODES */
324 /* The following lines are auto generated by the script mkerr.pl. Any changes
325 * made after this point may be overwritten when the script is next run.
327 void ERR_load_FIPS_strings(void);
329 /* Error codes for the FIPS functions. */
331 /* Function codes. */
332 #define FIPS_F_DH_BUILTIN_GENPARAMS 100
333 #define FIPS_F_DH_INIT 148
334 #define FIPS_F_DSA_BUILTIN_PARAMGEN 101
335 #define FIPS_F_DSA_BUILTIN_PARAMGEN2 102
336 #define FIPS_F_DSA_DO_SIGN 103
337 #define FIPS_F_DSA_DO_VERIFY 104
338 #define FIPS_F_FIPS_CHECK_DSA 105
339 #define FIPS_F_FIPS_CHECK_DSA_PRNG 151
340 #define FIPS_F_FIPS_CHECK_EC 106
341 #define FIPS_F_FIPS_CHECK_EC_PRNG 152
342 #define FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT 107
343 #define FIPS_F_FIPS_CHECK_RSA 108
344 #define FIPS_F_FIPS_CHECK_RSA_PRNG 150
345 #define FIPS_F_FIPS_CIPHER 160
346 #define FIPS_F_FIPS_CIPHERINIT 109
347 #define FIPS_F_FIPS_CIPHER_CTX_CTRL 161
348 #define FIPS_F_FIPS_DIGESTFINAL 158
349 #define FIPS_F_FIPS_DIGESTINIT 110
350 #define FIPS_F_FIPS_DIGESTUPDATE 159
351 #define FIPS_F_FIPS_DRBG_BYTES 111
352 #define FIPS_F_FIPS_DRBG_CHECK 146
353 #define FIPS_F_FIPS_DRBG_CPRNG_TEST 112
354 #define FIPS_F_FIPS_DRBG_GENERATE 113
355 #define FIPS_F_FIPS_DRBG_HEALTH_CHECK 114
356 #define FIPS_F_FIPS_DRBG_INIT 115
357 #define FIPS_F_FIPS_DRBG_INSTANTIATE 116
358 #define FIPS_F_FIPS_DRBG_NEW 117
359 #define FIPS_F_FIPS_DRBG_RESEED 118
360 #define FIPS_F_FIPS_DRBG_SINGLE_KAT 119
361 #define FIPS_F_FIPS_DSA_SIGN_DIGEST 154
362 #define FIPS_F_FIPS_DSA_VERIFY_DIGEST 155
363 #define FIPS_F_FIPS_GET_ENTROPY 147
364 #define FIPS_F_FIPS_MODULE_MODE_SET 120
365 #define FIPS_F_FIPS_PKEY_SIGNATURE_TEST 121
366 #define FIPS_F_FIPS_RAND_ADD 122
367 #define FIPS_F_FIPS_RAND_BYTES 123
368 #define FIPS_F_FIPS_RAND_PSEUDO_BYTES 124
369 #define FIPS_F_FIPS_RAND_SEED 125
370 #define FIPS_F_FIPS_RAND_SET_METHOD 126
371 #define FIPS_F_FIPS_RAND_STATUS 127
372 #define FIPS_F_FIPS_RSA_SIGN_DIGEST 156
373 #define FIPS_F_FIPS_RSA_VERIFY_DIGEST 157
374 #define FIPS_F_FIPS_SELFTEST_AES 128
375 #define FIPS_F_FIPS_SELFTEST_AES_CCM 145
376 #define FIPS_F_FIPS_SELFTEST_AES_GCM 129
377 #define FIPS_F_FIPS_SELFTEST_AES_XTS 144
378 #define FIPS_F_FIPS_SELFTEST_CMAC 130
379 #define FIPS_F_FIPS_SELFTEST_DES 131
380 #define FIPS_F_FIPS_SELFTEST_DSA 132
381 #define FIPS_F_FIPS_SELFTEST_ECDSA 133
382 #define FIPS_F_FIPS_SELFTEST_HMAC 134
383 #define FIPS_F_FIPS_SELFTEST_SHA1 135
384 #define FIPS_F_FIPS_SELFTEST_X931 136
385 #define FIPS_F_FIPS_SET_PRNG_KEY 153
386 #define FIPS_F_HASH_FINAL 137
387 #define FIPS_F_RSA_BUILTIN_KEYGEN 138
388 #define FIPS_F_RSA_EAY_INIT 149
389 #define FIPS_F_RSA_EAY_PRIVATE_DECRYPT 139
390 #define FIPS_F_RSA_EAY_PRIVATE_ENCRYPT 140
391 #define FIPS_F_RSA_EAY_PUBLIC_DECRYPT 141
392 #define FIPS_F_RSA_EAY_PUBLIC_ENCRYPT 142
393 #define FIPS_F_RSA_X931_GENERATE_KEY_EX 143
396 #define FIPS_R_ADDITIONAL_INPUT_TOO_LONG 100
397 #define FIPS_R_ALREADY_INSTANTIATED 101
398 #define FIPS_R_CONTRADICTING_EVIDENCE 102
399 #define FIPS_R_DRBG_STUCK 103
400 #define FIPS_R_ENTROPY_ERROR_UNDETECTED 104
401 #define FIPS_R_ENTROPY_NOT_REQUESTED_FOR_RESEED 105
402 #define FIPS_R_ENTROPY_SOURCE_STUCK 142
403 #define FIPS_R_ERROR_INITIALISING_DRBG 106
404 #define FIPS_R_ERROR_INSTANTIATING_DRBG 107
405 #define FIPS_R_ERROR_RETRIEVING_ADDITIONAL_INPUT 108
406 #define FIPS_R_ERROR_RETRIEVING_ENTROPY 109
407 #define FIPS_R_ERROR_RETRIEVING_NONCE 110
408 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH 111
409 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED 112
410 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING 113
411 #define FIPS_R_FIPS_MODE_ALREADY_SET 114
412 #define FIPS_R_FIPS_SELFTEST_FAILED 115
413 #define FIPS_R_FUNCTION_ERROR 116
414 #define FIPS_R_GENERATE_ERROR 117
415 #define FIPS_R_GENERATE_ERROR_UNDETECTED 118
416 #define FIPS_R_INSTANTIATE_ERROR 119
417 #define FIPS_R_INSUFFICIENT_SECURITY_STRENGTH 120
418 #define FIPS_R_INTERNAL_ERROR 121
419 #define FIPS_R_INVALID_KEY_LENGTH 122
420 #define FIPS_R_INVALID_PARAMETERS 144
421 #define FIPS_R_IN_ERROR_STATE 123
422 #define FIPS_R_KEY_TOO_SHORT 124
423 #define FIPS_R_NON_FIPS_METHOD 125
424 #define FIPS_R_NOT_INSTANTIATED 126
425 #define FIPS_R_PAIRWISE_TEST_FAILED 127
426 #define FIPS_R_PERSONALISATION_ERROR_UNDETECTED 128
427 #define FIPS_R_PERSONALISATION_STRING_TOO_LONG 129
428 #define FIPS_R_PRNG_STRENGTH_TOO_LOW 143
429 #define FIPS_R_REQUEST_LENGTH_ERROR_UNDETECTED 130
430 #define FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG 131
431 #define FIPS_R_RESEED_COUNTER_ERROR 132
432 #define FIPS_R_RESEED_ERROR 133
433 #define FIPS_R_SELFTEST_FAILED 134
434 #define FIPS_R_SELFTEST_FAILURE 135
435 #define FIPS_R_STRENGTH_ERROR_UNDETECTED 136
436 #define FIPS_R_TEST_FAILURE 137
437 #define FIPS_R_UNINSTANTIATE_ERROR 141
438 #define FIPS_R_UNINSTANTIATE_ZEROISE_ERROR 138
439 #define FIPS_R_UNSUPPORTED_DRBG_TYPE 139
440 #define FIPS_R_UNSUPPORTED_PLATFORM 140