Implement FIPS CMAC.
[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 void FIPS_corrupt_sha1(void);
76 int FIPS_selftest_sha1(void);
77 void FIPS_corrupt_aes(void);
78 int FIPS_selftest_aes_gcm(void);
79 void FIPS_corrupt_aes_gcm(void);
80 int FIPS_selftest_aes(void);
81 void FIPS_corrupt_des(void);
82 int FIPS_selftest_des(void);
83 void FIPS_corrupt_rsa(void);
84 void FIPS_corrupt_rsa_keygen(void);
85 int FIPS_selftest_rsa(void);
86 void FIPS_corrupt_dsa(void);
87 void FIPS_corrupt_dsa_keygen(void);
88 int FIPS_selftest_dsa(void);
89 int FIPS_selftest_ecdsa(void);
90 void FIPS_corrupt_ecdsa(void);
91 void FIPS_corrupt_ec_keygen(void);
92 void FIPS_corrupt_rng(void);
93 void FIPS_corrupt_drbg(void);
94 void FIPS_rng_stick(void);
95 int FIPS_selftest_rng(void);
96 int FIPS_selftest_hmac(void);
97 int FIPS_selftest_drbg(void);
98 int FIPS_selftest_cmac(void);
99
100 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len);
101 int FIPS_check_incore_fingerprint(void);
102
103 int fips_pkey_signature_test(struct evp_pkey_st *pkey,
104                         const unsigned char *tbs, int tbslen,
105                         const unsigned char *kat, unsigned int katlen,
106                         const struct env_md_st *digest, int pad_mode,
107                         const char *fail_str);
108
109 int fips_cipher_test(struct evp_cipher_ctx_st *ctx,
110                         const struct evp_cipher_st *cipher,
111                         const unsigned char *key,
112                         const unsigned char *iv,
113                         const unsigned char *plaintext,
114                         const unsigned char *ciphertext,
115                         int len);
116
117 void fips_set_selftest_fail(void);
118 int fips_check_rsa(struct rsa_st *rsa);
119
120 void FIPS_set_locking_callbacks(void (*func)(int mode, int type,
121                                 const char *file,int line),
122                                 int (*add_cb)(int *pointer, int amount,
123                                         int type, const char *file, int line));
124
125 #define FIPS_ERROR_IGNORED(alg) OpenSSLDie(__FILE__, __LINE__, \
126                 alg " previous FIPS forbidden algorithm error ignored");
127
128 /* Where necessary redirect standard OpenSSL APIs to FIPS versions */
129
130 #if defined(OPENSSL_FIPSCANISTER) && defined(OPENSSL_FIPSAPI)
131
132 #define CRYPTO_lock FIPS_lock
133 #define CRYPTO_add_lock FIPS_add_lock
134 #define CRYPTO_malloc FIPS_malloc
135 #define CRYPTO_free FIPS_free
136
137 #define ERR_put_error FIPS_put_error
138 #define ERR_add_error_data FIPS_add_error_data
139
140 #define EVP_MD_CTX_init FIPS_md_ctx_init
141 #define EVP_MD_CTX_cleanup FIPS_md_ctx_cleanup
142 #define EVP_MD_CTX_create FIPS_md_ctx_create
143 #define EVP_MD_CTX_destroy FIPS_md_ctx_destroy
144 #define EVP_DigestInit_ex(ctx, type, impl) FIPS_digestinit(ctx, type)
145 #define EVP_DigestInit FIPS_digestinit
146 #define EVP_DigestUpdate FIPS_digestupdate
147 #define EVP_Digest(data, count, md, size, type, impl) \
148                         FIPS_digest(data, count, md, size, type)
149 #define EVP_DigestFinal_ex FIPS_digestfinal
150 #define EVP_MD_CTX_copy_ex FIPS_md_ctx_copy
151
152 #define EVP_CipherInit_ex(ctx, cipher, impl, key, iv, enc) \
153                                 FIPS_cipherinit(ctx, cipher, key, iv, enc)
154
155 #define EVP_CipherInit FIPS_cipherinit
156
157 #define EVP_CIPHER_CTX_init FIPS_cipher_ctx_init
158 #define EVP_CIPHER_CTX_cleanup FIPS_cipher_ctx_cleanup
159 #define EVP_Cipher FIPS_cipher
160 #define EVP_CIPHER_CTX_ctrl FIPS_cipher_ctx_ctrl
161 #define EVP_CIPHER_CTX_new FIPS_cipher_ctx_new
162 #define EVP_CIPHER_CTX_free FIPS_cipher_ctx_free
163 #define EVP_CIPHER_CTX_copy FIPS_cipher_ctx_copy
164 #define EVP_CIPHER_CTX_set_key_length FIPS_cipher_ctx_set_key_length
165
166 #define DSA_SIG_new FIPS_dsa_sig_new
167 #define DSA_SIG_free FIPS_dsa_sig_free
168
169 #define ECDSA_SIG_new FIPS_ecdsa_sig_new
170 #define ECDSA_SIG_free FIPS_ecdsa_sig_free
171
172 #define ecdsa_check fips_ecdsa_check
173 #define ecdh_check fips_ecdh_check
174
175 #endif
176
177 /* BEGIN ERROR CODES */
178 /* The following lines are auto generated by the script mkerr.pl. Any changes
179  * made after this point may be overwritten when the script is next run.
180  */
181 void ERR_load_FIPS_strings(void);
182
183 /* Error codes for the FIPS functions. */
184
185 /* Function codes. */
186 #define FIPS_F_DH_BUILTIN_GENPARAMS                      100
187 #define FIPS_F_DSA_BUILTIN_PARAMGEN                      101
188 #define FIPS_F_DSA_BUILTIN_PARAMGEN2                     126
189 #define FIPS_F_DSA_DO_SIGN                               102
190 #define FIPS_F_DSA_DO_VERIFY                             103
191 #define FIPS_F_EVP_CIPHERINIT_EX                         124
192 #define FIPS_F_EVP_DIGESTINIT_EX                         125
193 #define FIPS_F_FIPS_CHECK_DSA                            104
194 #define FIPS_F_FIPS_CHECK_EC                             129
195 #define FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT             105
196 #define FIPS_F_FIPS_CHECK_RSA                            106
197 #define FIPS_F_FIPS_CIPHERINIT                           128
198 #define FIPS_F_FIPS_DIGESTINIT                           127
199 #define FIPS_F_FIPS_DRBG_GENERATE                        132
200 #define FIPS_F_FIPS_DRBG_GENERATE_INTERNAL               138
201 #define FIPS_F_FIPS_DRBG_HEALTH_CHECK                    137
202 #define FIPS_F_FIPS_DRBG_INIT                            136
203 #define FIPS_F_FIPS_DRBG_INSTANTIATE                     133
204 #define FIPS_F_FIPS_DRBG_NEW                             134
205 #define FIPS_F_FIPS_DRBG_RESEED                          135
206 #define FIPS_F_FIPS_DSA_CHECK                            107
207 #define FIPS_F_FIPS_MODE_SET                             108
208 #define FIPS_F_FIPS_PKEY_SIGNATURE_TEST                  109
209 #define FIPS_F_FIPS_SELFTEST_AES                         110
210 #define FIPS_F_FIPS_SELFTEST_AES_GCM                     130
211 #define FIPS_F_FIPS_SELFTEST_CMAC                        139
212 #define FIPS_F_FIPS_SELFTEST_DES                         111
213 #define FIPS_F_FIPS_SELFTEST_DSA                         112
214 #define FIPS_F_FIPS_SELFTEST_ECDSA                       131
215 #define FIPS_F_FIPS_SELFTEST_HMAC                        113
216 #define FIPS_F_FIPS_SELFTEST_RNG                         114
217 #define FIPS_F_FIPS_SELFTEST_SHA1                        115
218 #define FIPS_F_HASH_FINAL                                123
219 #define FIPS_F_RSA_BUILTIN_KEYGEN                        116
220 #define FIPS_F_RSA_EAY_PRIVATE_DECRYPT                   117
221 #define FIPS_F_RSA_EAY_PRIVATE_ENCRYPT                   118
222 #define FIPS_F_RSA_EAY_PUBLIC_DECRYPT                    119
223 #define FIPS_F_RSA_EAY_PUBLIC_ENCRYPT                    120
224 #define FIPS_F_RSA_X931_GENERATE_KEY_EX                  121
225 #define FIPS_F_SSLEAY_RAND_BYTES                         122
226
227 /* Reason codes. */
228 #define FIPS_R_ADDITIONAL_INPUT_TOO_LONG                 118
229 #define FIPS_R_ALREADY_INSTANTIATED                      119
230 #define FIPS_R_CANNOT_READ_EXE                           103
231 #define FIPS_R_CANNOT_READ_EXE_DIGEST                    104
232 #define FIPS_R_CONTRADICTING_EVIDENCE                    114
233 #define FIPS_R_DRBG_STUCK                                142
234 #define FIPS_R_ENTROPY_ERROR_UNDETECTED                  133
235 #define FIPS_R_ENTROPY_NOT_REQUESTED_FOR_RESEED          134
236 #define FIPS_R_ERROR_INITIALISING_DRBG                   120
237 #define FIPS_R_ERROR_INSTANTIATING_DRBG                  121
238 #define FIPS_R_ERROR_RETRIEVING_ENTROPY                  122
239 #define FIPS_R_ERROR_RETRIEVING_NONCE                    123
240 #define FIPS_R_EXE_DIGEST_DOES_NOT_MATCH                 105
241 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH                110
242 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED 111
243 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING 112
244 #define FIPS_R_FIPS_MODE_ALREADY_SET                     102
245 #define FIPS_R_FIPS_SELFTEST_FAILED                      106
246 #define FIPS_R_FUNCTION_ERROR                            135
247 #define FIPS_R_GENERATE_ERROR                            124
248 #define FIPS_R_GENERATE_ERROR_UNDETECTED                 136
249 #define FIPS_R_INSTANTIATE_ERROR                         125
250 #define FIPS_R_INSUFFICIENT_SECURITY_STRENGTH            132
251 #define FIPS_R_INVALID_KEY_LENGTH                        109
252 #define FIPS_R_IN_ERROR_STATE                            126
253 #define FIPS_R_KEY_TOO_SHORT                             108
254 #define FIPS_R_NON_FIPS_METHOD                           100
255 #define FIPS_R_NOT_INSTANTIATED                          127
256 #define FIPS_R_PAIRWISE_TEST_FAILED                      107
257 #define FIPS_R_PERSONALISATION_ERROR_UNDETECTED          137
258 #define FIPS_R_PERSONALISATION_STRING_TOO_LONG           128
259 #define FIPS_R_REQUEST_LENGTH_ERROR_UNDETECTED           138
260 #define FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG                129
261 #define FIPS_R_RESEED_COUNTER_ERROR                      139
262 #define FIPS_R_RESEED_ERROR                              130
263 #define FIPS_R_RSA_DECRYPT_ERROR                         115
264 #define FIPS_R_RSA_ENCRYPT_ERROR                         116
265 #define FIPS_R_SELFTEST_FAILED                           101
266 #define FIPS_R_STRENGTH_ERROR_UNDETECTED                 140
267 #define FIPS_R_TEST_FAILURE                              117
268 #define FIPS_R_UNINSTANTIATE_ZEROISE_ERROR               141
269 #define FIPS_R_UNSUPPORTED_DRBG_TYPE                     131
270 #define FIPS_R_UNSUPPORTED_PLATFORM                      113
271
272 #ifdef  __cplusplus
273 }
274 #endif
275 #endif