1 /* ====================================================================
2 * Copyright (c) 2003 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 #define OPENSSL_FIPSAPI
52 #include <openssl/rand.h>
53 #include <openssl/fips_rand.h>
54 #include <openssl/err.h>
55 #include <openssl/bio.h>
56 #include <openssl/hmac.h>
57 #include <openssl/rsa.h>
58 #include <openssl/dsa.h>
61 #include "fips_locl.h"
65 #include <openssl/fips.h>
71 static int fips_selftest_fail;
73 static int fips_started = 0;
74 static const void *fips_rand_check;
76 static int fips_is_owning_thread(void);
77 static int fips_set_owning_thread(void);
78 static int fips_clear_owning_thread(void);
79 static unsigned char *fips_signature_witness(void);
81 static void fips_w_lock(void) { CRYPTO_w_lock(CRYPTO_LOCK_FIPS); }
82 static void fips_w_unlock(void) { CRYPTO_w_unlock(CRYPTO_LOCK_FIPS); }
83 static void fips_r_lock(void) { CRYPTO_r_lock(CRYPTO_LOCK_FIPS); }
84 static void fips_r_unlock(void) { CRYPTO_r_unlock(CRYPTO_LOCK_FIPS); }
86 static void fips_set_mode(int onoff)
88 int owning_thread = fips_is_owning_thread();
92 if (!owning_thread) fips_w_lock();
94 if (!owning_thread) fips_w_unlock();
98 static void fips_set_rand_check(const void *rand_check)
100 int owning_thread = fips_is_owning_thread();
104 if (!owning_thread) fips_w_lock();
105 fips_rand_check = rand_check;
106 if (!owning_thread) fips_w_unlock();
113 int owning_thread = fips_is_owning_thread();
117 if (!owning_thread) fips_r_lock();
119 if (!owning_thread) fips_r_unlock();
124 const void *FIPS_rand_check(void)
127 int owning_thread = fips_is_owning_thread();
131 if (!owning_thread) fips_r_lock();
132 ret = fips_rand_check;
133 if (!owning_thread) fips_r_unlock();
138 int FIPS_selftest_failed(void)
143 int owning_thread = fips_is_owning_thread();
145 if (!owning_thread) fips_r_lock();
146 ret = fips_selftest_fail;
147 if (!owning_thread) fips_r_unlock();
152 /* Selftest failure fatal exit routine. This will be called
153 * during *any* cryptographic operation. It has the minimum
154 * overhead possible to avoid too big a performance hit.
157 void FIPS_selftest_check(void)
159 if (fips_selftest_fail)
161 OpenSSLDie(__FILE__,__LINE__, "FATAL FIPS SELFTEST FAILURE");
165 void fips_set_selftest_fail(void)
167 fips_selftest_fail = 1;
170 int FIPS_selftest(void)
173 return FIPS_selftest_sha1()
174 && FIPS_selftest_hmac()
175 && FIPS_selftest_aes()
176 && FIPS_selftest_des()
177 && FIPS_selftest_rsa()
178 && FIPS_selftest_dsa();
181 extern const void *FIPS_text_start(), *FIPS_text_end();
182 extern const unsigned char FIPS_rodata_start[], FIPS_rodata_end[];
183 unsigned char FIPS_signature [20] = { 0 };
184 static const char FIPS_hmac_key[]="etaonrishdlcupfm";
186 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len)
188 const unsigned char *p1 = FIPS_text_start();
189 const unsigned char *p2 = FIPS_text_end();
190 const unsigned char *p3 = FIPS_rodata_start;
191 const unsigned char *p4 = FIPS_rodata_end;
195 HMAC_Init(&c,FIPS_hmac_key,strlen(FIPS_hmac_key),EVP_sha1());
197 /* detect overlapping regions */
198 if (p1<=p3 && p2>=p3)
199 p3=p1, p4=p2>p4?p2:p4, p1=NULL, p2=NULL;
200 else if (p3<=p1 && p4>=p1)
201 p3=p3, p4=p2>p4?p2:p4, p1=NULL, p2=NULL;
204 HMAC_Update(&c,p1,(size_t)p2-(size_t)p1);
206 if (FIPS_signature>=p3 && FIPS_signature<p4)
209 HMAC_Update(&c,p3,(size_t)FIPS_signature-(size_t)p3);
210 p3 = FIPS_signature+sizeof(FIPS_signature);
212 HMAC_Update(&c,p3,(size_t)p4-(size_t)p3);
215 HMAC_Update(&c,p3,(size_t)p4-(size_t)p3);
217 HMAC_Final(&c,sig,&len);
218 HMAC_CTX_cleanup(&c);
223 int FIPS_check_incore_fingerprint(void)
225 unsigned char sig[EVP_MAX_MD_SIZE];
227 #if defined(__sgi) && (defined(__mips) || defined(mips))
228 extern int __dso_displacement[];
230 extern int OPENSSL_NONPIC_relocated;
233 if (FIPS_text_start()==NULL)
235 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_UNSUPPORTED_PLATFORM);
239 len=FIPS_incore_fingerprint (sig,sizeof(sig));
241 if (len!=sizeof(FIPS_signature) ||
242 memcmp(FIPS_signature,sig,sizeof(FIPS_signature)))
244 if (FIPS_signature>=FIPS_rodata_start && FIPS_signature<FIPS_rodata_end)
245 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING);
246 #if defined(__sgi) && (defined(__mips) || defined(mips))
247 else if (__dso_displacement!=NULL)
249 else if (OPENSSL_NONPIC_relocated)
251 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED);
253 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_FINGERPRINT_DOES_NOT_MATCH);
254 #ifdef OPENSSL_FIPS_DEBUGGER
263 int FIPS_mode_set(int onoff)
265 int fips_set_owning_thread();
266 int fips_clear_owning_thread();
271 fips_set_owning_thread();
275 unsigned char buf[48];
277 fips_selftest_fail = 0;
279 /* Don't go into FIPS mode twice, just so we can do automagic
283 FIPSerr(FIPS_F_FIPS_MODE_SET,FIPS_R_FIPS_MODE_ALREADY_SET);
284 fips_selftest_fail = 1;
289 #ifdef OPENSSL_IA32_SSE2
290 if ((OPENSSL_ia32cap & (1<<25|1<<26)) != (1<<25|1<<26))
292 FIPSerr(FIPS_F_FIPS_MODE_SET,FIPS_R_UNSUPPORTED_PLATFORM);
293 fips_selftest_fail = 1;
299 if(fips_signature_witness() != FIPS_signature)
301 FIPSerr(FIPS_F_FIPS_MODE_SET,FIPS_R_CONTRADICTING_EVIDENCE);
302 fips_selftest_fail = 1;
307 if(!FIPS_check_incore_fingerprint())
309 fips_selftest_fail = 1;
314 /* Perform RNG KAT before seeding */
315 if (!FIPS_selftest_rng())
317 fips_selftest_fail = 1;
322 /* automagically seed PRNG if not already seeded */
323 if(!FIPS_rand_status())
325 if(RAND_bytes(buf,sizeof buf) <= 0)
327 fips_selftest_fail = 1;
331 FIPS_rand_set_key(buf,32);
332 FIPS_rand_seed(buf+32,16);
335 /* now switch into FIPS mode */
336 fips_set_rand_check(FIPS_rand_method());
337 RAND_set_rand_method(FIPS_rand_method());
342 fips_selftest_fail = 1;
350 fips_selftest_fail = 0;
353 fips_clear_owning_thread();
358 static CRYPTO_THREADID fips_thread;
359 static int fips_thread_set = 0;
361 static int fips_is_owning_thread(void)
367 CRYPTO_r_lock(CRYPTO_LOCK_FIPS2);
371 CRYPTO_THREADID_current(&cur);
372 if (!CRYPTO_THREADID_cmp(&cur, &fips_thread))
375 CRYPTO_r_unlock(CRYPTO_LOCK_FIPS2);
380 int fips_set_owning_thread(void)
386 CRYPTO_w_lock(CRYPTO_LOCK_FIPS2);
387 if (!fips_thread_set)
389 CRYPTO_THREADID_current(&fips_thread);
392 CRYPTO_w_unlock(CRYPTO_LOCK_FIPS2);
397 int fips_clear_owning_thread(void)
403 CRYPTO_w_lock(CRYPTO_LOCK_FIPS2);
407 CRYPTO_THREADID_current(&cur);
408 if (!CRYPTO_THREADID_cmp(&cur, &fips_thread))
411 CRYPTO_w_unlock(CRYPTO_LOCK_FIPS2);
416 unsigned char *fips_signature_witness(void)
418 extern unsigned char FIPS_signature[];
419 return FIPS_signature;
422 /* Generalized public key test routine. Signs and verifies the data
423 * supplied in tbs using mesage digest md and setting RSA padding mode
424 * pad_mode. If the 'kat' parameter is not NULL it will
425 * additionally check the signature matches it: a known answer test
426 * The string "fail_str" is used for identification purposes in case
430 int fips_pkey_signature_test(EVP_PKEY *pkey,
431 const unsigned char *tbs, int tbslen,
432 const unsigned char *kat, unsigned int katlen,
433 const EVP_MD *digest, int pad_mode,
434 const char *fail_str)
437 unsigned char sigtmp[256], *sig = sigtmp;
439 DSA_SIG *dsig = NULL;
441 FIPS_md_ctx_init(&mctx);
443 if ((pkey->type == EVP_PKEY_RSA)
444 && ((size_t)RSA_size(pkey->pkey.rsa) > sizeof(sigtmp)))
446 sig = OPENSSL_malloc(RSA_size(pkey->pkey.rsa));
449 FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,ERR_R_MALLOC_FAILURE);
455 tbslen = strlen((char *)tbs);
457 if (!FIPS_digestinit(&mctx, digest))
459 if (!FIPS_digestupdate(&mctx, tbs, tbslen))
461 if (pkey->type == EVP_PKEY_RSA)
463 if (!FIPS_rsa_sign_ctx(pkey->pkey.rsa, &mctx,
464 pad_mode, 0, NULL, sig, &siglen))
467 else if (pkey->type == EVP_PKEY_DSA)
469 dsig = FIPS_dsa_sign_ctx(pkey->pkey.dsa, &mctx);
474 else if (!EVP_SignFinal(&mctx, sig, &siglen, pkey))
478 if (kat && ((siglen != katlen) || memcmp(kat, sig, katlen)))
481 if (!FIPS_digestinit(&mctx, digest))
483 if (!FIPS_digestupdate(&mctx, tbs, tbslen))
485 if (pkey->type == EVP_PKEY_RSA)
487 ret = FIPS_rsa_verify_ctx(pkey->pkey.rsa, &mctx,
488 pad_mode, 0, NULL, sig, siglen);
490 else if (pkey->type == EVP_PKEY_DSA)
492 ret = FIPS_dsa_verify_ctx(pkey->pkey.dsa, &mctx, dsig);
496 ret = EVP_VerifyFinal(&mctx, sig, siglen, pkey);
501 FIPS_dsa_sig_free(dsig);
504 FIPS_md_ctx_cleanup(&mctx);
507 FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,FIPS_R_TEST_FAILURE);
509 FIPS_add_error_data(2, "Type=", fail_str);
515 /* Generalized symmetric cipher test routine. Encrypt data, verify result
516 * against known answer, decrypt and compare with original plaintext.
519 int fips_cipher_test(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
520 const unsigned char *key,
521 const unsigned char *iv,
522 const unsigned char *plaintext,
523 const unsigned char *ciphertext,
526 unsigned char pltmp[FIPS_MAX_CIPHER_TEST_SIZE];
527 unsigned char citmp[FIPS_MAX_CIPHER_TEST_SIZE];
528 OPENSSL_assert(len <= FIPS_MAX_CIPHER_TEST_SIZE);
529 if (FIPS_cipherinit(ctx, cipher, key, iv, 1) <= 0)
531 FIPS_cipher(ctx, citmp, plaintext, len);
532 if (memcmp(citmp, ciphertext, len))
534 if (FIPS_cipherinit(ctx, cipher, key, iv, 0) <= 0)
536 FIPS_cipher(ctx, pltmp, citmp, len);
537 if (memcmp(pltmp, plaintext, len))
543 /* The purpose of this is to ensure the error code exists and the function
544 * name is to keep the error checking script quiet
546 void hash_final(void)
548 FIPSerr(FIPS_F_HASH_FINAL,FIPS_R_NON_FIPS_METHOD);