fips/fips.h

   1 /* ====================================================================
   2  * Copyright (c) 2011 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 ec_key_st;
  64 struct rsa_st;
  65 struct evp_pkey_st;
  66 struct env_md_st;
  67 struct evp_cipher_st;
  68 struct evp_cipher_ctx_st;
  69
  70 int FIPS_module_mode_set(int onoff);
  71 int FIPS_module_mode(void);
  72 const void *FIPS_rand_check(void);
  73 int FIPS_selftest(void);
  74 int FIPS_selftest_failed(void);
  75 void FIPS_selftest_check(void);
  76 int FIPS_selftest_sha1(void);
  77 int FIPS_selftest_aes_ccm(void);
  78 int FIPS_selftest_aes_gcm(void);
  79 int FIPS_selftest_aes_xts(void);
  80 int FIPS_selftest_aes(void);
  81 int FIPS_selftest_des(void);
  82 int FIPS_selftest_rsa(void);
  83 int FIPS_selftest_dsa(void);
  84 int FIPS_selftest_ecdsa(void);
  85 void FIPS_corrupt_drbg(void);
  86 void FIPS_x931_stick(void);
  87 void FIPS_drbg_stick(void);
  88 int FIPS_selftest_x931(void);
  89 int FIPS_selftest_hmac(void);
  90 int FIPS_selftest_drbg(void);
  91 int FIPS_selftest_cmac(void);
  92
  93 unsigned int FIPS_incore_fingerprint(unsigned char *sig,unsigned int len);
  94 int FIPS_check_incore_fingerprint(void);
  95
  96 void fips_set_selftest_fail(void);
  97 int fips_check_rsa(struct rsa_st *rsa);
  98 int fips_check_rsa_prng(struct rsa_st *rsa, int bits);
  99 int fips_check_dsa_prng(struct dsa_st *dsa, size_t L, size_t N);
 100 int fips_check_ec_prng(struct ec_key_st *ec);
 101
 102 void FIPS_set_locking_callbacks(void (*func)(int mode, int type,
 103                                 const char *file,int line),
 104                                 int (*add_cb)(int *pointer, int amount,
 105                                         int type, const char *file, int line));
 106
 107 void FIPS_set_malloc_callbacks(
 108                 void *(*malloc_cb)(int num, const char *file, int line),
 109                 void (*free_cb)(void *));
 110
 111 void FIPS_get_timevec(unsigned char *buf, unsigned long *pctr);
 112
 113 /* POST callback operation value: */
 114 /* All tests started */
 115 #define FIPS_POST_BEGIN         1
 116 /* All tests end: result in id */
 117 #define FIPS_POST_END           2
 118 /* One individual test started */
 119 #define FIPS_POST_STARTED       3
 120 /* Individual test success */
 121 #define FIPS_POST_SUCCESS       4
 122 /* Individual test failure */
 123 #define FIPS_POST_FAIL          5
 124 /* Induce failure in test if zero return */
 125 #define FIPS_POST_CORRUPT       6
 126
 127 /* Test IDs */
 128 /* HMAC integrity test */
 129 #define FIPS_TEST_INTEGRITY     1
 130 /* Digest test */
 131 #define FIPS_TEST_DIGEST        2
 132 /* Symmetric cipher test */
 133 #define FIPS_TEST_CIPHER        3
 134 /* Public key signature test */
 135 #define FIPS_TEST_SIGNATURE     4
 136 /* HMAC test */
 137 #define FIPS_TEST_HMAC          5
 138 /* CMAC test */
 139 #define FIPS_TEST_CMAC          6
 140 /* GCM test */
 141 #define FIPS_TEST_GCM           7
 142 /* CCM test */
 143 #define FIPS_TEST_CCM           8
 144 /* XTS test */
 145 #define FIPS_TEST_XTS           9
 146 /* X9.31 PRNG */
 147 #define FIPS_TEST_X931          10
 148 /* DRNB */
 149 #define FIPS_TEST_DRBG          11
 150 /* Keygen pairwise consistency test */
 151 #define FIPS_TEST_PAIRWISE      12
 152 /* Continuous PRNG test */
 153 #define FIPS_TEST_CONTINUOUS    13
 154
 155 void FIPS_post_set_callback(
 156         int (*post_cb)(int op, int id, int subid, void *ex));
 157
 158 #define FIPS_ERROR_IGNORED(alg) OpenSSLDie(__FILE__, __LINE__, \
 159                 alg " previous FIPS forbidden algorithm error ignored");
 160
 161 int fips_pkey_signature_test(int id, struct evp_pkey_st *pkey,
 162                         const unsigned char *tbs, size_t tbslen,
 163                         const unsigned char *kat, size_t katlen,
 164                         const struct env_md_st *digest, int pad_mode,
 165                         const char *fail_str);
 166
 167 int fips_cipher_test(int id, struct evp_cipher_ctx_st *ctx,
 168                         const struct evp_cipher_st *cipher,
 169                         const unsigned char *key,
 170                         const unsigned char *iv,
 171                         const unsigned char *plaintext,
 172                         const unsigned char *ciphertext,
 173                         int len);
 174
 175 #ifndef OPENSSL_FIPSCANISTER
 176
 177 int FIPS_digestinit(EVP_MD_CTX *ctx, const EVP_MD *type);
 178 int FIPS_digestupdate(EVP_MD_CTX *ctx, const void *data, size_t count);
 179 int FIPS_digestfinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size);
 180 int FIPS_md_ctx_cleanup(EVP_MD_CTX *ctx);
 181
 182 int FIPS_cipherinit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 183              const unsigned char *key, const unsigned char *iv, int enc);
 184 int FIPS_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 185                         const unsigned char *in, unsigned int inl);
 186 int FIPS_cipher_ctx_cleanup(EVP_CIPHER_CTX *c);
 187
 188 const EVP_CIPHER *FIPS_evp_aes_128_cbc(void);
 189 const EVP_CIPHER *FIPS_evp_aes_128_ccm(void);
 190 const EVP_CIPHER *FIPS_evp_aes_128_cfb1(void);
 191 const EVP_CIPHER *FIPS_evp_aes_128_cfb128(void);
 192 const EVP_CIPHER *FIPS_evp_aes_128_cfb8(void);
 193 const EVP_CIPHER *FIPS_evp_aes_128_ctr(void);
 194 const EVP_CIPHER *FIPS_evp_aes_128_ecb(void);
 195 const EVP_CIPHER *FIPS_evp_aes_128_gcm(void);
 196 const EVP_CIPHER *FIPS_evp_aes_128_ofb(void);
 197 const EVP_CIPHER *FIPS_evp_aes_128_xts(void);
 198 const EVP_CIPHER *FIPS_evp_aes_192_cbc(void);
 199 const EVP_CIPHER *FIPS_evp_aes_192_ccm(void);
 200 const EVP_CIPHER *FIPS_evp_aes_192_cfb1(void);
 201 const EVP_CIPHER *FIPS_evp_aes_192_cfb128(void);
 202 const EVP_CIPHER *FIPS_evp_aes_192_cfb8(void);
 203 const EVP_CIPHER *FIPS_evp_aes_192_ctr(void);
 204 const EVP_CIPHER *FIPS_evp_aes_192_ecb(void);
 205 const EVP_CIPHER *FIPS_evp_aes_192_gcm(void);
 206 const EVP_CIPHER *FIPS_evp_aes_192_ofb(void);
 207 const EVP_CIPHER *FIPS_evp_aes_256_cbc(void);
 208 const EVP_CIPHER *FIPS_evp_aes_256_ccm(void);
 209 const EVP_CIPHER *FIPS_evp_aes_256_cfb1(void);
 210 const EVP_CIPHER *FIPS_evp_aes_256_cfb128(void);
 211 const EVP_CIPHER *FIPS_evp_aes_256_cfb8(void);
 212 const EVP_CIPHER *FIPS_evp_aes_256_ctr(void);
 213 const EVP_CIPHER *FIPS_evp_aes_256_ecb(void);
 214 const EVP_CIPHER *FIPS_evp_aes_256_gcm(void);
 215 const EVP_CIPHER *FIPS_evp_aes_256_ofb(void);
 216 const EVP_CIPHER *FIPS_evp_aes_256_xts(void);
 217 const EVP_CIPHER *FIPS_evp_des_ede(void);
 218 const EVP_CIPHER *FIPS_evp_des_ede3(void);
 219 const EVP_CIPHER *FIPS_evp_des_ede3_cbc(void);
 220 const EVP_CIPHER *FIPS_evp_des_ede3_cfb1(void);
 221 const EVP_CIPHER *FIPS_evp_des_ede3_cfb64(void);
 222 const EVP_CIPHER *FIPS_evp_des_ede3_cfb8(void);
 223 const EVP_CIPHER *FIPS_evp_des_ede3_ecb(void);
 224 const EVP_CIPHER *FIPS_evp_des_ede3_ofb(void);
 225 const EVP_CIPHER *FIPS_evp_des_ede_cbc(void);
 226 const EVP_CIPHER *FIPS_evp_des_ede_cfb64(void);
 227 const EVP_CIPHER *FIPS_evp_des_ede_ecb(void);
 228 const EVP_CIPHER *FIPS_evp_des_ede_ofb(void);
 229 const EVP_MD *FIPS_evp_sha1(void);
 230 const EVP_MD *FIPS_evp_sha224(void);
 231 const EVP_MD *FIPS_evp_sha256(void);
 232 const EVP_MD *FIPS_evp_sha384(void);
 233 const EVP_MD *FIPS_evp_sha512(void);
 234
 235 #endif
 236
 237 /* Where necessary redirect standard OpenSSL APIs to FIPS versions */
 238
 239 #if defined(OPENSSL_FIPSCANISTER) && defined(OPENSSL_FIPSAPI)
 240
 241 #define CRYPTO_lock FIPS_lock
 242 #define CRYPTO_add_lock FIPS_add_lock
 243 #define CRYPTO_malloc FIPS_malloc
 244 #define CRYPTO_free FIPS_free
 245
 246 #define ERR_put_error FIPS_put_error
 247 #define ERR_add_error_data FIPS_add_error_data
 248
 249 #define EVP_MD_CTX_init FIPS_md_ctx_init
 250 #define EVP_MD_CTX_cleanup FIPS_md_ctx_cleanup
 251 #define EVP_MD_CTX_create FIPS_md_ctx_create
 252 #define EVP_MD_CTX_destroy FIPS_md_ctx_destroy
 253 #define EVP_DigestInit_ex(ctx, type, impl) FIPS_digestinit(ctx, type)
 254 #define EVP_DigestInit FIPS_digestinit
 255 #define EVP_DigestUpdate FIPS_digestupdate
 256 #define EVP_Digest(data, count, md, size, type, impl) \
 257                         FIPS_digest(data, count, md, size, type)
 258 #define EVP_DigestFinal_ex FIPS_digestfinal
 259 #define EVP_MD_CTX_copy_ex FIPS_md_ctx_copy
 260
 261 #define EVP_CipherInit_ex(ctx, cipher, impl, key, iv, enc) \
 262                                 FIPS_cipherinit(ctx, cipher, key, iv, enc)
 263
 264 #define EVP_CipherInit FIPS_cipherinit
 265
 266 #define EVP_CIPHER_CTX_init FIPS_cipher_ctx_init
 267 #define EVP_CIPHER_CTX_cleanup FIPS_cipher_ctx_cleanup
 268 #define EVP_Cipher FIPS_cipher
 269 #define EVP_CIPHER_CTX_ctrl FIPS_cipher_ctx_ctrl
 270 #define EVP_CIPHER_CTX_new FIPS_cipher_ctx_new
 271 #define EVP_CIPHER_CTX_free FIPS_cipher_ctx_free
 272 #define EVP_CIPHER_CTX_copy FIPS_cipher_ctx_copy
 273 #define EVP_CIPHER_CTX_set_key_length FIPS_cipher_ctx_set_key_length
 274
 275 #define DSA_SIG_new FIPS_dsa_sig_new
 276 #define DSA_SIG_free FIPS_dsa_sig_free
 277
 278 #define ECDSA_SIG_new FIPS_ecdsa_sig_new
 279 #define ECDSA_SIG_free FIPS_ecdsa_sig_free
 280
 281 #define ecdsa_check fips_ecdsa_check
 282 #define ecdh_check fips_ecdh_check
 283
 284 #define RAND_bytes FIPS_rand_bytes
 285 #define RAND_pseudo_bytes FIPS_rand_pseudo_bytes
 286 #define RAND_add FIPS_rand_add
 287 #define RAND_seed FIPS_rand_seed
 288 #define RAND_status FIPS_rand_status
 289
 290 #endif
 291
 292 /* BEGIN ERROR CODES */
 293 /* The following lines are auto generated by the script mkerr.pl. Any changes
 294  * made after this point may be overwritten when the script is next run.
 295  */
 296 void ERR_load_FIPS_strings(void);
 297
 298 /* Error codes for the FIPS functions. */
 299
 300 /* Function codes. */
 301 #define FIPS_F_DH_BUILTIN_GENPARAMS                      100
 302 #define FIPS_F_DH_INIT                                   148
 303 #define FIPS_F_DSA_BUILTIN_PARAMGEN                      101
 304 #define FIPS_F_DSA_BUILTIN_PARAMGEN2                     102
 305 #define FIPS_F_DSA_DO_SIGN                               103
 306 #define FIPS_F_DSA_DO_VERIFY                             104
 307 #define FIPS_F_FIPS_CHECK_DSA                            105
 308 #define FIPS_F_FIPS_CHECK_DSA_PRNG                       151
 309 #define FIPS_F_FIPS_CHECK_EC                             106
 310 #define FIPS_F_FIPS_CHECK_EC_PRNG                        152
 311 #define FIPS_F_FIPS_CHECK_INCORE_FINGERPRINT             107
 312 #define FIPS_F_FIPS_CHECK_RSA                            108
 313 #define FIPS_F_FIPS_CHECK_RSA_PRNG                       150
 314 #define FIPS_F_FIPS_CIPHER                               160
 315 #define FIPS_F_FIPS_CIPHERINIT                           109
 316 #define FIPS_F_FIPS_CIPHER_CTX_CTRL                      161
 317 #define FIPS_F_FIPS_DIGESTFINAL                          158
 318 #define FIPS_F_FIPS_DIGESTINIT                           110
 319 #define FIPS_F_FIPS_DIGESTUPDATE                         159
 320 #define FIPS_F_FIPS_DRBG_BYTES                           111
 321 #define FIPS_F_FIPS_DRBG_CHECK                           146
 322 #define FIPS_F_FIPS_DRBG_CPRNG_TEST                      112
 323 #define FIPS_F_FIPS_DRBG_GENERATE                        113
 324 #define FIPS_F_FIPS_DRBG_HEALTH_CHECK                    114
 325 #define FIPS_F_FIPS_DRBG_INIT                            115
 326 #define FIPS_F_FIPS_DRBG_INSTANTIATE                     116
 327 #define FIPS_F_FIPS_DRBG_NEW                             117
 328 #define FIPS_F_FIPS_DRBG_RESEED                          118
 329 #define FIPS_F_FIPS_DRBG_SINGLE_KAT                      119
 330 #define FIPS_F_FIPS_DSA_SIGN_DIGEST                      154
 331 #define FIPS_F_FIPS_DSA_VERIFY_DIGEST                    155
 332 #define FIPS_F_FIPS_GET_ENTROPY                          147
 333 #define FIPS_F_FIPS_MODULE_MODE_SET                      120
 334 #define FIPS_F_FIPS_PKEY_SIGNATURE_TEST                  121
 335 #define FIPS_F_FIPS_RAND_ADD                             122
 336 #define FIPS_F_FIPS_RAND_BYTES                           123
 337 #define FIPS_F_FIPS_RAND_PSEUDO_BYTES                    124
 338 #define FIPS_F_FIPS_RAND_SEED                            125
 339 #define FIPS_F_FIPS_RAND_SET_METHOD                      126
 340 #define FIPS_F_FIPS_RAND_STATUS                          127
 341 #define FIPS_F_FIPS_RSA_SIGN_DIGEST                      156
 342 #define FIPS_F_FIPS_RSA_VERIFY_DIGEST                    157
 343 #define FIPS_F_FIPS_SELFTEST_AES                         128
 344 #define FIPS_F_FIPS_SELFTEST_AES_CCM                     145
 345 #define FIPS_F_FIPS_SELFTEST_AES_GCM                     129
 346 #define FIPS_F_FIPS_SELFTEST_AES_XTS                     144
 347 #define FIPS_F_FIPS_SELFTEST_CMAC                        130
 348 #define FIPS_F_FIPS_SELFTEST_DES                         131
 349 #define FIPS_F_FIPS_SELFTEST_DSA                         132
 350 #define FIPS_F_FIPS_SELFTEST_ECDSA                       133
 351 #define FIPS_F_FIPS_SELFTEST_HMAC                        134
 352 #define FIPS_F_FIPS_SELFTEST_SHA1                        135
 353 #define FIPS_F_FIPS_SELFTEST_X931                        136
 354 #define FIPS_F_FIPS_SET_PRNG_KEY                         153
 355 #define FIPS_F_HASH_FINAL                                137
 356 #define FIPS_F_RSA_BUILTIN_KEYGEN                        138
 357 #define FIPS_F_RSA_EAY_INIT                              149
 358 #define FIPS_F_RSA_EAY_PRIVATE_DECRYPT                   139
 359 #define FIPS_F_RSA_EAY_PRIVATE_ENCRYPT                   140
 360 #define FIPS_F_RSA_EAY_PUBLIC_DECRYPT                    141
 361 #define FIPS_F_RSA_EAY_PUBLIC_ENCRYPT                    142
 362 #define FIPS_F_RSA_X931_GENERATE_KEY_EX                  143
 363
 364 /* Reason codes. */
 365 #define FIPS_R_ADDITIONAL_INPUT_TOO_LONG                 100
 366 #define FIPS_R_ALREADY_INSTANTIATED                      101
 367 #define FIPS_R_CONTRADICTING_EVIDENCE                    102
 368 #define FIPS_R_DRBG_STUCK                                103
 369 #define FIPS_R_ENTROPY_ERROR_UNDETECTED                  104
 370 #define FIPS_R_ENTROPY_NOT_REQUESTED_FOR_RESEED          105
 371 #define FIPS_R_ENTROPY_SOURCE_STUCK                      142
 372 #define FIPS_R_ERROR_INITIALISING_DRBG                   106
 373 #define FIPS_R_ERROR_INSTANTIATING_DRBG                  107
 374 #define FIPS_R_ERROR_RETRIEVING_ADDITIONAL_INPUT         108
 375 #define FIPS_R_ERROR_RETRIEVING_ENTROPY                  109
 376 #define FIPS_R_ERROR_RETRIEVING_NONCE                    110
 377 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH                111
 378 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_NONPIC_RELOCATED 112
 379 #define FIPS_R_FINGERPRINT_DOES_NOT_MATCH_SEGMENT_ALIASING 113
 380 #define FIPS_R_FIPS_MODE_ALREADY_SET                     114
 381 #define FIPS_R_FIPS_SELFTEST_FAILED                      115
 382 #define FIPS_R_FUNCTION_ERROR                            116
 383 #define FIPS_R_GENERATE_ERROR                            117
 384 #define FIPS_R_GENERATE_ERROR_UNDETECTED                 118
 385 #define FIPS_R_INSTANTIATE_ERROR                         119
 386 #define FIPS_R_INSUFFICIENT_SECURITY_STRENGTH            120
 387 #define FIPS_R_INTERNAL_ERROR                            121
 388 #define FIPS_R_INVALID_KEY_LENGTH                        122
 389 #define FIPS_R_INVALID_PARAMETERS                        144
 390 #define FIPS_R_IN_ERROR_STATE                            123
 391 #define FIPS_R_KEY_TOO_SHORT                             124
 392 #define FIPS_R_NON_FIPS_METHOD                           125
 393 #define FIPS_R_NOT_INSTANTIATED                          126
 394 #define FIPS_R_PAIRWISE_TEST_FAILED                      127
 395 #define FIPS_R_PERSONALISATION_ERROR_UNDETECTED          128
 396 #define FIPS_R_PERSONALISATION_STRING_TOO_LONG           129
 397 #define FIPS_R_PRNG_STRENGTH_TOO_LOW                     143
 398 #define FIPS_R_REQUEST_LENGTH_ERROR_UNDETECTED           130
 399 #define FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG                131
 400 #define FIPS_R_RESEED_COUNTER_ERROR                      132
 401 #define FIPS_R_RESEED_ERROR                              133
 402 #define FIPS_R_SELFTEST_FAILED                           134
 403 #define FIPS_R_SELFTEST_FAILURE                          135
 404 #define FIPS_R_STRENGTH_ERROR_UNDETECTED                 136
 405 #define FIPS_R_TEST_FAILURE                              137
 406 #define FIPS_R_UNINSTANTIATE_ERROR                       141
 407 #define FIPS_R_UNINSTANTIATE_ZEROISE_ERROR               138
 408 #define FIPS_R_UNSUPPORTED_DRBG_TYPE                     139
 409 #define FIPS_R_UNSUPPORTED_PLATFORM                      140
 410
 411 #ifdef  __cplusplus
 412 }
 413 #endif
 414 #endif