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