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).
61 #include <openssl/crypto.h>
63 #include <openssl/engine.h>
64 #include <openssl/dso.h>
65 #include <openssl/pem.h>
67 /* This testing gunk is implemented (and explained) lower down. It also assumes
68 * the application explicitly calls "ENGINE_load_openssl()" because this is no
69 * longer automatic in ENGINE_load_builtin_engines(). */
70 #define TEST_ENG_OPENSSL_RC4
71 #define TEST_ENG_OPENSSL_PKEY
72 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
73 #define TEST_ENG_OPENSSL_RC4_P_INIT
74 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
75 #define TEST_ENG_OPENSSL_SHA
76 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
77 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
78 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
79 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
81 #ifdef TEST_ENG_OPENSSL_RC4
82 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
83 const int **nids, int nid);
85 #ifdef TEST_ENG_OPENSSL_SHA
86 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
87 const int **nids, int nid);
90 #ifdef TEST_ENG_OPENSSL_PKEY
91 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
92 UI_METHOD *ui_method, void *callback_data);
95 /* The constants used when creating the ENGINE */
96 static const char *engine_openssl_id = "openssl";
97 static const char *engine_openssl_name = "Software engine support";
99 /* This internal function is used by ENGINE_openssl() and possibly by the
100 * "dynamic" ENGINE support too */
101 static int bind_helper(ENGINE *e)
103 if(!ENGINE_set_id(e, engine_openssl_id)
104 || !ENGINE_set_name(e, engine_openssl_name)
105 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
106 #ifndef OPENSSL_NO_RSA
107 || !ENGINE_set_RSA(e, RSA_get_default_method())
109 #ifndef OPENSSL_NO_DSA
110 || !ENGINE_set_DSA(e, DSA_get_default_method())
112 #ifndef OPENSSL_NO_DH
113 || !ENGINE_set_DH(e, DH_get_default_method())
115 || !ENGINE_set_RAND(e, RAND_SSLeay())
116 #ifdef TEST_ENG_OPENSSL_RC4
117 || !ENGINE_set_ciphers(e, openssl_ciphers)
119 #ifdef TEST_ENG_OPENSSL_SHA
120 || !ENGINE_set_digests(e, openssl_digests)
123 #ifdef TEST_ENG_OPENSSL_PKEY
124 || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
128 /* If we add errors to this ENGINE, ensure the error handling is setup here */
129 /* openssl_load_error_strings(); */
133 static ENGINE *engine_openssl(void)
135 ENGINE *ret = ENGINE_new();
138 if(!bind_helper(ret))
146 void ENGINE_load_openssl(void)
148 ENGINE *toadd = engine_openssl();
151 /* If the "add" worked, it gets a structural reference. So either way,
152 * we release our just-created reference. */
157 /* This stuff is needed if this ENGINE is being compiled into a self-contained
159 #ifdef ENGINE_DYNAMIC_SUPPORT
160 static int bind_fn(ENGINE *e, const char *id)
162 if(id && (strcmp(id, engine_openssl_id) != 0))
168 IMPLEMENT_DYNAMIC_CHECK_FN()
169 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
170 #endif /* ENGINE_DYNAMIC_SUPPORT */
172 #ifdef TEST_ENG_OPENSSL_RC4
173 /* This section of code compiles an "alternative implementation" of two modes of
174 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
175 * should under normal circumstances go via this support rather than the default
176 * EVP support. There are other symbols to tweak the testing;
177 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
178 * we're asked for a cipher we don't support (should not happen).
179 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
180 * the "init_key" handler is called.
181 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
183 #include <openssl/evp.h>
184 #include <openssl/rc4.h>
185 #define TEST_RC4_KEY_SIZE 16
186 static int test_cipher_nids[] = {NID_rc4,NID_rc4_40};
187 static int test_cipher_nids_number = 2;
189 unsigned char key[TEST_RC4_KEY_SIZE];
192 #define test(ctx) ((TEST_RC4_KEY *)(ctx)->cipher_data)
193 static int test_rc4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
194 const unsigned char *iv, int enc)
196 #ifdef TEST_ENG_OPENSSL_RC4_P_INIT
197 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
199 memcpy(&test(ctx)->key[0],key,EVP_CIPHER_CTX_key_length(ctx));
200 RC4_set_key(&test(ctx)->ks,EVP_CIPHER_CTX_key_length(ctx),
204 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
205 const unsigned char *in, unsigned int inl)
207 #ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
208 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
210 RC4(&test(ctx)->ks,inl,in,out);
213 static const EVP_CIPHER test_r4_cipher=
216 1,TEST_RC4_KEY_SIZE,0,
217 EVP_CIPH_VARIABLE_LENGTH,
221 sizeof(TEST_RC4_KEY),
226 static const EVP_CIPHER test_r4_40_cipher=
230 EVP_CIPH_VARIABLE_LENGTH,
234 sizeof(TEST_RC4_KEY),
239 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
240 const int **nids, int nid)
244 /* We are returning a list of supported nids */
245 *nids = test_cipher_nids;
246 return test_cipher_nids_number;
248 /* We are being asked for a specific cipher */
250 *cipher = &test_r4_cipher;
251 else if(nid == NID_rc4_40)
252 *cipher = &test_r4_40_cipher;
255 #ifdef TEST_ENG_OPENSSL_RC4_OTHERS
256 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
266 #ifdef TEST_ENG_OPENSSL_SHA
267 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
268 #include <openssl/evp.h>
269 #include <openssl/sha.h>
270 static int test_digest_nids[] = {NID_sha1};
271 static int test_digest_nids_number = 1;
272 static int test_sha1_init(EVP_MD_CTX *ctx)
274 #ifdef TEST_ENG_OPENSSL_SHA_P_INIT
275 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
277 return SHA1_Init(ctx->md_data);
279 static int test_sha1_update(EVP_MD_CTX *ctx,const void *data,unsigned long count)
281 #ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
282 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
284 return SHA1_Update(ctx->md_data,data,count);
286 static int test_sha1_final(EVP_MD_CTX *ctx,unsigned char *md)
288 #ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
289 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
291 return SHA1_Final(md,ctx->md_data);
293 static const EVP_MD test_sha_md=
296 NID_sha1WithRSAEncryption,
306 sizeof(EVP_MD *)+sizeof(SHA_CTX),
308 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
309 const int **nids, int nid)
313 /* We are returning a list of supported nids */
314 *nids = test_digest_nids;
315 return test_digest_nids_number;
317 /* We are being asked for a specific digest */
319 *digest = &test_sha_md;
322 #ifdef TEST_ENG_OPENSSL_SHA_OTHERS
323 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
333 #ifdef TEST_ENG_OPENSSL_PKEY
334 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
335 UI_METHOD *ui_method, void *callback_data)
339 fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n", key_id);
340 in = BIO_new_file(key_id, "r");
343 key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);