This changes the existing hardware ENGINE implementations to dynamically
[openssl.git] / crypto / engine / hw_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 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 <openssl/crypto.h>
63 #include "cryptlib.h"
64 #include <openssl/dso.h>
65 #include <openssl/engine.h>
66
67 #ifndef OPENSSL_NO_HW
68 #ifndef OPENSSL_NO_HW_UBSEC
69
70 #ifdef FLAT_INC
71 #include "hw_ubsec.h"
72 #else
73 #include "vendor_defns/hw_ubsec.h"
74 #endif
75
76 static int ubsec_init(ENGINE *e);
77 static int ubsec_finish(ENGINE *e);
78 static int ubsec_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
79 static int ubsec_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
80                 const BIGNUM *m, BN_CTX *ctx);
81 static int ubsec_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
82                         const BIGNUM *q, const BIGNUM *dp,
83                         const BIGNUM *dq, const BIGNUM *qinv, BN_CTX *ctx);
84 #ifndef OPENSSL_NO_RSA
85 static int ubsec_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa);
86 #endif
87 static int ubsec_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
88                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
89 #ifndef OPENSSL_NO_DSA
90 #if NOT_USED
91 static int ubsec_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
92                 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
93                 BN_CTX *ctx, BN_MONT_CTX *in_mont);
94 static int ubsec_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
95                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
96                 BN_MONT_CTX *m_ctx);
97 #endif
98 static DSA_SIG *ubsec_dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
99 static int ubsec_dsa_verify(const unsigned char *dgst, int dgst_len,
100                                 DSA_SIG *sig, DSA *dsa);
101 #endif
102 #ifndef OPENSSL_NO_DH
103 static int ubsec_mod_exp_dh(const DH *dh, BIGNUM *r, const BIGNUM *a,
104                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
105                 BN_MONT_CTX *m_ctx);
106 static int ubsec_dh_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
107 static int ubsec_dh_generate_key(DH *dh);
108 #endif
109
110 #if NOT_USED
111 static int ubsec_rand_bytes(unsigned char *buf, int num);
112 static int ubsec_rand_status(void);
113 #endif
114
115 #define UBSEC_CMD_SO_PATH               ENGINE_CMD_BASE
116 static const ENGINE_CMD_DEFN ubsec_cmd_defns[] = {
117         {UBSEC_CMD_SO_PATH,
118                 "SO_PATH",
119                 "Specifies the path to the 'ubsec' shared library",
120                 ENGINE_CMD_FLAG_STRING},
121         {0, NULL, NULL, 0}
122         };
123
124 #ifndef OPENSSL_NO_RSA
125 /* Our internal RSA_METHOD that we provide pointers to */
126 static RSA_METHOD ubsec_rsa =
127         {
128         "UBSEC RSA method",
129         NULL,
130         NULL,
131         NULL,
132         NULL,
133         ubsec_rsa_mod_exp,
134         ubsec_mod_exp_mont,
135         NULL,
136         NULL,
137         0,
138         NULL,
139         NULL,
140         NULL
141         };
142 #endif
143
144 #ifndef OPENSSL_NO_DSA
145 /* Our internal DSA_METHOD that we provide pointers to */
146 static DSA_METHOD ubsec_dsa =
147         {
148         "UBSEC DSA method",
149         ubsec_dsa_do_sign, /* dsa_do_sign */
150         NULL, /* dsa_sign_setup */
151         ubsec_dsa_verify, /* dsa_do_verify */
152         NULL, /* ubsec_dsa_mod_exp */ /* dsa_mod_exp */
153         NULL, /* ubsec_mod_exp_dsa */ /* bn_mod_exp */
154         NULL, /* init */
155         NULL, /* finish */
156         0, /* flags */
157         NULL /* app_data */
158         };
159 #endif
160
161 #ifndef OPENSSL_NO_DH
162 /* Our internal DH_METHOD that we provide pointers to */
163 static DH_METHOD ubsec_dh =
164         {
165         "UBSEC DH method",
166         ubsec_dh_generate_key,
167         ubsec_dh_compute_key,
168         ubsec_mod_exp_dh,
169         NULL,
170         NULL,
171         0,
172         NULL
173         };
174 #endif
175
176 #ifndef OPENSSL_NO_ERR
177 /* Error function codes for use in ubsec operation */
178 #define UBSEC_F_UBSEC_INIT                      100
179 #define UBSEC_F_UBSEC_FINISH                    101
180 #define UBSEC_F_UBSEC_CTRL                      102
181 #define UBSEC_F_UBSEC_MOD_EXP                   103
182 #define UBSEC_F_UBSEC_RSA_MOD_EXP               104
183 #define UBSEC_F_UBSEC_RSA_MOD_EXP_CRT           105
184 #define UBSEC_F_UBSEC_DSA_SIGN                  106
185 #define UBSEC_F_UBSEC_DSA_VERIFY                107
186 /* Error reason codes */
187 #define UBSEC_R_ALREADY_LOADED                  108
188 #define UBSEC_R_DSO_FAILURE                     109
189 #define UBSEC_R_UNIT_FAILURE                    110
190 #define UBSEC_R_NOT_LOADED                      111
191 #define UBSEC_R_CTRL_COMMAND_NOT_IMPLEMENTED    112
192 #define UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL     113
193 #define UBSEC_R_BN_EXPAND_FAIL                  114
194 #define UBSEC_R_REQUEST_FAILED                  115
195 #define UBSEC_R_MISSING_KEY_COMPONENTS          116
196 static ERR_STRING_DATA ubsec_str_functs[] =
197         {
198         /* This first element is changed to match the dynamic 'lib' number */
199 {ERR_PACK(0,0,0),                               "ubsec engine code"},
200 {ERR_PACK(0,UBSEC_F_UBSEC_INIT,0),              "ubsec_init"},
201 {ERR_PACK(0,UBSEC_F_UBSEC_FINISH,0),            "ubsec_finish"},
202 {ERR_PACK(0,UBSEC_F_UBSEC_CTRL,0),              "ubsec_ctrl"},
203 {ERR_PACK(0,UBSEC_F_UBSEC_MOD_EXP,0),           "ubsec_mod_exp"},
204 {ERR_PACK(0,UBSEC_F_UBSEC_RSA_MOD_EXP,0),       "ubsec_rsa_mod_exp"},
205 {ERR_PACK(0,UBSEC_F_UBSEC_RSA_MOD_EXP_CRT,0),   "ubsec_rsa_mod_exp_crt"},
206 {ERR_PACK(0,UBSEC_F_UBSEC_DSA_SIGN,0),          "ubsec_dsa_sign"},
207 {ERR_PACK(0,UBSEC_F_UBSEC_DSA_VERIFY,0),        "ubsec_dsa_verify"},
208 /* Error reason codes */
209 {UBSEC_R_ALREADY_LOADED                 ,"already loaded"},
210 {UBSEC_R_DSO_FAILURE                    ,"DSO failure"},
211 {UBSEC_R_UNIT_FAILURE                   ,"unit failure"},
212 {UBSEC_R_NOT_LOADED                     ,"not loaded"},
213 {UBSEC_R_CTRL_COMMAND_NOT_IMPLEMENTED   ,"ctrl command not implemented"},
214 {UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL    ,"size too large or too small"},
215 {UBSEC_R_BN_EXPAND_FAIL                 ,"bn_expand fail"},
216 {UBSEC_R_REQUEST_FAILED                 ,"request failed"},
217 {UBSEC_R_MISSING_KEY_COMPONENTS         ,"missing key components"},
218 {0,NULL}
219         };
220 /* The library number we obtain dynamically from the ERR code */
221 static int ubsec_err_lib = -1;
222 #define UBSECerr(f,r) ERR_PUT_error(ubsec_err_lib,(f),(r),__FILE__,__LINE__)
223 static void ubsec_load_error_strings(void)
224         {
225         if(ubsec_err_lib < 0)
226                 {
227                 if((ubsec_err_lib = ERR_get_next_error_library()) <= 0)
228                         return;
229                 ubsec_str_functs[0].error = ERR_PACK(ubsec_err_lib,0,0);
230                 ERR_load_strings(ubsec_err_lib, ubsec_str_functs);
231                 }
232         }
233 #else
234 #define UBSECerr(f,r)                             /* NOP */
235 static void ubsec_load_error_strings(void) { }   /* NOP */
236 #endif
237
238 /* Constants used when creating the ENGINE */
239 static const char *engine_ubsec_id = "ubsec";
240 static const char *engine_ubsec_name = "UBSEC hardware engine support";
241
242 /* This internal function is used by ENGINE_ubsec() and possibly by the
243  * "dynamic" ENGINE support too */
244 static int bind_helper(ENGINE *e)
245         {
246 #ifndef OPENSSL_NO_RSA
247         const RSA_METHOD *meth1;
248 #endif
249 #ifndef OPENSSL_NO_DH
250 #ifndef HAVE_UBSEC_DH
251         const DH_METHOD *meth3;
252 #endif /* HAVE_UBSEC_DH */
253 #endif
254         if(!ENGINE_set_id(e, engine_ubsec_id) ||
255                         !ENGINE_set_name(e, engine_ubsec_name) ||
256 #ifndef OPENSSL_NO_RSA
257                         !ENGINE_set_RSA(e, &ubsec_rsa) ||
258 #endif
259 #ifndef OPENSSL_NO_DSA
260                         !ENGINE_set_DSA(e, &ubsec_dsa) ||
261 #endif
262 #ifndef OPENSSL_NO_DH
263                         !ENGINE_set_DH(e, &ubsec_dh) ||
264 #endif
265                         !ENGINE_set_BN_mod_exp(e, ubsec_mod_exp) ||
266                         !ENGINE_set_BN_mod_exp_crt(e, ubsec_mod_exp_crt) ||
267                         !ENGINE_set_init_function(e, ubsec_init) ||
268                         !ENGINE_set_finish_function(e, ubsec_finish) ||
269                         !ENGINE_set_ctrl_function(e, ubsec_ctrl) ||
270                         !ENGINE_set_cmd_defns(e, ubsec_cmd_defns))
271                 return 0;
272
273 #ifndef OPENSSL_NO_RSA
274         /* We know that the "PKCS1_SSLeay()" functions hook properly
275          * to the Broadcom-specific mod_exp and mod_exp_crt so we use
276          * those functions. NB: We don't use ENGINE_openssl() or
277          * anything "more generic" because something like the RSAref
278          * code may not hook properly, and if you own one of these
279          * cards then you have the right to do RSA operations on it
280          * anyway! */ 
281         meth1 = RSA_PKCS1_SSLeay();
282         ubsec_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
283         ubsec_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
284         ubsec_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
285         ubsec_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
286 #endif
287
288 #ifndef OPENSSL_NO_DH
289 #ifndef HAVE_UBSEC_DH
290         /* Much the same for Diffie-Hellman */
291         meth3 = DH_OpenSSL();
292         ubsec_dh.generate_key = meth3->generate_key;
293         ubsec_dh.compute_key = meth3->compute_key;
294 #endif /* HAVE_UBSEC_DH */
295 #endif
296
297         /* Ensure the ubsec error handling is set up */
298         ubsec_load_error_strings();
299         return 1;
300         }
301
302 /* As this is only ever called once, there's no need for locking
303  * (indeed - the lock will already be held by our caller!!!) */
304 ENGINE *ENGINE_ubsec(void)
305         {
306         ENGINE *ret = ENGINE_new();
307         if(!ret)
308                 return NULL;
309         if(!bind_helper(ret))
310                 {
311                 ENGINE_free(ret);
312                 return NULL;
313                 }
314         return ret;
315         }
316
317 /* This is a process-global DSO handle used for loading and unloading
318  * the UBSEC library. NB: This is only set (or unset) during an
319  * init() or finish() call (reference counts permitting) and they're
320  * operating with global locks, so this should be thread-safe
321  * implicitly. */
322
323 static DSO *ubsec_dso = NULL;
324
325 /* These are the function pointers that are (un)set when the library has
326  * successfully (un)loaded. */
327
328 static t_UBSEC_ubsec_bytes_to_bits *p_UBSEC_ubsec_bytes_to_bits = NULL;
329 static t_UBSEC_ubsec_bits_to_bytes *p_UBSEC_ubsec_bits_to_bytes = NULL;
330 static t_UBSEC_ubsec_open *p_UBSEC_ubsec_open = NULL;
331 static t_UBSEC_ubsec_close *p_UBSEC_ubsec_close = NULL;
332 #ifndef OPENSSL_NO_DH
333 static t_UBSEC_diffie_hellman_generate_ioctl 
334         *p_UBSEC_diffie_hellman_generate_ioctl = NULL;
335 static t_UBSEC_diffie_hellman_agree_ioctl *p_UBSEC_diffie_hellman_agree_ioctl = NULL;
336 #endif
337 /* #ifndef OPENSSL_NO_RSA */
338 static t_UBSEC_rsa_mod_exp_ioctl *p_UBSEC_rsa_mod_exp_ioctl = NULL;
339 static t_UBSEC_rsa_mod_exp_crt_ioctl *p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
340 /* #endif */
341 #ifndef OPENSSL_NO_DSA
342 static t_UBSEC_dsa_sign_ioctl *p_UBSEC_dsa_sign_ioctl = NULL;
343 static t_UBSEC_dsa_verify_ioctl *p_UBSEC_dsa_verify_ioctl = NULL;
344 #endif
345 static t_UBSEC_math_accelerate_ioctl *p_UBSEC_math_accelerate_ioctl = NULL;
346 static t_UBSEC_rng_ioctl *p_UBSEC_rng_ioctl = NULL;
347
348 /* 
349  * These are the static string constants for the DSO file name and the function
350  * symbol names to bind to. 
351  */
352
353 static const char *UBSEC_LIBNAME = "ubsec";
354 static const char *UBSEC_F1 = "ubsec_bytes_to_bits";
355 static const char *UBSEC_F2 = "ubsec_bits_to_bytes";
356 static const char *UBSEC_F3 = "ubsec_open";
357 static const char *UBSEC_F4 = "ubsec_close";
358 #ifndef OPENSSL_NO_DH
359 static const char *UBSEC_F5 = "diffie_hellman_generate_ioctl";
360 static const char *UBSEC_F6 = "diffie_hellman_agree_ioctl";
361 #endif
362 /* #ifndef OPENSSL_NO_RSA */
363 static const char *UBSEC_F7 = "rsa_mod_exp_ioctl";
364 static const char *UBSEC_F8 = "rsa_mod_exp_crt_ioctl";
365 /* #endif */
366 #ifndef OPENSSL_NO_DSA
367 static const char *UBSEC_F9 = "dsa_sign_ioctl";
368 static const char *UBSEC_F10 = "dsa_verify_ioctl";
369 #endif
370 static const char *UBSEC_F11 = "math_accelerate_ioctl";
371 static const char *UBSEC_F12 = "rng_ioctl";
372
373 /* (de)initialisation functions. */
374 static int ubsec_init(ENGINE *e)
375         {
376         t_UBSEC_ubsec_bytes_to_bits *p1;
377         t_UBSEC_ubsec_bits_to_bytes *p2;
378         t_UBSEC_ubsec_open *p3;
379         t_UBSEC_ubsec_close *p4;
380 #ifndef OPENSSL_NO_DH
381         t_UBSEC_diffie_hellman_generate_ioctl *p5;
382         t_UBSEC_diffie_hellman_agree_ioctl *p6;
383 #endif
384 /* #ifndef OPENSSL_NO_RSA */
385         t_UBSEC_rsa_mod_exp_ioctl *p7;
386         t_UBSEC_rsa_mod_exp_crt_ioctl *p8;
387 /* #endif */
388 #ifndef OPENSSL_NO_DSA
389         t_UBSEC_dsa_sign_ioctl *p9;
390         t_UBSEC_dsa_verify_ioctl *p10;
391 #endif
392         t_UBSEC_math_accelerate_ioctl *p11;
393         t_UBSEC_rng_ioctl *p12;
394         int fd = 0;
395
396         if(ubsec_dso != NULL)
397                 {
398                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_ALREADY_LOADED);
399                 goto err;
400                 }
401         /* 
402          * Attempt to load libubsec.so/ubsec.dll/whatever. 
403          */
404         ubsec_dso = DSO_load(NULL, UBSEC_LIBNAME, NULL, 0);
405         if(ubsec_dso == NULL)
406                 {
407                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_DSO_FAILURE);
408                 goto err;
409                 }
410
411         if (
412         !(p1 = (t_UBSEC_ubsec_bytes_to_bits *) DSO_bind_func(ubsec_dso, UBSEC_F1)) ||
413         !(p2 = (t_UBSEC_ubsec_bits_to_bytes *) DSO_bind_func(ubsec_dso, UBSEC_F2)) ||
414         !(p3 = (t_UBSEC_ubsec_open *) DSO_bind_func(ubsec_dso, UBSEC_F3)) ||
415         !(p4 = (t_UBSEC_ubsec_close *) DSO_bind_func(ubsec_dso, UBSEC_F4)) ||
416 #ifndef OPENSSL_NO_DH
417         !(p5 = (t_UBSEC_diffie_hellman_generate_ioctl *) 
418                                 DSO_bind_func(ubsec_dso, UBSEC_F5)) ||
419         !(p6 = (t_UBSEC_diffie_hellman_agree_ioctl *) 
420                                 DSO_bind_func(ubsec_dso, UBSEC_F6)) ||
421 #endif
422 /* #ifndef OPENSSL_NO_RSA */
423         !(p7 = (t_UBSEC_rsa_mod_exp_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F7)) ||
424         !(p8 = (t_UBSEC_rsa_mod_exp_crt_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F8)) ||
425 /* #endif */
426 #ifndef OPENSSL_NO_DSA
427         !(p9 = (t_UBSEC_dsa_sign_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F9)) ||
428         !(p10 = (t_UBSEC_dsa_verify_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F10)) ||
429 #endif
430         !(p11 = (t_UBSEC_math_accelerate_ioctl *) 
431                                 DSO_bind_func(ubsec_dso, UBSEC_F11)) ||
432         !(p12 = (t_UBSEC_rng_ioctl *) DSO_bind_func(ubsec_dso, UBSEC_F12)))
433                 {
434                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_DSO_FAILURE);
435                 goto err;
436                 }
437
438         /* Copy the pointers */
439         p_UBSEC_ubsec_bytes_to_bits = p1;
440         p_UBSEC_ubsec_bits_to_bytes = p2;
441         p_UBSEC_ubsec_open = p3;
442         p_UBSEC_ubsec_close = p4;
443 #ifndef OPENSSL_NO_DH
444         p_UBSEC_diffie_hellman_generate_ioctl = p5;
445         p_UBSEC_diffie_hellman_agree_ioctl = p6;
446 #endif
447 #ifndef OPENSSL_NO_RSA
448         p_UBSEC_rsa_mod_exp_ioctl = p7;
449         p_UBSEC_rsa_mod_exp_crt_ioctl = p8;
450 #endif
451 #ifndef OPENSSL_NO_DSA
452         p_UBSEC_dsa_sign_ioctl = p9;
453         p_UBSEC_dsa_verify_ioctl = p10;
454 #endif
455         p_UBSEC_math_accelerate_ioctl = p11;
456         p_UBSEC_rng_ioctl = p12;
457
458         /* Perform an open to see if there's actually any unit running. */
459         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) > 0)
460                 {
461                 p_UBSEC_ubsec_close(fd);
462                 return 1;
463                 }
464         else
465                 {
466                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
467                 }
468
469 err:
470         if(ubsec_dso)
471                 DSO_free(ubsec_dso);
472         p_UBSEC_ubsec_bytes_to_bits = NULL;
473         p_UBSEC_ubsec_bits_to_bytes = NULL;
474         p_UBSEC_ubsec_open = NULL;
475         p_UBSEC_ubsec_close = NULL;
476 #ifndef OPENSSL_NO_DH
477         p_UBSEC_diffie_hellman_generate_ioctl = NULL;
478         p_UBSEC_diffie_hellman_agree_ioctl = NULL;
479 #endif
480 #ifndef OPENSSL_NO_RSA
481         p_UBSEC_rsa_mod_exp_ioctl = NULL;
482         p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
483 #endif
484 #ifndef OPENSSL_NO_DSA
485         p_UBSEC_dsa_sign_ioctl = NULL;
486         p_UBSEC_dsa_verify_ioctl = NULL;
487 #endif
488         p_UBSEC_math_accelerate_ioctl = NULL;
489         p_UBSEC_rng_ioctl = NULL;
490
491         return 0;
492         }
493
494 static int ubsec_finish(ENGINE *e)
495         {
496         if(ubsec_dso == NULL)
497                 {
498                 UBSECerr(UBSEC_F_UBSEC_FINISH, UBSEC_R_NOT_LOADED);
499                 return 0;
500                 }
501         if(!DSO_free(ubsec_dso))
502                 {
503                 UBSECerr(UBSEC_F_UBSEC_FINISH, UBSEC_R_DSO_FAILURE);
504                 return 0;
505                 }
506         ubsec_dso = NULL;
507         p_UBSEC_ubsec_bytes_to_bits = NULL;
508         p_UBSEC_ubsec_bits_to_bytes = NULL;
509         p_UBSEC_ubsec_open = NULL;
510         p_UBSEC_ubsec_close = NULL;
511 #ifndef OPENSSL_NO_DH
512         p_UBSEC_diffie_hellman_generate_ioctl = NULL;
513         p_UBSEC_diffie_hellman_agree_ioctl = NULL;
514 #endif
515 #ifndef OPENSSL_NO_RSA
516         p_UBSEC_rsa_mod_exp_ioctl = NULL;
517         p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
518 #endif
519 #ifndef OPENSSL_NO_DSA
520         p_UBSEC_dsa_sign_ioctl = NULL;
521         p_UBSEC_dsa_verify_ioctl = NULL;
522 #endif
523         p_UBSEC_math_accelerate_ioctl = NULL;
524         p_UBSEC_rng_ioctl = NULL;
525         return 1;
526         }
527
528 static int ubsec_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)())
529         {
530         int initialised = ((ubsec_dso == NULL) ? 0 : 1);
531         switch(cmd)
532                 {
533         case UBSEC_CMD_SO_PATH:
534                 if(p == NULL)
535                         {
536                         UBSECerr(UBSEC_F_UBSEC_CTRL,ERR_R_PASSED_NULL_PARAMETER);
537                         return 0;
538                         }
539                 if(initialised)
540                         {
541                         UBSECerr(UBSEC_F_UBSEC_CTRL,UBSEC_R_ALREADY_LOADED);
542                         return 0;
543                         }
544                 UBSEC_LIBNAME = (const char *)p;
545                 return 1;
546         default:
547                 break;
548                 }
549         UBSECerr(UBSEC_F_UBSEC_CTRL,UBSEC_R_CTRL_COMMAND_NOT_IMPLEMENTED);
550         return 0;
551         }
552
553 static int ubsec_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
554                 const BIGNUM *m, BN_CTX *ctx)
555         {
556         int     y_len = 0;
557         int     fd;
558
559         if(ubsec_dso == NULL)
560         {
561                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_NOT_LOADED);
562                 return 0;
563         }
564
565         /* Check if hardware can't handle this argument. */
566         y_len = BN_num_bits(m);
567         if (y_len > 1024) {
568                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL);
569                 return 0;
570         } 
571
572         if(!bn_wexpand(r, m->top))
573         {
574                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_BN_EXPAND_FAIL);
575                 return 0;
576         }
577         memset(r->d, 0, BN_num_bytes(m));
578
579         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
580                 fd = 0;
581                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
582                 return 0;
583         }
584
585         if (p_UBSEC_rsa_mod_exp_ioctl(fd, (unsigned char *)a->d, BN_num_bits(a),
586                 (unsigned char *)m->d, BN_num_bits(m), (unsigned char *)p->d, 
587                 BN_num_bits(p), (unsigned char *)r->d, &y_len) != 0)
588         {
589                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_REQUEST_FAILED);
590                 return 0;
591         }
592
593         p_UBSEC_ubsec_close(fd);
594
595         r->top = (BN_num_bits(m)+BN_BITS2-1)/BN_BITS2;
596         return 1;
597         }
598
599 #ifndef OPENSSL_NO_RSA
600 static int ubsec_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa)
601         {
602         BN_CTX *ctx;
603         int to_return = 0;
604
605         if((ctx = BN_CTX_new()) == NULL)
606                 goto err;
607
608         if(!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp)
609                 {
610                 UBSECerr(UBSEC_F_UBSEC_RSA_MOD_EXP, UBSEC_R_MISSING_KEY_COMPONENTS);
611                 goto err;
612                 }
613
614         /*
615          * Do in software if argument is too large for hardware.
616          */
617         if ((BN_num_bits(rsa->p)+BN_num_bits(rsa->q)) > 1024) {
618                 const RSA_METHOD *meth = RSA_PKCS1_SSLeay();
619                 to_return = (*meth->rsa_mod_exp)(r0, I, rsa);
620         } else {
621                 to_return = ubsec_mod_exp_crt(r0, I, rsa->p, rsa->q, rsa->dmp1,
622                         rsa->dmq1, rsa->iqmp, ctx);
623         }
624 err:
625         if(ctx)
626                 BN_CTX_free(ctx);
627         return to_return;
628         }
629 #endif
630
631 static int ubsec_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
632                         const BIGNUM *q, const BIGNUM *dp,
633                         const BIGNUM *dq, const BIGNUM *qinv, BN_CTX *ctx)
634         {
635         int     y_len,
636                 m_len,
637                 fd;
638
639         m_len = BN_num_bytes(p) + BN_num_bytes(q) + 1;
640         y_len = BN_num_bits(p) + BN_num_bits(q);
641
642         /* Check if hardware can't handle this argument. */
643         if (y_len > 1024) {
644                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL);
645                 return 0;
646         } 
647
648         if (!bn_wexpand(r, p->top + q->top + 1)) {
649                 UBSECerr(UBSEC_F_UBSEC_RSA_MOD_EXP_CRT, UBSEC_R_BN_EXPAND_FAIL);
650                 return 0;
651         }
652
653         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
654                 fd = 0;
655                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
656                 return 0;
657         }
658
659         if (p_UBSEC_rsa_mod_exp_crt_ioctl(fd,
660                 (unsigned char *)a->d, BN_num_bits(a), 
661                 (unsigned char *)qinv->d, BN_num_bits(qinv),
662                 (unsigned char *)dp->d, BN_num_bits(dp),
663                 (unsigned char *)p->d, BN_num_bits(p),
664                 (unsigned char *)dq->d, BN_num_bits(dq),
665                 (unsigned char *)q->d, BN_num_bits(q),
666                 (unsigned char *)r->d,  &y_len) != 0) {
667                 UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_REQUEST_FAILED);
668                 return 0;
669         }
670
671         p_UBSEC_ubsec_close(fd);
672
673         r->top = (BN_num_bits(p) + BN_num_bits(q) + BN_BITS2 - 1)/BN_BITS2;
674         return 1;
675 }
676
677 #ifndef OPENSSL_NO_DSA
678 #if NOT_USED
679 static int ubsec_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
680                 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
681                 BN_CTX *ctx, BN_MONT_CTX *in_mont)
682         {
683         BIGNUM t;
684         int to_return = 0;
685  
686         BN_init(&t);
687         /* let rr = a1 ^ p1 mod m */
688         if (!ubsec_mod_exp(rr,a1,p1,m,ctx)) goto end;
689         /* let t = a2 ^ p2 mod m */
690         if (!ubsec_mod_exp(&t,a2,p2,m,ctx)) goto end;
691         /* let rr = rr * t mod m */
692         if (!BN_mod_mul(rr,rr,&t,m,ctx)) goto end;
693         to_return = 1;
694 end:
695         BN_free(&t);
696         return to_return;
697         }
698
699 static int ubsec_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
700                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
701                 BN_MONT_CTX *m_ctx)
702         {
703         return ubsec_mod_exp(r, a, p, m, ctx);
704         }
705 #endif
706 #endif
707
708 /*
709  * This function is aliased to mod_exp (with the mont stuff dropped).
710  */
711 static int ubsec_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
712                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
713         {
714         int ret = 0;
715
716 #ifndef OPENSSL_NO_RSA
717         /* Do in software if the key is too large for the hardware. */
718         if (BN_num_bits(m) > 1024)
719                 {
720                 const RSA_METHOD *meth = RSA_PKCS1_SSLeay();
721                 ret = (*meth->bn_mod_exp)(r, a, p, m, ctx, m_ctx);
722                 }
723         else
724 #endif
725                 {
726                 ret = ubsec_mod_exp(r, a, p, m, ctx);
727                 }
728         
729         return ret;
730         }
731
732 #ifndef OPENSSL_NO_DH
733 /* This function is aliased to mod_exp (with the dh and mont dropped). */
734 static int ubsec_mod_exp_dh(const DH *dh, BIGNUM *r, const BIGNUM *a,
735                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
736                 BN_MONT_CTX *m_ctx)
737         {
738         return ubsec_mod_exp(r, a, p, m, ctx);
739         }
740 #endif
741
742 #ifndef OPENSSL_NO_DSA
743 static DSA_SIG *ubsec_dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa)
744         {
745         DSA_SIG *to_return = NULL;
746         int s_len = 160, r_len = 160, d_len, fd;
747         BIGNUM m, *r=NULL, *s=NULL;
748
749         BN_init(&m);
750
751         s = BN_new();
752         r = BN_new();
753         if ((s == NULL) || (r==NULL))
754                 goto err;
755
756         d_len = p_UBSEC_ubsec_bytes_to_bits((unsigned char *)dgst, dlen);
757
758         if(!bn_wexpand(r, (160+BN_BITS2-1)/BN_BITS2) ||
759            (!bn_wexpand(s, (160+BN_BITS2-1)/BN_BITS2))) {
760                 UBSECerr(UBSEC_F_UBSEC_DSA_SIGN, UBSEC_R_BN_EXPAND_FAIL);
761                 goto err;
762         }
763
764         if (BN_bin2bn(dgst,dlen,&m) == NULL) {
765                 UBSECerr(UBSEC_F_UBSEC_DSA_SIGN, UBSEC_R_BN_EXPAND_FAIL);
766                 goto err;
767         } 
768
769         if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
770                 fd = 0;
771                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
772                 return 0;
773         }
774
775         if (p_UBSEC_dsa_sign_ioctl(fd, 0, /* compute hash before signing */
776                 (unsigned char *)dgst, d_len,
777                 NULL, 0,  /* compute random value */
778                 (unsigned char *)dsa->p->d, BN_num_bits(dsa->p), 
779                 (unsigned char *)dsa->q->d, BN_num_bits(dsa->q),
780                 (unsigned char *)dsa->g->d, BN_num_bits(dsa->g),
781                 (unsigned char *)dsa->priv_key->d, BN_num_bits(dsa->priv_key),
782                 (unsigned char *)r->d, &r_len,
783                 (unsigned char *)s->d, &s_len ) != 0) {
784                 UBSECerr(UBSEC_F_UBSEC_DSA_SIGN, UBSEC_R_REQUEST_FAILED);
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                 fd = 0;
832                 UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
833                 return 0;
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                 UBSECerr(UBSEC_F_UBSEC_DSA_VERIFY , UBSEC_R_REQUEST_FAILED);
846                 goto err;
847         }
848
849         p_UBSEC_ubsec_close(fd);
850
851         to_return = 1;
852 err:
853         BN_clear_free(&v);
854         return to_return;
855         }
856 #endif
857
858 #ifndef OPENSSL_NO_DH
859 static int ubsec_dh_compute_key (unsigned char *key,const BIGNUM *pub_key,DH *dh)
860         {
861         return 0;
862         }
863
864 static int ubsec_dh_generate_key (DH *dh)
865         {
866         return 0;
867         }
868 #endif
869
870 #ifdef NOT_USED
871 static int ubsec_rand_bytes(unsigned char *buf, int num)
872         {
873         return 0;
874         }
875
876 static int ubsec_rand_status(void)
877         {
878         return 0;
879         }
880 #endif
881
882 /* This stuff is needed if this ENGINE is being compiled into a self-contained
883  * shared-library. */
884 #ifdef ENGINE_DYNAMIC_SUPPORT
885 static int bind_fn(ENGINE *e, const char *id)
886         {
887         if(id && (strcmp(id, engine_ubsec_id) != 0))
888                 return 0;
889         if(!bind_helper(e))
890                 return 0;
891         return 1;
892         }
893 IMPLEMENT_DYNAMIC_CHECK_FN()
894 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
895 #endif /* ENGINE_DYNAMIC_SUPPORT */
896
897 #endif /* !OPENSSL_NO_HW_UBSEC */
898 #endif /* !OPENSSL_NO_HW */