2 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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"
14 * Don't free up md_ctx->pctx in EVP_MD_CTX_reset, use the reserved flag
17 #define EVP_MD_CTX_FLAG_KEEP_PKEY_CTX 0x0400
19 struct evp_pkey_ctx_st {
20 /* Method associated with this operation */
21 const EVP_PKEY_METHOD *pmeth;
22 /* Engine that implements this method or NULL if builtin */
24 /* Key: may be NULL */
26 /* Peer key for key agreement, may be NULL */
28 /* Actual operation */
30 /* Algorithm specific data */
32 /* Application specific data */
35 EVP_PKEY_gen_cb *pkey_gencb;
36 /* implementation specific keygen data */
38 int keygen_info_count;
39 } /* EVP_PKEY_CTX */ ;
41 #define EVP_PKEY_FLAG_DYNAMIC 1
43 struct evp_pkey_method_st {
46 int (*init) (EVP_PKEY_CTX *ctx);
47 int (*copy) (EVP_PKEY_CTX *dst, const EVP_PKEY_CTX *src);
48 void (*cleanup) (EVP_PKEY_CTX *ctx);
49 int (*paramgen_init) (EVP_PKEY_CTX *ctx);
50 int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
51 int (*keygen_init) (EVP_PKEY_CTX *ctx);
52 int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
53 int (*sign_init) (EVP_PKEY_CTX *ctx);
54 int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
55 const unsigned char *tbs, size_t tbslen);
56 int (*verify_init) (EVP_PKEY_CTX *ctx);
57 int (*verify) (EVP_PKEY_CTX *ctx,
58 const unsigned char *sig, size_t siglen,
59 const unsigned char *tbs, size_t tbslen);
60 int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
61 int (*verify_recover) (EVP_PKEY_CTX *ctx,
62 unsigned char *rout, size_t *routlen,
63 const unsigned char *sig, size_t siglen);
64 int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
65 int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
67 int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
68 int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
70 int (*encrypt_init) (EVP_PKEY_CTX *ctx);
71 int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
72 const unsigned char *in, size_t inlen);
73 int (*decrypt_init) (EVP_PKEY_CTX *ctx);
74 int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
75 const unsigned char *in, size_t inlen);
76 int (*derive_init) (EVP_PKEY_CTX *ctx);
77 int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
78 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
79 int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
80 int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
81 const unsigned char *tbs, size_t tbslen);
82 int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
83 size_t siglen, const unsigned char *tbs,
85 int (*check) (EVP_PKEY *pkey);
86 int (*public_check) (EVP_PKEY *pkey);
87 int (*param_check) (EVP_PKEY *pkey);
89 int (*digest_custom) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
90 } /* EVP_PKEY_METHOD */ ;
92 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
94 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
96 extern const EVP_PKEY_METHOD cmac_pkey_meth;
97 extern const EVP_PKEY_METHOD dh_pkey_meth;
98 extern const EVP_PKEY_METHOD dhx_pkey_meth;
99 extern const EVP_PKEY_METHOD dsa_pkey_meth;
100 extern const EVP_PKEY_METHOD ec_pkey_meth;
101 extern const EVP_PKEY_METHOD sm2_pkey_meth;
102 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
103 extern const EVP_PKEY_METHOD ecx448_pkey_meth;
104 extern const EVP_PKEY_METHOD ed25519_pkey_meth;
105 extern const EVP_PKEY_METHOD ed448_pkey_meth;
106 extern const EVP_PKEY_METHOD hmac_pkey_meth;
107 extern const EVP_PKEY_METHOD rsa_pkey_meth;
108 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
109 extern const EVP_PKEY_METHOD scrypt_pkey_meth;
110 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
111 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
112 extern const EVP_PKEY_METHOD poly1305_pkey_meth;
113 extern const EVP_PKEY_METHOD siphash_pkey_meth;
115 /* struct evp_mac_impl_st is defined by the implementation */
116 typedef struct evp_mac_impl_st EVP_MAC_IMPL;
119 EVP_MAC_IMPL *(*new) (void);
120 int (*copy) (EVP_MAC_IMPL *macdst, EVP_MAC_IMPL *macsrc);
121 void (*free) (EVP_MAC_IMPL *macctx);
122 size_t (*size) (EVP_MAC_IMPL *macctx);
123 int (*init) (EVP_MAC_IMPL *macctx);
124 int (*update) (EVP_MAC_IMPL *macctx, const unsigned char *data,
126 int (*final) (EVP_MAC_IMPL *macctx, unsigned char *out);
127 int (*ctrl) (EVP_MAC_IMPL *macctx, int cmd, va_list args);
128 int (*ctrl_str) (EVP_MAC_IMPL *macctx, const char *type, const char *value);
131 extern const EVP_MAC blake2b_mac_meth;
132 extern const EVP_MAC blake2s_mac_meth;
133 extern const EVP_MAC cmac_meth;
134 extern const EVP_MAC gmac_meth;
135 extern const EVP_MAC hmac_meth;
136 extern const EVP_MAC kmac128_meth;
137 extern const EVP_MAC kmac256_meth;
138 extern const EVP_MAC siphash_meth;
139 extern const EVP_MAC poly1305_meth;
141 /* Internal keccak algorithms used for KMAC */
142 const EVP_MD *evp_keccak_kmac128(void);
143 const EVP_MD *evp_keccak_kmac256(void);
146 * This function is internal for now, but can be made external when needed.
147 * The documentation would read:
149 * EVP_add_mac() adds the MAC implementation C<mac> to the internal
152 int EVP_add_mac(const EVP_MAC *mac);
154 /* struct evp_kdf_impl_st is defined by the implementation */
155 typedef struct evp_kdf_impl_st EVP_KDF_IMPL;
158 EVP_KDF_IMPL *(*new) (void);
159 void (*free) (EVP_KDF_IMPL *impl);
160 void (*reset) (EVP_KDF_IMPL *impl);
161 int (*ctrl) (EVP_KDF_IMPL *impl, int cmd, va_list args);
162 int (*ctrl_str) (EVP_KDF_IMPL *impl, const char *type, const char *value);
163 size_t (*size) (EVP_KDF_IMPL *impl);
164 int (*derive) (EVP_KDF_IMPL *impl, unsigned char *key, size_t keylen);
167 extern const EVP_KDF_METHOD pbkdf2_kdf_meth;
168 extern const EVP_KDF_METHOD scrypt_kdf_meth;
169 extern const EVP_KDF_METHOD tls1_prf_kdf_meth;
170 extern const EVP_KDF_METHOD hkdf_kdf_meth;
171 extern const EVP_KDF_METHOD sshkdf_kdf_meth;
172 extern const EVP_KDF_METHOD ss_kdf_meth;
179 int (*init) (EVP_MD_CTX *ctx);
180 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
181 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
182 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
183 int (*cleanup) (EVP_MD_CTX *ctx);
185 int ctx_size; /* how big does the ctx->md_data need to be */
186 /* control function */
187 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
190 struct evp_cipher_st {
193 /* Default value for variable length ciphers */
199 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
200 const unsigned char *iv, int enc);
201 /* encrypt/decrypt data */
202 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
203 const unsigned char *in, size_t inl);
205 int (*cleanup) (EVP_CIPHER_CTX *);
206 /* how big ctx->cipher_data needs to be */
208 /* Populate a ASN1_TYPE with parameters */
209 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
210 /* Get parameters from a ASN1_TYPE */
211 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
212 /* Miscellaneous operations */
213 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
214 /* Application data */
218 /* Macros to code block cipher wrappers */
220 /* Wrapper functions for each cipher mode */
222 #define EVP_C_DATA(kstruct, ctx) \
223 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
225 #define BLOCK_CIPHER_ecb_loop() \
227 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
228 if (inl < bl) return 1;\
230 for (i=0; i <= inl; i+=bl)
232 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
233 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
235 BLOCK_CIPHER_ecb_loop() \
236 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
240 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
242 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
243 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
245 while(inl>=EVP_MAXCHUNK) {\
246 int num = EVP_CIPHER_CTX_num(ctx);\
247 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
248 EVP_CIPHER_CTX_set_num(ctx, num);\
254 int num = EVP_CIPHER_CTX_num(ctx);\
255 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
256 EVP_CIPHER_CTX_set_num(ctx, num);\
261 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
262 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
264 while(inl>=EVP_MAXCHUNK) \
266 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));\
272 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
276 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
277 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
279 size_t chunk = EVP_MAXCHUNK;\
280 if (cbits == 1) chunk >>= 3;\
281 if (inl < chunk) chunk = inl;\
282 while (inl && inl >= chunk)\
284 int num = EVP_CIPHER_CTX_num(ctx);\
285 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
287 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
288 ? chunk*8 : chunk), \
289 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
290 &num, EVP_CIPHER_CTX_encrypting(ctx));\
291 EVP_CIPHER_CTX_set_num(ctx, num);\
295 if (inl < chunk) chunk = inl;\
300 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
301 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
302 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
303 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
304 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
306 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
307 key_len, iv_len, flags, init_key, cleanup, \
308 set_asn1, get_asn1, ctrl) \
309 static const EVP_CIPHER cname##_##mode = { \
310 nid##_##nmode, block_size, key_len, iv_len, \
311 flags | EVP_CIPH_##MODE##_MODE, \
313 cname##_##mode##_cipher, \
320 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
322 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
323 iv_len, flags, init_key, cleanup, set_asn1, \
325 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
326 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
328 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
329 iv_len, cbits, flags, init_key, cleanup, \
330 set_asn1, get_asn1, ctrl) \
331 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
332 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
335 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
336 iv_len, cbits, flags, init_key, cleanup, \
337 set_asn1, get_asn1, ctrl) \
338 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
339 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
342 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
343 flags, init_key, cleanup, set_asn1, \
345 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
346 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
348 #define BLOCK_CIPHER_defs(cname, kstruct, \
349 nid, block_size, key_len, iv_len, cbits, flags, \
350 init_key, cleanup, set_asn1, get_asn1, ctrl) \
351 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
352 init_key, cleanup, set_asn1, get_asn1, ctrl) \
353 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
354 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
355 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
356 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
357 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
358 init_key, cleanup, set_asn1, get_asn1, ctrl)
361 #define BLOCK_CIPHER_defs(cname, kstruct, \
362 nid, block_size, key_len, iv_len, flags,\
363 init_key, cleanup, set_asn1, get_asn1, ctrl)\
364 static const EVP_CIPHER cname##_cbc = {\
365 nid##_cbc, block_size, key_len, iv_len, \
366 flags | EVP_CIPH_CBC_MODE,\
370 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
371 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
376 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
377 static const EVP_CIPHER cname##_cfb = {\
378 nid##_cfb64, 1, key_len, iv_len, \
379 flags | EVP_CIPH_CFB_MODE,\
383 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
384 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
389 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
390 static const EVP_CIPHER cname##_ofb = {\
391 nid##_ofb64, 1, key_len, iv_len, \
392 flags | EVP_CIPH_OFB_MODE,\
396 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
397 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
402 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
403 static const EVP_CIPHER cname##_ecb = {\
404 nid##_ecb, block_size, key_len, iv_len, \
405 flags | EVP_CIPH_ECB_MODE,\
409 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
410 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
415 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
418 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
419 block_size, key_len, iv_len, cbits, \
421 cleanup, set_asn1, get_asn1, ctrl) \
422 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
423 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
424 cbits, flags, init_key, cleanup, set_asn1, \
427 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
428 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
429 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
430 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
431 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
432 cipher##_init_key, NULL, NULL, NULL, NULL)
435 # ifndef OPENSSL_NO_EC
437 #define X25519_KEYLEN 32
438 #define X448_KEYLEN 56
439 #define ED448_KEYLEN 57
441 #define MAX_KEYLEN ED448_KEYLEN
444 unsigned char pubkey[MAX_KEYLEN];
445 unsigned char *privkey;
451 * Type needs to be a bit field Sub-type needs to be for variations on the
452 * method, as in, can it do arbitrary encryption....
457 CRYPTO_REF_COUNT references;
458 const EVP_PKEY_ASN1_METHOD *ameth;
460 ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
463 # ifndef OPENSSL_NO_RSA
464 struct rsa_st *rsa; /* RSA */
466 # ifndef OPENSSL_NO_DSA
467 struct dsa_st *dsa; /* DSA */
469 # ifndef OPENSSL_NO_DH
470 struct dh_st *dh; /* DH */
472 # ifndef OPENSSL_NO_EC
473 struct ec_key_st *ec; /* ECC */
474 ECX_KEY *ecx; /* X25519, X448, Ed25519, Ed448 */
478 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
483 void openssl_add_all_ciphers_int(void);
484 void openssl_add_all_digests_int(void);
485 void openssl_add_all_macs_int(void);
486 void evp_cleanup_int(void);
487 void evp_app_cleanup_int(void);
489 /* Pulling defines out of C source files */
491 #define EVP_RC4_KEY_SIZE 16
492 #ifndef TLS1_1_VERSION
493 # define TLS1_1_VERSION 0x0302
496 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
498 /* EVP_ENCODE_CTX flags */
499 /* Don't generate new lines when encoding */
500 #define EVP_ENCODE_CTX_NO_NEWLINES 1
501 /* Use the SRP base64 alphabet instead of the standard one */
502 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2