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).
60 #include <openssl/crypto.h>
62 #include <openssl/dso.h>
63 #include <openssl/engine.h>
66 #ifndef OPENSSL_NO_HW_ATALLA
71 #include "vendor_defns/atalla.h"
74 #define ATALLA_LIB_NAME "atalla engine"
75 #include "hw_atalla_err.c"
77 static int atalla_destroy(ENGINE
*e
);
78 static int atalla_init(ENGINE
*e
);
79 static int atalla_finish(ENGINE
*e
);
80 static int atalla_ctrl(ENGINE
*e
, int cmd
, long i
, void *p
, void (*f
)());
83 static int atalla_mod_exp(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
84 const BIGNUM
*m
, BN_CTX
*ctx
);
86 #ifndef OPENSSL_NO_RSA
88 static int atalla_rsa_mod_exp(BIGNUM
*r0
, const BIGNUM
*I
, RSA
*rsa
);
90 /* This function is aliased to mod_exp (with the mont stuff dropped). */
91 static int atalla_mod_exp_mont(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
92 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
);
94 #ifndef OPENSSL_NO_DSA
96 static int atalla_dsa_mod_exp(DSA
*dsa
, BIGNUM
*rr
, BIGNUM
*a1
,
97 BIGNUM
*p1
, BIGNUM
*a2
, BIGNUM
*p2
, BIGNUM
*m
,
98 BN_CTX
*ctx
, BN_MONT_CTX
*in_mont
);
99 static int atalla_mod_exp_dsa(DSA
*dsa
, BIGNUM
*r
, BIGNUM
*a
,
100 const BIGNUM
*p
, const BIGNUM
*m
, BN_CTX
*ctx
,
104 #ifndef OPENSSL_NO_DH
106 /* This function is alised to mod_exp (with the DH and mont dropped). */
107 static int atalla_mod_exp_dh(const DH
*dh
, BIGNUM
*r
,
108 const BIGNUM
*a
, const BIGNUM
*p
,
109 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
);
112 /* The definitions for control commands specific to this engine */
113 #define ATALLA_CMD_SO_PATH ENGINE_CMD_BASE
114 static const ENGINE_CMD_DEFN atalla_cmd_defns
[] = {
117 "Specifies the path to the 'atasi' shared library",
118 ENGINE_CMD_FLAG_STRING
},
122 #ifndef OPENSSL_NO_RSA
123 /* Our internal RSA_METHOD that we provide pointers to */
124 static RSA_METHOD atalla_rsa
=
142 #ifndef OPENSSL_NO_DSA
143 /* Our internal DSA_METHOD that we provide pointers to */
144 static DSA_METHOD atalla_dsa
=
147 NULL
, /* dsa_do_sign */
148 NULL
, /* dsa_sign_setup */
149 NULL
, /* dsa_do_verify */
150 atalla_dsa_mod_exp
, /* dsa_mod_exp */
151 atalla_mod_exp_dsa
, /* bn_mod_exp */
159 #ifndef OPENSSL_NO_DH
160 /* Our internal DH_METHOD that we provide pointers to */
161 static DH_METHOD atalla_dh
=
174 /* Constants used when creating the ENGINE */
175 static const char *engine_atalla_id
= "atalla";
176 static const char *engine_atalla_name
= "Atalla hardware engine support";
178 /* This internal function is used by ENGINE_atalla() and possibly by the
179 * "dynamic" ENGINE support too */
180 static int bind_helper(ENGINE
*e
)
182 #ifndef OPENSSL_NO_RSA
183 const RSA_METHOD
*meth1
;
185 #ifndef OPENSSL_NO_DSA
186 const DSA_METHOD
*meth2
;
188 #ifndef OPENSSL_NO_DH
189 const DH_METHOD
*meth3
;
191 if(!ENGINE_set_id(e
, engine_atalla_id
) ||
192 !ENGINE_set_name(e
, engine_atalla_name
) ||
193 #ifndef OPENSSL_NO_RSA
194 !ENGINE_set_RSA(e
, &atalla_rsa
) ||
196 #ifndef OPENSSL_NO_DSA
197 !ENGINE_set_DSA(e
, &atalla_dsa
) ||
199 #ifndef OPENSSL_NO_DH
200 !ENGINE_set_DH(e
, &atalla_dh
) ||
202 !ENGINE_set_destroy_function(e
, atalla_destroy
) ||
203 !ENGINE_set_init_function(e
, atalla_init
) ||
204 !ENGINE_set_finish_function(e
, atalla_finish
) ||
205 !ENGINE_set_ctrl_function(e
, atalla_ctrl
) ||
206 !ENGINE_set_cmd_defns(e
, atalla_cmd_defns
))
209 #ifndef OPENSSL_NO_RSA
210 /* We know that the "PKCS1_SSLeay()" functions hook properly
211 * to the atalla-specific mod_exp and mod_exp_crt so we use
212 * those functions. NB: We don't use ENGINE_openssl() or
213 * anything "more generic" because something like the RSAref
214 * code may not hook properly, and if you own one of these
215 * cards then you have the right to do RSA operations on it
217 meth1
= RSA_PKCS1_SSLeay();
218 atalla_rsa
.rsa_pub_enc
= meth1
->rsa_pub_enc
;
219 atalla_rsa
.rsa_pub_dec
= meth1
->rsa_pub_dec
;
220 atalla_rsa
.rsa_priv_enc
= meth1
->rsa_priv_enc
;
221 atalla_rsa
.rsa_priv_dec
= meth1
->rsa_priv_dec
;
224 #ifndef OPENSSL_NO_DSA
225 /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
227 meth2
= DSA_OpenSSL();
228 atalla_dsa
.dsa_do_sign
= meth2
->dsa_do_sign
;
229 atalla_dsa
.dsa_sign_setup
= meth2
->dsa_sign_setup
;
230 atalla_dsa
.dsa_do_verify
= meth2
->dsa_do_verify
;
233 #ifndef OPENSSL_NO_DH
234 /* Much the same for Diffie-Hellman */
235 meth3
= DH_OpenSSL();
236 atalla_dh
.generate_key
= meth3
->generate_key
;
237 atalla_dh
.compute_key
= meth3
->compute_key
;
240 /* Ensure the atalla error handling is set up */
241 ERR_load_ATALLA_strings();
245 static ENGINE
*engine_atalla(void)
247 ENGINE
*ret
= ENGINE_new();
250 if(!bind_helper(ret
))
258 void ENGINE_load_atalla(void)
260 /* Copied from eng_[openssl|dyn].c */
261 ENGINE
*toadd
= engine_atalla();
268 /* This is a process-global DSO handle used for loading and unloading
269 * the Atalla library. NB: This is only set (or unset) during an
270 * init() or finish() call (reference counts permitting) and they're
271 * operating with global locks, so this should be thread-safe
273 static DSO
*atalla_dso
= NULL
;
275 /* These are the function pointers that are (un)set when the library has
276 * successfully (un)loaded. */
277 static tfnASI_GetHardwareConfig
*p_Atalla_GetHardwareConfig
= NULL
;
278 static tfnASI_RSAPrivateKeyOpFn
*p_Atalla_RSAPrivateKeyOpFn
= NULL
;
279 static tfnASI_GetPerformanceStatistics
*p_Atalla_GetPerformanceStatistics
= NULL
;
281 /* These are the static string constants for the DSO file name and the function
282 * symbol names to bind to. Regrettably, the DSO name on *nix appears to be
283 * "atasi.so" rather than something more consistent like "libatasi.so". At the
284 * time of writing, I'm not sure what the file name on win32 is but clearly
285 * native name translation is not possible (eg libatasi.so on *nix, and
286 * atasi.dll on win32). For the purposes of testing, I have created a symbollic
287 * link called "libatasi.so" so that we can use native name-translation - a
288 * better solution will be needed. */
289 static const char *ATALLA_LIBNAME
= NULL
;
290 static const char *get_ATALLA_LIBNAME(void)
293 return ATALLA_LIBNAME
;
296 static void free_ATALLA_LIBNAME(void)
299 OPENSSL_free((void*)ATALLA_LIBNAME
);
300 ATALLA_LIBNAME
= NULL
;
302 static long set_ATALLA_LIBNAME(const char *name
)
304 free_ATALLA_LIBNAME();
305 return (((ATALLA_LIBNAME
= BUF_strdup(name
)) != NULL
) ? 1 : 0);
307 static const char *ATALLA_F1
= "ASI_GetHardwareConfig";
308 static const char *ATALLA_F2
= "ASI_RSAPrivateKeyOpFn";
309 static const char *ATALLA_F3
= "ASI_GetPerformanceStatistics";
311 /* Destructor (complements the "ENGINE_atalla()" constructor) */
312 static int atalla_destroy(ENGINE
*e
)
314 free_ATALLA_LIBNAME();
315 /* Unload the atalla error strings so any error state including our
316 * functs or reasons won't lead to a segfault (they simply get displayed
317 * without corresponding string data because none will be found). */
318 ERR_unload_ATALLA_strings();
322 /* (de)initialisation functions. */
323 static int atalla_init(ENGINE
*e
)
325 tfnASI_GetHardwareConfig
*p1
;
326 tfnASI_RSAPrivateKeyOpFn
*p2
;
327 tfnASI_GetPerformanceStatistics
*p3
;
328 /* Not sure of the origin of this magic value, but Ben's code had it
329 * and it seemed to have been working for a few people. :-) */
330 unsigned int config_buf
[1024];
332 if(atalla_dso
!= NULL
)
334 ATALLAerr(ATALLA_F_ATALLA_INIT
,ATALLA_R_ALREADY_LOADED
);
337 /* Attempt to load libatasi.so/atasi.dll/whatever. Needs to be
338 * changed unfortunately because the Atalla drivers don't have
339 * standard library names that can be platform-translated well. */
340 /* TODO: Work out how to actually map to the names the Atalla
341 * drivers really use - for now a symbollic link needs to be
342 * created on the host system from libatasi.so to atasi.so on
344 atalla_dso
= DSO_load(NULL
, get_ATALLA_LIBNAME(), NULL
, 0);
345 if(atalla_dso
== NULL
)
347 ATALLAerr(ATALLA_F_ATALLA_INIT
,ATALLA_R_NOT_LOADED
);
350 if(!(p1
= (tfnASI_GetHardwareConfig
*)DSO_bind_func(
351 atalla_dso
, ATALLA_F1
)) ||
352 !(p2
= (tfnASI_RSAPrivateKeyOpFn
*)DSO_bind_func(
353 atalla_dso
, ATALLA_F2
)) ||
354 !(p3
= (tfnASI_GetPerformanceStatistics
*)DSO_bind_func(
355 atalla_dso
, ATALLA_F3
)))
357 ATALLAerr(ATALLA_F_ATALLA_INIT
,ATALLA_R_NOT_LOADED
);
360 /* Copy the pointers */
361 p_Atalla_GetHardwareConfig
= p1
;
362 p_Atalla_RSAPrivateKeyOpFn
= p2
;
363 p_Atalla_GetPerformanceStatistics
= p3
;
364 /* Perform a basic test to see if there's actually any unit
366 if(p1(0L, config_buf
) != 0)
368 ATALLAerr(ATALLA_F_ATALLA_INIT
,ATALLA_R_UNIT_FAILURE
);
371 /* Everything's fine. */
375 DSO_free(atalla_dso
);
376 p_Atalla_GetHardwareConfig
= NULL
;
377 p_Atalla_RSAPrivateKeyOpFn
= NULL
;
378 p_Atalla_GetPerformanceStatistics
= NULL
;
382 static int atalla_finish(ENGINE
*e
)
384 free_ATALLA_LIBNAME();
385 if(atalla_dso
== NULL
)
387 ATALLAerr(ATALLA_F_ATALLA_FINISH
,ATALLA_R_NOT_LOADED
);
390 if(!DSO_free(atalla_dso
))
392 ATALLAerr(ATALLA_F_ATALLA_FINISH
,ATALLA_R_UNIT_FAILURE
);
396 p_Atalla_GetHardwareConfig
= NULL
;
397 p_Atalla_RSAPrivateKeyOpFn
= NULL
;
398 p_Atalla_GetPerformanceStatistics
= NULL
;
402 static int atalla_ctrl(ENGINE
*e
, int cmd
, long i
, void *p
, void (*f
)())
404 int initialised
= ((atalla_dso
== NULL
) ? 0 : 1);
407 case ATALLA_CMD_SO_PATH
:
410 ATALLAerr(ATALLA_F_ATALLA_CTRL
,ERR_R_PASSED_NULL_PARAMETER
);
415 ATALLAerr(ATALLA_F_ATALLA_CTRL
,ATALLA_R_ALREADY_LOADED
);
418 return set_ATALLA_LIBNAME((const char *)p
);
422 ATALLAerr(ATALLA_F_ATALLA_CTRL
,ATALLA_R_CTRL_COMMAND_NOT_IMPLEMENTED
);
426 static int atalla_mod_exp(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
427 const BIGNUM
*m
, BN_CTX
*ctx
)
429 /* I need somewhere to store temporary serialised values for
430 * use with the Atalla API calls. A neat cheat - I'll use
431 * BIGNUMs from the BN_CTX but access their arrays directly as
432 * byte arrays <grin>. This way I don't have to clean anything
438 RSAPrivateKey keydata
;
439 int to_return
, numbytes
;
441 modulus
= exponent
= argument
= result
= NULL
;
442 to_return
= 0; /* expect failure */
446 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP
,ATALLA_R_NOT_LOADED
);
449 /* Prepare the params */
451 modulus
= BN_CTX_get(ctx
);
452 exponent
= BN_CTX_get(ctx
);
453 argument
= BN_CTX_get(ctx
);
454 result
= BN_CTX_get(ctx
);
457 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP
,ATALLA_R_BN_CTX_FULL
);
460 if(!bn_wexpand(modulus
, m
->top
) || !bn_wexpand(exponent
, m
->top
) ||
461 !bn_wexpand(argument
, m
->top
) || !bn_wexpand(result
, m
->top
))
463 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP
,ATALLA_R_BN_EXPAND_FAIL
);
466 /* Prepare the key-data */
467 memset(&keydata
, 0,sizeof keydata
);
468 numbytes
= BN_num_bytes(m
);
469 memset(exponent
->d
, 0, numbytes
);
470 memset(modulus
->d
, 0, numbytes
);
471 BN_bn2bin(p
, (unsigned char *)exponent
->d
+ numbytes
- BN_num_bytes(p
));
472 BN_bn2bin(m
, (unsigned char *)modulus
->d
+ numbytes
- BN_num_bytes(m
));
473 keydata
.privateExponent
.data
= (unsigned char *)exponent
->d
;
474 keydata
.privateExponent
.len
= numbytes
;
475 keydata
.modulus
.data
= (unsigned char *)modulus
->d
;
476 keydata
.modulus
.len
= numbytes
;
477 /* Prepare the argument */
478 memset(argument
->d
, 0, numbytes
);
479 memset(result
->d
, 0, numbytes
);
480 BN_bn2bin(a
, (unsigned char *)argument
->d
+ numbytes
- BN_num_bytes(a
));
481 /* Perform the operation */
482 if(p_Atalla_RSAPrivateKeyOpFn(&keydata
, (unsigned char *)result
->d
,
483 (unsigned char *)argument
->d
,
484 keydata
.modulus
.len
) != 0)
486 ATALLAerr(ATALLA_F_ATALLA_MOD_EXP
,ATALLA_R_REQUEST_FAILED
);
489 /* Convert the response */
490 BN_bin2bn((unsigned char *)result
->d
, numbytes
, r
);
497 #ifndef OPENSSL_NO_RSA
498 static int atalla_rsa_mod_exp(BIGNUM
*r0
, const BIGNUM
*I
, RSA
*rsa
)
505 ATALLAerr(ATALLA_F_ATALLA_RSA_MOD_EXP
,ATALLA_R_NOT_LOADED
);
508 if((ctx
= BN_CTX_new()) == NULL
)
510 if(!rsa
->d
|| !rsa
->n
)
512 ATALLAerr(ATALLA_F_ATALLA_RSA_MOD_EXP
,ATALLA_R_MISSING_KEY_COMPONENTS
);
515 to_return
= atalla_mod_exp(r0
, I
, rsa
->d
, rsa
->n
, ctx
);
523 #ifndef OPENSSL_NO_DSA
524 /* This code was liberated and adapted from the commented-out code in
525 * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
526 * (it doesn't have a CRT form for RSA), this function means that an
527 * Atalla system running with a DSA server certificate can handshake
528 * around 5 or 6 times faster/more than an equivalent system running with
529 * RSA. Just check out the "signs" statistics from the RSA and DSA parts
530 * of "openssl speed -engine atalla dsa1024 rsa1024". */
531 static int atalla_dsa_mod_exp(DSA
*dsa
, BIGNUM
*rr
, BIGNUM
*a1
,
532 BIGNUM
*p1
, BIGNUM
*a2
, BIGNUM
*p2
, BIGNUM
*m
,
533 BN_CTX
*ctx
, BN_MONT_CTX
*in_mont
)
539 /* let rr = a1 ^ p1 mod m */
540 if (!atalla_mod_exp(rr
,a1
,p1
,m
,ctx
)) goto end
;
541 /* let t = a2 ^ p2 mod m */
542 if (!atalla_mod_exp(&t
,a2
,p2
,m
,ctx
)) goto end
;
543 /* let rr = rr * t mod m */
544 if (!BN_mod_mul(rr
,rr
,&t
,m
,ctx
)) goto end
;
551 static int atalla_mod_exp_dsa(DSA
*dsa
, BIGNUM
*r
, BIGNUM
*a
,
552 const BIGNUM
*p
, const BIGNUM
*m
, BN_CTX
*ctx
,
555 return atalla_mod_exp(r
, a
, p
, m
, ctx
);
559 /* This function is aliased to mod_exp (with the mont stuff dropped). */
560 static int atalla_mod_exp_mont(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
561 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
563 return atalla_mod_exp(r
, a
, p
, m
, ctx
);
566 #ifndef OPENSSL_NO_DH
567 /* This function is aliased to mod_exp (with the dh and mont dropped). */
568 static int atalla_mod_exp_dh(const DH
*dh
, BIGNUM
*r
,
569 const BIGNUM
*a
, const BIGNUM
*p
,
570 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
572 return atalla_mod_exp(r
, a
, p
, m
, ctx
);
576 /* This stuff is needed if this ENGINE is being compiled into a self-contained
578 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
579 static int bind_fn(ENGINE
*e
, const char *id
)
581 if(id
&& (strcmp(id
, engine_atalla_id
) != 0))
587 IMPLEMENT_DYNAMIC_CHECK_FN()
588 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn
)
589 #endif /* OPENSSL_NO_DYNAMIC_ENGINE */
591 #endif /* !OPENSSL_NO_HW_ATALLA */
592 #endif /* !OPENSSL_NO_HW */