Add EVP_PKEY_set1_engine() function.
[openssl.git] / crypto / include / internal / evp_int.h
1 /*
2  * Copyright 2015-2017 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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 "internal/refcount.h"
11
12 struct evp_pkey_ctx_st {
13     /* Method associated with this operation */
14     const EVP_PKEY_METHOD *pmeth;
15     /* Engine that implements this method or NULL if builtin */
16     ENGINE *engine;
17     /* Key: may be NULL */
18     EVP_PKEY *pkey;
19     /* Peer key for key agreement, may be NULL */
20     EVP_PKEY *peerkey;
21     /* Actual operation */
22     int operation;
23     /* Algorithm specific data */
24     void *data;
25     /* Application specific data */
26     void *app_data;
27     /* Keygen callback */
28     EVP_PKEY_gen_cb *pkey_gencb;
29     /* implementation specific keygen data */
30     int *keygen_info;
31     int keygen_info_count;
32 } /* EVP_PKEY_CTX */ ;
33
34 #define EVP_PKEY_FLAG_DYNAMIC   1
35
36 struct evp_pkey_method_st {
37     int pkey_id;
38     int flags;
39     int (*init) (EVP_PKEY_CTX *ctx);
40     int (*copy) (EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src);
41     void (*cleanup) (EVP_PKEY_CTX *ctx);
42     int (*paramgen_init) (EVP_PKEY_CTX *ctx);
43     int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
44     int (*keygen_init) (EVP_PKEY_CTX *ctx);
45     int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
46     int (*sign_init) (EVP_PKEY_CTX *ctx);
47     int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
48                  const unsigned char *tbs, size_t tbslen);
49     int (*verify_init) (EVP_PKEY_CTX *ctx);
50     int (*verify) (EVP_PKEY_CTX *ctx,
51                    const unsigned char *sig, size_t siglen,
52                    const unsigned char *tbs, size_t tbslen);
53     int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
54     int (*verify_recover) (EVP_PKEY_CTX *ctx,
55                            unsigned char *rout, size_t *routlen,
56                            const unsigned char *sig, size_t siglen);
57     int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
58     int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
59                     EVP_MD_CTX *mctx);
60     int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
61     int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
62                       EVP_MD_CTX *mctx);
63     int (*encrypt_init) (EVP_PKEY_CTX *ctx);
64     int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
65                     const unsigned char *in, size_t inlen);
66     int (*decrypt_init) (EVP_PKEY_CTX *ctx);
67     int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
68                     const unsigned char *in, size_t inlen);
69     int (*derive_init) (EVP_PKEY_CTX *ctx);
70     int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
71     int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
72     int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
73     int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
74                        const unsigned char *tbs, size_t tbslen);
75     int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
76                          size_t siglen, const unsigned char *tbs,
77                          size_t tbslen);
78     int (*check) (EVP_PKEY *pkey);
79 } /* EVP_PKEY_METHOD */ ;
80
81 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
82
83 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
84
85 extern const EVP_PKEY_METHOD cmac_pkey_meth;
86 extern const EVP_PKEY_METHOD dh_pkey_meth;
87 extern const EVP_PKEY_METHOD dhx_pkey_meth;
88 extern const EVP_PKEY_METHOD dsa_pkey_meth;
89 extern const EVP_PKEY_METHOD ec_pkey_meth;
90 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
91 extern const EVP_PKEY_METHOD ed25519_pkey_meth;
92 extern const EVP_PKEY_METHOD hmac_pkey_meth;
93 extern const EVP_PKEY_METHOD rsa_pkey_meth;
94 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
95 extern const EVP_PKEY_METHOD scrypt_pkey_meth;
96 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
97 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
98 extern const EVP_PKEY_METHOD poly1305_pkey_meth;
99 extern const EVP_PKEY_METHOD siphash_pkey_meth;
100
101 struct evp_md_st {
102     int type;
103     int pkey_type;
104     int md_size;
105     unsigned long flags;
106     int (*init) (EVP_MD_CTX *ctx);
107     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
108     int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
109     int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
110     int (*cleanup) (EVP_MD_CTX *ctx);
111     int block_size;
112     int ctx_size;               /* how big does the ctx->md_data need to be */
113     /* control function */
114     int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
115 } /* EVP_MD */ ;
116
117 struct evp_cipher_st {
118     int nid;
119     int block_size;
120     /* Default value for variable length ciphers */
121     int key_len;
122     int iv_len;
123     /* Various flags */
124     unsigned long flags;
125     /* init key */
126     int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
127                  const unsigned char *iv, int enc);
128     /* encrypt/decrypt data */
129     int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
130                       const unsigned char *in, size_t inl);
131     /* cleanup ctx */
132     int (*cleanup) (EVP_CIPHER_CTX *);
133     /* how big ctx->cipher_data needs to be */
134     int ctx_size;
135     /* Populate a ASN1_TYPE with parameters */
136     int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
137     /* Get parameters from a ASN1_TYPE */
138     int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
139     /* Miscellaneous operations */
140     int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
141     /* Application data */
142     void *app_data;
143 } /* EVP_CIPHER */ ;
144
145 /* Macros to code block cipher wrappers */
146
147 /* Wrapper functions for each cipher mode */
148
149 #define EVP_C_DATA(kstruct, ctx) \
150         ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
151
152 #define BLOCK_CIPHER_ecb_loop() \
153         size_t i, bl; \
154         bl = EVP_CIPHER_CTX_cipher(ctx)->block_size;    \
155         if (inl < bl) return 1;\
156         inl -= bl; \
157         for (i=0; i <= inl; i+=bl)
158
159 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
160 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
161 {\
162         BLOCK_CIPHER_ecb_loop() \
163             cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
164         return 1;\
165 }
166
167 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
168
169 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
170     static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
171 {\
172         while(inl>=EVP_MAXCHUNK) {\
173             int num = EVP_CIPHER_CTX_num(ctx);\
174             cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
175             EVP_CIPHER_CTX_set_num(ctx, num);\
176             inl-=EVP_MAXCHUNK;\
177             in +=EVP_MAXCHUNK;\
178             out+=EVP_MAXCHUNK;\
179         }\
180         if (inl) {\
181             int num = EVP_CIPHER_CTX_num(ctx);\
182             cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
183             EVP_CIPHER_CTX_set_num(ctx, num);\
184         }\
185         return 1;\
186 }
187
188 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
189 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
190 {\
191         while(inl>=EVP_MAXCHUNK) \
192             {\
193             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));\
194             inl-=EVP_MAXCHUNK;\
195             in +=EVP_MAXCHUNK;\
196             out+=EVP_MAXCHUNK;\
197             }\
198         if (inl)\
199             cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
200         return 1;\
201 }
202
203 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched)  \
204 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
205 {\
206     size_t chunk = EVP_MAXCHUNK;\
207     if (cbits == 1)  chunk >>= 3;\
208     if (inl < chunk) chunk = inl;\
209     while (inl && inl >= chunk)\
210     {\
211         int num = EVP_CIPHER_CTX_num(ctx);\
212         cprefix##_cfb##cbits##_encrypt(in, out, (long) \
213             ((cbits == 1) \
214                 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
215                 ? inl*8 : inl), \
216             &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
217             &num, EVP_CIPHER_CTX_encrypting(ctx));\
218         EVP_CIPHER_CTX_set_num(ctx, num);\
219         inl -= chunk;\
220         in += chunk;\
221         out += chunk;\
222         if (inl < chunk) chunk = inl;\
223     }\
224     return 1;\
225 }
226
227 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
228         BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
229         BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
230         BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
231         BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
232
233 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
234                           key_len, iv_len, flags, init_key, cleanup, \
235                           set_asn1, get_asn1, ctrl) \
236 static const EVP_CIPHER cname##_##mode = { \
237         nid##_##nmode, block_size, key_len, iv_len, \
238         flags | EVP_CIPH_##MODE##_MODE, \
239         init_key, \
240         cname##_##mode##_cipher, \
241         cleanup, \
242         sizeof(kstruct), \
243         set_asn1, get_asn1,\
244         ctrl, \
245         NULL \
246 }; \
247 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
248
249 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
250                              iv_len, flags, init_key, cleanup, set_asn1, \
251                              get_asn1, ctrl) \
252 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
253                   iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
254
255 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
256                              iv_len, cbits, flags, init_key, cleanup, \
257                              set_asn1, get_asn1, ctrl) \
258 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
259                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
260                   get_asn1, ctrl)
261
262 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
263                              iv_len, cbits, flags, init_key, cleanup, \
264                              set_asn1, get_asn1, ctrl) \
265 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
266                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
267                   get_asn1, ctrl)
268
269 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
270                              flags, init_key, cleanup, set_asn1, \
271                              get_asn1, ctrl) \
272 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
273                   0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
274
275 #define BLOCK_CIPHER_defs(cname, kstruct, \
276                           nid, block_size, key_len, iv_len, cbits, flags, \
277                           init_key, cleanup, set_asn1, get_asn1, ctrl) \
278 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
279                      init_key, cleanup, set_asn1, get_asn1, ctrl) \
280 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
281                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
282 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
283                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
284 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
285                      init_key, cleanup, set_asn1, get_asn1, ctrl)
286
287 /*-
288 #define BLOCK_CIPHER_defs(cname, kstruct, \
289                                 nid, block_size, key_len, iv_len, flags,\
290                                  init_key, cleanup, set_asn1, get_asn1, ctrl)\
291 static const EVP_CIPHER cname##_cbc = {\
292         nid##_cbc, block_size, key_len, iv_len, \
293         flags | EVP_CIPH_CBC_MODE,\
294         init_key,\
295         cname##_cbc_cipher,\
296         cleanup,\
297         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
298                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
299         set_asn1, get_asn1,\
300         ctrl, \
301         NULL \
302 };\
303 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
304 static const EVP_CIPHER cname##_cfb = {\
305         nid##_cfb64, 1, key_len, iv_len, \
306         flags | EVP_CIPH_CFB_MODE,\
307         init_key,\
308         cname##_cfb_cipher,\
309         cleanup,\
310         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
311                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
312         set_asn1, get_asn1,\
313         ctrl,\
314         NULL \
315 };\
316 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
317 static const EVP_CIPHER cname##_ofb = {\
318         nid##_ofb64, 1, key_len, iv_len, \
319         flags | EVP_CIPH_OFB_MODE,\
320         init_key,\
321         cname##_ofb_cipher,\
322         cleanup,\
323         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
324                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
325         set_asn1, get_asn1,\
326         ctrl,\
327         NULL \
328 };\
329 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
330 static const EVP_CIPHER cname##_ecb = {\
331         nid##_ecb, block_size, key_len, iv_len, \
332         flags | EVP_CIPH_ECB_MODE,\
333         init_key,\
334         cname##_ecb_cipher,\
335         cleanup,\
336         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
337                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
338         set_asn1, get_asn1,\
339         ctrl,\
340         NULL \
341 };\
342 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
343 */
344
345 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
346                                block_size, key_len, iv_len, cbits, \
347                                flags, init_key, \
348                                cleanup, set_asn1, get_asn1, ctrl) \
349         BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
350         BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
351                           cbits, flags, init_key, cleanup, set_asn1, \
352                           get_asn1, ctrl)
353
354 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
355         BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
356         BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
357                              NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
358                              (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
359                              cipher##_init_key, NULL, NULL, NULL, NULL)
360
361
362 /*
363  * Type needs to be a bit field Sub-type needs to be for variations on the
364  * method, as in, can it do arbitrary encryption....
365  */
366 struct evp_pkey_st {
367     int type;
368     int save_type;
369     CRYPTO_REF_COUNT references;
370     const EVP_PKEY_ASN1_METHOD *ameth;
371     ENGINE *engine;
372     ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
373     union {
374         void *ptr;
375 # ifndef OPENSSL_NO_RSA
376         struct rsa_st *rsa;     /* RSA */
377 # endif
378 # ifndef OPENSSL_NO_DSA
379         struct dsa_st *dsa;     /* DSA */
380 # endif
381 # ifndef OPENSSL_NO_DH
382         struct dh_st *dh;       /* DH */
383 # endif
384 # ifndef OPENSSL_NO_EC
385         struct ec_key_st *ec;   /* ECC */
386 # endif
387     } pkey;
388     int save_parameters;
389     STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
390     CRYPTO_RWLOCK *lock;
391 } /* EVP_PKEY */ ;
392
393
394 void openssl_add_all_ciphers_int(void);
395 void openssl_add_all_digests_int(void);
396 void evp_cleanup_int(void);
397 void evp_app_cleanup_int(void);
398
399 /* Pulling defines out of C soure files */
400
401 #define EVP_RC4_KEY_SIZE 16
402 #ifndef TLS1_1_VERSION
403 # define TLS1_1_VERSION   0x0302
404 #endif