Initialize variable
[openssl.git] / engines / e_cswift.c
1 /* crypto/engine/hw_cswift.c */
2 /*
3  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
4  * 2000.
5  */
6 /* ====================================================================
7  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59
60 #include <stdio.h>
61 #include <string.h>
62 #include <openssl/crypto.h>
63 #include <openssl/buffer.h>
64 #include <openssl/dso.h>
65 #include <openssl/engine.h>
66 #ifndef OPENSSL_NO_RSA
67 # include <openssl/rsa.h>
68 #endif
69 #ifndef OPENSSL_NO_DSA
70 # include <openssl/dsa.h>
71 #endif
72 #ifndef OPENSSL_NO_DH
73 # include <openssl/dh.h>
74 #endif
75 #include <openssl/rand.h>
76 #include <openssl/bn.h>
77
78 #ifndef OPENSSL_NO_HW
79 # ifndef OPENSSL_NO_HW_CSWIFT
80
81 /*
82  * Attribution notice: Rainbow have generously allowed me to reproduce the
83  * necessary definitions here from their API. This means the support can
84  * build independently of whether application builders have the API or
85  * hardware. This will allow developers to easily produce software that has
86  * latent hardware support for any users that have accelerators installed,
87  * without the developers themselves needing anything extra. I have only
88  * clipped the parts from the CryptoSwift header files that are (or seem)
89  * relevant to the CryptoSwift support code. This is simply to keep the file
90  * sizes reasonable. [Geoff]
91  */
92 #  ifdef FLAT_INC
93 #   include "cswift.h"
94 #  else
95 #   include "vendor_defns/cswift.h"
96 #  endif
97
98 #  define CSWIFT_LIB_NAME "cswift engine"
99 #  include "e_cswift_err.c"
100
101 #  define DECIMAL_SIZE(type)      ((sizeof(type)*8+2)/3+1)
102
103 static int cswift_destroy(ENGINE *e);
104 static int cswift_init(ENGINE *e);
105 static int cswift_finish(ENGINE *e);
106 static int cswift_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
107 #  ifndef OPENSSL_NO_RSA
108 static int cswift_bn_32copy(SW_LARGENUMBER *out, const BIGNUM *in);
109 #  endif
110
111 /* BIGNUM stuff */
112 static int cswift_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
113                           const BIGNUM *m, BN_CTX *ctx);
114 #  ifndef OPENSSL_NO_RSA
115 static int cswift_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
116                               const BIGNUM *q, const BIGNUM *dmp1,
117                               const BIGNUM *dmq1, const BIGNUM *iqmp,
118                               BN_CTX *ctx);
119 #  endif
120
121 #  ifndef OPENSSL_NO_RSA
122 /* RSA stuff */
123 static int cswift_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa,
124                               BN_CTX *ctx);
125 /* This function is aliased to mod_exp (with the mont stuff dropped). */
126 static int cswift_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
127                                const BIGNUM *m, BN_CTX *ctx,
128                                BN_MONT_CTX *m_ctx);
129 #  endif
130
131 #  ifndef OPENSSL_NO_DSA
132 /* DSA stuff */
133 static DSA_SIG *cswift_dsa_sign(const unsigned char *dgst, int dlen,
134                                 DSA *dsa);
135 static int cswift_dsa_verify(const unsigned char *dgst, int dgst_len,
136                              DSA_SIG *sig, DSA *dsa);
137 #  endif
138
139 #  ifndef OPENSSL_NO_DH
140 /* DH stuff */
141 /* This function is alised to mod_exp (with the DH and mont dropped). */
142 static int cswift_mod_exp_dh(const DH *dh, BIGNUM *r,
143                              const BIGNUM *a, const BIGNUM *p,
144                              const BIGNUM *m, BN_CTX *ctx,
145                              BN_MONT_CTX *m_ctx);
146 #  endif
147
148 /* RAND stuff */
149 static int cswift_rand_bytes(unsigned char *buf, int num);
150 static int cswift_rand_status(void);
151
152 /* The definitions for control commands specific to this engine */
153 #  define CSWIFT_CMD_SO_PATH              ENGINE_CMD_BASE
154 static const ENGINE_CMD_DEFN cswift_cmd_defns[] = {
155     {CSWIFT_CMD_SO_PATH,
156      "SO_PATH",
157      "Specifies the path to the 'cswift' shared library",
158      ENGINE_CMD_FLAG_STRING},
159     {0, NULL, NULL, 0}
160 };
161
162 #  ifndef OPENSSL_NO_RSA
163 /* Our internal RSA_METHOD that we provide pointers to */
164 static RSA_METHOD cswift_rsa = {
165     "CryptoSwift RSA method",
166     NULL,
167     NULL,
168     NULL,
169     NULL,
170     cswift_rsa_mod_exp,
171     cswift_mod_exp_mont,
172     NULL,
173     NULL,
174     0,
175     NULL,
176     NULL,
177     NULL,
178     NULL
179 };
180 #  endif
181
182 #  ifndef OPENSSL_NO_DSA
183 /* Our internal DSA_METHOD that we provide pointers to */
184 static DSA_METHOD cswift_dsa = {
185     "CryptoSwift DSA method",
186     cswift_dsa_sign,
187     NULL,                       /* dsa_sign_setup */
188     cswift_dsa_verify,
189     NULL,                       /* dsa_mod_exp */
190     NULL,                       /* bn_mod_exp */
191     NULL,                       /* init */
192     NULL,                       /* finish */
193     0,                          /* flags */
194     NULL,                       /* app_data */
195     NULL,                       /* dsa_paramgen */
196     NULL                        /* dsa_keygen */
197 };
198 #  endif
199
200 #  ifndef OPENSSL_NO_DH
201 /* Our internal DH_METHOD that we provide pointers to */
202 static DH_METHOD cswift_dh = {
203     "CryptoSwift DH method",
204     NULL,
205     NULL,
206     cswift_mod_exp_dh,
207     NULL,
208     NULL,
209     0,
210     NULL,
211     NULL
212 };
213 #  endif
214
215 static RAND_METHOD cswift_random = {
216     /* "CryptoSwift RAND method", */
217     NULL,
218     cswift_rand_bytes,
219     NULL,
220     NULL,
221     cswift_rand_bytes,
222     cswift_rand_status,
223 };
224
225 /* Constants used when creating the ENGINE */
226 static const char *engine_cswift_id = "cswift";
227 static const char *engine_cswift_name = "CryptoSwift hardware engine support";
228
229 /*
230  * This internal function is used by ENGINE_cswift() and possibly by the
231  * "dynamic" ENGINE support too
232  */
233 static int bind_helper(ENGINE *e)
234 {
235 #  ifndef OPENSSL_NO_RSA
236     const RSA_METHOD *meth1;
237 #  endif
238 #  ifndef OPENSSL_NO_DH
239     const DH_METHOD *meth2;
240 #  endif
241     if (!ENGINE_set_id(e, engine_cswift_id) ||
242         !ENGINE_set_name(e, engine_cswift_name) ||
243 #  ifndef OPENSSL_NO_RSA
244         !ENGINE_set_RSA(e, &cswift_rsa) ||
245 #  endif
246 #  ifndef OPENSSL_NO_DSA
247         !ENGINE_set_DSA(e, &cswift_dsa) ||
248 #  endif
249 #  ifndef OPENSSL_NO_DH
250         !ENGINE_set_DH(e, &cswift_dh) ||
251 #  endif
252         !ENGINE_set_RAND(e, &cswift_random) ||
253         !ENGINE_set_destroy_function(e, cswift_destroy) ||
254         !ENGINE_set_init_function(e, cswift_init) ||
255         !ENGINE_set_finish_function(e, cswift_finish) ||
256         !ENGINE_set_ctrl_function(e, cswift_ctrl) ||
257         !ENGINE_set_cmd_defns(e, cswift_cmd_defns))
258         return 0;
259
260 #  ifndef OPENSSL_NO_RSA
261     /*
262      * We know that the "PKCS1_SSLeay()" functions hook properly to the
263      * cswift-specific mod_exp and mod_exp_crt so we use those functions. NB:
264      * We don't use ENGINE_openssl() or anything "more generic" because
265      * something like the RSAref code may not hook properly, and if you own
266      * one of these cards then you have the right to do RSA operations on it
267      * anyway!
268      */
269     meth1 = RSA_PKCS1_SSLeay();
270     cswift_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
271     cswift_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
272     cswift_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
273     cswift_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
274 #  endif
275
276 #  ifndef OPENSSL_NO_DH
277     /* Much the same for Diffie-Hellman */
278     meth2 = DH_OpenSSL();
279     cswift_dh.generate_key = meth2->generate_key;
280     cswift_dh.compute_key = meth2->compute_key;
281 #  endif
282
283     /* Ensure the cswift error handling is set up */
284     ERR_load_CSWIFT_strings();
285     return 1;
286 }
287
288 #  ifdef OPENSSL_NO_DYNAMIC_ENGINE
289 static ENGINE *engine_cswift(void)
290 {
291     ENGINE *ret = ENGINE_new();
292     if (!ret)
293         return NULL;
294     if (!bind_helper(ret)) {
295         ENGINE_free(ret);
296         return NULL;
297     }
298     return ret;
299 }
300
301 void ENGINE_load_cswift(void)
302 {
303     /* Copied from eng_[openssl|dyn].c */
304     ENGINE *toadd = engine_cswift();
305     if (!toadd)
306         return;
307     ENGINE_add(toadd);
308     ENGINE_free(toadd);
309     ERR_clear_error();
310 }
311 #  endif
312
313 /*
314  * This is a process-global DSO handle used for loading and unloading the
315  * CryptoSwift library. NB: This is only set (or unset) during an init() or
316  * finish() call (reference counts permitting) and they're operating with
317  * global locks, so this should be thread-safe implicitly.
318  */
319 static DSO *cswift_dso = NULL;
320
321 /*
322  * These are the function pointers that are (un)set when the library has
323  * successfully (un)loaded.
324  */
325 t_swAcquireAccContext *p_CSwift_AcquireAccContext = NULL;
326 t_swAttachKeyParam *p_CSwift_AttachKeyParam = NULL;
327 t_swSimpleRequest *p_CSwift_SimpleRequest = NULL;
328 t_swReleaseAccContext *p_CSwift_ReleaseAccContext = NULL;
329
330 /* Used in the DSO operations. */
331 static const char *CSWIFT_LIBNAME = NULL;
332 static const char *get_CSWIFT_LIBNAME(void)
333 {
334     if (CSWIFT_LIBNAME)
335         return CSWIFT_LIBNAME;
336     return "swift";
337 }
338
339 static void free_CSWIFT_LIBNAME(void)
340 {
341     if (CSWIFT_LIBNAME)
342         OPENSSL_free((void *)CSWIFT_LIBNAME);
343     CSWIFT_LIBNAME = NULL;
344 }
345
346 static long set_CSWIFT_LIBNAME(const char *name)
347 {
348     free_CSWIFT_LIBNAME();
349     return (((CSWIFT_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
350 }
351
352 static const char *CSWIFT_F1 = "swAcquireAccContext";
353 static const char *CSWIFT_F2 = "swAttachKeyParam";
354 static const char *CSWIFT_F3 = "swSimpleRequest";
355 static const char *CSWIFT_F4 = "swReleaseAccContext";
356
357 /*
358  * CryptoSwift library functions and mechanics - these are used by the
359  * higher-level functions further down. NB: As and where there's no error
360  * checking, take a look lower down where these functions are called, the
361  * checking and error handling is probably down there.
362  */
363
364 /* utility function to obtain a context */
365 static int get_context(SW_CONTEXT_HANDLE *hac)
366 {
367     SW_STATUS status;
368
369     status = p_CSwift_AcquireAccContext(hac);
370     if (status != SW_OK)
371         return 0;
372     return 1;
373 }
374
375 /* similarly to release one. */
376 static void release_context(SW_CONTEXT_HANDLE hac)
377 {
378     p_CSwift_ReleaseAccContext(hac);
379 }
380
381 /* Destructor (complements the "ENGINE_cswift()" constructor) */
382 static int cswift_destroy(ENGINE *e)
383 {
384     free_CSWIFT_LIBNAME();
385     ERR_unload_CSWIFT_strings();
386     return 1;
387 }
388
389 /* (de)initialisation functions. */
390 static int cswift_init(ENGINE *e)
391 {
392     SW_CONTEXT_HANDLE hac;
393     t_swAcquireAccContext *p1;
394     t_swAttachKeyParam *p2;
395     t_swSimpleRequest *p3;
396     t_swReleaseAccContext *p4;
397
398     if (cswift_dso != NULL) {
399         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_ALREADY_LOADED);
400         goto err;
401     }
402     /* Attempt to load libswift.so/swift.dll/whatever. */
403     cswift_dso = DSO_load(NULL, get_CSWIFT_LIBNAME(), NULL, 0);
404     if (cswift_dso == NULL) {
405         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_NOT_LOADED);
406         goto err;
407     }
408     if (!(p1 = (t_swAcquireAccContext *)
409           DSO_bind_func(cswift_dso, CSWIFT_F1)) ||
410         !(p2 = (t_swAttachKeyParam *)
411           DSO_bind_func(cswift_dso, CSWIFT_F2)) ||
412         !(p3 = (t_swSimpleRequest *)
413           DSO_bind_func(cswift_dso, CSWIFT_F3)) ||
414         !(p4 = (t_swReleaseAccContext *)
415           DSO_bind_func(cswift_dso, CSWIFT_F4))) {
416         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_NOT_LOADED);
417         goto err;
418     }
419     /* Copy the pointers */
420     p_CSwift_AcquireAccContext = p1;
421     p_CSwift_AttachKeyParam = p2;
422     p_CSwift_SimpleRequest = p3;
423     p_CSwift_ReleaseAccContext = p4;
424     /*
425      * Try and get a context - if not, we may have a DSO but no accelerator!
426      */
427     if (!get_context(&hac)) {
428         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_UNIT_FAILURE);
429         goto err;
430     }
431     release_context(hac);
432     /* Everything's fine. */
433     return 1;
434  err:
435     if (cswift_dso) {
436         DSO_free(cswift_dso);
437         cswift_dso = NULL;
438     }
439     p_CSwift_AcquireAccContext = NULL;
440     p_CSwift_AttachKeyParam = NULL;
441     p_CSwift_SimpleRequest = NULL;
442     p_CSwift_ReleaseAccContext = NULL;
443     return 0;
444 }
445
446 static int cswift_finish(ENGINE *e)
447 {
448     free_CSWIFT_LIBNAME();
449     if (cswift_dso == NULL) {
450         CSWIFTerr(CSWIFT_F_CSWIFT_FINISH, CSWIFT_R_NOT_LOADED);
451         return 0;
452     }
453     if (!DSO_free(cswift_dso)) {
454         CSWIFTerr(CSWIFT_F_CSWIFT_FINISH, CSWIFT_R_UNIT_FAILURE);
455         return 0;
456     }
457     cswift_dso = NULL;
458     p_CSwift_AcquireAccContext = NULL;
459     p_CSwift_AttachKeyParam = NULL;
460     p_CSwift_SimpleRequest = NULL;
461     p_CSwift_ReleaseAccContext = NULL;
462     return 1;
463 }
464
465 static int cswift_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
466 {
467     int initialised = ((cswift_dso == NULL) ? 0 : 1);
468     switch (cmd) {
469     case CSWIFT_CMD_SO_PATH:
470         if (p == NULL) {
471             CSWIFTerr(CSWIFT_F_CSWIFT_CTRL, ERR_R_PASSED_NULL_PARAMETER);
472             return 0;
473         }
474         if (initialised) {
475             CSWIFTerr(CSWIFT_F_CSWIFT_CTRL, CSWIFT_R_ALREADY_LOADED);
476             return 0;
477         }
478         return set_CSWIFT_LIBNAME((const char *)p);
479     default:
480         break;
481     }
482     CSWIFTerr(CSWIFT_F_CSWIFT_CTRL, CSWIFT_R_CTRL_COMMAND_NOT_IMPLEMENTED);
483     return 0;
484 }
485
486 /* Un petit mod_exp */
487 static int cswift_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
488                           const BIGNUM *m, BN_CTX *ctx)
489 {
490     /*
491      * I need somewhere to store temporary serialised values for use with the
492      * CryptoSwift API calls. A neat cheat - I'll use BIGNUMs from the BN_CTX
493      * but access their arrays directly as byte arrays <grin>. This way I
494      * don't have to clean anything up.
495      */
496     BIGNUM *modulus;
497     BIGNUM *exponent;
498     BIGNUM *argument;
499     BIGNUM *result;
500     SW_STATUS sw_status;
501     SW_LARGENUMBER arg, res;
502     SW_PARAM sw_param;
503     SW_CONTEXT_HANDLE hac;
504     int to_return, acquired;
505
506     modulus = exponent = argument = result = NULL;
507     to_return = 0;              /* expect failure */
508     acquired = 0;
509
510     if (!get_context(&hac)) {
511         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_UNIT_FAILURE);
512         goto err;
513     }
514     acquired = 1;
515     /* Prepare the params */
516     BN_CTX_start(ctx);
517     modulus = BN_CTX_get(ctx);
518     exponent = BN_CTX_get(ctx);
519     argument = BN_CTX_get(ctx);
520     result = BN_CTX_get(ctx);
521     if (!result) {
522         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_BN_CTX_FULL);
523         goto err;
524     }
525     if (!bn_wexpand(modulus, m->top) || !bn_wexpand(exponent, p->top) ||
526         !bn_wexpand(argument, a->top) || !bn_wexpand(result, m->top)) {
527         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_BN_EXPAND_FAIL);
528         goto err;
529     }
530     sw_param.type = SW_ALG_EXP;
531     sw_param.up.exp.modulus.nbytes = BN_bn2bin(m,
532                                                (unsigned char *)modulus->d);
533     sw_param.up.exp.modulus.value = (unsigned char *)modulus->d;
534     sw_param.up.exp.exponent.nbytes = BN_bn2bin(p,
535                                                 (unsigned char *)exponent->d);
536     sw_param.up.exp.exponent.value = (unsigned char *)exponent->d;
537     /* Attach the key params */
538     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
539     switch (sw_status) {
540     case SW_OK:
541         break;
542     case SW_ERR_INPUT_SIZE:
543         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_BAD_KEY_SIZE);
544         goto err;
545     default:
546         {
547             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
548             CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_REQUEST_FAILED);
549             sprintf(tmpbuf, "%ld", sw_status);
550             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
551         }
552         goto err;
553     }
554     /* Prepare the argument and response */
555     arg.nbytes = BN_bn2bin(a, (unsigned char *)argument->d);
556     arg.value = (unsigned char *)argument->d;
557     res.nbytes = BN_num_bytes(m);
558     memset(result->d, 0, res.nbytes);
559     res.value = (unsigned char *)result->d;
560     /* Perform the operation */
561     if ((sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_MODEXP, &arg, 1,
562                                             &res, 1)) != SW_OK) {
563         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
564         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_REQUEST_FAILED);
565         sprintf(tmpbuf, "%ld", sw_status);
566         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
567         goto err;
568     }
569     /* Convert the response */
570     BN_bin2bn((unsigned char *)result->d, res.nbytes, r);
571     to_return = 1;
572  err:
573     if (acquired)
574         release_context(hac);
575     BN_CTX_end(ctx);
576     return to_return;
577 }
578
579 #  ifndef OPENSSL_NO_RSA
580 int cswift_bn_32copy(SW_LARGENUMBER *out, const BIGNUM *in)
581 {
582     int mod;
583     int numbytes = BN_num_bytes(in);
584
585     mod = 0;
586     while (((out->nbytes = (numbytes + mod)) % 32)) {
587         mod++;
588     }
589     out->value = (unsigned char *)OPENSSL_malloc(out->nbytes);
590     if (!out->value) {
591         return 0;
592     }
593     BN_bn2bin(in, &out->value[mod]);
594     if (mod)
595         memset(out->value, 0, mod);
596
597     return 1;
598 }
599 #  endif
600
601 #  ifndef OPENSSL_NO_RSA
602 /* Un petit mod_exp chinois */
603 static int cswift_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
604                               const BIGNUM *q, const BIGNUM *dmp1,
605                               const BIGNUM *dmq1, const BIGNUM *iqmp,
606                               BN_CTX *ctx)
607 {
608     SW_STATUS sw_status;
609     SW_LARGENUMBER arg, res;
610     SW_PARAM sw_param;
611     SW_CONTEXT_HANDLE hac;
612     BIGNUM *result = NULL;
613     BIGNUM *argument = NULL;
614     int to_return = 0;          /* expect failure */
615     int acquired = 0;
616
617     sw_param.up.crt.p.value = NULL;
618     sw_param.up.crt.q.value = NULL;
619     sw_param.up.crt.dmp1.value = NULL;
620     sw_param.up.crt.dmq1.value = NULL;
621     sw_param.up.crt.iqmp.value = NULL;
622
623     if (!get_context(&hac)) {
624         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_UNIT_FAILURE);
625         goto err;
626     }
627     acquired = 1;
628
629     /* Prepare the params */
630     argument = BN_new();
631     result = BN_new();
632     if (!result || !argument) {
633         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_CTX_FULL);
634         goto err;
635     }
636
637     sw_param.type = SW_ALG_CRT;
638         /************************************************************************/
639     /*
640      * 04/02/2003
641      */
642     /*
643      * Modified by Frederic Giudicelli (deny-all.com) to overcome the
644      */
645     /*
646      * limitation of cswift with values not a multiple of 32
647      */
648         /************************************************************************/
649     if (!cswift_bn_32copy(&sw_param.up.crt.p, p)) {
650         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
651         goto err;
652     }
653     if (!cswift_bn_32copy(&sw_param.up.crt.q, q)) {
654         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
655         goto err;
656     }
657     if (!cswift_bn_32copy(&sw_param.up.crt.dmp1, dmp1)) {
658         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
659         goto err;
660     }
661     if (!cswift_bn_32copy(&sw_param.up.crt.dmq1, dmq1)) {
662         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
663         goto err;
664     }
665     if (!cswift_bn_32copy(&sw_param.up.crt.iqmp, iqmp)) {
666         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
667         goto err;
668     }
669     if (!bn_wexpand(argument, a->top) || !bn_wexpand(result, p->top + q->top)) {
670         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
671         goto err;
672     }
673
674     /* Attach the key params */
675     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
676     switch (sw_status) {
677     case SW_OK:
678         break;
679     case SW_ERR_INPUT_SIZE:
680         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BAD_KEY_SIZE);
681         goto err;
682     default:
683         {
684             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
685             CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_REQUEST_FAILED);
686             sprintf(tmpbuf, "%ld", sw_status);
687             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
688         }
689         goto err;
690     }
691     /* Prepare the argument and response */
692     arg.nbytes = BN_bn2bin(a, (unsigned char *)argument->d);
693     arg.value = (unsigned char *)argument->d;
694     res.nbytes = 2 * BN_num_bytes(p);
695     memset(result->d, 0, res.nbytes);
696     res.value = (unsigned char *)result->d;
697     /* Perform the operation */
698     if ((sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_MODEXP_CRT, &arg, 1,
699                                             &res, 1)) != SW_OK) {
700         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
701         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_REQUEST_FAILED);
702         sprintf(tmpbuf, "%ld", sw_status);
703         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
704         goto err;
705     }
706     /* Convert the response */
707     BN_bin2bn((unsigned char *)result->d, res.nbytes, r);
708     to_return = 1;
709  err:
710     if (sw_param.up.crt.p.value)
711         OPENSSL_free(sw_param.up.crt.p.value);
712     if (sw_param.up.crt.q.value)
713         OPENSSL_free(sw_param.up.crt.q.value);
714     if (sw_param.up.crt.dmp1.value)
715         OPENSSL_free(sw_param.up.crt.dmp1.value);
716     if (sw_param.up.crt.dmq1.value)
717         OPENSSL_free(sw_param.up.crt.dmq1.value);
718     if (sw_param.up.crt.iqmp.value)
719         OPENSSL_free(sw_param.up.crt.iqmp.value);
720     if (result)
721         BN_free(result);
722     if (argument)
723         BN_free(argument);
724     if (acquired)
725         release_context(hac);
726     return to_return;
727 }
728 #  endif
729
730 #  ifndef OPENSSL_NO_RSA
731 static int cswift_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa,
732                               BN_CTX *ctx)
733 {
734     int to_return = 0;
735     const RSA_METHOD *def_rsa_method;
736
737     if (!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp) {
738         CSWIFTerr(CSWIFT_F_CSWIFT_RSA_MOD_EXP,
739                   CSWIFT_R_MISSING_KEY_COMPONENTS);
740         goto err;
741     }
742
743     /* Try the limits of RSA (2048 bits) */
744     if (BN_num_bytes(rsa->p) > 128 ||
745         BN_num_bytes(rsa->q) > 128 ||
746         BN_num_bytes(rsa->dmp1) > 128 ||
747         BN_num_bytes(rsa->dmq1) > 128 || BN_num_bytes(rsa->iqmp) > 128) {
748 #   ifdef RSA_NULL
749         def_rsa_method = RSA_null_method();
750 #   else
751         def_rsa_method = RSA_PKCS1_SSLeay();
752 #   endif
753         if (def_rsa_method)
754             return def_rsa_method->rsa_mod_exp(r0, I, rsa, ctx);
755     }
756
757     to_return = cswift_mod_exp_crt(r0, I, rsa->p, rsa->q, rsa->dmp1,
758                                    rsa->dmq1, rsa->iqmp, ctx);
759  err:
760     return to_return;
761 }
762
763 /* This function is aliased to mod_exp (with the mont stuff dropped). */
764 static int cswift_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
765                                const BIGNUM *m, BN_CTX *ctx,
766                                BN_MONT_CTX *m_ctx)
767 {
768     const RSA_METHOD *def_rsa_method;
769
770     /* Try the limits of RSA (2048 bits) */
771     if (BN_num_bytes(r) > 256 ||
772         BN_num_bytes(a) > 256 || BN_num_bytes(m) > 256) {
773 #   ifdef RSA_NULL
774         def_rsa_method = RSA_null_method();
775 #   else
776         def_rsa_method = RSA_PKCS1_SSLeay();
777 #   endif
778         if (def_rsa_method)
779             return def_rsa_method->bn_mod_exp(r, a, p, m, ctx, m_ctx);
780     }
781
782     return cswift_mod_exp(r, a, p, m, ctx);
783 }
784 #  endif                        /* OPENSSL_NO_RSA */
785
786 #  ifndef OPENSSL_NO_DSA
787 static DSA_SIG *cswift_dsa_sign(const unsigned char *dgst, int dlen, DSA *dsa)
788 {
789     SW_CONTEXT_HANDLE hac;
790     SW_PARAM sw_param;
791     SW_STATUS sw_status;
792     SW_LARGENUMBER arg, res;
793     BN_CTX *ctx;
794     BIGNUM *dsa_p = NULL;
795     BIGNUM *dsa_q = NULL;
796     BIGNUM *dsa_g = NULL;
797     BIGNUM *dsa_key = NULL;
798     BIGNUM *result = NULL;
799     DSA_SIG *to_return = NULL;
800     int acquired = 0;
801
802     if ((ctx = BN_CTX_new()) == NULL)
803         goto err;
804     if (!get_context(&hac)) {
805         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_UNIT_FAILURE);
806         goto err;
807     }
808     acquired = 1;
809     /* Prepare the params */
810     BN_CTX_start(ctx);
811     dsa_p = BN_CTX_get(ctx);
812     dsa_q = BN_CTX_get(ctx);
813     dsa_g = BN_CTX_get(ctx);
814     dsa_key = BN_CTX_get(ctx);
815     result = BN_CTX_get(ctx);
816     if (!result) {
817         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_BN_CTX_FULL);
818         goto err;
819     }
820     if (!bn_wexpand(dsa_p, dsa->p->top) ||
821         !bn_wexpand(dsa_q, dsa->q->top) ||
822         !bn_wexpand(dsa_g, dsa->g->top) ||
823         !bn_wexpand(dsa_key, dsa->priv_key->top) ||
824         !bn_wexpand(result, dsa->p->top)) {
825         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_BN_EXPAND_FAIL);
826         goto err;
827     }
828     sw_param.type = SW_ALG_DSA;
829     sw_param.up.dsa.p.nbytes = BN_bn2bin(dsa->p, (unsigned char *)dsa_p->d);
830     sw_param.up.dsa.p.value = (unsigned char *)dsa_p->d;
831     sw_param.up.dsa.q.nbytes = BN_bn2bin(dsa->q, (unsigned char *)dsa_q->d);
832     sw_param.up.dsa.q.value = (unsigned char *)dsa_q->d;
833     sw_param.up.dsa.g.nbytes = BN_bn2bin(dsa->g, (unsigned char *)dsa_g->d);
834     sw_param.up.dsa.g.value = (unsigned char *)dsa_g->d;
835     sw_param.up.dsa.key.nbytes = BN_bn2bin(dsa->priv_key,
836                                            (unsigned char *)dsa_key->d);
837     sw_param.up.dsa.key.value = (unsigned char *)dsa_key->d;
838     /* Attach the key params */
839     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
840     switch (sw_status) {
841     case SW_OK:
842         break;
843     case SW_ERR_INPUT_SIZE:
844         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_BAD_KEY_SIZE);
845         goto err;
846     default:
847         {
848             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
849             CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_REQUEST_FAILED);
850             sprintf(tmpbuf, "%ld", sw_status);
851             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
852         }
853         goto err;
854     }
855     /* Prepare the argument and response */
856     arg.nbytes = dlen;
857     arg.value = (unsigned char *)dgst;
858     res.nbytes = BN_num_bytes(dsa->p);
859     memset(result->d, 0, res.nbytes);
860     res.value = (unsigned char *)result->d;
861     /* Perform the operation */
862     sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_DSS_SIGN, &arg, 1,
863                                        &res, 1);
864     if (sw_status != SW_OK) {
865         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
866         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_REQUEST_FAILED);
867         sprintf(tmpbuf, "%ld", sw_status);
868         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
869         goto err;
870     }
871     /* Convert the response */
872     if ((to_return = DSA_SIG_new()) == NULL)
873         goto err;
874     to_return->r = BN_bin2bn((unsigned char *)result->d, 20, NULL);
875     to_return->s = BN_bin2bn((unsigned char *)result->d + 20, 20, NULL);
876
877  err:
878     if (acquired)
879         release_context(hac);
880     if (ctx) {
881         BN_CTX_end(ctx);
882         BN_CTX_free(ctx);
883     }
884     return to_return;
885 }
886
887 static int cswift_dsa_verify(const unsigned char *dgst, int dgst_len,
888                              DSA_SIG *sig, DSA *dsa)
889 {
890     SW_CONTEXT_HANDLE hac;
891     SW_PARAM sw_param;
892     SW_STATUS sw_status;
893     SW_LARGENUMBER arg[2], res;
894     unsigned long sig_result;
895     BN_CTX *ctx;
896     BIGNUM *dsa_p = NULL;
897     BIGNUM *dsa_q = NULL;
898     BIGNUM *dsa_g = NULL;
899     BIGNUM *dsa_key = NULL;
900     BIGNUM *argument = NULL;
901     int to_return = -1;
902     int acquired = 0;
903
904     if ((ctx = BN_CTX_new()) == NULL)
905         goto err;
906     if (!get_context(&hac)) {
907         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_UNIT_FAILURE);
908         goto err;
909     }
910     acquired = 1;
911     /* Prepare the params */
912     BN_CTX_start(ctx);
913     dsa_p = BN_CTX_get(ctx);
914     dsa_q = BN_CTX_get(ctx);
915     dsa_g = BN_CTX_get(ctx);
916     dsa_key = BN_CTX_get(ctx);
917     argument = BN_CTX_get(ctx);
918     if (!argument) {
919         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_BN_CTX_FULL);
920         goto err;
921     }
922     if (!bn_wexpand(dsa_p, dsa->p->top) ||
923         !bn_wexpand(dsa_q, dsa->q->top) ||
924         !bn_wexpand(dsa_g, dsa->g->top) ||
925         !bn_wexpand(dsa_key, dsa->pub_key->top) ||
926         !bn_wexpand(argument, 40)) {
927         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_BN_EXPAND_FAIL);
928         goto err;
929     }
930     sw_param.type = SW_ALG_DSA;
931     sw_param.up.dsa.p.nbytes = BN_bn2bin(dsa->p, (unsigned char *)dsa_p->d);
932     sw_param.up.dsa.p.value = (unsigned char *)dsa_p->d;
933     sw_param.up.dsa.q.nbytes = BN_bn2bin(dsa->q, (unsigned char *)dsa_q->d);
934     sw_param.up.dsa.q.value = (unsigned char *)dsa_q->d;
935     sw_param.up.dsa.g.nbytes = BN_bn2bin(dsa->g, (unsigned char *)dsa_g->d);
936     sw_param.up.dsa.g.value = (unsigned char *)dsa_g->d;
937     sw_param.up.dsa.key.nbytes = BN_bn2bin(dsa->pub_key,
938                                            (unsigned char *)dsa_key->d);
939     sw_param.up.dsa.key.value = (unsigned char *)dsa_key->d;
940     /* Attach the key params */
941     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
942     switch (sw_status) {
943     case SW_OK:
944         break;
945     case SW_ERR_INPUT_SIZE:
946         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_BAD_KEY_SIZE);
947         goto err;
948     default:
949         {
950             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
951             CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_REQUEST_FAILED);
952             sprintf(tmpbuf, "%ld", sw_status);
953             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
954         }
955         goto err;
956     }
957     /* Prepare the argument and response */
958     arg[0].nbytes = dgst_len;
959     arg[0].value = (unsigned char *)dgst;
960     arg[1].nbytes = 40;
961     arg[1].value = (unsigned char *)argument->d;
962     memset(arg[1].value, 0, 40);
963     BN_bn2bin(sig->r, arg[1].value + 20 - BN_num_bytes(sig->r));
964     BN_bn2bin(sig->s, arg[1].value + 40 - BN_num_bytes(sig->s));
965     res.nbytes = 4;             /* unsigned long */
966     res.value = (unsigned char *)(&sig_result);
967     /* Perform the operation */
968     sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_DSS_VERIFY, arg, 2,
969                                        &res, 1);
970     if (sw_status != SW_OK) {
971         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
972         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_REQUEST_FAILED);
973         sprintf(tmpbuf, "%ld", sw_status);
974         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
975         goto err;
976     }
977     /* Convert the response */
978     to_return = ((sig_result == 0) ? 0 : 1);
979
980  err:
981     if (acquired)
982         release_context(hac);
983     if (ctx) {
984         BN_CTX_end(ctx);
985         BN_CTX_free(ctx);
986     }
987     return to_return;
988 }
989 #  endif
990
991 #  ifndef OPENSSL_NO_DH
992 /* This function is aliased to mod_exp (with the dh and mont dropped). */
993 static int cswift_mod_exp_dh(const DH *dh, BIGNUM *r,
994                              const BIGNUM *a, const BIGNUM *p,
995                              const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
996 {
997     return cswift_mod_exp(r, a, p, m, ctx);
998 }
999 #  endif
1000
1001 /* Random bytes are good */
1002 static int cswift_rand_bytes(unsigned char *buf, int num)
1003 {
1004     SW_CONTEXT_HANDLE hac;
1005     SW_STATUS swrc;
1006     SW_LARGENUMBER largenum;
1007     int acquired = 0;
1008     int to_return = 0;          /* assume failure */
1009     unsigned char buf32[1024];
1010
1011     if (!get_context(&hac)) {
1012         CSWIFTerr(CSWIFT_F_CSWIFT_RAND_BYTES, CSWIFT_R_UNIT_FAILURE);
1013         goto err;
1014     }
1015     acquired = 1;
1016
1017         /************************************************************************/
1018     /*
1019      * 04/02/2003
1020      */
1021     /*
1022      * Modified by Frederic Giudicelli (deny-all.com) to overcome the
1023      */
1024     /*
1025      * limitation of cswift with values not a multiple of 32
1026      */
1027         /************************************************************************/
1028
1029     while (num >= (int)sizeof(buf32)) {
1030         largenum.value = buf;
1031         largenum.nbytes = sizeof(buf32);
1032         /*-
1033          * tell CryptoSwift how many bytes we want and where we want it.
1034          * Note: - CryptoSwift cannot do more than 4096 bytes at a time.
1035          *       - CryptoSwift can only do multiple of 32-bits.
1036          */
1037         swrc =
1038             p_CSwift_SimpleRequest(hac, SW_CMD_RAND, NULL, 0, &largenum, 1);
1039         if (swrc != SW_OK) {
1040             char tmpbuf[20];
1041             CSWIFTerr(CSWIFT_F_CSWIFT_RAND_BYTES, CSWIFT_R_REQUEST_FAILED);
1042             sprintf(tmpbuf, "%ld", swrc);
1043             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
1044             goto err;
1045         }
1046         buf += sizeof(buf32);
1047         num -= sizeof(buf32);
1048     }
1049     if (num) {
1050         largenum.nbytes = sizeof(buf32);
1051         largenum.value = buf32;
1052         swrc =
1053             p_CSwift_SimpleRequest(hac, SW_CMD_RAND, NULL, 0, &largenum, 1);
1054         if (swrc != SW_OK) {
1055             char tmpbuf[20];
1056             CSWIFTerr(CSWIFT_F_CSWIFT_RAND_BYTES, CSWIFT_R_REQUEST_FAILED);
1057             sprintf(tmpbuf, "%ld", swrc);
1058             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
1059             goto err;
1060         }
1061         memcpy(buf, largenum.value, num);
1062     }
1063
1064     to_return = 1;              /* success */
1065  err:
1066     if (acquired)
1067         release_context(hac);
1068
1069     return to_return;
1070 }
1071
1072 static int cswift_rand_status(void)
1073 {
1074     return 1;
1075 }
1076
1077 /*
1078  * This stuff is needed if this ENGINE is being compiled into a
1079  * self-contained shared-library.
1080  */
1081 #  ifndef OPENSSL_NO_DYNAMIC_ENGINE
1082 static int bind_fn(ENGINE *e, const char *id)
1083 {
1084     if (id && (strcmp(id, engine_cswift_id) != 0))
1085         return 0;
1086     if (!bind_helper(e))
1087         return 0;
1088     return 1;
1089 }
1090
1091 IMPLEMENT_DYNAMIC_CHECK_FN()
1092     IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1093 #  endif                        /* OPENSSL_NO_DYNAMIC_ENGINE */
1094 # endif                         /* !OPENSSL_NO_HW_CSWIFT */
1095 #endif                          /* !OPENSSL_NO_HW */