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
, 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
;
177 int (*init
) (EVP_MD_CTX
*ctx
);
178 int (*update
) (EVP_MD_CTX
*ctx
, const void *data
, size_t count
);
179 int (*final
) (EVP_MD_CTX
*ctx
, unsigned char *md
);
180 int (*copy
) (EVP_MD_CTX
*to
, const EVP_MD_CTX
*from
);
181 int (*cleanup
) (EVP_MD_CTX
*ctx
);
183 int ctx_size
; /* how big does the ctx->md_data need to be */
184 /* control function */
185 int (*md_ctrl
) (EVP_MD_CTX
*ctx
, int cmd
, int p1
, void *p2
);
188 struct evp_cipher_st
{
191 /* Default value for variable length ciphers */
197 int (*init
) (EVP_CIPHER_CTX
*ctx
, const unsigned char *key
,
198 const unsigned char *iv
, int enc
);
199 /* encrypt/decrypt data */
200 int (*do_cipher
) (EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
201 const unsigned char *in
, size_t inl
);
203 int (*cleanup
) (EVP_CIPHER_CTX
*);
204 /* how big ctx->cipher_data needs to be */
206 /* Populate a ASN1_TYPE with parameters */
207 int (*set_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
208 /* Get parameters from a ASN1_TYPE */
209 int (*get_asn1_parameters
) (EVP_CIPHER_CTX
*, ASN1_TYPE
*);
210 /* Miscellaneous operations */
211 int (*ctrl
) (EVP_CIPHER_CTX
*, int type
, int arg
, void *ptr
);
212 /* Application data */
216 /* Macros to code block cipher wrappers */
218 /* Wrapper functions for each cipher mode */
220 #define EVP_C_DATA(kstruct, ctx) \
221 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
223 #define BLOCK_CIPHER_ecb_loop() \
225 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
226 if (inl < bl) return 1;\
228 for (i=0; i <= inl; i+=bl)
230 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
231 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
233 BLOCK_CIPHER_ecb_loop() \
234 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
238 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
240 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
241 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
243 while(inl>=EVP_MAXCHUNK) {\
244 int num = EVP_CIPHER_CTX_num(ctx);\
245 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
246 EVP_CIPHER_CTX_set_num(ctx, num);\
252 int num = EVP_CIPHER_CTX_num(ctx);\
253 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
254 EVP_CIPHER_CTX_set_num(ctx, num);\
259 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
260 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
262 while(inl>=EVP_MAXCHUNK) \
264 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));\
270 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
274 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
275 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
277 size_t chunk = EVP_MAXCHUNK;\
278 if (cbits == 1) chunk >>= 3;\
279 if (inl < chunk) chunk = inl;\
280 while (inl && inl >= chunk)\
282 int num = EVP_CIPHER_CTX_num(ctx);\
283 cprefix##_cfb##cbits##_encrypt(in, out, (long) \
285 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
286 ? chunk*8 : chunk), \
287 &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
288 &num, EVP_CIPHER_CTX_encrypting(ctx));\
289 EVP_CIPHER_CTX_set_num(ctx, num);\
293 if (inl < chunk) chunk = inl;\
298 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
299 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
300 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
301 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
302 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
304 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
305 key_len, iv_len, flags, init_key, cleanup, \
306 set_asn1, get_asn1, ctrl) \
307 static const EVP_CIPHER cname##_##mode = { \
308 nid##_##nmode, block_size, key_len, iv_len, \
309 flags | EVP_CIPH_##MODE##_MODE, \
311 cname##_##mode##_cipher, \
318 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
320 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
321 iv_len, flags, init_key, cleanup, set_asn1, \
323 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
324 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
326 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
327 iv_len, cbits, flags, init_key, cleanup, \
328 set_asn1, get_asn1, ctrl) \
329 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
330 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
333 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
334 iv_len, cbits, flags, init_key, cleanup, \
335 set_asn1, get_asn1, ctrl) \
336 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
337 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
340 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
341 flags, init_key, cleanup, set_asn1, \
343 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
344 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
346 #define BLOCK_CIPHER_defs(cname, kstruct, \
347 nid, block_size, key_len, iv_len, cbits, flags, \
348 init_key, cleanup, set_asn1, get_asn1, ctrl) \
349 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
350 init_key, cleanup, set_asn1, get_asn1, ctrl) \
351 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
352 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
353 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
354 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
355 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
356 init_key, cleanup, set_asn1, get_asn1, ctrl)
359 #define BLOCK_CIPHER_defs(cname, kstruct, \
360 nid, block_size, key_len, iv_len, flags,\
361 init_key, cleanup, set_asn1, get_asn1, ctrl)\
362 static const EVP_CIPHER cname##_cbc = {\
363 nid##_cbc, block_size, key_len, iv_len, \
364 flags | EVP_CIPH_CBC_MODE,\
368 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
369 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
374 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
375 static const EVP_CIPHER cname##_cfb = {\
376 nid##_cfb64, 1, key_len, iv_len, \
377 flags | EVP_CIPH_CFB_MODE,\
381 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
382 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
387 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
388 static const EVP_CIPHER cname##_ofb = {\
389 nid##_ofb64, 1, key_len, iv_len, \
390 flags | EVP_CIPH_OFB_MODE,\
394 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
395 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
400 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
401 static const EVP_CIPHER cname##_ecb = {\
402 nid##_ecb, block_size, key_len, iv_len, \
403 flags | EVP_CIPH_ECB_MODE,\
407 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
408 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
413 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
416 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
417 block_size, key_len, iv_len, cbits, \
419 cleanup, set_asn1, get_asn1, ctrl) \
420 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
421 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
422 cbits, flags, init_key, cleanup, set_asn1, \
425 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
426 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
427 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
428 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
429 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
430 cipher##_init_key, NULL, NULL, NULL, NULL)
433 # ifndef OPENSSL_NO_EC
435 #define X25519_KEYLEN 32
436 #define X448_KEYLEN 56
437 #define ED448_KEYLEN 57
439 #define MAX_KEYLEN ED448_KEYLEN
442 unsigned char pubkey
[MAX_KEYLEN
];
443 unsigned char *privkey
;
449 * Type needs to be a bit field Sub-type needs to be for variations on the
450 * method, as in, can it do arbitrary encryption....
455 CRYPTO_REF_COUNT references
;
456 const EVP_PKEY_ASN1_METHOD
*ameth
;
458 ENGINE
*pmeth_engine
; /* If not NULL public key ENGINE to use */
461 # ifndef OPENSSL_NO_RSA
462 struct rsa_st
*rsa
; /* RSA */
464 # ifndef OPENSSL_NO_DSA
465 struct dsa_st
*dsa
; /* DSA */
467 # ifndef OPENSSL_NO_DH
468 struct dh_st
*dh
; /* DH */
470 # ifndef OPENSSL_NO_EC
471 struct ec_key_st
*ec
; /* ECC */
472 ECX_KEY
*ecx
; /* X25519, X448, Ed25519, Ed448 */
476 STACK_OF(X509_ATTRIBUTE
) *attributes
; /* [ 0 ] */
481 void openssl_add_all_ciphers_int(void);
482 void openssl_add_all_digests_int(void);
483 void openssl_add_all_macs_int(void);
484 void evp_cleanup_int(void);
485 void evp_app_cleanup_int(void);
487 /* Pulling defines out of C source files */
489 #define EVP_RC4_KEY_SIZE 16
490 #ifndef TLS1_1_VERSION
491 # define TLS1_1_VERSION 0x0302
494 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX
*ctx
, unsigned int flags
);
496 /* EVP_ENCODE_CTX flags */
497 /* Don't generate new lines when encoding */
498 #define EVP_ENCODE_CTX_NO_NEWLINES 1
499 /* Use the SRP base64 alphabet instead of the standard one */
500 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET 2