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 "internal/evp_int.h"
17 #include "internal/provider.h"
20 #if !defined(FIPS_MODE)
21 int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
24 const EVP_CIPHER *cipher = c->cipher;
26 if (cipher->prov != NULL) {
28 * The cipher has come from a provider and won't have the default flags.
29 * Find the implicit form so we can check the flags.
30 * TODO(3.0): This won't work for 3rd party ciphers we know nothing about
31 * We'll need to think of something else for those.
33 cipher = EVP_get_cipherbynid(cipher->nid);
35 EVPerr(EVP_F_EVP_CIPHER_PARAM_TO_ASN1, ASN1_R_UNSUPPORTED_CIPHER);
40 if (cipher->set_asn1_parameters != NULL)
41 ret = cipher->set_asn1_parameters(c, type);
42 else if (cipher->flags & EVP_CIPH_FLAG_DEFAULT_ASN1) {
43 switch (EVP_CIPHER_mode(cipher)) {
44 case EVP_CIPH_WRAP_MODE:
45 if (EVP_CIPHER_nid(cipher) == NID_id_smime_alg_CMS3DESwrap)
46 ASN1_TYPE_set(type, V_ASN1_NULL, NULL);
50 case EVP_CIPH_GCM_MODE:
51 case EVP_CIPH_CCM_MODE:
52 case EVP_CIPH_XTS_MODE:
53 case EVP_CIPH_OCB_MODE:
58 ret = EVP_CIPHER_set_asn1_iv(c, type);
63 EVPerr(EVP_F_EVP_CIPHER_PARAM_TO_ASN1, ret == -2 ?
64 ASN1_R_UNSUPPORTED_CIPHER :
65 EVP_R_CIPHER_PARAMETER_ERROR);
71 int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
74 const EVP_CIPHER *cipher = c->cipher;
76 if (cipher->prov != NULL) {
78 * The cipher has come from a provider and won't have the default flags.
79 * Find the implicit form so we can check the flags.
81 cipher = EVP_get_cipherbynid(cipher->nid);
86 if (cipher->get_asn1_parameters != NULL)
87 ret = cipher->get_asn1_parameters(c, type);
88 else if (cipher->flags & EVP_CIPH_FLAG_DEFAULT_ASN1) {
89 switch (EVP_CIPHER_mode(cipher)) {
91 case EVP_CIPH_WRAP_MODE:
95 case EVP_CIPH_GCM_MODE:
96 case EVP_CIPH_CCM_MODE:
97 case EVP_CIPH_XTS_MODE:
98 case EVP_CIPH_OCB_MODE:
103 ret = EVP_CIPHER_get_asn1_iv(c, type);
109 EVPerr(EVP_F_EVP_CIPHER_ASN1_TO_PARAM, ret == -2 ?
110 EVP_R_UNSUPPORTED_CIPHER :
111 EVP_R_CIPHER_PARAMETER_ERROR);
117 int EVP_CIPHER_get_asn1_iv(EVP_CIPHER_CTX *ctx, ASN1_TYPE *type)
123 unsigned char iv[EVP_MAX_IV_LENGTH];
125 l = EVP_CIPHER_CTX_iv_length(ctx);
126 if (!ossl_assert(l <= sizeof(iv)))
128 i = ASN1_TYPE_get_octetstring(type, iv, l);
132 if (!EVP_CipherInit_ex(ctx, NULL, NULL, NULL, iv, -1))
138 int EVP_CIPHER_set_asn1_iv(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
144 j = EVP_CIPHER_CTX_iv_length(c);
145 OPENSSL_assert(j <= sizeof(c->iv));
146 i = ASN1_TYPE_set_octetstring(type, c->oiv, j);
150 #endif /* !defined(FIPS_MODE) */
152 /* Convert the various cipher NIDs and dummies to a proper OID NID */
153 int EVP_CIPHER_type(const EVP_CIPHER *ctx)
156 nid = EVP_CIPHER_nid(ctx);
171 case NID_aes_128_cfb128:
172 case NID_aes_128_cfb8:
173 case NID_aes_128_cfb1:
175 return NID_aes_128_cfb128;
177 case NID_aes_192_cfb128:
178 case NID_aes_192_cfb8:
179 case NID_aes_192_cfb1:
181 return NID_aes_192_cfb128;
183 case NID_aes_256_cfb128:
184 case NID_aes_256_cfb8:
185 case NID_aes_256_cfb1:
187 return NID_aes_256_cfb128;
193 return NID_des_cfb64;
195 case NID_des_ede3_cfb64:
196 case NID_des_ede3_cfb8:
197 case NID_des_ede3_cfb1:
199 return NID_des_cfb64;
206 /* Check it has an OID and it is valid */
207 ASN1_OBJECT *otmp = OBJ_nid2obj(nid);
209 if (OBJ_get0_data(otmp) == NULL)
211 ASN1_OBJECT_free(otmp);
218 int EVP_CIPHER_block_size(const EVP_CIPHER *cipher)
220 int ok, v = cipher->block_size;
221 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
223 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_BLOCK_SIZE, &v);
224 ok = evp_do_ciph_getparams(cipher, params);
226 return ok != 0 ? v : -1;
229 int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx)
231 return EVP_CIPHER_block_size(ctx->cipher);
234 int EVP_CIPHER_impl_ctx_size(const EVP_CIPHER *e)
239 int EVP_Cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
240 const unsigned char *in, unsigned int inl)
242 if (ctx->cipher->prov != NULL) {
243 size_t outl = 0; /* ignored */
244 int blocksize = EVP_CIPHER_CTX_block_size(ctx);
246 if (ctx->cipher->ccipher != NULL)
248 ctx->cipher->ccipher(ctx->provctx, out, &outl,
249 inl + (blocksize == 1 ? 0 : blocksize),
254 return ctx->cipher->do_cipher(ctx, out, in, inl);
257 const EVP_CIPHER *EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX *ctx)
262 int EVP_CIPHER_CTX_encrypting(const EVP_CIPHER_CTX *ctx)
267 unsigned long EVP_CIPHER_flags(const EVP_CIPHER *cipher)
270 unsigned long v = cipher->flags;
271 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
273 params[0] = OSSL_PARAM_construct_ulong(OSSL_CIPHER_PARAM_FLAGS, &v);
274 ok = evp_do_ciph_getparams(cipher, params);
276 return ok != 0 ? v : 0;
279 void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx)
281 return ctx->app_data;
284 void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, void *data)
286 ctx->app_data = data;
289 void *EVP_CIPHER_CTX_get_cipher_data(const EVP_CIPHER_CTX *ctx)
291 return ctx->cipher_data;
294 void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX *ctx, void *cipher_data)
296 void *old_cipher_data;
298 old_cipher_data = ctx->cipher_data;
299 ctx->cipher_data = cipher_data;
301 return old_cipher_data;
304 int EVP_CIPHER_iv_length(const EVP_CIPHER *cipher)
306 int ok, v = cipher->iv_len;
307 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
309 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_IVLEN, &v);
310 ok = evp_do_ciph_getparams(cipher, params);
312 return ok != 0 ? v : -1;
315 int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx)
317 return EVP_CIPHER_iv_length(ctx->cipher);
320 const unsigned char *EVP_CIPHER_CTX_original_iv(const EVP_CIPHER_CTX *ctx)
326 * OSSL_PARAM_OCTET_PTR gets us the pointer to the running IV in the provider
328 const unsigned char *EVP_CIPHER_CTX_iv(const EVP_CIPHER_CTX *ctx)
331 const unsigned char *v = ctx->iv;
332 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
335 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_IV, (void **)&v,
337 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
339 return ok != 0 ? v : NULL;
342 unsigned char *EVP_CIPHER_CTX_iv_noconst(EVP_CIPHER_CTX *ctx)
345 unsigned char *v = ctx->iv;
346 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
349 OSSL_PARAM_construct_octet_ptr(OSSL_CIPHER_PARAM_IV, (void **)&v,
351 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
353 return ok != 0 ? v : NULL;
356 unsigned char *EVP_CIPHER_CTX_buf_noconst(EVP_CIPHER_CTX *ctx)
361 int EVP_CIPHER_CTX_num(const EVP_CIPHER_CTX *ctx)
363 int ok, v = ctx->num;
364 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
366 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_NUM, &v);
367 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
369 return ok != 0 ? v : -1;
372 int EVP_CIPHER_CTX_set_num(EVP_CIPHER_CTX *ctx, int num)
375 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
377 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_NUM, &num);
378 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
385 int EVP_CIPHER_key_length(const EVP_CIPHER *cipher)
387 int ok, v = cipher->key_len;
388 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
390 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN, &v);
391 ok = evp_do_ciph_getparams(cipher, params);
393 return ok != 0 ? v : -1;
396 int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx)
398 int ok, v = ctx->key_len;
399 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
401 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN, &v);
402 ok = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
404 return ok != 0 ? v : -1;
407 int EVP_CIPHER_nid(const EVP_CIPHER *cipher)
412 int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx)
414 return ctx->cipher->nid;
417 int EVP_CIPHER_mode(const EVP_CIPHER *cipher)
419 int ok, v = EVP_CIPHER_flags(cipher) & EVP_CIPH_MODE;
420 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
422 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_MODE, &v);
423 ok = evp_do_ciph_getparams(cipher, params);
425 return ok != 0 ? v : 0;
428 int EVP_MD_block_size(const EVP_MD *md)
431 EVPerr(EVP_F_EVP_MD_BLOCK_SIZE, EVP_R_MESSAGE_DIGEST_IS_NULL);
435 if (md->prov != NULL && md->dblock_size != NULL)
436 return (int)md->dblock_size();
438 return md->block_size;
441 int EVP_MD_type(const EVP_MD *md)
446 int EVP_MD_pkey_type(const EVP_MD *md)
448 return md->pkey_type;
451 int EVP_MD_size(const EVP_MD *md)
454 EVPerr(EVP_F_EVP_MD_SIZE, EVP_R_MESSAGE_DIGEST_IS_NULL);
458 if (md->prov != NULL && md->size != NULL)
459 return (int)md->size();
464 unsigned long EVP_MD_flags(const EVP_MD *md)
469 EVP_MD *EVP_MD_meth_new(int md_type, int pkey_type)
471 EVP_MD *md = OPENSSL_zalloc(sizeof(*md));
475 md->pkey_type = pkey_type;
476 md->lock = CRYPTO_THREAD_lock_new();
477 if (md->lock == NULL) {
486 EVP_MD *EVP_MD_meth_dup(const EVP_MD *md)
488 EVP_MD *to = EVP_MD_meth_new(md->type, md->pkey_type);
491 CRYPTO_RWLOCK *lock = to->lock;
492 memcpy(to, md, sizeof(*to));
498 int EVP_MD_up_ref(EVP_MD *md)
502 CRYPTO_UP_REF(&md->refcnt, &ref, md->lock);
506 void EVP_MD_meth_free(EVP_MD *md)
511 CRYPTO_DOWN_REF(&md->refcnt, &i, md->lock);
514 ossl_provider_free(md->prov);
515 CRYPTO_THREAD_lock_free(md->lock);
519 int EVP_MD_meth_set_input_blocksize(EVP_MD *md, int blocksize)
521 md->block_size = blocksize;
524 int EVP_MD_meth_set_result_size(EVP_MD *md, int resultsize)
526 md->md_size = resultsize;
529 int EVP_MD_meth_set_app_datasize(EVP_MD *md, int datasize)
531 md->ctx_size = datasize;
534 int EVP_MD_meth_set_flags(EVP_MD *md, unsigned long flags)
539 int EVP_MD_meth_set_init(EVP_MD *md, int (*init)(EVP_MD_CTX *ctx))
544 int EVP_MD_meth_set_update(EVP_MD *md, int (*update)(EVP_MD_CTX *ctx,
551 int EVP_MD_meth_set_final(EVP_MD *md, int (*final)(EVP_MD_CTX *ctx,
557 int EVP_MD_meth_set_copy(EVP_MD *md, int (*copy)(EVP_MD_CTX *to,
558 const EVP_MD_CTX *from))
563 int EVP_MD_meth_set_cleanup(EVP_MD *md, int (*cleanup)(EVP_MD_CTX *ctx))
565 md->cleanup = cleanup;
568 int EVP_MD_meth_set_ctrl(EVP_MD *md, int (*ctrl)(EVP_MD_CTX *ctx, int cmd,
575 int EVP_MD_meth_get_input_blocksize(const EVP_MD *md)
577 return md->block_size;
579 int EVP_MD_meth_get_result_size(const EVP_MD *md)
583 int EVP_MD_meth_get_app_datasize(const EVP_MD *md)
587 unsigned long EVP_MD_meth_get_flags(const EVP_MD *md)
591 int (*EVP_MD_meth_get_init(const EVP_MD *md))(EVP_MD_CTX *ctx)
595 int (*EVP_MD_meth_get_update(const EVP_MD *md))(EVP_MD_CTX *ctx,
601 int (*EVP_MD_meth_get_final(const EVP_MD *md))(EVP_MD_CTX *ctx,
606 int (*EVP_MD_meth_get_copy(const EVP_MD *md))(EVP_MD_CTX *to,
607 const EVP_MD_CTX *from)
611 int (*EVP_MD_meth_get_cleanup(const EVP_MD *md))(EVP_MD_CTX *ctx)
615 int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd,
621 const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx)
625 return ctx->reqdigest;
628 EVP_PKEY_CTX *EVP_MD_CTX_pkey_ctx(const EVP_MD_CTX *ctx)
633 #if !defined(FIPS_MODE)
634 /* TODO(3.0): EVP_DigestSign* not yet supported in FIPS module */
635 void EVP_MD_CTX_set_pkey_ctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX *pctx)
638 * it's reasonable to set NULL pctx (a.k.a clear the ctx->pctx), so
639 * we have to deal with the cleanup job here.
641 if (!EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX))
642 EVP_PKEY_CTX_free(ctx->pctx);
647 /* make sure pctx is not freed when destroying EVP_MD_CTX */
648 EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
650 EVP_MD_CTX_clear_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
653 #endif /* !defined(FIPS_MODE) */
655 void *EVP_MD_CTX_md_data(const EVP_MD_CTX *ctx)
660 int (*EVP_MD_CTX_update_fn(EVP_MD_CTX *ctx))(EVP_MD_CTX *ctx,
661 const void *data, size_t count)
666 void EVP_MD_CTX_set_update_fn(EVP_MD_CTX *ctx,
667 int (*update) (EVP_MD_CTX *ctx,
668 const void *data, size_t count))
670 ctx->update = update;
673 void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, int flags)
678 void EVP_MD_CTX_clear_flags(EVP_MD_CTX *ctx, int flags)
680 ctx->flags &= ~flags;
683 int EVP_MD_CTX_test_flags(const EVP_MD_CTX *ctx, int flags)
685 return (ctx->flags & flags);
688 void EVP_CIPHER_CTX_set_flags(EVP_CIPHER_CTX *ctx, int flags)
693 void EVP_CIPHER_CTX_clear_flags(EVP_CIPHER_CTX *ctx, int flags)
695 ctx->flags &= ~flags;
698 int EVP_CIPHER_CTX_test_flags(const EVP_CIPHER_CTX *ctx, int flags)
700 return (ctx->flags & flags);
703 int EVP_str2ctrl(int (*cb)(void *ctx, int cmd, void *buf, size_t buflen),
704 void *ctx, int cmd, const char *value)
711 return cb(ctx, cmd, (void *)value, len);
714 int EVP_hex2ctrl(int (*cb)(void *ctx, int cmd, void *buf, size_t buflen),
715 void *ctx, int cmd, const char *hex)
721 bin = OPENSSL_hexstr2buf(hex, &binlen);
724 if (binlen <= INT_MAX)
725 rv = cb(ctx, cmd, bin, binlen);