2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #include "internal/cryptlib.h"
12 #include <openssl/objects.h>
13 #include <openssl/evp.h>
14 #include <openssl/engine.h>
15 #include "internal/evp_int.h"
16 #include "internal/provider.h"
19 /* This call frees resources associated with the context */
20 int EVP_MD_CTX_reset(EVP_MD_CTX
*ctx
)
25 if (ctx
->digest
== NULL
|| ctx
->digest
->prov
== NULL
)
28 if (ctx
->provctx
!= NULL
) {
29 if (ctx
->digest
->freectx
!= NULL
)
30 ctx
->digest
->freectx(ctx
->provctx
);
32 EVP_MD_CTX_set_flags(ctx
, EVP_MD_CTX_FLAG_CLEANED
);
35 if (ctx
->pctx
!= NULL
)
40 /* TODO(3.0): Remove legacy code below */
44 * Don't assume ctx->md_data was cleaned in EVP_Digest_Final, because
45 * sometimes only copies of the context are ever finalised.
47 if (ctx
->digest
&& ctx
->digest
->cleanup
48 && !EVP_MD_CTX_test_flags(ctx
, EVP_MD_CTX_FLAG_CLEANED
))
49 ctx
->digest
->cleanup(ctx
);
50 if (ctx
->digest
&& ctx
->digest
->ctx_size
&& ctx
->md_data
51 && !EVP_MD_CTX_test_flags(ctx
, EVP_MD_CTX_FLAG_REUSE
)) {
52 OPENSSL_clear_free(ctx
->md_data
, ctx
->digest
->ctx_size
);
55 * pctx should be freed by the user of EVP_MD_CTX
56 * if EVP_MD_CTX_FLAG_KEEP_PKEY_CTX is set
58 if (!EVP_MD_CTX_test_flags(ctx
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
))
59 EVP_PKEY_CTX_free(ctx
->pctx
);
60 #ifndef OPENSSL_NO_ENGINE
61 ENGINE_finish(ctx
->engine
);
63 OPENSSL_cleanse(ctx
, sizeof(*ctx
));
68 EVP_MD_CTX
*EVP_MD_CTX_new(void)
70 return OPENSSL_zalloc(sizeof(EVP_MD_CTX
));
73 void EVP_MD_CTX_free(EVP_MD_CTX
*ctx
)
78 if (ctx
->digest
== NULL
|| ctx
->digest
->prov
== NULL
)
81 EVP_MD_CTX_reset(ctx
);
83 EVP_MD_meth_free(ctx
->fetched_digest
);
84 ctx
->fetched_digest
= NULL
;
86 ctx
->reqdigest
= NULL
;
91 /* TODO(3.0): Remove legacy code below */
93 EVP_MD_CTX_reset(ctx
);
97 int EVP_DigestInit(EVP_MD_CTX
*ctx
, const EVP_MD
*type
)
99 EVP_MD_CTX_reset(ctx
);
100 return EVP_DigestInit_ex(ctx
, type
, NULL
);
103 int EVP_DigestInit_ex(EVP_MD_CTX
*ctx
, const EVP_MD
*type
, ENGINE
*impl
)
106 ENGINE
*tmpimpl
= NULL
;
108 EVP_MD_CTX_clear_flags(ctx
, EVP_MD_CTX_FLAG_CLEANED
);
111 ctx
->reqdigest
= type
;
113 /* TODO(3.0): Legacy work around code below. Remove this */
114 #ifndef OPENSSL_NO_ENGINE
116 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
117 * this context may already have an ENGINE! Try to avoid releasing the
118 * previous handle, re-querying for an ENGINE, and having a
119 * reinitialisation, when it may all be unnecessary.
121 if (ctx
->engine
&& ctx
->digest
&&
122 (type
== NULL
|| (type
->type
== ctx
->digest
->type
)))
125 if (type
!= NULL
&& impl
== NULL
)
126 tmpimpl
= ENGINE_get_digest_engine(type
->type
);
130 * If there are engines involved or if we're being used as part of
131 * EVP_DigestSignInit then we should use legacy handling for now.
133 if (ctx
->engine
!= NULL
137 || (ctx
->flags
& EVP_MD_CTX_FLAG_NO_INIT
) != 0) {
138 if (ctx
->digest
== ctx
->fetched_digest
)
140 EVP_MD_meth_free(ctx
->fetched_digest
);
141 ctx
->fetched_digest
= NULL
;
145 if (type
->prov
== NULL
) {
155 if (ctx
->digest
!= NULL
&& ctx
->digest
->ctx_size
> 0) {
156 OPENSSL_clear_free(ctx
->md_data
, ctx
->digest
->ctx_size
);
160 /* TODO(3.0): Start of non-legacy code below */
162 if (type
->prov
== NULL
) {
163 provmd
= EVP_MD_fetch(NULL
, OBJ_nid2sn(type
->type
), "");
164 if (provmd
== NULL
) {
165 EVPerr(EVP_F_EVP_DIGESTINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
169 EVP_MD_meth_free(ctx
->fetched_digest
);
170 ctx
->fetched_digest
= provmd
;
174 if (ctx
->provctx
== NULL
) {
175 ctx
->provctx
= ctx
->digest
->newctx(ossl_provider_ctx(type
->prov
));
176 if (ctx
->provctx
== NULL
) {
177 EVPerr(EVP_F_EVP_DIGESTINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
182 if (ctx
->digest
->dinit
== NULL
) {
183 EVPerr(EVP_F_EVP_DIGESTINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
187 return ctx
->digest
->dinit(ctx
->provctx
);
189 /* TODO(3.0): Remove legacy code below */
192 #ifndef OPENSSL_NO_ENGINE
195 * Ensure an ENGINE left lying around from last time is cleared (the
196 * previous check attempted to avoid this if the same ENGINE and
197 * EVP_MD could be used).
199 ENGINE_finish(ctx
->engine
);
201 if (!ENGINE_init(impl
)) {
202 EVPerr(EVP_F_EVP_DIGESTINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
206 /* Ask if an ENGINE is reserved for this job */
210 /* There's an ENGINE for this job ... (apparently) */
211 const EVP_MD
*d
= ENGINE_get_digest(impl
, type
->type
);
214 EVPerr(EVP_F_EVP_DIGESTINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
218 /* We'll use the ENGINE's private digest definition */
221 * Store the ENGINE functional reference so we know 'type' came
222 * from an ENGINE and we need to release it when done.
229 EVPerr(EVP_F_EVP_DIGESTINIT_EX
, EVP_R_NO_DIGEST_SET
);
235 if (ctx
->digest
!= type
) {
236 if (ctx
->digest
&& ctx
->digest
->ctx_size
) {
237 OPENSSL_clear_free(ctx
->md_data
, ctx
->digest
->ctx_size
);
241 if (!(ctx
->flags
& EVP_MD_CTX_FLAG_NO_INIT
) && type
->ctx_size
) {
242 ctx
->update
= type
->update
;
243 ctx
->md_data
= OPENSSL_zalloc(type
->ctx_size
);
244 if (ctx
->md_data
== NULL
) {
245 EVPerr(EVP_F_EVP_DIGESTINIT_EX
, ERR_R_MALLOC_FAILURE
);
250 #ifndef OPENSSL_NO_ENGINE
255 r
= EVP_PKEY_CTX_ctrl(ctx
->pctx
, -1, EVP_PKEY_OP_TYPE_SIG
,
256 EVP_PKEY_CTRL_DIGESTINIT
, 0, ctx
);
257 if (r
<= 0 && (r
!= -2))
260 if (ctx
->flags
& EVP_MD_CTX_FLAG_NO_INIT
)
262 return ctx
->digest
->init(ctx
);
265 int EVP_DigestUpdate(EVP_MD_CTX
*ctx
, const void *data
, size_t count
)
270 if (ctx
->digest
== NULL
|| ctx
->digest
->prov
== NULL
)
273 if (ctx
->digest
->dupdate
== NULL
) {
274 EVPerr(EVP_F_EVP_DIGESTUPDATE
, EVP_R_UPDATE_ERROR
);
277 return ctx
->digest
->dupdate(ctx
->provctx
, data
, count
);
279 /* TODO(3.0): Remove legacy code below */
281 return ctx
->update(ctx
, data
, count
);
284 /* The caller can assume that this removes any secret data from the context */
285 int EVP_DigestFinal(EVP_MD_CTX
*ctx
, unsigned char *md
, unsigned int *size
)
288 ret
= EVP_DigestFinal_ex(ctx
, md
, size
);
289 EVP_MD_CTX_reset(ctx
);
293 /* The caller can assume that this removes any secret data from the context */
294 int EVP_DigestFinal_ex(EVP_MD_CTX
*ctx
, unsigned char *md
, unsigned int *isize
)
298 size_t mdsize
= EVP_MD_size(ctx
->digest
);
300 if (ctx
->digest
== NULL
|| ctx
->digest
->prov
== NULL
)
303 if (ctx
->digest
->dfinal
== NULL
) {
304 EVPerr(EVP_F_EVP_DIGESTFINAL_EX
, EVP_R_FINAL_ERROR
);
308 ret
= ctx
->digest
->dfinal(ctx
->provctx
, md
, &size
, mdsize
);
311 if (size
<= UINT_MAX
) {
314 EVPerr(EVP_F_EVP_DIGESTFINAL_EX
, EVP_R_FINAL_ERROR
);
319 EVP_MD_CTX_reset(ctx
);
323 /* TODO(3.0): Remove legacy code below */
325 OPENSSL_assert(mdsize
<= EVP_MAX_MD_SIZE
);
326 ret
= ctx
->digest
->final(ctx
, md
);
329 if (ctx
->digest
->cleanup
) {
330 ctx
->digest
->cleanup(ctx
);
331 EVP_MD_CTX_set_flags(ctx
, EVP_MD_CTX_FLAG_CLEANED
);
333 OPENSSL_cleanse(ctx
->md_data
, ctx
->digest
->ctx_size
);
337 int EVP_DigestFinalXOF(EVP_MD_CTX
*ctx
, unsigned char *md
, size_t size
)
341 if (ctx
->digest
->flags
& EVP_MD_FLAG_XOF
343 && ctx
->digest
->md_ctrl(ctx
, EVP_MD_CTRL_XOF_LEN
, (int)size
, NULL
)) {
344 ret
= ctx
->digest
->final(ctx
, md
);
346 if (ctx
->digest
->cleanup
!= NULL
) {
347 ctx
->digest
->cleanup(ctx
);
348 EVP_MD_CTX_set_flags(ctx
, EVP_MD_CTX_FLAG_CLEANED
);
350 OPENSSL_cleanse(ctx
->md_data
, ctx
->digest
->ctx_size
);
352 EVPerr(EVP_F_EVP_DIGESTFINALXOF
, EVP_R_NOT_XOF_OR_INVALID_LENGTH
);
358 int EVP_MD_CTX_copy(EVP_MD_CTX
*out
, const EVP_MD_CTX
*in
)
360 EVP_MD_CTX_reset(out
);
361 return EVP_MD_CTX_copy_ex(out
, in
);
364 int EVP_MD_CTX_copy_ex(EVP_MD_CTX
*out
, const EVP_MD_CTX
*in
)
366 unsigned char *tmp_buf
;
368 if (in
== NULL
|| in
->digest
== NULL
) {
369 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX
, EVP_R_INPUT_NOT_INITIALIZED
);
373 if (in
->digest
->prov
== NULL
)
376 if (in
->digest
->dupctx
== NULL
) {
377 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
381 EVP_MD_CTX_reset(out
);
382 if (out
->fetched_digest
!= NULL
)
383 EVP_MD_meth_free(out
->fetched_digest
);
385 /* NULL out pointers in case of error */
389 if (in
->fetched_digest
!= NULL
)
390 EVP_MD_upref(in
->fetched_digest
);
392 out
->provctx
= in
->digest
->dupctx(in
->provctx
);
393 if (out
->provctx
== NULL
) {
394 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
398 /* copied EVP_MD_CTX should free the copied EVP_PKEY_CTX */
399 EVP_MD_CTX_clear_flags(out
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
);
400 if (in
->pctx
!= NULL
) {
401 out
->pctx
= EVP_PKEY_CTX_dup(in
->pctx
);
402 if (out
->pctx
== NULL
) {
403 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
404 EVP_MD_CTX_reset(out
);
411 /* TODO(3.0): Remove legacy code below */
413 #ifndef OPENSSL_NO_ENGINE
414 /* Make sure it's safe to copy a digest context using an ENGINE */
415 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
416 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX
, ERR_R_ENGINE_LIB
);
421 if (out
->digest
== in
->digest
) {
422 tmp_buf
= out
->md_data
;
423 EVP_MD_CTX_set_flags(out
, EVP_MD_CTX_FLAG_REUSE
);
426 EVP_MD_CTX_reset(out
);
427 memcpy(out
, in
, sizeof(*out
));
429 /* copied EVP_MD_CTX should free the copied EVP_PKEY_CTX */
430 EVP_MD_CTX_clear_flags(out
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
);
432 /* Null these variables, since they are getting fixed up
433 * properly below. Anything else may cause a memleak and/or
434 * double free if any of the memory allocations below fail
439 if (in
->md_data
&& out
->digest
->ctx_size
) {
441 out
->md_data
= tmp_buf
;
443 out
->md_data
= OPENSSL_malloc(out
->digest
->ctx_size
);
444 if (out
->md_data
== NULL
) {
445 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX
, ERR_R_MALLOC_FAILURE
);
449 memcpy(out
->md_data
, in
->md_data
, out
->digest
->ctx_size
);
452 out
->update
= in
->update
;
455 out
->pctx
= EVP_PKEY_CTX_dup(in
->pctx
);
457 EVP_MD_CTX_reset(out
);
462 if (out
->digest
->copy
)
463 return out
->digest
->copy(out
, in
);
468 int EVP_Digest(const void *data
, size_t count
,
469 unsigned char *md
, unsigned int *size
, const EVP_MD
*type
,
472 EVP_MD_CTX
*ctx
= EVP_MD_CTX_new();
477 EVP_MD_CTX_set_flags(ctx
, EVP_MD_CTX_FLAG_ONESHOT
);
478 ret
= EVP_DigestInit_ex(ctx
, type
, impl
)
479 && EVP_DigestUpdate(ctx
, data
, count
)
480 && EVP_DigestFinal_ex(ctx
, md
, size
);
481 EVP_MD_CTX_free(ctx
);
486 int EVP_MD_CTX_ctrl(EVP_MD_CTX
*ctx
, int cmd
, int p1
, void *p2
)
488 if (ctx
->digest
&& ctx
->digest
->md_ctrl
) {
489 int ret
= ctx
->digest
->md_ctrl(ctx
, cmd
, p1
, p2
);
497 static void *evp_md_from_dispatch(int mdtype
, const OSSL_DISPATCH
*fns
,
503 if ((md
= EVP_MD_meth_new(mdtype
, NID_undef
)) == NULL
)
506 for (; fns
->function_id
!= 0; fns
++) {
507 switch (fns
->function_id
) {
508 case OSSL_FUNC_DIGEST_NEWCTX
:
509 if (md
->newctx
!= NULL
)
511 md
->newctx
= OSSL_get_OP_digest_newctx(fns
);
514 case OSSL_FUNC_DIGEST_INIT
:
515 if (md
->dinit
!= NULL
)
517 md
->dinit
= OSSL_get_OP_digest_init(fns
);
520 case OSSL_FUNC_DIGEST_UPDATE
:
521 if (md
->dupdate
!= NULL
)
523 md
->dupdate
= OSSL_get_OP_digest_update(fns
);
526 case OSSL_FUNC_DIGEST_FINAL
:
527 if (md
->dfinal
!= NULL
)
529 md
->dfinal
= OSSL_get_OP_digest_final(fns
);
532 case OSSL_FUNC_DIGEST_DIGEST
:
533 if (md
->digest
!= NULL
)
535 md
->digest
= OSSL_get_OP_digest_digest(fns
);
536 /* We don't increment fnct for this as it is stand alone */
538 case OSSL_FUNC_DIGEST_FREECTX
:
539 if (md
->freectx
!= NULL
)
541 md
->freectx
= OSSL_get_OP_digest_freectx(fns
);
544 case OSSL_FUNC_DIGEST_DUPCTX
:
545 if (md
->dupctx
!= NULL
)
547 md
->dupctx
= OSSL_get_OP_digest_dupctx(fns
);
549 case OSSL_FUNC_DIGEST_SIZE
:
550 if (md
->size
!= NULL
)
552 md
->size
= OSSL_get_OP_digest_size(fns
);
554 case OSSL_FUNC_DIGEST_BLOCK_SIZE
:
555 if (md
->dblock_size
!= NULL
)
557 md
->dblock_size
= OSSL_get_OP_digest_block_size(fns
);
561 if ((fncnt
!= 0 && fncnt
!= 5)
562 || (fncnt
== 0 && md
->digest
== NULL
)
563 || md
->size
== NULL
) {
565 * In order to be a consistent set of functions we either need the
566 * whole set of init/update/final etc functions or none of them.
567 * The "digest" function can standalone. We at least need one way to
570 EVP_MD_meth_free(md
);
575 ossl_provider_upref(prov
);
580 static int evp_md_upref(void *md
)
582 return EVP_MD_upref(md
);
585 static void evp_md_free(void *md
)
587 EVP_MD_meth_free(md
);
590 static int evp_md_nid(void *vmd
)
597 EVP_MD
*EVP_MD_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
598 const char *properties
)
600 return evp_generic_fetch(ctx
, OSSL_OP_DIGEST
, algorithm
, properties
,
601 evp_md_from_dispatch
, evp_md_upref
,
602 evp_md_free
, evp_md_nid
);