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