1 /* crypto/engine/eng_openssl.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2001 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).
58 /* ====================================================================
59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60 * ECDH support in OpenSSL originally developed by
61 * 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>
86 /* This testing gunk is implemented (and explained) lower down. It also assumes
87 * the application explicitly calls "ENGINE_load_openssl()" because this is no
88 * longer automatic in ENGINE_load_builtin_engines(). */
89 #define TEST_ENG_OPENSSL_RC4
90 #define TEST_ENG_OPENSSL_PKEY
91 /* #define TEST_ENG_OPENSSL_HMAC */
92 /* #define TEST_ENG_OPENSSL_HMAC_INIT */
93 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
94 #define TEST_ENG_OPENSSL_RC4_P_INIT
95 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
96 #define TEST_ENG_OPENSSL_SHA
97 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
98 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
99 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
100 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
102 /* Now check what of those algorithms are actually enabled */
103 #ifdef OPENSSL_NO_RC4
104 #undef TEST_ENG_OPENSSL_RC4
105 #undef TEST_ENG_OPENSSL_RC4_OTHERS
106 #undef TEST_ENG_OPENSSL_RC4_P_INIT
107 #undef TEST_ENG_OPENSSL_RC4_P_CIPHER
109 #if defined(OPENSSL_NO_SHA) || defined(OPENSSL_NO_SHA0) || defined(OPENSSL_NO_SHA1)
110 #undef TEST_ENG_OPENSSL_SHA
111 #undef TEST_ENG_OPENSSL_SHA_OTHERS
112 #undef TEST_ENG_OPENSSL_SHA_P_INIT
113 #undef TEST_ENG_OPENSSL_SHA_P_UPDATE
114 #undef TEST_ENG_OPENSSL_SHA_P_FINAL
117 #ifdef TEST_ENG_OPENSSL_RC4
118 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
119 const int **nids, int nid);
121 #ifdef TEST_ENG_OPENSSL_SHA
122 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
123 const int **nids, int nid);
126 #ifdef TEST_ENG_OPENSSL_PKEY
127 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
128 UI_METHOD *ui_method, void *callback_data);
131 #ifdef TEST_ENG_OPENSSL_HMAC
132 static int ossl_register_hmac_meth(void);
133 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
134 const int **nids, int nid);
137 /* The constants used when creating the ENGINE */
138 static const char *engine_openssl_id = "openssl";
139 static const char *engine_openssl_name = "Software engine support";
141 /* This internal function is used by ENGINE_openssl() and possibly by the
142 * "dynamic" ENGINE support too */
143 static int bind_helper(ENGINE *e)
145 if(!ENGINE_set_id(e, engine_openssl_id)
146 || !ENGINE_set_name(e, engine_openssl_name)
147 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
148 #ifndef OPENSSL_NO_RSA
149 || !ENGINE_set_RSA(e, RSA_get_default_method())
151 #ifndef OPENSSL_NO_DSA
152 || !ENGINE_set_DSA(e, DSA_get_default_method())
154 #ifndef OPENSSL_NO_ECDH
155 || !ENGINE_set_ECDH(e, ECDH_OpenSSL())
157 #ifndef OPENSSL_NO_ECDSA
158 || !ENGINE_set_ECDSA(e, ECDSA_OpenSSL())
160 #ifndef OPENSSL_NO_DH
161 || !ENGINE_set_DH(e, DH_get_default_method())
163 || !ENGINE_set_RAND(e, RAND_SSLeay())
164 #ifdef TEST_ENG_OPENSSL_RC4
165 || !ENGINE_set_ciphers(e, openssl_ciphers)
167 #ifdef TEST_ENG_OPENSSL_SHA
168 || !ENGINE_set_digests(e, openssl_digests)
171 #ifdef TEST_ENG_OPENSSL_PKEY
172 || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
174 #ifdef TEST_ENG_OPENSSL_HMAC
175 || !ossl_register_hmac_meth()
176 || !ENGINE_set_pkey_meths(e, ossl_pkey_meths)
180 /* If we add errors to this ENGINE, ensure the error handling is setup here */
181 /* openssl_load_error_strings(); */
185 static ENGINE *engine_openssl(void)
187 ENGINE *ret = ENGINE_new();
190 if(!bind_helper(ret))
198 void ENGINE_load_openssl(void)
200 ENGINE *toadd = engine_openssl();
203 /* If the "add" worked, it gets a structural reference. So either way,
204 * we release our just-created reference. */
209 /* This stuff is needed if this ENGINE is being compiled into a self-contained
211 #ifdef ENGINE_DYNAMIC_SUPPORT
212 static int bind_fn(ENGINE *e, const char *id)
214 if(id && (strcmp(id, engine_openssl_id) != 0))
220 IMPLEMENT_DYNAMIC_CHECK_FN()
221 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
222 #endif /* ENGINE_DYNAMIC_SUPPORT */
224 #ifdef TEST_ENG_OPENSSL_RC4
226 * This section of code compiles an "alternative implementation" of two modes of
227 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
228 * should under normal circumstances go via this support rather than the default
229 * EVP support. There are other symbols to tweak the testing;
230 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
231 * we're asked for a cipher we don't support (should not happen).
232 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
233 * the "init_key" handler is called.
234 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
236 #include <openssl/rc4.h>
237 #define TEST_RC4_KEY_SIZE 16
238 static const int test_cipher_nids[] = {NID_rc4,NID_rc4_40};
239 static const int test_cipher_nids_number = 2;
241 unsigned char key[TEST_RC4_KEY_SIZE];
244 #define test(ctx) ((TEST_RC4_KEY *)(ctx)->cipher_data)
245 static int test_rc4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
246 const unsigned char *iv, int enc)
248 #ifdef TEST_ENG_OPENSSL_RC4_P_INIT
249 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
251 memcpy(&test(ctx)->key[0],key,EVP_CIPHER_CTX_key_length(ctx));
252 RC4_set_key(&test(ctx)->ks,EVP_CIPHER_CTX_key_length(ctx),
256 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
257 const unsigned char *in, size_t inl)
259 #ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
260 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
262 RC4(&test(ctx)->ks,inl,in,out);
265 static const EVP_CIPHER test_r4_cipher=
268 1,TEST_RC4_KEY_SIZE,0,
269 EVP_CIPH_VARIABLE_LENGTH,
273 sizeof(TEST_RC4_KEY),
279 static const EVP_CIPHER test_r4_40_cipher=
283 EVP_CIPH_VARIABLE_LENGTH,
287 sizeof(TEST_RC4_KEY),
293 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
294 const int **nids, int nid)
298 /* We are returning a list of supported nids */
299 *nids = test_cipher_nids;
300 return test_cipher_nids_number;
302 /* We are being asked for a specific cipher */
304 *cipher = &test_r4_cipher;
305 else if(nid == NID_rc4_40)
306 *cipher = &test_r4_40_cipher;
309 #ifdef TEST_ENG_OPENSSL_RC4_OTHERS
310 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
320 #ifdef TEST_ENG_OPENSSL_SHA
321 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
322 #include <openssl/sha.h>
323 static const int test_digest_nids[] = {NID_sha1};
324 static const int test_digest_nids_number = 1;
325 static int test_sha1_init(EVP_MD_CTX *ctx)
327 #ifdef TEST_ENG_OPENSSL_SHA_P_INIT
328 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
330 return SHA1_Init(ctx->md_data);
332 static int test_sha1_update(EVP_MD_CTX *ctx,const void *data,size_t count)
334 #ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
335 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
337 return SHA1_Update(ctx->md_data,data,count);
339 static int test_sha1_final(EVP_MD_CTX *ctx,unsigned char *md)
341 #ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
342 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
344 return SHA1_Final(md,ctx->md_data);
346 static const EVP_MD test_sha_md=
349 NID_sha1WithRSAEncryption,
359 sizeof(EVP_MD *)+sizeof(SHA_CTX),
361 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
362 const int **nids, int nid)
366 /* We are returning a list of supported nids */
367 *nids = test_digest_nids;
368 return test_digest_nids_number;
370 /* We are being asked for a specific digest */
372 *digest = &test_sha_md;
375 #ifdef TEST_ENG_OPENSSL_SHA_OTHERS
376 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
386 #ifdef TEST_ENG_OPENSSL_PKEY
387 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
388 UI_METHOD *ui_method, void *callback_data)
392 fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n", key_id);
393 in = BIO_new_file(key_id, "r");
396 key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);
402 #ifdef TEST_ENG_OPENSSL_HMAC
404 /* Experimental HMAC redirection implementation: mainly copied from
408 /* HMAC pkey context structure */
412 const EVP_MD *md; /* MD for HMAC use */
413 ASN1_OCTET_STRING ktmp; /* Temp storage for key */
415 } OSSL_HMAC_PKEY_CTX;
417 static int ossl_hmac_init(EVP_PKEY_CTX *ctx)
419 OSSL_HMAC_PKEY_CTX *hctx;
420 hctx = OPENSSL_malloc(sizeof(OSSL_HMAC_PKEY_CTX));
424 hctx->ktmp.data = NULL;
425 hctx->ktmp.length = 0;
426 hctx->ktmp.flags = 0;
427 hctx->ktmp.type = V_ASN1_OCTET_STRING;
428 HMAC_CTX_init(&hctx->ctx);
429 EVP_PKEY_CTX_set_data(ctx, hctx);
430 EVP_PKEY_CTX_set0_keygen_info(ctx, NULL, 0);
431 #ifdef TEST_ENG_OPENSSL_HMAC_INIT
432 fprintf(stderr, "(TEST_ENG_OPENSSL_HMAC) ossl_hmac_init() called\n");
437 static int ossl_hmac_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
439 OSSL_HMAC_PKEY_CTX *sctx, *dctx;
440 if (!ossl_hmac_init(dst))
442 sctx = EVP_PKEY_CTX_get_data(src);
443 dctx = EVP_PKEY_CTX_get_data(dst);
445 HMAC_CTX_init(&dctx->ctx);
446 if (!HMAC_CTX_copy(&dctx->ctx, &sctx->ctx))
450 if (!ASN1_OCTET_STRING_set(&dctx->ktmp,
451 sctx->ktmp.data, sctx->ktmp.length))
457 static void ossl_hmac_cleanup(EVP_PKEY_CTX *ctx)
459 OSSL_HMAC_PKEY_CTX *hctx;
460 hctx = EVP_PKEY_CTX_get_data(ctx);
461 HMAC_CTX_cleanup(&hctx->ctx);
464 if (hctx->ktmp.length)
465 OPENSSL_cleanse(hctx->ktmp.data, hctx->ktmp.length);
466 OPENSSL_free(hctx->ktmp.data);
467 hctx->ktmp.data = NULL;
472 static int ossl_hmac_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
474 ASN1_OCTET_STRING *hkey = NULL;
475 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
476 if (!hctx->ktmp.data)
478 hkey = ASN1_OCTET_STRING_dup(&hctx->ktmp);
481 EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, hkey);
486 static int ossl_int_update(EVP_MD_CTX *ctx,const void *data,size_t count)
488 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx->pctx);
489 if (!HMAC_Update(&hctx->ctx, data, count))
494 static int ossl_hmac_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
496 EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
497 mctx->update = ossl_int_update;
501 static int ossl_hmac_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
505 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
506 int l = EVP_MD_CTX_size(mctx);
514 if (!HMAC_Final(&hctx->ctx, sig, &hlen))
516 *siglen = (size_t)hlen;
520 static int ossl_hmac_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
522 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
524 ASN1_OCTET_STRING *key;
528 case EVP_PKEY_CTRL_SET_MAC_KEY:
529 if ((!p2 && p1 > 0) || (p1 < -1))
531 if (!ASN1_OCTET_STRING_set(&hctx->ktmp, p2, p1))
535 case EVP_PKEY_CTRL_MD:
539 case EVP_PKEY_CTRL_DIGESTINIT:
540 pk = EVP_PKEY_CTX_get0_pkey(ctx);
541 key = EVP_PKEY_get0(pk);
542 if (!HMAC_Init_ex(&hctx->ctx, key->data, key->length, hctx->md,
554 static int ossl_hmac_ctrl_str(EVP_PKEY_CTX *ctx,
555 const char *type, const char *value)
561 if (!strcmp(type, "key"))
563 void *p = (void *)value;
564 return ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY,
567 if (!strcmp(type, "hexkey"))
572 key = string_to_hex(value, &keylen);
575 r = ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, keylen, key);
582 static EVP_PKEY_METHOD *ossl_hmac_meth;
584 static int ossl_register_hmac_meth(void)
586 EVP_PKEY_METHOD *meth;
587 meth = EVP_PKEY_meth_new(EVP_PKEY_HMAC, 0);
590 EVP_PKEY_meth_set_init(meth, ossl_hmac_init);
591 EVP_PKEY_meth_set_copy(meth, ossl_hmac_copy);
592 EVP_PKEY_meth_set_cleanup(meth, ossl_hmac_cleanup);
594 EVP_PKEY_meth_set_keygen(meth, 0, ossl_hmac_keygen);
596 EVP_PKEY_meth_set_signctx(meth, ossl_hmac_signctx_init,
599 EVP_PKEY_meth_set_ctrl(meth, ossl_hmac_ctrl, ossl_hmac_ctrl_str);
600 ossl_hmac_meth = meth;
604 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
605 const int **nids, int nid)
608 static int ossl_pkey_nids[] =
615 *nids = ossl_pkey_nids;
619 if (nid == EVP_PKEY_HMAC)
621 *pmeth = ossl_hmac_meth;