By adding a BN_CTX parameter to the 'rsa_mod_exp' callback, private key
[openssl.git] / engines / e_ubsec.c
1 /* crypto/engine/hw_ubsec.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
3  * project 2000.
4  *
5  * Cloned shamelessly by Joe Tardo. 
6  */
7 /* ====================================================================
8  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer. 
16  *
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in
19  *    the documentation and/or other materials provided with the
20  *    distribution.
21  *
22  * 3. All advertising materials mentioning features or use of this
23  *    software must display the following acknowledgment:
24  *    "This product includes software developed by the OpenSSL Project
25  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26  *
27  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
28  *    endorse or promote products derived from this software without
29  *    prior written permission. For written permission, please contact
30  *    licensing@OpenSSL.org.
31  *
32  * 5. Products derived from this software may not be called "OpenSSL"
33  *    nor may "OpenSSL" appear in their names without prior written
34  *    permission of the OpenSSL Project.
35  *
36  * 6. Redistributions of any form whatsoever must retain the following
37  *    acknowledgment:
38  *    "This product includes software developed by the OpenSSL Project
39  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
42  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
44  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
47  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
48  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
50  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
51  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
52  * OF THE POSSIBILITY OF SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This product includes cryptographic software written by Eric Young
56  * (eay@cryptsoft.com).  This product includes software written by Tim
57  * Hudson (tjh@cryptsoft.com).
58  *
59  */
60
61 #include <stdio.h>
62 #include <string.h>
63 #include <openssl/crypto.h>
64 #include <openssl/buffer.h>
65 #include <openssl/dso.h>
66 #include <openssl/engine.h>
67
68 #ifndef OPENSSL_NO_HW
69 #ifndef OPENSSL_NO_HW_UBSEC
70
71 #ifdef FLAT_INC
72 #include "hw_ubsec.h"
73 #else
74 #include "vendor_defns/hw_ubsec.h"
75 #endif
76
77 #define UBSEC_LIB_NAME "ubsec engine"
78 #include "e_ubsec_err.c"
79
80 #define FAIL_TO_SOFTWARE -15
81
82 static int ubsec_destroy(ENGINE *e);
83 static int ubsec_init(ENGINE *e);
84 static int ubsec_finish(ENGINE *e);
85 static int ubsec_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
86 static int ubsec_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
87                 const BIGNUM *m, BN_CTX *ctx);
88 static int ubsec_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
89                         const BIGNUM *q, const BIGNUM *dp,
90                         const BIGNUM *dq, const BIGNUM *qinv, BN_CTX *ctx);
91 #ifndef OPENSSL_NO_RSA
92 static int ubsec_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
93 #endif
94 static int ubsec_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
95                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
96 #ifndef OPENSSL_NO_DSA
97 #ifdef NOT_USED
98 static int ubsec_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
99                 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
100                 BN_CTX *ctx, BN_MONT_CTX *in_mont);
101 static int ubsec_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
102                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
103                 BN_MONT_CTX *m_ctx);
104 #endif
105 static DSA_SIG *ubsec_dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
106 static int ubsec_dsa_verify(const unsigned char *dgst, int dgst_len,
107                                 DSA_SIG *sig, DSA *dsa);
108 #endif
109 #ifndef OPENSSL_NO_DH
110 static int ubsec_mod_exp_dh(const DH *dh, BIGNUM *r, const BIGNUM *a,
111                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
112                 BN_MONT_CTX *m_ctx);
113 static int ubsec_dh_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
114 static int ubsec_dh_generate_key(DH *dh);
115 #endif
116
117 #ifdef NOT_USED
118 static int ubsec_rand_bytes(unsigned char *buf, int num);
119 static int ubsec_rand_status(void);
120 #endif
121
122 #define UBSEC_CMD_SO_PATH               ENGINE_CMD_BASE
123 static const ENGINE_CMD_DEFN ubsec_cmd_defns[] = {
124         {UBSEC_CMD_SO_PATH,
125                 "SO_PATH",
126                 "Specifies the path to the 'ubsec' shared library",
127                 ENGINE_CMD_FLAG_STRING},
128         {0, NULL, NULL, 0}
129         };
130
131 #ifndef OPENSSL_NO_RSA
132 /* Our internal RSA_METHOD that we provide pointers to */
133 static RSA_METHOD ubsec_rsa =
134         {
135         "UBSEC RSA method",
136         NULL,
137         NULL,
138         NULL,
139         NULL,
140         ubsec_rsa_mod_exp,
141         ubsec_mod_exp_mont,
142         NULL,
143         NULL,
144         0,
145         NULL,
146         NULL,
147         NULL,
148         NULL
149         };
150 #endif
151
152 #ifndef OPENSSL_NO_DSA
153 /* Our internal DSA_METHOD that we provide pointers to */
154 static DSA_METHOD ubsec_dsa =
155         {
156         "UBSEC DSA method",
157         ubsec_dsa_do_sign, /* dsa_do_sign */
158         NULL, /* dsa_sign_setup */
159         ubsec_dsa_verify, /* dsa_do_verify */
160         NULL, /* ubsec_dsa_mod_exp */ /* dsa_mod_exp */
161         NULL, /* ubsec_mod_exp_dsa */ /* bn_mod_exp */
162         NULL, /* init */
163         NULL, /* finish */
164         0, /* flags */
165         NULL, /* app_data */
166         NULL, /* dsa_paramgen */
167         NULL /* dsa_keygen */
168         };
169 #endif
170
171 #ifndef OPENSSL_NO_DH
172 /* Our internal DH_METHOD that we provide pointers to */
173 static DH_METHOD ubsec_dh =
174         {
175         "UBSEC DH method",
176         ubsec_dh_generate_key,
177         ubsec_dh_compute_key,
178         ubsec_mod_exp_dh,
179         NULL,
180         NULL,
181         0,
182         NULL,
183         NULL
184         };
185 #endif
186
187 /* Constants used when creating the ENGINE */
188 static const char *engine_ubsec_id = "ubsec";
189 static const char *engine_ubsec_name = "UBSEC hardware engine support";
190
191 /* This internal function is used by ENGINE_ubsec() and possibly by the
192  * "dynamic" ENGINE support too */
193 static int bind_helper(ENGINE *e)
194         {
195 #ifndef OPENSSL_NO_RSA
196         const RSA_METHOD *meth1;
197 #endif
198 #ifndef OPENSSL_NO_DH
199 #ifndef HAVE_UBSEC_DH
200         const DH_METHOD *meth3;
201 #endif /* HAVE_UBSEC_DH */
202 #endif
203         if(!ENGINE_set_id(e, engine_ubsec_id) ||
204                         !ENGINE_set_name(e, engine_ubsec_name) ||
205 #ifndef OPENSSL_NO_RSA
206                         !ENGINE_set_RSA(e, &ubsec_rsa) ||
207 #endif
208 #ifndef OPENSSL_NO_DSA
209                         !ENGINE_set_DSA(e, &ubsec_dsa) ||
210 #endif
211 #ifndef OPENSSL_NO_DH
212                         !ENGINE_set_DH(e, &ubsec_dh) ||
213 #endif
214                         !ENGINE_set_destroy_function(e, ubsec_destroy) ||
215                         !ENGINE_set_init_function(e, ubsec_init) ||
216                         !ENGINE_set_finish_function(e, ubsec_finish) ||
217                         !ENGINE_set_ctrl_function(e, ubsec_ctrl) ||
218                         !ENGINE_set_cmd_defns(e, ubsec_cmd_defns))
219                 return 0;
220
221 #ifndef OPENSSL_NO_RSA
222         /* We know that the "PKCS1_SSLeay()" functions hook properly
223          * to the Broadcom-specific mod_exp and mod_exp_crt so we use
224          * those functions. NB: We don't use ENGINE_openssl() or
225          * anything "more generic" because something like the RSAref
226          * code may not hook properly, and if you own one of these
227          * cards then you have the right to do RSA operations on it
228          * anyway! */ 
229         meth1 = RSA_PKCS1_SSLeay();
230         ubsec_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
231         ubsec_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
232         ubsec_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
233         ubsec_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
234 #endif
235
236 #ifndef OPENSSL_NO_DH
237 #ifndef HAVE_UBSEC_DH
238         /* Much the same for Diffie-Hellman */
239         meth3 = DH_OpenSSL();
240         ubsec_dh.generate_key = meth3->generate_key;
241         ubsec_dh.compute_key = meth3->compute_key;
242 #endif /* HAVE_UBSEC_DH */
243 #endif
244
245         /* Ensure the ubsec error handling is set up */
246         ERR_load_UBSEC_strings();
247         return 1;
248         }
249
250 #ifdef OPENSSL_NO_DYNAMIC_ENGINE
251 static ENGINE *engine_ubsec(void)
252         {
253         ENGINE *ret = ENGINE_new();
254         if(!ret)
255                 return NULL;
256         if(!bind_helper(ret))
257                 {
258                 ENGINE_free(ret);
259                 return NULL;
260                 }
261         return ret;
262         }
263
264 void ENGINE_load_ubsec(void)
265         {
266         /* Copied from eng_[openssl|dyn].c */
267         ENGINE *toadd = engine_ubsec();
268         if(!toadd) return;
269         ENGINE_add(toadd);
270         ENGINE_free(toadd);
271         ERR_clear_error();
272         }
273 #endif
274
275 /* This is a process-global DSO handle used for loading and unloading
276  * the UBSEC library. NB: This is only set (or unset) during an
277  * init() or finish() call (reference counts permitting) and they're
278  * operating with global locks, so this should be thread-safe
279  * implicitly. */
280
281 static DSO *ubsec_dso = NULL;
282
283 /* These are the function pointers that are (un)set when the library has
284  * successfully (un)loaded. */
285
286 static t_UBSEC_ubsec_bytes_to_bits *p_UBSEC_ubsec_bytes_to_bits = NULL;
287 static t_UBSEC_ubsec_bits_to_bytes *p_UBSEC_ubsec_bits_to_bytes = NULL;
288 static t_UBSEC_ubsec_open *p_UBSEC_ubsec_open = NULL;
289 static t_UBSEC_ubsec_close *p_UBSEC_ubsec_close = NULL;
290 #ifndef OPENSSL_NO_DH
291 static t_UBSEC_diffie_hellman_generate_ioctl 
292         *p_UBSEC_diffie_hellman_generate_ioctl = NULL;
293 static t_UBSEC_diffie_hellman_agree_ioctl *p_UBSEC_diffie_hellman_agree_ioctl = NULL;
294 #endif
295 /* #ifndef OPENSSL_NO_RSA */
296 static t_UBSEC_rsa_mod_exp_ioctl *p_UBSEC_rsa_mod_exp_ioctl = NULL;
297 static t_UBSEC_rsa_mod_exp_crt_ioctl *p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
298 /* #endif */
299 #ifndef OPENSSL_NO_DSA
300 static t_UBSEC_dsa_sign_ioctl *p_UBSEC_dsa_sign_ioctl = NULL;
301 static t_UBSEC_dsa_verify_ioctl *p_UBSEC_dsa_verify_ioctl = NULL;
302 #endif
303 static t_UBSEC_math_accelerate_ioctl *p_UBSEC_math_accelerate_ioctl = NULL;
304 static t_UBSEC_rng_ioctl *p_UBSEC_rng_ioctl = NULL;
305 static t_UBSEC_max_key_len_ioctl *p_UBSEC_max_key_len_ioctl = NULL;
306
307 static int max_key_len = 1024;  /* ??? */
308
309 /* 
310  * These are the static string constants for the DSO file name and the function
311  * symbol names to bind to. 
312  */
313
314 static const char *UBSEC_LIBNAME = NULL;
315 static const char *get_UBSEC_LIBNAME(void)
316         {
317         if(UBSEC_LIBNAME)
318                 return UBSEC_LIBNAME;
319         return "ubsec";
320         }
321 static void free_UBSEC_LIBNAME(void)
322         {
323         if(UBSEC_LIBNAME)
324                 OPENSSL_free((void*)UBSEC_LIBNAME);
325         UBSEC_LIBNAME = NULL;
326         }
327 static long set_UBSEC_LIBNAME(const char *name)
328         {
329         free_UBSEC_LIBNAME();
330         return (((UBSEC_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
331         }
332 static const char *UBSEC_F1 = "ubsec_bytes_to_bits";
333 static const char *UBSEC_F2 = "ubsec_bits_to_bytes";
334 static const char *UBSEC_F3 = "ubsec_open";
335 static const char *UBSEC_F4 = "ubsec_close";
336 #ifndef OPENSSL_NO_DH
337 static const char *UBSEC_F5 = "diffie_hellman_generate_ioctl";
338 static const char *UBSEC_F6 = "diffie_hellman_agree_ioctl";
339 #endif
340 /* #ifndef OPENSSL_NO_RSA */
341 static const char *UBSEC_F7 = "rsa_mod_exp_ioctl";
342 static const char *UBSEC_F8 = "rsa_mod_exp_crt_ioctl";
343 /* #endif */
344 #ifndef OPENSSL_NO_DSA
345 static const char *UBSEC_F9 = "dsa_sign_ioctl";
346 static const char *UBSEC_F10 = "dsa_verify_ioctl";
347 #endif
348 static const char *UBSEC_F11 = "math_accelerate_ioctl";
349 static const char *UBSEC_F12 = "rng_ioctl";
350 static const char *UBSEC_F13 = "ubsec_max_key_len_ioctl";
351
352 /* Destructor (complements the "ENGINE_ubsec()" constructor) */
353 static int ubsec_destroy(ENGINE *e)
354         {
355         free_UBSEC_LIBNAME();
356         ERR_unload_UBSEC_strings();
357         return 1;
358         }
359
360 /* (de)initialisation functions. */
361 static int ubsec_init(ENGINE *e)
362         {
363         t_UBSEC_ubsec_bytes_to_bits *p1;
364         t_UBSEC_ubsec_bits_to_bytes *p2;
365         t_UBSEC_ubsec_open *p3;
366         t_UBSEC_ubsec_close *p4;
367 #ifndef OPENSSL_NO_DH
368         t_UBSEC_diffie_hellman_generate_ioctl *p5;
369         t_UBSEC_diffie_hellman_agree_ioctl *p6;
370 #endif
371 /* #ifndef OPENSSL_NO_RSA */
372         t_UBSEC_rsa_mod_exp_ioctl *p7;
373         t_UBSEC_rsa_mod_exp_crt_ioctl *p8;
374 /* #endif */
375 #ifndef OPENSSL_NO_DSA
376         t_UBSEC_dsa_sign_ioctl *p9;
377         t_UBSEC_dsa_verify_ioctl *p10;
378 #endif
379         t_UBSEC_math_accelerate_ioctl *p11;
380         t_UBSEC_rng_ioctl *p12;
381         t_UBSEC_max_key_len_ioctl *p13;
382         int fd = 0;
383
384         if(ubsec_dso != NULL)
385                 {
386                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_ALREADY_LOADED);
387                 goto err;
388                 }
389         /* 
390          * Attempt to load libubsec.so/ubsec.dll/whatever. 
391          */
392         ubsec_dso = DSO_load(NULL, get_UBSEC_LIBNAME(), NULL, 0);
393         if(ubsec_dso == NULL)
394                 {
395                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_DSO_FAILURE);
396                 goto err;
397                 }
398
399         if (
400         !(p1 = (t_UBSEC_ubsec_bytes_to_bits *) DSO_bind_func(ubsec_dso, UBSEC_F1)) ||
401         !(p2 = (t_UBSEC_ubsec_bits_to_bytes *) DSO_bind_func(ubsec_dso, UBSEC_F2)) ||
402         !(p3 = (t_UBSEC_ubsec_open *) DSO_bind_func(ubsec_dso, UBSEC_F3)) ||
403         !(p4 = (t_UBSEC_ubsec_close *) DSO_bind_func(ubsec_dso, UBSEC_F4)) ||
404 #ifndef OPENSSL_NO_DH
405         !(p5 = (t_UBSEC_diffie_hellman_generate_ioctl *) 
406                                 DSO_bind_func(ubsec_dso, UBSEC_F5)) ||
407         !(p6 = (t_UBSEC_diffie_hellman_agree_ioctl *) 
408                                 DSO_bind_func(ubsec_dso, UBSEC_F6)) ||
409 #endif
410 /* #ifndef OPENSSL_NO_RSA */
411         !(p7 = (t_UBSEC_rsa_mod_exp_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F7)) ||
412         !(p8 = (t_UBSEC_rsa_mod_exp_crt_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F8)) ||
413 /* #endif */
414 #ifndef OPENSSL_NO_DSA
415         !(p9 = (t_UBSEC_dsa_sign_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F9)) ||
416         !(p10 = (t_UBSEC_dsa_verify_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F10)) ||
417 #endif
418         !(p11 = (t_UBSEC_math_accelerate_ioctl *) 
419                                 DSO_bind_func(ubsec_dso, UBSEC_F11)) ||
420         !(p12 = (t_UBSEC_rng_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F12)) ||
421         !(p13 = (t_UBSEC_max_key_len_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F13)))
422                 {
423                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_DSO_FAILURE);
424                 goto err;
425                 }
426
427         /* Copy the pointers */
428         p_UBSEC_ubsec_bytes_to_bits = p1;
429         p_UBSEC_ubsec_bits_to_bytes = p2;
430         p_UBSEC_ubsec_open = p3;
431         p_UBSEC_ubsec_close = p4;
432 #ifndef OPENSSL_NO_DH
433         p_UBSEC_diffie_hellman_generate_ioctl = p5;
434         p_UBSEC_diffie_hellman_agree_ioctl = p6;
435 #endif
436 #ifndef OPENSSL_NO_RSA
437         p_UBSEC_rsa_mod_exp_ioctl = p7;
438         p_UBSEC_rsa_mod_exp_crt_ioctl = p8;
439 #endif
440 #ifndef OPENSSL_NO_DSA
441         p_UBSEC_dsa_sign_ioctl = p9;
442         p_UBSEC_dsa_verify_ioctl = p10;
443 #endif
444         p_UBSEC_math_accelerate_ioctl = p11;
445         p_UBSEC_rng_ioctl = p12;
446         p_UBSEC_max_key_len_ioctl = p13;
447
448         /* Perform an open to see if there's actually any unit running. */
449         if (((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) > 0) && (p_UBSEC_max_key_len_ioctl(fd, &max_key_len) == 0))
450         {
451            p_UBSEC_ubsec_close(fd);
452            return 1;
453         }
454         else
455         {
456           UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
457         }
458
459 err:
460         if(ubsec_dso)
461                 DSO_free(ubsec_dso);
462         p_UBSEC_ubsec_bytes_to_bits = NULL;
463         p_UBSEC_ubsec_bits_to_bytes = NULL;
464         p_UBSEC_ubsec_open = NULL;
465         p_UBSEC_ubsec_close = NULL;
466 #ifndef OPENSSL_NO_DH
467         p_UBSEC_diffie_hellman_generate_ioctl = NULL;
468         p_UBSEC_diffie_hellman_agree_ioctl = NULL;
469 #endif
470 #ifndef OPENSSL_NO_RSA
471         p_UBSEC_rsa_mod_exp_ioctl = NULL;
472         p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
473 #endif
474 #ifndef OPENSSL_NO_DSA
475         p_UBSEC_dsa_sign_ioctl = NULL;
476         p_UBSEC_dsa_verify_ioctl = NULL;
477 #endif
478         p_UBSEC_math_accelerate_ioctl = NULL;
479         p_UBSEC_rng_ioctl = NULL;
480         p_UBSEC_max_key_len_ioctl = NULL;
481
482         return 0;
483         }
484
485 static int ubsec_finish(ENGINE *e)
486         {
487         free_UBSEC_LIBNAME();
488         if(ubsec_dso == NULL)
489                 {
490                 UBSECerr(UBSEC_F_UBSEC_FINISH, UBSEC_R_NOT_LOADED);
491                 return 0;
492                 }
493         if(!DSO_free(ubsec_dso))
494                 {
495                 UBSECerr(UBSEC_F_UBSEC_FINISH, UBSEC_R_DSO_FAILURE);
496                 return 0;
497                 }
498         ubsec_dso = NULL;
499         p_UBSEC_ubsec_bytes_to_bits = NULL;
500         p_UBSEC_ubsec_bits_to_bytes = NULL;
501         p_UBSEC_ubsec_open = NULL;
502         p_UBSEC_ubsec_close = NULL;
503 #ifndef OPENSSL_NO_DH
504         p_UBSEC_diffie_hellman_generate_ioctl = NULL;
505         p_UBSEC_diffie_hellman_agree_ioctl = NULL;
506 #endif
507 #ifndef OPENSSL_NO_RSA
508         p_UBSEC_rsa_mod_exp_ioctl = NULL;
509         p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
510 #endif
511 #ifndef OPENSSL_NO_DSA
512         p_UBSEC_dsa_sign_ioctl = NULL;
513         p_UBSEC_dsa_verify_ioctl = NULL;
514 #endif
515         p_UBSEC_math_accelerate_ioctl = NULL;
516         p_UBSEC_rng_ioctl = NULL;
517         p_UBSEC_max_key_len_ioctl = NULL;
518         return 1;
519         }
520
521 static int ubsec_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
522         {
523         int initialised = ((ubsec_dso == NULL) ? 0 : 1);
524         switch(cmd)
525                 {
526         case UBSEC_CMD_SO_PATH:
527                 if(p == NULL)
528                         {
529                         UBSECerr(UBSEC_F_UBSEC_CTRL,ERR_R_PASSED_NULL_PARAMETER);
530                         return 0;
531                         }
532                 if(initialised)
533                         {
534                         UBSECerr(UBSEC_F_UBSEC_CTRL,UBSEC_R_ALREADY_LOADED);
535                         return 0;
536                         }
537                 return set_UBSEC_LIBNAME((const char *)p);
538         default:
539                 break;
540                 }
541         UBSECerr(UBSEC_F_UBSEC_CTRL,UBSEC_R_CTRL_COMMAND_NOT_IMPLEMENTED);
542         return 0;
543         }
544
545 static int ubsec_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
546                 const BIGNUM *m, BN_CTX *ctx)
547         {
548         int     y_len = 0;
549         int     fd;
550
551         if(ubsec_dso == NULL)
552         {
553                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_NOT_LOADED);
554                 return 0;
555         }
556
557         /* Check if hardware can't handle this argument. */
558         y_len = BN_num_bits(m);
559         if (y_len > max_key_len) {
560                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL);
561                 return BN_mod_exp(r, a, p, m, ctx);
562         } 
563
564         if(!bn_wexpand(r, m->top))
565         {
566                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_BN_EXPAND_FAIL);
567                 return 0;
568         }
569
570         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
571                 fd = 0;
572                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
573                 return BN_mod_exp(r, a, p, m, ctx);
574         }
575
576         if (p_UBSEC_rsa_mod_exp_ioctl(fd, (unsigned char *)a->d, BN_num_bits(a),
577                 (unsigned char *)m->d, BN_num_bits(m), (unsigned char *)p->d, 
578                 BN_num_bits(p), (unsigned char *)r->d, &y_len) != 0)
579         {
580                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_REQUEST_FAILED);
581                 p_UBSEC_ubsec_close(fd);
582
583                 return BN_mod_exp(r, a, p, m, ctx);
584         }
585
586         p_UBSEC_ubsec_close(fd);
587
588         r->top = (BN_num_bits(m)+BN_BITS2-1)/BN_BITS2;
589         return 1;
590         }
591
592 #ifndef OPENSSL_NO_RSA
593 static int ubsec_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx)
594         {
595         int to_return = 0;
596
597         if(!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp)
598                 {
599                 UBSECerr(UBSEC_F_UBSEC_RSA_MOD_EXP, UBSEC_R_MISSING_KEY_COMPONENTS);
600                 goto err;
601                 }
602
603         to_return = ubsec_mod_exp_crt(r0, I, rsa->p, rsa->q, rsa->dmp1,
604                     rsa->dmq1, rsa->iqmp, ctx);
605         if (to_return == FAIL_TO_SOFTWARE)
606         {
607           /*
608            * Do in software as hardware failed.
609            */
610            const RSA_METHOD *meth = RSA_PKCS1_SSLeay();
611            to_return = (*meth->rsa_mod_exp)(r0, I, rsa, ctx);
612         }
613 err:
614         return to_return;
615         }
616 #endif
617
618 static int ubsec_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
619                         const BIGNUM *q, const BIGNUM *dp,
620                         const BIGNUM *dq, const BIGNUM *qinv, BN_CTX *ctx)
621         {
622         int     y_len,
623                 m_len,
624                 fd;
625
626         m_len = BN_num_bytes(p) + BN_num_bytes(q) + 1;
627         y_len = BN_num_bits(p) + BN_num_bits(q);
628
629         /* Check if hardware can't handle this argument. */
630         if (y_len > max_key_len) {
631                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL);
632                 return FAIL_TO_SOFTWARE;
633         } 
634
635         if (!bn_wexpand(r, p->top + q->top + 1)) {
636                 UBSECerr(UBSEC_F_UBSEC_RSA_MOD_EXP_CRT, UBSEC_R_BN_EXPAND_FAIL);
637                 return 0;
638         }
639
640         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
641                 fd = 0;
642                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
643                 return FAIL_TO_SOFTWARE;
644         }
645
646         if (p_UBSEC_rsa_mod_exp_crt_ioctl(fd,
647                 (unsigned char *)a->d, BN_num_bits(a), 
648                 (unsigned char *)qinv->d, BN_num_bits(qinv),
649                 (unsigned char *)dp->d, BN_num_bits(dp),
650                 (unsigned char *)p->d, BN_num_bits(p),
651                 (unsigned char *)dq->d, BN_num_bits(dq),
652                 (unsigned char *)q->d, BN_num_bits(q),
653                 (unsigned char *)r->d,  &y_len) != 0) {
654                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_REQUEST_FAILED);
655                 p_UBSEC_ubsec_close(fd);
656                 return FAIL_TO_SOFTWARE;
657         }
658
659         p_UBSEC_ubsec_close(fd);
660
661         r->top = (BN_num_bits(p) + BN_num_bits(q) + BN_BITS2 - 1)/BN_BITS2;
662         return 1;
663 }
664
665 #ifndef OPENSSL_NO_DSA
666 #ifdef NOT_USED
667 static int ubsec_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
668                 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
669                 BN_CTX *ctx, BN_MONT_CTX *in_mont)
670         {
671         BIGNUM t;
672         int to_return = 0;
673  
674         BN_init(&t);
675         /* let rr = a1 ^ p1 mod m */
676         if (!ubsec_mod_exp(rr,a1,p1,m,ctx)) goto end;
677         /* let t = a2 ^ p2 mod m */
678         if (!ubsec_mod_exp(&t,a2,p2,m,ctx)) goto end;
679         /* let rr = rr * t mod m */
680         if (!BN_mod_mul(rr,rr,&t,m,ctx)) goto end;
681         to_return = 1;
682 end:
683         BN_free(&t);
684         return to_return;
685         }
686
687 static int ubsec_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
688                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
689                 BN_MONT_CTX *m_ctx)
690         {
691         return ubsec_mod_exp(r, a, p, m, ctx);
692         }
693 #endif
694 #endif
695
696 /*
697  * This function is aliased to mod_exp (with the mont stuff dropped).
698  */
699 static int ubsec_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
700                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
701         {
702         int ret = 0;
703
704 #ifndef OPENSSL_NO_RSA
705         /* Do in software if the key is too large for the hardware. */
706         if (BN_num_bits(m) > max_key_len)
707                 {
708                 const RSA_METHOD *meth = RSA_PKCS1_SSLeay();
709                 ret = (*meth->bn_mod_exp)(r, a, p, m, ctx, m_ctx);
710                 }
711         else
712 #endif
713                 {
714                 ret = ubsec_mod_exp(r, a, p, m, ctx);
715                 }
716         
717         return ret;
718         }
719
720 #ifndef OPENSSL_NO_DH
721 /* This function is aliased to mod_exp (with the dh and mont dropped). */
722 static int ubsec_mod_exp_dh(const DH *dh, BIGNUM *r, const BIGNUM *a,
723                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
724                 BN_MONT_CTX *m_ctx)
725         {
726         return ubsec_mod_exp(r, a, p, m, ctx);
727         }
728 #endif
729
730 #ifndef OPENSSL_NO_DSA
731 static DSA_SIG *ubsec_dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa)
732         {
733         DSA_SIG *to_return = NULL;
734         int s_len = 160, r_len = 160, d_len, fd;
735         BIGNUM m, *r=NULL, *s=NULL;
736
737         BN_init(&m);
738
739         s = BN_new();
740         r = BN_new();
741         if ((s == NULL) || (r==NULL))
742                 goto err;
743
744         d_len = p_UBSEC_ubsec_bytes_to_bits((unsigned char *)dgst, dlen);
745
746         if(!bn_wexpand(r, (160+BN_BITS2-1)/BN_BITS2) ||
747            (!bn_wexpand(s, (160+BN_BITS2-1)/BN_BITS2))) {
748                 UBSECerr(UBSEC_F_UBSEC_DSA_SIGN, UBSEC_R_BN_EXPAND_FAIL);
749                 goto err;
750         }
751
752         if (BN_bin2bn(dgst,dlen,&m) == NULL) {
753                 UBSECerr(UBSEC_F_UBSEC_DSA_SIGN, UBSEC_R_BN_EXPAND_FAIL);
754                 goto err;
755         } 
756
757         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
758                 const DSA_METHOD *meth;
759                 fd = 0;
760                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
761                 meth = DSA_OpenSSL();
762                 to_return =  meth->dsa_do_sign(dgst, dlen, dsa);
763                 goto err;
764         }
765
766         if (p_UBSEC_dsa_sign_ioctl(fd, 0, /* compute hash before signing */
767                 (unsigned char *)dgst, d_len,
768                 NULL, 0,  /* compute random value */
769                 (unsigned char *)dsa->p->d, BN_num_bits(dsa->p), 
770                 (unsigned char *)dsa->q->d, BN_num_bits(dsa->q),
771                 (unsigned char *)dsa->g->d, BN_num_bits(dsa->g),
772                 (unsigned char *)dsa->priv_key->d, BN_num_bits(dsa->priv_key),
773                 (unsigned char *)r->d, &r_len,
774                 (unsigned char *)s->d, &s_len ) != 0) {
775                 const DSA_METHOD *meth;
776
777                 UBSECerr(UBSEC_F_UBSEC_DSA_SIGN, UBSEC_R_REQUEST_FAILED);
778                 p_UBSEC_ubsec_close(fd);
779                 meth = DSA_OpenSSL();
780                 to_return = meth->dsa_do_sign(dgst, dlen, dsa);
781
782                 goto err;
783         }
784
785         p_UBSEC_ubsec_close(fd);
786
787         r->top = (160+BN_BITS2-1)/BN_BITS2;
788         s->top = (160+BN_BITS2-1)/BN_BITS2;
789
790         to_return = DSA_SIG_new();
791         if(to_return == NULL) {
792                 UBSECerr(UBSEC_F_UBSEC_DSA_SIGN, UBSEC_R_BN_EXPAND_FAIL);
793                 goto err;
794         }
795
796         to_return->r = r;
797         to_return->s = s;
798
799 err:
800         if (!to_return) {
801                 if (r) BN_free(r);
802                 if (s) BN_free(s);
803         }                                 
804         BN_clear_free(&m);
805         return to_return;
806 }
807
808 static int ubsec_dsa_verify(const unsigned char *dgst, int dgst_len,
809                                 DSA_SIG *sig, DSA *dsa)
810         {
811         int v_len, d_len;
812         int to_return = 0;
813         int fd;
814         BIGNUM v;
815
816         BN_init(&v);
817
818         if(!bn_wexpand(&v, dsa->p->top)) {
819                 UBSECerr(UBSEC_F_UBSEC_DSA_VERIFY ,UBSEC_R_BN_EXPAND_FAIL);
820                 goto err;
821         }
822
823         v_len = BN_num_bits(dsa->p);
824
825         d_len = p_UBSEC_ubsec_bytes_to_bits((unsigned char *)dgst, dgst_len);
826
827         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
828                 const DSA_METHOD *meth;
829                 fd = 0;
830                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
831                 meth = DSA_OpenSSL();
832                 to_return = meth->dsa_do_verify(dgst, dgst_len, sig, dsa);
833                 goto err;
834         }
835
836         if (p_UBSEC_dsa_verify_ioctl(fd, 0, /* compute hash before signing */
837                 (unsigned char *)dgst, d_len,
838                 (unsigned char *)dsa->p->d, BN_num_bits(dsa->p), 
839                 (unsigned char *)dsa->q->d, BN_num_bits(dsa->q),
840                 (unsigned char *)dsa->g->d, BN_num_bits(dsa->g),
841                 (unsigned char *)dsa->pub_key->d, BN_num_bits(dsa->pub_key),
842                 (unsigned char *)sig->r->d, BN_num_bits(sig->r),
843                 (unsigned char *)sig->s->d, BN_num_bits(sig->s),
844                 (unsigned char *)v.d, &v_len) != 0) {
845                 const DSA_METHOD *meth;
846                 UBSECerr(UBSEC_F_UBSEC_DSA_VERIFY , UBSEC_R_REQUEST_FAILED);
847                 p_UBSEC_ubsec_close(fd);
848
849                 meth = DSA_OpenSSL();
850                 to_return = meth->dsa_do_verify(dgst, dgst_len, sig, dsa);
851
852                 goto err;
853         }
854
855         p_UBSEC_ubsec_close(fd);
856
857         to_return = 1;
858 err:
859         BN_clear_free(&v);
860         return to_return;
861         }
862 #endif
863
864 #ifndef OPENSSL_NO_DH
865 static int ubsec_dh_compute_key (unsigned char *key,const BIGNUM *pub_key,DH *dh)
866         {
867         int      ret      = -1,
868                  k_len,
869                  fd;
870
871         k_len = BN_num_bits(dh->p);
872
873         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0)
874                 {
875                 const DH_METHOD *meth;
876                 ENGINEerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
877                 meth = DH_OpenSSL();
878                 ret = meth->compute_key(key, pub_key, dh);
879                 goto err;
880                 }
881
882         if (p_UBSEC_diffie_hellman_agree_ioctl(fd,
883                                                (unsigned char *)dh->priv_key->d, BN_num_bits(dh->priv_key),
884                                                (unsigned char *)pub_key->d, BN_num_bits(pub_key),
885                                                (unsigned char *)dh->p->d, BN_num_bits(dh->p),
886                                                key, &k_len) != 0)
887                 {
888                 /* Hardware's a no go, failover to software */
889                 const DH_METHOD *meth;
890                 ENGINEerr(UBSEC_F_UBSEC_DH_COMPUTE_KEY, UBSEC_R_REQUEST_FAILED);
891                 p_UBSEC_ubsec_close(fd);
892
893                 meth = DH_OpenSSL();
894                 ret = meth->compute_key(key, pub_key, dh);
895
896                 goto err;
897                 }
898
899         p_UBSEC_ubsec_close(fd);
900
901         ret = p_UBSEC_ubsec_bits_to_bytes(k_len);
902 err:
903         return ret;
904         }
905
906 static int ubsec_dh_generate_key (DH *dh)
907         {
908         int      ret               = 0,
909                  random_bits       = 0,
910                  pub_key_len       = 0,
911                  priv_key_len      = 0,
912                  fd;
913         BIGNUM   *pub_key          = NULL;
914         BIGNUM   *priv_key         = NULL;
915
916         /* 
917          *  How many bits should Random x be? dh_key.c
918          *  sets the range from 0 to num_bits(modulus) ???
919          */
920
921         if (dh->priv_key == NULL)
922                 {
923                 priv_key = BN_new();
924                 if (priv_key == NULL) goto err;
925                 priv_key_len = BN_num_bits(dh->p);
926                 bn_wexpand(priv_key, dh->p->top);
927                 do
928                         if (!BN_rand_range(priv_key, dh->p)) goto err;
929                 while (BN_is_zero(priv_key));
930                 random_bits = BN_num_bits(priv_key);
931                 }
932         else
933                 {
934                 priv_key = dh->priv_key;
935                 }
936
937         if (dh->pub_key == NULL)
938                 {
939                 pub_key = BN_new();
940                 pub_key_len = BN_num_bits(dh->p);
941                 bn_wexpand(pub_key, dh->p->top);
942                 if(pub_key == NULL) goto err;
943                 }
944         else
945                 {
946                 pub_key = dh->pub_key;
947                 }
948
949         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0)
950                 {
951                 const DH_METHOD *meth;
952                 ENGINEerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
953                 meth = DH_OpenSSL();
954                 ret = meth->generate_key(dh);
955                 goto err;
956                 }
957
958         if (p_UBSEC_diffie_hellman_generate_ioctl(fd,
959                                                   (unsigned char *)priv_key->d, &priv_key_len,
960                                                   (unsigned char *)pub_key->d,  &pub_key_len,
961                                                   (unsigned char *)dh->g->d, BN_num_bits(dh->g),
962                                                   (unsigned char *)dh->p->d, BN_num_bits(dh->p),
963                                                   0, 0, random_bits) != 0)
964                 {
965                 /* Hardware's a no go, failover to software */
966                 const DH_METHOD *meth;
967
968                 ENGINEerr(UBSEC_F_UBSEC_DH_COMPUTE_KEY, UBSEC_R_REQUEST_FAILED);
969                 p_UBSEC_ubsec_close(fd);
970
971                 meth = DH_OpenSSL();
972                 ret = meth->generate_key(dh);
973
974                 goto err;
975                 }
976
977         p_UBSEC_ubsec_close(fd);
978
979         dh->pub_key = pub_key;
980         dh->pub_key->top = (pub_key_len + BN_BITS2-1) / BN_BITS2;
981         dh->priv_key = priv_key;
982         dh->priv_key->top = (priv_key_len + BN_BITS2-1) / BN_BITS2;
983
984         ret = 1;
985 err:
986         return ret;
987         }
988 #endif
989
990 #ifdef NOT_USED
991 static int ubsec_rand_bytes(unsigned char * buf,
992                             int num)
993         {
994         int      ret      = 0,
995                  fd;
996
997         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0)
998                 {
999                 const RAND_METHOD *meth;
1000                 ENGINEerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
1001                 num = p_UBSEC_ubsec_bits_to_bytes(num);
1002                 meth = RAND_SSLeay();
1003                 meth->seed(buf, num);
1004                 ret = meth->bytes(buf, num);
1005                 goto err;
1006                 }
1007
1008         num *= 8; /* bytes to bits */
1009
1010         if (p_UBSEC_rng_ioctl(fd,
1011                               UBSEC_RNG_DIRECT,
1012                               buf,
1013                               &num) != 0)
1014                 {
1015                 /* Hardware's a no go, failover to software */
1016                 const RAND_METHOD *meth;
1017
1018                 ENGINEerr(UBSEC_F_UBSEC_RNG_BYTES, UBSEC_R_REQUEST_FAILED);
1019                 p_UBSEC_ubsec_close(fd);
1020
1021                 num = p_UBSEC_ubsec_bits_to_bytes(num);
1022                 meth = RAND_SSLeay();
1023                 meth->seed(buf, num);
1024                 ret = meth->bytes(buf, num);
1025
1026                 goto err;
1027                 }
1028
1029         p_UBSEC_ubsec_close(fd);
1030
1031         ret = 1;
1032 err:
1033         return(ret);
1034         }
1035
1036
1037 static int ubsec_rand_status(void)
1038         {
1039         return 0;
1040         }
1041 #endif
1042
1043 /* This stuff is needed if this ENGINE is being compiled into a self-contained
1044  * shared-library. */
1045 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
1046 static int bind_fn(ENGINE *e, const char *id)
1047         {
1048         if(id && (strcmp(id, engine_ubsec_id) != 0))
1049                 return 0;
1050         if(!bind_helper(e))
1051                 return 0;
1052         return 1;
1053         }
1054 IMPLEMENT_DYNAMIC_CHECK_FN()
1055 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1056 #endif /* OPENSSL_NO_DYNAMIC_ENGINE */
1057
1058 #endif /* !OPENSSL_NO_HW_UBSEC */
1059 #endif /* !OPENSSL_NO_HW */