Adds warnings about two curves and fixes the "seed" value for two other
[openssl.git] / engines / e_sureware.c
1 /* Written by Corinne Dive-Reclus(cdive@baltimore.com)
2
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer. 
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in
13 *    the documentation and/or other materials provided with the
14 *    distribution.
15 *
16 * 3. All advertising materials mentioning features or use of this
17 *    software must display the following acknowledgment:
18 *    "This product includes software developed by the OpenSSL Project
19 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20 *
21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22 *    endorse or promote products derived from this software without
23 *    prior written permission. For written permission, please contact
24 *    licensing@OpenSSL.org.
25 *
26 * 5. Products derived from this software may not be called "OpenSSL"
27 *    nor may "OpenSSL" appear in their names without prior written
28 *    permission of the OpenSSL Project.
29 *
30 * 6. Redistributions of any form whatsoever must retain the following
31 *    acknowledgment:
32 *    "This product includes software developed by the OpenSSL Project
33 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34 *
35 * Written by Corinne Dive-Reclus(cdive@baltimore.com)
36 *
37 * Copyright@2001 Baltimore Technologies Ltd.
38 * All right Reserved.
39 *                                                                                                                                                                                               *       
40 *               THIS FILE IS PROVIDED BY BALTIMORE TECHNOLOGIES ``AS IS'' AND                                                                                                                                                   *
41 *               ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE                                   * 
42 *               IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE                              *
43 *               ARE DISCLAIMED.  IN NO EVENT SHALL BALTIMORE TECHNOLOGIES BE LIABLE                                             *
44 *               FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL                              *
45 *               DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS                                 *
46 *               OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                                   *
47 *               HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT                              *
48 *               LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY                               *
49 *               OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF                                  *
50 *               SUCH DAMAGE.                                                                                                                                                    *
51 ====================================================================*/
52
53 #include <stdio.h>
54 #include <string.h>
55 #include <openssl/crypto.h>
56 #include <openssl/pem.h>
57 #include <openssl/dso.h>
58 #include <openssl/engine.h>
59
60 #ifndef OPENSSL_NO_HW
61 #ifndef OPENSSL_NO_HW_SUREWARE
62
63 #ifdef FLAT_INC
64 #include "sureware.h"
65 #else
66 #include "vendor_defns/sureware.h"
67 #endif
68
69 #define SUREWARE_LIB_NAME "sureware engine"
70 #include "e_sureware_err.c"
71
72 static int surewarehk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
73 static int surewarehk_destroy(ENGINE *e);
74 static int surewarehk_init(ENGINE *e);
75 static int surewarehk_finish(ENGINE *e);
76 static int surewarehk_modexp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
77         const BIGNUM *m, BN_CTX *ctx);
78
79 /* RSA stuff */
80 static int surewarehk_rsa_priv_dec(int flen,const unsigned char *from,unsigned char *to,
81                         RSA *rsa,int padding);
82 static int surewarehk_rsa_sign(int flen,const unsigned char *from,unsigned char *to,
83                             RSA *rsa,int padding);
84
85 /* RAND stuff */
86 static int surewarehk_rand_bytes(unsigned char *buf, int num);
87 static void surewarehk_rand_seed(const void *buf, int num);
88 static void surewarehk_rand_add(const void *buf, int num, double entropy);
89
90 /* KM stuff */
91 static EVP_PKEY *surewarehk_load_privkey(ENGINE *e, const char *key_id,
92         UI_METHOD *ui_method, void *callback_data);
93 static EVP_PKEY *surewarehk_load_pubkey(ENGINE *e, const char *key_id,
94         UI_METHOD *ui_method, void *callback_data);
95 static void surewarehk_ex_free(void *obj, void *item, CRYPTO_EX_DATA *ad,
96         int idx,long argl, void *argp);
97 #if 0
98 static void surewarehk_dh_ex_free(void *obj, void *item, CRYPTO_EX_DATA *ad,
99         int idx,long argl, void *argp);
100 #endif
101
102 #ifndef OPENSSL_NO_RSA
103 /* This function is aliased to mod_exp (with the mont stuff dropped). */
104 static int surewarehk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
105                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
106 {
107         return surewarehk_modexp(r, a, p, m, ctx);
108 }
109
110 /* Our internal RSA_METHOD that we provide pointers to */
111 static RSA_METHOD surewarehk_rsa =
112         {
113         "SureWare RSA method",
114         NULL, /* pub_enc*/
115         NULL, /* pub_dec*/
116         surewarehk_rsa_sign, /* our rsa_sign is OpenSSL priv_enc*/
117         surewarehk_rsa_priv_dec, /* priv_dec*/
118         NULL, /*mod_exp*/
119         surewarehk_mod_exp_mont, /*mod_exp_mongomery*/
120         NULL, /* init*/
121         NULL, /* finish*/
122         0,      /* RSA flag*/
123         NULL, 
124         NULL, /* OpenSSL sign*/
125         NULL, /* OpenSSL verify*/
126         NULL  /* keygen */
127         };
128 #endif
129
130 #ifndef OPENSSL_NO_DH
131 /* Our internal DH_METHOD that we provide pointers to */
132 /* This function is aliased to mod_exp (with the dh and mont dropped). */
133 static int surewarehk_modexp_dh(const DH *dh, BIGNUM *r, const BIGNUM *a,
134         const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
135 {
136         return surewarehk_modexp(r, a, p, m, ctx);
137 }
138
139 static DH_METHOD surewarehk_dh =
140         {
141         "SureWare DH method",
142         NULL,/*gen_key*/
143         NULL,/*agree,*/
144         surewarehk_modexp_dh, /*dh mod exp*/
145         NULL, /* init*/
146         NULL, /* finish*/
147         0,    /* flags*/
148         NULL,
149         NULL
150         };
151 #endif
152
153 static RAND_METHOD surewarehk_rand =
154         {
155         /* "SureWare RAND method", */
156         surewarehk_rand_seed,
157         surewarehk_rand_bytes,
158         NULL,/*cleanup*/
159         surewarehk_rand_add,
160         surewarehk_rand_bytes,
161         NULL,/*rand_status*/
162         };
163
164 #ifndef OPENSSL_NO_DSA
165 /* DSA stuff */
166 static  DSA_SIG * surewarehk_dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
167 static int surewarehk_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
168                 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
169                 BN_CTX *ctx, BN_MONT_CTX *in_mont)
170 {
171         BIGNUM t;
172         int to_return = 0;
173         BN_init(&t);
174         /* let rr = a1 ^ p1 mod m */
175         if (!surewarehk_modexp(rr,a1,p1,m,ctx)) goto end;
176         /* let t = a2 ^ p2 mod m */
177         if (!surewarehk_modexp(&t,a2,p2,m,ctx)) goto end;
178         /* let rr = rr * t mod m */
179         if (!BN_mod_mul(rr,rr,&t,m,ctx)) goto end;
180         to_return = 1;
181 end:
182         BN_free(&t);
183         return to_return;
184 }
185
186 static DSA_METHOD surewarehk_dsa =
187         {
188          "SureWare DSA method", 
189         surewarehk_dsa_do_sign,
190         NULL,/*sign setup*/
191         NULL,/*verify,*/
192         surewarehk_dsa_mod_exp,/*mod exp*/
193         NULL,/*bn mod exp*/
194         NULL, /*init*/
195         NULL,/*finish*/
196         0,
197         NULL,
198         NULL,
199         NULL
200         };
201 #endif
202
203 static const char *engine_sureware_id = "sureware";
204 static const char *engine_sureware_name = "SureWare hardware engine support";
205
206 /* Now, to our own code */
207
208 /* As this is only ever called once, there's no need for locking
209  * (indeed - the lock will already be held by our caller!!!) */
210 static int bind_sureware(ENGINE *e)
211 {
212 #ifndef OPENSSL_NO_RSA
213         const RSA_METHOD *meth1;
214 #endif
215 #ifndef OPENSSL_NO_DSA
216         const DSA_METHOD *meth2;
217 #endif
218 #ifndef OPENSSL_NO_DH
219         const DH_METHOD *meth3;
220 #endif
221
222         if(!ENGINE_set_id(e, engine_sureware_id) ||
223            !ENGINE_set_name(e, engine_sureware_name) ||
224 #ifndef OPENSSL_NO_RSA
225            !ENGINE_set_RSA(e, &surewarehk_rsa) ||
226 #endif
227 #ifndef OPENSSL_NO_DSA
228            !ENGINE_set_DSA(e, &surewarehk_dsa) ||
229 #endif
230 #ifndef OPENSSL_NO_DH
231            !ENGINE_set_DH(e, &surewarehk_dh) ||
232 #endif
233            !ENGINE_set_RAND(e, &surewarehk_rand) ||
234            !ENGINE_set_destroy_function(e, surewarehk_destroy) ||
235            !ENGINE_set_init_function(e, surewarehk_init) ||
236            !ENGINE_set_finish_function(e, surewarehk_finish) ||
237            !ENGINE_set_ctrl_function(e, surewarehk_ctrl) ||
238            !ENGINE_set_load_privkey_function(e, surewarehk_load_privkey) ||
239            !ENGINE_set_load_pubkey_function(e, surewarehk_load_pubkey))
240           return 0;
241
242 #ifndef OPENSSL_NO_RSA
243         /* We know that the "PKCS1_SSLeay()" functions hook properly
244          * to the cswift-specific mod_exp and mod_exp_crt so we use
245          * those functions. NB: We don't use ENGINE_openssl() or
246          * anything "more generic" because something like the RSAref
247          * code may not hook properly, and if you own one of these
248          * cards then you have the right to do RSA operations on it
249          * anyway! */ 
250         meth1 = RSA_PKCS1_SSLeay();
251         if (meth1)
252         {
253                 surewarehk_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
254                 surewarehk_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
255         }
256 #endif
257
258 #ifndef OPENSSL_NO_DSA
259         /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
260          * bits. */
261         meth2 = DSA_OpenSSL();
262         if (meth2)
263         {
264                 surewarehk_dsa.dsa_do_verify = meth2->dsa_do_verify;
265         }
266 #endif
267
268 #ifndef OPENSSL_NO_DH
269         /* Much the same for Diffie-Hellman */
270         meth3 = DH_OpenSSL();
271         if (meth3)
272         {
273                 surewarehk_dh.generate_key = meth3->generate_key;
274                 surewarehk_dh.compute_key = meth3->compute_key;
275         }
276 #endif
277
278         /* Ensure the sureware error handling is set up */
279         ERR_load_SUREWARE_strings();
280         return 1;
281 }
282
283 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
284 static int bind_helper(ENGINE *e, const char *id)
285         {
286         if(id && (strcmp(id, engine_sureware_id) != 0))
287                 return 0;
288         if(!bind_sureware(e))
289                 return 0;
290         return 1;
291         }       
292 IMPLEMENT_DYNAMIC_CHECK_FN()
293 IMPLEMENT_DYNAMIC_BIND_FN(bind_helper)
294 #else
295 static ENGINE *engine_sureware(void)
296         {
297         ENGINE *ret = ENGINE_new();
298         if(!ret)
299                 return NULL;
300         if(!bind_sureware(ret))
301                 {
302                 ENGINE_free(ret);
303                 return NULL;
304                 }
305         return ret;
306         }
307
308 void ENGINE_load_sureware(void)
309         {
310         /* Copied from eng_[openssl|dyn].c */
311         ENGINE *toadd = engine_sureware();
312         if(!toadd) return;
313         ENGINE_add(toadd);
314         ENGINE_free(toadd);
315         ERR_clear_error();
316         }
317 #endif
318
319 /* This is a process-global DSO handle used for loading and unloading
320  * the SureWareHook library. NB: This is only set (or unset) during an
321  * init() or finish() call (reference counts permitting) and they're
322  * operating with global locks, so this should be thread-safe
323  * implicitly. */
324 static DSO *surewarehk_dso = NULL;
325 #ifndef OPENSSL_NO_RSA
326 static int rsaHndidx = -1;      /* Index for KM handle.  Not really used yet. */
327 #endif
328 #ifndef OPENSSL_NO_DSA
329 static int dsaHndidx = -1;      /* Index for KM handle.  Not really used yet. */
330 #endif
331
332 /* These are the function pointers that are (un)set when the library has
333  * successfully (un)loaded. */
334 static SureWareHook_Init_t *p_surewarehk_Init = NULL;
335 static SureWareHook_Finish_t *p_surewarehk_Finish = NULL;
336 static SureWareHook_Rand_Bytes_t *p_surewarehk_Rand_Bytes = NULL;
337 static SureWareHook_Rand_Seed_t *p_surewarehk_Rand_Seed = NULL;
338 static SureWareHook_Load_Privkey_t *p_surewarehk_Load_Privkey = NULL;
339 static SureWareHook_Info_Pubkey_t *p_surewarehk_Info_Pubkey = NULL;
340 static SureWareHook_Load_Rsa_Pubkey_t *p_surewarehk_Load_Rsa_Pubkey = NULL;
341 static SureWareHook_Load_Dsa_Pubkey_t *p_surewarehk_Load_Dsa_Pubkey = NULL;
342 static SureWareHook_Free_t *p_surewarehk_Free=NULL;
343 static SureWareHook_Rsa_Priv_Dec_t *p_surewarehk_Rsa_Priv_Dec=NULL;
344 static SureWareHook_Rsa_Sign_t *p_surewarehk_Rsa_Sign=NULL;
345 static SureWareHook_Dsa_Sign_t *p_surewarehk_Dsa_Sign=NULL;
346 static SureWareHook_Mod_Exp_t *p_surewarehk_Mod_Exp=NULL;
347
348 /* Used in the DSO operations. */
349 static const char *surewarehk_LIBNAME = "SureWareHook";
350 static const char *n_surewarehk_Init = "SureWareHook_Init";
351 static const char *n_surewarehk_Finish = "SureWareHook_Finish";
352 static const char *n_surewarehk_Rand_Bytes="SureWareHook_Rand_Bytes";
353 static const char *n_surewarehk_Rand_Seed="SureWareHook_Rand_Seed";
354 static const char *n_surewarehk_Load_Privkey="SureWareHook_Load_Privkey";
355 static const char *n_surewarehk_Info_Pubkey="SureWareHook_Info_Pubkey";
356 static const char *n_surewarehk_Load_Rsa_Pubkey="SureWareHook_Load_Rsa_Pubkey";
357 static const char *n_surewarehk_Load_Dsa_Pubkey="SureWareHook_Load_Dsa_Pubkey";
358 static const char *n_surewarehk_Free="SureWareHook_Free";
359 static const char *n_surewarehk_Rsa_Priv_Dec="SureWareHook_Rsa_Priv_Dec";
360 static const char *n_surewarehk_Rsa_Sign="SureWareHook_Rsa_Sign";
361 static const char *n_surewarehk_Dsa_Sign="SureWareHook_Dsa_Sign";
362 static const char *n_surewarehk_Mod_Exp="SureWareHook_Mod_Exp";
363 static BIO *logstream = NULL;
364
365 /* SureWareHook library functions and mechanics - these are used by the
366  * higher-level functions further down. NB: As and where there's no
367  * error checking, take a look lower down where these functions are
368  * called, the checking and error handling is probably down there. 
369 */
370 static int threadsafe=1;
371 static int surewarehk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
372 {
373         int to_return = 1;
374
375         switch(cmd)
376         {
377                 case ENGINE_CTRL_SET_LOGSTREAM:
378                 {
379                         BIO *bio = (BIO *)p;
380                         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
381                         if (logstream)
382                         {
383                                 BIO_free(logstream);
384                                 logstream = NULL;
385                         }
386                         if (CRYPTO_add(&bio->references,1,CRYPTO_LOCK_BIO) > 1)
387                                 logstream = bio;
388                         else
389                                 SUREWAREerr(SUREWARE_F_SUREWAREHK_CTRL,SUREWARE_R_BIO_WAS_FREED);
390                 }
391                 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
392                 break;
393         /* This will prevent the initialisation function from "installing"
394          * the mutex-handling callbacks, even if they are available from
395          * within the library (or were provided to the library from the
396          * calling application). This is to remove any baggage for
397          * applications not using multithreading. */
398         case ENGINE_CTRL_CHIL_NO_LOCKING:
399                 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
400                 threadsafe = 0;
401                 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
402                 break;
403
404         /* The command isn't understood by this engine */
405         default:
406                 SUREWAREerr(SUREWARE_F_SUREWAREHK_CTRL,
407                         ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED);
408                 to_return = 0;
409                 break;
410                 }
411
412         return to_return;
413 }
414
415 /* Destructor (complements the "ENGINE_surewarehk()" constructor) */
416 static int surewarehk_destroy(ENGINE *e)
417 {
418         ERR_unload_SUREWARE_strings();
419         return 1;
420 }
421
422 /* (de)initialisation functions. */
423 static int surewarehk_init(ENGINE *e)
424 {
425         char msg[64]="ENGINE_init";
426         SureWareHook_Init_t *p1=NULL;
427         SureWareHook_Finish_t *p2=NULL;
428         SureWareHook_Rand_Bytes_t *p3=NULL;
429         SureWareHook_Rand_Seed_t *p4=NULL;
430         SureWareHook_Load_Privkey_t *p5=NULL;
431         SureWareHook_Load_Rsa_Pubkey_t *p6=NULL;
432         SureWareHook_Free_t *p7=NULL;
433         SureWareHook_Rsa_Priv_Dec_t *p8=NULL;
434         SureWareHook_Rsa_Sign_t *p9=NULL;
435         SureWareHook_Dsa_Sign_t *p12=NULL;
436         SureWareHook_Info_Pubkey_t *p13=NULL;
437         SureWareHook_Load_Dsa_Pubkey_t *p14=NULL;
438         SureWareHook_Mod_Exp_t *p15=NULL;
439
440         if(surewarehk_dso != NULL)
441         {
442                 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT,ENGINE_R_ALREADY_LOADED);
443                 goto err;
444         }
445         /* Attempt to load libsurewarehk.so/surewarehk.dll/whatever. */
446         surewarehk_dso = DSO_load(NULL, surewarehk_LIBNAME, NULL, 0);
447         if(surewarehk_dso == NULL)
448         {
449                 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT,ENGINE_R_DSO_FAILURE);
450                 goto err;
451         }
452         if(!(p1=(SureWareHook_Init_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Init)) ||
453            !(p2=(SureWareHook_Finish_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Finish)) ||
454            !(p3=(SureWareHook_Rand_Bytes_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Rand_Bytes)) ||
455            !(p4=(SureWareHook_Rand_Seed_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Rand_Seed)) ||
456            !(p5=(SureWareHook_Load_Privkey_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Load_Privkey)) ||
457            !(p6=(SureWareHook_Load_Rsa_Pubkey_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Load_Rsa_Pubkey)) ||
458            !(p7=(SureWareHook_Free_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Free)) ||
459            !(p8=(SureWareHook_Rsa_Priv_Dec_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Rsa_Priv_Dec)) ||
460            !(p9=(SureWareHook_Rsa_Sign_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Rsa_Sign)) ||
461            !(p12=(SureWareHook_Dsa_Sign_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Dsa_Sign)) ||
462            !(p13=(SureWareHook_Info_Pubkey_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Info_Pubkey)) ||
463            !(p14=(SureWareHook_Load_Dsa_Pubkey_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Load_Dsa_Pubkey)) ||
464            !(p15=(SureWareHook_Mod_Exp_t*)DSO_bind_func(surewarehk_dso, n_surewarehk_Mod_Exp)))
465         {
466                 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT,ENGINE_R_DSO_FAILURE);
467                 goto err;
468         }
469         /* Copy the pointers */
470         p_surewarehk_Init = p1;
471         p_surewarehk_Finish = p2;
472         p_surewarehk_Rand_Bytes = p3;
473         p_surewarehk_Rand_Seed = p4;
474         p_surewarehk_Load_Privkey = p5;
475         p_surewarehk_Load_Rsa_Pubkey = p6;
476         p_surewarehk_Free = p7;
477         p_surewarehk_Rsa_Priv_Dec = p8;
478         p_surewarehk_Rsa_Sign = p9;
479         p_surewarehk_Dsa_Sign = p12;
480         p_surewarehk_Info_Pubkey = p13;
481         p_surewarehk_Load_Dsa_Pubkey = p14;
482         p_surewarehk_Mod_Exp = p15;
483         /* Contact the hardware and initialises it. */
484         if(p_surewarehk_Init(msg,threadsafe)==SUREWAREHOOK_ERROR_UNIT_FAILURE)
485         {
486                 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT,SUREWARE_R_UNIT_FAILURE);
487                 goto err;
488         }
489         if(p_surewarehk_Init(msg,threadsafe)==SUREWAREHOOK_ERROR_UNIT_FAILURE)
490         {
491                 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT,SUREWARE_R_UNIT_FAILURE);
492                 goto err;
493         }
494         /* try to load the default private key, if failed does not return a failure but
495            wait for an explicit ENGINE_load_privakey */
496         surewarehk_load_privkey(e,NULL,NULL,NULL);
497
498         /* Everything's fine. */
499 #ifndef OPENSSL_NO_RSA
500         if (rsaHndidx == -1)
501                 rsaHndidx = RSA_get_ex_new_index(0,
502                                                 "SureWareHook RSA key handle",
503                                                 NULL, NULL, surewarehk_ex_free);
504 #endif
505 #ifndef OPENSSL_NO_DSA
506         if (dsaHndidx == -1)
507                 dsaHndidx = DSA_get_ex_new_index(0,
508                                                 "SureWareHook DSA key handle",
509                                                 NULL, NULL, surewarehk_ex_free);
510 #endif
511
512         return 1;
513 err:
514         if(surewarehk_dso)
515                 DSO_free(surewarehk_dso);
516         surewarehk_dso = NULL;
517         p_surewarehk_Init = NULL;
518         p_surewarehk_Finish = NULL;
519         p_surewarehk_Rand_Bytes = NULL;
520         p_surewarehk_Rand_Seed = NULL;
521         p_surewarehk_Load_Privkey = NULL;
522         p_surewarehk_Load_Rsa_Pubkey = NULL;
523         p_surewarehk_Free = NULL;
524         p_surewarehk_Rsa_Priv_Dec = NULL;
525         p_surewarehk_Rsa_Sign = NULL;
526         p_surewarehk_Dsa_Sign = NULL;
527         p_surewarehk_Info_Pubkey = NULL;
528         p_surewarehk_Load_Dsa_Pubkey = NULL;
529         p_surewarehk_Mod_Exp = NULL;
530         return 0;
531 }
532
533 static int surewarehk_finish(ENGINE *e)
534 {
535         int to_return = 1;
536         if(surewarehk_dso == NULL)
537                 {
538                 SUREWAREerr(SUREWARE_F_SUREWAREHK_FINISH,ENGINE_R_NOT_LOADED);
539                 to_return = 0;
540                 goto err;
541                 }
542         p_surewarehk_Finish();
543         if(!DSO_free(surewarehk_dso))
544                 {
545                 SUREWAREerr(SUREWARE_F_SUREWAREHK_FINISH,ENGINE_R_DSO_FAILURE);
546                 to_return = 0;
547                 goto err;
548                 }
549  err:
550         if (logstream)
551                 BIO_free(logstream);
552         surewarehk_dso = NULL;
553         p_surewarehk_Init = NULL;
554         p_surewarehk_Finish = NULL;
555         p_surewarehk_Rand_Bytes = NULL;
556         p_surewarehk_Rand_Seed = NULL;
557         p_surewarehk_Load_Privkey = NULL;
558         p_surewarehk_Load_Rsa_Pubkey = NULL;
559         p_surewarehk_Free = NULL;
560         p_surewarehk_Rsa_Priv_Dec = NULL;
561         p_surewarehk_Rsa_Sign = NULL;
562         p_surewarehk_Dsa_Sign = NULL;
563         p_surewarehk_Info_Pubkey = NULL;
564         p_surewarehk_Load_Dsa_Pubkey = NULL;
565         p_surewarehk_Mod_Exp = NULL;
566         return to_return;
567 }
568
569 static void surewarehk_error_handling(char *const msg,int func,int ret)
570 {
571         switch (ret)
572         {
573                 case SUREWAREHOOK_ERROR_UNIT_FAILURE:
574                         ENGINEerr(func,SUREWARE_R_UNIT_FAILURE);
575                         break;
576                 case SUREWAREHOOK_ERROR_FALLBACK:
577                         ENGINEerr(func,SUREWARE_R_REQUEST_FALLBACK);
578                         break;
579                 case SUREWAREHOOK_ERROR_DATA_SIZE:
580                         ENGINEerr(func,SUREWARE_R_SIZE_TOO_LARGE_OR_TOO_SMALL);
581                         break;
582                 case SUREWAREHOOK_ERROR_INVALID_PAD:
583                         ENGINEerr(func,RSA_R_PADDING_CHECK_FAILED);
584                         break;
585                 default:
586                         ENGINEerr(func,SUREWARE_R_REQUEST_FAILED);
587                         break;
588                 case 1:/*nothing*/
589                         msg[0]='\0';
590         }
591         if (*msg)
592         {
593                 ERR_add_error_data(1,msg);
594                 if (logstream)
595                 {
596                         CRYPTO_w_lock(CRYPTO_LOCK_BIO);
597                         BIO_write(logstream, msg, strlen(msg));
598                         CRYPTO_w_unlock(CRYPTO_LOCK_BIO);
599                 }
600         }
601 }
602
603 static int surewarehk_rand_bytes(unsigned char *buf, int num)
604 {
605         int ret=0;
606         char msg[64]="ENGINE_rand_bytes";
607         if(!p_surewarehk_Rand_Bytes)
608         {
609                 SUREWAREerr(SUREWARE_F_SUREWAREHK_RAND_BYTES,ENGINE_R_NOT_INITIALISED);
610         }
611         else
612         {
613                 ret = p_surewarehk_Rand_Bytes(msg,buf, num);
614                 surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_RAND_BYTES,ret);
615         }
616         return ret==1 ? 1 : 0;
617 }
618
619 static void surewarehk_rand_seed(const void *buf, int num)
620 {
621         int ret=0;
622         char msg[64]="ENGINE_rand_seed";
623         if(!p_surewarehk_Rand_Seed)
624         {
625                 SUREWAREerr(SUREWARE_F_SUREWAREHK_RAND_SEED,ENGINE_R_NOT_INITIALISED);
626         }
627         else
628         {
629                 ret = p_surewarehk_Rand_Seed(msg,buf, num);
630                 surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_RAND_SEED,ret);
631         }
632 }
633
634 static void surewarehk_rand_add(const void *buf, int num, double entropy)
635 {
636         surewarehk_rand_seed(buf,num);
637 }
638
639 static EVP_PKEY* sureware_load_public(ENGINE *e,const char *key_id,char *hptr,unsigned long el,char keytype)
640 {
641         EVP_PKEY *res = NULL;
642 #ifndef OPENSSL_NO_RSA
643         RSA *rsatmp = NULL;
644 #endif
645 #ifndef OPENSSL_NO_DSA
646         DSA *dsatmp=NULL;
647 #endif
648         char msg[64]="sureware_load_public";
649         int ret=0;
650         if(!p_surewarehk_Load_Rsa_Pubkey || !p_surewarehk_Load_Dsa_Pubkey)
651         {
652                 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PUBLIC_KEY,ENGINE_R_NOT_INITIALISED);
653                 goto err;
654         }
655         switch (keytype)
656         {
657 #ifndef OPENSSL_NO_RSA
658         case 1: /*RSA*/
659                 /* set private external reference */
660                 rsatmp = RSA_new_method(e);
661                 RSA_set_ex_data(rsatmp,rsaHndidx,hptr);
662                 rsatmp->flags |= RSA_FLAG_EXT_PKEY;
663
664                 /* set public big nums*/
665                 rsatmp->e = BN_new();
666                 rsatmp->n = BN_new();
667                 bn_expand2(rsatmp->e, el/sizeof(BN_ULONG));
668                 bn_expand2(rsatmp->n, el/sizeof(BN_ULONG));
669                 if (!rsatmp->e || rsatmp->e->dmax!=(int)(el/sizeof(BN_ULONG))|| 
670                         !rsatmp->n || rsatmp->n->dmax!=(int)(el/sizeof(BN_ULONG)))
671                         goto err;
672                 ret=p_surewarehk_Load_Rsa_Pubkey(msg,key_id,el,
673                                                  (unsigned long *)rsatmp->n->d,
674                                                  (unsigned long *)rsatmp->e->d);
675                 surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_LOAD_PUBLIC_KEY,ret);
676                 if (ret!=1)
677                 {
678                         SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PRIVATE_KEY,ENGINE_R_FAILED_LOADING_PUBLIC_KEY);
679                         goto err;
680                 }
681                 /* normalise pub e and pub n */
682                 rsatmp->e->top=el/sizeof(BN_ULONG);
683                 bn_fix_top(rsatmp->e);
684                 rsatmp->n->top=el/sizeof(BN_ULONG);
685                 bn_fix_top(rsatmp->n);
686                 /* create an EVP object: engine + rsa key */
687                 res = EVP_PKEY_new();
688                 EVP_PKEY_assign_RSA(res, rsatmp);
689                 break;
690 #endif
691
692 #ifndef OPENSSL_NO_DSA
693         case 2:/*DSA*/
694                 /* set private/public external reference */
695                 dsatmp = DSA_new_method(e);
696                 DSA_set_ex_data(dsatmp,dsaHndidx,hptr);
697                 /*dsatmp->flags |= DSA_FLAG_EXT_PKEY;*/
698
699                 /* set public key*/
700                 dsatmp->pub_key = BN_new();
701                 dsatmp->p = BN_new();
702                 dsatmp->q = BN_new();
703                 dsatmp->g = BN_new();
704                 bn_expand2(dsatmp->pub_key, el/sizeof(BN_ULONG));
705                 bn_expand2(dsatmp->p, el/sizeof(BN_ULONG));
706                 bn_expand2(dsatmp->q, 20/sizeof(BN_ULONG));
707                 bn_expand2(dsatmp->g, el/sizeof(BN_ULONG));
708                 if (!dsatmp->pub_key || dsatmp->pub_key->dmax!=(int)(el/sizeof(BN_ULONG))|| 
709                         !dsatmp->p || dsatmp->p->dmax!=(int)(el/sizeof(BN_ULONG)) ||
710                         !dsatmp->q || dsatmp->q->dmax!=20/sizeof(BN_ULONG) ||
711                         !dsatmp->g || dsatmp->g->dmax!=(int)(el/sizeof(BN_ULONG)))
712                         goto err;
713
714                 ret=p_surewarehk_Load_Dsa_Pubkey(msg,key_id,el,
715                                                  (unsigned long *)dsatmp->pub_key->d, 
716                                                  (unsigned long *)dsatmp->p->d,
717                                                  (unsigned long *)dsatmp->q->d,
718                                                  (unsigned long *)dsatmp->g->d);
719                 surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_LOAD_PUBLIC_KEY,ret);
720                 if (ret!=1)
721                 {
722                         SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PRIVATE_KEY,ENGINE_R_FAILED_LOADING_PUBLIC_KEY);
723                         goto err;
724                 }
725                 /* set parameters */
726                 /* normalise pubkey and parameters in case of */
727                 dsatmp->pub_key->top=el/sizeof(BN_ULONG);
728                 bn_fix_top(dsatmp->pub_key);
729                 dsatmp->p->top=el/sizeof(BN_ULONG);
730                 bn_fix_top(dsatmp->p);
731                 dsatmp->q->top=20/sizeof(BN_ULONG);
732                 bn_fix_top(dsatmp->q);
733                 dsatmp->g->top=el/sizeof(BN_ULONG);
734                 bn_fix_top(dsatmp->g);
735
736                 /* create an EVP object: engine + rsa key */
737                 res = EVP_PKEY_new();
738                 EVP_PKEY_assign_DSA(res, dsatmp);
739                 break;
740 #endif
741
742         default:
743                 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PRIVATE_KEY,ENGINE_R_FAILED_LOADING_PRIVATE_KEY);
744                 goto err;
745         }
746         return res;
747  err:
748         if (res)
749                 EVP_PKEY_free(res);
750 #ifndef OPENSSL_NO_RSA
751         if (rsatmp)
752                 RSA_free(rsatmp);
753 #endif
754 #ifndef OPENSSL_NO_DSA
755         if (dsatmp)
756                 DSA_free(dsatmp);
757 #endif
758         return NULL;
759 }
760
761 static EVP_PKEY *surewarehk_load_privkey(ENGINE *e, const char *key_id,
762                                          UI_METHOD *ui_method, void *callback_data)
763 {
764         EVP_PKEY *res = NULL;
765         int ret=0;
766         unsigned long el=0;
767         char *hptr=NULL;
768         char keytype=0;
769         char msg[64]="ENGINE_load_privkey";
770
771         if(!p_surewarehk_Load_Privkey)
772         {
773                 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PRIVATE_KEY,ENGINE_R_NOT_INITIALISED);
774         }
775         else
776         {
777                 ret=p_surewarehk_Load_Privkey(msg,key_id,&hptr,&el,&keytype);
778                 if (ret!=1)
779                 {
780                         SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PRIVATE_KEY,ENGINE_R_FAILED_LOADING_PRIVATE_KEY);
781                         ERR_add_error_data(1,msg);              
782                 }
783                 else
784                         res=sureware_load_public(e,key_id,hptr,el,keytype);
785         }
786         return res;
787 }
788
789 static EVP_PKEY *surewarehk_load_pubkey(ENGINE *e, const char *key_id,
790                                          UI_METHOD *ui_method, void *callback_data)
791 {
792         EVP_PKEY *res = NULL;
793         int ret=0;
794         unsigned long el=0;
795         char *hptr=NULL;
796         char keytype=0;
797         char msg[64]="ENGINE_load_pubkey";
798
799         if(!p_surewarehk_Info_Pubkey)
800         {
801                 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PUBLIC_KEY,ENGINE_R_NOT_INITIALISED);
802         }
803         else
804         {
805                 /* call once to identify if DSA or RSA */
806                 ret=p_surewarehk_Info_Pubkey(msg,key_id,&el,&keytype);
807                 if (ret!=1)
808                 {
809                         SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PUBLIC_KEY,ENGINE_R_FAILED_LOADING_PUBLIC_KEY);
810                         ERR_add_error_data(1,msg);
811                 }
812                 else
813                         res=sureware_load_public(e,key_id,hptr,el,keytype);
814         }
815         return res;
816 }
817
818 /* This cleans up an RSA/DSA KM key(do not destroy the key into the hardware)
819 , called when ex_data is freed */
820 static void surewarehk_ex_free(void *obj, void *item, CRYPTO_EX_DATA *ad,
821         int idx,long argl, void *argp)
822 {
823         if(!p_surewarehk_Free)
824         {
825                 SUREWAREerr(SUREWARE_F_SUREWAREHK_EX_FREE,ENGINE_R_NOT_INITIALISED);
826         }
827         else
828                 p_surewarehk_Free((char *)item,0);
829 }
830
831 #if 0
832 /* not currently used (bug?) */
833 /* This cleans up an DH KM key (destroys the key into hardware), 
834 called when ex_data is freed */
835 static void surewarehk_dh_ex_free(void *obj, void *item, CRYPTO_EX_DATA *ad,
836         int idx,long argl, void *argp)
837 {
838         if(!p_surewarehk_Free)
839         {
840                 SUREWAREerr(SUREWARE_F_SUREWAREHK_EX_FREE,ENGINE_R_NOT_INITIALISED);
841         }
842         else
843                 p_surewarehk_Free((char *)item,1);
844 }
845 #endif
846
847 /*
848 * return number of decrypted bytes
849 */
850 #ifndef OPENSSL_NO_RSA
851 static int surewarehk_rsa_priv_dec(int flen,const unsigned char *from,unsigned char *to,
852                         RSA *rsa,int padding)
853 {
854         int ret=0,tlen;
855         char *buf=NULL,*hptr=NULL;
856         char msg[64]="ENGINE_rsa_priv_dec";
857         if (!p_surewarehk_Rsa_Priv_Dec)
858         {
859                 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC,ENGINE_R_NOT_INITIALISED);
860         }
861         /* extract ref to private key */
862         else if (!(hptr=RSA_get_ex_data(rsa, rsaHndidx)))
863         {
864                 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC,SUREWARE_R_MISSING_KEY_COMPONENTS);
865                 goto err;
866         }
867         /* analyse what padding we can do into the hardware */
868         if (padding==RSA_PKCS1_PADDING)
869         {
870                 /* do it one shot */
871                 ret=p_surewarehk_Rsa_Priv_Dec(msg,flen,(unsigned char *)from,&tlen,to,hptr,SUREWARE_PKCS1_PAD);
872                 surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC,ret);
873                 if (ret!=1)
874                         goto err;
875                 ret=tlen;
876         }
877         else /* do with no padding into hardware */
878         {
879                 ret=p_surewarehk_Rsa_Priv_Dec(msg,flen,(unsigned char *)from,&tlen,to,hptr,SUREWARE_NO_PAD);
880                 surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC,ret);
881                 if (ret!=1)
882                         goto err;
883                 /* intermediate buffer for padding */
884                 if ((buf=OPENSSL_malloc(tlen)) == NULL)
885                 {
886                         RSAerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC,ERR_R_MALLOC_FAILURE);
887                         goto err;
888                 }
889                 memcpy(buf,to,tlen);/* transfert to into buf */
890                 switch (padding) /* check padding in software */
891                 {
892 #ifndef OPENSSL_NO_SHA
893                 case RSA_PKCS1_OAEP_PADDING:
894                         ret=RSA_padding_check_PKCS1_OAEP(to,tlen,(unsigned char *)buf,tlen,tlen,NULL,0);
895                         break;
896 #endif
897                 case RSA_SSLV23_PADDING:
898                         ret=RSA_padding_check_SSLv23(to,tlen,(unsigned char *)buf,flen,tlen);
899                         break;
900                 case RSA_NO_PADDING:
901                         ret=RSA_padding_check_none(to,tlen,(unsigned char *)buf,flen,tlen);
902                         break;
903                 default:
904                         RSAerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC,RSA_R_UNKNOWN_PADDING_TYPE);
905                         goto err;
906                 }
907                 if (ret < 0)
908                         RSAerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC,RSA_R_PADDING_CHECK_FAILED);
909         }
910 err:
911         if (buf)
912         {
913                 OPENSSL_cleanse(buf,tlen);
914                 OPENSSL_free(buf);
915         }
916         return ret;
917 }
918
919 /*
920 * Does what OpenSSL rsa_priv_enc does.
921 */
922 static int surewarehk_rsa_sign(int flen,const unsigned char *from,unsigned char *to,
923                             RSA *rsa,int padding)
924 {
925         int ret=0,tlen;
926         char *hptr=NULL;
927         char msg[64]="ENGINE_rsa_sign";
928         if (!p_surewarehk_Rsa_Sign)
929         {
930                 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_ENC,ENGINE_R_NOT_INITIALISED);
931         }
932         /* extract ref to private key */
933         else if (!(hptr=RSA_get_ex_data(rsa, rsaHndidx)))
934         {
935                 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_ENC,SUREWARE_R_MISSING_KEY_COMPONENTS);
936         }
937         else
938         {
939                 switch (padding)
940                 {
941                 case RSA_PKCS1_PADDING: /* do it in one shot */
942                         ret=p_surewarehk_Rsa_Sign(msg,flen,(unsigned char *)from,&tlen,to,hptr,SUREWARE_PKCS1_PAD);
943                         surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_RSA_PRIV_ENC,ret);
944                         break;
945                 case RSA_NO_PADDING:
946                 default:
947                         RSAerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_ENC,RSA_R_UNKNOWN_PADDING_TYPE);
948                 }
949         }
950         return ret==1 ? tlen : ret;
951 }
952
953 #endif
954
955 #ifndef OPENSSL_NO_DSA
956 /* DSA sign and verify */
957 static  DSA_SIG * surewarehk_dsa_do_sign(const unsigned char *from, int flen, DSA *dsa)
958 {
959         int ret=0;
960         char *hptr=NULL;
961         DSA_SIG *psign=NULL;
962         char msg[64]="ENGINE_dsa_do_sign";
963         if (!p_surewarehk_Dsa_Sign)
964         {
965                 SUREWAREerr(SUREWARE_F_SUREWAREHK_DSA_DO_SIGN,ENGINE_R_NOT_INITIALISED);
966         }
967         /* extract ref to private key */
968         else if (!(hptr=DSA_get_ex_data(dsa, dsaHndidx)))
969         {
970                 SUREWAREerr(SUREWARE_F_SUREWAREHK_DSA_DO_SIGN,SUREWARE_R_MISSING_KEY_COMPONENTS);
971         }
972         else
973         {
974                 if((psign = DSA_SIG_new()) == NULL)
975                 {
976                         SUREWAREerr(SUREWARE_F_SUREWAREHK_DSA_DO_SIGN,ERR_R_MALLOC_FAILURE);
977                         goto err;
978                 }
979                 psign->r=BN_new();
980                 psign->s=BN_new();
981                 bn_expand2(psign->r, 20/sizeof(BN_ULONG));
982                 bn_expand2(psign->s, 20/sizeof(BN_ULONG));
983                 if (!psign->r || psign->r->dmax!=20/sizeof(BN_ULONG) ||
984                         !psign->s || psign->s->dmax!=20/sizeof(BN_ULONG))
985                         goto err;
986                 ret=p_surewarehk_Dsa_Sign(msg,flen,from,
987                                           (unsigned long *)psign->r->d,
988                                           (unsigned long *)psign->s->d,
989                                           hptr);
990                 surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_DSA_DO_SIGN,ret);
991         }
992         psign->r->top=20/sizeof(BN_ULONG);
993         bn_fix_top(psign->r);
994         psign->s->top=20/sizeof(BN_ULONG);
995         bn_fix_top(psign->s);
996
997 err:    
998         if (psign)
999         {
1000                 DSA_SIG_free(psign);
1001                 psign=NULL;
1002         }
1003         return psign;
1004 }
1005 #endif
1006
1007 static int surewarehk_modexp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
1008                              const BIGNUM *m, BN_CTX *ctx)
1009 {
1010         int ret=0;
1011         char msg[64]="ENGINE_modexp";
1012         if (!p_surewarehk_Mod_Exp)
1013         {
1014                 SUREWAREerr(SUREWARE_F_SUREWAREHK_MOD_EXP,ENGINE_R_NOT_INITIALISED);
1015         }
1016         else
1017         {
1018                 bn_expand2(r,m->top);
1019                 if (r && r->dmax==m->top)
1020                 {
1021                         /* do it*/
1022                         ret=p_surewarehk_Mod_Exp(msg,
1023                                                  m->top*sizeof(BN_ULONG),
1024                                                  (unsigned long *)m->d,
1025                                                  p->top*sizeof(BN_ULONG),
1026                                                  (unsigned long *)p->d,
1027                                                  a->top*sizeof(BN_ULONG),
1028                                                  (unsigned long *)a->d,
1029                                                  (unsigned long *)r->d);
1030                         surewarehk_error_handling(msg,SUREWARE_F_SUREWAREHK_MOD_EXP,ret);
1031                         if (ret==1)
1032                         {
1033                                 /* normalise result */
1034                                 r->top=m->top;
1035                                 bn_fix_top(r);
1036                         }
1037                 }
1038         }
1039         return ret;
1040 }
1041 #endif /* !OPENSSL_NO_HW_SureWare */
1042 #endif /* !OPENSSL_NO_HW */