132534464fdf9508942170b8c6c71bb1e255ed42
[openssl.git] / crypto / evp / evp_local.h
1 /*
2  * Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 /* EVP_MD_CTX related stuff */
11
12 #include <openssl/core_numbers.h>
13 #include "internal/refcount.h"
14
15 #define EVP_CTRL_RET_UNSUPPORTED -1
16
17
18 struct evp_md_ctx_st {
19     const EVP_MD *reqdigest;    /* The original requested digest */
20     const EVP_MD *digest;
21     ENGINE *engine;             /* functional reference if 'digest' is
22                                  * ENGINE-provided */
23     unsigned long flags;
24     void *md_data;
25     /* Public key context for sign/verify */
26     EVP_PKEY_CTX *pctx;
27     /* Update function: usually copied from EVP_MD */
28     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
29
30     /* Provider ctx */
31     void *provctx;
32     EVP_MD *fetched_digest;
33 } /* EVP_MD_CTX */ ;
34
35 struct evp_cipher_ctx_st {
36     const EVP_CIPHER *cipher;
37     ENGINE *engine;             /* functional reference if 'cipher' is
38                                  * ENGINE-provided */
39     int encrypt;                /* encrypt or decrypt */
40     int buf_len;                /* number we have left */
41     unsigned char oiv[EVP_MAX_IV_LENGTH]; /* original iv */
42     unsigned char iv[EVP_MAX_IV_LENGTH]; /* working iv */
43     unsigned char buf[EVP_MAX_BLOCK_LENGTH]; /* saved partial block */
44     int num;                    /* used by cfb/ofb/ctr mode */
45     /* FIXME: Should this even exist? It appears unused */
46     void *app_data;             /* application stuff */
47     int key_len;                /* May change for variable length cipher */
48     unsigned long flags;        /* Various flags */
49     void *cipher_data;          /* per EVP data */
50     int final_used;
51     int block_mask;
52     unsigned char final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */
53
54     /* Provider ctx */
55     void *provctx;
56     EVP_CIPHER *fetched_cipher;
57 } /* EVP_CIPHER_CTX */ ;
58
59 struct evp_mac_ctx_st {
60     EVP_MAC *meth;               /* Method structure */
61     void *data;                  /* Individual method data */
62 } /* EVP_MAC_CTX */;
63
64 struct evp_kdf_ctx_st {
65     EVP_KDF *meth;              /* Method structure */
66     void *data;                 /* Algorithm-specific data */
67 } /* EVP_KDF_CTX */ ;
68
69 struct evp_rand_ctx_st {
70     EVP_RAND *meth;             /* Method structure */
71     void *data;                 /* Algorithm-specific data */
72     size_t max_request;         /*
73                                  * Cached: maximum number of bytes generated 
74                                  * in a single call to the generate function
75                                  */
76     unsigned int strength;      /* Cached: bit strength of generator */
77 } /* EVP_RAND_CTX */ ;
78
79 struct evp_rand_st {
80     OSSL_PROVIDER *prov;
81     int name_id;
82     CRYPTO_REF_COUNT refcnt;
83     CRYPTO_RWLOCK *refcnt_lock;
84
85     const OSSL_DISPATCH *dispatch;
86     OSSL_OP_rand_newctx_fn *newctx;
87     OSSL_OP_rand_freectx_fn *freectx;
88     OSSL_OP_rand_instantiate_fn *instantiate;
89     OSSL_OP_rand_uninstantiate_fn *uninstantiate;
90     OSSL_OP_rand_generate_fn *generate;
91     OSSL_OP_rand_reseed_fn *reseed;
92     OSSL_OP_rand_nonce_fn *nonce;
93     OSSL_OP_rand_enable_locking_fn *enable_locking;
94     OSSL_OP_rand_lock_fn *lock;
95     OSSL_OP_rand_unlock_fn *unlock;
96     OSSL_OP_rand_gettable_params_fn *gettable_params;
97     OSSL_OP_rand_gettable_ctx_params_fn *gettable_ctx_params;
98     OSSL_OP_rand_settable_ctx_params_fn *settable_ctx_params;
99     OSSL_OP_rand_get_params_fn *get_params;
100     OSSL_OP_rand_get_ctx_params_fn *get_ctx_params;
101     OSSL_OP_rand_set_ctx_params_fn *set_ctx_params;
102     OSSL_OP_rand_set_callbacks_fn *set_callbacks;
103     OSSL_OP_rand_verify_zeroization_fn *verify_zeroization;
104 } /* EVP_RAND */ ;
105
106 struct evp_keymgmt_st {
107     int id;                      /* libcrypto internal */
108
109     int name_id;
110     OSSL_PROVIDER *prov;
111     CRYPTO_REF_COUNT refcnt;
112     CRYPTO_RWLOCK *lock;
113
114     /* Constructor(s), destructor, information */
115     OSSL_OP_keymgmt_new_fn *new;
116     OSSL_OP_keymgmt_free_fn *free;
117     OSSL_OP_keymgmt_get_params_fn *get_params;
118     OSSL_OP_keymgmt_gettable_params_fn *gettable_params;
119     OSSL_OP_keymgmt_set_params_fn *set_params;
120     OSSL_OP_keymgmt_settable_params_fn *settable_params;
121
122     /* Generation, a complex constructor */
123     OSSL_OP_keymgmt_gen_init_fn *gen_init;
124     OSSL_OP_keymgmt_gen_set_template_fn *gen_set_template;
125     OSSL_OP_keymgmt_gen_set_params_fn *gen_set_params;
126     OSSL_OP_keymgmt_gen_settable_params_fn *gen_settable_params;
127     OSSL_OP_keymgmt_gen_fn *gen;
128     OSSL_OP_keymgmt_gen_cleanup_fn *gen_cleanup;
129
130     /* Key object checking */
131     OSSL_OP_keymgmt_query_operation_name_fn *query_operation_name;
132     OSSL_OP_keymgmt_has_fn *has;
133     OSSL_OP_keymgmt_validate_fn *validate;
134     OSSL_OP_keymgmt_match_fn *match;
135
136     /* Import and export routines */
137     OSSL_OP_keymgmt_import_fn *import;
138     OSSL_OP_keymgmt_import_types_fn *import_types;
139     OSSL_OP_keymgmt_export_fn *export;
140     OSSL_OP_keymgmt_export_types_fn *export_types;
141     OSSL_OP_keymgmt_copy_fn *copy;
142 } /* EVP_KEYMGMT */ ;
143
144 struct evp_keyexch_st {
145     int name_id;
146     OSSL_PROVIDER *prov;
147     CRYPTO_REF_COUNT refcnt;
148     CRYPTO_RWLOCK *lock;
149
150     OSSL_OP_keyexch_newctx_fn *newctx;
151     OSSL_OP_keyexch_init_fn *init;
152     OSSL_OP_keyexch_set_peer_fn *set_peer;
153     OSSL_OP_keyexch_derive_fn *derive;
154     OSSL_OP_keyexch_freectx_fn *freectx;
155     OSSL_OP_keyexch_dupctx_fn *dupctx;
156     OSSL_OP_keyexch_set_ctx_params_fn *set_ctx_params;
157     OSSL_OP_keyexch_settable_ctx_params_fn *settable_ctx_params;
158     OSSL_OP_keyexch_get_ctx_params_fn *get_ctx_params;
159     OSSL_OP_keyexch_gettable_ctx_params_fn *gettable_ctx_params;
160 } /* EVP_KEYEXCH */;
161
162 struct evp_signature_st {
163     int name_id;
164     OSSL_PROVIDER *prov;
165     CRYPTO_REF_COUNT refcnt;
166     CRYPTO_RWLOCK *lock;
167
168     OSSL_OP_signature_newctx_fn *newctx;
169     OSSL_OP_signature_sign_init_fn *sign_init;
170     OSSL_OP_signature_sign_fn *sign;
171     OSSL_OP_signature_verify_init_fn *verify_init;
172     OSSL_OP_signature_verify_fn *verify;
173     OSSL_OP_signature_verify_recover_init_fn *verify_recover_init;
174     OSSL_OP_signature_verify_recover_fn *verify_recover;
175     OSSL_OP_signature_digest_sign_init_fn *digest_sign_init;
176     OSSL_OP_signature_digest_sign_update_fn *digest_sign_update;
177     OSSL_OP_signature_digest_sign_final_fn *digest_sign_final;
178     OSSL_OP_signature_digest_sign_fn *digest_sign;
179     OSSL_OP_signature_digest_verify_init_fn *digest_verify_init;
180     OSSL_OP_signature_digest_verify_update_fn *digest_verify_update;
181     OSSL_OP_signature_digest_verify_final_fn *digest_verify_final;
182     OSSL_OP_signature_digest_verify_fn *digest_verify;
183     OSSL_OP_signature_freectx_fn *freectx;
184     OSSL_OP_signature_dupctx_fn *dupctx;
185     OSSL_OP_signature_get_ctx_params_fn *get_ctx_params;
186     OSSL_OP_signature_gettable_ctx_params_fn *gettable_ctx_params;
187     OSSL_OP_signature_set_ctx_params_fn *set_ctx_params;
188     OSSL_OP_signature_settable_ctx_params_fn *settable_ctx_params;
189     OSSL_OP_signature_get_ctx_md_params_fn *get_ctx_md_params;
190     OSSL_OP_signature_gettable_ctx_md_params_fn *gettable_ctx_md_params;
191     OSSL_OP_signature_set_ctx_md_params_fn *set_ctx_md_params;
192     OSSL_OP_signature_settable_ctx_md_params_fn *settable_ctx_md_params;
193 } /* EVP_SIGNATURE */;
194
195 struct evp_asym_cipher_st {
196     int name_id;
197     OSSL_PROVIDER *prov;
198     CRYPTO_REF_COUNT refcnt;
199     CRYPTO_RWLOCK *lock;
200
201     OSSL_OP_asym_cipher_newctx_fn *newctx;
202     OSSL_OP_asym_cipher_encrypt_init_fn *encrypt_init;
203     OSSL_OP_asym_cipher_encrypt_fn *encrypt;
204     OSSL_OP_asym_cipher_decrypt_init_fn *decrypt_init;
205     OSSL_OP_asym_cipher_decrypt_fn *decrypt;
206     OSSL_OP_asym_cipher_freectx_fn *freectx;
207     OSSL_OP_asym_cipher_dupctx_fn *dupctx;
208     OSSL_OP_asym_cipher_get_ctx_params_fn *get_ctx_params;
209     OSSL_OP_asym_cipher_gettable_ctx_params_fn *gettable_ctx_params;
210     OSSL_OP_asym_cipher_set_ctx_params_fn *set_ctx_params;
211     OSSL_OP_asym_cipher_settable_ctx_params_fn *settable_ctx_params;
212 } /* EVP_ASYM_CIPHER */;
213
214 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
215                              int passlen, ASN1_TYPE *param,
216                              const EVP_CIPHER *c, const EVP_MD *md,
217                              int en_de);
218
219 struct evp_Encode_Ctx_st {
220     /* number saved in a partial encode/decode */
221     int num;
222     /*
223      * The length is either the output line length (in input bytes) or the
224      * shortest input line length that is ok.  Once decoding begins, the
225      * length is adjusted up each time a longer line is decoded
226      */
227     int length;
228     /* data to encode */
229     unsigned char enc_data[80];
230     /* number read on current line */
231     int line_num;
232     unsigned int flags;
233 };
234
235 typedef struct evp_pbe_st EVP_PBE_CTL;
236 DEFINE_STACK_OF(EVP_PBE_CTL)
237
238 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len);
239
240 #include <openssl/types.h>
241 #include <openssl/core.h>
242
243 void *evp_generic_fetch(OPENSSL_CTX *ctx, int operation_id,
244                         const char *name, const char *properties,
245                         void *(*new_method)(int name_id,
246                                             const OSSL_DISPATCH *fns,
247                                             OSSL_PROVIDER *prov),
248                         int (*up_ref_method)(void *),
249                         void (*free_method)(void *));
250 void *evp_generic_fetch_by_number(OPENSSL_CTX *ctx, int operation_id,
251                                   int name_id, const char *properties,
252                                   void *(*new_method)(int name_id,
253                                                       const OSSL_DISPATCH *fns,
254                                                       OSSL_PROVIDER *prov),
255                                   int (*up_ref_method)(void *),
256                                   void (*free_method)(void *));
257 void evp_generic_do_all(OPENSSL_CTX *libctx, int operation_id,
258                         void (*user_fn)(void *method, void *arg),
259                         void *user_arg,
260                         void *(*new_method)(int name_id,
261                                             const OSSL_DISPATCH *fns,
262                                             OSSL_PROVIDER *prov),
263                         void (*free_method)(void *));
264
265 /* Internal fetchers for method types that are to be combined with others */
266 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_CTX *ctx, int name_id,
267                                          const char *properties);
268
269 /* Internal structure constructors for fetched methods */
270 EVP_MD *evp_md_new(void);
271 EVP_CIPHER *evp_cipher_new(void);
272
273 /* Helper functions to avoid duplicating code */
274
275 /*
276  * These methods implement different ways to pass a params array to the
277  * provider.  They will return one of these values:
278  *
279  * -2 if the method doesn't come from a provider
280  *    (evp_do_param will return this to the called)
281  * -1 if the provider doesn't offer the desired function
282  *    (evp_do_param will raise an error and return 0)
283  * or the return value from the desired function
284  *    (evp_do_param will return it to the caller)
285  */
286 int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]);
287 int evp_do_ciph_ctx_getparams(const EVP_CIPHER *ciph, void *provctx,
288                               OSSL_PARAM params[]);
289 int evp_do_ciph_ctx_setparams(const EVP_CIPHER *ciph, void *provctx,
290                               OSSL_PARAM params[]);
291 int evp_do_md_getparams(const EVP_MD *md, OSSL_PARAM params[]);
292 int evp_do_md_ctx_getparams(const EVP_MD *md, void *provctx,
293                             OSSL_PARAM params[]);
294 int evp_do_md_ctx_setparams(const EVP_MD *md, void *provctx,
295                             OSSL_PARAM params[]);
296
297 OSSL_PARAM *evp_pkey_to_param(EVP_PKEY *pkey, size_t *sz);
298
299 #define M_check_autoarg(ctx, arg, arglen, err) \
300     if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) {           \
301         size_t pksize = (size_t)EVP_PKEY_size(ctx->pkey);         \
302                                                                   \
303         if (pksize == 0) {                                        \
304             ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY); /*ckerr_ignore*/ \
305             return 0;                                             \
306         }                                                         \
307         if (arg == NULL) {                                        \
308             *arglen = pksize;                                     \
309             return 1;                                             \
310         }                                                         \
311         if (*arglen < pksize) {                                   \
312             ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \
313             return 0;                                             \
314         }                                                         \
315     }
316
317 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx);
318
319 /* OSSL_PROVIDER * is only used to get the library context */
320 const char *evp_first_name(const OSSL_PROVIDER *prov, int name_id);
321 int evp_is_a(OSSL_PROVIDER *prov, int number,
322              const char *legacy_name, const char *name);
323 void evp_names_do_all(OSSL_PROVIDER *prov, int number,
324                       void (*fn)(const char *name, void *data),
325                       void *data);
326 int evp_cipher_cache_constants(EVP_CIPHER *cipher);