fips/fips_post.c

   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 #define OPENSSL_FIPSAPI
  51
  52 #include <openssl/crypto.h>
  53 #include <openssl/rand.h>
  54 #include <openssl/fips_rand.h>
  55 #include <openssl/err.h>
  56 #include <openssl/bio.h>
  57 #include <openssl/hmac.h>
  58 #include <openssl/rsa.h>
  59 #include <openssl/dsa.h>
  60 #include <openssl/ecdsa.h>
  61 #include <string.h>
  62 #include <limits.h>
  63
  64 #ifdef OPENSSL_FIPS
  65
  66 /* Power on self test (POST) support functions */
  67
  68 #include <openssl/fips.h>
  69 #include "fips_locl.h"
  70
  71 /* POST notification callback */
  72
  73 int (*fips_post_cb)(int op, int id, int subid, void *ex);
  74
  75 void FIPS_post_set_callback(
  76         int (*post_cb)(int op, int id, int subid, void *ex))
  77         {
  78         fips_post_cb = post_cb;
  79         }
  80
  81 /* POST status: i.e. status of all tests */
  82 #define FIPS_POST_STATUS_NOT_STARTED    0
  83 #define FIPS_POST_STATUS_OK             1
  84 #define FIPS_POST_STATUS_RUNNING        2
  85 #define FIPS_POST_STATUS_FAILED         -1
  86 static int post_status = 0;
  87 /* Set to 1 if any test failed */
  88 static int post_failure = 0;
  89
  90 /* All tests started */
  91
  92 int fips_post_begin(void)
  93         {
  94         post_failure = 0;
  95         post_status = FIPS_POST_STATUS_NOT_STARTED;
  96         if (fips_post_cb)
  97                 if (!fips_post_cb(FIPS_POST_BEGIN, 0, 0, NULL))
  98                         return 0;
  99         post_status = FIPS_POST_STATUS_RUNNING;
 100         return 1;
 101         }
 102
 103 void fips_post_end(void)
 104         {
 105         if (post_failure)
 106                 {
 107                 post_status = FIPS_POST_STATUS_FAILED;
 108                 if(fips_post_cb)
 109                         fips_post_cb(FIPS_POST_END, 0, 0, NULL);
 110                 }
 111         else
 112                 {
 113                 post_status = FIPS_POST_STATUS_OK;
 114                 if (fips_post_cb)
 115                         fips_post_cb(FIPS_POST_END, 1, 0, NULL);
 116                 }
 117         }
 118
 119 /* A self test started */
 120 int fips_post_started(int id, int subid, void *ex)
 121         {
 122         if (fips_post_cb)
 123                 return fips_post_cb(FIPS_POST_STARTED, id, subid, ex);
 124         return 1;
 125         }
 126 /* A self test passed successfully */
 127 int fips_post_success(int id, int subid, void *ex)
 128         {
 129         if (fips_post_cb)
 130                 return fips_post_cb(FIPS_POST_SUCCESS, id, subid, ex);
 131         return 1;
 132         }
 133 /* A self test failed */
 134 int fips_post_failed(int id, int subid, void *ex)
 135         {
 136         post_failure = 1;
 137         if (fips_post_cb)
 138                 return fips_post_cb(FIPS_POST_FAIL, id, subid, ex);
 139         return 1;
 140         }
 141 /* Indicate if a self test failure should be induced */
 142 int fips_post_corrupt(int id, int subid, void *ex)
 143         {
 144         if (fips_post_cb)
 145                 return fips_post_cb(FIPS_POST_CORRUPT, id, subid, ex);
 146         return 1;
 147         }
 148 /* Note: if selftests running return status OK so their operation is
 149  * not interrupted. This will only happen while selftests are actually
 150  * running so will not interfere with normal operation.
 151  */
 152 int fips_post_status(void)
 153         {
 154         return post_status > 0 ? 1 : 0;
 155         }
 156 /* Run all selftests */
 157 int FIPS_selftest(void)
 158         {
 159         int rv = 1;
 160         fips_post_begin();
 161         if(!FIPS_check_incore_fingerprint())
 162                 rv = 0;
 163         if (!FIPS_selftest_drbg())
 164                 rv = 0;
 165         if (!FIPS_selftest_x931())
 166                 rv = 0;
 167         if (!FIPS_selftest_sha1())
 168                 rv = 0;
 169         if (!FIPS_selftest_hmac())
 170                 rv = 0;
 171         if (!FIPS_selftest_cmac())
 172                 rv = 0;
 173         if (!FIPS_selftest_aes())
 174                 rv = 0;
 175         if (!FIPS_selftest_aes_gcm())
 176                 rv = 0;
 177         if (!FIPS_selftest_aes_xts())
 178                 rv = 0;
 179         if (!FIPS_selftest_des())
 180                 rv = 0;
 181         if (!FIPS_selftest_rsa())
 182                 rv = 0;
 183         if (!FIPS_selftest_ecdsa())
 184                 rv = 0;
 185         if (!FIPS_selftest_dsa())
 186                 rv = 0;
 187         fips_post_end();
 188         return rv;
 189         }
 190
 191 /* Generalized public key test routine. Signs and verifies the data
 192  * supplied in tbs using mesage digest md and setting RSA padding mode
 193  * pad_mode. If the 'kat' parameter is not NULL it will
 194  * additionally check the signature matches it: a known answer test
 195  * The string "fail_str" is used for identification purposes in case
 196  * of failure. If "pkey" is NULL just perform a message digest check.
 197  */
 198
 199 int fips_pkey_signature_test(int id, EVP_PKEY *pkey,
 200                         const unsigned char *tbs, size_t tbslen,
 201                         const unsigned char *kat, size_t katlen,
 202                         const EVP_MD *digest, int pad_mode,
 203                         const char *fail_str)
 204         {
 205         int subid;
 206         void *ex = NULL;
 207         int ret = 0;
 208         unsigned char *sig = NULL;
 209         unsigned int siglen;
 210         static const unsigned char str1[]="12345678901234567890";
 211         DSA_SIG *dsig = NULL;
 212         ECDSA_SIG *esig = NULL;
 213         EVP_MD_CTX mctx;
 214         FIPS_md_ctx_init(&mctx);
 215
 216         if (tbs == NULL)
 217                 tbs = str1;
 218
 219         if (tbslen == 0)
 220                 tbslen = strlen((char *)tbs);
 221
 222         if (digest == NULL)
 223                 digest = EVP_sha256();
 224
 225         subid = M_EVP_MD_type(digest);
 226
 227
 228         if (!fips_post_started(id, subid, pkey))
 229                 return 1;
 230
 231         if (!pkey || pkey->type == EVP_PKEY_RSA)
 232                 {
 233                 size_t sigsize;
 234                 if (!pkey)
 235                         sigsize = EVP_MAX_MD_SIZE;
 236                 else
 237                         sigsize = RSA_size(pkey->pkey.rsa);
 238
 239                 sig = OPENSSL_malloc(sigsize);
 240                 if (!sig)
 241                         {
 242                         FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,ERR_R_MALLOC_FAILURE);
 243                         goto error;
 244                         }
 245                 }
 246
 247         if (!FIPS_digestinit(&mctx, digest))
 248                 goto error;
 249         if (!FIPS_digestupdate(&mctx, tbs, tbslen))
 250                 goto error;
 251
 252         if (!fips_post_corrupt(id, subid, pkey))
 253                 {
 254                 if (!FIPS_digestupdate(&mctx, tbs, 1))
 255                         goto error;
 256                 }
 257
 258         if (pkey == NULL)
 259                 {
 260                 if (!FIPS_digestfinal(&mctx, sig, &siglen))
 261                         goto error;
 262                 }
 263         else if (pkey->type == EVP_PKEY_RSA)
 264                 {
 265                 if (!FIPS_rsa_sign_ctx(pkey->pkey.rsa, &mctx,
 266                                         pad_mode, 0, NULL, sig, &siglen))
 267                         goto error;
 268                 }
 269         else if (pkey->type == EVP_PKEY_DSA)
 270                 {
 271                 dsig = FIPS_dsa_sign_ctx(pkey->pkey.dsa, &mctx);
 272                 if (!dsig)
 273                         goto error;
 274                 }
 275         else if (pkey->type == EVP_PKEY_EC)
 276                 {
 277                 esig = FIPS_ecdsa_sign_ctx(pkey->pkey.ec, &mctx);
 278                 if (!esig)
 279                         goto error;
 280                 }
 281
 282         if (kat && ((siglen != katlen) || memcmp(kat, sig, katlen)))
 283                 goto error;
 284 #if 0
 285         {
 286         /* Debug code to print out self test KAT discrepancies */
 287         unsigned int i;
 288         fprintf(stderr, "%s=", fail_str);
 289         for (i = 0; i < siglen; i++)
 290                         fprintf(stderr, "%02X", sig[i]);
 291         fprintf(stderr, "\n");
 292         goto error;
 293         }
 294 #endif
 295         /* If just digest test we've finished */
 296         if (pkey == NULL)
 297                 {
 298                 ret = 1;
 299                 /* Well actually sucess as we've set ret to 1 */
 300                 goto error;
 301                 }
 302         if (!FIPS_digestinit(&mctx, digest))
 303                 goto error;
 304         if (!FIPS_digestupdate(&mctx, tbs, tbslen))
 305                 goto error;
 306         if (pkey->type == EVP_PKEY_RSA)
 307                 {
 308                 ret = FIPS_rsa_verify_ctx(pkey->pkey.rsa, &mctx,
 309                                                 pad_mode, 0, NULL, sig, siglen);
 310                 }
 311         else if (pkey->type == EVP_PKEY_DSA)
 312                 {
 313                 ret = FIPS_dsa_verify_ctx(pkey->pkey.dsa, &mctx, dsig);
 314                 }
 315         else if (pkey->type == EVP_PKEY_EC)
 316                 {
 317                 ret = FIPS_ecdsa_verify_ctx(pkey->pkey.ec, &mctx, esig);
 318                 }
 319
 320         error:
 321         if (dsig != NULL)
 322                 FIPS_dsa_sig_free(dsig);
 323         if (esig != NULL)
 324                 FIPS_ecdsa_sig_free(esig);
 325         if (sig)
 326                 OPENSSL_free(sig);
 327         FIPS_md_ctx_cleanup(&mctx);
 328         if (ret != 1)
 329                 {
 330                 FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,FIPS_R_TEST_FAILURE);
 331                 if (fail_str)
 332                         FIPS_add_error_data(2, "Type=", fail_str);
 333                 fips_post_failed(id, subid, ex);
 334                 return 0;
 335                 }
 336         return fips_post_success(id, subid, pkey);
 337         }
 338
 339 /* Generalized symmetric cipher test routine. Encrypt data, verify result
 340  * against known answer, decrypt and compare with original plaintext.
 341  */
 342
 343 int fips_cipher_test(int id, EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 344                         const unsigned char *key,
 345                         const unsigned char *iv,
 346                         const unsigned char *plaintext,
 347                         const unsigned char *ciphertext,
 348                         int len)
 349         {
 350         unsigned char pltmp[FIPS_MAX_CIPHER_TEST_SIZE];
 351         unsigned char citmp[FIPS_MAX_CIPHER_TEST_SIZE];
 352         int subid = M_EVP_CIPHER_nid(cipher);
 353         int rv = 0;
 354         OPENSSL_assert(len <= FIPS_MAX_CIPHER_TEST_SIZE);
 355         memset(pltmp, 0, FIPS_MAX_CIPHER_TEST_SIZE);
 356         memset(citmp, 0, FIPS_MAX_CIPHER_TEST_SIZE);
 357
 358         if (!fips_post_started(id, subid, NULL))
 359                 return 1;
 360         if (FIPS_cipherinit(ctx, cipher, key, iv, 1) <= 0)
 361                 goto error;
 362         if (!FIPS_cipher(ctx, citmp, plaintext, len))
 363                 goto error;
 364         if (memcmp(citmp, ciphertext, len))
 365                 goto error;
 366         if (!fips_post_corrupt(id, subid, NULL))
 367                         citmp[0] ^= 0x1;
 368         if (FIPS_cipherinit(ctx, cipher, key, iv, 0) <= 0)
 369                 goto error;
 370         FIPS_cipher(ctx, pltmp, citmp, len);
 371         if (memcmp(pltmp, plaintext, len))
 372                 goto error;
 373         rv = 1;
 374         error:
 375         if (rv == 0)
 376                 {
 377                 fips_post_failed(id, subid, NULL);
 378                 return 0;
 379                 }
 380         return fips_post_success(id, subid, NULL);
 381         }
 382
 383 #endif