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