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);
82 } /* EVP_PKEY_METHOD */ ;
84 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
86 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
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 sm2_pkey_meth;
94 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
95 extern const EVP_PKEY_METHOD ecx448_pkey_meth;
96 extern const EVP_PKEY_METHOD ed25519_pkey_meth;
97 extern const EVP_PKEY_METHOD ed448_pkey_meth;
98 extern const EVP_PKEY_METHOD hmac_pkey_meth;
99 extern const EVP_PKEY_METHOD rsa_pkey_meth;
100 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
101 extern const EVP_PKEY_METHOD scrypt_pkey_meth;
102 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
103 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
104 extern const EVP_PKEY_METHOD poly1305_pkey_meth;
105 extern const EVP_PKEY_METHOD siphash_pkey_meth;
112 int (*init) (EVP_MD_CTX *ctx);
113 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
114 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
115 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
116 int (*cleanup) (EVP_MD_CTX *ctx);
118 int ctx_size; /* how big does the ctx->md_data need to be */
119 /* control function */
120 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
123 struct evp_cipher_st {
126 /* Default value for variable length ciphers */
132 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
133 const unsigned char *iv, int enc);
134 /* encrypt/decrypt data */
135 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
136 const unsigned char *in, size_t inl);
138 int (*cleanup) (EVP_CIPHER_CTX *);
139 /* how big ctx->cipher_data needs to be */
141 /* Populate a ASN1_TYPE with parameters */
142 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
143 /* Get parameters from a ASN1_TYPE */
144 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
145 /* Miscellaneous operations */
146 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
147 /* Application data */
151 /* Macros to code block cipher wrappers */
153 /* Wrapper functions for each cipher mode */
155 #define EVP_C_DATA(kstruct, ctx) \
156 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
158 #define BLOCK_CIPHER_ecb_loop() \
160 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
161 if (inl < bl) return 1;\
163 for (i=0; i <= inl; i+=bl)
165 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
166 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
168 BLOCK_CIPHER_ecb_loop() \
169 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
173 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
175 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
176 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
178 while(inl>=EVP_MAXCHUNK) {\
179 int num = EVP_CIPHER_CTX_num(ctx);\
180 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
181 EVP_CIPHER_CTX_set_num(ctx, num);\
187 int num = EVP_CIPHER_CTX_num(ctx);\
188 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
189 EVP_CIPHER_CTX_set_num(ctx, num);\
194 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
195 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
197 while(inl>=EVP_MAXCHUNK) \
199 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));\
205 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
209 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
210 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
212 size_t chunk = EVP_MAXCHUNK;\
213 if (cbits == 1) chunk >>= 3;\
214 if (inl < chunk) chunk = inl;\
215 while (inl && inl >= chunk)\
217 int num = EVP_CIPHER_CTX_num(ctx);\
218 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
220 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
221 ? chunk*8 : chunk), \
222 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
223 &num, EVP_CIPHER_CTX_encrypting(ctx));\
224 EVP_CIPHER_CTX_set_num(ctx, num);\
228 if (inl < chunk) chunk = inl;\
233 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
234 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
235 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
236 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
237 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
239 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
240 key_len, iv_len, flags, init_key, cleanup, \
241 set_asn1, get_asn1, ctrl) \
242 static const EVP_CIPHER cname##_##mode = { \
243 nid##_##nmode, block_size, key_len, iv_len, \
244 flags | EVP_CIPH_##MODE##_MODE, \
246 cname##_##mode##_cipher, \
253 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
255 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
256 iv_len, flags, init_key, cleanup, set_asn1, \
258 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
259 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
261 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
262 iv_len, cbits, flags, init_key, cleanup, \
263 set_asn1, get_asn1, ctrl) \
264 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
265 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
268 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
269 iv_len, cbits, flags, init_key, cleanup, \
270 set_asn1, get_asn1, ctrl) \
271 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
272 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
275 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
276 flags, init_key, cleanup, set_asn1, \
278 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
279 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
281 #define BLOCK_CIPHER_defs(cname, kstruct, \
282 nid, block_size, key_len, iv_len, cbits, flags, \
283 init_key, cleanup, set_asn1, get_asn1, ctrl) \
284 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
285 init_key, cleanup, set_asn1, get_asn1, ctrl) \
286 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
287 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
288 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
289 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
290 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
291 init_key, cleanup, set_asn1, get_asn1, ctrl)
294 #define BLOCK_CIPHER_defs(cname, kstruct, \
295 nid, block_size, key_len, iv_len, flags,\
296 init_key, cleanup, set_asn1, get_asn1, ctrl)\
297 static const EVP_CIPHER cname##_cbc = {\
298 nid##_cbc, block_size, key_len, iv_len, \
299 flags | EVP_CIPH_CBC_MODE,\
303 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
304 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
309 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
310 static const EVP_CIPHER cname##_cfb = {\
311 nid##_cfb64, 1, key_len, iv_len, \
312 flags | EVP_CIPH_CFB_MODE,\
316 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
317 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
322 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
323 static const EVP_CIPHER cname##_ofb = {\
324 nid##_ofb64, 1, key_len, iv_len, \
325 flags | EVP_CIPH_OFB_MODE,\
329 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
330 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
335 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
336 static const EVP_CIPHER cname##_ecb = {\
337 nid##_ecb, block_size, key_len, iv_len, \
338 flags | EVP_CIPH_ECB_MODE,\
342 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
343 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
348 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
351 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
352 block_size, key_len, iv_len, cbits, \
354 cleanup, set_asn1, get_asn1, ctrl) \
355 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
356 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
357 cbits, flags, init_key, cleanup, set_asn1, \
360 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
361 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
362 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
363 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
364 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
365 cipher##_init_key, NULL, NULL, NULL, NULL)
368 # ifndef OPENSSL_NO_EC
370 #define X25519_KEYLEN 32
371 #define X448_KEYLEN 56
372 #define ED448_KEYLEN 57
374 #define MAX_KEYLEN ED448_KEYLEN
377 unsigned char pubkey[MAX_KEYLEN];
378 unsigned char *privkey;
384 * Type needs to be a bit field Sub-type needs to be for variations on the
385 * method, as in, can it do arbitrary encryption....
390 CRYPTO_REF_COUNT references;
391 const EVP_PKEY_ASN1_METHOD *ameth;
393 ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
396 # ifndef OPENSSL_NO_RSA
397 struct rsa_st *rsa; /* RSA */
399 # ifndef OPENSSL_NO_DSA
400 struct dsa_st *dsa; /* DSA */
402 # ifndef OPENSSL_NO_DH
403 struct dh_st *dh; /* DH */
405 # ifndef OPENSSL_NO_EC
406 struct ec_key_st *ec; /* ECC */
407 ECX_KEY *ecx; /* X25519, X448, Ed25519, Ed448 */
411 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
416 void openssl_add_all_ciphers_int(void);
417 void openssl_add_all_digests_int(void);
418 void evp_cleanup_int(void);
419 void evp_app_cleanup_int(void);
421 /* Pulling defines out of C source files */
423 #define EVP_RC4_KEY_SIZE 16
424 #ifndef TLS1_1_VERSION
425 # define TLS1_1_VERSION 0x0302
428 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
430 /* EVP_ENCODE_CTX flags */
431 /* Don't generate new lines when encoding */
432 #define EVP_ENCODE_CTX_NO_NEWLINES 1
433 /* Use the SRP base64 alphabet instead of the standard one */
434 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2