1 /* crypto/engine/hw_atalla.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
61 #include <openssl/crypto.h>
62 #include <openssl/buffer.h>
63 #include <openssl/dso.h>
64 #include <openssl/engine.h>
67 #ifndef OPENSSL_NO_HW_ATALLA
72 #include "vendor_defns/atalla.h"
75 #define ATALLA_LIB_NAME "atalla engine"
76 #include "e_atalla_err.c"
78 static int atalla_destroy(ENGINE *e);
79 static int atalla_init(ENGINE *e);
80 static int atalla_finish(ENGINE *e);
81 static int atalla_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
84 static int atalla_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
85 const BIGNUM *m, BN_CTX *ctx);
87 #ifndef OPENSSL_NO_RSA
89 static int atalla_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa);
91 /* This function is aliased to mod_exp (with the mont stuff dropped). */
92 static int atalla_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
93 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
95 #ifndef OPENSSL_NO_DSA
97 static int atalla_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
98 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
99 BN_CTX *ctx, BN_MONT_CTX *in_mont);
100 static int atalla_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
101 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
105 #ifndef OPENSSL_NO_DH
107 /* This function is alised to mod_exp (with the DH and mont dropped). */
108 static int atalla_mod_exp_dh(const DH *dh, BIGNUM *r,
109 const BIGNUM *a, const BIGNUM *p,
110 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
113 /* The definitions for control commands specific to this engine */
114 #define ATALLA_CMD_SO_PATH ENGINE_CMD_BASE
115 static const ENGINE_CMD_DEFN atalla_cmd_defns[] = {
118 "Specifies the path to the 'atasi' shared library",
119 ENGINE_CMD_FLAG_STRING},
123 #ifndef OPENSSL_NO_RSA
124 /* Our internal RSA_METHOD that we provide pointers to */
125 static RSA_METHOD atalla_rsa =
143 #ifndef OPENSSL_NO_DSA
144 /* Our internal DSA_METHOD that we provide pointers to */
145 static DSA_METHOD atalla_dsa =
148 NULL, /* dsa_do_sign */
149 NULL, /* dsa_sign_setup */
150 NULL, /* dsa_do_verify */
151 atalla_dsa_mod_exp, /* dsa_mod_exp */
152 atalla_mod_exp_dsa, /* bn_mod_exp */
160 #ifndef OPENSSL_NO_DH
161 /* Our internal DH_METHOD that we provide pointers to */
162 static DH_METHOD atalla_dh =
175 /* Constants used when creating the ENGINE */
176 static const char *engine_atalla_id = "atalla";
177 static const char *engine_atalla_name = "Atalla hardware engine support";
179 /* This internal function is used by ENGINE_atalla() and possibly by the
180 * "dynamic" ENGINE support too */
181 static int bind_helper(ENGINE *e)
183 #ifndef OPENSSL_NO_RSA
184 const RSA_METHOD *meth1;
186 #ifndef OPENSSL_NO_DSA
187 const DSA_METHOD *meth2;
189 #ifndef OPENSSL_NO_DH
190 const DH_METHOD *meth3;
192 if(!ENGINE_set_id(e, engine_atalla_id) ||
193 !ENGINE_set_name(e, engine_atalla_name) ||
194 #ifndef OPENSSL_NO_RSA
195 !ENGINE_set_RSA(e, &atalla_rsa) ||
197 #ifndef OPENSSL_NO_DSA
198 !ENGINE_set_DSA(e, &atalla_dsa) ||
200 #ifndef OPENSSL_NO_DH
201 !ENGINE_set_DH(e, &atalla_dh) ||
203 !ENGINE_set_destroy_function(e, atalla_destroy) ||
204 !ENGINE_set_init_function(e, atalla_init) ||
205 !ENGINE_set_finish_function(e, atalla_finish) ||
206 !ENGINE_set_ctrl_function(e, atalla_ctrl) ||
207 !ENGINE_set_cmd_defns(e, atalla_cmd_defns))
210 #ifndef OPENSSL_NO_RSA
211 /* We know that the "PKCS1_SSLeay()" functions hook properly
212 * to the atalla-specific mod_exp and mod_exp_crt so we use
213 * those functions. NB: We don't use ENGINE_openssl() or
214 * anything "more generic" because something like the RSAref
215 * code may not hook properly, and if you own one of these
216 * cards then you have the right to do RSA operations on it
218 meth1 = RSA_PKCS1_SSLeay();
219 atalla_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
220 atalla_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
221 atalla_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
222 atalla_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
225 #ifndef OPENSSL_NO_DSA
226 /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
228 meth2 = DSA_OpenSSL();
229 atalla_dsa.dsa_do_sign = meth2->dsa_do_sign;
230 atalla_dsa.dsa_sign_setup = meth2->dsa_sign_setup;
231 atalla_dsa.dsa_do_verify = meth2->dsa_do_verify;
234 #ifndef OPENSSL_NO_DH
235 /* Much the same for Diffie-Hellman */
236 meth3 = DH_OpenSSL();
237 atalla_dh.generate_key = meth3->generate_key;
238 atalla_dh.compute_key = meth3->compute_key;
241 /* Ensure the atalla error handling is set up */
242 ERR_load_ATALLA_strings();
246 static ENGINE *engine_atalla(void)
248 ENGINE *ret = ENGINE_new();
251 if(!bind_helper(ret))
259 void ENGINE_load_atalla(void)
261 /* Copied from eng_[openssl|dyn].c */
262 ENGINE *toadd = engine_atalla();
269 /* This is a process-global DSO handle used for loading and unloading
270 * the Atalla library. NB: This is only set (or unset) during an
271 * init() or finish() call (reference counts permitting) and they're
272 * operating with global locks, so this should be thread-safe
274 static DSO *atalla_dso = NULL;
276 /* These are the function pointers that are (un)set when the library has
277 * successfully (un)loaded. */
278 static tfnASI_GetHardwareConfig *p_Atalla_GetHardwareConfig = NULL;
279 static tfnASI_RSAPrivateKeyOpFn *p_Atalla_RSAPrivateKeyOpFn = NULL;
280 static tfnASI_GetPerformanceStatistics *p_Atalla_GetPerformanceStatistics = NULL;
282 /* These are the static string constants for the DSO file name and the function
283 * symbol names to bind to. Regrettably, the DSO name on *nix appears to be
284 * "atasi.so" rather than something more consistent like "libatasi.so". At the
285 * time of writing, I'm not sure what the file name on win32 is but clearly
286 * native name translation is not possible (eg libatasi.so on *nix, and
287 * atasi.dll on win32). For the purposes of testing, I have created a symbollic
288 * link called "libatasi.so" so that we can use native name-translation - a
289 * better solution will be needed. */
290 static const char *ATALLA_LIBNAME = NULL;
291 static const char *get_ATALLA_LIBNAME(void)
294 return ATALLA_LIBNAME;
297 static void free_ATALLA_LIBNAME(void)
300 OPENSSL_free((void*)ATALLA_LIBNAME);
301 ATALLA_LIBNAME = NULL;
303 static long set_ATALLA_LIBNAME(const char *name)
305 free_ATALLA_LIBNAME();
306 return (((ATALLA_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
308 static const char *ATALLA_F1 = "ASI_GetHardwareConfig";
309 static const char *ATALLA_F2 = "ASI_RSAPrivateKeyOpFn";
310 static const char *ATALLA_F3 = "ASI_GetPerformanceStatistics";
312 /* Destructor (complements the "ENGINE_atalla()" constructor) */
313 static int atalla_destroy(ENGINE *e)
315 free_ATALLA_LIBNAME();
316 /* Unload the atalla error strings so any error state including our
317 * functs or reasons won't lead to a segfault (they simply get displayed
318 * without corresponding string data because none will be found). */
319 ERR_unload_ATALLA_strings();
323 /* (de)initialisation functions. */
324 static int atalla_init(ENGINE *e)
326 tfnASI_GetHardwareConfig *p1;
327 tfnASI_RSAPrivateKeyOpFn *p2;
328 tfnASI_GetPerformanceStatistics *p3;
329 /* Not sure of the origin of this magic value, but Ben's code had it
330 * and it seemed to have been working for a few people. :-) */
331 unsigned int config_buf[1024];
333 if(atalla_dso != NULL)
335 ATALLAerr(ATALLA_F_ATALLA_INIT,ATALLA_R_ALREADY_LOADED);
338 /* Attempt to load libatasi.so/atasi.dll/whatever. Needs to be
339 * changed unfortunately because the Atalla drivers don't have
340 * standard library names that can be platform-translated well. */
341 /* TODO: Work out how to actually map to the names the Atalla
342 * drivers really use - for now a symbollic link needs to be
343 * created on the host system from libatasi.so to atasi.so on
345 atalla_dso = DSO_load(NULL, get_ATALLA_LIBNAME(), NULL, 0);
346 if(atalla_dso == NULL)
348 ATALLAerr(ATALLA_F_ATALLA_INIT,ATALLA_R_NOT_LOADED);
351 if(!(p1 = (tfnASI_GetHardwareConfig *)DSO_bind_func(
352 atalla_dso, ATALLA_F1)) ||
353 !(p2 = (tfnASI_RSAPrivateKeyOpFn *)DSO_bind_func(
354 atalla_dso, ATALLA_F2)) ||
355 !(p3 = (tfnASI_GetPerformanceStatistics *)DSO_bind_func(
356 atalla_dso, ATALLA_F3)))
358 ATALLAerr(ATALLA_F_ATALLA_INIT,ATALLA_R_NOT_LOADED);
361 /* Copy the pointers */
362 p_Atalla_GetHardwareConfig = p1;
363 p_Atalla_RSAPrivateKeyOpFn = p2;
364 p_Atalla_GetPerformanceStatistics = p3;
365 /* Perform a basic test to see if there's actually any unit
367 if(p1(0L, config_buf) != 0)
369 ATALLAerr(ATALLA_F_ATALLA_INIT,ATALLA_R_UNIT_FAILURE);
372 /* Everything's fine. */
376 DSO_free(atalla_dso);
377 p_Atalla_GetHardwareConfig = NULL;
378 p_Atalla_RSAPrivateKeyOpFn = NULL;
379 p_Atalla_GetPerformanceStatistics = NULL;
383 static int atalla_finish(ENGINE *e)
385 free_ATALLA_LIBNAME();
386 if(atalla_dso == NULL)
388 ATALLAerr(ATALLA_F_ATALLA_FINISH,ATALLA_R_NOT_LOADED);
391 if(!DSO_free(atalla_dso))
393 ATALLAerr(ATALLA_F_ATALLA_FINISH,ATALLA_R_UNIT_FAILURE);
397 p_Atalla_GetHardwareConfig = NULL;
398 p_Atalla_RSAPrivateKeyOpFn = NULL;
399 p_Atalla_GetPerformanceStatistics = NULL;
403 static int atalla_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)())
405 int initialised = ((atalla_dso == NULL) ? 0 : 1);
408 case ATALLA_CMD_SO_PATH:
411 ATALLAerr(ATALLA_F_ATALLA_CTRL,ERR_R_PASSED_NULL_PARAMETER);
416 ATALLAerr(ATALLA_F_ATALLA_CTRL,ATALLA_R_ALREADY_LOADED);
419 return set_ATALLA_LIBNAME((const char *)p);
423 ATALLAerr(ATALLA_F_ATALLA_CTRL,ATALLA_R_CTRL_COMMAND_NOT_IMPLEMENTED);
427 static int atalla_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
428 const BIGNUM *m, BN_CTX *ctx)
430 /* I need somewhere to store temporary serialised values for
431 * use with the Atalla API calls. A neat cheat - I'll use
432 * BIGNUMs from the BN_CTX but access their arrays directly as
433 * byte arrays <grin>. This way I don't have to clean anything
439 RSAPrivateKey keydata;
440 int to_return, numbytes;
442 modulus = exponent = argument = result = NULL;
443 to_return = 0; /* expect failure */
447 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP,ATALLA_R_NOT_LOADED);
450 /* Prepare the params */
452 modulus = BN_CTX_get(ctx);
453 exponent = BN_CTX_get(ctx);
454 argument = BN_CTX_get(ctx);
455 result = BN_CTX_get(ctx);
458 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP,ATALLA_R_BN_CTX_FULL);
461 if(!bn_wexpand(modulus, m->top) || !bn_wexpand(exponent, m->top) ||
462 !bn_wexpand(argument, m->top) || !bn_wexpand(result, m->top))
464 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP,ATALLA_R_BN_EXPAND_FAIL);
467 /* Prepare the key-data */
468 memset(&keydata, 0,sizeof keydata);
469 numbytes = BN_num_bytes(m);
470 memset(exponent->d, 0, numbytes);
471 memset(modulus->d, 0, numbytes);
472 BN_bn2bin(p, (unsigned char *)exponent->d + numbytes - BN_num_bytes(p));
473 BN_bn2bin(m, (unsigned char *)modulus->d + numbytes - BN_num_bytes(m));
474 keydata.privateExponent.data = (unsigned char *)exponent->d;
475 keydata.privateExponent.len = numbytes;
476 keydata.modulus.data = (unsigned char *)modulus->d;
477 keydata.modulus.len = numbytes;
478 /* Prepare the argument */
479 memset(argument->d, 0, numbytes);
480 memset(result->d, 0, numbytes);
481 BN_bn2bin(a, (unsigned char *)argument->d + numbytes - BN_num_bytes(a));
482 /* Perform the operation */
483 if(p_Atalla_RSAPrivateKeyOpFn(&keydata, (unsigned char *)result->d,
484 (unsigned char *)argument->d,
485 keydata.modulus.len) != 0)
487 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP,ATALLA_R_REQUEST_FAILED);
490 /* Convert the response */
491 BN_bin2bn((unsigned char *)result->d, numbytes, r);
498 #ifndef OPENSSL_NO_RSA
499 static int atalla_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa)
506 ATALLAerr(ATALLA_F_ATALLA_RSA_MOD_EXP,ATALLA_R_NOT_LOADED);
509 if((ctx = BN_CTX_new()) == NULL)
511 if(!rsa->d || !rsa->n)
513 ATALLAerr(ATALLA_F_ATALLA_RSA_MOD_EXP,ATALLA_R_MISSING_KEY_COMPONENTS);
516 to_return = atalla_mod_exp(r0, I, rsa->d, rsa->n, ctx);
524 #ifndef OPENSSL_NO_DSA
525 /* This code was liberated and adapted from the commented-out code in
526 * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
527 * (it doesn't have a CRT form for RSA), this function means that an
528 * Atalla system running with a DSA server certificate can handshake
529 * around 5 or 6 times faster/more than an equivalent system running with
530 * RSA. Just check out the "signs" statistics from the RSA and DSA parts
531 * of "openssl speed -engine atalla dsa1024 rsa1024". */
532 static int atalla_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
533 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
534 BN_CTX *ctx, BN_MONT_CTX *in_mont)
540 /* let rr = a1 ^ p1 mod m */
541 if (!atalla_mod_exp(rr,a1,p1,m,ctx)) goto end;
542 /* let t = a2 ^ p2 mod m */
543 if (!atalla_mod_exp(&t,a2,p2,m,ctx)) goto end;
544 /* let rr = rr * t mod m */
545 if (!BN_mod_mul(rr,rr,&t,m,ctx)) goto end;
552 static int atalla_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
553 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
556 return atalla_mod_exp(r, a, p, m, ctx);
560 /* This function is aliased to mod_exp (with the mont stuff dropped). */
561 static int atalla_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
562 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
564 return atalla_mod_exp(r, a, p, m, ctx);
567 #ifndef OPENSSL_NO_DH
568 /* This function is aliased to mod_exp (with the dh and mont dropped). */
569 static int atalla_mod_exp_dh(const DH *dh, BIGNUM *r,
570 const BIGNUM *a, const BIGNUM *p,
571 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
573 return atalla_mod_exp(r, a, p, m, ctx);
577 /* This stuff is needed if this ENGINE is being compiled into a self-contained
579 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
580 static int bind_fn(ENGINE *e, const char *id)
582 if(id && (strcmp(id, engine_atalla_id) != 0))
588 IMPLEMENT_DYNAMIC_CHECK_FN()
589 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
590 #endif /* OPENSSL_NO_DYNAMIC_ENGINE */
592 #endif /* !OPENSSL_NO_HW_ATALLA */
593 #endif /* !OPENSSL_NO_HW */