2 * Copyright 1995-2021 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 * EVP _meth_ APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
18 #include "e_os.h" /* strcasecmp */
19 #include "internal/cryptlib.h"
20 #include <openssl/evp.h>
21 #include <openssl/objects.h>
22 #include <openssl/params.h>
23 #include <openssl/core_names.h>
24 #include <openssl/rsa.h>
25 #include <openssl/dh.h>
26 #include <openssl/ec.h>
27 #include "crypto/evp.h"
28 #include "crypto/asn1.h"
29 #include "internal/provider.h"
30 #include "evp_local.h"
32 #if !defined(FIPS_MODULE)
34 int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
)
36 return evp_cipher_param_to_asn1_ex(c
, type
, NULL
);
39 int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
)
41 return evp_cipher_asn1_to_param_ex(c
, type
, NULL
);
44 int EVP_CIPHER_get_asn1_iv(EVP_CIPHER_CTX
*ctx
, ASN1_TYPE
*type
)
50 unsigned char iv
[EVP_MAX_IV_LENGTH
];
52 l
= EVP_CIPHER_CTX_get_iv_length(ctx
);
53 if (!ossl_assert(l
<= sizeof(iv
)))
55 i
= ASN1_TYPE_get_octetstring(type
, iv
, l
);
59 if (!EVP_CipherInit_ex(ctx
, NULL
, NULL
, NULL
, iv
, -1))
65 int EVP_CIPHER_set_asn1_iv(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
)
69 unsigned char *oiv
= NULL
;
72 oiv
= (unsigned char *)EVP_CIPHER_CTX_original_iv(c
);
73 j
= EVP_CIPHER_CTX_get_iv_length(c
);
74 OPENSSL_assert(j
<= sizeof(c
->iv
));
75 i
= ASN1_TYPE_set_octetstring(type
, oiv
, j
);
80 int evp_cipher_param_to_asn1_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
81 evp_cipher_aead_asn1_params
*asn1_params
)
83 int ret
= -1; /* Assume the worst */
84 const EVP_CIPHER
*cipher
= c
->cipher
;
87 * For legacy implementations, we detect custom AlgorithmIdentifier
88 * parameter handling by checking if the function pointer
89 * cipher->set_asn1_parameters is set. We know that this pointer
90 * is NULL for provided implementations.
92 * Otherwise, for any implementation, we check the flag
93 * EVP_CIPH_FLAG_CUSTOM_ASN1. If it isn't set, we apply
94 * default AI parameter extraction.
96 * Otherwise, for provided implementations, we convert |type| to
97 * a DER encoded blob and pass to the implementation in OSSL_PARAM
100 * If none of the above applies, this operation is unsupported.
102 if (cipher
->set_asn1_parameters
!= NULL
) {
103 ret
= cipher
->set_asn1_parameters(c
, type
);
104 } else if ((EVP_CIPHER_get_flags(cipher
) & EVP_CIPH_FLAG_CUSTOM_ASN1
) == 0) {
105 switch (EVP_CIPHER_get_mode(cipher
)) {
106 case EVP_CIPH_WRAP_MODE
:
107 if (EVP_CIPHER_is_a(cipher
, SN_id_smime_alg_CMS3DESwrap
))
108 ASN1_TYPE_set(type
, V_ASN1_NULL
, NULL
);
112 case EVP_CIPH_GCM_MODE
:
113 ret
= evp_cipher_set_asn1_aead_params(c
, type
, asn1_params
);
116 case EVP_CIPH_CCM_MODE
:
117 case EVP_CIPH_XTS_MODE
:
118 case EVP_CIPH_OCB_MODE
:
123 ret
= EVP_CIPHER_set_asn1_iv(c
, type
);
125 } else if (cipher
->prov
!= NULL
) {
126 OSSL_PARAM params
[3], *p
= params
;
127 unsigned char *der
= NULL
, *derp
;
130 * We make two passes, the first to get the appropriate buffer size,
131 * and the second to get the actual value.
133 *p
++ = OSSL_PARAM_construct_octet_string(
134 OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS
,
136 *p
= OSSL_PARAM_construct_end();
138 if (!EVP_CIPHER_CTX_get_params(c
, params
))
141 /* ... but, we should get a return size too! */
142 if (OSSL_PARAM_modified(params
)
143 && params
[0].return_size
!= 0
144 && (der
= OPENSSL_malloc(params
[0].return_size
)) != NULL
) {
145 params
[0].data
= der
;
146 params
[0].data_size
= params
[0].return_size
;
147 OSSL_PARAM_set_all_unmodified(params
);
149 if (EVP_CIPHER_CTX_get_params(c
, params
)
150 && OSSL_PARAM_modified(params
)
151 && d2i_ASN1_TYPE(&type
, (const unsigned char **)&derp
,
152 params
[0].return_size
) != NULL
) {
163 ERR_raise(ERR_LIB_EVP
, EVP_R_UNSUPPORTED_CIPHER
);
165 ERR_raise(ERR_LIB_EVP
, EVP_R_CIPHER_PARAMETER_ERROR
);
171 int evp_cipher_asn1_to_param_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
172 evp_cipher_aead_asn1_params
*asn1_params
)
174 int ret
= -1; /* Assume the worst */
175 const EVP_CIPHER
*cipher
= c
->cipher
;
178 * For legacy implementations, we detect custom AlgorithmIdentifier
179 * parameter handling by checking if there the function pointer
180 * cipher->get_asn1_parameters is set. We know that this pointer
181 * is NULL for provided implementations.
183 * Otherwise, for any implementation, we check the flag
184 * EVP_CIPH_FLAG_CUSTOM_ASN1. If it isn't set, we apply
185 * default AI parameter creation.
187 * Otherwise, for provided implementations, we get the AI parameter
188 * in DER encoded form from the implementation by requesting the
189 * appropriate OSSL_PARAM and converting the result to a ASN1_TYPE.
191 * If none of the above applies, this operation is unsupported.
193 if (cipher
->get_asn1_parameters
!= NULL
) {
194 ret
= cipher
->get_asn1_parameters(c
, type
);
195 } else if ((EVP_CIPHER_get_flags(cipher
) & EVP_CIPH_FLAG_CUSTOM_ASN1
) == 0) {
196 switch (EVP_CIPHER_get_mode(cipher
)) {
197 case EVP_CIPH_WRAP_MODE
:
201 case EVP_CIPH_GCM_MODE
:
202 ret
= evp_cipher_get_asn1_aead_params(c
, type
, asn1_params
);
205 case EVP_CIPH_CCM_MODE
:
206 case EVP_CIPH_XTS_MODE
:
207 case EVP_CIPH_OCB_MODE
:
212 ret
= EVP_CIPHER_get_asn1_iv(c
, type
);
214 } else if (cipher
->prov
!= NULL
) {
215 OSSL_PARAM params
[3], *p
= params
;
216 unsigned char *der
= NULL
;
219 if ((derl
= i2d_ASN1_TYPE(type
, &der
)) >= 0) {
221 OSSL_PARAM_construct_octet_string(
222 OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS
,
224 *p
= OSSL_PARAM_construct_end();
225 if (EVP_CIPHER_CTX_set_params(c
, params
))
234 ERR_raise(ERR_LIB_EVP
, EVP_R_UNSUPPORTED_CIPHER
);
236 ERR_raise(ERR_LIB_EVP
, EVP_R_CIPHER_PARAMETER_ERROR
);
242 int evp_cipher_get_asn1_aead_params(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
243 evp_cipher_aead_asn1_params
*asn1_params
)
247 unsigned char iv
[EVP_MAX_IV_LENGTH
];
249 if (type
== NULL
|| asn1_params
== NULL
)
252 i
= ossl_asn1_type_get_octetstring_int(type
, &tl
, NULL
, EVP_MAX_IV_LENGTH
);
255 ossl_asn1_type_get_octetstring_int(type
, &tl
, iv
, i
);
257 memcpy(asn1_params
->iv
, iv
, i
);
258 asn1_params
->iv_len
= i
;
263 int evp_cipher_set_asn1_aead_params(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
264 evp_cipher_aead_asn1_params
*asn1_params
)
266 if (type
== NULL
|| asn1_params
== NULL
)
269 return ossl_asn1_type_set_octetstring_int(type
, asn1_params
->tag_len
,
271 asn1_params
->iv_len
);
273 #endif /* !defined(FIPS_MODULE) */
275 /* Convert the various cipher NIDs and dummies to a proper OID NID */
276 int EVP_CIPHER_get_type(const EVP_CIPHER
*cipher
)
279 nid
= EVP_CIPHER_get_nid(cipher
);
294 case NID_aes_128_cfb128
:
295 case NID_aes_128_cfb8
:
296 case NID_aes_128_cfb1
:
298 return NID_aes_128_cfb128
;
300 case NID_aes_192_cfb128
:
301 case NID_aes_192_cfb8
:
302 case NID_aes_192_cfb1
:
304 return NID_aes_192_cfb128
;
306 case NID_aes_256_cfb128
:
307 case NID_aes_256_cfb8
:
308 case NID_aes_256_cfb1
:
310 return NID_aes_256_cfb128
;
316 return NID_des_cfb64
;
318 case NID_des_ede3_cfb64
:
319 case NID_des_ede3_cfb8
:
320 case NID_des_ede3_cfb1
:
322 return NID_des_cfb64
;
329 /* Check it has an OID and it is valid */
330 ASN1_OBJECT
*otmp
= OBJ_nid2obj(nid
);
332 if (OBJ_get0_data(otmp
) == NULL
)
334 ASN1_OBJECT_free(otmp
);
341 int evp_cipher_cache_constants(EVP_CIPHER
*cipher
)
343 int ok
, aead
= 0, custom_iv
= 0, cts
= 0, multiblock
= 0;
347 unsigned int mode
= 0;
348 OSSL_PARAM params
[9];
350 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_BLOCK_SIZE
, &blksz
);
351 params
[1] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN
, &ivlen
);
352 params
[2] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN
, &keylen
);
353 params
[3] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_MODE
, &mode
);
354 params
[4] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_AEAD
, &aead
);
355 params
[5] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_CUSTOM_IV
,
357 params
[6] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_CTS
, &cts
);
358 params
[7] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK
,
360 params
[8] = OSSL_PARAM_construct_end();
361 ok
= evp_do_ciph_getparams(cipher
, params
) > 0;
363 cipher
->block_size
= blksz
;
364 cipher
->iv_len
= ivlen
;
365 cipher
->key_len
= keylen
;
366 cipher
->flags
= mode
;
368 cipher
->flags
|= EVP_CIPH_FLAG_AEAD_CIPHER
;
370 cipher
->flags
|= EVP_CIPH_CUSTOM_IV
;
372 cipher
->flags
|= EVP_CIPH_FLAG_CTS
;
374 cipher
->flags
|= EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
;
375 if (cipher
->ccipher
!= NULL
)
376 cipher
->flags
|= EVP_CIPH_FLAG_CUSTOM_CIPHER
;
377 if (OSSL_PARAM_locate_const(EVP_CIPHER_gettable_ctx_params(cipher
),
378 OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS
))
379 cipher
->flags
|= EVP_CIPH_FLAG_CUSTOM_ASN1
;
384 int EVP_CIPHER_get_block_size(const EVP_CIPHER
*cipher
)
386 return cipher
->block_size
;
389 int EVP_CIPHER_CTX_get_block_size(const EVP_CIPHER_CTX
*ctx
)
391 return EVP_CIPHER_get_block_size(ctx
->cipher
);
394 int EVP_CIPHER_impl_ctx_size(const EVP_CIPHER
*e
)
399 int EVP_Cipher(EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
400 const unsigned char *in
, unsigned int inl
)
402 if (ctx
->cipher
->prov
!= NULL
) {
404 * If the provided implementation has a ccipher function, we use it,
405 * and translate its return value like this: 0 => -1, 1 => outlen
407 * Otherwise, we call the cupdate function if in != NULL, or cfinal
408 * if in == NULL. Regardless of which, we return what we got.
412 size_t blocksize
= EVP_CIPHER_CTX_get_block_size(ctx
);
414 if (ctx
->cipher
->ccipher
!= NULL
)
415 ret
= ctx
->cipher
->ccipher(ctx
->algctx
, out
, &outl
,
416 inl
+ (blocksize
== 1 ? 0 : blocksize
),
420 ret
= ctx
->cipher
->cupdate(ctx
->algctx
, out
, &outl
,
421 inl
+ (blocksize
== 1 ? 0 : blocksize
),
424 ret
= ctx
->cipher
->cfinal(ctx
->algctx
, out
, &outl
,
425 blocksize
== 1 ? 0 : blocksize
);
430 return ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
433 #ifndef OPENSSL_NO_DEPRECATED_3_0
434 const EVP_CIPHER
*EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX
*ctx
)
442 const EVP_CIPHER
*EVP_CIPHER_CTX_get0_cipher(const EVP_CIPHER_CTX
*ctx
)
449 EVP_CIPHER
*EVP_CIPHER_CTX_get1_cipher(EVP_CIPHER_CTX
*ctx
)
455 cipher
= (EVP_CIPHER
*)ctx
->cipher
;
456 if (!EVP_CIPHER_up_ref(cipher
))
461 int EVP_CIPHER_CTX_is_encrypting(const EVP_CIPHER_CTX
*ctx
)
466 unsigned long EVP_CIPHER_get_flags(const EVP_CIPHER
*cipher
)
468 return cipher
->flags
;
471 void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX
*ctx
)
473 return ctx
->app_data
;
476 void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX
*ctx
, void *data
)
478 ctx
->app_data
= data
;
481 void *EVP_CIPHER_CTX_get_cipher_data(const EVP_CIPHER_CTX
*ctx
)
483 return ctx
->cipher_data
;
486 void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX
*ctx
, void *cipher_data
)
488 void *old_cipher_data
;
490 old_cipher_data
= ctx
->cipher_data
;
491 ctx
->cipher_data
= cipher_data
;
493 return old_cipher_data
;
496 int EVP_CIPHER_get_iv_length(const EVP_CIPHER
*cipher
)
498 return cipher
->iv_len
;
501 int EVP_CIPHER_CTX_get_iv_length(const EVP_CIPHER_CTX
*ctx
)
503 int rv
, len
= EVP_CIPHER_get_iv_length(ctx
->cipher
);
505 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
507 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN
, &v
);
508 rv
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
509 if (rv
== EVP_CTRL_RET_UNSUPPORTED
)
511 return rv
!= 0 ? (int)v
: -1;
512 /* Code below to be removed when legacy support is dropped. */
514 if ((EVP_CIPHER_get_flags(ctx
->cipher
) & EVP_CIPH_CUSTOM_IV_LENGTH
) != 0) {
515 rv
= EVP_CIPHER_CTX_ctrl((EVP_CIPHER_CTX
*)ctx
, EVP_CTRL_GET_IVLEN
,
517 return (rv
== 1) ? len
: -1;
522 int EVP_CIPHER_CTX_get_tag_length(const EVP_CIPHER_CTX
*ctx
)
526 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
528 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN
, &v
);
529 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
530 return ret
== 1 ? (int)v
: 0;
533 #ifndef OPENSSL_NO_DEPRECATED_3_0
534 const unsigned char *EVP_CIPHER_CTX_original_iv(const EVP_CIPHER_CTX
*ctx
)
537 const unsigned char *v
= ctx
->oiv
;
538 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
541 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_IV
,
542 (void **)&v
, sizeof(ctx
->oiv
));
543 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
545 return ok
!= 0 ? v
: NULL
;
549 * OSSL_PARAM_OCTET_PTR gets us the pointer to the running IV in the provider
551 const unsigned char *EVP_CIPHER_CTX_iv(const EVP_CIPHER_CTX
*ctx
)
554 const unsigned char *v
= ctx
->iv
;
555 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
558 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_UPDATED_IV
,
559 (void **)&v
, sizeof(ctx
->iv
));
560 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
562 return ok
!= 0 ? v
: NULL
;
565 unsigned char *EVP_CIPHER_CTX_iv_noconst(EVP_CIPHER_CTX
*ctx
)
568 unsigned char *v
= ctx
->iv
;
569 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
572 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_UPDATED_IV
,
573 (void **)&v
, sizeof(ctx
->iv
));
574 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
576 return ok
!= 0 ? v
: NULL
;
578 #endif /* OPENSSL_NO_DEPRECATED_3_0_0 */
580 int EVP_CIPHER_CTX_get_updated_iv(EVP_CIPHER_CTX
*ctx
, void *buf
, size_t len
)
582 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
585 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_UPDATED_IV
, buf
, len
);
586 return evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
589 int EVP_CIPHER_CTX_get_original_iv(EVP_CIPHER_CTX
*ctx
, void *buf
, size_t len
)
591 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
594 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV
, buf
, len
);
595 return evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
598 unsigned char *EVP_CIPHER_CTX_buf_noconst(EVP_CIPHER_CTX
*ctx
)
603 int EVP_CIPHER_CTX_get_num(const EVP_CIPHER_CTX
*ctx
)
606 unsigned int v
= (unsigned int)ctx
->num
;
607 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
609 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_NUM
, &v
);
610 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
612 return ok
!= 0 ? (int)v
: EVP_CTRL_RET_UNSUPPORTED
;
615 int EVP_CIPHER_CTX_set_num(EVP_CIPHER_CTX
*ctx
, int num
)
618 unsigned int n
= (unsigned int)num
;
619 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
621 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_NUM
, &n
);
622 ok
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->algctx
, params
);
629 int EVP_CIPHER_get_key_length(const EVP_CIPHER
*cipher
)
631 return cipher
->key_len
;
634 int EVP_CIPHER_CTX_get_key_length(const EVP_CIPHER_CTX
*ctx
)
637 size_t v
= ctx
->key_len
;
638 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
640 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN
, &v
);
641 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
643 return ok
!= 0 ? (int)v
: EVP_CTRL_RET_UNSUPPORTED
;
646 int EVP_CIPHER_get_nid(const EVP_CIPHER
*cipher
)
651 int EVP_CIPHER_CTX_get_nid(const EVP_CIPHER_CTX
*ctx
)
653 return ctx
->cipher
->nid
;
656 int EVP_CIPHER_is_a(const EVP_CIPHER
*cipher
, const char *name
)
658 if (cipher
->prov
!= NULL
)
659 return evp_is_a(cipher
->prov
, cipher
->name_id
, NULL
, name
);
660 return evp_is_a(NULL
, 0, EVP_CIPHER_get0_name(cipher
), name
);
663 int EVP_CIPHER_get_number(const EVP_CIPHER
*cipher
)
665 return cipher
->name_id
;
668 const char *EVP_CIPHER_get0_name(const EVP_CIPHER
*cipher
)
670 if (cipher
->type_name
!= NULL
)
671 return cipher
->type_name
;
673 return OBJ_nid2sn(EVP_CIPHER_get_nid(cipher
));
679 const char *EVP_CIPHER_get0_description(const EVP_CIPHER
*cipher
)
681 if (cipher
->description
!= NULL
)
682 return cipher
->description
;
684 return OBJ_nid2ln(EVP_CIPHER_get_nid(cipher
));
690 int EVP_CIPHER_names_do_all(const EVP_CIPHER
*cipher
,
691 void (*fn
)(const char *name
, void *data
),
694 if (cipher
->prov
!= NULL
)
695 return evp_names_do_all(cipher
->prov
, cipher
->name_id
, fn
, data
);
700 const OSSL_PROVIDER
*EVP_CIPHER_get0_provider(const EVP_CIPHER
*cipher
)
705 int EVP_CIPHER_get_mode(const EVP_CIPHER
*cipher
)
707 return EVP_CIPHER_get_flags(cipher
) & EVP_CIPH_MODE
;
710 int EVP_MD_is_a(const EVP_MD
*md
, const char *name
)
712 if (md
->prov
!= NULL
)
713 return evp_is_a(md
->prov
, md
->name_id
, NULL
, name
);
714 return evp_is_a(NULL
, 0, EVP_MD_get0_name(md
), name
);
717 int EVP_MD_get_number(const EVP_MD
*md
)
722 const char *EVP_MD_get0_description(const EVP_MD
*md
)
724 if (md
->description
!= NULL
)
725 return md
->description
;
727 return OBJ_nid2ln(EVP_MD_nid(md
));
733 const char *EVP_MD_get0_name(const EVP_MD
*md
)
737 if (md
->type_name
!= NULL
)
738 return md
->type_name
;
740 return OBJ_nid2sn(EVP_MD_nid(md
));
746 int EVP_MD_names_do_all(const EVP_MD
*md
,
747 void (*fn
)(const char *name
, void *data
),
750 if (md
->prov
!= NULL
)
751 return evp_names_do_all(md
->prov
, md
->name_id
, fn
, data
);
756 const OSSL_PROVIDER
*EVP_MD_get0_provider(const EVP_MD
*md
)
761 int EVP_MD_get_type(const EVP_MD
*md
)
766 int EVP_MD_get_pkey_type(const EVP_MD
*md
)
768 return md
->pkey_type
;
771 int EVP_MD_get_block_size(const EVP_MD
*md
)
774 ERR_raise(ERR_LIB_EVP
, EVP_R_MESSAGE_DIGEST_IS_NULL
);
777 return md
->block_size
;
780 int EVP_MD_get_size(const EVP_MD
*md
)
783 ERR_raise(ERR_LIB_EVP
, EVP_R_MESSAGE_DIGEST_IS_NULL
);
789 unsigned long EVP_MD_get_flags(const EVP_MD
*md
)
794 EVP_MD
*EVP_MD_meth_new(int md_type
, int pkey_type
)
796 EVP_MD
*md
= evp_md_new();
800 md
->pkey_type
= pkey_type
;
801 md
->origin
= EVP_ORIG_METH
;
806 EVP_MD
*EVP_MD_meth_dup(const EVP_MD
*md
)
811 * Non-legacy EVP_MDs can't be duplicated like this.
812 * Use EVP_MD_up_ref() instead.
814 if (md
->prov
!= NULL
)
817 if ((to
= EVP_MD_meth_new(md
->type
, md
->pkey_type
)) != NULL
) {
818 CRYPTO_RWLOCK
*lock
= to
->lock
;
820 memcpy(to
, md
, sizeof(*to
));
826 void evp_md_free_int(EVP_MD
*md
)
828 OPENSSL_free(md
->type_name
);
829 ossl_provider_free(md
->prov
);
830 CRYPTO_THREAD_lock_free(md
->lock
);
834 void EVP_MD_meth_free(EVP_MD
*md
)
836 if (md
== NULL
|| md
->origin
!= EVP_ORIG_METH
)
842 int EVP_MD_meth_set_input_blocksize(EVP_MD
*md
, int blocksize
)
844 if (md
->block_size
!= 0)
847 md
->block_size
= blocksize
;
850 int EVP_MD_meth_set_result_size(EVP_MD
*md
, int resultsize
)
852 if (md
->md_size
!= 0)
855 md
->md_size
= resultsize
;
858 int EVP_MD_meth_set_app_datasize(EVP_MD
*md
, int datasize
)
860 if (md
->ctx_size
!= 0)
863 md
->ctx_size
= datasize
;
866 int EVP_MD_meth_set_flags(EVP_MD
*md
, unsigned long flags
)
874 int EVP_MD_meth_set_init(EVP_MD
*md
, int (*init
)(EVP_MD_CTX
*ctx
))
876 if (md
->init
!= NULL
)
882 int EVP_MD_meth_set_update(EVP_MD
*md
, int (*update
)(EVP_MD_CTX
*ctx
,
886 if (md
->update
!= NULL
)
892 int EVP_MD_meth_set_final(EVP_MD
*md
, int (*final
)(EVP_MD_CTX
*ctx
,
895 if (md
->final
!= NULL
)
901 int EVP_MD_meth_set_copy(EVP_MD
*md
, int (*copy
)(EVP_MD_CTX
*to
,
902 const EVP_MD_CTX
*from
))
904 if (md
->copy
!= NULL
)
910 int EVP_MD_meth_set_cleanup(EVP_MD
*md
, int (*cleanup
)(EVP_MD_CTX
*ctx
))
912 if (md
->cleanup
!= NULL
)
915 md
->cleanup
= cleanup
;
918 int EVP_MD_meth_set_ctrl(EVP_MD
*md
, int (*ctrl
)(EVP_MD_CTX
*ctx
, int cmd
,
921 if (md
->md_ctrl
!= NULL
)
928 int EVP_MD_meth_get_input_blocksize(const EVP_MD
*md
)
930 return md
->block_size
;
932 int EVP_MD_meth_get_result_size(const EVP_MD
*md
)
936 int EVP_MD_meth_get_app_datasize(const EVP_MD
*md
)
940 unsigned long EVP_MD_meth_get_flags(const EVP_MD
*md
)
944 int (*EVP_MD_meth_get_init(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
)
948 int (*EVP_MD_meth_get_update(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
,
954 int (*EVP_MD_meth_get_final(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
,
959 int (*EVP_MD_meth_get_copy(const EVP_MD
*md
))(EVP_MD_CTX
*to
,
960 const EVP_MD_CTX
*from
)
964 int (*EVP_MD_meth_get_cleanup(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
)
968 int (*EVP_MD_meth_get_ctrl(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
, int cmd
,
974 #ifndef OPENSSL_NO_DEPRECATED_3_0
975 const EVP_MD
*EVP_MD_CTX_md(const EVP_MD_CTX
*ctx
)
979 return ctx
->reqdigest
;
983 const EVP_MD
*EVP_MD_CTX_get0_md(const EVP_MD_CTX
*ctx
)
987 return ctx
->reqdigest
;
990 EVP_MD
*EVP_MD_CTX_get1_md(EVP_MD_CTX
*ctx
)
996 md
= (EVP_MD
*)ctx
->reqdigest
;
997 if (!EVP_MD_up_ref(md
))
1002 EVP_PKEY_CTX
*EVP_MD_CTX_get_pkey_ctx(const EVP_MD_CTX
*ctx
)
1007 #if !defined(FIPS_MODULE)
1008 void EVP_MD_CTX_set_pkey_ctx(EVP_MD_CTX
*ctx
, EVP_PKEY_CTX
*pctx
)
1011 * it's reasonable to set NULL pctx (a.k.a clear the ctx->pctx), so
1012 * we have to deal with the cleanup job here.
1014 if (!EVP_MD_CTX_test_flags(ctx
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
))
1015 EVP_PKEY_CTX_free(ctx
->pctx
);
1020 /* make sure pctx is not freed when destroying EVP_MD_CTX */
1021 EVP_MD_CTX_set_flags(ctx
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
);
1023 EVP_MD_CTX_clear_flags(ctx
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
);
1026 #endif /* !defined(FIPS_MODULE) */
1028 void *EVP_MD_CTX_get0_md_data(const EVP_MD_CTX
*ctx
)
1030 return ctx
->md_data
;
1033 int (*EVP_MD_CTX_update_fn(EVP_MD_CTX
*ctx
))(EVP_MD_CTX
*ctx
,
1034 const void *data
, size_t count
)
1039 void EVP_MD_CTX_set_update_fn(EVP_MD_CTX
*ctx
,
1040 int (*update
) (EVP_MD_CTX
*ctx
,
1041 const void *data
, size_t count
))
1043 ctx
->update
= update
;
1046 void EVP_MD_CTX_set_flags(EVP_MD_CTX
*ctx
, int flags
)
1048 ctx
->flags
|= flags
;
1051 void EVP_MD_CTX_clear_flags(EVP_MD_CTX
*ctx
, int flags
)
1053 ctx
->flags
&= ~flags
;
1056 int EVP_MD_CTX_test_flags(const EVP_MD_CTX
*ctx
, int flags
)
1058 return (ctx
->flags
& flags
);
1061 static int evp_cipher_ctx_enable_use_bits(EVP_CIPHER_CTX
*ctx
,
1062 unsigned int enable
)
1064 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1066 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_USE_BITS
, &enable
);
1067 return EVP_CIPHER_CTX_set_params(ctx
, params
);
1070 void EVP_CIPHER_CTX_set_flags(EVP_CIPHER_CTX
*ctx
, int flags
)
1072 int oldflags
= ctx
->flags
;
1074 ctx
->flags
|= flags
;
1075 if (((oldflags
^ ctx
->flags
) & EVP_CIPH_FLAG_LENGTH_BITS
) != 0)
1076 evp_cipher_ctx_enable_use_bits(ctx
, 1);
1079 void EVP_CIPHER_CTX_clear_flags(EVP_CIPHER_CTX
*ctx
, int flags
)
1081 int oldflags
= ctx
->flags
;
1083 ctx
->flags
&= ~flags
;
1084 if (((oldflags
^ ctx
->flags
) & EVP_CIPH_FLAG_LENGTH_BITS
) != 0)
1085 evp_cipher_ctx_enable_use_bits(ctx
, 0);
1088 int EVP_CIPHER_CTX_test_flags(const EVP_CIPHER_CTX
*ctx
, int flags
)
1090 return (ctx
->flags
& flags
);
1093 int EVP_PKEY_CTX_set_group_name(EVP_PKEY_CTX
*ctx
, const char *name
)
1095 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1097 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_GEN_OP(ctx
)) {
1098 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1099 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1106 params
[0] = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME
,
1108 return EVP_PKEY_CTX_set_params(ctx
, params
);
1111 int EVP_PKEY_CTX_get_group_name(EVP_PKEY_CTX
*ctx
, char *name
, size_t namelen
)
1113 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1114 OSSL_PARAM
*p
= params
;
1116 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_GEN_OP(ctx
)) {
1117 /* There is no legacy support for this */
1118 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1119 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1126 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME
,
1128 if (!EVP_PKEY_CTX_get_params(ctx
, params
))
1134 * evp_pkey_keygen() abstracts from the explicit use of B<EVP_PKEY_CTX>
1135 * while providing a generic way of generating a new asymmetric key pair
1136 * of algorithm type I<name> (e.g., C<RSA> or C<EC>).
1137 * The library context I<libctx> and property query I<propq>
1138 * are used when fetching algorithms from providers.
1139 * The I<params> specify algorithm-specific parameters
1140 * such as the RSA modulus size or the name of an EC curve.
1142 static EVP_PKEY
*evp_pkey_keygen(OSSL_LIB_CTX
*libctx
, const char *name
,
1143 const char *propq
, const OSSL_PARAM
*params
)
1145 EVP_PKEY
*pkey
= NULL
;
1146 EVP_PKEY_CTX
*ctx
= EVP_PKEY_CTX_new_from_name(libctx
, name
, propq
);
1149 && EVP_PKEY_keygen_init(ctx
) > 0
1150 && EVP_PKEY_CTX_set_params(ctx
, params
))
1151 (void)EVP_PKEY_generate(ctx
, &pkey
);
1153 EVP_PKEY_CTX_free(ctx
);
1157 EVP_PKEY
*EVP_PKEY_Q_keygen(OSSL_LIB_CTX
*libctx
, const char *propq
,
1158 const char *type
, ...)
1163 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1164 EVP_PKEY
*ret
= NULL
;
1166 va_start(args
, type
);
1168 if (strcasecmp(type
, "RSA") == 0) {
1169 bits
= va_arg(args
, size_t);
1170 params
[0] = OSSL_PARAM_construct_size_t(OSSL_PKEY_PARAM_RSA_BITS
, &bits
);
1171 } else if (strcasecmp(type
, "EC") == 0) {
1172 name
= va_arg(args
, char *);
1173 params
[0] = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME
,
1175 } else if (strcasecmp(type
, "ED25519") != 0
1176 && strcasecmp(type
, "X25519") != 0
1177 && strcasecmp(type
, "ED448") != 0
1178 && strcasecmp(type
, "X448") != 0) {
1179 ERR_raise(ERR_LIB_EVP
, ERR_R_PASSED_INVALID_ARGUMENT
);
1182 ret
= evp_pkey_keygen(libctx
, type
, propq
, params
);