2 * Copyright 2015-2016 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 } /* EVP_PKEY_METHOD */ ;
75 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
77 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
79 extern const EVP_PKEY_METHOD cmac_pkey_meth;
80 extern const EVP_PKEY_METHOD dh_pkey_meth;
81 extern const EVP_PKEY_METHOD dhx_pkey_meth;
82 extern const EVP_PKEY_METHOD dsa_pkey_meth;
83 extern const EVP_PKEY_METHOD ec_pkey_meth;
84 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
85 extern const EVP_PKEY_METHOD hmac_pkey_meth;
86 extern const EVP_PKEY_METHOD rsa_pkey_meth;
87 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
88 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
89 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
96 int (*init) (EVP_MD_CTX *ctx);
97 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
98 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
99 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
100 int (*cleanup) (EVP_MD_CTX *ctx);
102 int ctx_size; /* how big does the ctx->md_data need to be */
103 /* control function */
104 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
107 struct evp_cipher_st {
110 /* Default value for variable length ciphers */
116 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
117 const unsigned char *iv, int enc);
118 /* encrypt/decrypt data */
119 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
120 const unsigned char *in, size_t inl);
122 int (*cleanup) (EVP_CIPHER_CTX *);
123 /* how big ctx->cipher_data needs to be */
125 /* Populate a ASN1_TYPE with parameters */
126 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
127 /* Get parameters from a ASN1_TYPE */
128 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
129 /* Miscellaneous operations */
130 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
131 /* Application data */
135 /* Macros to code block cipher wrappers */
137 /* Wrapper functions for each cipher mode */
139 #define EVP_C_DATA(kstruct, ctx) \
140 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
142 #define BLOCK_CIPHER_ecb_loop() \
144 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
145 if (inl < bl) return 1;\
147 for (i=0; i <= inl; i+=bl)
149 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
150 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
152 BLOCK_CIPHER_ecb_loop() \
153 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
157 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
159 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
160 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
162 while(inl>=EVP_MAXCHUNK) {\
163 int num = EVP_CIPHER_CTX_num(ctx);\
164 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
165 EVP_CIPHER_CTX_set_num(ctx, num);\
171 int num = EVP_CIPHER_CTX_num(ctx);\
172 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
173 EVP_CIPHER_CTX_set_num(ctx, num);\
178 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
179 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
181 while(inl>=EVP_MAXCHUNK) \
183 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));\
189 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
193 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
194 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
196 size_t chunk = EVP_MAXCHUNK;\
197 if (cbits == 1) chunk >>= 3;\
198 if (inl < chunk) chunk = inl;\
199 while (inl && inl >= chunk)\
201 int num = EVP_CIPHER_CTX_num(ctx);\
202 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
204 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
206 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
207 &num, EVP_CIPHER_CTX_encrypting(ctx));\
208 EVP_CIPHER_CTX_set_num(ctx, num);\
212 if (inl < chunk) chunk = inl;\
217 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
218 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
219 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
220 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
221 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
223 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
224 key_len, iv_len, flags, init_key, cleanup, \
225 set_asn1, get_asn1, ctrl) \
226 static const EVP_CIPHER cname##_##mode = { \
227 nid##_##nmode, block_size, key_len, iv_len, \
228 flags | EVP_CIPH_##MODE##_MODE, \
230 cname##_##mode##_cipher, \
237 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
239 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
240 iv_len, flags, init_key, cleanup, set_asn1, \
242 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
243 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
245 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
246 iv_len, cbits, flags, init_key, cleanup, \
247 set_asn1, get_asn1, ctrl) \
248 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
249 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
252 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
253 iv_len, cbits, flags, init_key, cleanup, \
254 set_asn1, get_asn1, ctrl) \
255 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
256 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
259 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
260 flags, init_key, cleanup, set_asn1, \
262 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
263 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
265 #define BLOCK_CIPHER_defs(cname, kstruct, \
266 nid, block_size, key_len, iv_len, cbits, flags, \
267 init_key, cleanup, set_asn1, get_asn1, ctrl) \
268 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
269 init_key, cleanup, set_asn1, get_asn1, ctrl) \
270 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
271 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
272 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
273 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
274 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
275 init_key, cleanup, set_asn1, get_asn1, ctrl)
278 #define BLOCK_CIPHER_defs(cname, kstruct, \
279 nid, block_size, key_len, iv_len, flags,\
280 init_key, cleanup, set_asn1, get_asn1, ctrl)\
281 static const EVP_CIPHER cname##_cbc = {\
282 nid##_cbc, block_size, key_len, iv_len, \
283 flags | EVP_CIPH_CBC_MODE,\
287 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
288 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
293 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
294 static const EVP_CIPHER cname##_cfb = {\
295 nid##_cfb64, 1, key_len, iv_len, \
296 flags | EVP_CIPH_CFB_MODE,\
300 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
301 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
306 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
307 static const EVP_CIPHER cname##_ofb = {\
308 nid##_ofb64, 1, key_len, iv_len, \
309 flags | EVP_CIPH_OFB_MODE,\
313 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
314 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
319 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
320 static const EVP_CIPHER cname##_ecb = {\
321 nid##_ecb, block_size, key_len, iv_len, \
322 flags | EVP_CIPH_ECB_MODE,\
326 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
327 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
332 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
335 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
336 block_size, key_len, iv_len, cbits, \
338 cleanup, set_asn1, get_asn1, ctrl) \
339 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
340 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
341 cbits, flags, init_key, cleanup, set_asn1, \
344 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
345 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
346 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
347 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
348 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
349 cipher##_init_key, NULL, NULL, NULL, NULL)
353 * Type needs to be a bit field Sub-type needs to be for variations on the
354 * method, as in, can it do arbitrary encryption....
359 CRYPTO_REF_COUNT references;
360 const EVP_PKEY_ASN1_METHOD *ameth;
364 # ifndef OPENSSL_NO_RSA
365 struct rsa_st *rsa; /* RSA */
367 # ifndef OPENSSL_NO_DSA
368 struct dsa_st *dsa; /* DSA */
370 # ifndef OPENSSL_NO_DH
371 struct dh_st *dh; /* DH */
373 # ifndef OPENSSL_NO_EC
374 struct ec_key_st *ec; /* ECC */
378 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
383 void openssl_add_all_ciphers_int(void);
384 void openssl_add_all_digests_int(void);
385 void evp_cleanup_int(void);