1 /* crypto/engine/eng_openssl.c */
3 * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
59 /* ====================================================================
60 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
61 * ECDH support in OpenSSL originally developed by
62 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
66 #include <openssl/crypto.h>
68 #include <openssl/engine.h>
69 #include <openssl/dso.h>
70 #include <openssl/pem.h>
71 #include <openssl/evp.h>
72 #include <openssl/rand.h>
73 #ifndef OPENSSL_NO_RSA
74 # include <openssl/rsa.h>
76 #ifndef OPENSSL_NO_DSA
77 # include <openssl/dsa.h>
80 # include <openssl/dh.h>
83 #include <openssl/hmac.h>
84 #include <openssl/x509v3.h>
87 * This testing gunk is implemented (and explained) lower down. It also
88 * assumes the application explicitly calls "ENGINE_load_openssl()" because
89 * this is no longer automatic in ENGINE_load_builtin_engines().
91 #define TEST_ENG_OPENSSL_RC4
92 #define TEST_ENG_OPENSSL_PKEY
93 /* #define TEST_ENG_OPENSSL_HMAC */
94 /* #define TEST_ENG_OPENSSL_HMAC_INIT */
95 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
96 #define TEST_ENG_OPENSSL_RC4_P_INIT
97 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
98 #define TEST_ENG_OPENSSL_SHA
99 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
100 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
101 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
102 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
104 /* Now check what of those algorithms are actually enabled */
105 #ifdef OPENSSL_NO_RC4
106 # undef TEST_ENG_OPENSSL_RC4
107 # undef TEST_ENG_OPENSSL_RC4_OTHERS
108 # undef TEST_ENG_OPENSSL_RC4_P_INIT
109 # undef TEST_ENG_OPENSSL_RC4_P_CIPHER
111 #if defined(OPENSSL_NO_SHA) || defined(OPENSSL_NO_SHA0) || defined(OPENSSL_NO_SHA1)
112 # undef TEST_ENG_OPENSSL_SHA
113 # undef TEST_ENG_OPENSSL_SHA_OTHERS
114 # undef TEST_ENG_OPENSSL_SHA_P_INIT
115 # undef TEST_ENG_OPENSSL_SHA_P_UPDATE
116 # undef TEST_ENG_OPENSSL_SHA_P_FINAL
119 #ifdef TEST_ENG_OPENSSL_RC4
120 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
121 const int **nids, int nid);
123 #ifdef TEST_ENG_OPENSSL_SHA
124 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
125 const int **nids, int nid);
128 #ifdef TEST_ENG_OPENSSL_PKEY
129 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
130 UI_METHOD *ui_method,
131 void *callback_data);
134 #ifdef TEST_ENG_OPENSSL_HMAC
135 static int ossl_register_hmac_meth(void);
136 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
137 const int **nids, int nid);
140 /* The constants used when creating the ENGINE */
141 static const char *engine_openssl_id = "openssl";
142 static const char *engine_openssl_name = "Software engine support";
145 * This internal function is used by ENGINE_openssl() and possibly by the
146 * "dynamic" ENGINE support too
148 static int bind_helper(ENGINE *e)
150 if (!ENGINE_set_id(e, engine_openssl_id)
151 || !ENGINE_set_name(e, engine_openssl_name)
152 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
153 # ifndef OPENSSL_NO_RSA
154 || !ENGINE_set_RSA(e, RSA_get_default_method())
156 # ifndef OPENSSL_NO_DSA
157 || !ENGINE_set_DSA(e, DSA_get_default_method())
159 # ifndef OPENSSL_NO_ECDH
160 || !ENGINE_set_ECDH(e, ECDH_OpenSSL())
162 # ifndef OPENSSL_NO_ECDSA
163 || !ENGINE_set_ECDSA(e, ECDSA_OpenSSL())
165 # ifndef OPENSSL_NO_DH
166 || !ENGINE_set_DH(e, DH_get_default_method())
168 || !ENGINE_set_RAND(e, RAND_SSLeay())
169 # ifdef TEST_ENG_OPENSSL_RC4
170 || !ENGINE_set_ciphers(e, openssl_ciphers)
172 # ifdef TEST_ENG_OPENSSL_SHA
173 || !ENGINE_set_digests(e, openssl_digests)
176 #ifdef TEST_ENG_OPENSSL_PKEY
177 || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
179 #ifdef TEST_ENG_OPENSSL_HMAC
180 || !ossl_register_hmac_meth()
181 || !ENGINE_set_pkey_meths(e, ossl_pkey_meths)
186 * If we add errors to this ENGINE, ensure the error handling is setup
189 /* openssl_load_error_strings(); */
193 static ENGINE *engine_openssl(void)
195 ENGINE *ret = ENGINE_new();
198 if (!bind_helper(ret)) {
205 void ENGINE_load_openssl(void)
207 ENGINE *toadd = engine_openssl();
212 * If the "add" worked, it gets a structural reference. So either way, we
213 * release our just-created reference.
220 * This stuff is needed if this ENGINE is being compiled into a
221 * self-contained shared-library.
223 #ifdef ENGINE_DYNAMIC_SUPPORT
224 static int bind_fn(ENGINE *e, const char *id)
226 if (id && (strcmp(id, engine_openssl_id) != 0))
233 IMPLEMENT_DYNAMIC_CHECK_FN()
234 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
235 #endif /* ENGINE_DYNAMIC_SUPPORT */
236 #ifdef TEST_ENG_OPENSSL_RC4
238 * This section of code compiles an "alternative implementation" of two modes of
239 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
240 * should under normal circumstances go via this support rather than the default
241 * EVP support. There are other symbols to tweak the testing;
242 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
243 * we're asked for a cipher we don't support (should not happen).
244 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
245 * the "init_key" handler is called.
246 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
248 # include <openssl/rc4.h>
249 # define TEST_RC4_KEY_SIZE 16
250 static const int test_cipher_nids[] = { NID_rc4, NID_rc4_40 };
252 static const int test_cipher_nids_number = 2;
254 unsigned char key[TEST_RC4_KEY_SIZE];
257 # define test(ctx) ((TEST_RC4_KEY *)(ctx)->cipher_data)
258 static int test_rc4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
259 const unsigned char *iv, int enc)
261 # ifdef TEST_ENG_OPENSSL_RC4_P_INIT
262 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
264 memcpy(&test(ctx)->key[0], key, EVP_CIPHER_CTX_key_length(ctx));
265 RC4_set_key(&test(ctx)->ks, EVP_CIPHER_CTX_key_length(ctx),
270 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
271 const unsigned char *in, size_t inl)
273 # ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
274 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
276 RC4(&test(ctx)->ks, inl, in, out);
280 static const EVP_CIPHER test_r4_cipher = {
282 1, TEST_RC4_KEY_SIZE, 0,
283 EVP_CIPH_VARIABLE_LENGTH,
287 sizeof(TEST_RC4_KEY),
294 static const EVP_CIPHER test_r4_40_cipher = {
296 1, 5 /* 40 bit */ , 0,
297 EVP_CIPH_VARIABLE_LENGTH,
301 sizeof(TEST_RC4_KEY),
308 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
309 const int **nids, int nid)
312 /* We are returning a list of supported nids */
313 *nids = test_cipher_nids;
314 return test_cipher_nids_number;
316 /* We are being asked for a specific cipher */
318 *cipher = &test_r4_cipher;
319 else if (nid == NID_rc4_40)
320 *cipher = &test_r4_40_cipher;
322 # ifdef TEST_ENG_OPENSSL_RC4_OTHERS
323 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
333 #ifdef TEST_ENG_OPENSSL_SHA
334 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
335 # include <openssl/sha.h>
336 static const int test_digest_nids[] = { NID_sha1 };
338 static const int test_digest_nids_number = 1;
339 static int test_sha1_init(EVP_MD_CTX *ctx)
341 # ifdef TEST_ENG_OPENSSL_SHA_P_INIT
342 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
344 return SHA1_Init(ctx->md_data);
347 static int test_sha1_update(EVP_MD_CTX *ctx, const void *data, size_t count)
349 # ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
350 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
352 return SHA1_Update(ctx->md_data, data, count);
355 static int test_sha1_final(EVP_MD_CTX *ctx, unsigned char *md)
357 # ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
358 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
360 return SHA1_Final(md, ctx->md_data);
363 static const EVP_MD test_sha_md = {
365 NID_sha1WithRSAEncryption,
375 sizeof(EVP_MD *) + sizeof(SHA_CTX),
378 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
379 const int **nids, int nid)
382 /* We are returning a list of supported nids */
383 *nids = test_digest_nids;
384 return test_digest_nids_number;
386 /* We are being asked for a specific digest */
388 *digest = &test_sha_md;
390 # ifdef TEST_ENG_OPENSSL_SHA_OTHERS
391 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
401 #ifdef TEST_ENG_OPENSSL_PKEY
402 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
403 UI_METHOD *ui_method,
408 fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n",
410 in = BIO_new_file(key_id, "r");
413 key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);
419 #ifdef TEST_ENG_OPENSSL_HMAC
422 * Experimental HMAC redirection implementation: mainly copied from
426 /* HMAC pkey context structure */
429 const EVP_MD *md; /* MD for HMAC use */
430 ASN1_OCTET_STRING ktmp; /* Temp storage for key */
432 } OSSL_HMAC_PKEY_CTX;
434 static int ossl_hmac_init(EVP_PKEY_CTX *ctx)
436 OSSL_HMAC_PKEY_CTX *hctx;
437 hctx = OPENSSL_malloc(sizeof(OSSL_HMAC_PKEY_CTX));
441 hctx->ktmp.data = NULL;
442 hctx->ktmp.length = 0;
443 hctx->ktmp.flags = 0;
444 hctx->ktmp.type = V_ASN1_OCTET_STRING;
445 HMAC_CTX_init(&hctx->ctx);
446 EVP_PKEY_CTX_set_data(ctx, hctx);
447 EVP_PKEY_CTX_set0_keygen_info(ctx, NULL, 0);
448 # ifdef TEST_ENG_OPENSSL_HMAC_INIT
449 fprintf(stderr, "(TEST_ENG_OPENSSL_HMAC) ossl_hmac_init() called\n");
454 static int ossl_hmac_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
456 OSSL_HMAC_PKEY_CTX *sctx, *dctx;
457 if (!ossl_hmac_init(dst))
459 sctx = EVP_PKEY_CTX_get_data(src);
460 dctx = EVP_PKEY_CTX_get_data(dst);
462 HMAC_CTX_init(&dctx->ctx);
463 if (!HMAC_CTX_copy(&dctx->ctx, &sctx->ctx))
465 if (sctx->ktmp.data) {
466 if (!ASN1_OCTET_STRING_set(&dctx->ktmp,
467 sctx->ktmp.data, sctx->ktmp.length))
473 static void ossl_hmac_cleanup(EVP_PKEY_CTX *ctx)
475 OSSL_HMAC_PKEY_CTX *hctx;
476 hctx = EVP_PKEY_CTX_get_data(ctx);
477 HMAC_CTX_cleanup(&hctx->ctx);
478 if (hctx->ktmp.data) {
479 if (hctx->ktmp.length)
480 OPENSSL_cleanse(hctx->ktmp.data, hctx->ktmp.length);
481 OPENSSL_free(hctx->ktmp.data);
482 hctx->ktmp.data = NULL;
487 static int ossl_hmac_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
489 ASN1_OCTET_STRING *hkey = NULL;
490 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
491 if (!hctx->ktmp.data)
493 hkey = ASN1_OCTET_STRING_dup(&hctx->ktmp);
496 EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, hkey);
501 static int ossl_int_update(EVP_MD_CTX *ctx, const void *data, size_t count)
503 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx->pctx);
504 if (!HMAC_Update(&hctx->ctx, data, count))
509 static int ossl_hmac_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
511 EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
512 mctx->update = ossl_int_update;
516 static int ossl_hmac_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig,
517 size_t *siglen, EVP_MD_CTX *mctx)
520 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
521 int l = EVP_MD_CTX_size(mctx);
529 if (!HMAC_Final(&hctx->ctx, sig, &hlen))
531 *siglen = (size_t)hlen;
535 static int ossl_hmac_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
537 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
539 ASN1_OCTET_STRING *key;
542 case EVP_PKEY_CTRL_SET_MAC_KEY:
543 if ((!p2 && p1 > 0) || (p1 < -1))
545 if (!ASN1_OCTET_STRING_set(&hctx->ktmp, p2, p1))
549 case EVP_PKEY_CTRL_MD:
553 case EVP_PKEY_CTRL_DIGESTINIT:
554 pk = EVP_PKEY_CTX_get0_pkey(ctx);
555 key = EVP_PKEY_get0(pk);
556 if (!HMAC_Init_ex(&hctx->ctx, key->data, key->length, hctx->md, NULL))
567 static int ossl_hmac_ctrl_str(EVP_PKEY_CTX *ctx,
568 const char *type, const char *value)
573 if (!strcmp(type, "key")) {
574 void *p = (void *)value;
575 return ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, -1, p);
577 if (!strcmp(type, "hexkey")) {
581 key = string_to_hex(value, &keylen);
584 r = ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, keylen, key);
591 static EVP_PKEY_METHOD *ossl_hmac_meth;
593 static int ossl_register_hmac_meth(void)
595 EVP_PKEY_METHOD *meth;
596 meth = EVP_PKEY_meth_new(EVP_PKEY_HMAC, 0);
599 EVP_PKEY_meth_set_init(meth, ossl_hmac_init);
600 EVP_PKEY_meth_set_copy(meth, ossl_hmac_copy);
601 EVP_PKEY_meth_set_cleanup(meth, ossl_hmac_cleanup);
603 EVP_PKEY_meth_set_keygen(meth, 0, ossl_hmac_keygen);
605 EVP_PKEY_meth_set_signctx(meth, ossl_hmac_signctx_init,
608 EVP_PKEY_meth_set_ctrl(meth, ossl_hmac_ctrl, ossl_hmac_ctrl_str);
609 ossl_hmac_meth = meth;
613 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
614 const int **nids, int nid)
616 static int ossl_pkey_nids[] = {
621 *nids = ossl_pkey_nids;
625 if (nid == EVP_PKEY_HMAC) {
626 *pmeth = ossl_hmac_meth;