798cf9d0aa18e93d678a0539d85675cf38f1fd41
[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 #include <openssl/engine.h>
117
118 void EVP_MD_CTX_init(EVP_MD_CTX *ctx)
119         {
120         memset(ctx,'\0',sizeof *ctx);
121         }
122
123 EVP_MD_CTX *EVP_MD_CTX_create(void)
124         {
125         EVP_MD_CTX *ctx=OPENSSL_malloc(sizeof *ctx);
126
127         EVP_MD_CTX_init(ctx);
128
129         return ctx;
130         }
131
132 int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type)
133         {
134         EVP_MD_CTX_init(ctx);
135         return EVP_DigestInit_ex(ctx, type, NULL);
136         }
137
138 int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl)
139         {
140         EVP_MD_CTX_clear_flags(ctx,EVP_MD_CTX_FLAG_CLEANED);
141         /* Whether it's nice or not, "Inits" can be used on "Final"'d contexts
142          * so this context may already have an ENGINE! Try to avoid releasing
143          * the previous handle, re-querying for an ENGINE, and having a
144          * reinitialisation, when it may all be unecessary. */
145         if (ctx->engine && ctx->digest && (!type ||
146                         (type && (type->type == ctx->digest->type))))
147                 goto skip_to_init;
148         if (type)
149                 {
150                 /* Ensure an ENGINE left lying around from last time is cleared
151                  * (the previous check attempted to avoid this if the same
152                  * ENGINE and EVP_MD could be used). */
153                 if(ctx->engine)
154                         ENGINE_finish(ctx->engine);
155                 if(!impl)
156                         /* Ask if an ENGINE is reserved for this job */
157                         impl = ENGINE_get_digest_engine(type->type);
158                 if(impl)
159                         {
160                         /* There's an ENGINE for this job ... (apparently) */
161                         const EVP_MD *d = ENGINE_get_digest(impl, type->type);
162                         if(!d)
163                                 {
164                                 /* Same comment from evp_enc.c */
165                                 EVPerr(EVP_F_EVP_DIGESTINIT, EVP_R_INITIALIZATION_ERROR);
166                                 return 0;
167                                 }
168                         /* We'll use the ENGINE's private digest definition */
169                         type = d;
170                         /* Store the ENGINE functional reference so we know
171                          * 'type' came from an ENGINE and we need to release
172                          * it when done. */
173                         ctx->engine = impl;
174                         }
175                 else
176                         ctx->engine = NULL;
177                 }
178         else if(!ctx->digest)
179                 {
180                 EVPerr(EVP_F_EVP_DIGESTINIT, EVP_R_NO_DIGEST_SET);
181                 return 0;
182                 }
183         if (ctx->digest != type)
184                 {
185                 if (ctx->digest && ctx->digest->ctx_size)
186                         OPENSSL_free(ctx->md_data);
187                 ctx->digest=type;
188                 if (type->ctx_size)
189                         ctx->md_data=OPENSSL_malloc(type->ctx_size);
190                 }
191 skip_to_init:
192         return type->init(ctx);
193         }
194
195 int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *data,
196              unsigned int count)
197         {
198         return ctx->digest->update(ctx,data,(unsigned long)count);
199         }
200
201 /* The caller can assume that this removes any secret data from the context */
202 int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
203         {
204         int ret;
205         ret = EVP_DigestFinal_ex(ctx, md, size);
206         EVP_MD_CTX_cleanup(ctx);
207         return ret;
208         }
209
210 /* The caller can assume that this removes any secret data from the context */
211 int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
212         {
213         int ret;
214         ret=ctx->digest->final(ctx,md);
215         if (size != NULL)
216                 *size=ctx->digest->md_size;
217         if (ctx->digest->cleanup)
218                 {
219                 ctx->digest->cleanup(ctx);
220                 EVP_MD_CTX_set_flags(ctx,EVP_MD_CTX_FLAG_CLEANED);
221                 }
222         memset(ctx->md_data,0,ctx->digest->ctx_size);
223         return ret;
224         }
225
226 int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in)
227         {
228         EVP_MD_CTX_init(out);
229         return EVP_MD_CTX_copy_ex(out, in);
230         }
231
232 int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in)
233         {
234         if ((in == NULL) || (in->digest == NULL))
235                 {
236                 EVPerr(EVP_F_EVP_MD_CTX_COPY,EVP_R_INPUT_NOT_INITIALIZED);
237                 return 0;
238                 }
239         /* Make sure it's safe to copy a digest context using an ENGINE */
240         if (in->engine && !ENGINE_init(in->engine))
241                 {
242                 EVPerr(EVP_F_EVP_MD_CTX_COPY,ERR_R_ENGINE_LIB);
243                 return 0;
244                 }
245
246         EVP_MD_CTX_cleanup(out);
247         memcpy(out,in,sizeof *out);
248
249         if (out->digest->ctx_size)
250                 {
251                 out->md_data=OPENSSL_malloc(out->digest->ctx_size);
252                 memcpy(out->md_data,in->md_data,out->digest->ctx_size);
253                 }
254         
255         if (out->digest->copy)
256                 return out->digest->copy(out,in);
257         
258         return 1;
259         }
260
261 int EVP_Digest(void *data, unsigned int count,
262                 unsigned char *md, unsigned int *size, const EVP_MD *type, ENGINE *impl)
263         {
264         EVP_MD_CTX ctx;
265         int ret;
266
267         EVP_MD_CTX_init(&ctx);
268         EVP_MD_CTX_set_flags(&ctx,EVP_MD_CTX_FLAG_ONESHOT);
269         ret=EVP_DigestInit_ex(&ctx, type, impl)
270           && EVP_DigestUpdate(&ctx, data, count)
271           && EVP_DigestFinal_ex(&ctx, md, size);
272         EVP_MD_CTX_cleanup(&ctx);
273
274         return ret;
275         }
276
277 void EVP_MD_CTX_destroy(EVP_MD_CTX *ctx)
278         {
279         EVP_MD_CTX_cleanup(ctx);
280         OPENSSL_free(ctx);
281         }
282
283 /* This call frees resources associated with the context */
284 int EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx)
285         {
286         /* Don't assume ctx->md_data was cleaned in EVP_Digest_Final,
287          * because sometimes only copies of the context are ever finalised.
288          */
289         if (ctx->digest && ctx->digest->cleanup
290             && !EVP_MD_CTX_test_flags(ctx,EVP_MD_CTX_FLAG_CLEANED))
291                 ctx->digest->cleanup(ctx);
292         if (ctx->digest && ctx->digest->ctx_size && ctx->md_data)
293                 {
294                 memset(ctx->md_data,0,ctx->digest->ctx_size);
295                 OPENSSL_free(ctx->md_data);
296                 }
297         if(ctx->engine)
298                 /* The EVP_MD we used belongs to an ENGINE, release the
299                  * functional reference we held for this reason. */
300                 ENGINE_finish(ctx->engine);
301         memset(ctx,'\0',sizeof *ctx);
302
303         return 1;
304         }