crypto/evp/digest.c

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57 /* ====================================================================
  58  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
  59  *
  60  * Redistribution and use in source and binary forms, with or without
  61  * modification, are permitted provided that the following conditions
  62  * are met:
  63  *
  64  * 1. Redistributions of source code must retain the above copyright
  65  *    notice, this list of conditions and the following disclaimer.
  66  *
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in
  69  *    the documentation and/or other materials provided with the
  70  *    distribution.
  71  *
  72  * 3. All advertising materials mentioning features or use of this
  73  *    software must display the following acknowledgment:
  74  *    "This product includes software developed by the OpenSSL Project
  75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76  *
  77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78  *    endorse or promote products derived from this software without
  79  *    prior written permission. For written permission, please contact
  80  *    openssl-core@openssl.org.
  81  *
  82  * 5. Products derived from this software may not be called "OpenSSL"
  83  *    nor may "OpenSSL" appear in their names without prior written
  84  *    permission of the OpenSSL Project.
  85  *
  86  * 6. Redistributions of any form whatsoever must retain the following
  87  *    acknowledgment:
  88  *    "This product includes software developed by the OpenSSL Project
  89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90  *
  91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 102  * OF THE POSSIBILITY OF SUCH DAMAGE.
 103  * ====================================================================
 104  *
 105  * This product includes cryptographic software written by Eric Young
 106  * (eay@cryptsoft.com).  This product includes software written by Tim
 107  * Hudson (tjh@cryptsoft.com).
 108  *
 109  */
 110
 111 #include <stdio.h>
 112 #include "internal/cryptlib.h"
 113 #include <openssl/objects.h>
 114 #include <openssl/evp.h>
 115 #ifndef OPENSSL_NO_ENGINE
 116 # include <openssl/engine.h>
 117 #endif
 118 #include "internal/evp_int.h"
 119 #include "evp_locl.h"
 120
 121 /* This call frees resources associated with the context */
 122 int EVP_MD_CTX_reset(EVP_MD_CTX *ctx)
 123 {
 124     if (ctx == NULL)
 125         return 1;
 126
 127     /*
 128      * Don't assume ctx->md_data was cleaned in EVP_Digest_Final, because
 129      * sometimes only copies of the context are ever finalised.
 130      */
 131     if (ctx->digest && ctx->digest->cleanup
 132         && !EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_CLEANED))
 133         ctx->digest->cleanup(ctx);
 134     if (ctx->digest && ctx->digest->ctx_size && ctx->md_data
 135         && !EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_REUSE)) {
 136         OPENSSL_clear_free(ctx->md_data, ctx->digest->ctx_size);
 137     }
 138     EVP_PKEY_CTX_free(ctx->pctx);
 139 #ifndef OPENSSL_NO_ENGINE
 140     if (ctx->engine)
 141         /*
 142          * The EVP_MD we used belongs to an ENGINE, release the functional
 143          * reference we held for this reason.
 144          */
 145         ENGINE_finish(ctx->engine);
 146 #endif
 147     memset(ctx, 0, sizeof(*ctx));
 148
 149     return 1;
 150 }
 151
 152 EVP_MD_CTX *EVP_MD_CTX_new(void)
 153 {
 154     return OPENSSL_zalloc(sizeof(EVP_MD_CTX));
 155 }
 156
 157 void EVP_MD_CTX_free(EVP_MD_CTX *ctx)
 158 {
 159     EVP_MD_CTX_reset(ctx);
 160     OPENSSL_free(ctx);
 161 }
 162
 163 int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type)
 164 {
 165     EVP_MD_CTX_reset(ctx);
 166     return EVP_DigestInit_ex(ctx, type, NULL);
 167 }
 168
 169 int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl)
 170 {
 171     EVP_MD_CTX_clear_flags(ctx, EVP_MD_CTX_FLAG_CLEANED);
 172 #ifndef OPENSSL_NO_ENGINE
 173     /*
 174      * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
 175      * this context may already have an ENGINE! Try to avoid releasing the
 176      * previous handle, re-querying for an ENGINE, and having a
 177      * reinitialisation, when it may all be unnecessary.
 178      */
 179     if (ctx->engine && ctx->digest && (!type ||
 180                                        (type
 181                                         && (type->type ==
 182                                             ctx->digest->type))))
 183         goto skip_to_init;
 184     if (type) {
 185         /*
 186          * Ensure an ENGINE left lying around from last time is cleared (the
 187          * previous check attempted to avoid this if the same ENGINE and
 188          * EVP_MD could be used).
 189          */
 190         if (ctx->engine)
 191             ENGINE_finish(ctx->engine);
 192         if (impl) {
 193             if (!ENGINE_init(impl)) {
 194                 EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 195                 return 0;
 196             }
 197         } else
 198             /* Ask if an ENGINE is reserved for this job */
 199             impl = ENGINE_get_digest_engine(type->type);
 200         if (impl) {
 201             /* There's an ENGINE for this job ... (apparently) */
 202             const EVP_MD *d = ENGINE_get_digest(impl, type->type);
 203             if (!d) {
 204                 /* Same comment from evp_enc.c */
 205                 EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 206                 ENGINE_finish(impl);
 207                 return 0;
 208             }
 209             /* We'll use the ENGINE's private digest definition */
 210             type = d;
 211             /*
 212              * Store the ENGINE functional reference so we know 'type' came
 213              * from an ENGINE and we need to release it when done.
 214              */
 215             ctx->engine = impl;
 216         } else
 217             ctx->engine = NULL;
 218     } else {
 219         if (!ctx->digest) {
 220             EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_NO_DIGEST_SET);
 221             return 0;
 222         }
 223         type = ctx->digest;
 224     }
 225 #endif
 226     if (ctx->digest != type) {
 227         if (ctx->digest && ctx->digest->ctx_size)
 228             OPENSSL_free(ctx->md_data);
 229         ctx->digest = type;
 230         if (!(ctx->flags & EVP_MD_CTX_FLAG_NO_INIT) && type->ctx_size) {
 231             ctx->update = type->update;
 232             ctx->md_data = OPENSSL_zalloc(type->ctx_size);
 233             if (ctx->md_data == NULL) {
 234                 EVPerr(EVP_F_EVP_DIGESTINIT_EX, ERR_R_MALLOC_FAILURE);
 235                 return 0;
 236             }
 237         }
 238     }
 239 #ifndef OPENSSL_NO_ENGINE
 240  skip_to_init:
 241 #endif
 242     if (ctx->pctx) {
 243         int r;
 244         r = EVP_PKEY_CTX_ctrl(ctx->pctx, -1, EVP_PKEY_OP_TYPE_SIG,
 245                               EVP_PKEY_CTRL_DIGESTINIT, 0, ctx);
 246         if (r <= 0 && (r != -2))
 247             return 0;
 248     }
 249     if (ctx->flags & EVP_MD_CTX_FLAG_NO_INIT)
 250         return 1;
 251     return ctx->digest->init(ctx);
 252 }
 253
 254 int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *data, size_t count)
 255 {
 256     return ctx->update(ctx, data, count);
 257 }
 258
 259 /* The caller can assume that this removes any secret data from the context */
 260 int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
 261 {
 262     int ret;
 263     ret = EVP_DigestFinal_ex(ctx, md, size);
 264     EVP_MD_CTX_reset(ctx);
 265     return ret;
 266 }
 267
 268 /* The caller can assume that this removes any secret data from the context */
 269 int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
 270 {
 271     int ret;
 272
 273     OPENSSL_assert(ctx->digest->md_size <= EVP_MAX_MD_SIZE);
 274     ret = ctx->digest->final(ctx, md);
 275     if (size != NULL)
 276         *size = ctx->digest->md_size;
 277     if (ctx->digest->cleanup) {
 278         ctx->digest->cleanup(ctx);
 279         EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_CLEANED);
 280     }
 281     memset(ctx->md_data, 0, ctx->digest->ctx_size);
 282     return ret;
 283 }
 284
 285 int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in)
 286 {
 287     EVP_MD_CTX_reset(out);
 288     return EVP_MD_CTX_copy_ex(out, in);
 289 }
 290
 291 int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in)
 292 {
 293     unsigned char *tmp_buf;
 294     if ((in == NULL) || (in->digest == NULL)) {
 295         EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, EVP_R_INPUT_NOT_INITIALIZED);
 296         return 0;
 297     }
 298 #ifndef OPENSSL_NO_ENGINE
 299     /* Make sure it's safe to copy a digest context using an ENGINE */
 300     if (in->engine && !ENGINE_init(in->engine)) {
 301         EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, ERR_R_ENGINE_LIB);
 302         return 0;
 303     }
 304 #endif
 305
 306     if (out->digest == in->digest) {
 307         tmp_buf = out->md_data;
 308         EVP_MD_CTX_set_flags(out, EVP_MD_CTX_FLAG_REUSE);
 309     } else
 310         tmp_buf = NULL;
 311     EVP_MD_CTX_reset(out);
 312     memcpy(out, in, sizeof(*out));
 313
 314     /* Null these variables, since they are getting fixed up
 315      * properly below.  Anything else may cause a memleak and/or
 316      * double free if any of the memory allocations below fail
 317      */
 318     out->md_data = NULL;
 319     out->pctx = NULL;
 320
 321     if (in->md_data && out->digest->ctx_size) {
 322         if (tmp_buf)
 323             out->md_data = tmp_buf;
 324         else {
 325             out->md_data = OPENSSL_malloc(out->digest->ctx_size);
 326             if (out->md_data == NULL) {
 327                 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, ERR_R_MALLOC_FAILURE);
 328                 return 0;
 329             }
 330         }
 331         memcpy(out->md_data, in->md_data, out->digest->ctx_size);
 332     }
 333
 334     out->update = in->update;
 335
 336     if (in->pctx) {
 337         out->pctx = EVP_PKEY_CTX_dup(in->pctx);
 338         if (!out->pctx) {
 339             EVP_MD_CTX_reset(out);
 340             return 0;
 341         }
 342     }
 343
 344     if (out->digest->copy)
 345         return out->digest->copy(out, in);
 346
 347     return 1;
 348 }
 349
 350 int EVP_Digest(const void *data, size_t count,
 351                unsigned char *md, unsigned int *size, const EVP_MD *type,
 352                ENGINE *impl)
 353 {
 354     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
 355     int ret;
 356
 357     if (ctx == NULL)
 358         return 0;
 359     EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_ONESHOT);
 360     ret = EVP_DigestInit_ex(ctx, type, impl)
 361         && EVP_DigestUpdate(ctx, data, count)
 362         && EVP_DigestFinal_ex(ctx, md, size);
 363     EVP_MD_CTX_free(ctx);
 364
 365     return ret;
 366 }
 367
 368 int EVP_MD_CTX_ctrl(EVP_MD_CTX *ctx, int cmd, int p1, void *p2)
 369 {
 370     if (ctx->digest && ctx->digest->md_ctrl) {
 371         int ret = ctx->digest->md_ctrl(ctx, cmd, p1, p2);
 372         if (ret <= 0)
 373             return 0;
 374         return 1;
 375     }
 376     return 0;
 377 }