d54edc78d3dd35873869b69133c6687d2167f40d
[openssl.git] / crypto / include / internal / evp_int.h
1 /*
2  * Copyright 2015-2018 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 #include <openssl/evp.h>
11 #include <openssl/core_numbers.h>
12 #include "internal/refcount.h"
13
14 /*
15  * Don't free up md_ctx->pctx in EVP_MD_CTX_reset, use the reserved flag
16  * values in evp.h
17  */
18 #define EVP_MD_CTX_FLAG_KEEP_PKEY_CTX   0x0400
19
20 struct evp_pkey_ctx_st {
21     EVP_KEYEXCH *exchange;
22     void *exchprovctx;
23
24     /* Legacy fields below */
25
26     /* Method associated with this operation */
27     const EVP_PKEY_METHOD *pmeth;
28     /* Engine that implements this method or NULL if builtin */
29     ENGINE *engine;
30     /* Key: may be NULL */
31     EVP_PKEY *pkey;
32     /* Peer key for key agreement, may be NULL */
33     EVP_PKEY *peerkey;
34     /* Actual operation */
35     int operation;
36     /* Algorithm specific data */
37     void *data;
38     /* Application specific data */
39     void *app_data;
40     /* Keygen callback */
41     EVP_PKEY_gen_cb *pkey_gencb;
42     /* implementation specific keygen data */
43     int *keygen_info;
44     int keygen_info_count;
45 } /* EVP_PKEY_CTX */ ;
46
47 #define EVP_PKEY_FLAG_DYNAMIC   1
48
49 struct evp_pkey_method_st {
50     int pkey_id;
51     int flags;
52     int (*init) (EVP_PKEY_CTX *ctx);
53     int (*copy) (EVP_PKEY_CTX *dst, const EVP_PKEY_CTX *src);
54     void (*cleanup) (EVP_PKEY_CTX *ctx);
55     int (*paramgen_init) (EVP_PKEY_CTX *ctx);
56     int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
57     int (*keygen_init) (EVP_PKEY_CTX *ctx);
58     int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
59     int (*sign_init) (EVP_PKEY_CTX *ctx);
60     int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
61                  const unsigned char *tbs, size_t tbslen);
62     int (*verify_init) (EVP_PKEY_CTX *ctx);
63     int (*verify) (EVP_PKEY_CTX *ctx,
64                    const unsigned char *sig, size_t siglen,
65                    const unsigned char *tbs, size_t tbslen);
66     int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
67     int (*verify_recover) (EVP_PKEY_CTX *ctx,
68                            unsigned char *rout, size_t *routlen,
69                            const unsigned char *sig, size_t siglen);
70     int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
71     int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
72                     EVP_MD_CTX *mctx);
73     int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
74     int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
75                       EVP_MD_CTX *mctx);
76     int (*encrypt_init) (EVP_PKEY_CTX *ctx);
77     int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
78                     const unsigned char *in, size_t inlen);
79     int (*decrypt_init) (EVP_PKEY_CTX *ctx);
80     int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
81                     const unsigned char *in, size_t inlen);
82     int (*derive_init) (EVP_PKEY_CTX *ctx);
83     int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
84     int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
85     int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
86     int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
87                        const unsigned char *tbs, size_t tbslen);
88     int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
89                          size_t siglen, const unsigned char *tbs,
90                          size_t tbslen);
91     int (*check) (EVP_PKEY *pkey);
92     int (*public_check) (EVP_PKEY *pkey);
93     int (*param_check) (EVP_PKEY *pkey);
94
95     int (*digest_custom) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
96 } /* EVP_PKEY_METHOD */ ;
97
98 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
99
100 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
101
102 extern const EVP_PKEY_METHOD cmac_pkey_meth;
103 extern const EVP_PKEY_METHOD dh_pkey_meth;
104 extern const EVP_PKEY_METHOD dhx_pkey_meth;
105 extern const EVP_PKEY_METHOD dsa_pkey_meth;
106 extern const EVP_PKEY_METHOD ec_pkey_meth;
107 extern const EVP_PKEY_METHOD sm2_pkey_meth;
108 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
109 extern const EVP_PKEY_METHOD ecx448_pkey_meth;
110 extern const EVP_PKEY_METHOD ed25519_pkey_meth;
111 extern const EVP_PKEY_METHOD ed448_pkey_meth;
112 extern const EVP_PKEY_METHOD hmac_pkey_meth;
113 extern const EVP_PKEY_METHOD rsa_pkey_meth;
114 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
115 extern const EVP_PKEY_METHOD scrypt_pkey_meth;
116 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
117 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
118 extern const EVP_PKEY_METHOD poly1305_pkey_meth;
119 extern const EVP_PKEY_METHOD siphash_pkey_meth;
120
121 struct evp_mac_st {
122     OSSL_PROVIDER *prov;
123     char *name;
124
125     CRYPTO_REF_COUNT refcnt;
126     CRYPTO_RWLOCK *lock;
127
128     OSSL_OP_mac_newctx_fn *newctx;
129     OSSL_OP_mac_dupctx_fn *dupctx;
130     OSSL_OP_mac_freectx_fn *freectx;
131     OSSL_OP_mac_size_fn *size;
132     OSSL_OP_mac_init_fn *init;
133     OSSL_OP_mac_update_fn *update;
134     OSSL_OP_mac_final_fn *final;
135     OSSL_OP_mac_gettable_params_fn *gettable_params;
136     OSSL_OP_mac_gettable_ctx_params_fn *gettable_ctx_params;
137     OSSL_OP_mac_settable_ctx_params_fn *settable_ctx_params;
138     OSSL_OP_mac_get_params_fn *get_params;
139     OSSL_OP_mac_get_ctx_params_fn *get_ctx_params;
140     OSSL_OP_mac_set_ctx_params_fn *set_ctx_params;
141 };
142
143 struct evp_kdf_st {
144     OSSL_PROVIDER *prov;
145     char *name;
146     CRYPTO_REF_COUNT refcnt;
147     CRYPTO_RWLOCK *lock;
148
149     OSSL_OP_kdf_newctx_fn *newctx;
150     OSSL_OP_kdf_dupctx_fn *dupctx;
151     OSSL_OP_kdf_freectx_fn *freectx;
152     OSSL_OP_kdf_reset_fn *reset;
153     OSSL_OP_kdf_derive_fn *derive;
154     OSSL_OP_kdf_gettable_params_fn *gettable_params;
155     OSSL_OP_kdf_gettable_ctx_params_fn *gettable_ctx_params;
156     OSSL_OP_kdf_settable_ctx_params_fn *settable_ctx_params;
157     OSSL_OP_kdf_get_params_fn *get_params;
158     OSSL_OP_kdf_get_ctx_params_fn *get_ctx_params;
159     OSSL_OP_kdf_set_ctx_params_fn *set_ctx_params;
160 };
161
162 extern const EVP_KDF pbkdf2_kdf_meth;
163 extern const EVP_KDF scrypt_kdf_meth;
164 extern const EVP_KDF tls1_prf_kdf_meth;
165 extern const EVP_KDF hkdf_kdf_meth;
166 extern const EVP_KDF sshkdf_kdf_meth;
167 extern const EVP_KDF ss_kdf_meth;
168 extern const EVP_KDF x963_kdf_meth;
169 extern const EVP_KDF x942_kdf_meth;
170
171 struct evp_md_st {
172     /* nid */
173     int type;
174
175     /* Legacy structure members */
176     /* TODO(3.0): Remove these */
177     int pkey_type;
178     int md_size;
179     unsigned long flags;
180     int (*init) (EVP_MD_CTX *ctx);
181     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
182     int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
183     int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
184     int (*cleanup) (EVP_MD_CTX *ctx);
185     int block_size;
186     int ctx_size;               /* how big does the ctx->md_data need to be */
187     /* control function */
188     int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
189
190     /* New structure members */
191     /* TODO(3.0): Remove above comment when legacy has gone */
192     char *name;
193     OSSL_PROVIDER *prov;
194     CRYPTO_REF_COUNT refcnt;
195     CRYPTO_RWLOCK *lock;
196     OSSL_OP_digest_newctx_fn *newctx;
197     OSSL_OP_digest_init_fn *dinit;
198     OSSL_OP_digest_update_fn *dupdate;
199     OSSL_OP_digest_final_fn *dfinal;
200     OSSL_OP_digest_digest_fn *digest;
201     OSSL_OP_digest_freectx_fn *freectx;
202     OSSL_OP_digest_dupctx_fn *dupctx;
203     OSSL_OP_digest_get_params_fn *get_params;
204     OSSL_OP_digest_set_ctx_params_fn *set_ctx_params;
205     OSSL_OP_digest_get_ctx_params_fn *get_ctx_params;
206     OSSL_OP_digest_gettable_params_fn *gettable_params;
207     OSSL_OP_digest_settable_ctx_params_fn *settable_ctx_params;
208     OSSL_OP_digest_gettable_ctx_params_fn *gettable_ctx_params;
209
210 } /* EVP_MD */ ;
211
212 struct evp_cipher_st {
213     int nid;
214
215     int block_size;
216     /* Default value for variable length ciphers */
217     int key_len;
218     int iv_len;
219
220     /* Legacy structure members */
221     /* TODO(3.0): Remove these */
222     /* Various flags */
223     unsigned long flags;
224     /* init key */
225     int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
226                  const unsigned char *iv, int enc);
227     /* encrypt/decrypt data */
228     int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
229                       const unsigned char *in, size_t inl);
230     /* cleanup ctx */
231     int (*cleanup) (EVP_CIPHER_CTX *);
232     /* how big ctx->cipher_data needs to be */
233     int ctx_size;
234     /* Populate a ASN1_TYPE with parameters */
235     int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
236     /* Get parameters from a ASN1_TYPE */
237     int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
238     /* Miscellaneous operations */
239     int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
240     /* Application data */
241     void *app_data;
242
243     /* New structure members */
244     /* TODO(3.0): Remove above comment when legacy has gone */
245     char *name;
246     OSSL_PROVIDER *prov;
247     CRYPTO_REF_COUNT refcnt;
248     CRYPTO_RWLOCK *lock;
249     OSSL_OP_cipher_newctx_fn *newctx;
250     OSSL_OP_cipher_encrypt_init_fn *einit;
251     OSSL_OP_cipher_decrypt_init_fn *dinit;
252     OSSL_OP_cipher_update_fn *cupdate;
253     OSSL_OP_cipher_final_fn *cfinal;
254     OSSL_OP_cipher_cipher_fn *ccipher;
255     OSSL_OP_cipher_freectx_fn *freectx;
256     OSSL_OP_cipher_dupctx_fn *dupctx;
257     OSSL_OP_cipher_get_params_fn *get_params;
258     OSSL_OP_cipher_get_ctx_params_fn *get_ctx_params;
259     OSSL_OP_cipher_set_ctx_params_fn *set_ctx_params;
260     OSSL_OP_cipher_gettable_params_fn *gettable_params;
261     OSSL_OP_cipher_gettable_ctx_params_fn *gettable_ctx_params;
262     OSSL_OP_cipher_settable_ctx_params_fn *settable_ctx_params;
263 } /* EVP_CIPHER */ ;
264
265 /* Macros to code block cipher wrappers */
266
267 /* Wrapper functions for each cipher mode */
268
269 #define EVP_C_DATA(kstruct, ctx) \
270         ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
271
272 #define BLOCK_CIPHER_ecb_loop() \
273         size_t i, bl; \
274         bl = EVP_CIPHER_CTX_cipher(ctx)->block_size;    \
275         if (inl < bl) return 1;\
276         inl -= bl; \
277         for (i=0; i <= inl; i+=bl)
278
279 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
280 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
281 {\
282         BLOCK_CIPHER_ecb_loop() \
283             cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
284         return 1;\
285 }
286
287 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
288
289 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
290     static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
291 {\
292         while(inl>=EVP_MAXCHUNK) {\
293             int num = EVP_CIPHER_CTX_num(ctx);\
294             cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
295             EVP_CIPHER_CTX_set_num(ctx, num);\
296             inl-=EVP_MAXCHUNK;\
297             in +=EVP_MAXCHUNK;\
298             out+=EVP_MAXCHUNK;\
299         }\
300         if (inl) {\
301             int num = EVP_CIPHER_CTX_num(ctx);\
302             cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
303             EVP_CIPHER_CTX_set_num(ctx, num);\
304         }\
305         return 1;\
306 }
307
308 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
309 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
310 {\
311         while(inl>=EVP_MAXCHUNK) \
312             {\
313             cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
314             inl-=EVP_MAXCHUNK;\
315             in +=EVP_MAXCHUNK;\
316             out+=EVP_MAXCHUNK;\
317             }\
318         if (inl)\
319             cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
320         return 1;\
321 }
322
323 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched)  \
324 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
325 {\
326     size_t chunk = EVP_MAXCHUNK;\
327     if (cbits == 1)  chunk >>= 3;\
328     if (inl < chunk) chunk = inl;\
329     while (inl && inl >= chunk)\
330     {\
331         int num = EVP_CIPHER_CTX_num(ctx);\
332         cprefix##_cfb##cbits##_encrypt(in, out, (long) \
333             ((cbits == 1) \
334                 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
335                 ? chunk*8 : chunk), \
336             &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
337             &num, EVP_CIPHER_CTX_encrypting(ctx));\
338         EVP_CIPHER_CTX_set_num(ctx, num);\
339         inl -= chunk;\
340         in += chunk;\
341         out += chunk;\
342         if (inl < chunk) chunk = inl;\
343     }\
344     return 1;\
345 }
346
347 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
348         BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
349         BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
350         BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
351         BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
352
353 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
354                           key_len, iv_len, flags, init_key, cleanup, \
355                           set_asn1, get_asn1, ctrl) \
356 static const EVP_CIPHER cname##_##mode = { \
357         nid##_##nmode, block_size, key_len, iv_len, \
358         flags | EVP_CIPH_##MODE##_MODE, \
359         init_key, \
360         cname##_##mode##_cipher, \
361         cleanup, \
362         sizeof(kstruct), \
363         set_asn1, get_asn1,\
364         ctrl, \
365         NULL \
366 }; \
367 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
368
369 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
370                              iv_len, flags, init_key, cleanup, set_asn1, \
371                              get_asn1, ctrl) \
372 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
373                   iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
374
375 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
376                              iv_len, cbits, flags, init_key, cleanup, \
377                              set_asn1, get_asn1, ctrl) \
378 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
379                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
380                   get_asn1, ctrl)
381
382 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
383                              iv_len, cbits, flags, init_key, cleanup, \
384                              set_asn1, get_asn1, ctrl) \
385 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
386                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
387                   get_asn1, ctrl)
388
389 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
390                              flags, init_key, cleanup, set_asn1, \
391                              get_asn1, ctrl) \
392 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
393                   0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
394
395 #define BLOCK_CIPHER_defs(cname, kstruct, \
396                           nid, block_size, key_len, iv_len, cbits, flags, \
397                           init_key, cleanup, set_asn1, get_asn1, ctrl) \
398 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
399                      init_key, cleanup, set_asn1, get_asn1, ctrl) \
400 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
401                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
402 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
403                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
404 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
405                      init_key, cleanup, set_asn1, get_asn1, ctrl)
406
407 /*-
408 #define BLOCK_CIPHER_defs(cname, kstruct, \
409                                 nid, block_size, key_len, iv_len, flags,\
410                                  init_key, cleanup, set_asn1, get_asn1, ctrl)\
411 static const EVP_CIPHER cname##_cbc = {\
412         nid##_cbc, block_size, key_len, iv_len, \
413         flags | EVP_CIPH_CBC_MODE,\
414         init_key,\
415         cname##_cbc_cipher,\
416         cleanup,\
417         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
418                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
419         set_asn1, get_asn1,\
420         ctrl, \
421         NULL \
422 };\
423 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
424 static const EVP_CIPHER cname##_cfb = {\
425         nid##_cfb64, 1, key_len, iv_len, \
426         flags | EVP_CIPH_CFB_MODE,\
427         init_key,\
428         cname##_cfb_cipher,\
429         cleanup,\
430         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
431                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
432         set_asn1, get_asn1,\
433         ctrl,\
434         NULL \
435 };\
436 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
437 static const EVP_CIPHER cname##_ofb = {\
438         nid##_ofb64, 1, key_len, iv_len, \
439         flags | EVP_CIPH_OFB_MODE,\
440         init_key,\
441         cname##_ofb_cipher,\
442         cleanup,\
443         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
444                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
445         set_asn1, get_asn1,\
446         ctrl,\
447         NULL \
448 };\
449 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
450 static const EVP_CIPHER cname##_ecb = {\
451         nid##_ecb, block_size, key_len, iv_len, \
452         flags | EVP_CIPH_ECB_MODE,\
453         init_key,\
454         cname##_ecb_cipher,\
455         cleanup,\
456         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
457                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
458         set_asn1, get_asn1,\
459         ctrl,\
460         NULL \
461 };\
462 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
463 */
464
465 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
466                                block_size, key_len, iv_len, cbits, \
467                                flags, init_key, \
468                                cleanup, set_asn1, get_asn1, ctrl) \
469         BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
470         BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
471                           cbits, flags, init_key, cleanup, set_asn1, \
472                           get_asn1, ctrl)
473
474 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
475         BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
476         BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
477                              NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
478                              (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
479                              cipher##_init_key, NULL, NULL, NULL, NULL)
480
481
482 # ifndef OPENSSL_NO_EC
483
484 #define X25519_KEYLEN        32
485 #define X448_KEYLEN          56
486 #define ED448_KEYLEN         57
487
488 #define MAX_KEYLEN  ED448_KEYLEN
489
490 typedef struct {
491     unsigned char pubkey[MAX_KEYLEN];
492     unsigned char *privkey;
493 } ECX_KEY;
494
495 #endif
496
497 /*
498  * Type needs to be a bit field Sub-type needs to be for variations on the
499  * method, as in, can it do arbitrary encryption....
500  */
501 struct evp_pkey_st {
502     /* == Legacy attributes == */
503     int type;
504     int save_type;
505     const EVP_PKEY_ASN1_METHOD *ameth;
506     ENGINE *engine;
507     ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
508     union {
509         void *ptr;
510 # ifndef OPENSSL_NO_RSA
511         struct rsa_st *rsa;     /* RSA */
512 # endif
513 # ifndef OPENSSL_NO_DSA
514         struct dsa_st *dsa;     /* DSA */
515 # endif
516 # ifndef OPENSSL_NO_DH
517         struct dh_st *dh;       /* DH */
518 # endif
519 # ifndef OPENSSL_NO_EC
520         struct ec_key_st *ec;   /* ECC */
521         ECX_KEY *ecx;           /* X25519, X448, Ed25519, Ed448 */
522 # endif
523     } pkey;
524
525     /* == Common attributes == */
526     CRYPTO_REF_COUNT references;
527     CRYPTO_RWLOCK *lock;
528     STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
529     int save_parameters;
530
531     /* == Provider attributes == */
532     /*
533      * To support transparent export/import between providers that
534      * support the methods for it, and still not having to do the
535      * export/import every time a key is used, we maintain a cache
536      * of imported key, indexed by provider address.
537      * pkeys[0] is *always* the "original" key.
538      */
539     struct {
540         EVP_KEYMGMT *keymgmt;
541         void *provkey;
542     } pkeys[10];
543     /*
544      * If there is a legacy key assigned to this structure, we keep
545      * a copy of that key's dirty count.
546      */
547     size_t dirty_cnt_copy;
548 } /* EVP_PKEY */ ;
549
550
551 void openssl_add_all_ciphers_int(void);
552 void openssl_add_all_digests_int(void);
553 void evp_cleanup_int(void);
554 void evp_app_cleanup_int(void);
555
556 /* KEYMGMT helper functions */
557 void *evp_keymgmt_export_to_provider(EVP_PKEY *pk, EVP_KEYMGMT *keymgmt);
558 void evp_keymgmt_clear_pkey_cache(EVP_PKEY *pk);
559
560 /* KEYMGMT provider interface functions */
561 void *evp_keymgmt_importdomparams(const EVP_KEYMGMT *keymgmt,
562                                   const OSSL_PARAM params[]);
563 void *evp_keymgmt_gendomparams(const EVP_KEYMGMT *keymgmt,
564                             const OSSL_PARAM params[]);
565 void evp_keymgmt_freedomparams(const EVP_KEYMGMT *keymgmt,
566                                void *provdomparams);
567 int evp_keymgmt_exportdomparams(const EVP_KEYMGMT *keymgmt,
568                                 void *provdomparams, OSSL_PARAM params[]);
569 const OSSL_PARAM *
570 evp_keymgmt_importdomparam_types(const EVP_KEYMGMT *keymgmt);
571 const OSSL_PARAM *
572 evp_keymgmt_exportdomparam_types(const EVP_KEYMGMT *keymgmt);
573
574 void *evp_keymgmt_importkey(const EVP_KEYMGMT *keymgmt,
575                             const OSSL_PARAM params[]);
576 void *evp_keymgmt_genkey(const EVP_KEYMGMT *keymgmt, void *domparams,
577                          const OSSL_PARAM params[]);
578 void *evp_keymgmt_loadkey(const EVP_KEYMGMT *keymgmt,
579                           void *id, size_t idlen);
580 void evp_keymgmt_freekey(const EVP_KEYMGMT *keymgmt, void *provkey);
581 int evp_keymgmt_exportkey(const EVP_KEYMGMT *keymgmt,
582                                void *provkey, OSSL_PARAM params[]);
583 const OSSL_PARAM *evp_keymgmt_importkey_types(const EVP_KEYMGMT *keymgmt);
584 const OSSL_PARAM *evp_keymgmt_exportkey_types(const EVP_KEYMGMT *keymgmt);
585
586 /* Pulling defines out of C source files */
587
588 #define EVP_RC4_KEY_SIZE 16
589 #ifndef TLS1_1_VERSION
590 # define TLS1_1_VERSION   0x0302
591 #endif
592
593 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
594
595 /* EVP_ENCODE_CTX flags */
596 /* Don't generate new lines when encoding */
597 #define EVP_ENCODE_CTX_NO_NEWLINES          1
598 /* Use the SRP base64 alphabet instead of the standard one */
599 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET     2