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