fips/utl/fips_md.c

   1 /* fips/evp/fips_md.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58 /* ====================================================================
  59  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111
 112 /* Minimal standalone FIPS versions of Digest operations */
 113
 114 #define OPENSSL_FIPSAPI
 115
 116 #include <stdio.h>
 117 #include <string.h>
 118 #include <openssl/objects.h>
 119 #include <openssl/evp.h>
 120 #include <openssl/err.h>
 121 #include <openssl/fips.h>
 122
 123 void FIPS_md_ctx_init(EVP_MD_CTX *ctx)
 124         {
 125         memset(ctx,'\0',sizeof *ctx);
 126         }
 127
 128 EVP_MD_CTX *FIPS_md_ctx_create(void)
 129         {
 130         EVP_MD_CTX *ctx=OPENSSL_malloc(sizeof *ctx);
 131
 132         if (ctx)
 133                 FIPS_md_ctx_init(ctx);
 134
 135         return ctx;
 136         }
 137
 138 /* The purpose of these is to trap programs that attempt to use non FIPS
 139  * algorithms in FIPS mode and ignore the errors.
 140  */
 141
 142 static int bad_init(EVP_MD_CTX *ctx)
 143         { FIPS_ERROR_IGNORED("Digest init"); return 0;}
 144
 145 static int bad_update(EVP_MD_CTX *ctx,const void *data,size_t count)
 146         { FIPS_ERROR_IGNORED("Digest update"); return 0;}
 147
 148 static int bad_final(EVP_MD_CTX *ctx,unsigned char *md)
 149         { FIPS_ERROR_IGNORED("Digest Final"); return 0;}
 150
 151 static const EVP_MD bad_md =
 152         {
 153         0,
 154         0,
 155         0,
 156         0,
 157         bad_init,
 158         bad_update,
 159         bad_final,
 160         NULL,
 161         NULL,
 162         NULL,
 163         0,
 164         {0,0,0,0},
 165         };
 166
 167 int FIPS_digestinit(EVP_MD_CTX *ctx, const EVP_MD *type)
 168         {
 169         M_EVP_MD_CTX_clear_flags(ctx,EVP_MD_CTX_FLAG_CLEANED);
 170         if(FIPS_selftest_failed())
 171                 {
 172                 FIPSerr(FIPS_F_FIPS_DIGESTINIT,FIPS_R_FIPS_SELFTEST_FAILED);
 173                 ctx->digest = &bad_md;
 174                 ctx->update = bad_update;
 175                 return 0;
 176                 }
 177         if(FIPS_module_mode() && !(type->flags & EVP_MD_FLAG_FIPS) &&
 178                 !(ctx->flags & EVP_MD_CTX_FLAG_NON_FIPS_ALLOW))
 179                 {
 180                 EVPerr(EVP_F_FIPS_DIGESTINIT, EVP_R_DISABLED_FOR_FIPS);
 181                 ctx->digest = &bad_md;
 182                 ctx->update = bad_update;
 183                 return 0;
 184                 }
 185         if (ctx->digest != type)
 186                 {
 187                 if (ctx->digest && ctx->digest->ctx_size)
 188                         OPENSSL_free(ctx->md_data);
 189                 ctx->digest=type;
 190                 if (!(ctx->flags & EVP_MD_CTX_FLAG_NO_INIT) && type->ctx_size)
 191                         {
 192                         ctx->update = type->update;
 193                         ctx->md_data=OPENSSL_malloc(type->ctx_size);
 194                         if (ctx->md_data == NULL)
 195                                 {
 196                                 EVPerr(EVP_F_FIPS_DIGESTINIT,
 197                                                         ERR_R_MALLOC_FAILURE);
 198                                 return 0;
 199                                 }
 200                         }
 201                 }
 202         if (ctx->flags & EVP_MD_CTX_FLAG_NO_INIT)
 203                 return 1;
 204         return ctx->digest->init(ctx);
 205         }
 206
 207 int FIPS_digestupdate(EVP_MD_CTX *ctx, const void *data, size_t count)
 208         {
 209         if (FIPS_selftest_failed())
 210                 {
 211                 FIPSerr(FIPS_F_FIPS_DIGESTUPDATE, FIPS_R_SELFTEST_FAILED);
 212                 return 0;
 213                 }
 214         return ctx->update(ctx,data,count);
 215         }
 216
 217 /* The caller can assume that this removes any secret data from the context */
 218 int FIPS_digestfinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
 219         {
 220         int ret;
 221
 222         if (FIPS_selftest_failed())
 223                 {
 224                 FIPSerr(FIPS_F_FIPS_DIGESTFINAL, FIPS_R_SELFTEST_FAILED);
 225                 return 0;
 226                 }
 227
 228         OPENSSL_assert(ctx->digest->md_size <= EVP_MAX_MD_SIZE);
 229         ret=ctx->digest->final(ctx,md);
 230         if (size != NULL)
 231                 *size=ctx->digest->md_size;
 232         if (ctx->digest->cleanup)
 233                 {
 234                 ctx->digest->cleanup(ctx);
 235                 M_EVP_MD_CTX_set_flags(ctx,EVP_MD_CTX_FLAG_CLEANED);
 236                 }
 237         memset(ctx->md_data,0,ctx->digest->ctx_size);
 238         return ret;
 239         }
 240
 241 int FIPS_digest(const void *data, size_t count,
 242                 unsigned char *md, unsigned int *size, const EVP_MD *type)
 243         {
 244         EVP_MD_CTX ctx;
 245         int ret;
 246
 247         FIPS_md_ctx_init(&ctx);
 248         M_EVP_MD_CTX_set_flags(&ctx,EVP_MD_CTX_FLAG_ONESHOT);
 249         ret=FIPS_digestinit(&ctx, type)
 250           && FIPS_digestupdate(&ctx, data, count)
 251           && FIPS_digestfinal(&ctx, md, size);
 252         FIPS_md_ctx_cleanup(&ctx);
 253
 254         return ret;
 255         }
 256
 257 void FIPS_md_ctx_destroy(EVP_MD_CTX *ctx)
 258         {
 259         FIPS_md_ctx_cleanup(ctx);
 260         OPENSSL_free(ctx);
 261         }
 262
 263 /* This call frees resources associated with the context */
 264 int FIPS_md_ctx_cleanup(EVP_MD_CTX *ctx)
 265         {
 266         /* Don't assume ctx->md_data was cleaned in FIPS_digest_Final,
 267          * because sometimes only copies of the context are ever finalised.
 268          */
 269         if (ctx->digest && ctx->digest->cleanup
 270             && !M_EVP_MD_CTX_test_flags(ctx,EVP_MD_CTX_FLAG_CLEANED))
 271                 ctx->digest->cleanup(ctx);
 272         if (ctx->digest && ctx->digest->ctx_size && ctx->md_data
 273             && !M_EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_REUSE))
 274                 {
 275                 OPENSSL_cleanse(ctx->md_data,ctx->digest->ctx_size);
 276                 OPENSSL_free(ctx->md_data);
 277                 }
 278         memset(ctx,'\0',sizeof *ctx);
 279
 280         return 1;
 281         }
 282
 283 int FIPS_md_ctx_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in)
 284         {
 285         unsigned char *tmp_buf;
 286         if ((in == NULL) || (in->digest == NULL))
 287                 {
 288                 EVPerr(EVP_F_FIPS_MD_CTX_COPY,EVP_R_INPUT_NOT_INITIALIZED);
 289                 return 0;
 290                 }
 291
 292         if (out->digest == in->digest)
 293                 {
 294                 tmp_buf = out->md_data;
 295                 M_EVP_MD_CTX_set_flags(out,EVP_MD_CTX_FLAG_REUSE);
 296                 }
 297         else tmp_buf = NULL;
 298         FIPS_md_ctx_cleanup(out);
 299         memcpy(out,in,sizeof *out);
 300
 301         if (in->md_data && out->digest->ctx_size)
 302                 {
 303                 if (tmp_buf)
 304                         out->md_data = tmp_buf;
 305                 else
 306                         {
 307                         out->md_data=OPENSSL_malloc(out->digest->ctx_size);
 308                         if (!out->md_data)
 309                                 {
 310                                 EVPerr(EVP_F_FIPS_MD_CTX_COPY,ERR_R_MALLOC_FAILURE);
 311                                 return 0;
 312                                 }
 313                         }
 314                 memcpy(out->md_data,in->md_data,out->digest->ctx_size);
 315                 }
 316
 317         out->update = in->update;
 318
 319         if (out->digest->copy)
 320                 return out->digest->copy(out,in);
 321
 322         return 1;
 323         }
 324
 325 const EVP_MD *FIPS_get_digestbynid(int nid)
 326         {
 327         switch (nid)
 328                 {
 329                 case NID_sha1:
 330                 return EVP_sha1();
 331
 332                 case NID_sha224:
 333                 return EVP_sha224();
 334
 335                 case NID_sha256:
 336                 return EVP_sha256();
 337
 338                 case NID_sha384:
 339                 return EVP_sha384();
 340
 341                 case NID_sha512:
 342                 return EVP_sha512();
 343
 344                 default:
 345                 return NULL;
 346                 }
 347         }