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>
59 #include <openssl/ecdsa.h>
62 #include "fips_locl.h"
66 #include <openssl/fips.h>
72 static int fips_selftest_fail;
74 static int fips_started = 0;
75 static const void *fips_rand_check;
77 static int fips_is_owning_thread(void);
78 static int fips_set_owning_thread(void);
79 static int fips_clear_owning_thread(void);
80 static unsigned char *fips_signature_witness(void);
82 static void fips_w_lock(void) { CRYPTO_w_lock(CRYPTO_LOCK_FIPS); }
83 static void fips_w_unlock(void) { CRYPTO_w_unlock(CRYPTO_LOCK_FIPS); }
84 static void fips_r_lock(void) { CRYPTO_r_lock(CRYPTO_LOCK_FIPS); }
85 static void fips_r_unlock(void) { CRYPTO_r_unlock(CRYPTO_LOCK_FIPS); }
87 static void fips_set_mode(int onoff)
89 int owning_thread = fips_is_owning_thread();
93 if (!owning_thread) fips_w_lock();
95 if (!owning_thread) fips_w_unlock();
99 static void fips_set_rand_check(const void *rand_check)
101 int owning_thread = fips_is_owning_thread();
105 if (!owning_thread) fips_w_lock();
106 fips_rand_check = rand_check;
107 if (!owning_thread) fips_w_unlock();
114 int owning_thread = fips_is_owning_thread();
118 if (!owning_thread) fips_r_lock();
120 if (!owning_thread) fips_r_unlock();
125 const void *FIPS_rand_check(void)
128 int owning_thread = fips_is_owning_thread();
132 if (!owning_thread) fips_r_lock();
133 ret = fips_rand_check;
134 if (!owning_thread) fips_r_unlock();
139 int FIPS_selftest_failed(void)
144 int owning_thread = fips_is_owning_thread();
146 if (!owning_thread) fips_r_lock();
147 ret = fips_selftest_fail;
148 if (!owning_thread) fips_r_unlock();
153 /* Selftest failure fatal exit routine. This will be called
154 * during *any* cryptographic operation. It has the minimum
155 * overhead possible to avoid too big a performance hit.
158 void FIPS_selftest_check(void)
160 if (fips_selftest_fail)
162 OpenSSLDie(__FILE__,__LINE__, "FATAL FIPS SELFTEST FAILURE");
166 void fips_set_selftest_fail(void)
168 fips_selftest_fail = 1;
171 int FIPS_selftest(void)
174 return FIPS_selftest_sha1()
175 && FIPS_selftest_hmac()
176 && FIPS_selftest_aes()
177 && FIPS_selftest_des()
178 && FIPS_selftest_rsa()
179 && FIPS_selftest_dsa();
182 extern const void *FIPS_text_start(), *FIPS_text_end();
183 extern const unsigned char FIPS_rodata_start[], FIPS_rodata_end[];
184 unsigned char FIPS_signature [20] = { 0 };
185 static const char FIPS_hmac_key[]="etaonrishdlcupfm";
187 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len)
189 const unsigned char *p1 = FIPS_text_start();
190 const unsigned char *p2 = FIPS_text_end();
191 const unsigned char *p3 = FIPS_rodata_start;
192 const unsigned char *p4 = FIPS_rodata_end;
196 HMAC_Init(&c,FIPS_hmac_key,strlen(FIPS_hmac_key),EVP_sha1());
198 /* detect overlapping regions */
199 if (p1<=p3 && p2>=p3)
200 p3=p1, p4=p2>p4?p2:p4, p1=NULL, p2=NULL;
201 else if (p3<=p1 && p4>=p1)
202 p3=p3, p4=p2>p4?p2:p4, p1=NULL, p2=NULL;
205 HMAC_Update(&c,p1,(size_t)p2-(size_t)p1);
207 if (FIPS_signature>=p3 && FIPS_signature<p4)
210 HMAC_Update(&c,p3,(size_t)FIPS_signature-(size_t)p3);
211 p3 = FIPS_signature+sizeof(FIPS_signature);
213 HMAC_Update(&c,p3,(size_t)p4-(size_t)p3);
216 HMAC_Update(&c,p3,(size_t)p4-(size_t)p3);
218 HMAC_Final(&c,sig,&len);
219 HMAC_CTX_cleanup(&c);
224 int FIPS_check_incore_fingerprint(void)
226 unsigned char sig[EVP_MAX_MD_SIZE];
228 #if defined(__sgi) && (defined(__mips) || defined(mips))
229 extern int __dso_displacement[];
231 extern int OPENSSL_NONPIC_relocated;
234 if (FIPS_text_start()==NULL)
236 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_UNSUPPORTED_PLATFORM);
240 len=FIPS_incore_fingerprint (sig,sizeof(sig));
242 if (len!=sizeof(FIPS_signature) ||
243 memcmp(FIPS_signature,sig,sizeof(FIPS_signature)))
245 if (FIPS_signature>=FIPS_rodata_start && FIPS_signature<FIPS_rodata_end)
246 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING);
247 #if defined(__sgi) && (defined(__mips) || defined(mips))
248 else if (__dso_displacement!=NULL)
250 else if (OPENSSL_NONPIC_relocated)
252 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED);
254 FIPSerr(FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT,FIPS_R_FINGERPRINT_DOES_NOT_MATCH);
255 #ifdef OPENSSL_FIPS_DEBUGGER
264 int FIPS_mode_set(int onoff)
266 int fips_set_owning_thread();
267 int fips_clear_owning_thread();
272 fips_set_owning_thread();
276 unsigned char buf[48];
278 fips_selftest_fail = 0;
280 /* Don't go into FIPS mode twice, just so we can do automagic
284 FIPSerr(FIPS_F_FIPS_MODE_SET,FIPS_R_FIPS_MODE_ALREADY_SET);
285 fips_selftest_fail = 1;
290 #ifdef OPENSSL_IA32_SSE2
291 if ((OPENSSL_ia32cap & (1<<25|1<<26)) != (1<<25|1<<26))
293 FIPSerr(FIPS_F_FIPS_MODE_SET,FIPS_R_UNSUPPORTED_PLATFORM);
294 fips_selftest_fail = 1;
300 if(fips_signature_witness() != FIPS_signature)
302 FIPSerr(FIPS_F_FIPS_MODE_SET,FIPS_R_CONTRADICTING_EVIDENCE);
303 fips_selftest_fail = 1;
308 if(!FIPS_check_incore_fingerprint())
310 fips_selftest_fail = 1;
315 /* Perform RNG KAT before seeding */
316 if (!FIPS_selftest_rng())
318 fips_selftest_fail = 1;
323 /* automagically seed PRNG if not already seeded */
324 if(!FIPS_rand_status())
326 if(RAND_bytes(buf,sizeof buf) <= 0)
328 fips_selftest_fail = 1;
332 FIPS_rand_set_key(buf,32);
333 FIPS_rand_seed(buf+32,16);
336 /* now switch into FIPS mode */
337 fips_set_rand_check(FIPS_rand_method());
338 RAND_set_rand_method(FIPS_rand_method());
343 fips_selftest_fail = 1;
351 fips_selftest_fail = 0;
354 fips_clear_owning_thread();
359 static CRYPTO_THREADID fips_thread;
360 static int fips_thread_set = 0;
362 static int fips_is_owning_thread(void)
368 CRYPTO_r_lock(CRYPTO_LOCK_FIPS2);
372 CRYPTO_THREADID_current(&cur);
373 if (!CRYPTO_THREADID_cmp(&cur, &fips_thread))
376 CRYPTO_r_unlock(CRYPTO_LOCK_FIPS2);
381 int fips_set_owning_thread(void)
387 CRYPTO_w_lock(CRYPTO_LOCK_FIPS2);
388 if (!fips_thread_set)
390 CRYPTO_THREADID_current(&fips_thread);
393 CRYPTO_w_unlock(CRYPTO_LOCK_FIPS2);
398 int fips_clear_owning_thread(void)
404 CRYPTO_w_lock(CRYPTO_LOCK_FIPS2);
408 CRYPTO_THREADID_current(&cur);
409 if (!CRYPTO_THREADID_cmp(&cur, &fips_thread))
412 CRYPTO_w_unlock(CRYPTO_LOCK_FIPS2);
417 unsigned char *fips_signature_witness(void)
419 extern unsigned char FIPS_signature[];
420 return FIPS_signature;
423 /* Generalized public key test routine. Signs and verifies the data
424 * supplied in tbs using mesage digest md and setting RSA padding mode
425 * pad_mode. If the 'kat' parameter is not NULL it will
426 * additionally check the signature matches it: a known answer test
427 * The string "fail_str" is used for identification purposes in case
431 int fips_pkey_signature_test(EVP_PKEY *pkey,
432 const unsigned char *tbs, int tbslen,
433 const unsigned char *kat, unsigned int katlen,
434 const EVP_MD *digest, int pad_mode,
435 const char *fail_str)
438 unsigned char sigtmp[256], *sig = sigtmp;
440 DSA_SIG *dsig = NULL;
441 ECDSA_SIG *esig = NULL;
443 FIPS_md_ctx_init(&mctx);
445 if ((pkey->type == EVP_PKEY_RSA)
446 && ((size_t)RSA_size(pkey->pkey.rsa) > sizeof(sigtmp)))
448 sig = OPENSSL_malloc(RSA_size(pkey->pkey.rsa));
451 FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,ERR_R_MALLOC_FAILURE);
457 tbslen = strlen((char *)tbs);
460 digest = EVP_sha256();
462 if (!FIPS_digestinit(&mctx, digest))
464 if (!FIPS_digestupdate(&mctx, tbs, tbslen))
466 if (pkey->type == EVP_PKEY_RSA)
468 if (!FIPS_rsa_sign_ctx(pkey->pkey.rsa, &mctx,
469 pad_mode, 0, NULL, sig, &siglen))
472 else if (pkey->type == EVP_PKEY_DSA)
474 dsig = FIPS_dsa_sign_ctx(pkey->pkey.dsa, &mctx);
478 else if (pkey->type == EVP_PKEY_EC)
480 esig = FIPS_ecdsa_sign_ctx(pkey->pkey.ec, &mctx);
485 else if (!EVP_SignFinal(&mctx, sig, &siglen, pkey))
489 if (kat && ((siglen != katlen) || memcmp(kat, sig, katlen)))
492 if (!FIPS_digestinit(&mctx, digest))
494 if (!FIPS_digestupdate(&mctx, tbs, tbslen))
496 if (pkey->type == EVP_PKEY_RSA)
498 ret = FIPS_rsa_verify_ctx(pkey->pkey.rsa, &mctx,
499 pad_mode, 0, NULL, sig, siglen);
501 else if (pkey->type == EVP_PKEY_DSA)
503 ret = FIPS_dsa_verify_ctx(pkey->pkey.dsa, &mctx, dsig);
505 else if (pkey->type == EVP_PKEY_EC)
507 ret = FIPS_ecdsa_verify_ctx(pkey->pkey.ec, &mctx, esig);
511 ret = EVP_VerifyFinal(&mctx, sig, siglen, pkey);
516 FIPS_dsa_sig_free(dsig);
518 FIPS_ecdsa_sig_free(esig);
521 FIPS_md_ctx_cleanup(&mctx);
524 FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,FIPS_R_TEST_FAILURE);
526 FIPS_add_error_data(2, "Type=", fail_str);
532 /* Generalized symmetric cipher test routine. Encrypt data, verify result
533 * against known answer, decrypt and compare with original plaintext.
536 int fips_cipher_test(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
537 const unsigned char *key,
538 const unsigned char *iv,
539 const unsigned char *plaintext,
540 const unsigned char *ciphertext,
543 unsigned char pltmp[FIPS_MAX_CIPHER_TEST_SIZE];
544 unsigned char citmp[FIPS_MAX_CIPHER_TEST_SIZE];
545 OPENSSL_assert(len <= FIPS_MAX_CIPHER_TEST_SIZE);
546 if (FIPS_cipherinit(ctx, cipher, key, iv, 1) <= 0)
548 FIPS_cipher(ctx, citmp, plaintext, len);
549 if (memcmp(citmp, ciphertext, len))
551 if (FIPS_cipherinit(ctx, cipher, key, iv, 0) <= 0)
553 FIPS_cipher(ctx, pltmp, citmp, len);
554 if (memcmp(pltmp, plaintext, len))
560 /* The purpose of this is to ensure the error code exists and the function
561 * name is to keep the error checking script quiet
563 void hash_final(void)
565 FIPSerr(FIPS_F_HASH_FINAL,FIPS_R_NON_FIPS_METHOD);