2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 struct evp_pkey_ctx_st {
60 /* Method associated with this operation */
61 const EVP_PKEY_METHOD *pmeth;
62 /* Engine that implements this method or NULL if builtin */
64 /* Key: may be NULL */
66 /* Peer key for key agreement, may be NULL */
68 /* Actual operation */
70 /* Algorithm specific data */
72 /* Application specific data */
75 EVP_PKEY_gen_cb *pkey_gencb;
76 /* implementation specific keygen data */
78 int keygen_info_count;
79 } /* EVP_PKEY_CTX */ ;
81 #define EVP_PKEY_FLAG_DYNAMIC 1
83 struct evp_pkey_method_st {
86 int (*init) (EVP_PKEY_CTX *ctx);
87 int (*copy) (EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src);
88 void (*cleanup) (EVP_PKEY_CTX *ctx);
89 int (*paramgen_init) (EVP_PKEY_CTX *ctx);
90 int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
91 int (*keygen_init) (EVP_PKEY_CTX *ctx);
92 int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
93 int (*sign_init) (EVP_PKEY_CTX *ctx);
94 int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
95 const unsigned char *tbs, size_t tbslen);
96 int (*verify_init) (EVP_PKEY_CTX *ctx);
97 int (*verify) (EVP_PKEY_CTX *ctx,
98 const unsigned char *sig, size_t siglen,
99 const unsigned char *tbs, size_t tbslen);
100 int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
101 int (*verify_recover) (EVP_PKEY_CTX *ctx,
102 unsigned char *rout, size_t *routlen,
103 const unsigned char *sig, size_t siglen);
104 int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
105 int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
107 int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
108 int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
110 int (*encrypt_init) (EVP_PKEY_CTX *ctx);
111 int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
112 const unsigned char *in, size_t inlen);
113 int (*decrypt_init) (EVP_PKEY_CTX *ctx);
114 int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
115 const unsigned char *in, size_t inlen);
116 int (*derive_init) (EVP_PKEY_CTX *ctx);
117 int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
118 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
119 int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
120 } /* EVP_PKEY_METHOD */ ;
122 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
124 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
126 extern const EVP_PKEY_METHOD cmac_pkey_meth;
127 extern const EVP_PKEY_METHOD dh_pkey_meth;
128 extern const EVP_PKEY_METHOD dhx_pkey_meth;
129 extern const EVP_PKEY_METHOD dsa_pkey_meth;
130 extern const EVP_PKEY_METHOD ec_pkey_meth;
131 extern const EVP_PKEY_METHOD hmac_pkey_meth;
132 extern const EVP_PKEY_METHOD rsa_pkey_meth;
133 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
134 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
141 int (*init) (EVP_MD_CTX *ctx);
142 int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
143 int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
144 int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
145 int (*cleanup) (EVP_MD_CTX *ctx);
147 int ctx_size; /* how big does the ctx->md_data need to be */
148 /* control function */
149 int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
152 struct evp_cipher_st {
155 /* Default value for variable length ciphers */
161 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
162 const unsigned char *iv, int enc);
163 /* encrypt/decrypt data */
164 int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
165 const unsigned char *in, size_t inl);
167 int (*cleanup) (EVP_CIPHER_CTX *);
168 /* how big ctx->cipher_data needs to be */
170 /* Populate a ASN1_TYPE with parameters */
171 int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
172 /* Get parameters from a ASN1_TYPE */
173 int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
174 /* Miscellaneous operations */
175 int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
176 /* Application data */
180 /* Macros to code block cipher wrappers */
182 /* Wrapper functions for each cipher mode */
184 #define EVP_C_DATA(kstruct, ctx) \
185 ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
187 #define BLOCK_CIPHER_ecb_loop() \
189 bl = EVP_CIPHER_CTX_cipher(ctx)->block_size; \
190 if(inl < bl) return 1;\
192 for(i=0; i <= inl; i+=bl)
194 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
195 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
197 BLOCK_CIPHER_ecb_loop() \
198 cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
202 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
204 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
205 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
207 while(inl>=EVP_MAXCHUNK) {\
208 int num = EVP_CIPHER_CTX_num(ctx);\
209 cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
210 EVP_CIPHER_CTX_set_num(ctx, num);\
216 int num = EVP_CIPHER_CTX_num(ctx);\
217 cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
218 EVP_CIPHER_CTX_set_num(ctx, num);\
223 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
224 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
226 while(inl>=EVP_MAXCHUNK) \
228 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));\
234 cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
238 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
239 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
241 size_t chunk=EVP_MAXCHUNK;\
242 if (cbits==1) chunk>>=3;\
243 if (inl<chunk) chunk=inl;\
244 while(inl && inl>=chunk)\
246 int num = EVP_CIPHER_CTX_num(ctx);\
247 cprefix##_cfb##cbits##_encrypt(in, out, (long)((cbits==1) && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) ?inl*8:inl), &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num, EVP_CIPHER_CTX_encrypting(ctx)); \
248 EVP_CIPHER_CTX_set_num(ctx, num);\
252 if(inl<chunk) chunk=inl;\
257 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
258 BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
259 BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
260 BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
261 BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
263 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
264 key_len, iv_len, flags, init_key, cleanup, \
265 set_asn1, get_asn1, ctrl) \
266 static const EVP_CIPHER cname##_##mode = { \
267 nid##_##nmode, block_size, key_len, iv_len, \
268 flags | EVP_CIPH_##MODE##_MODE, \
270 cname##_##mode##_cipher, \
277 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
279 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
280 iv_len, flags, init_key, cleanup, set_asn1, \
282 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
283 iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
285 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
286 iv_len, cbits, flags, init_key, cleanup, \
287 set_asn1, get_asn1, ctrl) \
288 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
289 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
292 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
293 iv_len, cbits, flags, init_key, cleanup, \
294 set_asn1, get_asn1, ctrl) \
295 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
296 key_len, iv_len, flags, init_key, cleanup, set_asn1, \
299 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
300 flags, init_key, cleanup, set_asn1, \
302 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
303 0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
305 #define BLOCK_CIPHER_defs(cname, kstruct, \
306 nid, block_size, key_len, iv_len, cbits, flags, \
307 init_key, cleanup, set_asn1, get_asn1, ctrl) \
308 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
309 init_key, cleanup, set_asn1, get_asn1, ctrl) \
310 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
311 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
312 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
313 flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
314 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
315 init_key, cleanup, set_asn1, get_asn1, ctrl)
318 #define BLOCK_CIPHER_defs(cname, kstruct, \
319 nid, block_size, key_len, iv_len, flags,\
320 init_key, cleanup, set_asn1, get_asn1, ctrl)\
321 static const EVP_CIPHER cname##_cbc = {\
322 nid##_cbc, block_size, key_len, iv_len, \
323 flags | EVP_CIPH_CBC_MODE,\
327 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
328 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
333 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
334 static const EVP_CIPHER cname##_cfb = {\
335 nid##_cfb64, 1, key_len, iv_len, \
336 flags | EVP_CIPH_CFB_MODE,\
340 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
341 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
346 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
347 static const EVP_CIPHER cname##_ofb = {\
348 nid##_ofb64, 1, key_len, iv_len, \
349 flags | EVP_CIPH_OFB_MODE,\
353 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
354 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
359 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
360 static const EVP_CIPHER cname##_ecb = {\
361 nid##_ecb, block_size, key_len, iv_len, \
362 flags | EVP_CIPH_ECB_MODE,\
366 sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
367 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
372 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
375 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
376 block_size, key_len, iv_len, cbits, \
378 cleanup, set_asn1, get_asn1, ctrl) \
379 BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
380 BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
381 cbits, flags, init_key, cleanup, set_asn1, \
384 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
385 BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
386 BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
387 NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
388 (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
389 cipher##_init_key, NULL, NULL, NULL, NULL)
393 * Type needs to be a bit field Sub-type needs to be for variations on the
394 * method, as in, can it do arbitrary encryption....
400 const EVP_PKEY_ASN1_METHOD *ameth;
404 # ifndef OPENSSL_NO_RSA
405 struct rsa_st *rsa; /* RSA */
407 # ifndef OPENSSL_NO_DSA
408 struct dsa_st *dsa; /* DSA */
410 # ifndef OPENSSL_NO_DH
411 struct dh_st *dh; /* DH */
413 # ifndef OPENSSL_NO_EC
414 struct ec_key_st *ec; /* ECC */
418 STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
422 void openssl_add_all_ciphers_internal(void);
423 void openssl_add_all_digests_internal(void);