free NULL cleanup 11
[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     OPENSSL_free(CSWIFT_LIBNAME);
342     CSWIFT_LIBNAME = NULL;
343 }
344
345 static long set_CSWIFT_LIBNAME(const char *name)
346 {
347     free_CSWIFT_LIBNAME();
348     return (((CSWIFT_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
349 }
350
351 static const char *CSWIFT_F1 = "swAcquireAccContext";
352 static const char *CSWIFT_F2 = "swAttachKeyParam";
353 static const char *CSWIFT_F3 = "swSimpleRequest";
354 static const char *CSWIFT_F4 = "swReleaseAccContext";
355
356 /*
357  * CryptoSwift library functions and mechanics - these are used by the
358  * higher-level functions further down. NB: As and where there's no error
359  * checking, take a look lower down where these functions are called, the
360  * checking and error handling is probably down there.
361  */
362
363 /* utility function to obtain a context */
364 static int get_context(SW_CONTEXT_HANDLE *hac)
365 {
366     SW_STATUS status;
367
368     status = p_CSwift_AcquireAccContext(hac);
369     if (status != SW_OK)
370         return 0;
371     return 1;
372 }
373
374 /* similarly to release one. */
375 static void release_context(SW_CONTEXT_HANDLE hac)
376 {
377     p_CSwift_ReleaseAccContext(hac);
378 }
379
380 /* Destructor (complements the "ENGINE_cswift()" constructor) */
381 static int cswift_destroy(ENGINE *e)
382 {
383     free_CSWIFT_LIBNAME();
384     ERR_unload_CSWIFT_strings();
385     return 1;
386 }
387
388 /* (de)initialisation functions. */
389 static int cswift_init(ENGINE *e)
390 {
391     SW_CONTEXT_HANDLE hac;
392     t_swAcquireAccContext *p1;
393     t_swAttachKeyParam *p2;
394     t_swSimpleRequest *p3;
395     t_swReleaseAccContext *p4;
396
397     if (cswift_dso != NULL) {
398         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_ALREADY_LOADED);
399         goto err;
400     }
401     /* Attempt to load libswift.so/swift.dll/whatever. */
402     cswift_dso = DSO_load(NULL, get_CSWIFT_LIBNAME(), NULL, 0);
403     if (cswift_dso == NULL) {
404         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_NOT_LOADED);
405         goto err;
406     }
407     if (!(p1 = (t_swAcquireAccContext *)
408           DSO_bind_func(cswift_dso, CSWIFT_F1)) ||
409         !(p2 = (t_swAttachKeyParam *)
410           DSO_bind_func(cswift_dso, CSWIFT_F2)) ||
411         !(p3 = (t_swSimpleRequest *)
412           DSO_bind_func(cswift_dso, CSWIFT_F3)) ||
413         !(p4 = (t_swReleaseAccContext *)
414           DSO_bind_func(cswift_dso, CSWIFT_F4))) {
415         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_NOT_LOADED);
416         goto err;
417     }
418     /* Copy the pointers */
419     p_CSwift_AcquireAccContext = p1;
420     p_CSwift_AttachKeyParam = p2;
421     p_CSwift_SimpleRequest = p3;
422     p_CSwift_ReleaseAccContext = p4;
423     /*
424      * Try and get a context - if not, we may have a DSO but no accelerator!
425      */
426     if (!get_context(&hac)) {
427         CSWIFTerr(CSWIFT_F_CSWIFT_INIT, CSWIFT_R_UNIT_FAILURE);
428         goto err;
429     }
430     release_context(hac);
431     /* Everything's fine. */
432     return 1;
433  err:
434     DSO_free(cswift_dso);
435     cswift_dso = NULL;
436     p_CSwift_AcquireAccContext = NULL;
437     p_CSwift_AttachKeyParam = NULL;
438     p_CSwift_SimpleRequest = NULL;
439     p_CSwift_ReleaseAccContext = NULL;
440     return 0;
441 }
442
443 static int cswift_finish(ENGINE *e)
444 {
445     free_CSWIFT_LIBNAME();
446     if (cswift_dso == NULL) {
447         CSWIFTerr(CSWIFT_F_CSWIFT_FINISH, CSWIFT_R_NOT_LOADED);
448         return 0;
449     }
450     if (!DSO_free(cswift_dso)) {
451         CSWIFTerr(CSWIFT_F_CSWIFT_FINISH, CSWIFT_R_UNIT_FAILURE);
452         return 0;
453     }
454     cswift_dso = NULL;
455     p_CSwift_AcquireAccContext = NULL;
456     p_CSwift_AttachKeyParam = NULL;
457     p_CSwift_SimpleRequest = NULL;
458     p_CSwift_ReleaseAccContext = NULL;
459     return 1;
460 }
461
462 static int cswift_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
463 {
464     int initialised = ((cswift_dso == NULL) ? 0 : 1);
465     switch (cmd) {
466     case CSWIFT_CMD_SO_PATH:
467         if (p == NULL) {
468             CSWIFTerr(CSWIFT_F_CSWIFT_CTRL, ERR_R_PASSED_NULL_PARAMETER);
469             return 0;
470         }
471         if (initialised) {
472             CSWIFTerr(CSWIFT_F_CSWIFT_CTRL, CSWIFT_R_ALREADY_LOADED);
473             return 0;
474         }
475         return set_CSWIFT_LIBNAME((const char *)p);
476     default:
477         break;
478     }
479     CSWIFTerr(CSWIFT_F_CSWIFT_CTRL, CSWIFT_R_CTRL_COMMAND_NOT_IMPLEMENTED);
480     return 0;
481 }
482
483 /* Un petit mod_exp */
484 static int cswift_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
485                           const BIGNUM *m, BN_CTX *ctx)
486 {
487     /*
488      * I need somewhere to store temporary serialised values for use with the
489      * CryptoSwift API calls. A neat cheat - I'll use BIGNUMs from the BN_CTX
490      * but access their arrays directly as byte arrays <grin>. This way I
491      * don't have to clean anything up.
492      */
493     BIGNUM *modulus;
494     BIGNUM *exponent;
495     BIGNUM *argument;
496     BIGNUM *result;
497     SW_STATUS sw_status;
498     SW_LARGENUMBER arg, res;
499     SW_PARAM sw_param;
500     SW_CONTEXT_HANDLE hac;
501     int to_return, acquired;
502
503     modulus = exponent = argument = result = NULL;
504     to_return = 0;              /* expect failure */
505     acquired = 0;
506
507     if (!get_context(&hac)) {
508         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_UNIT_FAILURE);
509         goto err;
510     }
511     acquired = 1;
512     /* Prepare the params */
513     BN_CTX_start(ctx);
514     modulus = BN_CTX_get(ctx);
515     exponent = BN_CTX_get(ctx);
516     argument = BN_CTX_get(ctx);
517     result = BN_CTX_get(ctx);
518     if (!result) {
519         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_BN_CTX_FULL);
520         goto err;
521     }
522     if (!bn_wexpand(modulus, m->top) || !bn_wexpand(exponent, p->top) ||
523         !bn_wexpand(argument, a->top) || !bn_wexpand(result, m->top)) {
524         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_BN_EXPAND_FAIL);
525         goto err;
526     }
527     sw_param.type = SW_ALG_EXP;
528     sw_param.up.exp.modulus.nbytes = BN_bn2bin(m,
529                                                (unsigned char *)modulus->d);
530     sw_param.up.exp.modulus.value = (unsigned char *)modulus->d;
531     sw_param.up.exp.exponent.nbytes = BN_bn2bin(p,
532                                                 (unsigned char *)exponent->d);
533     sw_param.up.exp.exponent.value = (unsigned char *)exponent->d;
534     /* Attach the key params */
535     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
536     switch (sw_status) {
537     case SW_OK:
538         break;
539     case SW_ERR_INPUT_SIZE:
540         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_BAD_KEY_SIZE);
541         goto err;
542     default:
543         {
544             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
545             CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_REQUEST_FAILED);
546             sprintf(tmpbuf, "%ld", sw_status);
547             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
548         }
549         goto err;
550     }
551     /* Prepare the argument and response */
552     arg.nbytes = BN_bn2bin(a, (unsigned char *)argument->d);
553     arg.value = (unsigned char *)argument->d;
554     res.nbytes = BN_num_bytes(m);
555     memset(result->d, 0, res.nbytes);
556     res.value = (unsigned char *)result->d;
557     /* Perform the operation */
558     if ((sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_MODEXP, &arg, 1,
559                                             &res, 1)) != SW_OK) {
560         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
561         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP, CSWIFT_R_REQUEST_FAILED);
562         sprintf(tmpbuf, "%ld", sw_status);
563         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
564         goto err;
565     }
566     /* Convert the response */
567     BN_bin2bn((unsigned char *)result->d, res.nbytes, r);
568     to_return = 1;
569  err:
570     if (acquired)
571         release_context(hac);
572     BN_CTX_end(ctx);
573     return to_return;
574 }
575
576 #  ifndef OPENSSL_NO_RSA
577 int cswift_bn_32copy(SW_LARGENUMBER *out, const BIGNUM *in)
578 {
579     int mod;
580     int numbytes = BN_num_bytes(in);
581
582     mod = 0;
583     while (((out->nbytes = (numbytes + mod)) % 32)) {
584         mod++;
585     }
586     out->value = OPENSSL_malloc(out->nbytes);
587     if (!out->value) {
588         return 0;
589     }
590     BN_bn2bin(in, &out->value[mod]);
591     if (mod)
592         memset(out->value, 0, mod);
593
594     return 1;
595 }
596 #  endif
597
598 #  ifndef OPENSSL_NO_RSA
599 /* Un petit mod_exp chinois */
600 static int cswift_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
601                               const BIGNUM *q, const BIGNUM *dmp1,
602                               const BIGNUM *dmq1, const BIGNUM *iqmp,
603                               BN_CTX *ctx)
604 {
605     SW_STATUS sw_status;
606     SW_LARGENUMBER arg, res;
607     SW_PARAM sw_param;
608     SW_CONTEXT_HANDLE hac;
609     BIGNUM *result = NULL;
610     BIGNUM *argument = NULL;
611     int to_return = 0;          /* expect failure */
612     int acquired = 0;
613
614     sw_param.up.crt.p.value = NULL;
615     sw_param.up.crt.q.value = NULL;
616     sw_param.up.crt.dmp1.value = NULL;
617     sw_param.up.crt.dmq1.value = NULL;
618     sw_param.up.crt.iqmp.value = NULL;
619
620     if (!get_context(&hac)) {
621         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_UNIT_FAILURE);
622         goto err;
623     }
624     acquired = 1;
625
626     /* Prepare the params */
627     argument = BN_new();
628     result = BN_new();
629     if (!result || !argument) {
630         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_CTX_FULL);
631         goto err;
632     }
633
634     sw_param.type = SW_ALG_CRT;
635         /************************************************************************/
636     /*
637      * 04/02/2003
638      */
639     /*
640      * Modified by Frederic Giudicelli (deny-all.com) to overcome the
641      */
642     /*
643      * limitation of cswift with values not a multiple of 32
644      */
645         /************************************************************************/
646     if (!cswift_bn_32copy(&sw_param.up.crt.p, p)) {
647         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
648         goto err;
649     }
650     if (!cswift_bn_32copy(&sw_param.up.crt.q, q)) {
651         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
652         goto err;
653     }
654     if (!cswift_bn_32copy(&sw_param.up.crt.dmp1, dmp1)) {
655         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
656         goto err;
657     }
658     if (!cswift_bn_32copy(&sw_param.up.crt.dmq1, dmq1)) {
659         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
660         goto err;
661     }
662     if (!cswift_bn_32copy(&sw_param.up.crt.iqmp, iqmp)) {
663         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
664         goto err;
665     }
666     if (!bn_wexpand(argument, a->top) || !bn_wexpand(result, p->top + q->top)) {
667         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BN_EXPAND_FAIL);
668         goto err;
669     }
670
671     /* Attach the key params */
672     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
673     switch (sw_status) {
674     case SW_OK:
675         break;
676     case SW_ERR_INPUT_SIZE:
677         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_BAD_KEY_SIZE);
678         goto err;
679     default:
680         {
681             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
682             CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_REQUEST_FAILED);
683             sprintf(tmpbuf, "%ld", sw_status);
684             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
685         }
686         goto err;
687     }
688     /* Prepare the argument and response */
689     arg.nbytes = BN_bn2bin(a, (unsigned char *)argument->d);
690     arg.value = (unsigned char *)argument->d;
691     res.nbytes = 2 * BN_num_bytes(p);
692     memset(result->d, 0, res.nbytes);
693     res.value = (unsigned char *)result->d;
694     /* Perform the operation */
695     if ((sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_MODEXP_CRT, &arg, 1,
696                                             &res, 1)) != SW_OK) {
697         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
698         CSWIFTerr(CSWIFT_F_CSWIFT_MOD_EXP_CRT, CSWIFT_R_REQUEST_FAILED);
699         sprintf(tmpbuf, "%ld", sw_status);
700         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
701         goto err;
702     }
703     /* Convert the response */
704     BN_bin2bn((unsigned char *)result->d, res.nbytes, r);
705     to_return = 1;
706  err:
707     OPENSSL_free(sw_param.up.crt.p.value);
708     OPENSSL_free(sw_param.up.crt.q.value);
709     OPENSSL_free(sw_param.up.crt.dmp1.value);
710     OPENSSL_free(sw_param.up.crt.dmq1.value);
711     OPENSSL_free(sw_param.up.crt.iqmp.value);
712     BN_free(result);
713     BN_free(argument);
714     if (acquired)
715         release_context(hac);
716     return to_return;
717 }
718 #  endif
719
720 #  ifndef OPENSSL_NO_RSA
721 static int cswift_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa,
722                               BN_CTX *ctx)
723 {
724     int to_return = 0;
725     const RSA_METHOD *def_rsa_method;
726
727     if (!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp) {
728         CSWIFTerr(CSWIFT_F_CSWIFT_RSA_MOD_EXP,
729                   CSWIFT_R_MISSING_KEY_COMPONENTS);
730         goto err;
731     }
732
733     /* Try the limits of RSA (2048 bits) */
734     if (BN_num_bytes(rsa->p) > 128 ||
735         BN_num_bytes(rsa->q) > 128 ||
736         BN_num_bytes(rsa->dmp1) > 128 ||
737         BN_num_bytes(rsa->dmq1) > 128 || BN_num_bytes(rsa->iqmp) > 128) {
738 #   ifdef RSA_NULL
739         def_rsa_method = RSA_null_method();
740 #   else
741         def_rsa_method = RSA_PKCS1_SSLeay();
742 #   endif
743         if (def_rsa_method)
744             return def_rsa_method->rsa_mod_exp(r0, I, rsa, ctx);
745     }
746
747     to_return = cswift_mod_exp_crt(r0, I, rsa->p, rsa->q, rsa->dmp1,
748                                    rsa->dmq1, rsa->iqmp, ctx);
749  err:
750     return to_return;
751 }
752
753 /* This function is aliased to mod_exp (with the mont stuff dropped). */
754 static int cswift_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
755                                const BIGNUM *m, BN_CTX *ctx,
756                                BN_MONT_CTX *m_ctx)
757 {
758     const RSA_METHOD *def_rsa_method;
759
760     /* Try the limits of RSA (2048 bits) */
761     if (BN_num_bytes(r) > 256 ||
762         BN_num_bytes(a) > 256 || BN_num_bytes(m) > 256) {
763 #   ifdef RSA_NULL
764         def_rsa_method = RSA_null_method();
765 #   else
766         def_rsa_method = RSA_PKCS1_SSLeay();
767 #   endif
768         if (def_rsa_method)
769             return def_rsa_method->bn_mod_exp(r, a, p, m, ctx, m_ctx);
770     }
771
772     return cswift_mod_exp(r, a, p, m, ctx);
773 }
774 #  endif                        /* OPENSSL_NO_RSA */
775
776 #  ifndef OPENSSL_NO_DSA
777 static DSA_SIG *cswift_dsa_sign(const unsigned char *dgst, int dlen, DSA *dsa)
778 {
779     SW_CONTEXT_HANDLE hac;
780     SW_PARAM sw_param;
781     SW_STATUS sw_status;
782     SW_LARGENUMBER arg, res;
783     BN_CTX *ctx;
784     BIGNUM *dsa_p = NULL;
785     BIGNUM *dsa_q = NULL;
786     BIGNUM *dsa_g = NULL;
787     BIGNUM *dsa_key = NULL;
788     BIGNUM *result = NULL;
789     DSA_SIG *to_return = NULL;
790     int acquired = 0;
791
792     if ((ctx = BN_CTX_new()) == NULL)
793         goto err;
794     if (!get_context(&hac)) {
795         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_UNIT_FAILURE);
796         goto err;
797     }
798     acquired = 1;
799     /* Prepare the params */
800     BN_CTX_start(ctx);
801     dsa_p = BN_CTX_get(ctx);
802     dsa_q = BN_CTX_get(ctx);
803     dsa_g = BN_CTX_get(ctx);
804     dsa_key = BN_CTX_get(ctx);
805     result = BN_CTX_get(ctx);
806     if (!result) {
807         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_BN_CTX_FULL);
808         goto err;
809     }
810     if (!bn_wexpand(dsa_p, dsa->p->top) ||
811         !bn_wexpand(dsa_q, dsa->q->top) ||
812         !bn_wexpand(dsa_g, dsa->g->top) ||
813         !bn_wexpand(dsa_key, dsa->priv_key->top) ||
814         !bn_wexpand(result, dsa->p->top)) {
815         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_BN_EXPAND_FAIL);
816         goto err;
817     }
818     sw_param.type = SW_ALG_DSA;
819     sw_param.up.dsa.p.nbytes = BN_bn2bin(dsa->p, (unsigned char *)dsa_p->d);
820     sw_param.up.dsa.p.value = (unsigned char *)dsa_p->d;
821     sw_param.up.dsa.q.nbytes = BN_bn2bin(dsa->q, (unsigned char *)dsa_q->d);
822     sw_param.up.dsa.q.value = (unsigned char *)dsa_q->d;
823     sw_param.up.dsa.g.nbytes = BN_bn2bin(dsa->g, (unsigned char *)dsa_g->d);
824     sw_param.up.dsa.g.value = (unsigned char *)dsa_g->d;
825     sw_param.up.dsa.key.nbytes = BN_bn2bin(dsa->priv_key,
826                                            (unsigned char *)dsa_key->d);
827     sw_param.up.dsa.key.value = (unsigned char *)dsa_key->d;
828     /* Attach the key params */
829     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
830     switch (sw_status) {
831     case SW_OK:
832         break;
833     case SW_ERR_INPUT_SIZE:
834         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_BAD_KEY_SIZE);
835         goto err;
836     default:
837         {
838             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
839             CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_REQUEST_FAILED);
840             sprintf(tmpbuf, "%ld", sw_status);
841             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
842         }
843         goto err;
844     }
845     /* Prepare the argument and response */
846     arg.nbytes = dlen;
847     arg.value = (unsigned char *)dgst;
848     res.nbytes = BN_num_bytes(dsa->p);
849     memset(result->d, 0, res.nbytes);
850     res.value = (unsigned char *)result->d;
851     /* Perform the operation */
852     sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_DSS_SIGN, &arg, 1,
853                                        &res, 1);
854     if (sw_status != SW_OK) {
855         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
856         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_SIGN, CSWIFT_R_REQUEST_FAILED);
857         sprintf(tmpbuf, "%ld", sw_status);
858         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
859         goto err;
860     }
861     /* Convert the response */
862     if ((to_return = DSA_SIG_new()) == NULL)
863         goto err;
864     to_return->r = BN_bin2bn((unsigned char *)result->d, 20, NULL);
865     to_return->s = BN_bin2bn((unsigned char *)result->d + 20, 20, NULL);
866
867  err:
868     if (acquired)
869         release_context(hac);
870     if (ctx)
871         BN_CTX_end(ctx);
872     BN_CTX_free(ctx);
873     return to_return;
874 }
875
876 static int cswift_dsa_verify(const unsigned char *dgst, int dgst_len,
877                              DSA_SIG *sig, DSA *dsa)
878 {
879     SW_CONTEXT_HANDLE hac;
880     SW_PARAM sw_param;
881     SW_STATUS sw_status;
882     SW_LARGENUMBER arg[2], res;
883     unsigned long sig_result;
884     BN_CTX *ctx;
885     BIGNUM *dsa_p = NULL;
886     BIGNUM *dsa_q = NULL;
887     BIGNUM *dsa_g = NULL;
888     BIGNUM *dsa_key = NULL;
889     BIGNUM *argument = NULL;
890     int to_return = -1;
891     int acquired = 0;
892
893     if ((ctx = BN_CTX_new()) == NULL)
894         goto err;
895     if (!get_context(&hac)) {
896         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_UNIT_FAILURE);
897         goto err;
898     }
899     acquired = 1;
900     /* Prepare the params */
901     BN_CTX_start(ctx);
902     dsa_p = BN_CTX_get(ctx);
903     dsa_q = BN_CTX_get(ctx);
904     dsa_g = BN_CTX_get(ctx);
905     dsa_key = BN_CTX_get(ctx);
906     argument = BN_CTX_get(ctx);
907     if (!argument) {
908         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_BN_CTX_FULL);
909         goto err;
910     }
911     if (!bn_wexpand(dsa_p, dsa->p->top) ||
912         !bn_wexpand(dsa_q, dsa->q->top) ||
913         !bn_wexpand(dsa_g, dsa->g->top) ||
914         !bn_wexpand(dsa_key, dsa->pub_key->top) ||
915         !bn_wexpand(argument, 40)) {
916         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_BN_EXPAND_FAIL);
917         goto err;
918     }
919     sw_param.type = SW_ALG_DSA;
920     sw_param.up.dsa.p.nbytes = BN_bn2bin(dsa->p, (unsigned char *)dsa_p->d);
921     sw_param.up.dsa.p.value = (unsigned char *)dsa_p->d;
922     sw_param.up.dsa.q.nbytes = BN_bn2bin(dsa->q, (unsigned char *)dsa_q->d);
923     sw_param.up.dsa.q.value = (unsigned char *)dsa_q->d;
924     sw_param.up.dsa.g.nbytes = BN_bn2bin(dsa->g, (unsigned char *)dsa_g->d);
925     sw_param.up.dsa.g.value = (unsigned char *)dsa_g->d;
926     sw_param.up.dsa.key.nbytes = BN_bn2bin(dsa->pub_key,
927                                            (unsigned char *)dsa_key->d);
928     sw_param.up.dsa.key.value = (unsigned char *)dsa_key->d;
929     /* Attach the key params */
930     sw_status = p_CSwift_AttachKeyParam(hac, &sw_param);
931     switch (sw_status) {
932     case SW_OK:
933         break;
934     case SW_ERR_INPUT_SIZE:
935         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_BAD_KEY_SIZE);
936         goto err;
937     default:
938         {
939             char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
940             CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_REQUEST_FAILED);
941             sprintf(tmpbuf, "%ld", sw_status);
942             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
943         }
944         goto err;
945     }
946     /* Prepare the argument and response */
947     arg[0].nbytes = dgst_len;
948     arg[0].value = (unsigned char *)dgst;
949     arg[1].nbytes = 40;
950     arg[1].value = (unsigned char *)argument->d;
951     memset(arg[1].value, 0, 40);
952     BN_bn2bin(sig->r, arg[1].value + 20 - BN_num_bytes(sig->r));
953     BN_bn2bin(sig->s, arg[1].value + 40 - BN_num_bytes(sig->s));
954     res.nbytes = 4;             /* unsigned long */
955     res.value = (unsigned char *)(&sig_result);
956     /* Perform the operation */
957     sw_status = p_CSwift_SimpleRequest(hac, SW_CMD_DSS_VERIFY, arg, 2,
958                                        &res, 1);
959     if (sw_status != SW_OK) {
960         char tmpbuf[DECIMAL_SIZE(sw_status) + 1];
961         CSWIFTerr(CSWIFT_F_CSWIFT_DSA_VERIFY, CSWIFT_R_REQUEST_FAILED);
962         sprintf(tmpbuf, "%ld", sw_status);
963         ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
964         goto err;
965     }
966     /* Convert the response */
967     to_return = ((sig_result == 0) ? 0 : 1);
968
969  err:
970     if (acquired)
971         release_context(hac);
972     if (ctx)
973         BN_CTX_end(ctx);
974     BN_CTX_free(ctx);
975     return to_return;
976 }
977 #  endif
978
979 #  ifndef OPENSSL_NO_DH
980 /* This function is aliased to mod_exp (with the dh and mont dropped). */
981 static int cswift_mod_exp_dh(const DH *dh, BIGNUM *r,
982                              const BIGNUM *a, const BIGNUM *p,
983                              const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
984 {
985     return cswift_mod_exp(r, a, p, m, ctx);
986 }
987 #  endif
988
989 /* Random bytes are good */
990 static int cswift_rand_bytes(unsigned char *buf, int num)
991 {
992     SW_CONTEXT_HANDLE hac;
993     SW_STATUS swrc;
994     SW_LARGENUMBER largenum;
995     int acquired = 0;
996     int to_return = 0;          /* assume failure */
997     unsigned char buf32[1024];
998
999     if (!get_context(&hac)) {
1000         CSWIFTerr(CSWIFT_F_CSWIFT_RAND_BYTES, CSWIFT_R_UNIT_FAILURE);
1001         goto err;
1002     }
1003     acquired = 1;
1004
1005         /************************************************************************/
1006     /*
1007      * 04/02/2003
1008      */
1009     /*
1010      * Modified by Frederic Giudicelli (deny-all.com) to overcome the
1011      */
1012     /*
1013      * limitation of cswift with values not a multiple of 32
1014      */
1015         /************************************************************************/
1016
1017     while (num >= (int)sizeof(buf32)) {
1018         largenum.value = buf;
1019         largenum.nbytes = sizeof(buf32);
1020         /*-
1021          * tell CryptoSwift how many bytes we want and where we want it.
1022          * Note: - CryptoSwift cannot do more than 4096 bytes at a time.
1023          *       - CryptoSwift can only do multiple of 32-bits.
1024          */
1025         swrc =
1026             p_CSwift_SimpleRequest(hac, SW_CMD_RAND, NULL, 0, &largenum, 1);
1027         if (swrc != SW_OK) {
1028             char tmpbuf[20];
1029             CSWIFTerr(CSWIFT_F_CSWIFT_RAND_BYTES, CSWIFT_R_REQUEST_FAILED);
1030             sprintf(tmpbuf, "%ld", swrc);
1031             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
1032             goto err;
1033         }
1034         buf += sizeof(buf32);
1035         num -= sizeof(buf32);
1036     }
1037     if (num) {
1038         largenum.nbytes = sizeof(buf32);
1039         largenum.value = buf32;
1040         swrc =
1041             p_CSwift_SimpleRequest(hac, SW_CMD_RAND, NULL, 0, &largenum, 1);
1042         if (swrc != SW_OK) {
1043             char tmpbuf[20];
1044             CSWIFTerr(CSWIFT_F_CSWIFT_RAND_BYTES, CSWIFT_R_REQUEST_FAILED);
1045             sprintf(tmpbuf, "%ld", swrc);
1046             ERR_add_error_data(2, "CryptoSwift error number is ", tmpbuf);
1047             goto err;
1048         }
1049         memcpy(buf, largenum.value, num);
1050     }
1051
1052     to_return = 1;              /* success */
1053  err:
1054     if (acquired)
1055         release_context(hac);
1056
1057     return to_return;
1058 }
1059
1060 static int cswift_rand_status(void)
1061 {
1062     return 1;
1063 }
1064
1065 /*
1066  * This stuff is needed if this ENGINE is being compiled into a
1067  * self-contained shared-library.
1068  */
1069 #  ifndef OPENSSL_NO_DYNAMIC_ENGINE
1070 static int bind_fn(ENGINE *e, const char *id)
1071 {
1072     if (id && (strcmp(id, engine_cswift_id) != 0))
1073         return 0;
1074     if (!bind_helper(e))
1075         return 0;
1076     return 1;
1077 }
1078
1079 IMPLEMENT_DYNAMIC_CHECK_FN()
1080     IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1081 #  endif                        /* OPENSSL_NO_DYNAMIC_ENGINE */
1082 # endif                         /* !OPENSSL_NO_HW_CSWIFT */
1083 #endif                          /* !OPENSSL_NO_HW */