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 /* Constructor(s), destructor, information */
77 OSSL_OP_keymgmt_new_fn *new;
78 OSSL_OP_keymgmt_free_fn *free;
79 OSSL_OP_keymgmt_get_params_fn *get_params;
80 OSSL_OP_keymgmt_gettable_params_fn *gettable_params;
81 OSSL_OP_keymgmt_set_params_fn *set_params;
82 OSSL_OP_keymgmt_settable_params_fn *settable_params;
84 /* Key object checking */
85 OSSL_OP_keymgmt_query_operation_name_fn *query_operation_name;
86 OSSL_OP_keymgmt_has_fn *has;
87 OSSL_OP_keymgmt_validate_fn *validate;
89 /* Import and export routines */
90 OSSL_OP_keymgmt_import_fn *import;
91 OSSL_OP_keymgmt_import_types_fn *import_types;
92 OSSL_OP_keymgmt_export_fn *export;
93 OSSL_OP_keymgmt_export_types_fn *export_types;
96 struct evp_keyexch_st {
99 CRYPTO_REF_COUNT refcnt;
102 OSSL_OP_keyexch_newctx_fn *newctx;
103 OSSL_OP_keyexch_init_fn *init;
104 OSSL_OP_keyexch_set_peer_fn *set_peer;
105 OSSL_OP_keyexch_derive_fn *derive;
106 OSSL_OP_keyexch_freectx_fn *freectx;
107 OSSL_OP_keyexch_dupctx_fn *dupctx;
108 OSSL_OP_keyexch_set_ctx_params_fn *set_ctx_params;
109 OSSL_OP_keyexch_settable_ctx_params_fn *settable_ctx_params;
110 OSSL_OP_keyexch_get_ctx_params_fn *get_ctx_params;
111 OSSL_OP_keyexch_gettable_ctx_params_fn *gettable_ctx_params;
114 struct evp_signature_st {
117 CRYPTO_REF_COUNT refcnt;
120 OSSL_OP_signature_newctx_fn *newctx;
121 OSSL_OP_signature_sign_init_fn *sign_init;
122 OSSL_OP_signature_sign_fn *sign;
123 OSSL_OP_signature_verify_init_fn *verify_init;
124 OSSL_OP_signature_verify_fn *verify;
125 OSSL_OP_signature_verify_recover_init_fn *verify_recover_init;
126 OSSL_OP_signature_verify_recover_fn *verify_recover;
127 OSSL_OP_signature_digest_sign_init_fn *digest_sign_init;
128 OSSL_OP_signature_digest_sign_update_fn *digest_sign_update;
129 OSSL_OP_signature_digest_sign_final_fn *digest_sign_final;
130 OSSL_OP_signature_digest_verify_init_fn *digest_verify_init;
131 OSSL_OP_signature_digest_verify_update_fn *digest_verify_update;
132 OSSL_OP_signature_digest_verify_final_fn *digest_verify_final;
133 OSSL_OP_signature_freectx_fn *freectx;
134 OSSL_OP_signature_dupctx_fn *dupctx;
135 OSSL_OP_signature_get_ctx_params_fn *get_ctx_params;
136 OSSL_OP_signature_gettable_ctx_params_fn *gettable_ctx_params;
137 OSSL_OP_signature_set_ctx_params_fn *set_ctx_params;
138 OSSL_OP_signature_settable_ctx_params_fn *settable_ctx_params;
139 OSSL_OP_signature_get_ctx_md_params_fn *get_ctx_md_params;
140 OSSL_OP_signature_gettable_ctx_md_params_fn *gettable_ctx_md_params;
141 OSSL_OP_signature_set_ctx_md_params_fn *set_ctx_md_params;
142 OSSL_OP_signature_settable_ctx_md_params_fn *settable_ctx_md_params;
143 } /* EVP_SIGNATURE */;
145 struct evp_asym_cipher_st {
148 CRYPTO_REF_COUNT refcnt;
151 OSSL_OP_asym_cipher_newctx_fn *newctx;
152 OSSL_OP_asym_cipher_encrypt_init_fn *encrypt_init;
153 OSSL_OP_asym_cipher_encrypt_fn *encrypt;
154 OSSL_OP_asym_cipher_decrypt_init_fn *decrypt_init;
155 OSSL_OP_asym_cipher_decrypt_fn *decrypt;
156 OSSL_OP_asym_cipher_freectx_fn *freectx;
157 OSSL_OP_asym_cipher_dupctx_fn *dupctx;
158 OSSL_OP_asym_cipher_get_ctx_params_fn *get_ctx_params;
159 OSSL_OP_asym_cipher_gettable_ctx_params_fn *gettable_ctx_params;
160 OSSL_OP_asym_cipher_set_ctx_params_fn *set_ctx_params;
161 OSSL_OP_asym_cipher_settable_ctx_params_fn *settable_ctx_params;
162 } /* EVP_ASYM_CIPHER */;
164 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
165 int passlen, ASN1_TYPE *param,
166 const EVP_CIPHER *c, const EVP_MD *md,
169 struct evp_Encode_Ctx_st {
170 /* number saved in a partial encode/decode */
173 * The length is either the output line length (in input bytes) or the
174 * shortest input line length that is ok. Once decoding begins, the
175 * length is adjusted up each time a longer line is decoded
179 unsigned char enc_data[80];
180 /* number read on current line */
185 typedef struct evp_pbe_st EVP_PBE_CTL;
186 DEFINE_STACK_OF(EVP_PBE_CTL)
188 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len);
190 #include <openssl/types.h>
191 #include <openssl/core.h>
193 void *evp_generic_fetch(OPENSSL_CTX *ctx, int operation_id,
194 const char *name, const char *properties,
195 void *(*new_method)(int name_id,
196 const OSSL_DISPATCH *fns,
197 OSSL_PROVIDER *prov),
198 int (*up_ref_method)(void *),
199 void (*free_method)(void *));
200 void *evp_generic_fetch_by_number(OPENSSL_CTX *ctx, int operation_id,
201 int name_id, 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_do_all(OPENSSL_CTX *libctx, int operation_id,
208 void (*user_fn)(void *method, void *arg),
210 void *(*new_method)(int name_id,
211 const OSSL_DISPATCH *fns,
212 OSSL_PROVIDER *prov),
213 void (*free_method)(void *));
215 /* Internal fetchers for method types that are to be combined with others */
216 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_CTX *ctx, int name_id,
217 const char *properties);
219 /* Internal structure constructors for fetched methods */
220 EVP_MD *evp_md_new(void);
221 EVP_CIPHER *evp_cipher_new(void);
223 /* Helper functions to avoid duplicating code */
226 * These methods implement different ways to pass a params array to the
227 * provider. They will return one of these values:
229 * -2 if the method doesn't come from a provider
230 * (evp_do_param will return this to the called)
231 * -1 if the provider doesn't offer the desired function
232 * (evp_do_param will raise an error and return 0)
233 * or the return value from the desired function
234 * (evp_do_param will return it to the caller)
236 int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]);
237 int evp_do_ciph_ctx_getparams(const EVP_CIPHER *ciph, void *provctx,
238 OSSL_PARAM params[]);
239 int evp_do_ciph_ctx_setparams(const EVP_CIPHER *ciph, void *provctx,
240 OSSL_PARAM params[]);
241 int evp_do_md_getparams(const EVP_MD *md, OSSL_PARAM params[]);
242 int evp_do_md_ctx_getparams(const EVP_MD *md, void *provctx,
243 OSSL_PARAM params[]);
244 int evp_do_md_ctx_setparams(const EVP_MD *md, void *provctx,
245 OSSL_PARAM params[]);
247 OSSL_PARAM *evp_pkey_to_param(EVP_PKEY *pkey, size_t *sz);
249 #define M_check_autoarg(ctx, arg, arglen, err) \
250 if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) { \
251 size_t pksize = (size_t)EVP_PKEY_size(ctx->pkey); \
254 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY); /*ckerr_ignore*/ \
261 if (*arglen < pksize) { \
262 ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \
267 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx);
269 /* OSSL_PROVIDER * is only used to get the library context */
270 const char *evp_first_name(OSSL_PROVIDER *prov, int name_id);
271 int evp_is_a(OSSL_PROVIDER *prov, int number,
272 const char *legacy_name, const char *name);
273 void evp_names_do_all(OSSL_PROVIDER *prov, int number,
274 void (*fn)(const char *name, void *data),
276 int evp_cipher_cache_constants(EVP_CIPHER *cipher);
277 void *evp_pkey_make_provided(EVP_PKEY *pk, OPENSSL_CTX *libctx,
278 EVP_KEYMGMT **keymgmt, const char *propquery);