1a35f73a11b8b42569a73ed4b55fc4e72d60a639
[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 rsa_st;
64 struct evp_pkey_st;
65 struct env_md_st;
66 struct evp_cipher_st;
67 struct evp_cipher_ctx_st;
68
69 int FIPS_mode_set(int onoff);
70 int FIPS_mode(void);
71 const void *FIPS_rand_check(void);
72 int FIPS_selftest(void);
73 int FIPS_selftest_failed(void);
74 void FIPS_selftest_check(void);
75 int FIPS_selftest_sha1(void);
76 int FIPS_selftest_aes_gcm(void);
77 int FIPS_selftest_aes(void);
78 int FIPS_selftest_des(void);
79 int FIPS_selftest_rsa(void);
80 int FIPS_selftest_dsa(void);
81 int FIPS_selftest_ecdsa(void);
82 void FIPS_corrupt_x931(void);
83 void FIPS_corrupt_drbg(void);
84 void FIPS_x931_stick(void);
85 void FIPS_drbg_stick(void);
86 int FIPS_selftest_x931(void);
87 int FIPS_selftest_hmac(void);
88 int FIPS_selftest_drbg(void);
89 int FIPS_selftest_cmac(void);
90
91 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len);
92 int FIPS_check_incore_fingerprint(void);
93
94 void fips_set_selftest_fail(void);
95 int fips_check_rsa(struct rsa_st *rsa);
96
97 void FIPS_set_locking_callbacks(void (*func)(int mode, int type,
98                                 const char *file,int line),
99                                 int (*add_cb)(int *pointer, int amount,
100                                         int type, const char *file, int line));
101
102 void FIPS_set_malloc_callbacks(
103                 void *(*malloc_cb)(int num, const char *file, int line),
104                 void (*free_cb)(void *));
105
106 void FIPS_get_timevec(unsigned char *buf, unsigned long *pctr);
107
108 /* POST callback operation value: */
109 /* All tests started */
110 #define FIPS_POST_BEGIN         1
111 /* All tests end: result in id */
112 #define FIPS_POST_END           2
113 /* One individual test started */
114 #define FIPS_POST_STARTED       3
115 /* Individual test success */
116 #define FIPS_POST_SUCCESS       4
117 /* Individual test failure */
118 #define FIPS_POST_FAIL          5
119 /* Induce failure in test if zero return */
120 #define FIPS_POST_CORRUPT       6
121
122 /* Test IDs */
123 /* HMAC integrity test */
124 #define FIPS_TEST_INTEGRITY     1
125 /* Digest test */
126 #define FIPS_TEST_DIGEST        2
127 /* Symmetric cipher test */
128 #define FIPS_TEST_CIPHER        3
129 /* Public key signature test */
130 #define FIPS_TEST_SIGNATURE     4
131 /* HMAC test */
132 #define FIPS_TEST_HMAC          5
133 /* CMAC test */
134 #define FIPS_TEST_CMAC          6
135 /* GCM test */
136 #define FIPS_TEST_GCM           7
137 /* CCM test */
138 #define FIPS_TEST_CCM           8
139 /* XTS test */
140 #define FIPS_TEST_XTS           9
141 /* X9.31 PRNG */
142 #define FIPS_TEST_X931          10
143 /* DRNB */
144 #define FIPS_TEST_DRBG          11
145 /* Keygen pairwise consistency test */
146 #define FIPS_TEST_PAIRWISE      12
147 /* Continuous PRNG test */
148 #define FIPS_TEST_CONTINUOUS    13
149
150 void FIPS_post_set_callback(
151         int (*post_cb)(int op, int id, int subid, void *ex));
152
153 #define FIPS_ERROR_IGNORED(alg) OpenSSLDie(__FILE__, __LINE__, \
154                 alg " previous FIPS forbidden algorithm error ignored");
155
156 int fips_pkey_signature_test(int id, struct evp_pkey_st *pkey,
157                         const unsigned char *tbs, size_t tbslen,
158                         const unsigned char *kat, size_t katlen,
159                         const struct env_md_st *digest, int pad_mode,
160                         const char *fail_str);
161
162 int fips_cipher_test(int id, struct evp_cipher_ctx_st *ctx,
163                         const struct evp_cipher_st *cipher,
164                         const unsigned char *key,
165                         const unsigned char *iv,
166                         const unsigned char *plaintext,
167                         const unsigned char *ciphertext,
168                         int len);
169
170 /* Where necessary redirect standard OpenSSL APIs to FIPS versions */
171
172 #if defined(OPENSSL_FIPSCANISTER) && defined(OPENSSL_FIPSAPI)
173
174 #define CRYPTO_lock FIPS_lock
175 #define CRYPTO_add_lock FIPS_add_lock
176 #define CRYPTO_malloc FIPS_malloc
177 #define CRYPTO_free FIPS_free
178
179 #define ERR_put_error FIPS_put_error
180 #define ERR_add_error_data FIPS_add_error_data
181
182 #define EVP_MD_CTX_init FIPS_md_ctx_init
183 #define EVP_MD_CTX_cleanup FIPS_md_ctx_cleanup
184 #define EVP_MD_CTX_create FIPS_md_ctx_create
185 #define EVP_MD_CTX_destroy FIPS_md_ctx_destroy
186 #define EVP_DigestInit_ex(ctx, type, impl) FIPS_digestinit(ctx, type)
187 #define EVP_DigestInit FIPS_digestinit
188 #define EVP_DigestUpdate FIPS_digestupdate
189 #define EVP_Digest(data, count, md, size, type, impl) \
190                         FIPS_digest(data, count, md, size, type)
191 #define EVP_DigestFinal_ex FIPS_digestfinal
192 #define EVP_MD_CTX_copy_ex FIPS_md_ctx_copy
193
194 #define EVP_CipherInit_ex(ctx, cipher, impl, key, iv, enc) \
195                                 FIPS_cipherinit(ctx, cipher, key, iv, enc)
196
197 #define EVP_CipherInit FIPS_cipherinit
198
199 #define EVP_CIPHER_CTX_init FIPS_cipher_ctx_init
200 #define EVP_CIPHER_CTX_cleanup FIPS_cipher_ctx_cleanup
201 #define EVP_Cipher FIPS_cipher
202 #define EVP_CIPHER_CTX_ctrl FIPS_cipher_ctx_ctrl
203 #define EVP_CIPHER_CTX_new FIPS_cipher_ctx_new
204 #define EVP_CIPHER_CTX_free FIPS_cipher_ctx_free
205 #define EVP_CIPHER_CTX_copy FIPS_cipher_ctx_copy
206 #define EVP_CIPHER_CTX_set_key_length FIPS_cipher_ctx_set_key_length
207
208 #define DSA_SIG_new FIPS_dsa_sig_new
209 #define DSA_SIG_free FIPS_dsa_sig_free
210
211 #define ECDSA_SIG_new FIPS_ecdsa_sig_new
212 #define ECDSA_SIG_free FIPS_ecdsa_sig_free
213
214 #define ecdsa_check fips_ecdsa_check
215 #define ecdh_check fips_ecdh_check
216
217 #define RAND_bytes FIPS_rand_bytes
218 #define RAND_pseudo_bytes FIPS_rand_pseudo_bytes
219 #define RAND_add FIPS_rand_add
220 #define RAND_seed FIPS_rand_seed
221 #define RAND_status FIPS_rand_status
222
223 #endif
224
225 /* BEGIN ERROR CODES */
226 /* The following lines are auto generated by the script mkerr.pl. Any changes
227  * made after this point may be overwritten when the script is next run.
228  */
229 void ERR_load_FIPS_strings(void);
230
231 /* Error codes for the FIPS functions. */
232
233 /* Function codes. */
234 #define FIPS_F_DH_BUILTIN_GENPARAMS                      100
235 #define FIPS_F_DSA_BUILTIN_PARAMGEN                      101
236 #define FIPS_F_DSA_BUILTIN_PARAMGEN2                     102
237 #define FIPS_F_DSA_DO_SIGN                               103
238 #define FIPS_F_DSA_DO_VERIFY                             104
239 #define FIPS_F_FIPS_CHECK_DSA                            105
240 #define FIPS_F_FIPS_CHECK_EC                             106
241 #define FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT             107
242 #define FIPS_F_FIPS_CHECK_RSA                            108
243 #define FIPS_F_FIPS_CIPHERINIT                           109
244 #define FIPS_F_FIPS_DIGESTINIT                           110
245 #define FIPS_F_FIPS_DRBG_BYTES                           111
246 #define FIPS_F_FIPS_DRBG_CPRNG_TEST                      112
247 #define FIPS_F_FIPS_DRBG_GENERATE                        113
248 #define FIPS_F_FIPS_DRBG_HEALTH_CHECK                    114
249 #define FIPS_F_FIPS_DRBG_INIT                            115
250 #define FIPS_F_FIPS_DRBG_INSTANTIATE                     116
251 #define FIPS_F_FIPS_DRBG_NEW                             117
252 #define FIPS_F_FIPS_DRBG_RESEED                          118
253 #define FIPS_F_FIPS_DRBG_SINGLE_KAT                      119
254 #define FIPS_F_FIPS_MODE_SET                             120
255 #define FIPS_F_FIPS_PKEY_SIGNATURE_TEST                  121
256 #define FIPS_F_FIPS_RAND_ADD                             122
257 #define FIPS_F_FIPS_RAND_BYTES                           123
258 #define FIPS_F_FIPS_RAND_PSEUDO_BYTES                    124
259 #define FIPS_F_FIPS_RAND_SEED                            125
260 #define FIPS_F_FIPS_RAND_SET_METHOD                      126
261 #define FIPS_F_FIPS_RAND_STATUS                          127
262 #define FIPS_F_FIPS_SELFTEST_AES                         128
263 #define FIPS_F_FIPS_SELFTEST_AES_GCM                     129
264 #define FIPS_F_FIPS_SELFTEST_CMAC                        130
265 #define FIPS_F_FIPS_SELFTEST_DES                         131
266 #define FIPS_F_FIPS_SELFTEST_DSA                         132
267 #define FIPS_F_FIPS_SELFTEST_ECDSA                       133
268 #define FIPS_F_FIPS_SELFTEST_HMAC                        134
269 #define FIPS_F_FIPS_SELFTEST_SHA1                        135
270 #define FIPS_F_FIPS_SELFTEST_X931                        136
271 #define FIPS_F_HASH_FINAL                                137
272 #define FIPS_F_RSA_BUILTIN_KEYGEN                        138
273 #define FIPS_F_RSA_EAY_PRIVATE_DECRYPT                   139
274 #define FIPS_F_RSA_EAY_PRIVATE_ENCRYPT                   140
275 #define FIPS_F_RSA_EAY_PUBLIC_DECRYPT                    141
276 #define FIPS_F_RSA_EAY_PUBLIC_ENCRYPT                    142
277 #define FIPS_F_RSA_X931_GENERATE_KEY_EX                  143
278
279 /* Reason codes. */
280 #define FIPS_R_ADDITIONAL_INPUT_TOO_LONG                 100
281 #define FIPS_R_ALREADY_INSTANTIATED                      101
282 #define FIPS_R_CONTRADICTING_EVIDENCE                    102
283 #define FIPS_R_DRBG_STUCK                                103
284 #define FIPS_R_ENTROPY_ERROR_UNDETECTED                  104
285 #define FIPS_R_ENTROPY_NOT_REQUESTED_FOR_RESEED          105
286 #define FIPS_R_ERROR_INITIALISING_DRBG                   106
287 #define FIPS_R_ERROR_INSTANTIATING_DRBG                  107
288 #define FIPS_R_ERROR_RETRIEVING_ADDITIONAL_INPUT         108
289 #define FIPS_R_ERROR_RETRIEVING_ENTROPY                  109
290 #define FIPS_R_ERROR_RETRIEVING_NONCE                    110
291 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH                111
292 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED 112
293 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING 113
294 #define FIPS_R_FIPS_MODE_ALREADY_SET                     114
295 #define FIPS_R_FIPS_SELFTEST_FAILED                      115
296 #define FIPS_R_FUNCTION_ERROR                            116
297 #define FIPS_R_GENERATE_ERROR                            117
298 #define FIPS_R_GENERATE_ERROR_UNDETECTED                 118
299 #define FIPS_R_INSTANTIATE_ERROR                         119
300 #define FIPS_R_INSUFFICIENT_SECURITY_STRENGTH            120
301 #define FIPS_R_INTERNAL_ERROR                            121
302 #define FIPS_R_INVALID_KEY_LENGTH                        122
303 #define FIPS_R_IN_ERROR_STATE                            123
304 #define FIPS_R_KEY_TOO_SHORT                             124
305 #define FIPS_R_NON_FIPS_METHOD                           125
306 #define FIPS_R_NOT_INSTANTIATED                          126
307 #define FIPS_R_PAIRWISE_TEST_FAILED                      127
308 #define FIPS_R_PERSONALISATION_ERROR_UNDETECTED          128
309 #define FIPS_R_PERSONALISATION_STRING_TOO_LONG           129
310 #define FIPS_R_REQUEST_LENGTH_ERROR_UNDETECTED           130
311 #define FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG                131
312 #define FIPS_R_RESEED_COUNTER_ERROR                      132
313 #define FIPS_R_RESEED_ERROR                              133
314 #define FIPS_R_SELFTEST_FAILED                           134
315 #define FIPS_R_SELFTEST_FAILURE                          135
316 #define FIPS_R_STRENGTH_ERROR_UNDETECTED                 136
317 #define FIPS_R_TEST_FAILURE                              137
318 #define FIPS_R_UNINSTANTIATE_ERROR                       141
319 #define FIPS_R_UNINSTANTIATE_ZEROISE_ERROR               138
320 #define FIPS_R_UNSUPPORTED_DRBG_TYPE                     139
321 #define FIPS_R_UNSUPPORTED_PLATFORM                      140
322
323 #ifdef  __cplusplus
324 }
325 #endif
326 #endif