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