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 #include <openssl/rsa.h>
74 #include <openssl/dsa.h>
75 #include <openssl/dh.h>
77 /* This testing gunk is implemented (and explained) lower down. It also assumes
78 * the application explicitly calls "ENGINE_load_openssl()" because this is no
79 * longer automatic in ENGINE_load_builtin_engines(). */
80 #define TEST_ENG_OPENSSL_RC4
81 #define TEST_ENG_OPENSSL_PKEY
82 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
83 #define TEST_ENG_OPENSSL_RC4_P_INIT
84 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
85 #define TEST_ENG_OPENSSL_SHA
86 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
87 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
88 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
89 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
91 /* Now check what of those algorithms are actually enabled */
93 #undef TEST_ENG_OPENSSL_RC4
94 #undef TEST_ENG_OPENSSL_RC4_OTHERS
95 #undef TEST_ENG_OPENSSL_RC4_P_INIT
96 #undef TEST_ENG_OPENSSL_RC4_P_CIPHER
98 #if defined(OPENSSL_NO_SHA) || defined(OPENSSL_NO_SHA0) || defined(OPENSSL_NO_SHA1)
99 #undef TEST_ENG_OPENSSL_SHA
100 #undef TEST_ENG_OPENSSL_SHA_OTHERS
101 #undef TEST_ENG_OPENSSL_SHA_P_INIT
102 #undef TEST_ENG_OPENSSL_SHA_P_UPDATE
103 #undef TEST_ENG_OPENSSL_SHA_P_FINAL
106 #ifdef TEST_ENG_OPENSSL_RC4
107 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
108 const int **nids, int nid);
110 #ifdef TEST_ENG_OPENSSL_SHA
111 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
112 const int **nids, int nid);
115 #ifdef TEST_ENG_OPENSSL_PKEY
116 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
117 UI_METHOD *ui_method, void *callback_data);
120 /* The constants used when creating the ENGINE */
121 static const char *engine_openssl_id = "openssl";
122 static const char *engine_openssl_name = "Software engine support";
124 /* This internal function is used by ENGINE_openssl() and possibly by the
125 * "dynamic" ENGINE support too */
126 static int bind_helper(ENGINE *e)
128 if(!ENGINE_set_id(e, engine_openssl_id)
129 || !ENGINE_set_name(e, engine_openssl_name)
130 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
131 #ifndef OPENSSL_NO_RSA
132 || !ENGINE_set_RSA(e, RSA_get_default_method())
134 #ifndef OPENSSL_NO_DSA
135 || !ENGINE_set_DSA(e, DSA_get_default_method())
137 #ifndef OPENSSL_NO_ECDH
138 || !ENGINE_set_ECDH(e, ECDH_OpenSSL())
140 #ifndef OPENSSL_NO_ECDSA
141 || !ENGINE_set_ECDSA(e, ECDSA_OpenSSL())
143 #ifndef OPENSSL_NO_DH
144 || !ENGINE_set_DH(e, DH_get_default_method())
146 || !ENGINE_set_RAND(e, RAND_SSLeay())
147 #ifdef TEST_ENG_OPENSSL_RC4
148 || !ENGINE_set_ciphers(e, openssl_ciphers)
150 #ifdef TEST_ENG_OPENSSL_SHA
151 || !ENGINE_set_digests(e, openssl_digests)
154 #ifdef TEST_ENG_OPENSSL_PKEY
155 || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
159 /* If we add errors to this ENGINE, ensure the error handling is setup here */
160 /* openssl_load_error_strings(); */
164 static ENGINE *engine_openssl(void)
166 ENGINE *ret = ENGINE_new();
169 if(!bind_helper(ret))
177 void ENGINE_load_openssl(void)
179 ENGINE *toadd = engine_openssl();
182 /* If the "add" worked, it gets a structural reference. So either way,
183 * we release our just-created reference. */
188 /* This stuff is needed if this ENGINE is being compiled into a self-contained
190 #ifdef ENGINE_DYNAMIC_SUPPORT
191 static int bind_fn(ENGINE *e, const char *id)
193 if(id && (strcmp(id, engine_openssl_id) != 0))
199 IMPLEMENT_DYNAMIC_CHECK_FN()
200 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
201 #endif /* ENGINE_DYNAMIC_SUPPORT */
203 #ifdef TEST_ENG_OPENSSL_RC4
204 /* This section of code compiles an "alternative implementation" of two modes of
205 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
206 * should under normal circumstances go via this support rather than the default
207 * EVP support. There are other symbols to tweak the testing;
208 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
209 * we're asked for a cipher we don't support (should not happen).
210 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
211 * the "init_key" handler is called.
212 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
214 #include <openssl/rc4.h>
215 #define TEST_RC4_KEY_SIZE 16
216 static int test_cipher_nids[] = {NID_rc4,NID_rc4_40};
217 static int test_cipher_nids_number = 2;
219 unsigned char key[TEST_RC4_KEY_SIZE];
222 #define test(ctx) ((TEST_RC4_KEY *)(ctx)->cipher_data)
223 static int test_rc4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
224 const unsigned char *iv, int enc)
226 #ifdef TEST_ENG_OPENSSL_RC4_P_INIT
227 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
229 memcpy(&test(ctx)->key[0],key,EVP_CIPHER_CTX_key_length(ctx));
230 RC4_set_key(&test(ctx)->ks,EVP_CIPHER_CTX_key_length(ctx),
234 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
235 const unsigned char *in, unsigned int inl)
237 #ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
238 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
240 RC4(&test(ctx)->ks,inl,in,out);
243 static const EVP_CIPHER test_r4_cipher=
246 1,TEST_RC4_KEY_SIZE,0,
247 EVP_CIPH_VARIABLE_LENGTH,
251 sizeof(TEST_RC4_KEY),
256 static const EVP_CIPHER test_r4_40_cipher=
260 EVP_CIPH_VARIABLE_LENGTH,
264 sizeof(TEST_RC4_KEY),
269 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
270 const int **nids, int nid)
274 /* We are returning a list of supported nids */
275 *nids = test_cipher_nids;
276 return test_cipher_nids_number;
278 /* We are being asked for a specific cipher */
280 *cipher = &test_r4_cipher;
281 else if(nid == NID_rc4_40)
282 *cipher = &test_r4_40_cipher;
285 #ifdef TEST_ENG_OPENSSL_RC4_OTHERS
286 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
296 #ifdef TEST_ENG_OPENSSL_SHA
297 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
298 #include <openssl/sha.h>
299 static int test_digest_nids[] = {NID_sha1};
300 static int test_digest_nids_number = 1;
301 static int test_sha1_init(EVP_MD_CTX *ctx)
303 #ifdef TEST_ENG_OPENSSL_SHA_P_INIT
304 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
306 return SHA1_Init(ctx->md_data);
308 static int test_sha1_update(EVP_MD_CTX *ctx,const void *data,size_t count)
310 #ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
311 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
313 return SHA1_Update(ctx->md_data,data,count);
315 static int test_sha1_final(EVP_MD_CTX *ctx,unsigned char *md)
317 #ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
318 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
320 return SHA1_Final(md,ctx->md_data);
322 static const EVP_MD test_sha_md=
325 NID_sha1WithRSAEncryption,
335 sizeof(EVP_MD *)+sizeof(SHA_CTX),
337 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
338 const int **nids, int nid)
342 /* We are returning a list of supported nids */
343 *nids = test_digest_nids;
344 return test_digest_nids_number;
346 /* We are being asked for a specific digest */
348 *digest = &test_sha_md;
351 #ifdef TEST_ENG_OPENSSL_SHA_OTHERS
352 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
362 #ifdef TEST_ENG_OPENSSL_PKEY
363 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
364 UI_METHOD *ui_method, void *callback_data)
368 fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n", key_id);
369 in = BIO_new_file(key_id, "r");
372 key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);