2 * Copyright 2015-2018 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 <openssl/evp.h>
11 #include "internal/refcount.h"
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 */
18 /* Key: may be NULL */
20 /* Peer key for key agreement, may be NULL */
22 /* Actual operation */
24 /* Algorithm specific data */
26 /* Application specific data */
29 EVP_PKEY_gen_cb *pkey_gencb;
30 /* implementation specific keygen data */
32 int keygen_info_count;
33 } /* EVP_PKEY_CTX */ ;
35 #define EVP_PKEY_FLAG_DYNAMIC 1
37 struct evp_pkey_method_st {
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,
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,
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,
79 int (*check) (EVP_PKEY *pkey);
80 int (*public_check) (EVP_PKEY *pkey);
81 int (*param_check) (EVP_PKEY *pkey);
83 int (*digest_custom) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
84 } /* EVP_PKEY_METHOD */ ;
86 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
88 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
90 extern const EVP_PKEY_METHOD cmac_pkey_meth;
91 extern const EVP_PKEY_METHOD dh_pkey_meth;
92 extern const EVP_PKEY_METHOD dhx_pkey_meth;
93 extern const EVP_PKEY_METHOD dsa_pkey_meth;
94 extern const EVP_PKEY_METHOD ec_pkey_meth;
95 extern const EVP_PKEY_METHOD sm2_pkey_meth;
96 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
97 extern const EVP_PKEY_METHOD ecx448_pkey_meth;
98 extern const EVP_PKEY_METHOD ed25519_pkey_meth;
99 extern const EVP_PKEY_METHOD ed448_pkey_meth;
100 extern const EVP_PKEY_METHOD hmac_pkey_meth;
101 extern const EVP_PKEY_METHOD rsa_pkey_meth;
102 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
103 extern const EVP_PKEY_METHOD scrypt_pkey_meth;
104 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
105 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
106 extern const EVP_PKEY_METHOD poly1305_pkey_meth;
107 extern const EVP_PKEY_METHOD siphash_pkey_meth;
114 int (*init) (EVP_MD_CTX *ctx);
115 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
116 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
117 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
118 int (*cleanup) (EVP_MD_CTX *ctx);
120 int ctx_size; /* how big does the ctx->md_data need to be */
121 /* control function */
122 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
125 struct evp_cipher_st {
128 /* Default value for variable length ciphers */
134 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
135 const unsigned char *iv, int enc);
136 /* encrypt/decrypt data */
137 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
138 const unsigned char *in, size_t inl);
140 int (*cleanup) (EVP_CIPHER_CTX *);
141 /* how big ctx->cipher_data needs to be */
143 /* Populate a ASN1_TYPE with parameters */
144 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
145 /* Get parameters from a ASN1_TYPE */
146 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
147 /* Miscellaneous operations */
148 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
149 /* Application data */
153 /* Macros to code block cipher wrappers */
155 /* Wrapper functions for each cipher mode */
157 #define EVP_C_DATA(kstruct, ctx) \
158 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
160 #define BLOCK_CIPHER_ecb_loop() \
162 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
163 if (inl < bl) return 1;\
165 for (i=0; i <= inl; i+=bl)
167 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
168 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
170 BLOCK_CIPHER_ecb_loop() \
171 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
175 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
177 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
178 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
180 while(inl>=EVP_MAXCHUNK) {\
181 int num = EVP_CIPHER_CTX_num(ctx);\
182 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
183 EVP_CIPHER_CTX_set_num(ctx, num);\
189 int num = EVP_CIPHER_CTX_num(ctx);\
190 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
191 EVP_CIPHER_CTX_set_num(ctx, num);\
196 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
197 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
199 while(inl>=EVP_MAXCHUNK) \
201 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));\
207 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
211 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
212 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
214 size_t chunk = EVP_MAXCHUNK;\
215 if (cbits == 1) chunk >>= 3;\
216 if (inl < chunk) chunk = inl;\
217 while (inl && inl >= chunk)\
219 int num = EVP_CIPHER_CTX_num(ctx);\
220 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
222 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
223 ? chunk*8 : chunk), \
224 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
225 &num, EVP_CIPHER_CTX_encrypting(ctx));\
226 EVP_CIPHER_CTX_set_num(ctx, num);\
230 if (inl < chunk) chunk = inl;\
235 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
236 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
237 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
238 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
239 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
241 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
242 key_len, iv_len, flags, init_key, cleanup, \
243 set_asn1, get_asn1, ctrl) \
244 static const EVP_CIPHER cname##_##mode = { \
245 nid##_##nmode, block_size, key_len, iv_len, \
246 flags | EVP_CIPH_##MODE##_MODE, \
248 cname##_##mode##_cipher, \
255 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
257 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
258 iv_len, flags, init_key, cleanup, set_asn1, \
260 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
261 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
263 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
264 iv_len, cbits, flags, init_key, cleanup, \
265 set_asn1, get_asn1, ctrl) \
266 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
267 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
270 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
271 iv_len, cbits, flags, init_key, cleanup, \
272 set_asn1, get_asn1, ctrl) \
273 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
274 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
277 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
278 flags, init_key, cleanup, set_asn1, \
280 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
281 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
283 #define BLOCK_CIPHER_defs(cname, kstruct, \
284 nid, block_size, key_len, iv_len, cbits, flags, \
285 init_key, cleanup, set_asn1, get_asn1, ctrl) \
286 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
287 init_key, cleanup, set_asn1, get_asn1, ctrl) \
288 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
289 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
290 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
291 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
292 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
293 init_key, cleanup, set_asn1, get_asn1, ctrl)
296 #define BLOCK_CIPHER_defs(cname, kstruct, \
297 nid, block_size, key_len, iv_len, flags,\
298 init_key, cleanup, set_asn1, get_asn1, ctrl)\
299 static const EVP_CIPHER cname##_cbc = {\
300 nid##_cbc, block_size, key_len, iv_len, \
301 flags | EVP_CIPH_CBC_MODE,\
305 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
306 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
311 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
312 static const EVP_CIPHER cname##_cfb = {\
313 nid##_cfb64, 1, key_len, iv_len, \
314 flags | EVP_CIPH_CFB_MODE,\
318 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
319 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
324 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
325 static const EVP_CIPHER cname##_ofb = {\
326 nid##_ofb64, 1, key_len, iv_len, \
327 flags | EVP_CIPH_OFB_MODE,\
331 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
332 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
337 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
338 static const EVP_CIPHER cname##_ecb = {\
339 nid##_ecb, block_size, key_len, iv_len, \
340 flags | EVP_CIPH_ECB_MODE,\
344 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
345 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
350 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
353 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
354 block_size, key_len, iv_len, cbits, \
356 cleanup, set_asn1, get_asn1, ctrl) \
357 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
358 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
359 cbits, flags, init_key, cleanup, set_asn1, \
362 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
363 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
364 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
365 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
366 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
367 cipher##_init_key, NULL, NULL, NULL, NULL)
370 # ifndef OPENSSL_NO_EC
372 #define X25519_KEYLEN 32
373 #define X448_KEYLEN 56
374 #define ED448_KEYLEN 57
376 #define MAX_KEYLEN ED448_KEYLEN
379 unsigned char pubkey[MAX_KEYLEN];
380 unsigned char *privkey;
386 * Type needs to be a bit field Sub-type needs to be for variations on the
387 * method, as in, can it do arbitrary encryption....
392 CRYPTO_REF_COUNT references;
393 const EVP_PKEY_ASN1_METHOD *ameth;
395 ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
398 # ifndef OPENSSL_NO_RSA
399 struct rsa_st *rsa; /* RSA */
401 # ifndef OPENSSL_NO_DSA
402 struct dsa_st *dsa; /* DSA */
404 # ifndef OPENSSL_NO_DH
405 struct dh_st *dh; /* DH */
407 # ifndef OPENSSL_NO_EC
408 struct ec_key_st *ec; /* ECC */
409 ECX_KEY *ecx; /* X25519, X448, Ed25519, Ed448 */
413 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
418 void openssl_add_all_ciphers_int(void);
419 void openssl_add_all_digests_int(void);
420 void evp_cleanup_int(void);
421 void evp_app_cleanup_int(void);
423 /* Pulling defines out of C source files */
425 #define EVP_RC4_KEY_SIZE 16
426 #ifndef TLS1_1_VERSION
427 # define TLS1_1_VERSION 0x0302
430 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
432 /* EVP_ENCODE_CTX flags */
433 /* Don't generate new lines when encoding */
434 #define EVP_ENCODE_CTX_NO_NEWLINES 1
435 /* Use the SRP base64 alphabet instead of the standard one */
436 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2