crypto/openssl/crypto/evp/digest.c

   1 /* crypto/evp/digest.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 #include <stdio.h>
 113 #include "cryptlib.h"
 114 #include <openssl/objects.h>
 115 #include <openssl/evp.h>
 116 #ifndef OPENSSL_NO_ENGINE
 117 #include <openssl/engine.h>
 118 #endif
 119 #include "evp_locl.h"
 120
 121 void EVP_MD_CTX_init(EVP_MD_CTX *ctx)
 122         {
 123         memset(ctx,'\0',sizeof *ctx);
 124         }
 125
 126 EVP_MD_CTX *EVP_MD_CTX_create(void)
 127         {
 128         EVP_MD_CTX *ctx=OPENSSL_malloc(sizeof *ctx);
 129
 130         EVP_MD_CTX_init(ctx);
 131
 132         return ctx;
 133         }
 134
 135 int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type)
 136         {
 137         EVP_MD_CTX_init(ctx);
 138         return EVP_DigestInit_ex(ctx, type, NULL);
 139         }
 140
 141 #ifdef OPENSSL_FIPS
 142
 143 /* The purpose of these is to trap programs that attempt to use non FIPS
 144  * algorithms in FIPS mode and ignore the errors.
 145  */
 146
 147 static int bad_init(EVP_MD_CTX *ctx)
 148         { FIPS_ERROR_IGNORED("Digest init"); return 0;}
 149
 150 static int bad_update(EVP_MD_CTX *ctx,const void *data,size_t count)
 151         { FIPS_ERROR_IGNORED("Digest update"); return 0;}
 152
 153 static int bad_final(EVP_MD_CTX *ctx,unsigned char *md)
 154         { FIPS_ERROR_IGNORED("Digest Final"); return 0;}
 155
 156 static const EVP_MD bad_md =
 157         {
 158         0,
 159         0,
 160         0,
 161         0,
 162         bad_init,
 163         bad_update,
 164         bad_final,
 165         NULL,
 166         NULL,
 167         NULL,
 168         0,
 169         {0,0,0,0},
 170         };
 171
 172 #endif
 173
 174 #ifndef OPENSSL_NO_ENGINE
 175
 176 #ifdef OPENSSL_FIPS
 177
 178 static int do_engine_null(ENGINE *impl) { return 0;}
 179 static int do_evp_md_engine_null(EVP_MD_CTX *ctx,
 180                                 const EVP_MD **ptype, ENGINE *impl)
 181         { return 1; }
 182
 183 static int (*do_engine_init)(ENGINE *impl)
 184                 = do_engine_null;
 185
 186 static int (*do_engine_finish)(ENGINE *impl)
 187                 = do_engine_null;
 188
 189 static int (*do_evp_md_engine)
 190         (EVP_MD_CTX *ctx, const EVP_MD **ptype, ENGINE *impl)
 191                 = do_evp_md_engine_null;
 192
 193 void int_EVP_MD_set_engine_callbacks(
 194         int (*eng_md_init)(ENGINE *impl),
 195         int (*eng_md_fin)(ENGINE *impl),
 196         int (*eng_md_evp)
 197                 (EVP_MD_CTX *ctx, const EVP_MD **ptype, ENGINE *impl))
 198         {
 199         do_engine_init = eng_md_init;
 200         do_engine_finish = eng_md_fin;
 201         do_evp_md_engine = eng_md_evp;
 202         }
 203
 204 #else
 205
 206 #define do_engine_init  ENGINE_init
 207 #define do_engine_finish ENGINE_finish
 208
 209 static int do_evp_md_engine(EVP_MD_CTX *ctx, const EVP_MD **ptype, ENGINE *impl)
 210         {
 211         if (*ptype)
 212                 {
 213                 /* Ensure an ENGINE left lying around from last time is cleared
 214                  * (the previous check attempted to avoid this if the same
 215                  * ENGINE and EVP_MD could be used). */
 216                 if(ctx->engine)
 217                         ENGINE_finish(ctx->engine);
 218                 if(impl)
 219                         {
 220                         if (!ENGINE_init(impl))
 221                                 {
 222                                 EVPerr(EVP_F_DO_EVP_MD_ENGINE,EVP_R_INITIALIZATION_ERROR);
 223                                 return 0;
 224                                 }
 225                         }
 226                 else
 227                         /* Ask if an ENGINE is reserved for this job */
 228                         impl = ENGINE_get_digest_engine((*ptype)->type);
 229                 if(impl)
 230                         {
 231                         /* There's an ENGINE for this job ... (apparently) */
 232                         const EVP_MD *d = ENGINE_get_digest(impl, (*ptype)->type);
 233                         if(!d)
 234                                 {
 235                                 /* Same comment from evp_enc.c */
 236                                 EVPerr(EVP_F_DO_EVP_MD_ENGINE,EVP_R_INITIALIZATION_ERROR);
 237                                 return 0;
 238                                 }
 239                         /* We'll use the ENGINE's private digest definition */
 240                         *ptype = d;
 241                         /* Store the ENGINE functional reference so we know
 242                          * 'type' came from an ENGINE and we need to release
 243                          * it when done. */
 244                         ctx->engine = impl;
 245                         }
 246                 else
 247                         ctx->engine = NULL;
 248                 }
 249         else
 250         if(!ctx->digest)
 251                 {
 252                 EVPerr(EVP_F_DO_EVP_MD_ENGINE,EVP_R_NO_DIGEST_SET);
 253                 return 0;
 254                 }
 255         return 1;
 256         }
 257
 258 #endif
 259
 260 #endif
 261
 262 int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl)
 263         {
 264         M_EVP_MD_CTX_clear_flags(ctx,EVP_MD_CTX_FLAG_CLEANED);
 265 #ifdef OPENSSL_FIPS
 266         if(FIPS_selftest_failed())
 267                 {
 268                 FIPSerr(FIPS_F_EVP_DIGESTINIT_EX,FIPS_R_FIPS_SELFTEST_FAILED);
 269                 ctx->digest = &bad_md;
 270                 return 0;
 271                 }
 272 #endif
 273 #ifndef OPENSSL_NO_ENGINE
 274         /* Whether it's nice or not, "Inits" can be used on "Final"'d contexts
 275          * so this context may already have an ENGINE! Try to avoid releasing
 276          * the previous handle, re-querying for an ENGINE, and having a
 277          * reinitialisation, when it may all be unecessary. */
 278         if (ctx->engine && ctx->digest && (!type ||
 279                         (type && (type->type == ctx->digest->type))))
 280                 goto skip_to_init;
 281         if (!do_evp_md_engine(ctx, &type, impl))
 282                 return 0;
 283 #endif
 284         if (ctx->digest != type)
 285                 {
 286 #ifdef OPENSSL_FIPS
 287                 if (FIPS_mode())
 288                         {
 289                         if (!(type->flags & EVP_MD_FLAG_FIPS)
 290                          && !(ctx->flags & EVP_MD_CTX_FLAG_NON_FIPS_ALLOW))
 291                                 {
 292                                 EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_DISABLED_FOR_FIPS);
 293                                 ctx->digest = &bad_md;
 294                                 return 0;
 295                                 }
 296                         }
 297 #endif
 298                 if (ctx->digest && ctx->digest->ctx_size)
 299                         OPENSSL_free(ctx->md_data);
 300                 ctx->digest=type;
 301                 if (type->ctx_size)
 302                         ctx->md_data=OPENSSL_malloc(type->ctx_size);
 303                 }
 304 #ifndef OPENSSL_NO_ENGINE
 305         skip_to_init:
 306 #endif
 307         return ctx->digest->init(ctx);
 308         }
 309
 310 int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *data,
 311              size_t count)
 312         {
 313 #ifdef OPENSSL_FIPS
 314         FIPS_selftest_check();
 315 #endif
 316         return ctx->digest->update(ctx,data,count);
 317         }
 318
 319 /* The caller can assume that this removes any secret data from the context */
 320 int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
 321         {
 322         int ret;
 323         ret = EVP_DigestFinal_ex(ctx, md, size);
 324         EVP_MD_CTX_cleanup(ctx);
 325         return ret;
 326         }
 327
 328 /* The caller can assume that this removes any secret data from the context */
 329 int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
 330         {
 331         int ret;
 332 #ifdef OPENSSL_FIPS
 333         FIPS_selftest_check();
 334 #endif
 335
 336         OPENSSL_assert(ctx->digest->md_size <= EVP_MAX_MD_SIZE);
 337         ret=ctx->digest->final(ctx,md);
 338         if (size != NULL)
 339                 *size=ctx->digest->md_size;
 340         if (ctx->digest->cleanup)
 341                 {
 342                 ctx->digest->cleanup(ctx);
 343                 M_EVP_MD_CTX_set_flags(ctx,EVP_MD_CTX_FLAG_CLEANED);
 344                 }
 345         memset(ctx->md_data,0,ctx->digest->ctx_size);
 346         return ret;
 347         }
 348
 349 int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in)
 350         {
 351         EVP_MD_CTX_init(out);
 352         return EVP_MD_CTX_copy_ex(out, in);
 353         }
 354
 355 int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in)
 356         {
 357         unsigned char *tmp_buf;
 358         if ((in == NULL) || (in->digest == NULL))
 359                 {
 360                 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX,EVP_R_INPUT_NOT_INITIALIZED);
 361                 return 0;
 362                 }
 363 #ifndef OPENSSL_NO_ENGINE
 364         /* Make sure it's safe to copy a digest context using an ENGINE */
 365         if (in->engine && !do_engine_init(in->engine))
 366                 {
 367                 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX,ERR_R_ENGINE_LIB);
 368                 return 0;
 369                 }
 370 #endif
 371
 372         if (out->digest == in->digest)
 373                 {
 374                 tmp_buf = out->md_data;
 375                 M_EVP_MD_CTX_set_flags(out,EVP_MD_CTX_FLAG_REUSE);
 376                 }
 377         else tmp_buf = NULL;
 378         EVP_MD_CTX_cleanup(out);
 379         memcpy(out,in,sizeof *out);
 380
 381         if (out->digest->ctx_size)
 382                 {
 383                 if (tmp_buf) out->md_data = tmp_buf;
 384                 else out->md_data=OPENSSL_malloc(out->digest->ctx_size);
 385                 memcpy(out->md_data,in->md_data,out->digest->ctx_size);
 386                 }
 387
 388         if (out->digest->copy)
 389                 return out->digest->copy(out,in);
 390
 391         return 1;
 392         }
 393
 394 int EVP_Digest(const void *data, size_t count,
 395                 unsigned char *md, unsigned int *size, const EVP_MD *type, ENGINE *impl)
 396         {
 397         EVP_MD_CTX ctx;
 398         int ret;
 399
 400         EVP_MD_CTX_init(&ctx);
 401         M_EVP_MD_CTX_set_flags(&ctx,EVP_MD_CTX_FLAG_ONESHOT);
 402         ret=EVP_DigestInit_ex(&ctx, type, impl)
 403           && EVP_DigestUpdate(&ctx, data, count)
 404           && EVP_DigestFinal_ex(&ctx, md, size);
 405         EVP_MD_CTX_cleanup(&ctx);
 406
 407         return ret;
 408         }
 409
 410 void EVP_MD_CTX_destroy(EVP_MD_CTX *ctx)
 411         {
 412         EVP_MD_CTX_cleanup(ctx);
 413         OPENSSL_free(ctx);
 414         }
 415
 416 /* This call frees resources associated with the context */
 417 int EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx)
 418         {
 419         /* Don't assume ctx->md_data was cleaned in EVP_Digest_Final,
 420          * because sometimes only copies of the context are ever finalised.
 421          */
 422         if (ctx->digest && ctx->digest->cleanup
 423             && !M_EVP_MD_CTX_test_flags(ctx,EVP_MD_CTX_FLAG_CLEANED))
 424                 ctx->digest->cleanup(ctx);
 425         if (ctx->digest && ctx->digest->ctx_size && ctx->md_data
 426             && !M_EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_REUSE))
 427                 {
 428                 OPENSSL_cleanse(ctx->md_data,ctx->digest->ctx_size);
 429                 OPENSSL_free(ctx->md_data);
 430                 }
 431 #ifndef OPENSSL_NO_ENGINE
 432         if(ctx->engine)
 433                 /* The EVP_MD we used belongs to an ENGINE, release the
 434                  * functional reference we held for this reason. */
 435                 do_engine_finish(ctx->engine);
 436 #endif
 437         memset(ctx,'\0',sizeof *ctx);
 438
 439         return 1;
 440         }