2 * Copyright 1995-2022 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 "internal/cryptlib.h"
19 #include <openssl/evp.h>
20 #include <openssl/objects.h>
21 #include <openssl/params.h>
22 #include <openssl/core_names.h>
23 #include <openssl/rsa.h>
24 #include <openssl/dh.h>
25 #include <openssl/ec.h>
26 #include "crypto/evp.h"
27 #include "internal/provider.h"
28 #include "evp_local.h"
30 #if !defined(FIPS_MODULE)
31 # include "crypto/asn1.h"
33 int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
)
35 return evp_cipher_param_to_asn1_ex(c
, type
, NULL
);
38 int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
)
40 return evp_cipher_asn1_to_param_ex(c
, type
, NULL
);
43 int EVP_CIPHER_get_asn1_iv(EVP_CIPHER_CTX
*ctx
, ASN1_TYPE
*type
)
49 unsigned char iv
[EVP_MAX_IV_LENGTH
];
51 l
= EVP_CIPHER_CTX_get_iv_length(ctx
);
52 if (!ossl_assert(l
<= sizeof(iv
)))
54 i
= ASN1_TYPE_get_octetstring(type
, iv
, l
);
58 if (!EVP_CipherInit_ex(ctx
, NULL
, NULL
, NULL
, iv
, -1))
64 int EVP_CIPHER_set_asn1_iv(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
)
68 unsigned char *oiv
= NULL
;
71 oiv
= (unsigned char *)EVP_CIPHER_CTX_original_iv(c
);
72 j
= EVP_CIPHER_CTX_get_iv_length(c
);
73 OPENSSL_assert(j
<= sizeof(c
->iv
));
74 i
= ASN1_TYPE_set_octetstring(type
, oiv
, j
);
79 int evp_cipher_param_to_asn1_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
80 evp_cipher_aead_asn1_params
*asn1_params
)
82 int ret
= -1; /* Assume the worst */
83 const EVP_CIPHER
*cipher
= c
->cipher
;
86 * For legacy implementations, we detect custom AlgorithmIdentifier
87 * parameter handling by checking if the function pointer
88 * cipher->set_asn1_parameters is set. We know that this pointer
89 * is NULL for provided implementations.
91 * Otherwise, for any implementation, we check the flag
92 * EVP_CIPH_FLAG_CUSTOM_ASN1. If it isn't set, we apply
93 * default AI parameter extraction.
95 * Otherwise, for provided implementations, we convert |type| to
96 * a DER encoded blob and pass to the implementation in OSSL_PARAM
99 * If none of the above applies, this operation is unsupported.
101 if (cipher
->set_asn1_parameters
!= NULL
) {
102 ret
= cipher
->set_asn1_parameters(c
, type
);
103 } else if ((EVP_CIPHER_get_flags(cipher
) & EVP_CIPH_FLAG_CUSTOM_ASN1
) == 0) {
104 switch (EVP_CIPHER_get_mode(cipher
)) {
105 case EVP_CIPH_WRAP_MODE
:
106 if (EVP_CIPHER_is_a(cipher
, SN_id_smime_alg_CMS3DESwrap
))
107 ASN1_TYPE_set(type
, V_ASN1_NULL
, NULL
);
111 case EVP_CIPH_GCM_MODE
:
112 ret
= evp_cipher_set_asn1_aead_params(c
, type
, asn1_params
);
115 case EVP_CIPH_CCM_MODE
:
116 case EVP_CIPH_XTS_MODE
:
117 case EVP_CIPH_OCB_MODE
:
122 ret
= EVP_CIPHER_set_asn1_iv(c
, type
);
124 } else if (cipher
->prov
!= NULL
) {
125 OSSL_PARAM params
[3], *p
= params
;
126 unsigned char *der
= NULL
, *derp
;
129 * We make two passes, the first to get the appropriate buffer size,
130 * and the second to get the actual value.
132 *p
++ = OSSL_PARAM_construct_octet_string(
133 OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS
,
135 *p
= OSSL_PARAM_construct_end();
137 if (!EVP_CIPHER_CTX_get_params(c
, params
))
140 /* ... but, we should get a return size too! */
141 if (OSSL_PARAM_modified(params
)
142 && params
[0].return_size
!= 0
143 && (der
= OPENSSL_malloc(params
[0].return_size
)) != NULL
) {
144 params
[0].data
= der
;
145 params
[0].data_size
= params
[0].return_size
;
146 OSSL_PARAM_set_all_unmodified(params
);
148 if (EVP_CIPHER_CTX_get_params(c
, params
)
149 && OSSL_PARAM_modified(params
)
150 && d2i_ASN1_TYPE(&type
, (const unsigned char **)&derp
,
151 params
[0].return_size
) != NULL
) {
162 ERR_raise(ERR_LIB_EVP
, EVP_R_UNSUPPORTED_CIPHER
);
164 ERR_raise(ERR_LIB_EVP
, EVP_R_CIPHER_PARAMETER_ERROR
);
170 int evp_cipher_asn1_to_param_ex(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
171 evp_cipher_aead_asn1_params
*asn1_params
)
173 int ret
= -1; /* Assume the worst */
174 const EVP_CIPHER
*cipher
= c
->cipher
;
177 * For legacy implementations, we detect custom AlgorithmIdentifier
178 * parameter handling by checking if there the function pointer
179 * cipher->get_asn1_parameters is set. We know that this pointer
180 * is NULL for provided implementations.
182 * Otherwise, for any implementation, we check the flag
183 * EVP_CIPH_FLAG_CUSTOM_ASN1. If it isn't set, we apply
184 * default AI parameter creation.
186 * Otherwise, for provided implementations, we get the AI parameter
187 * in DER encoded form from the implementation by requesting the
188 * appropriate OSSL_PARAM and converting the result to a ASN1_TYPE.
190 * If none of the above applies, this operation is unsupported.
192 if (cipher
->get_asn1_parameters
!= NULL
) {
193 ret
= cipher
->get_asn1_parameters(c
, type
);
194 } else if ((EVP_CIPHER_get_flags(cipher
) & EVP_CIPH_FLAG_CUSTOM_ASN1
) == 0) {
195 switch (EVP_CIPHER_get_mode(cipher
)) {
196 case EVP_CIPH_WRAP_MODE
:
200 case EVP_CIPH_GCM_MODE
:
201 ret
= evp_cipher_get_asn1_aead_params(c
, type
, asn1_params
);
204 case EVP_CIPH_CCM_MODE
:
205 case EVP_CIPH_XTS_MODE
:
206 case EVP_CIPH_OCB_MODE
:
211 ret
= EVP_CIPHER_get_asn1_iv(c
, type
);
213 } else if (cipher
->prov
!= NULL
) {
214 OSSL_PARAM params
[3], *p
= params
;
215 unsigned char *der
= NULL
;
218 if ((derl
= i2d_ASN1_TYPE(type
, &der
)) >= 0) {
220 OSSL_PARAM_construct_octet_string(
221 OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS
,
223 *p
= OSSL_PARAM_construct_end();
224 if (EVP_CIPHER_CTX_set_params(c
, params
))
233 ERR_raise(ERR_LIB_EVP
, EVP_R_UNSUPPORTED_CIPHER
);
235 ERR_raise(ERR_LIB_EVP
, EVP_R_CIPHER_PARAMETER_ERROR
);
241 int evp_cipher_get_asn1_aead_params(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
242 evp_cipher_aead_asn1_params
*asn1_params
)
246 unsigned char iv
[EVP_MAX_IV_LENGTH
];
248 if (type
== NULL
|| asn1_params
== NULL
)
251 i
= ossl_asn1_type_get_octetstring_int(type
, &tl
, NULL
, EVP_MAX_IV_LENGTH
);
254 ossl_asn1_type_get_octetstring_int(type
, &tl
, iv
, i
);
256 memcpy(asn1_params
->iv
, iv
, i
);
257 asn1_params
->iv_len
= i
;
262 int evp_cipher_set_asn1_aead_params(EVP_CIPHER_CTX
*c
, ASN1_TYPE
*type
,
263 evp_cipher_aead_asn1_params
*asn1_params
)
265 if (type
== NULL
|| asn1_params
== NULL
)
268 return ossl_asn1_type_set_octetstring_int(type
, asn1_params
->tag_len
,
270 asn1_params
->iv_len
);
272 #endif /* !defined(FIPS_MODULE) */
274 /* Convert the various cipher NIDs and dummies to a proper OID NID */
275 int EVP_CIPHER_get_type(const EVP_CIPHER
*cipher
)
278 nid
= EVP_CIPHER_get_nid(cipher
);
293 case NID_aes_128_cfb128
:
294 case NID_aes_128_cfb8
:
295 case NID_aes_128_cfb1
:
297 return NID_aes_128_cfb128
;
299 case NID_aes_192_cfb128
:
300 case NID_aes_192_cfb8
:
301 case NID_aes_192_cfb1
:
303 return NID_aes_192_cfb128
;
305 case NID_aes_256_cfb128
:
306 case NID_aes_256_cfb8
:
307 case NID_aes_256_cfb1
:
309 return NID_aes_256_cfb128
;
315 return NID_des_cfb64
;
317 case NID_des_ede3_cfb64
:
318 case NID_des_ede3_cfb8
:
319 case NID_des_ede3_cfb1
:
321 return NID_des_cfb64
;
328 /* Check it has an OID and it is valid */
329 ASN1_OBJECT
*otmp
= OBJ_nid2obj(nid
);
331 if (OBJ_get0_data(otmp
) == NULL
)
333 ASN1_OBJECT_free(otmp
);
340 int evp_cipher_cache_constants(EVP_CIPHER
*cipher
)
342 int ok
, aead
= 0, custom_iv
= 0, cts
= 0, multiblock
= 0, randkey
= 0;
346 unsigned int mode
= 0;
347 OSSL_PARAM params
[10];
349 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_BLOCK_SIZE
, &blksz
);
350 params
[1] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN
, &ivlen
);
351 params
[2] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN
, &keylen
);
352 params
[3] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_MODE
, &mode
);
353 params
[4] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_AEAD
, &aead
);
354 params
[5] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_CUSTOM_IV
,
356 params
[6] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_CTS
, &cts
);
357 params
[7] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK
,
359 params
[8] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_HAS_RAND_KEY
,
361 params
[9] = OSSL_PARAM_construct_end();
362 ok
= evp_do_ciph_getparams(cipher
, params
) > 0;
364 cipher
->block_size
= blksz
;
365 cipher
->iv_len
= ivlen
;
366 cipher
->key_len
= keylen
;
367 cipher
->flags
= mode
;
369 cipher
->flags
|= EVP_CIPH_FLAG_AEAD_CIPHER
;
371 cipher
->flags
|= EVP_CIPH_CUSTOM_IV
;
373 cipher
->flags
|= EVP_CIPH_FLAG_CTS
;
375 cipher
->flags
|= EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
;
376 if (cipher
->ccipher
!= NULL
)
377 cipher
->flags
|= EVP_CIPH_FLAG_CUSTOM_CIPHER
;
379 cipher
->flags
|= EVP_CIPH_RAND_KEY
;
380 if (OSSL_PARAM_locate_const(EVP_CIPHER_gettable_ctx_params(cipher
),
381 OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS
))
382 cipher
->flags
|= EVP_CIPH_FLAG_CUSTOM_ASN1
;
387 int EVP_CIPHER_get_block_size(const EVP_CIPHER
*cipher
)
389 return cipher
->block_size
;
392 int EVP_CIPHER_CTX_get_block_size(const EVP_CIPHER_CTX
*ctx
)
394 return EVP_CIPHER_get_block_size(ctx
->cipher
);
397 int EVP_CIPHER_impl_ctx_size(const EVP_CIPHER
*e
)
402 int EVP_Cipher(EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
403 const unsigned char *in
, unsigned int inl
)
405 if (ctx
->cipher
->prov
!= NULL
) {
407 * If the provided implementation has a ccipher function, we use it,
408 * and translate its return value like this: 0 => -1, 1 => outlen
410 * Otherwise, we call the cupdate function if in != NULL, or cfinal
411 * if in == NULL. Regardless of which, we return what we got.
415 size_t blocksize
= EVP_CIPHER_CTX_get_block_size(ctx
);
417 if (ctx
->cipher
->ccipher
!= NULL
)
418 ret
= ctx
->cipher
->ccipher(ctx
->algctx
, out
, &outl
,
419 inl
+ (blocksize
== 1 ? 0 : blocksize
),
423 ret
= ctx
->cipher
->cupdate(ctx
->algctx
, out
, &outl
,
424 inl
+ (blocksize
== 1 ? 0 : blocksize
),
427 ret
= ctx
->cipher
->cfinal(ctx
->algctx
, out
, &outl
,
428 blocksize
== 1 ? 0 : blocksize
);
433 return ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
436 #ifndef OPENSSL_NO_DEPRECATED_3_0
437 const EVP_CIPHER
*EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX
*ctx
)
445 const EVP_CIPHER
*EVP_CIPHER_CTX_get0_cipher(const EVP_CIPHER_CTX
*ctx
)
452 EVP_CIPHER
*EVP_CIPHER_CTX_get1_cipher(EVP_CIPHER_CTX
*ctx
)
458 cipher
= (EVP_CIPHER
*)ctx
->cipher
;
459 if (!EVP_CIPHER_up_ref(cipher
))
464 int EVP_CIPHER_CTX_is_encrypting(const EVP_CIPHER_CTX
*ctx
)
469 unsigned long EVP_CIPHER_get_flags(const EVP_CIPHER
*cipher
)
471 return cipher
->flags
;
474 void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX
*ctx
)
476 return ctx
->app_data
;
479 void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX
*ctx
, void *data
)
481 ctx
->app_data
= data
;
484 void *EVP_CIPHER_CTX_get_cipher_data(const EVP_CIPHER_CTX
*ctx
)
486 return ctx
->cipher_data
;
489 void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX
*ctx
, void *cipher_data
)
491 void *old_cipher_data
;
493 old_cipher_data
= ctx
->cipher_data
;
494 ctx
->cipher_data
= cipher_data
;
496 return old_cipher_data
;
499 int EVP_CIPHER_get_iv_length(const EVP_CIPHER
*cipher
)
501 return cipher
->iv_len
;
504 int EVP_CIPHER_CTX_get_iv_length(const EVP_CIPHER_CTX
*ctx
)
506 if (ctx
->iv_len
< 0) {
507 int rv
, len
= EVP_CIPHER_get_iv_length(ctx
->cipher
);
509 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
511 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN
, &v
);
512 rv
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
513 if (rv
!= EVP_CTRL_RET_UNSUPPORTED
) {
518 /* Code below to be removed when legacy support is dropped. */
519 else if ((EVP_CIPHER_get_flags(ctx
->cipher
)
520 & EVP_CIPH_CUSTOM_IV_LENGTH
) != 0) {
521 rv
= EVP_CIPHER_CTX_ctrl((EVP_CIPHER_CTX
*)ctx
, EVP_CTRL_GET_IVLEN
,
527 * Casting away the const is annoying but required here. We need to
528 * cache the result for performance reasons.
530 ((EVP_CIPHER_CTX
*)ctx
)->iv_len
= len
;
535 int EVP_CIPHER_CTX_get_tag_length(const EVP_CIPHER_CTX
*ctx
)
539 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
541 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN
, &v
);
542 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
543 return ret
== 1 ? (int)v
: 0;
546 #ifndef OPENSSL_NO_DEPRECATED_3_0
547 const unsigned char *EVP_CIPHER_CTX_original_iv(const EVP_CIPHER_CTX
*ctx
)
550 const unsigned char *v
= ctx
->oiv
;
551 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
554 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_IV
,
555 (void **)&v
, sizeof(ctx
->oiv
));
556 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
558 return ok
!= 0 ? v
: NULL
;
562 * OSSL_PARAM_OCTET_PTR gets us the pointer to the running IV in the provider
564 const unsigned char *EVP_CIPHER_CTX_iv(const EVP_CIPHER_CTX
*ctx
)
567 const unsigned char *v
= ctx
->iv
;
568 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
571 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_UPDATED_IV
,
572 (void **)&v
, sizeof(ctx
->iv
));
573 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
575 return ok
!= 0 ? v
: NULL
;
578 unsigned char *EVP_CIPHER_CTX_iv_noconst(EVP_CIPHER_CTX
*ctx
)
581 unsigned char *v
= ctx
->iv
;
582 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
585 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_UPDATED_IV
,
586 (void **)&v
, sizeof(ctx
->iv
));
587 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
589 return ok
!= 0 ? v
: NULL
;
591 #endif /* OPENSSL_NO_DEPRECATED_3_0_0 */
593 int EVP_CIPHER_CTX_get_updated_iv(EVP_CIPHER_CTX
*ctx
, void *buf
, size_t len
)
595 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
598 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_UPDATED_IV
, buf
, len
);
599 return evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
602 int EVP_CIPHER_CTX_get_original_iv(EVP_CIPHER_CTX
*ctx
, void *buf
, size_t len
)
604 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
607 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV
, buf
, len
);
608 return evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
611 unsigned char *EVP_CIPHER_CTX_buf_noconst(EVP_CIPHER_CTX
*ctx
)
616 int EVP_CIPHER_CTX_get_num(const EVP_CIPHER_CTX
*ctx
)
619 unsigned int v
= (unsigned int)ctx
->num
;
620 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
622 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_NUM
, &v
);
623 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
625 return ok
!= 0 ? (int)v
: EVP_CTRL_RET_UNSUPPORTED
;
628 int EVP_CIPHER_CTX_set_num(EVP_CIPHER_CTX
*ctx
, int num
)
631 unsigned int n
= (unsigned int)num
;
632 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
634 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_NUM
, &n
);
635 ok
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->algctx
, params
);
642 int EVP_CIPHER_get_key_length(const EVP_CIPHER
*cipher
)
644 return cipher
->key_len
;
647 int EVP_CIPHER_CTX_get_key_length(const EVP_CIPHER_CTX
*ctx
)
649 if (ctx
->key_len
<= 0 && ctx
->cipher
->prov
!= NULL
) {
651 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
654 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN
, &len
);
655 ok
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->algctx
, params
);
657 return EVP_CTRL_RET_UNSUPPORTED
;
660 * The if branch should never be taken since EVP_MAX_KEY_LENGTH is
661 * less than INT_MAX but best to be safe.
663 * Casting away the const is annoying but required here. We need to
664 * cache the result for performance reasons.
666 if (!OSSL_PARAM_get_int(params
, &((EVP_CIPHER_CTX
*)ctx
)->key_len
))
668 ((EVP_CIPHER_CTX
*)ctx
)->key_len
= (int)len
;
673 int EVP_CIPHER_get_nid(const EVP_CIPHER
*cipher
)
678 int EVP_CIPHER_CTX_get_nid(const EVP_CIPHER_CTX
*ctx
)
680 return ctx
->cipher
->nid
;
683 int EVP_CIPHER_is_a(const EVP_CIPHER
*cipher
, const char *name
)
685 if (cipher
->prov
!= NULL
)
686 return evp_is_a(cipher
->prov
, cipher
->name_id
, NULL
, name
);
687 return evp_is_a(NULL
, 0, EVP_CIPHER_get0_name(cipher
), name
);
690 int evp_cipher_get_number(const EVP_CIPHER
*cipher
)
692 return cipher
->name_id
;
695 const char *EVP_CIPHER_get0_name(const EVP_CIPHER
*cipher
)
697 if (cipher
->type_name
!= NULL
)
698 return cipher
->type_name
;
700 return OBJ_nid2sn(EVP_CIPHER_get_nid(cipher
));
706 const char *EVP_CIPHER_get0_description(const EVP_CIPHER
*cipher
)
708 if (cipher
->description
!= NULL
)
709 return cipher
->description
;
711 return OBJ_nid2ln(EVP_CIPHER_get_nid(cipher
));
717 int EVP_CIPHER_names_do_all(const EVP_CIPHER
*cipher
,
718 void (*fn
)(const char *name
, void *data
),
721 if (cipher
->prov
!= NULL
)
722 return evp_names_do_all(cipher
->prov
, cipher
->name_id
, fn
, data
);
727 const OSSL_PROVIDER
*EVP_CIPHER_get0_provider(const EVP_CIPHER
*cipher
)
732 int EVP_CIPHER_get_mode(const EVP_CIPHER
*cipher
)
734 return EVP_CIPHER_get_flags(cipher
) & EVP_CIPH_MODE
;
737 int EVP_MD_is_a(const EVP_MD
*md
, const char *name
)
739 if (md
->prov
!= NULL
)
740 return evp_is_a(md
->prov
, md
->name_id
, NULL
, name
);
741 return evp_is_a(NULL
, 0, EVP_MD_get0_name(md
), name
);
744 int evp_md_get_number(const EVP_MD
*md
)
749 const char *EVP_MD_get0_description(const EVP_MD
*md
)
751 if (md
->description
!= NULL
)
752 return md
->description
;
754 return OBJ_nid2ln(EVP_MD_nid(md
));
760 const char *EVP_MD_get0_name(const EVP_MD
*md
)
764 if (md
->type_name
!= NULL
)
765 return md
->type_name
;
767 return OBJ_nid2sn(EVP_MD_nid(md
));
773 int EVP_MD_names_do_all(const EVP_MD
*md
,
774 void (*fn
)(const char *name
, void *data
),
777 if (md
->prov
!= NULL
)
778 return evp_names_do_all(md
->prov
, md
->name_id
, fn
, data
);
783 const OSSL_PROVIDER
*EVP_MD_get0_provider(const EVP_MD
*md
)
788 int EVP_MD_get_type(const EVP_MD
*md
)
793 int EVP_MD_get_pkey_type(const EVP_MD
*md
)
795 return md
->pkey_type
;
798 int EVP_MD_get_block_size(const EVP_MD
*md
)
801 ERR_raise(ERR_LIB_EVP
, EVP_R_MESSAGE_DIGEST_IS_NULL
);
804 return md
->block_size
;
807 int EVP_MD_get_size(const EVP_MD
*md
)
810 ERR_raise(ERR_LIB_EVP
, EVP_R_MESSAGE_DIGEST_IS_NULL
);
816 unsigned long EVP_MD_get_flags(const EVP_MD
*md
)
821 EVP_MD
*EVP_MD_meth_new(int md_type
, int pkey_type
)
823 EVP_MD
*md
= evp_md_new();
827 md
->pkey_type
= pkey_type
;
828 md
->origin
= EVP_ORIG_METH
;
833 EVP_MD
*EVP_MD_meth_dup(const EVP_MD
*md
)
838 * Non-legacy EVP_MDs can't be duplicated like this.
839 * Use EVP_MD_up_ref() instead.
841 if (md
->prov
!= NULL
)
844 if ((to
= EVP_MD_meth_new(md
->type
, md
->pkey_type
)) != NULL
) {
845 CRYPTO_RWLOCK
*lock
= to
->lock
;
847 memcpy(to
, md
, sizeof(*to
));
849 to
->origin
= EVP_ORIG_METH
;
854 void evp_md_free_int(EVP_MD
*md
)
856 OPENSSL_free(md
->type_name
);
857 ossl_provider_free(md
->prov
);
858 CRYPTO_THREAD_lock_free(md
->lock
);
862 void EVP_MD_meth_free(EVP_MD
*md
)
864 if (md
== NULL
|| md
->origin
!= EVP_ORIG_METH
)
870 int EVP_MD_meth_set_input_blocksize(EVP_MD
*md
, int blocksize
)
872 if (md
->block_size
!= 0)
875 md
->block_size
= blocksize
;
878 int EVP_MD_meth_set_result_size(EVP_MD
*md
, int resultsize
)
880 if (md
->md_size
!= 0)
883 md
->md_size
= resultsize
;
886 int EVP_MD_meth_set_app_datasize(EVP_MD
*md
, int datasize
)
888 if (md
->ctx_size
!= 0)
891 md
->ctx_size
= datasize
;
894 int EVP_MD_meth_set_flags(EVP_MD
*md
, unsigned long flags
)
902 int EVP_MD_meth_set_init(EVP_MD
*md
, int (*init
)(EVP_MD_CTX
*ctx
))
904 if (md
->init
!= NULL
)
910 int EVP_MD_meth_set_update(EVP_MD
*md
, int (*update
)(EVP_MD_CTX
*ctx
,
914 if (md
->update
!= NULL
)
920 int EVP_MD_meth_set_final(EVP_MD
*md
, int (*final
)(EVP_MD_CTX
*ctx
,
923 if (md
->final
!= NULL
)
929 int EVP_MD_meth_set_copy(EVP_MD
*md
, int (*copy
)(EVP_MD_CTX
*to
,
930 const EVP_MD_CTX
*from
))
932 if (md
->copy
!= NULL
)
938 int EVP_MD_meth_set_cleanup(EVP_MD
*md
, int (*cleanup
)(EVP_MD_CTX
*ctx
))
940 if (md
->cleanup
!= NULL
)
943 md
->cleanup
= cleanup
;
946 int EVP_MD_meth_set_ctrl(EVP_MD
*md
, int (*ctrl
)(EVP_MD_CTX
*ctx
, int cmd
,
949 if (md
->md_ctrl
!= NULL
)
956 int EVP_MD_meth_get_input_blocksize(const EVP_MD
*md
)
958 return md
->block_size
;
960 int EVP_MD_meth_get_result_size(const EVP_MD
*md
)
964 int EVP_MD_meth_get_app_datasize(const EVP_MD
*md
)
968 unsigned long EVP_MD_meth_get_flags(const EVP_MD
*md
)
972 int (*EVP_MD_meth_get_init(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
)
976 int (*EVP_MD_meth_get_update(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
,
982 int (*EVP_MD_meth_get_final(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
,
987 int (*EVP_MD_meth_get_copy(const EVP_MD
*md
))(EVP_MD_CTX
*to
,
988 const EVP_MD_CTX
*from
)
992 int (*EVP_MD_meth_get_cleanup(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
)
996 int (*EVP_MD_meth_get_ctrl(const EVP_MD
*md
))(EVP_MD_CTX
*ctx
, int cmd
,
1002 #ifndef OPENSSL_NO_DEPRECATED_3_0
1003 const EVP_MD
*EVP_MD_CTX_md(const EVP_MD_CTX
*ctx
)
1007 return ctx
->reqdigest
;
1011 const EVP_MD
*EVP_MD_CTX_get0_md(const EVP_MD_CTX
*ctx
)
1015 return ctx
->reqdigest
;
1018 EVP_MD
*EVP_MD_CTX_get1_md(EVP_MD_CTX
*ctx
)
1024 md
= (EVP_MD
*)ctx
->reqdigest
;
1025 if (md
== NULL
|| !EVP_MD_up_ref(md
))
1030 EVP_PKEY_CTX
*EVP_MD_CTX_get_pkey_ctx(const EVP_MD_CTX
*ctx
)
1035 #if !defined(FIPS_MODULE)
1036 void EVP_MD_CTX_set_pkey_ctx(EVP_MD_CTX
*ctx
, EVP_PKEY_CTX
*pctx
)
1039 * it's reasonable to set NULL pctx (a.k.a clear the ctx->pctx), so
1040 * we have to deal with the cleanup job here.
1042 if (!EVP_MD_CTX_test_flags(ctx
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
))
1043 EVP_PKEY_CTX_free(ctx
->pctx
);
1048 /* make sure pctx is not freed when destroying EVP_MD_CTX */
1049 EVP_MD_CTX_set_flags(ctx
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
);
1051 EVP_MD_CTX_clear_flags(ctx
, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX
);
1054 #endif /* !defined(FIPS_MODULE) */
1056 void *EVP_MD_CTX_get0_md_data(const EVP_MD_CTX
*ctx
)
1058 return ctx
->md_data
;
1061 int (*EVP_MD_CTX_update_fn(EVP_MD_CTX
*ctx
))(EVP_MD_CTX
*ctx
,
1062 const void *data
, size_t count
)
1067 void EVP_MD_CTX_set_update_fn(EVP_MD_CTX
*ctx
,
1068 int (*update
) (EVP_MD_CTX
*ctx
,
1069 const void *data
, size_t count
))
1071 ctx
->update
= update
;
1074 void EVP_MD_CTX_set_flags(EVP_MD_CTX
*ctx
, int flags
)
1076 ctx
->flags
|= flags
;
1079 void EVP_MD_CTX_clear_flags(EVP_MD_CTX
*ctx
, int flags
)
1081 ctx
->flags
&= ~flags
;
1084 int EVP_MD_CTX_test_flags(const EVP_MD_CTX
*ctx
, int flags
)
1086 return (ctx
->flags
& flags
);
1089 static int evp_cipher_ctx_enable_use_bits(EVP_CIPHER_CTX
*ctx
,
1090 unsigned int enable
)
1092 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1094 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_USE_BITS
, &enable
);
1095 return EVP_CIPHER_CTX_set_params(ctx
, params
);
1098 void EVP_CIPHER_CTX_set_flags(EVP_CIPHER_CTX
*ctx
, int flags
)
1100 int oldflags
= ctx
->flags
;
1102 ctx
->flags
|= flags
;
1103 if (((oldflags
^ ctx
->flags
) & EVP_CIPH_FLAG_LENGTH_BITS
) != 0)
1104 evp_cipher_ctx_enable_use_bits(ctx
, 1);
1107 void EVP_CIPHER_CTX_clear_flags(EVP_CIPHER_CTX
*ctx
, int flags
)
1109 int oldflags
= ctx
->flags
;
1111 ctx
->flags
&= ~flags
;
1112 if (((oldflags
^ ctx
->flags
) & EVP_CIPH_FLAG_LENGTH_BITS
) != 0)
1113 evp_cipher_ctx_enable_use_bits(ctx
, 0);
1116 int EVP_CIPHER_CTX_test_flags(const EVP_CIPHER_CTX
*ctx
, int flags
)
1118 return (ctx
->flags
& flags
);
1121 int EVP_PKEY_CTX_set_group_name(EVP_PKEY_CTX
*ctx
, const char *name
)
1123 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1125 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_GEN_OP(ctx
)) {
1126 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1127 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1134 params
[0] = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME
,
1136 return EVP_PKEY_CTX_set_params(ctx
, params
);
1139 int EVP_PKEY_CTX_get_group_name(EVP_PKEY_CTX
*ctx
, char *name
, size_t namelen
)
1141 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1142 OSSL_PARAM
*p
= params
;
1144 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_GEN_OP(ctx
)) {
1145 /* There is no legacy support for this */
1146 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1147 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1154 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME
,
1156 if (!EVP_PKEY_CTX_get_params(ctx
, params
))
1162 * evp_pkey_keygen() abstracts from the explicit use of B<EVP_PKEY_CTX>
1163 * while providing a generic way of generating a new asymmetric key pair
1164 * of algorithm type I<name> (e.g., C<RSA> or C<EC>).
1165 * The library context I<libctx> and property query I<propq>
1166 * are used when fetching algorithms from providers.
1167 * The I<params> specify algorithm-specific parameters
1168 * such as the RSA modulus size or the name of an EC curve.
1170 static EVP_PKEY
*evp_pkey_keygen(OSSL_LIB_CTX
*libctx
, const char *name
,
1171 const char *propq
, const OSSL_PARAM
*params
)
1173 EVP_PKEY
*pkey
= NULL
;
1174 EVP_PKEY_CTX
*ctx
= EVP_PKEY_CTX_new_from_name(libctx
, name
, propq
);
1177 && EVP_PKEY_keygen_init(ctx
) > 0
1178 && EVP_PKEY_CTX_set_params(ctx
, params
))
1179 (void)EVP_PKEY_generate(ctx
, &pkey
);
1181 EVP_PKEY_CTX_free(ctx
);
1185 EVP_PKEY
*EVP_PKEY_Q_keygen(OSSL_LIB_CTX
*libctx
, const char *propq
,
1186 const char *type
, ...)
1191 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1192 EVP_PKEY
*ret
= NULL
;
1194 va_start(args
, type
);
1196 if (OPENSSL_strcasecmp(type
, "RSA") == 0) {
1197 bits
= va_arg(args
, size_t);
1198 params
[0] = OSSL_PARAM_construct_size_t(OSSL_PKEY_PARAM_RSA_BITS
, &bits
);
1199 } else if (OPENSSL_strcasecmp(type
, "EC") == 0) {
1200 name
= va_arg(args
, char *);
1201 params
[0] = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME
,
1203 } else if (OPENSSL_strcasecmp(type
, "ED25519") != 0
1204 && OPENSSL_strcasecmp(type
, "X25519") != 0
1205 && OPENSSL_strcasecmp(type
, "ED448") != 0
1206 && OPENSSL_strcasecmp(type
, "X448") != 0) {
1207 ERR_raise(ERR_LIB_EVP
, ERR_R_PASSED_INVALID_ARGUMENT
);
1210 ret
= evp_pkey_keygen(libctx
, type
, propq
, params
);