1 /* crypto/engine/hw_nuron.c */
2 /* Written by Ben Laurie for the OpenSSL Project, leaning heavily on Geoff
3 * Thorpe's Atalla implementation.
5 /* ====================================================================
6 * Copyright (c) 2000-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>
67 #ifndef OPENSSL_NO_HW_NURON
69 #define NURON_LIB_NAME "nuron engine"
70 #include "hw_nuron_err.c"
72 static const char *NURON_LIBNAME
= NULL
;
73 static const char *get_NURON_LIBNAME(void)
79 static void free_NURON_LIBNAME(void)
82 OPENSSL_free((void*)NURON_LIBNAME
);
85 static long set_NURON_LIBNAME(const char *name
)
88 return (((NURON_LIBNAME
= BUF_strdup(name
)) != NULL
) ? 1 : 0);
90 static const char *NURON_F1
= "nuron_mod_exp";
92 /* The definitions for control commands specific to this engine */
93 #define NURON_CMD_SO_PATH ENGINE_CMD_BASE
94 static const ENGINE_CMD_DEFN nuron_cmd_defns
[] = {
97 "Specifies the path to the 'nuronssl' shared library",
98 ENGINE_CMD_FLAG_STRING
},
102 typedef int tfnModExp(BIGNUM
*r
,const BIGNUM
*a
,const BIGNUM
*p
,const BIGNUM
*m
);
103 static tfnModExp
*pfnModExp
= NULL
;
105 static DSO
*pvDSOHandle
= NULL
;
107 static int nuron_destroy(ENGINE
*e
)
109 free_NURON_LIBNAME();
110 ERR_unload_NURON_strings();
114 static int nuron_init(ENGINE
*e
)
116 if(pvDSOHandle
!= NULL
)
118 NURONerr(NURON_F_NURON_INIT
,NURON_R_ALREADY_LOADED
);
122 pvDSOHandle
= DSO_load(NULL
, get_NURON_LIBNAME(), NULL
,
123 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY
);
126 NURONerr(NURON_F_NURON_INIT
,NURON_R_DSO_NOT_FOUND
);
130 pfnModExp
= (tfnModExp
*)DSO_bind_func(pvDSOHandle
, NURON_F1
);
133 NURONerr(NURON_F_NURON_INIT
,NURON_R_DSO_FUNCTION_NOT_FOUND
);
140 static int nuron_finish(ENGINE
*e
)
142 free_NURON_LIBNAME();
143 if(pvDSOHandle
== NULL
)
145 NURONerr(NURON_F_NURON_FINISH
,NURON_R_NOT_LOADED
);
148 if(!DSO_free(pvDSOHandle
))
150 NURONerr(NURON_F_NURON_FINISH
,NURON_R_DSO_FAILURE
);
158 static int nuron_ctrl(ENGINE
*e
, int cmd
, long i
, void *p
, void (*f
)())
160 int initialised
= ((pvDSOHandle
== NULL
) ? 0 : 1);
163 case NURON_CMD_SO_PATH
:
166 NURONerr(NURON_F_NURON_CTRL
,ERR_R_PASSED_NULL_PARAMETER
);
171 NURONerr(NURON_F_NURON_CTRL
,NURON_R_ALREADY_LOADED
);
174 return set_NURON_LIBNAME((const char *)p
);
178 NURONerr(NURON_F_NURON_CTRL
,NURON_R_CTRL_COMMAND_NOT_IMPLEMENTED
);
182 static int nuron_mod_exp(BIGNUM
*r
,const BIGNUM
*a
,const BIGNUM
*p
,
183 const BIGNUM
*m
,BN_CTX
*ctx
)
187 NURONerr(NURON_F_NURON_MOD_EXP
,NURON_R_NOT_LOADED
);
190 return pfnModExp(r
,a
,p
,m
);
193 #ifndef OPENSSL_NO_RSA
194 static int nuron_rsa_mod_exp(BIGNUM
*r0
, const BIGNUM
*I
, RSA
*rsa
)
196 return nuron_mod_exp(r0
,I
,rsa
->d
,rsa
->n
,NULL
);
200 #ifndef OPENSSL_NO_DSA
201 /* This code was liberated and adapted from the commented-out code in
202 * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
203 * (it doesn't have a CRT form for RSA), this function means that an
204 * Atalla system running with a DSA server certificate can handshake
205 * around 5 or 6 times faster/more than an equivalent system running with
206 * RSA. Just check out the "signs" statistics from the RSA and DSA parts
207 * of "openssl speed -engine atalla dsa1024 rsa1024". */
208 static int nuron_dsa_mod_exp(DSA
*dsa
, BIGNUM
*rr
, BIGNUM
*a1
,
209 BIGNUM
*p1
, BIGNUM
*a2
, BIGNUM
*p2
, BIGNUM
*m
,
210 BN_CTX
*ctx
, BN_MONT_CTX
*in_mont
)
216 /* let rr = a1 ^ p1 mod m */
217 if (!nuron_mod_exp(rr
,a1
,p1
,m
,ctx
))
219 /* let t = a2 ^ p2 mod m */
220 if (!nuron_mod_exp(&t
,a2
,p2
,m
,ctx
))
222 /* let rr = rr * t mod m */
223 if (!BN_mod_mul(rr
,rr
,&t
,m
,ctx
))
232 static int nuron_mod_exp_dsa(DSA
*dsa
, BIGNUM
*r
, BIGNUM
*a
,
233 const BIGNUM
*p
, const BIGNUM
*m
, BN_CTX
*ctx
,
236 return nuron_mod_exp(r
, a
, p
, m
, ctx
);
240 /* This function is aliased to mod_exp (with the mont stuff dropped). */
241 static int nuron_mod_exp_mont(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
242 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
244 return nuron_mod_exp(r
, a
, p
, m
, ctx
);
247 #ifndef OPENSSL_NO_DH
248 /* This function is aliased to mod_exp (with the dh and mont dropped). */
249 static int nuron_mod_exp_dh(const DH
*dh
, BIGNUM
*r
,
250 const BIGNUM
*a
, const BIGNUM
*p
,
251 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
253 return nuron_mod_exp(r
, a
, p
, m
, ctx
);
257 #ifndef OPENSSL_NO_RSA
258 static RSA_METHOD nuron_rsa
=
276 #ifndef OPENSSL_NO_DSA
277 static DSA_METHOD nuron_dsa
=
280 NULL
, /* dsa_do_sign */
281 NULL
, /* dsa_sign_setup */
282 NULL
, /* dsa_do_verify */
283 nuron_dsa_mod_exp
, /* dsa_mod_exp */
284 nuron_mod_exp_dsa
, /* bn_mod_exp */
292 #ifndef OPENSSL_NO_DH
293 static DH_METHOD nuron_dh
=
306 /* Constants used when creating the ENGINE */
307 static const char *engine_nuron_id
= "nuron";
308 static const char *engine_nuron_name
= "Nuron hardware engine support";
310 /* This internal function is used by ENGINE_nuron() and possibly by the
311 * "dynamic" ENGINE support too */
312 static int bind_helper(ENGINE
*e
)
314 #ifndef OPENSSL_NO_RSA
315 const RSA_METHOD
*meth1
;
317 #ifndef OPENSSL_NO_DSA
318 const DSA_METHOD
*meth2
;
320 #ifndef OPENSSL_NO_DH
321 const DH_METHOD
*meth3
;
323 if(!ENGINE_set_id(e
, engine_nuron_id
) ||
324 !ENGINE_set_name(e
, engine_nuron_name
) ||
325 #ifndef OPENSSL_NO_RSA
326 !ENGINE_set_RSA(e
, &nuron_rsa
) ||
328 #ifndef OPENSSL_NO_DSA
329 !ENGINE_set_DSA(e
, &nuron_dsa
) ||
331 #ifndef OPENSSL_NO_DH
332 !ENGINE_set_DH(e
, &nuron_dh
) ||
334 !ENGINE_set_destroy_function(e
, nuron_destroy
) ||
335 !ENGINE_set_init_function(e
, nuron_init
) ||
336 !ENGINE_set_finish_function(e
, nuron_finish
) ||
337 !ENGINE_set_ctrl_function(e
, nuron_ctrl
) ||
338 !ENGINE_set_cmd_defns(e
, nuron_cmd_defns
))
341 #ifndef OPENSSL_NO_RSA
342 /* We know that the "PKCS1_SSLeay()" functions hook properly
343 * to the nuron-specific mod_exp and mod_exp_crt so we use
344 * those functions. NB: We don't use ENGINE_openssl() or
345 * anything "more generic" because something like the RSAref
346 * code may not hook properly, and if you own one of these
347 * cards then you have the right to do RSA operations on it
349 meth1
=RSA_PKCS1_SSLeay();
350 nuron_rsa
.rsa_pub_enc
=meth1
->rsa_pub_enc
;
351 nuron_rsa
.rsa_pub_dec
=meth1
->rsa_pub_dec
;
352 nuron_rsa
.rsa_priv_enc
=meth1
->rsa_priv_enc
;
353 nuron_rsa
.rsa_priv_dec
=meth1
->rsa_priv_dec
;
356 #ifndef OPENSSL_NO_DSA
357 /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
360 nuron_dsa
.dsa_do_sign
=meth2
->dsa_do_sign
;
361 nuron_dsa
.dsa_sign_setup
=meth2
->dsa_sign_setup
;
362 nuron_dsa
.dsa_do_verify
=meth2
->dsa_do_verify
;
365 #ifndef OPENSSL_NO_DH
366 /* Much the same for Diffie-Hellman */
368 nuron_dh
.generate_key
=meth3
->generate_key
;
369 nuron_dh
.compute_key
=meth3
->compute_key
;
372 /* Ensure the nuron error handling is set up */
373 ERR_load_NURON_strings();
377 #ifndef ENGINE_DYNAMIC_SUPPORT
378 static ENGINE
*engine_nuron(void)
380 ENGINE
*ret
= ENGINE_new();
383 if(!bind_helper(ret
))
391 void ENGINE_load_nuron(void)
393 /* Copied from eng_[openssl|dyn].c */
394 ENGINE
*toadd
= engine_nuron();
402 /* This stuff is needed if this ENGINE is being compiled into a self-contained
404 #ifdef ENGINE_DYNAMIC_SUPPORT
405 static int bind_fn(ENGINE
*e
, const char *id
)
407 if(id
&& (strcmp(id
, engine_nuron_id
) != 0))
413 IMPLEMENT_DYNAMIC_CHECK_FN()
414 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn
)
415 #endif /* ENGINE_DYNAMIC_SUPPORT */
417 #endif /* !OPENSSL_NO_HW_NURON */
418 #endif /* !OPENSSL_NO_HW */