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).
61 #include <openssl/crypto.h>
62 #include <openssl/buffer.h>
63 #include <openssl/dso.h>
64 #include <openssl/engine.h>
65 #include <openssl/rsa.h>
66 #include <openssl/dsa.h>
67 #include <openssl/dh.h>
70 #ifndef OPENSSL_NO_HW_NURON
72 #define NURON_LIB_NAME "nuron engine"
73 #include "e_nuron_err.c"
75 static const char *NURON_LIBNAME = NULL;
76 static const char *get_NURON_LIBNAME(void)
82 static void free_NURON_LIBNAME(void)
85 OPENSSL_free((void*)NURON_LIBNAME);
88 static long set_NURON_LIBNAME(const char *name)
91 return (((NURON_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
93 static const char *NURON_F1 = "nuron_mod_exp";
95 /* The definitions for control commands specific to this engine */
96 #define NURON_CMD_SO_PATH ENGINE_CMD_BASE
97 static const ENGINE_CMD_DEFN nuron_cmd_defns[] = {
100 "Specifies the path to the 'nuronssl' shared library",
101 ENGINE_CMD_FLAG_STRING},
105 typedef int tfnModExp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,const BIGNUM *m);
106 static tfnModExp *pfnModExp = NULL;
108 static DSO *pvDSOHandle = NULL;
110 static int nuron_destroy(ENGINE *e)
112 free_NURON_LIBNAME();
113 ERR_unload_NURON_strings();
117 static int nuron_init(ENGINE *e)
119 if(pvDSOHandle != NULL)
121 NURONerr(NURON_F_NURON_INIT,NURON_R_ALREADY_LOADED);
125 pvDSOHandle = DSO_load(NULL, get_NURON_LIBNAME(), NULL,
126 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY);
129 NURONerr(NURON_F_NURON_INIT,NURON_R_DSO_NOT_FOUND);
133 pfnModExp = (tfnModExp *)DSO_bind_func(pvDSOHandle, NURON_F1);
136 NURONerr(NURON_F_NURON_INIT,NURON_R_DSO_FUNCTION_NOT_FOUND);
143 static int nuron_finish(ENGINE *e)
145 free_NURON_LIBNAME();
146 if(pvDSOHandle == NULL)
148 NURONerr(NURON_F_NURON_FINISH,NURON_R_NOT_LOADED);
151 if(!DSO_free(pvDSOHandle))
153 NURONerr(NURON_F_NURON_FINISH,NURON_R_DSO_FAILURE);
161 static int nuron_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
163 int initialised = ((pvDSOHandle == NULL) ? 0 : 1);
166 case NURON_CMD_SO_PATH:
169 NURONerr(NURON_F_NURON_CTRL,ERR_R_PASSED_NULL_PARAMETER);
174 NURONerr(NURON_F_NURON_CTRL,NURON_R_ALREADY_LOADED);
177 return set_NURON_LIBNAME((const char *)p);
181 NURONerr(NURON_F_NURON_CTRL,NURON_R_CTRL_COMMAND_NOT_IMPLEMENTED);
185 static int nuron_mod_exp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,
186 const BIGNUM *m,BN_CTX *ctx)
190 NURONerr(NURON_F_NURON_MOD_EXP,NURON_R_NOT_LOADED);
193 return pfnModExp(r,a,p,m);
196 #ifndef OPENSSL_NO_RSA
197 static int nuron_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx)
199 return nuron_mod_exp(r0,I,rsa->d,rsa->n,ctx);
203 #ifndef OPENSSL_NO_DSA
204 /* This code was liberated and adapted from the commented-out code in
205 * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
206 * (it doesn't have a CRT form for RSA), this function means that an
207 * Atalla system running with a DSA server certificate can handshake
208 * around 5 or 6 times faster/more than an equivalent system running with
209 * RSA. Just check out the "signs" statistics from the RSA and DSA parts
210 * of "openssl speed -engine atalla dsa1024 rsa1024". */
211 static int nuron_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
212 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
213 BN_CTX *ctx, BN_MONT_CTX *in_mont)
219 /* let rr = a1 ^ p1 mod m */
220 if (!nuron_mod_exp(rr,a1,p1,m,ctx))
222 /* let t = a2 ^ p2 mod m */
223 if (!nuron_mod_exp(&t,a2,p2,m,ctx))
225 /* let rr = rr * t mod m */
226 if (!BN_mod_mul(rr,rr,&t,m,ctx))
235 static int nuron_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
236 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
239 return nuron_mod_exp(r, a, p, m, ctx);
243 /* This function is aliased to mod_exp (with the mont stuff dropped). */
244 static int nuron_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
245 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
247 return nuron_mod_exp(r, a, p, m, ctx);
250 #ifndef OPENSSL_NO_DH
251 /* This function is aliased to mod_exp (with the dh and mont dropped). */
252 static int nuron_mod_exp_dh(const DH *dh, BIGNUM *r,
253 const BIGNUM *a, const BIGNUM *p,
254 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
256 return nuron_mod_exp(r, a, p, m, ctx);
260 #ifndef OPENSSL_NO_RSA
261 static RSA_METHOD nuron_rsa =
280 #ifndef OPENSSL_NO_DSA
281 static DSA_METHOD nuron_dsa =
284 NULL, /* dsa_do_sign */
285 NULL, /* dsa_sign_setup */
286 NULL, /* dsa_do_verify */
287 nuron_dsa_mod_exp, /* dsa_mod_exp */
288 nuron_mod_exp_dsa, /* bn_mod_exp */
293 NULL, /* dsa_paramgen */
294 NULL /* dsa_keygen */
298 #ifndef OPENSSL_NO_DH
299 static DH_METHOD nuron_dh =
313 /* Constants used when creating the ENGINE */
314 static const char *engine_nuron_id = "nuron";
315 static const char *engine_nuron_name = "Nuron hardware engine support";
317 /* This internal function is used by ENGINE_nuron() and possibly by the
318 * "dynamic" ENGINE support too */
319 static int bind_helper(ENGINE *e)
321 #ifndef OPENSSL_NO_RSA
322 const RSA_METHOD *meth1;
324 #ifndef OPENSSL_NO_DSA
325 const DSA_METHOD *meth2;
327 #ifndef OPENSSL_NO_DH
328 const DH_METHOD *meth3;
330 if(!ENGINE_set_id(e, engine_nuron_id) ||
331 !ENGINE_set_name(e, engine_nuron_name) ||
332 #ifndef OPENSSL_NO_RSA
333 !ENGINE_set_RSA(e, &nuron_rsa) ||
335 #ifndef OPENSSL_NO_DSA
336 !ENGINE_set_DSA(e, &nuron_dsa) ||
338 #ifndef OPENSSL_NO_DH
339 !ENGINE_set_DH(e, &nuron_dh) ||
341 !ENGINE_set_destroy_function(e, nuron_destroy) ||
342 !ENGINE_set_init_function(e, nuron_init) ||
343 !ENGINE_set_finish_function(e, nuron_finish) ||
344 !ENGINE_set_ctrl_function(e, nuron_ctrl) ||
345 !ENGINE_set_cmd_defns(e, nuron_cmd_defns))
348 #ifndef OPENSSL_NO_RSA
349 /* We know that the "PKCS1_SSLeay()" functions hook properly
350 * to the nuron-specific mod_exp and mod_exp_crt so we use
351 * those functions. NB: We don't use ENGINE_openssl() or
352 * anything "more generic" because something like the RSAref
353 * code may not hook properly, and if you own one of these
354 * cards then you have the right to do RSA operations on it
356 meth1=RSA_PKCS1_SSLeay();
357 nuron_rsa.rsa_pub_enc=meth1->rsa_pub_enc;
358 nuron_rsa.rsa_pub_dec=meth1->rsa_pub_dec;
359 nuron_rsa.rsa_priv_enc=meth1->rsa_priv_enc;
360 nuron_rsa.rsa_priv_dec=meth1->rsa_priv_dec;
363 #ifndef OPENSSL_NO_DSA
364 /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
367 nuron_dsa.dsa_do_sign=meth2->dsa_do_sign;
368 nuron_dsa.dsa_sign_setup=meth2->dsa_sign_setup;
369 nuron_dsa.dsa_do_verify=meth2->dsa_do_verify;
372 #ifndef OPENSSL_NO_DH
373 /* Much the same for Diffie-Hellman */
375 nuron_dh.generate_key=meth3->generate_key;
376 nuron_dh.compute_key=meth3->compute_key;
379 /* Ensure the nuron error handling is set up */
380 ERR_load_NURON_strings();
384 #ifdef OPENSSL_NO_DYNAMIC_ENGINE
385 static ENGINE *engine_nuron(void)
387 ENGINE *ret = ENGINE_new();
390 if(!bind_helper(ret))
398 void ENGINE_load_nuron(void)
400 /* Copied from eng_[openssl|dyn].c */
401 ENGINE *toadd = engine_nuron();
409 /* This stuff is needed if this ENGINE is being compiled into a self-contained
411 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
412 static int bind_fn(ENGINE *e, const char *id)
414 if(id && (strcmp(id, engine_nuron_id) != 0))
420 IMPLEMENT_DYNAMIC_CHECK_FN()
421 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
422 #endif /* OPENSSL_NO_DYNAMIC_ENGINE */
424 #endif /* !OPENSSL_NO_HW_NURON */
425 #endif /* !OPENSSL_NO_HW */