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 v = cipher->block_size;
221 int ok = evp_do_param(cipher, &v, sizeof(v),
222 OSSL_CIPHER_PARAM_BLOCK_SIZE, OSSL_PARAM_INTEGER,
223 evp_do_ciph_getparams, NULL);
225 return ok != 0 ? v : -1;
228 int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx)
230 return EVP_CIPHER_block_size(ctx->cipher);
233 int EVP_CIPHER_impl_ctx_size(const EVP_CIPHER *e)
238 int EVP_Cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
239 const unsigned char *in, unsigned int inl)
241 if (ctx->cipher->prov != NULL) {
242 size_t outl = 0; /* ignored */
243 int blocksize = EVP_CIPHER_CTX_block_size(ctx);
245 if (ctx->cipher->ccipher != NULL)
247 ctx->cipher->ccipher(ctx->provctx, out, &outl,
248 inl + (blocksize == 1 ? 0 : blocksize),
253 return ctx->cipher->do_cipher(ctx, out, in, inl);
256 const EVP_CIPHER *EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX *ctx)
261 int EVP_CIPHER_CTX_encrypting(const EVP_CIPHER_CTX *ctx)
266 unsigned long EVP_CIPHER_flags(const EVP_CIPHER *cipher)
268 unsigned long v = cipher->flags;
269 int ok = evp_do_param(cipher, &v, sizeof(v),
270 OSSL_CIPHER_PARAM_FLAGS, OSSL_PARAM_UNSIGNED_INTEGER,
271 evp_do_ciph_getparams, NULL);
273 return ok != 0 ? v : 0;
276 void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx)
278 return ctx->app_data;
281 void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, void *data)
283 ctx->app_data = data;
286 void *EVP_CIPHER_CTX_get_cipher_data(const EVP_CIPHER_CTX *ctx)
288 return ctx->cipher_data;
291 void *EVP_CIPHER_CTX_set_cipher_data(EVP_CIPHER_CTX *ctx, void *cipher_data)
293 void *old_cipher_data;
295 old_cipher_data = ctx->cipher_data;
296 ctx->cipher_data = cipher_data;
298 return old_cipher_data;
301 int EVP_CIPHER_iv_length(const EVP_CIPHER *cipher)
303 int v = cipher->iv_len;
304 int ok = evp_do_param(cipher, &v, sizeof(v),
305 OSSL_CIPHER_PARAM_IVLEN, OSSL_PARAM_UNSIGNED_INTEGER,
306 evp_do_ciph_getparams, NULL);
308 return ok != 0 ? v: -1;
311 int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx)
313 return EVP_CIPHER_iv_length(ctx->cipher);
316 const unsigned char *EVP_CIPHER_CTX_original_iv(const EVP_CIPHER_CTX *ctx)
322 * OSSL_PARAM_OCTET_PTR gets us the pointer to the running IV in the provider
324 const unsigned char *EVP_CIPHER_CTX_iv(const EVP_CIPHER_CTX *ctx)
326 const unsigned char *v = ctx->iv;
327 int ok = evp_do_param(ctx->cipher, &v, sizeof(ctx->iv),
328 OSSL_CIPHER_PARAM_IV, OSSL_PARAM_OCTET_PTR,
329 evp_do_ciph_ctx_getparams, ctx->provctx);
331 return ok != 0 ? v: NULL;
334 unsigned char *EVP_CIPHER_CTX_iv_noconst(EVP_CIPHER_CTX *ctx)
336 unsigned char *v = ctx->iv;
337 int ok = evp_do_param(ctx->cipher, &v, sizeof(ctx->iv),
338 OSSL_CIPHER_PARAM_IV, OSSL_PARAM_OCTET_PTR,
339 evp_do_ciph_ctx_getparams, ctx->provctx);
341 return ok != 0 ? v: NULL;
344 unsigned char *EVP_CIPHER_CTX_buf_noconst(EVP_CIPHER_CTX *ctx)
349 int EVP_CIPHER_CTX_num(const EVP_CIPHER_CTX *ctx)
352 int ok = evp_do_param(ctx->cipher, &v, sizeof(v),
353 OSSL_CIPHER_PARAM_NUM, OSSL_PARAM_INTEGER,
354 evp_do_ciph_ctx_getparams, ctx->provctx);
356 return ok != 0 ? v: -1;
359 int EVP_CIPHER_CTX_set_num(EVP_CIPHER_CTX *ctx, int num)
361 int ok = evp_do_param(ctx->cipher, &num, sizeof(num),
362 OSSL_CIPHER_PARAM_NUM, OSSL_PARAM_INTEGER,
363 evp_do_ciph_ctx_setparams, ctx->provctx);
369 int EVP_CIPHER_key_length(const EVP_CIPHER *cipher)
371 int v = cipher->key_len;
372 int ok = evp_do_param(cipher, &v, sizeof(v),
373 OSSL_CIPHER_PARAM_KEYLEN, OSSL_PARAM_INTEGER,
374 evp_do_ciph_getparams, NULL);
376 return ok != 0 ? v: -1;
379 int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx)
381 int v = ctx->key_len;
382 int ok = evp_do_param(ctx->cipher, &v, sizeof(v),
383 OSSL_CIPHER_PARAM_KEYLEN, OSSL_PARAM_INTEGER,
384 evp_do_ciph_ctx_getparams, ctx->provctx);
386 return ok != 0 ? v: -1;
389 int EVP_CIPHER_nid(const EVP_CIPHER *cipher)
394 int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx)
396 return ctx->cipher->nid;
399 int EVP_CIPHER_mode(const EVP_CIPHER *cipher)
401 int v = EVP_CIPHER_flags(cipher) & EVP_CIPH_MODE;
402 int ok = evp_do_param(cipher, &v, sizeof(v),
403 OSSL_CIPHER_PARAM_MODE, OSSL_PARAM_INTEGER,
404 evp_do_ciph_getparams, NULL);
406 return ok != 0 ? v: 0;
410 int EVP_MD_block_size(const EVP_MD *md)
413 EVPerr(EVP_F_EVP_MD_BLOCK_SIZE, EVP_R_MESSAGE_DIGEST_IS_NULL);
417 if (md->prov != NULL && md->dblock_size != NULL)
418 return (int)md->dblock_size();
420 return md->block_size;
423 int EVP_MD_type(const EVP_MD *md)
428 int EVP_MD_pkey_type(const EVP_MD *md)
430 return md->pkey_type;
433 int EVP_MD_size(const EVP_MD *md)
436 EVPerr(EVP_F_EVP_MD_SIZE, EVP_R_MESSAGE_DIGEST_IS_NULL);
440 if (md->prov != NULL && md->size != NULL)
441 return (int)md->size();
446 unsigned long EVP_MD_flags(const EVP_MD *md)
451 EVP_MD *EVP_MD_meth_new(int md_type, int pkey_type)
453 EVP_MD *md = OPENSSL_zalloc(sizeof(*md));
457 md->pkey_type = pkey_type;
458 md->lock = CRYPTO_THREAD_lock_new();
459 if (md->lock == NULL) {
468 EVP_MD *EVP_MD_meth_dup(const EVP_MD *md)
470 EVP_MD *to = EVP_MD_meth_new(md->type, md->pkey_type);
473 CRYPTO_RWLOCK *lock = to->lock;
474 memcpy(to, md, sizeof(*to));
480 int EVP_MD_up_ref(EVP_MD *md)
484 CRYPTO_UP_REF(&md->refcnt, &ref, md->lock);
488 void EVP_MD_meth_free(EVP_MD *md)
493 CRYPTO_DOWN_REF(&md->refcnt, &i, md->lock);
496 ossl_provider_free(md->prov);
497 CRYPTO_THREAD_lock_free(md->lock);
501 int EVP_MD_meth_set_input_blocksize(EVP_MD *md, int blocksize)
503 md->block_size = blocksize;
506 int EVP_MD_meth_set_result_size(EVP_MD *md, int resultsize)
508 md->md_size = resultsize;
511 int EVP_MD_meth_set_app_datasize(EVP_MD *md, int datasize)
513 md->ctx_size = datasize;
516 int EVP_MD_meth_set_flags(EVP_MD *md, unsigned long flags)
521 int EVP_MD_meth_set_init(EVP_MD *md, int (*init)(EVP_MD_CTX *ctx))
526 int EVP_MD_meth_set_update(EVP_MD *md, int (*update)(EVP_MD_CTX *ctx,
533 int EVP_MD_meth_set_final(EVP_MD *md, int (*final)(EVP_MD_CTX *ctx,
539 int EVP_MD_meth_set_copy(EVP_MD *md, int (*copy)(EVP_MD_CTX *to,
540 const EVP_MD_CTX *from))
545 int EVP_MD_meth_set_cleanup(EVP_MD *md, int (*cleanup)(EVP_MD_CTX *ctx))
547 md->cleanup = cleanup;
550 int EVP_MD_meth_set_ctrl(EVP_MD *md, int (*ctrl)(EVP_MD_CTX *ctx, int cmd,
557 int EVP_MD_meth_get_input_blocksize(const EVP_MD *md)
559 return md->block_size;
561 int EVP_MD_meth_get_result_size(const EVP_MD *md)
565 int EVP_MD_meth_get_app_datasize(const EVP_MD *md)
569 unsigned long EVP_MD_meth_get_flags(const EVP_MD *md)
573 int (*EVP_MD_meth_get_init(const EVP_MD *md))(EVP_MD_CTX *ctx)
577 int (*EVP_MD_meth_get_update(const EVP_MD *md))(EVP_MD_CTX *ctx,
583 int (*EVP_MD_meth_get_final(const EVP_MD *md))(EVP_MD_CTX *ctx,
588 int (*EVP_MD_meth_get_copy(const EVP_MD *md))(EVP_MD_CTX *to,
589 const EVP_MD_CTX *from)
593 int (*EVP_MD_meth_get_cleanup(const EVP_MD *md))(EVP_MD_CTX *ctx)
597 int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd,
603 const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx)
607 return ctx->reqdigest;
610 EVP_PKEY_CTX *EVP_MD_CTX_pkey_ctx(const EVP_MD_CTX *ctx)
615 #if !defined(FIPS_MODE)
616 /* TODO(3.0): EVP_DigestSign* not yet supported in FIPS module */
617 void EVP_MD_CTX_set_pkey_ctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX *pctx)
620 * it's reasonable to set NULL pctx (a.k.a clear the ctx->pctx), so
621 * we have to deal with the cleanup job here.
623 if (!EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX))
624 EVP_PKEY_CTX_free(ctx->pctx);
629 /* make sure pctx is not freed when destroying EVP_MD_CTX */
630 EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
632 EVP_MD_CTX_clear_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
635 #endif /* !defined(FIPS_MODE) */
637 void *EVP_MD_CTX_md_data(const EVP_MD_CTX *ctx)
642 int (*EVP_MD_CTX_update_fn(EVP_MD_CTX *ctx))(EVP_MD_CTX *ctx,
643 const void *data, size_t count)
648 void EVP_MD_CTX_set_update_fn(EVP_MD_CTX *ctx,
649 int (*update) (EVP_MD_CTX *ctx,
650 const void *data, size_t count))
652 ctx->update = update;
655 void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, int flags)
660 void EVP_MD_CTX_clear_flags(EVP_MD_CTX *ctx, int flags)
662 ctx->flags &= ~flags;
665 int EVP_MD_CTX_test_flags(const EVP_MD_CTX *ctx, int flags)
667 return (ctx->flags & flags);
670 void EVP_CIPHER_CTX_set_flags(EVP_CIPHER_CTX *ctx, int flags)
675 void EVP_CIPHER_CTX_clear_flags(EVP_CIPHER_CTX *ctx, int flags)
677 ctx->flags &= ~flags;
680 int EVP_CIPHER_CTX_test_flags(const EVP_CIPHER_CTX *ctx, int flags)
682 return (ctx->flags & flags);
685 int EVP_str2ctrl(int (*cb)(void *ctx, int cmd, void *buf, size_t buflen),
686 void *ctx, int cmd, const char *value)
693 return cb(ctx, cmd, (void *)value, len);
696 int EVP_hex2ctrl(int (*cb)(void *ctx, int cmd, void *buf, size_t buflen),
697 void *ctx, int cmd, const char *hex)
703 bin = OPENSSL_hexstr2buf(hex, &binlen);
706 if (binlen <= INT_MAX)
707 rv = cb(ctx, cmd, bin, binlen);