5452db9311f522ec110e257ba18be66b7ba722ea
[openssl.git] / fips / fips.h
1 /* ====================================================================
2  * Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer. 
10  *
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
14  *    distribution.
15  *
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/)"
20  *
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.
25  *
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.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
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.
47  *
48  */
49
50 #include <openssl/opensslconf.h>
51
52 #ifndef OPENSSL_FIPS
53 #error FIPS is disabled.
54 #endif
55
56 #ifdef OPENSSL_FIPS
57
58 #ifdef  __cplusplus
59 extern "C" {
60 #endif
61
62 struct dsa_st;
63 struct evp_pkey_st;
64 struct env_md_st;
65 struct evp_cipher_st;
66 struct evp_cipher_ctx_st;
67
68 int FIPS_mode_set(int onoff);
69 int FIPS_mode(void);
70 const void *FIPS_rand_check(void);
71 int FIPS_selftest(void);
72 int FIPS_selftest_failed(void);
73 void FIPS_selftest_check(void);
74 void FIPS_corrupt_sha1(void);
75 int FIPS_selftest_sha1(void);
76 void FIPS_corrupt_aes(void);
77 int FIPS_selftest_aes(void);
78 void FIPS_corrupt_des(void);
79 int FIPS_selftest_des(void);
80 void FIPS_corrupt_rsa(void);
81 void FIPS_corrupt_rsa_keygen(void);
82 int FIPS_selftest_rsa(void);
83 void FIPS_corrupt_dsa(void);
84 void FIPS_corrupt_dsa_keygen(void);
85 int FIPS_selftest_dsa(void);
86 void FIPS_corrupt_rng(void);
87 void FIPS_rng_stick(void);
88 int FIPS_selftest_rng(void);
89 int FIPS_selftest_hmac(void);
90
91 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len);
92 int FIPS_check_incore_fingerprint(void);
93
94 int fips_pkey_signature_test(struct evp_pkey_st *pkey,
95                         const unsigned char *tbs, int tbslen,
96                         const unsigned char *kat, unsigned int katlen,
97                         const struct env_md_st *digest, int pad_mode,
98                         const char *fail_str);
99
100 int fips_cipher_test(struct evp_cipher_ctx_st *ctx,
101                         const struct evp_cipher_st *cipher,
102                         const unsigned char *key,
103                         const unsigned char *iv,
104                         const unsigned char *plaintext,
105                         const unsigned char *ciphertext,
106                         int len);
107
108 void fips_set_selftest_fail(void);
109 int fips_check_rsa(struct rsa_st *rsa);
110
111 void FIPS_lock(int mode, int type,const char *file,int line);
112
113 void FIPS_set_locking_callback (void (*func)(int mode, int type,
114                                 const char *file,int line));
115
116 void *FIPS_malloc(int num, const char *file, int line);
117 void FIPS_free(void *);
118
119 #if defined(OPENSSL_FIPSCANISTER) && defined(OPENSSL_FIPSAPI)
120 #define CRYPTO_lock FIPS_lock
121 #define CRYPTO_malloc FIPS_malloc
122 #define CRYPTO_free FIPS_free
123 #endif
124
125 /* BEGIN ERROR CODES */
126 /* The following lines are auto generated by the script mkerr.pl. Any changes
127  * made after this point may be overwritten when the script is next run.
128  */
129 void ERR_load_FIPS_strings(void);
130
131 /* Error codes for the FIPS functions. */
132
133 /* Function codes. */
134 #define FIPS_F_DH_BUILTIN_GENPARAMS                      100
135 #define FIPS_F_DSA_BUILTIN_PARAMGEN                      101
136 #define FIPS_F_DSA_DO_SIGN                               102
137 #define FIPS_F_DSA_DO_VERIFY                             103
138 #define FIPS_F_EVP_CIPHERINIT_EX                         124
139 #define FIPS_F_EVP_DIGESTINIT_EX                         125
140 #define FIPS_F_FIPS_CHECK_DSA                            104
141 #define FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT             105
142 #define FIPS_F_FIPS_CHECK_RSA                            106
143 #define FIPS_F_FIPS_DSA_CHECK                            107
144 #define FIPS_F_FIPS_MODE_SET                             108
145 #define FIPS_F_FIPS_PKEY_SIGNATURE_TEST                  109
146 #define FIPS_F_FIPS_SELFTEST_AES                         110
147 #define FIPS_F_FIPS_SELFTEST_DES                         111
148 #define FIPS_F_FIPS_SELFTEST_DSA                         112
149 #define FIPS_F_FIPS_SELFTEST_HMAC                        113
150 #define FIPS_F_FIPS_SELFTEST_RNG                         114
151 #define FIPS_F_FIPS_SELFTEST_SHA1                        115
152 #define FIPS_F_HASH_FINAL                                123
153 #define FIPS_F_RSA_BUILTIN_KEYGEN                        116
154 #define FIPS_F_RSA_EAY_PRIVATE_DECRYPT                   117
155 #define FIPS_F_RSA_EAY_PRIVATE_ENCRYPT                   118
156 #define FIPS_F_RSA_EAY_PUBLIC_DECRYPT                    119
157 #define FIPS_F_RSA_EAY_PUBLIC_ENCRYPT                    120
158 #define FIPS_F_RSA_X931_GENERATE_KEY_EX                  121
159 #define FIPS_F_SSLEAY_RAND_BYTES                         122
160
161 /* Reason codes. */
162 #define FIPS_R_CANNOT_READ_EXE                           103
163 #define FIPS_R_CANNOT_READ_EXE_DIGEST                    104
164 #define FIPS_R_CONTRADICTING_EVIDENCE                    114
165 #define FIPS_R_EXE_DIGEST_DOES_NOT_MATCH                 105
166 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH                110
167 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED 111
168 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING 112
169 #define FIPS_R_FIPS_MODE_ALREADY_SET                     102
170 #define FIPS_R_FIPS_SELFTEST_FAILED                      106
171 #define FIPS_R_INVALID_KEY_LENGTH                        109
172 #define FIPS_R_KEY_TOO_SHORT                             108
173 #define FIPS_R_NON_FIPS_METHOD                           100
174 #define FIPS_R_PAIRWISE_TEST_FAILED                      107
175 #define FIPS_R_RSA_DECRYPT_ERROR                         115
176 #define FIPS_R_RSA_ENCRYPT_ERROR                         116
177 #define FIPS_R_SELFTEST_FAILED                           101
178 #define FIPS_R_TEST_FAILURE                              117
179 #define FIPS_R_UNSUPPORTED_PLATFORM                      113
180
181 #ifdef  __cplusplus
182 }
183 #endif
184 #endif