2 * Copyright 2000-2019 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
10 /* EVP_MD_CTX related stuff */
12 #include <openssl/core_numbers.h>
14 #define EVP_CTRL_RET_UNSUPPORTED -1
17 struct evp_md_ctx_st {
18 const EVP_MD *reqdigest; /* The original requested digest */
20 ENGINE *engine; /* functional reference if 'digest' is
24 /* Public key context for sign/verify */
26 /* Update function: usually copied from EVP_MD */
27 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
31 EVP_MD *fetched_digest;
34 struct evp_cipher_ctx_st {
35 const EVP_CIPHER *cipher;
36 ENGINE *engine; /* functional reference if 'cipher' is
38 int encrypt; /* encrypt or decrypt */
39 int buf_len; /* number we have left */
40 unsigned char oiv[EVP_MAX_IV_LENGTH]; /* original iv */
41 unsigned char iv[EVP_MAX_IV_LENGTH]; /* working iv */
42 unsigned char buf[EVP_MAX_BLOCK_LENGTH]; /* saved partial block */
43 int num; /* used by cfb/ofb/ctr mode */
44 /* FIXME: Should this even exist? It appears unused */
45 void *app_data; /* application stuff */
46 int key_len; /* May change for variable length cipher */
47 unsigned long flags; /* Various flags */
48 void *cipher_data; /* per EVP data */
51 unsigned char final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */
55 EVP_CIPHER *fetched_cipher;
56 } /* EVP_CIPHER_CTX */ ;
58 struct evp_mac_ctx_st {
59 EVP_MAC *meth; /* Method structure */
60 void *data; /* Individual method data */
63 struct evp_kdf_ctx_st {
64 EVP_KDF *meth; /* Method structure */
65 void *data; /* Algorithm-specific data */
68 struct evp_keymgmt_st {
69 int id; /* libcrypto internal */
73 CRYPTO_REF_COUNT refcnt;
76 /* Domain parameter routines */
77 OSSL_OP_keymgmt_importdomparams_fn *importdomparams;
78 OSSL_OP_keymgmt_gendomparams_fn *gendomparams;
79 OSSL_OP_keymgmt_freedomparams_fn *freedomparams;
80 OSSL_OP_keymgmt_exportdomparams_fn *exportdomparams;
81 OSSL_OP_keymgmt_importdomparam_types_fn *importdomparam_types;
82 OSSL_OP_keymgmt_exportdomparam_types_fn *exportdomparam_types;
83 OSSL_OP_keymgmt_get_domparam_params_fn *get_domparam_params;
84 OSSL_OP_keymgmt_gettable_domparam_params_fn *gettable_domparam_params;
87 OSSL_OP_keymgmt_importkey_fn *importkey;
88 OSSL_OP_keymgmt_genkey_fn *genkey;
89 OSSL_OP_keymgmt_loadkey_fn *loadkey;
90 OSSL_OP_keymgmt_freekey_fn *freekey;
91 OSSL_OP_keymgmt_exportkey_fn *exportkey;
92 OSSL_OP_keymgmt_importkey_types_fn *importkey_types;
93 OSSL_OP_keymgmt_exportkey_types_fn *exportkey_types;
94 OSSL_OP_keymgmt_get_key_params_fn *get_key_params;
95 OSSL_OP_keymgmt_gettable_key_params_fn *gettable_key_params;
97 OSSL_OP_keymgmt_query_operation_name_fn *query_operation_name;
100 struct keymgmt_data_st {
102 const char *properties;
105 struct evp_keyexch_st {
108 CRYPTO_REF_COUNT refcnt;
111 OSSL_OP_keyexch_newctx_fn *newctx;
112 OSSL_OP_keyexch_init_fn *init;
113 OSSL_OP_keyexch_set_peer_fn *set_peer;
114 OSSL_OP_keyexch_derive_fn *derive;
115 OSSL_OP_keyexch_freectx_fn *freectx;
116 OSSL_OP_keyexch_dupctx_fn *dupctx;
117 OSSL_OP_keyexch_set_ctx_params_fn *set_ctx_params;
118 OSSL_OP_keyexch_settable_ctx_params_fn *settable_ctx_params;
121 struct evp_signature_st {
124 CRYPTO_REF_COUNT refcnt;
127 OSSL_OP_signature_newctx_fn *newctx;
128 OSSL_OP_signature_sign_init_fn *sign_init;
129 OSSL_OP_signature_sign_fn *sign;
130 OSSL_OP_signature_verify_init_fn *verify_init;
131 OSSL_OP_signature_verify_fn *verify;
132 OSSL_OP_signature_verify_recover_init_fn *verify_recover_init;
133 OSSL_OP_signature_verify_recover_fn *verify_recover;
134 OSSL_OP_signature_digest_sign_init_fn *digest_sign_init;
135 OSSL_OP_signature_digest_sign_update_fn *digest_sign_update;
136 OSSL_OP_signature_digest_sign_final_fn *digest_sign_final;
137 OSSL_OP_signature_digest_verify_init_fn *digest_verify_init;
138 OSSL_OP_signature_digest_verify_update_fn *digest_verify_update;
139 OSSL_OP_signature_digest_verify_final_fn *digest_verify_final;
140 OSSL_OP_signature_freectx_fn *freectx;
141 OSSL_OP_signature_dupctx_fn *dupctx;
142 OSSL_OP_signature_get_ctx_params_fn *get_ctx_params;
143 OSSL_OP_signature_gettable_ctx_params_fn *gettable_ctx_params;
144 OSSL_OP_signature_set_ctx_params_fn *set_ctx_params;
145 OSSL_OP_signature_settable_ctx_params_fn *settable_ctx_params;
146 OSSL_OP_signature_get_ctx_md_params_fn *get_ctx_md_params;
147 OSSL_OP_signature_gettable_ctx_md_params_fn *gettable_ctx_md_params;
148 OSSL_OP_signature_set_ctx_md_params_fn *set_ctx_md_params;
149 OSSL_OP_signature_settable_ctx_md_params_fn *settable_ctx_md_params;
150 } /* EVP_SIGNATURE */;
152 struct evp_asym_cipher_st {
155 CRYPTO_REF_COUNT refcnt;
158 OSSL_OP_asym_cipher_newctx_fn *newctx;
159 OSSL_OP_asym_cipher_encrypt_init_fn *encrypt_init;
160 OSSL_OP_asym_cipher_encrypt_fn *encrypt;
161 OSSL_OP_asym_cipher_decrypt_init_fn *decrypt_init;
162 OSSL_OP_asym_cipher_decrypt_fn *decrypt;
163 OSSL_OP_asym_cipher_freectx_fn *freectx;
164 OSSL_OP_asym_cipher_dupctx_fn *dupctx;
165 OSSL_OP_asym_cipher_get_ctx_params_fn *get_ctx_params;
166 OSSL_OP_asym_cipher_gettable_ctx_params_fn *gettable_ctx_params;
167 OSSL_OP_asym_cipher_set_ctx_params_fn *set_ctx_params;
168 OSSL_OP_asym_cipher_settable_ctx_params_fn *settable_ctx_params;
169 } /* EVP_ASYM_CIPHER */;
171 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
172 int passlen, ASN1_TYPE *param,
173 const EVP_CIPHER *c, const EVP_MD *md,
176 struct evp_Encode_Ctx_st {
177 /* number saved in a partial encode/decode */
180 * The length is either the output line length (in input bytes) or the
181 * shortest input line length that is ok. Once decoding begins, the
182 * length is adjusted up each time a longer line is decoded
186 unsigned char enc_data[80];
187 /* number read on current line */
192 typedef struct evp_pbe_st EVP_PBE_CTL;
193 DEFINE_STACK_OF(EVP_PBE_CTL)
195 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len);
197 #include <openssl/types.h>
198 #include <openssl/core.h>
200 void *evp_generic_fetch(OPENSSL_CTX *ctx, int operation_id,
201 const char *name, const char *properties,
202 void *(*new_method)(int name_id,
203 const OSSL_DISPATCH *fns,
204 OSSL_PROVIDER *prov),
205 int (*up_ref_method)(void *),
206 void (*free_method)(void *));
207 void *evp_generic_fetch_by_number(OPENSSL_CTX *ctx, int operation_id,
208 int name_id, const char *properties,
209 void *(*new_method)(int name_id,
210 const OSSL_DISPATCH *fns,
211 OSSL_PROVIDER *prov),
212 int (*up_ref_method)(void *),
213 void (*free_method)(void *));
214 void evp_generic_do_all(OPENSSL_CTX *libctx, int operation_id,
215 void (*user_fn)(void *method, void *arg),
217 void *(*new_method)(int name_id,
218 const OSSL_DISPATCH *fns,
219 OSSL_PROVIDER *prov),
220 void (*free_method)(void *));
222 /* Internal fetchers for method types that are to be combined with others */
223 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_CTX *ctx, int name_id,
224 const char *properties);
226 /* Internal structure constructors for fetched methods */
227 EVP_MD *evp_md_new(void);
228 EVP_CIPHER *evp_cipher_new(void);
230 /* Helper functions to avoid duplicating code */
233 * These methods implement different ways to pass a params array to the
234 * provider. They will return one of these values:
236 * -2 if the method doesn't come from a provider
237 * (evp_do_param will return this to the called)
238 * -1 if the provider doesn't offer the desired function
239 * (evp_do_param will raise an error and return 0)
240 * or the return value from the desired function
241 * (evp_do_param will return it to the caller)
243 int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]);
244 int evp_do_ciph_ctx_getparams(const EVP_CIPHER *ciph, void *provctx,
245 OSSL_PARAM params[]);
246 int evp_do_ciph_ctx_setparams(const EVP_CIPHER *ciph, void *provctx,
247 OSSL_PARAM params[]);
248 int evp_do_md_getparams(const EVP_MD *md, OSSL_PARAM params[]);
249 int evp_do_md_ctx_getparams(const EVP_MD *md, void *provctx,
250 OSSL_PARAM params[]);
251 int evp_do_md_ctx_setparams(const EVP_MD *md, void *provctx,
252 OSSL_PARAM params[]);
254 OSSL_PARAM *evp_pkey_to_param(EVP_PKEY *pkey, size_t *sz);
256 #define M_check_autoarg(ctx, arg, arglen, err) \
257 if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) { \
258 size_t pksize = (size_t)EVP_PKEY_size(ctx->pkey); \
261 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY); /*ckerr_ignore*/ \
268 if (*arglen < pksize) { \
269 ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \
274 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx);
276 /* OSSL_PROVIDER * is only used to get the library context */
277 const char *evp_first_name(OSSL_PROVIDER *prov, int name_id);
278 int evp_is_a(OSSL_PROVIDER *prov, int number,
279 const char *legacy_name, const char *name);
280 void evp_names_do_all(OSSL_PROVIDER *prov, int number,
281 void (*fn)(const char *name, void *data),
283 int evp_cipher_cache_constants(EVP_CIPHER *cipher);