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