1 /* crypto/engine/hw_atalla.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 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 "engine_int.h"
64 #include <openssl/engine.h>
72 #include "vendor_defns/atalla.h"
75 static int atalla_init(void);
76 static int atalla_finish(void);
79 static int atalla_mod_exp(BIGNUM
*r
, BIGNUM
*a
, const BIGNUM
*p
,
80 const BIGNUM
*m
, BN_CTX
*ctx
);
83 static int atalla_rsa_mod_exp(BIGNUM
*r0
, BIGNUM
*I
, RSA
*rsa
);
84 /* This function is aliased to mod_exp (with the mont stuff dropped). */
85 static int atalla_mod_exp_mont(BIGNUM
*r
, BIGNUM
*a
, const BIGNUM
*p
,
86 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
);
89 static int atalla_dsa_mod_exp(DSA
*dsa
, BIGNUM
*rr
, BIGNUM
*a1
,
90 BIGNUM
*p1
, BIGNUM
*a2
, BIGNUM
*p2
, BIGNUM
*m
,
91 BN_CTX
*ctx
, BN_MONT_CTX
*in_mont
);
92 static int atalla_mod_exp_dsa(DSA
*dsa
, BIGNUM
*r
, BIGNUM
*a
,
93 const BIGNUM
*p
, const BIGNUM
*m
, BN_CTX
*ctx
,
97 /* This function is alised to mod_exp (with the DH and mont dropped). */
98 static int atalla_mod_exp_dh(DH
*dh
, BIGNUM
*r
, BIGNUM
*a
, const BIGNUM
*p
,
99 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
);
102 /* Our internal RSA_METHOD that we provide pointers to */
103 static RSA_METHOD atalla_rsa
=
120 /* Our internal DSA_METHOD that we provide pointers to */
121 static DSA_METHOD atalla_dsa
=
124 NULL
, /* dsa_do_sign */
125 NULL
, /* dsa_sign_setup */
126 NULL
, /* dsa_do_verify */
127 atalla_dsa_mod_exp
, /* dsa_mod_exp */
128 atalla_mod_exp_dsa
, /* bn_mod_exp */
135 /* Our internal DH_METHOD that we provide pointers to */
136 static DH_METHOD atalla_dh
=
148 /* Our ENGINE structure. */
149 static ENGINE engine_atalla
=
152 "Atalla hardware engine support",
161 NULL
, /* no ctrl() */
162 NULL
, /* no load_privkey() */
163 NULL
, /* no load_pubkey() */
165 0, 0, /* no references */
166 NULL
, NULL
/* unlinked */
169 /* As this is only ever called once, there's no need for locking
170 * (indeed - the lock will already be held by our caller!!!) */
171 ENGINE
*ENGINE_atalla()
177 /* We know that the "PKCS1_SSLeay()" functions hook properly
178 * to the atalla-specific mod_exp and mod_exp_crt so we use
179 * those functions. NB: We don't use ENGINE_openssl() or
180 * anything "more generic" because something like the RSAref
181 * code may not hook properly, and if you own one of these
182 * cards then you have the right to do RSA operations on it
184 meth1
= RSA_PKCS1_SSLeay();
185 atalla_rsa
.rsa_pub_enc
= meth1
->rsa_pub_enc
;
186 atalla_rsa
.rsa_pub_dec
= meth1
->rsa_pub_dec
;
187 atalla_rsa
.rsa_priv_enc
= meth1
->rsa_priv_enc
;
188 atalla_rsa
.rsa_priv_dec
= meth1
->rsa_priv_dec
;
190 /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
192 meth2
= DSA_OpenSSL();
193 atalla_dsa
.dsa_do_sign
= meth2
->dsa_do_sign
;
194 atalla_dsa
.dsa_sign_setup
= meth2
->dsa_sign_setup
;
195 atalla_dsa
.dsa_do_verify
= meth2
->dsa_do_verify
;
197 /* Much the same for Diffie-Hellman */
198 meth3
= DH_OpenSSL();
199 atalla_dh
.generate_key
= meth3
->generate_key
;
200 atalla_dh
.compute_key
= meth3
->compute_key
;
201 return &engine_atalla
;
204 /* This is a process-global DSO handle used for loading and unloading
205 * the Atalla library. NB: This is only set (or unset) during an
206 * init() or finish() call (reference counts permitting) and they're
207 * operating with global locks, so this should be thread-safe
209 static DSO
*atalla_dso
= NULL
;
211 /* These are the function pointers that are (un)set when the library has
212 * successfully (un)loaded. */
213 static tfnASI_GetHardwareConfig
*p_Atalla_GetHardwareConfig
= NULL
;
214 static tfnASI_RSAPrivateKeyOpFn
*p_Atalla_RSAPrivateKeyOpFn
= NULL
;
215 static tfnASI_GetPerformanceStatistics
*p_Atalla_GetPerformanceStatistics
= NULL
;
217 /* (de)initialisation functions. */
218 static int atalla_init()
220 tfnASI_GetHardwareConfig
*p1
;
221 tfnASI_RSAPrivateKeyOpFn
*p2
;
222 tfnASI_GetPerformanceStatistics
*p3
;
223 /* Not sure of the origin of this magic value, but Ben's code had it
224 * and it seemed to have been working for a few people. :-) */
225 unsigned int config_buf
[1024];
227 if(atalla_dso
!= NULL
)
229 ENGINEerr(ENGINE_F_ATALLA_INIT
,ENGINE_R_ALREADY_LOADED
);
232 /* Attempt to load libatasi.so/atasi.dll/whatever. Needs to be
233 * changed unfortunately because the Atalla drivers don't have
234 * standard library names that can be platform-translated well. */
235 /* TODO: Work out how to actually map to the names the Atalla
236 * drivers really use - for now a symbollic link needs to be
237 * created on the host system from libatasi.so to atasi.so on
239 atalla_dso
= DSO_load(NULL
, ATALLA_LIBNAME
, NULL
, 0);
240 if(atalla_dso
== NULL
)
242 ENGINEerr(ENGINE_F_ATALLA_INIT
,ENGINE_R_DSO_FAILURE
);
245 if(!(p1
= (tfnASI_GetHardwareConfig
*)DSO_bind_func(
246 atalla_dso
, ATALLA_F1
)) ||
247 !(p2
= (tfnASI_RSAPrivateKeyOpFn
*)DSO_bind_func(
248 atalla_dso
, ATALLA_F2
)) ||
249 !(p3
= (tfnASI_GetPerformanceStatistics
*)DSO_bind_func(
250 atalla_dso
, ATALLA_F3
)))
252 ENGINEerr(ENGINE_F_ATALLA_INIT
,ENGINE_R_DSO_FAILURE
);
255 /* Copy the pointers */
256 p_Atalla_GetHardwareConfig
= p1
;
257 p_Atalla_RSAPrivateKeyOpFn
= p2
;
258 p_Atalla_GetPerformanceStatistics
= p3
;
259 /* Perform a basic test to see if there's actually any unit
261 if(p1(0L, config_buf
) != 0)
263 ENGINEerr(ENGINE_F_ATALLA_INIT
,ENGINE_R_UNIT_FAILURE
);
266 /* Everything's fine. */
270 DSO_free(atalla_dso
);
271 p_Atalla_GetHardwareConfig
= NULL
;
272 p_Atalla_RSAPrivateKeyOpFn
= NULL
;
273 p_Atalla_GetPerformanceStatistics
= NULL
;
277 static int atalla_finish()
279 if(atalla_dso
== NULL
)
281 ENGINEerr(ENGINE_F_ATALLA_FINISH
,ENGINE_R_NOT_LOADED
);
284 if(!DSO_free(atalla_dso
))
286 ENGINEerr(ENGINE_F_ATALLA_FINISH
,ENGINE_R_DSO_FAILURE
);
290 p_Atalla_GetHardwareConfig
= NULL
;
291 p_Atalla_RSAPrivateKeyOpFn
= NULL
;
292 p_Atalla_GetPerformanceStatistics
= NULL
;
296 static int atalla_mod_exp(BIGNUM
*r
, BIGNUM
*a
, const BIGNUM
*p
,
297 const BIGNUM
*m
, BN_CTX
*ctx
)
299 /* I need somewhere to store temporary serialised values for
300 * use with the Atalla API calls. A neat cheat - I'll use
301 * BIGNUMs from the BN_CTX but access their arrays directly as
302 * byte arrays <grin>. This way I don't have to clean anything
308 RSAPrivateKey keydata
;
309 int to_return
, numbytes
;
311 modulus
= exponent
= argument
= result
= NULL
;
312 to_return
= 0; /* expect failure */
316 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP
,ENGINE_R_NOT_LOADED
);
319 /* Prepare the params */
320 modulus
= BN_CTX_get(ctx
);
321 exponent
= BN_CTX_get(ctx
);
322 argument
= BN_CTX_get(ctx
);
323 result
= BN_CTX_get(ctx
);
324 if(!modulus
|| !exponent
|| !argument
|| !result
)
326 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP
,ENGINE_R_BN_CTX_FULL
);
329 if(!bn_wexpand(modulus
, m
->top
) || !bn_wexpand(exponent
, m
->top
) ||
330 !bn_wexpand(argument
, m
->top
) || !bn_wexpand(result
, m
->top
))
332 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP
,ENGINE_R_BN_EXPAND_FAIL
);
335 /* Prepare the key-data */
336 memset(&keydata
, 0,sizeof keydata
);
337 numbytes
= BN_num_bytes(m
);
338 memset(exponent
->d
, 0, numbytes
);
339 memset(modulus
->d
, 0, numbytes
);
340 BN_bn2bin(p
, (unsigned char *)exponent
->d
+ numbytes
- BN_num_bytes(p
));
341 BN_bn2bin(m
, (unsigned char *)modulus
->d
+ numbytes
- BN_num_bytes(m
));
342 keydata
.privateExponent
.data
= (unsigned char *)exponent
->d
;
343 keydata
.privateExponent
.len
= numbytes
;
344 keydata
.modulus
.data
= (unsigned char *)modulus
->d
;
345 keydata
.modulus
.len
= numbytes
;
346 /* Prepare the argument */
347 memset(argument
->d
, 0, numbytes
);
348 memset(result
->d
, 0, numbytes
);
349 BN_bn2bin(a
, (unsigned char *)argument
->d
+ numbytes
- BN_num_bytes(a
));
350 /* Perform the operation */
351 if(p_Atalla_RSAPrivateKeyOpFn(&keydata
, (unsigned char *)result
->d
,
352 (unsigned char *)argument
->d
,
353 keydata
.modulus
.len
) != 0)
355 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP
,ENGINE_R_REQUEST_FAILED
);
358 /* Convert the response */
359 BN_bin2bn((unsigned char *)result
->d
, numbytes
, r
);
362 if(modulus
) ctx
->tos
--;
363 if(exponent
) ctx
->tos
--;
364 if(argument
) ctx
->tos
--;
365 if(result
) ctx
->tos
--;
369 static int atalla_rsa_mod_exp(BIGNUM
*r0
, BIGNUM
*I
, RSA
*rsa
)
376 ENGINEerr(ENGINE_F_ATALLA_RSA_MOD_EXP
,ENGINE_R_NOT_LOADED
);
379 if((ctx
= BN_CTX_new()) == NULL
)
381 if(!rsa
->d
|| !rsa
->n
)
383 ENGINEerr(ENGINE_F_ATALLA_RSA_MOD_EXP
,ENGINE_R_MISSING_KEY_COMPONENTS
);
386 to_return
= atalla_mod_exp(r0
, I
, rsa
->d
, rsa
->n
, ctx
);
393 /* This code was liberated and adapted from the commented-out code in
394 * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
395 * (it doesn't have a CRT form for RSA), this function means that an
396 * Atalla system running with a DSA server certificate can handshake
397 * around 5 or 6 times faster/more than an equivalent system running with
398 * RSA. Just check out the "signs" statistics from the RSA and DSA parts
399 * of "openssl speed -engine atalla dsa1024 rsa1024". */
400 static int atalla_dsa_mod_exp(DSA
*dsa
, BIGNUM
*rr
, BIGNUM
*a1
,
401 BIGNUM
*p1
, BIGNUM
*a2
, BIGNUM
*p2
, BIGNUM
*m
,
402 BN_CTX
*ctx
, BN_MONT_CTX
*in_mont
)
408 /* let rr = a1 ^ p1 mod m */
409 if (!atalla_mod_exp(rr
,a1
,p1
,m
,ctx
)) goto end
;
410 /* let t = a2 ^ p2 mod m */
411 if (!atalla_mod_exp(&t
,a2
,p2
,m
,ctx
)) goto end
;
412 /* let rr = rr * t mod m */
413 if (!BN_mod_mul(rr
,rr
,&t
,m
,ctx
)) goto end
;
421 static int atalla_mod_exp_dsa(DSA
*dsa
, BIGNUM
*r
, BIGNUM
*a
,
422 const BIGNUM
*p
, const BIGNUM
*m
, BN_CTX
*ctx
,
425 return atalla_mod_exp(r
, a
, p
, m
, ctx
);
428 /* This function is aliased to mod_exp (with the mont stuff dropped). */
429 static int atalla_mod_exp_mont(BIGNUM
*r
, BIGNUM
*a
, const BIGNUM
*p
,
430 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
432 return atalla_mod_exp(r
, a
, p
, m
, ctx
);
435 /* This function is aliased to mod_exp (with the dh and mont dropped). */
436 static int atalla_mod_exp_dh(DH
*dh
, BIGNUM
*r
, BIGNUM
*a
, const BIGNUM
*p
,
437 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
439 return atalla_mod_exp(r
, a
, p
, m
, ctx
);
442 #endif /* !NO_HW_ATALLA */