]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/include/internal/evp_int.h
Docs for OpenSSL_init_crypto: there is no way to specify another file
[thirdparty/openssl.git] / crypto / include / internal / evp_int.h
CommitLineData
27af42f9 1/*
0d664759 2 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
27af42f9 3 *
aa6bb135
RS
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
27af42f9
DSH
8 */
9
2f545ae4
KR
10#include "internal/refcount.h"
11
27af42f9
DSH
12struct 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
36struct 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);
f723c98e
DSH
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);
2aee35d3 78 int (*check) (EVP_PKEY *pkey);
b0004708
PY
79 int (*public_check) (EVP_PKEY *pkey);
80 int (*param_check) (EVP_PKEY *pkey);
27af42f9
DSH
81} /* EVP_PKEY_METHOD */ ;
82
a8eba56e 83DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
4a1f3f27 84
27af42f9 85void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
8f463dbd
DSH
86
87extern const EVP_PKEY_METHOD cmac_pkey_meth;
88extern const EVP_PKEY_METHOD dh_pkey_meth;
89extern const EVP_PKEY_METHOD dhx_pkey_meth;
90extern const EVP_PKEY_METHOD dsa_pkey_meth;
91extern const EVP_PKEY_METHOD ec_pkey_meth;
262bd85f 92extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
13735cfe 93extern const EVP_PKEY_METHOD ecx448_pkey_meth;
42a3008a 94extern const EVP_PKEY_METHOD ed25519_pkey_meth;
13735cfe 95extern const EVP_PKEY_METHOD ed448_pkey_meth;
8f463dbd
DSH
96extern const EVP_PKEY_METHOD hmac_pkey_meth;
97extern const EVP_PKEY_METHOD rsa_pkey_meth;
6577e008 98extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
cefa762e 99extern const EVP_PKEY_METHOD scrypt_pkey_meth;
1eff3485 100extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
aacfb134 101extern const EVP_PKEY_METHOD hkdf_pkey_meth;
52ad5b60 102extern const EVP_PKEY_METHOD poly1305_pkey_meth;
3f5616d7 103extern const EVP_PKEY_METHOD siphash_pkey_meth;
2db6bf6f
RL
104
105struct evp_md_st {
106 int type;
107 int pkey_type;
108 int md_size;
109 unsigned long flags;
110 int (*init) (EVP_MD_CTX *ctx);
111 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
112 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
113 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
114 int (*cleanup) (EVP_MD_CTX *ctx);
115 int block_size;
116 int ctx_size; /* how big does the ctx->md_data need to be */
117 /* control function */
118 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
119} /* EVP_MD */ ;
120
e79f8773
RL
121struct evp_cipher_st {
122 int nid;
123 int block_size;
124 /* Default value for variable length ciphers */
125 int key_len;
126 int iv_len;
127 /* Various flags */
128 unsigned long flags;
129 /* init key */
130 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
131 const unsigned char *iv, int enc);
132 /* encrypt/decrypt data */
133 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
134 const unsigned char *in, size_t inl);
135 /* cleanup ctx */
136 int (*cleanup) (EVP_CIPHER_CTX *);
137 /* how big ctx->cipher_data needs to be */
138 int ctx_size;
139 /* Populate a ASN1_TYPE with parameters */
140 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
141 /* Get parameters from a ASN1_TYPE */
142 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
143 /* Miscellaneous operations */
144 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
145 /* Application data */
146 void *app_data;
147} /* EVP_CIPHER */ ;
148
149/* Macros to code block cipher wrappers */
150
151/* Wrapper functions for each cipher mode */
152
44ab2dfd
MC
153#define EVP_C_DATA(kstruct, ctx) \
154 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
e79f8773
RL
155
156#define BLOCK_CIPHER_ecb_loop() \
157 size_t i, bl; \
158 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
e8aa8b6c 159 if (inl < bl) return 1;\
e79f8773 160 inl -= bl; \
e8aa8b6c 161 for (i=0; i <= inl; i+=bl)
e79f8773
RL
162
163#define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
164static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
165{\
166 BLOCK_CIPHER_ecb_loop() \
167 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
168 return 1;\
169}
170
171#define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
172
173#define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
174 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
175{\
176 while(inl>=EVP_MAXCHUNK) {\
177 int num = EVP_CIPHER_CTX_num(ctx);\
178 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
179 EVP_CIPHER_CTX_set_num(ctx, num);\
180 inl-=EVP_MAXCHUNK;\
181 in +=EVP_MAXCHUNK;\
182 out+=EVP_MAXCHUNK;\
183 }\
184 if (inl) {\
185 int num = EVP_CIPHER_CTX_num(ctx);\
186 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
187 EVP_CIPHER_CTX_set_num(ctx, num);\
188 }\
189 return 1;\
190}
191
192#define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
193static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
194{\
195 while(inl>=EVP_MAXCHUNK) \
196 {\
197 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));\
198 inl-=EVP_MAXCHUNK;\
199 in +=EVP_MAXCHUNK;\
200 out+=EVP_MAXCHUNK;\
201 }\
202 if (inl)\
203 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
204 return 1;\
205}
206
207#define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
208static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
209{\
e8aa8b6c
F
210 size_t chunk = EVP_MAXCHUNK;\
211 if (cbits == 1) chunk >>= 3;\
212 if (inl < chunk) chunk = inl;\
213 while (inl && inl >= chunk)\
214 {\
215 int num = EVP_CIPHER_CTX_num(ctx);\
216 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
217 ((cbits == 1) \
218 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
604e591e 219 ? chunk*8 : chunk), \
e8aa8b6c
F
220 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
221 &num, EVP_CIPHER_CTX_encrypting(ctx));\
222 EVP_CIPHER_CTX_set_num(ctx, num);\
223 inl -= chunk;\
224 in += chunk;\
225 out += chunk;\
226 if (inl < chunk) chunk = inl;\
227 }\
228 return 1;\
e79f8773
RL
229}
230
231#define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
232 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
233 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
234 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
235 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
236
237#define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
238 key_len, iv_len, flags, init_key, cleanup, \
239 set_asn1, get_asn1, ctrl) \
240static const EVP_CIPHER cname##_##mode = { \
241 nid##_##nmode, block_size, key_len, iv_len, \
242 flags | EVP_CIPH_##MODE##_MODE, \
243 init_key, \
244 cname##_##mode##_cipher, \
245 cleanup, \
246 sizeof(kstruct), \
247 set_asn1, get_asn1,\
248 ctrl, \
249 NULL \
250}; \
251const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
252
253#define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
254 iv_len, flags, init_key, cleanup, set_asn1, \
255 get_asn1, ctrl) \
256BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
257 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
258
259#define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
260 iv_len, cbits, flags, init_key, cleanup, \
261 set_asn1, get_asn1, ctrl) \
262BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
263 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
264 get_asn1, ctrl)
265
266#define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
267 iv_len, cbits, flags, init_key, cleanup, \
268 set_asn1, get_asn1, ctrl) \
269BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
270 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
271 get_asn1, ctrl)
272
273#define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
274 flags, init_key, cleanup, set_asn1, \
275 get_asn1, ctrl) \
276BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
277 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
278
279#define BLOCK_CIPHER_defs(cname, kstruct, \
280 nid, block_size, key_len, iv_len, cbits, flags, \
281 init_key, cleanup, set_asn1, get_asn1, ctrl) \
282BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
283 init_key, cleanup, set_asn1, get_asn1, ctrl) \
284BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
285 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
286BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
287 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
288BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
289 init_key, cleanup, set_asn1, get_asn1, ctrl)
290
291/*-
292#define BLOCK_CIPHER_defs(cname, kstruct, \
293 nid, block_size, key_len, iv_len, flags,\
294 init_key, cleanup, set_asn1, get_asn1, ctrl)\
295static const EVP_CIPHER cname##_cbc = {\
296 nid##_cbc, block_size, key_len, iv_len, \
297 flags | EVP_CIPH_CBC_MODE,\
298 init_key,\
299 cname##_cbc_cipher,\
300 cleanup,\
301 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
302 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
303 set_asn1, get_asn1,\
304 ctrl, \
305 NULL \
306};\
307const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
308static const EVP_CIPHER cname##_cfb = {\
309 nid##_cfb64, 1, key_len, iv_len, \
310 flags | EVP_CIPH_CFB_MODE,\
311 init_key,\
312 cname##_cfb_cipher,\
313 cleanup,\
314 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
315 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
316 set_asn1, get_asn1,\
317 ctrl,\
318 NULL \
319};\
320const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
321static const EVP_CIPHER cname##_ofb = {\
322 nid##_ofb64, 1, key_len, iv_len, \
323 flags | EVP_CIPH_OFB_MODE,\
324 init_key,\
325 cname##_ofb_cipher,\
326 cleanup,\
327 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
328 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
329 set_asn1, get_asn1,\
330 ctrl,\
331 NULL \
332};\
333const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
334static const EVP_CIPHER cname##_ecb = {\
335 nid##_ecb, block_size, key_len, iv_len, \
336 flags | EVP_CIPH_ECB_MODE,\
337 init_key,\
338 cname##_ecb_cipher,\
339 cleanup,\
340 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
341 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
342 set_asn1, get_asn1,\
343 ctrl,\
344 NULL \
345};\
346const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
347*/
348
349#define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
350 block_size, key_len, iv_len, cbits, \
351 flags, init_key, \
352 cleanup, set_asn1, get_asn1, ctrl) \
353 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
354 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
355 cbits, flags, init_key, cleanup, set_asn1, \
356 get_asn1, ctrl)
357
358#define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
359 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
360 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
361 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
362 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
363 cipher##_init_key, NULL, NULL, NULL, NULL)
364
3aeb9348 365
13735cfe
MC
366# ifndef OPENSSL_NO_EC
367
368#define X25519_KEYLEN 32
369#define X448_KEYLEN 56
370#define ED448_KEYLEN 57
371
372#define MAX_KEYLEN ED448_KEYLEN
373
374typedef struct {
375 unsigned char pubkey[MAX_KEYLEN];
376 unsigned char *privkey;
377} ECX_KEY;
378
379#endif
380
3aeb9348
DSH
381/*
382 * Type needs to be a bit field Sub-type needs to be for variations on the
383 * method, as in, can it do arbitrary encryption....
384 */
385struct evp_pkey_st {
386 int type;
387 int save_type;
2f545ae4 388 CRYPTO_REF_COUNT references;
3aeb9348
DSH
389 const EVP_PKEY_ASN1_METHOD *ameth;
390 ENGINE *engine;
d19b01ad 391 ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
3aeb9348 392 union {
a4cb54d2 393 void *ptr;
3aeb9348
DSH
394# ifndef OPENSSL_NO_RSA
395 struct rsa_st *rsa; /* RSA */
396# endif
397# ifndef OPENSSL_NO_DSA
398 struct dsa_st *dsa; /* DSA */
399# endif
400# ifndef OPENSSL_NO_DH
401 struct dh_st *dh; /* DH */
402# endif
403# ifndef OPENSSL_NO_EC
404 struct ec_key_st *ec; /* ECC */
13735cfe 405 ECX_KEY *ecx; /* X25519, X448, Ed25519, Ed448 */
3aeb9348
DSH
406# endif
407 } pkey;
408 int save_parameters;
409 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
03273d61 410 CRYPTO_RWLOCK *lock;
3aeb9348 411} /* EVP_PKEY */ ;
7b9f8f7f
MC
412
413
b3599dbb
MC
414void openssl_add_all_ciphers_int(void);
415void openssl_add_all_digests_int(void);
416void evp_cleanup_int(void);
0822e89a 417void evp_app_cleanup_int(void);
9d6fcd42 418
46f4e1be 419/* Pulling defines out of C source files */
9d6fcd42
TS
420
421#define EVP_RC4_KEY_SIZE 16
422#ifndef TLS1_1_VERSION
423# define TLS1_1_VERSION 0x0302
424#endif