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