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