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