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