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>
72 /* This testing gunk is implemented (and explained) lower down. It also assumes
73 * the application explicitly calls "ENGINE_load_openssl()" because this is no
74 * longer automatic in ENGINE_load_builtin_engines(). */
75 #define TEST_ENG_OPENSSL_RC4
76 #define TEST_ENG_OPENSSL_PKEY
77 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
78 #define TEST_ENG_OPENSSL_RC4_P_INIT
79 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
80 #define TEST_ENG_OPENSSL_SHA
81 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
82 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
83 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
84 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
86 #ifdef TEST_ENG_OPENSSL_RC4
87 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
88 const int **nids, int nid);
90 #ifdef TEST_ENG_OPENSSL_SHA
91 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
92 const int **nids, int nid);
95 #ifdef TEST_ENG_OPENSSL_PKEY
96 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
97 UI_METHOD *ui_method, void *callback_data);
100 /* The constants used when creating the ENGINE */
101 static const char *engine_openssl_id = "openssl";
102 static const char *engine_openssl_name = "Software engine support";
104 /* This internal function is used by ENGINE_openssl() and possibly by the
105 * "dynamic" ENGINE support too */
106 static int bind_helper(ENGINE *e)
108 if(!ENGINE_set_id(e, engine_openssl_id)
109 || !ENGINE_set_name(e, engine_openssl_name)
110 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
111 #ifndef OPENSSL_NO_RSA
112 || !ENGINE_set_RSA(e, RSA_get_default_method())
114 #ifndef OPENSSL_NO_DSA
115 || !ENGINE_set_DSA(e, DSA_get_default_method())
117 #ifndef OPENSSL_NO_ECDH
118 || !ENGINE_set_ECDH(e, ECDH_OpenSSL())
120 #ifndef OPENSSL_NO_ECDSA
121 || !ENGINE_set_ECDSA(e, ECDSA_OpenSSL())
123 #ifndef OPENSSL_NO_DH
124 || !ENGINE_set_DH(e, DH_get_default_method())
126 || !ENGINE_set_RAND(e, RAND_SSLeay())
127 #ifdef TEST_ENG_OPENSSL_RC4
128 || !ENGINE_set_ciphers(e, openssl_ciphers)
130 #ifdef TEST_ENG_OPENSSL_SHA
131 || !ENGINE_set_digests(e, openssl_digests)
134 #ifdef TEST_ENG_OPENSSL_PKEY
135 || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
139 /* If we add errors to this ENGINE, ensure the error handling is setup here */
140 /* openssl_load_error_strings(); */
144 static ENGINE *engine_openssl(void)
146 ENGINE *ret = ENGINE_new();
149 if(!bind_helper(ret))
157 void ENGINE_load_openssl(void)
159 ENGINE *toadd = engine_openssl();
162 /* If the "add" worked, it gets a structural reference. So either way,
163 * we release our just-created reference. */
168 /* This stuff is needed if this ENGINE is being compiled into a self-contained
170 #ifdef ENGINE_DYNAMIC_SUPPORT
171 static int bind_fn(ENGINE *e, const char *id)
173 if(id && (strcmp(id, engine_openssl_id) != 0))
179 IMPLEMENT_DYNAMIC_CHECK_FN()
180 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
181 #endif /* ENGINE_DYNAMIC_SUPPORT */
183 #ifdef TEST_ENG_OPENSSL_RC4
184 /* This section of code compiles an "alternative implementation" of two modes of
185 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
186 * should under normal circumstances go via this support rather than the default
187 * EVP support. There are other symbols to tweak the testing;
188 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
189 * we're asked for a cipher we don't support (should not happen).
190 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
191 * the "init_key" handler is called.
192 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
194 #include <openssl/evp.h>
195 #include <openssl/rc4.h>
196 #define TEST_RC4_KEY_SIZE 16
197 static int test_cipher_nids[] = {NID_rc4,NID_rc4_40};
198 static int test_cipher_nids_number = 2;
200 unsigned char key[TEST_RC4_KEY_SIZE];
203 #define test(ctx) ((TEST_RC4_KEY *)(ctx)->cipher_data)
204 static int test_rc4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
205 const unsigned char *iv, int enc)
207 #ifdef TEST_ENG_OPENSSL_RC4_P_INIT
208 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
210 memcpy(&test(ctx)->key[0],key,EVP_CIPHER_CTX_key_length(ctx));
211 RC4_set_key(&test(ctx)->ks,EVP_CIPHER_CTX_key_length(ctx),
215 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
216 const unsigned char *in, unsigned int inl)
218 #ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
219 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
221 RC4(&test(ctx)->ks,inl,in,out);
224 static const EVP_CIPHER test_r4_cipher=
227 1,TEST_RC4_KEY_SIZE,0,
228 EVP_CIPH_VARIABLE_LENGTH,
232 sizeof(TEST_RC4_KEY),
237 static const EVP_CIPHER test_r4_40_cipher=
241 EVP_CIPH_VARIABLE_LENGTH,
245 sizeof(TEST_RC4_KEY),
250 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
251 const int **nids, int nid)
255 /* We are returning a list of supported nids */
256 *nids = test_cipher_nids;
257 return test_cipher_nids_number;
259 /* We are being asked for a specific cipher */
261 *cipher = &test_r4_cipher;
262 else if(nid == NID_rc4_40)
263 *cipher = &test_r4_40_cipher;
266 #ifdef TEST_ENG_OPENSSL_RC4_OTHERS
267 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
277 #ifdef TEST_ENG_OPENSSL_SHA
278 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
279 #include <openssl/evp.h>
280 #include <openssl/sha.h>
281 static int test_digest_nids[] = {NID_sha1};
282 static int test_digest_nids_number = 1;
283 static int test_sha1_init(EVP_MD_CTX *ctx)
285 #ifdef TEST_ENG_OPENSSL_SHA_P_INIT
286 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
288 return SHA1_Init(ctx->md_data);
290 static int test_sha1_update(EVP_MD_CTX *ctx,const void *data,unsigned long count)
292 #ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
293 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
295 return SHA1_Update(ctx->md_data,data,count);
297 static int test_sha1_final(EVP_MD_CTX *ctx,unsigned char *md)
299 #ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
300 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
302 return SHA1_Final(md,ctx->md_data);
304 static const EVP_MD test_sha_md=
307 NID_sha1WithRSAEncryption,
317 sizeof(EVP_MD *)+sizeof(SHA_CTX),
319 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
320 const int **nids, int nid)
324 /* We are returning a list of supported nids */
325 *nids = test_digest_nids;
326 return test_digest_nids_number;
328 /* We are being asked for a specific digest */
330 *digest = &test_sha_md;
333 #ifdef TEST_ENG_OPENSSL_SHA_OTHERS
334 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
344 #ifdef TEST_ENG_OPENSSL_PKEY
345 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
346 UI_METHOD *ui_method, void *callback_data)
350 fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n", key_id);
351 in = BIO_new_file(key_id, "r");
354 key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);