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