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 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 static const char def_NURON_LIBNAME[] = "nuronssl";
70 static const char *NURON_LIBNAME = def_NURON_LIBNAME;
71 static const char *NURON_F1 = "nuron_mod_exp";
73 /* The definitions for control commands specific to this engine */
74 #define NURON_CMD_SO_PATH ENGINE_CMD_BASE
75 static const ENGINE_CMD_DEFN nuron_cmd_defns[] = {
78 "Specifies the path to the 'nuronssl' shared library",
79 ENGINE_CMD_FLAG_STRING},
83 typedef int tfnModExp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,const BIGNUM *m);
84 static tfnModExp *pfnModExp = NULL;
86 static DSO *pvDSOHandle = NULL;
88 static int nuron_init(ENGINE *e)
90 if(pvDSOHandle != NULL)
92 ENGINEerr(ENGINE_F_NURON_INIT,ENGINE_R_ALREADY_LOADED);
96 pvDSOHandle = DSO_load(NULL, NURON_LIBNAME, NULL,
97 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY);
100 ENGINEerr(ENGINE_F_NURON_INIT,ENGINE_R_DSO_NOT_FOUND);
104 pfnModExp = (tfnModExp *)DSO_bind_func(pvDSOHandle, NURON_F1);
107 ENGINEerr(ENGINE_F_NURON_INIT,ENGINE_R_DSO_FUNCTION_NOT_FOUND);
114 static int nuron_finish(ENGINE *e)
116 if(pvDSOHandle == NULL)
118 ENGINEerr(ENGINE_F_NURON_FINISH,ENGINE_R_NOT_LOADED);
121 if(!DSO_free(pvDSOHandle))
123 ENGINEerr(ENGINE_F_NURON_FINISH,ENGINE_R_DSO_FAILURE);
131 static int nuron_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)())
133 int initialised = ((pvDSOHandle == NULL) ? 0 : 1);
136 case NURON_CMD_SO_PATH:
139 ENGINEerr(ENGINE_F_NURON_CTRL,ERR_R_PASSED_NULL_PARAMETER);
144 ENGINEerr(ENGINE_F_NURON_CTRL,ENGINE_R_ALREADY_LOADED);
147 NURON_LIBNAME = (const char *)p;
152 ENGINEerr(ENGINE_F_NURON_CTRL,ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED);
156 static int nuron_mod_exp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,
157 const BIGNUM *m,BN_CTX *ctx)
161 ENGINEerr(ENGINE_F_NURON_MOD_EXP,ENGINE_R_NOT_LOADED);
164 return pfnModExp(r,a,p,m);
167 #ifndef OPENSSL_NO_RSA
168 static int nuron_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa)
170 return nuron_mod_exp(r0,I,rsa->d,rsa->n,NULL);
174 #ifndef OPENSSL_NO_DSA
175 /* This code was liberated and adapted from the commented-out code in
176 * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
177 * (it doesn't have a CRT form for RSA), this function means that an
178 * Atalla system running with a DSA server certificate can handshake
179 * around 5 or 6 times faster/more than an equivalent system running with
180 * RSA. Just check out the "signs" statistics from the RSA and DSA parts
181 * of "openssl speed -engine atalla dsa1024 rsa1024". */
182 static int nuron_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
183 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
184 BN_CTX *ctx, BN_MONT_CTX *in_mont)
190 /* let rr = a1 ^ p1 mod m */
191 if (!nuron_mod_exp(rr,a1,p1,m,ctx))
193 /* let t = a2 ^ p2 mod m */
194 if (!nuron_mod_exp(&t,a2,p2,m,ctx))
196 /* let rr = rr * t mod m */
197 if (!BN_mod_mul(rr,rr,&t,m,ctx))
206 static int nuron_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
207 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
210 return nuron_mod_exp(r, a, p, m, ctx);
214 /* This function is aliased to mod_exp (with the mont stuff dropped). */
215 static int nuron_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
216 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
218 return nuron_mod_exp(r, a, p, m, ctx);
221 #ifndef OPENSSL_NO_DH
222 /* This function is aliased to mod_exp (with the dh and mont dropped). */
223 static int nuron_mod_exp_dh(const DH *dh, BIGNUM *r,
224 const BIGNUM *a, const BIGNUM *p,
225 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
227 return nuron_mod_exp(r, a, p, m, ctx);
231 #ifndef OPENSSL_NO_RSA
232 static RSA_METHOD nuron_rsa =
250 #ifndef OPENSSL_NO_DSA
251 static DSA_METHOD nuron_dsa =
254 NULL, /* dsa_do_sign */
255 NULL, /* dsa_sign_setup */
256 NULL, /* dsa_do_verify */
257 nuron_dsa_mod_exp, /* dsa_mod_exp */
258 nuron_mod_exp_dsa, /* bn_mod_exp */
266 #ifndef OPENSSL_NO_DH
267 static DH_METHOD nuron_dh =
280 /* Constants used when creating the ENGINE */
281 static const char *engine_nuron_id = "nuron";
282 static const char *engine_nuron_name = "Nuron hardware engine support";
284 /* As this is only ever called once, there's no need for locking
285 * (indeed - the lock will already be held by our caller!!!) */
286 ENGINE *ENGINE_nuron()
288 #ifndef OPENSSL_NO_RSA
289 const RSA_METHOD *meth1;
291 #ifndef OPENSSL_NO_DSA
292 const DSA_METHOD *meth2;
294 #ifndef OPENSSL_NO_DH
295 const DH_METHOD *meth3;
297 ENGINE *ret = ENGINE_new();
300 if(!ENGINE_set_id(ret, engine_nuron_id) ||
301 !ENGINE_set_name(ret, engine_nuron_name) ||
302 #ifndef OPENSSL_NO_RSA
303 !ENGINE_set_RSA(ret, &nuron_rsa) ||
305 #ifndef OPENSSL_NO_DSA
306 !ENGINE_set_DSA(ret, &nuron_dsa) ||
308 #ifndef OPENSSL_NO_DH
309 !ENGINE_set_DH(ret, &nuron_dh) ||
311 !ENGINE_set_BN_mod_exp(ret, nuron_mod_exp) ||
312 !ENGINE_set_init_function(ret, nuron_init) ||
313 !ENGINE_set_finish_function(ret, nuron_finish) ||
314 !ENGINE_set_ctrl_function(ret, nuron_ctrl) ||
315 !ENGINE_set_cmd_defns(ret, nuron_cmd_defns))
321 #ifndef OPENSSL_NO_RSA
322 /* We know that the "PKCS1_SSLeay()" functions hook properly
323 * to the nuron-specific mod_exp and mod_exp_crt so we use
324 * those functions. NB: We don't use ENGINE_openssl() or
325 * anything "more generic" because something like the RSAref
326 * code may not hook properly, and if you own one of these
327 * cards then you have the right to do RSA operations on it
329 meth1=RSA_PKCS1_SSLeay();
330 nuron_rsa.rsa_pub_enc=meth1->rsa_pub_enc;
331 nuron_rsa.rsa_pub_dec=meth1->rsa_pub_dec;
332 nuron_rsa.rsa_priv_enc=meth1->rsa_priv_enc;
333 nuron_rsa.rsa_priv_dec=meth1->rsa_priv_dec;
336 #ifndef OPENSSL_NO_DSA
337 /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
340 nuron_dsa.dsa_do_sign=meth2->dsa_do_sign;
341 nuron_dsa.dsa_sign_setup=meth2->dsa_sign_setup;
342 nuron_dsa.dsa_do_verify=meth2->dsa_do_verify;
345 #ifndef OPENSSL_NO_DH
346 /* Much the same for Diffie-Hellman */
348 nuron_dh.generate_key=meth3->generate_key;
349 nuron_dh.compute_key=meth3->compute_key;
354 #endif /* !OPENSSL_NO_HW_NURON */
355 #endif /* !OPENSSL_NO_HW */