Depend on OPENSSL_NO_STATIC_ENGINE rather than OPENSSL_NO_DYNAMIC_ENGINE.
[openssl.git] / crypto / engine / eng_openssl.c
1 /* crypto/engine/eng_openssl.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
3  * project 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
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.
62  */
63
64
65 #include <stdio.h>
66 #include <openssl/crypto.h>
67 #include "cryptlib.h"
68 #include <openssl/engine.h>
69 #include <openssl/dso.h>
70 #include <openssl/pem.h>
71 #include <openssl/evp.h>
72
73 /* This testing gunk is implemented (and explained) lower down. It also assumes
74  * the application explicitly calls "ENGINE_load_openssl()" because this is no
75  * longer automatic in ENGINE_load_builtin_engines(). */
76 #define TEST_ENG_OPENSSL_RC4
77 #define TEST_ENG_OPENSSL_PKEY
78 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
79 #define TEST_ENG_OPENSSL_RC4_P_INIT
80 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
81 #define TEST_ENG_OPENSSL_SHA
82 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
83 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
84 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
85 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
86
87 #ifdef TEST_ENG_OPENSSL_RC4
88 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
89                                 const int **nids, int nid);
90 #endif
91 #ifdef TEST_ENG_OPENSSL_SHA
92 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
93                                 const int **nids, int nid);
94 #endif
95
96 #ifdef TEST_ENG_OPENSSL_PKEY
97 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
98         UI_METHOD *ui_method, void *callback_data);
99 #endif
100
101 /* The constants used when creating the ENGINE */
102 static const char *engine_openssl_id = "openssl";
103 static const char *engine_openssl_name = "Software engine support";
104
105 /* This internal function is used by ENGINE_openssl() and possibly by the
106  * "dynamic" ENGINE support too */
107 static int bind_helper(ENGINE *e)
108         {
109         if(!ENGINE_set_id(e, engine_openssl_id)
110                         || !ENGINE_set_name(e, engine_openssl_name)
111 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
112 #ifndef OPENSSL_NO_RSA
113                         || !ENGINE_set_RSA(e, RSA_get_default_method())
114 #endif
115 #ifndef OPENSSL_NO_DSA
116                         || !ENGINE_set_DSA(e, DSA_get_default_method())
117 #endif
118 #ifndef OPENSSL_NO_ECDH
119                         || !ENGINE_set_ECDH(e, ECDH_OpenSSL())
120 #endif
121 #ifndef OPENSSL_NO_ECDSA
122                         || !ENGINE_set_ECDSA(e, ECDSA_OpenSSL())
123 #endif
124 #ifndef OPENSSL_NO_DH
125                         || !ENGINE_set_DH(e, DH_get_default_method())
126 #endif
127                         || !ENGINE_set_RAND(e, RAND_SSLeay())
128 #ifdef TEST_ENG_OPENSSL_RC4
129                         || !ENGINE_set_ciphers(e, openssl_ciphers)
130 #endif
131 #ifdef TEST_ENG_OPENSSL_SHA
132                         || !ENGINE_set_digests(e, openssl_digests)
133 #endif
134 #endif
135 #ifdef TEST_ENG_OPENSSL_PKEY
136                         || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
137 #endif
138                         )
139                 return 0;
140         /* If we add errors to this ENGINE, ensure the error handling is setup here */
141         /* openssl_load_error_strings(); */
142         return 1;
143         }
144
145 static ENGINE *engine_openssl(void)
146         {
147         ENGINE *ret = ENGINE_new();
148         if(!ret)
149                 return NULL;
150         if(!bind_helper(ret))
151                 {
152                 ENGINE_free(ret);
153                 return NULL;
154                 }
155         return ret;
156         }
157
158 void ENGINE_load_openssl(void)
159         {
160         ENGINE *toadd = engine_openssl();
161         if(!toadd) return;
162         ENGINE_add(toadd);
163         /* If the "add" worked, it gets a structural reference. So either way,
164          * we release our just-created reference. */
165         ENGINE_free(toadd);
166         ERR_clear_error();
167         }
168
169 /* This stuff is needed if this ENGINE is being compiled into a self-contained
170  * shared-library. */
171 #ifdef ENGINE_DYNAMIC_SUPPORT
172 static int bind_fn(ENGINE *e, const char *id)
173         {
174         if(id && (strcmp(id, engine_openssl_id) != 0))
175                 return 0;
176         if(!bind_helper(e))
177                 return 0;
178         return 1;
179         }
180 IMPLEMENT_DYNAMIC_CHECK_FN()
181 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
182 #endif /* ENGINE_DYNAMIC_SUPPORT */
183
184 #ifdef TEST_ENG_OPENSSL_RC4
185 /* This section of code compiles an "alternative implementation" of two modes of
186  * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
187  * should under normal circumstances go via this support rather than the default
188  * EVP support. There are other symbols to tweak the testing;
189  *    TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
190  *        we're asked for a cipher we don't support (should not happen).
191  *    TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
192  *        the "init_key" handler is called.
193  *    TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
194  */
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;
199 typedef struct {
200         unsigned char key[TEST_RC4_KEY_SIZE];
201         RC4_KEY ks;
202         } TEST_RC4_KEY;
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)
206         {
207 #ifdef TEST_ENG_OPENSSL_RC4_P_INIT
208         fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
209 #endif
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),
212                 test(ctx)->key);
213         return 1;
214         }
215 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
216                       const unsigned char *in, unsigned int inl)
217         {
218 #ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
219         fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
220 #endif
221         RC4(&test(ctx)->ks,inl,in,out);
222         return 1;
223         }
224 static const EVP_CIPHER test_r4_cipher=
225         {
226         NID_rc4,
227         1,TEST_RC4_KEY_SIZE,0,
228         EVP_CIPH_VARIABLE_LENGTH,
229         test_rc4_init_key,
230         test_rc4_cipher,
231         NULL,
232         sizeof(TEST_RC4_KEY),
233         NULL,
234         NULL,
235         NULL
236         };
237 static const EVP_CIPHER test_r4_40_cipher=
238         {
239         NID_rc4_40,
240         1,5 /* 40 bit */,0,
241         EVP_CIPH_VARIABLE_LENGTH,
242         test_rc4_init_key,
243         test_rc4_cipher,
244         NULL,
245         sizeof(TEST_RC4_KEY),
246         NULL, 
247         NULL,
248         NULL
249         };
250 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
251                         const int **nids, int nid)
252         {
253         if(!cipher)
254                 {
255                 /* We are returning a list of supported nids */
256                 *nids = test_cipher_nids;
257                 return test_cipher_nids_number;
258                 }
259         /* We are being asked for a specific cipher */
260         if(nid == NID_rc4)
261                 *cipher = &test_r4_cipher;
262         else if(nid == NID_rc4_40)
263                 *cipher = &test_r4_40_cipher;
264         else
265                 {
266 #ifdef TEST_ENG_OPENSSL_RC4_OTHERS
267                 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
268                                 "nid %d\n", nid);
269 #endif
270                 *cipher = NULL;
271                 return 0;
272                 }
273         return 1;
274         }
275 #endif
276
277 #ifdef TEST_ENG_OPENSSL_SHA
278 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
279 #include <openssl/sha.h>
280 static int test_digest_nids[] = {NID_sha1};
281 static int test_digest_nids_number = 1;
282 static int test_sha1_init(EVP_MD_CTX *ctx)
283         {
284 #ifdef TEST_ENG_OPENSSL_SHA_P_INIT
285         fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
286 #endif
287         return SHA1_Init(ctx->md_data);
288         }
289 static int test_sha1_update(EVP_MD_CTX *ctx,const void *data,unsigned long count)
290         {
291 #ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
292         fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
293 #endif
294         return SHA1_Update(ctx->md_data,data,count);
295         }
296 static int test_sha1_final(EVP_MD_CTX *ctx,unsigned char *md)
297         {
298 #ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
299         fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
300 #endif
301         return SHA1_Final(md,ctx->md_data);
302         }
303 static const EVP_MD test_sha_md=
304         {
305         NID_sha1,
306         NID_sha1WithRSAEncryption,
307         SHA_DIGEST_LENGTH,
308         0,
309         test_sha1_init,
310         test_sha1_update,
311         test_sha1_final,
312         NULL,
313         NULL,
314         EVP_PKEY_RSA_method,
315         SHA_CBLOCK,
316         sizeof(EVP_MD *)+sizeof(SHA_CTX),
317         };
318 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
319                         const int **nids, int nid)
320         {
321         if(!digest)
322                 {
323                 /* We are returning a list of supported nids */
324                 *nids = test_digest_nids;
325                 return test_digest_nids_number;
326                 }
327         /* We are being asked for a specific digest */
328         if(nid == NID_sha1)
329                 *digest = &test_sha_md;
330         else
331                 {
332 #ifdef TEST_ENG_OPENSSL_SHA_OTHERS
333                 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
334                                 "nid %d\n", nid);
335 #endif
336                 *digest = NULL;
337                 return 0;
338                 }
339         return 1;
340         }
341 #endif
342
343 #ifdef TEST_ENG_OPENSSL_PKEY
344 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
345         UI_METHOD *ui_method, void *callback_data)
346         {
347         BIO *in;
348         EVP_PKEY *key;
349         fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n", key_id);
350         in = BIO_new_file(key_id, "r");
351         if (!in)
352                 return NULL;
353         key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);
354         BIO_free(in);
355         return key;
356         }
357 #endif