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/evp.h>
13 #include <openssl/objects.h>
14 #include <openssl/params.h>
15 #include <openssl/core_names.h>
16 #include <openssl/dh.h>
17 #include "crypto/evp.h"
18 #include "internal/provider.h"
21 #if !defined(FIPS_MODE)
22 int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
25 const EVP_CIPHER *cipher = c->cipher;
27 if (cipher->prov != NULL) {
29 * The cipher has come from a provider and won't have the default flags.
30 * Find the implicit form so we can check the flags.
31 * TODO(3.0): This won't work for 3rd party ciphers we know nothing about
32 * We'll need to think of something else for those.
34 cipher = EVP_get_cipherbynid(cipher->nid);
36 EVPerr(EVP_F_EVP_CIPHER_PARAM_TO_ASN1, ASN1_R_UNSUPPORTED_CIPHER);
41 if (cipher->set_asn1_parameters != NULL)
42 ret = cipher->set_asn1_parameters(c, type);
43 else if (cipher->flags & EVP_CIPH_FLAG_DEFAULT_ASN1) {
44 switch (EVP_CIPHER_mode(cipher)) {
45 case EVP_CIPH_WRAP_MODE:
46 if (EVP_CIPHER_nid(cipher) == NID_id_smime_alg_CMS3DESwrap)
47 ASN1_TYPE_set(type, V_ASN1_NULL, NULL);
51 case EVP_CIPH_GCM_MODE:
52 case EVP_CIPH_CCM_MODE:
53 case EVP_CIPH_XTS_MODE:
54 case EVP_CIPH_OCB_MODE:
59 ret = EVP_CIPHER_set_asn1_iv(c, type);
64 EVPerr(EVP_F_EVP_CIPHER_PARAM_TO_ASN1, ASN1_R_UNSUPPORTED_CIPHER);
66 EVPerr(EVP_F_EVP_CIPHER_PARAM_TO_ASN1, EVP_R_CIPHER_PARAMETER_ERROR);
72 int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
75 const EVP_CIPHER *cipher = c->cipher;
77 if (cipher->prov != NULL) {
79 * The cipher has come from a provider and won't have the default flags.
80 * Find the implicit form so we can check the flags.
82 cipher = EVP_get_cipherbynid(cipher->nid);
87 if (cipher->get_asn1_parameters != NULL)
88 ret = cipher->get_asn1_parameters(c, type);
89 else if (cipher->flags & EVP_CIPH_FLAG_DEFAULT_ASN1) {
90 switch (EVP_CIPHER_mode(cipher)) {
92 case EVP_CIPH_WRAP_MODE:
96 case EVP_CIPH_GCM_MODE:
97 case EVP_CIPH_CCM_MODE:
98 case EVP_CIPH_XTS_MODE:
99 case EVP_CIPH_OCB_MODE:
104 ret = EVP_CIPHER_get_asn1_iv(c, type);
110 EVPerr(EVP_F_EVP_CIPHER_ASN1_TO_PARAM, EVP_R_UNSUPPORTED_CIPHER);
112 EVPerr(EVP_F_EVP_CIPHER_ASN1_TO_PARAM, EVP_R_CIPHER_PARAMETER_ERROR);
118 int EVP_CIPHER_get_asn1_iv(EVP_CIPHER_CTX *ctx, ASN1_TYPE *type)
124 unsigned char iv[EVP_MAX_IV_LENGTH];
126 l = EVP_CIPHER_CTX_iv_length(ctx);
127 if (!ossl_assert(l <= sizeof(iv)))
129 i = ASN1_TYPE_get_octetstring(type, iv, l);
133 if (!EVP_CipherInit_ex(ctx, NULL, NULL, NULL, iv, -1))
139 int EVP_CIPHER_set_asn1_iv(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
145 j = EVP_CIPHER_CTX_iv_length(c);
146 OPENSSL_assert(j <= sizeof(c->iv));
147 i = ASN1_TYPE_set_octetstring(type, c->oiv, j);
151 #endif /* !defined(FIPS_MODE) */
153 /* Convert the various cipher NIDs and dummies to a proper OID NID */
154 int EVP_CIPHER_type(const EVP_CIPHER *ctx)
157 nid = EVP_CIPHER_nid(ctx);
172 case NID_aes_128_cfb128:
173 case NID_aes_128_cfb8:
174 case NID_aes_128_cfb1:
176 return NID_aes_128_cfb128;
178 case NID_aes_192_cfb128:
179 case NID_aes_192_cfb8:
180 case NID_aes_192_cfb1:
182 return NID_aes_192_cfb128;
184 case NID_aes_256_cfb128:
185 case NID_aes_256_cfb8:
186 case NID_aes_256_cfb1:
188 return NID_aes_256_cfb128;
194 return NID_des_cfb64;
196 case NID_des_ede3_cfb64:
197 case NID_des_ede3_cfb8:
198 case NID_des_ede3_cfb1:
200 return NID_des_cfb64;
207 /* Check it has an OID and it is valid */
208 ASN1_OBJECT *otmp = OBJ_nid2obj(nid);
210 if (OBJ_get0_data(otmp) == NULL)
212 ASN1_OBJECT_free(otmp);
219 int EVP_CIPHER_block_size(const EVP_CIPHER *cipher)
222 size_t v = cipher->block_size;
223 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
225 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_BLOCK_SIZE, &v);
226 ok = evp_do_ciph_getparams(cipher, params);
228 return ok != 0 ? (int)v : EVP_CTRL_RET_UNSUPPORTED;
231 int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx)
233 return EVP_CIPHER_block_size(ctx->cipher);
236 int EVP_CIPHER_impl_ctx_size(const EVP_CIPHER *e)
241 int EVP_Cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
242 const unsigned char *in, unsigned int inl)
244 if (ctx->cipher->prov != NULL) {
245 size_t outl = 0; /* ignored */
246 int blocksize = EVP_CIPHER_CTX_block_size(ctx);
248 if (ctx->cipher->ccipher != NULL)
250 ctx->cipher->ccipher(ctx->provctx, out, &outl,
251 inl + (blocksize == 1 ? 0 : blocksize),
256 return ctx->cipher->do_cipher(ctx, out, in, inl);
259 const EVP_CIPHER *EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX *ctx)
264 int EVP_CIPHER_CTX_encrypting(const EVP_CIPHER_CTX *ctx)
269 unsigned long EVP_CIPHER_flags(const EVP_CIPHER *cipher)
272 unsigned long v = cipher->flags;
273 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
275 params[0] = OSSL_PARAM_construct_ulong(OSSL_CIPHER_PARAM_FLAGS, &v);
276 ok = evp_do_ciph_getparams(cipher, params);
278 return ok != 0 ? v : 0;
281 void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx)
283 return ctx->app_data;
286 void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, void *data)
288 ctx->app_data = data;
291 void *EVP_CIPHER_CTX_get_cipher_data(const EVP_CIPHER_CTX *ctx)
293 return ctx->cipher_data;
296 void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX *ctx, void *cipher_data)
298 void *old_cipher_data;
300 old_cipher_data = ctx->cipher_data;
301 ctx->cipher_data = cipher_data;
303 return old_cipher_data;
306 int EVP_CIPHER_iv_length(const EVP_CIPHER *cipher)
309 size_t v = cipher->iv_len;
310 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
312 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &v);
313 ok = evp_do_ciph_getparams(cipher, params);
315 return ok != 0 ? (int)v : EVP_CTRL_RET_UNSUPPORTED;
318 int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx)
320 int rv, len = EVP_CIPHER_iv_length(ctx->cipher);
322 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
324 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &v);
325 rv = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
326 if (rv == EVP_CTRL_RET_UNSUPPORTED)
328 return rv != 0 ? (int)v : -1;
329 /* TODO (3.0) Remove legacy support */
331 if ((EVP_CIPHER_flags(ctx->cipher) & EVP_CIPH_CUSTOM_IV_LENGTH) != 0) {
332 rv = EVP_CIPHER_CTX_ctrl((EVP_CIPHER_CTX *)ctx, EVP_CTRL_GET_IVLEN,
334 return (rv == 1) ? len : -1;
339 int EVP_CIPHER_CTX_tag_length(const EVP_CIPHER_CTX *ctx)
343 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
345 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, &v);
346 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
347 return ret == 1 ? (int)v : 0;
350 const unsigned char *EVP_CIPHER_CTX_original_iv(const EVP_CIPHER_CTX *ctx)
356 * OSSL_PARAM_OCTET_PTR gets us the pointer to the running IV in the provider
358 const unsigned char *EVP_CIPHER_CTX_iv(const EVP_CIPHER_CTX *ctx)
361 const unsigned char *v = ctx->iv;
362 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
365 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_IV, (void **)&v,
367 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
369 return ok != 0 ? v : NULL;
372 unsigned char *EVP_CIPHER_CTX_iv_noconst(EVP_CIPHER_CTX *ctx)
375 unsigned char *v = ctx->iv;
376 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
379 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_IV, (void **)&v,
381 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
383 return ok != 0 ? v : NULL;
386 unsigned char *EVP_CIPHER_CTX_buf_noconst(EVP_CIPHER_CTX *ctx)
391 int EVP_CIPHER_CTX_num(const EVP_CIPHER_CTX *ctx)
394 unsigned int v = (unsigned int)ctx->num;
395 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
397 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_NUM, &v);
398 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
400 return ok != 0 ? (int)v : EVP_CTRL_RET_UNSUPPORTED;
403 int EVP_CIPHER_CTX_set_num(EVP_CIPHER_CTX *ctx, int num)
406 unsigned int n = (unsigned int)num;
407 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
409 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_NUM, &n);
410 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
417 int EVP_CIPHER_key_length(const EVP_CIPHER *cipher)
420 size_t v = cipher->key_len;
421 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
423 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &v);
424 ok = evp_do_ciph_getparams(cipher, params);
426 return ok != 0 ? (int)v : EVP_CTRL_RET_UNSUPPORTED;
429 int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx)
432 size_t v = ctx->key_len;
433 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
435 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &v);
436 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
438 return ok != 0 ? (int)v : EVP_CTRL_RET_UNSUPPORTED;
441 int EVP_CIPHER_nid(const EVP_CIPHER *cipher)
446 int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx)
448 return ctx->cipher->nid;
451 int EVP_CIPHER_is_a(const EVP_CIPHER *cipher, const char *name)
453 return evp_is_a(cipher->prov, cipher->name_id, name);
456 const char *EVP_CIPHER_name(const EVP_CIPHER *cipher)
458 if (cipher->prov != NULL)
459 return evp_first_name(cipher->prov, cipher->name_id);
461 return OBJ_nid2sn(EVP_CIPHER_nid(cipher));
467 const OSSL_PROVIDER *EVP_CIPHER_provider(const EVP_CIPHER *cipher)
472 int EVP_CIPHER_mode(const EVP_CIPHER *cipher)
475 unsigned int v = EVP_CIPHER_flags(cipher) & EVP_CIPH_MODE;
476 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
478 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_MODE, &v);
479 ok = evp_do_ciph_getparams(cipher, params);
481 return ok != 0 ? (int)v : 0;
484 const char *EVP_MD_name(const EVP_MD *md)
486 if (md->prov != NULL)
487 return evp_first_name(md->prov, md->name_id);
489 return OBJ_nid2sn(EVP_MD_nid(md));
495 const OSSL_PROVIDER *EVP_MD_provider(const EVP_MD *md)
500 int EVP_MD_block_size(const EVP_MD *md)
503 size_t v = md->block_size;
504 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
507 EVPerr(EVP_F_EVP_MD_BLOCK_SIZE, EVP_R_MESSAGE_DIGEST_IS_NULL);
511 params[0] = OSSL_PARAM_construct_size_t(OSSL_DIGEST_PARAM_BLOCK_SIZE, &v);
512 ok = evp_do_md_getparams(md, params);
514 return ok != 0 ? (int)v : -1;
517 int EVP_MD_type(const EVP_MD *md)
522 int EVP_MD_pkey_type(const EVP_MD *md)
524 return md->pkey_type;
527 int EVP_MD_size(const EVP_MD *md)
530 size_t v = md->md_size;
531 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
534 EVPerr(EVP_F_EVP_MD_SIZE, EVP_R_MESSAGE_DIGEST_IS_NULL);
538 params[0] = OSSL_PARAM_construct_size_t(OSSL_DIGEST_PARAM_SIZE, &v);
539 ok = evp_do_md_getparams(md, params);
541 return ok != 0 ? (int)v : -1;
544 unsigned long EVP_MD_flags(const EVP_MD *md)
547 unsigned long v = md->flags;
548 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
550 params[0] = OSSL_PARAM_construct_ulong(OSSL_CIPHER_PARAM_FLAGS, &v);
551 ok = evp_do_md_getparams(md, params);
553 return ok != 0 ? v : 0;
556 EVP_MD *EVP_MD_meth_new(int md_type, int pkey_type)
558 EVP_MD *md = evp_md_new();
562 md->pkey_type = pkey_type;
567 EVP_MD *EVP_MD_meth_dup(const EVP_MD *md)
572 * Non-legacy EVP_MDs can't be duplicated like this.
573 * Use EVP_MD_up_ref() instead.
575 if (md->prov != NULL)
578 if ((to = EVP_MD_meth_new(md->type, md->pkey_type)) != NULL) {
579 CRYPTO_RWLOCK *lock = to->lock;
581 memcpy(to, md, sizeof(*to));
587 void EVP_MD_meth_free(EVP_MD *md)
591 int EVP_MD_meth_set_input_blocksize(EVP_MD *md, int blocksize)
593 if (md->block_size != 0)
596 md->block_size = blocksize;
599 int EVP_MD_meth_set_result_size(EVP_MD *md, int resultsize)
601 if (md->md_size != 0)
604 md->md_size = resultsize;
607 int EVP_MD_meth_set_app_datasize(EVP_MD *md, int datasize)
609 if (md->ctx_size != 0)
612 md->ctx_size = datasize;
615 int EVP_MD_meth_set_flags(EVP_MD *md, unsigned long flags)
623 int EVP_MD_meth_set_init(EVP_MD *md, int (*init)(EVP_MD_CTX *ctx))
625 if (md->init != NULL)
631 int EVP_MD_meth_set_update(EVP_MD *md, int (*update)(EVP_MD_CTX *ctx,
635 if (md->update != NULL)
641 int EVP_MD_meth_set_final(EVP_MD *md, int (*final)(EVP_MD_CTX *ctx,
644 if (md->final != NULL)
650 int EVP_MD_meth_set_copy(EVP_MD *md, int (*copy)(EVP_MD_CTX *to,
651 const EVP_MD_CTX *from))
653 if (md->copy != NULL)
659 int EVP_MD_meth_set_cleanup(EVP_MD *md, int (*cleanup)(EVP_MD_CTX *ctx))
661 if (md->cleanup != NULL)
664 md->cleanup = cleanup;
667 int EVP_MD_meth_set_ctrl(EVP_MD *md, int (*ctrl)(EVP_MD_CTX *ctx, int cmd,
670 if (md->md_ctrl != NULL)
677 int EVP_MD_meth_get_input_blocksize(const EVP_MD *md)
679 return md->block_size;
681 int EVP_MD_meth_get_result_size(const EVP_MD *md)
685 int EVP_MD_meth_get_app_datasize(const EVP_MD *md)
689 unsigned long EVP_MD_meth_get_flags(const EVP_MD *md)
693 int (*EVP_MD_meth_get_init(const EVP_MD *md))(EVP_MD_CTX *ctx)
697 int (*EVP_MD_meth_get_update(const EVP_MD *md))(EVP_MD_CTX *ctx,
703 int (*EVP_MD_meth_get_final(const EVP_MD *md))(EVP_MD_CTX *ctx,
708 int (*EVP_MD_meth_get_copy(const EVP_MD *md))(EVP_MD_CTX *to,
709 const EVP_MD_CTX *from)
713 int (*EVP_MD_meth_get_cleanup(const EVP_MD *md))(EVP_MD_CTX *ctx)
717 int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd,
723 const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx)
727 return ctx->reqdigest;
730 EVP_PKEY_CTX *EVP_MD_CTX_pkey_ctx(const EVP_MD_CTX *ctx)
735 #if !defined(FIPS_MODE)
736 /* TODO(3.0): EVP_DigestSign* not yet supported in FIPS module */
737 void EVP_MD_CTX_set_pkey_ctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX *pctx)
740 * it's reasonable to set NULL pctx (a.k.a clear the ctx->pctx), so
741 * we have to deal with the cleanup job here.
743 if (!EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX))
744 EVP_PKEY_CTX_free(ctx->pctx);
749 /* make sure pctx is not freed when destroying EVP_MD_CTX */
750 EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
752 EVP_MD_CTX_clear_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
755 #endif /* !defined(FIPS_MODE) */
757 void *EVP_MD_CTX_md_data(const EVP_MD_CTX *ctx)
762 int (*EVP_MD_CTX_update_fn(EVP_MD_CTX *ctx))(EVP_MD_CTX *ctx,
763 const void *data, size_t count)
768 void EVP_MD_CTX_set_update_fn(EVP_MD_CTX *ctx,
769 int (*update) (EVP_MD_CTX *ctx,
770 const void *data, size_t count))
772 ctx->update = update;
775 void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, int flags)
780 void EVP_MD_CTX_clear_flags(EVP_MD_CTX *ctx, int flags)
782 ctx->flags &= ~flags;
785 int EVP_MD_CTX_test_flags(const EVP_MD_CTX *ctx, int flags)
787 return (ctx->flags & flags);
790 void EVP_CIPHER_CTX_set_flags(EVP_CIPHER_CTX *ctx, int flags)
795 void EVP_CIPHER_CTX_clear_flags(EVP_CIPHER_CTX *ctx, int flags)
797 ctx->flags &= ~flags;
800 int EVP_CIPHER_CTX_test_flags(const EVP_CIPHER_CTX *ctx, int flags)
802 return (ctx->flags & flags);
805 int EVP_str2ctrl(int (*cb)(void *ctx, int cmd, void *buf, size_t buflen),
806 void *ctx, int cmd, const char *value)
813 return cb(ctx, cmd, (void *)value, len);
816 int EVP_hex2ctrl(int (*cb)(void *ctx, int cmd, void *buf, size_t buflen),
817 void *ctx, int cmd, const char *hex)
823 bin = OPENSSL_hexstr2buf(hex, &binlen);
826 if (binlen <= INT_MAX)
827 rv = cb(ctx, cmd, bin, binlen);