2 * Copyright 2015-2017 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include "internal/refcount.h"
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 */
17 /* Key: may be NULL */
19 /* Peer key for key agreement, may be NULL */
21 /* Actual operation */
23 /* Algorithm specific data */
25 /* Application specific data */
28 EVP_PKEY_gen_cb *pkey_gencb;
29 /* implementation specific keygen data */
31 int keygen_info_count;
32 } /* EVP_PKEY_CTX */ ;
34 #define EVP_PKEY_FLAG_DYNAMIC 1
36 struct evp_pkey_method_st {
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,
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,
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,
78 } /* EVP_PKEY_METHOD */ ;
80 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
82 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
84 extern const EVP_PKEY_METHOD cmac_pkey_meth;
85 extern const EVP_PKEY_METHOD dh_pkey_meth;
86 extern const EVP_PKEY_METHOD dhx_pkey_meth;
87 extern const EVP_PKEY_METHOD dsa_pkey_meth;
88 extern const EVP_PKEY_METHOD ec_pkey_meth;
89 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
90 extern const EVP_PKEY_METHOD ed25519_pkey_meth;
91 extern const EVP_PKEY_METHOD hmac_pkey_meth;
92 extern const EVP_PKEY_METHOD rsa_pkey_meth;
93 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
94 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
95 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
96 extern const EVP_PKEY_METHOD poly1305_pkey_meth;
97 extern const EVP_PKEY_METHOD siphash_pkey_meth;
104 int (*init) (EVP_MD_CTX *ctx);
105 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
106 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
107 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
108 int (*cleanup) (EVP_MD_CTX *ctx);
110 int ctx_size; /* how big does the ctx->md_data need to be */
111 /* control function */
112 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
115 struct evp_cipher_st {
118 /* Default value for variable length ciphers */
124 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
125 const unsigned char *iv, int enc);
126 /* encrypt/decrypt data */
127 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
128 const unsigned char *in, size_t inl);
130 int (*cleanup) (EVP_CIPHER_CTX *);
131 /* how big ctx->cipher_data needs to be */
133 /* Populate a ASN1_TYPE with parameters */
134 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
135 /* Get parameters from a ASN1_TYPE */
136 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
137 /* Miscellaneous operations */
138 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
139 /* Application data */
143 /* Macros to code block cipher wrappers */
145 /* Wrapper functions for each cipher mode */
147 #define EVP_C_DATA(kstruct, ctx) \
148 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
150 #define BLOCK_CIPHER_ecb_loop() \
152 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
153 if (inl < bl) return 1;\
155 for (i=0; i <= inl; i+=bl)
157 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
158 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
160 BLOCK_CIPHER_ecb_loop() \
161 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
165 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
167 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
168 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
170 while(inl>=EVP_MAXCHUNK) {\
171 int num = EVP_CIPHER_CTX_num(ctx);\
172 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
173 EVP_CIPHER_CTX_set_num(ctx, num);\
179 int num = EVP_CIPHER_CTX_num(ctx);\
180 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
181 EVP_CIPHER_CTX_set_num(ctx, num);\
186 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
187 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
189 while(inl>=EVP_MAXCHUNK) \
191 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));\
197 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
201 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
202 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
204 size_t chunk = EVP_MAXCHUNK;\
205 if (cbits == 1) chunk >>= 3;\
206 if (inl < chunk) chunk = inl;\
207 while (inl && inl >= chunk)\
209 int num = EVP_CIPHER_CTX_num(ctx);\
210 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
212 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
214 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
215 &num, EVP_CIPHER_CTX_encrypting(ctx));\
216 EVP_CIPHER_CTX_set_num(ctx, num);\
220 if (inl < chunk) chunk = inl;\
225 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
226 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
227 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
228 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
229 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
231 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
232 key_len, iv_len, flags, init_key, cleanup, \
233 set_asn1, get_asn1, ctrl) \
234 static const EVP_CIPHER cname##_##mode = { \
235 nid##_##nmode, block_size, key_len, iv_len, \
236 flags | EVP_CIPH_##MODE##_MODE, \
238 cname##_##mode##_cipher, \
245 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
247 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
248 iv_len, flags, init_key, cleanup, set_asn1, \
250 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
251 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
253 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
254 iv_len, cbits, flags, init_key, cleanup, \
255 set_asn1, get_asn1, ctrl) \
256 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
257 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
260 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
261 iv_len, cbits, flags, init_key, cleanup, \
262 set_asn1, get_asn1, ctrl) \
263 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
264 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
267 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
268 flags, init_key, cleanup, set_asn1, \
270 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
271 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
273 #define BLOCK_CIPHER_defs(cname, kstruct, \
274 nid, block_size, key_len, iv_len, cbits, flags, \
275 init_key, cleanup, set_asn1, get_asn1, ctrl) \
276 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
277 init_key, cleanup, set_asn1, get_asn1, ctrl) \
278 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
279 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
280 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
281 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
282 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
283 init_key, cleanup, set_asn1, get_asn1, ctrl)
286 #define BLOCK_CIPHER_defs(cname, kstruct, \
287 nid, block_size, key_len, iv_len, flags,\
288 init_key, cleanup, set_asn1, get_asn1, ctrl)\
289 static const EVP_CIPHER cname##_cbc = {\
290 nid##_cbc, block_size, key_len, iv_len, \
291 flags | EVP_CIPH_CBC_MODE,\
295 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
296 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
301 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
302 static const EVP_CIPHER cname##_cfb = {\
303 nid##_cfb64, 1, key_len, iv_len, \
304 flags | EVP_CIPH_CFB_MODE,\
308 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
309 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
314 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
315 static const EVP_CIPHER cname##_ofb = {\
316 nid##_ofb64, 1, key_len, iv_len, \
317 flags | EVP_CIPH_OFB_MODE,\
321 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
322 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
327 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
328 static const EVP_CIPHER cname##_ecb = {\
329 nid##_ecb, block_size, key_len, iv_len, \
330 flags | EVP_CIPH_ECB_MODE,\
334 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
335 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
340 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
343 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
344 block_size, key_len, iv_len, cbits, \
346 cleanup, set_asn1, get_asn1, ctrl) \
347 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
348 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
349 cbits, flags, init_key, cleanup, set_asn1, \
352 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
353 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
354 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
355 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
356 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
357 cipher##_init_key, NULL, NULL, NULL, NULL)
361 * Type needs to be a bit field Sub-type needs to be for variations on the
362 * method, as in, can it do arbitrary encryption....
367 CRYPTO_REF_COUNT references;
368 const EVP_PKEY_ASN1_METHOD *ameth;
372 # ifndef OPENSSL_NO_RSA
373 struct rsa_st *rsa; /* RSA */
375 # ifndef OPENSSL_NO_DSA
376 struct dsa_st *dsa; /* DSA */
378 # ifndef OPENSSL_NO_DH
379 struct dh_st *dh; /* DH */
381 # ifndef OPENSSL_NO_EC
382 struct ec_key_st *ec; /* ECC */
386 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
391 void openssl_add_all_ciphers_int(void);
392 void openssl_add_all_digests_int(void);
393 void evp_cleanup_int(void);
395 /* Pulling defines out of C soure files */
397 #define EVP_RC4_KEY_SIZE 16
398 #ifndef TLS1_1_VERSION
399 # define TLS1_1_VERSION 0x0302