Some more tweaks to ENGINE code.
[openssl.git] / crypto / engine / hw_nuron.c
1 /* crypto/engine/hw_nuron.c */
2 /* Written by Ben Laurie for the OpenSSL Project, leaning heavily on Geoff
3  * Thorpe's Atalla implementation.
4  */
5 /* ====================================================================
6  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
58
59 #include <stdio.h>
60 #include <openssl/crypto.h>
61 #include "cryptlib.h"
62 #include <openssl/dso.h>
63 #include <openssl/engine.h>
64
65
66 #ifndef OPENSSL_NO_HW
67 #ifndef OPENSSL_NO_HW_NURON
68
69 static const char *NURON_LIBNAME = "nuronssl";
70 static const char *NURON_F1 = "nuron_mod_exp";
71
72 typedef int tfnModExp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,const BIGNUM *m);
73 static tfnModExp *pfnModExp = NULL;
74
75 static DSO *pvDSOHandle = NULL;
76
77 static int nuron_init(ENGINE *e)
78         {
79         if(pvDSOHandle != NULL)
80                 {
81                 ENGINEerr(ENGINE_F_NURON_INIT,ENGINE_R_ALREADY_LOADED);
82                 return 0;
83                 }
84
85         pvDSOHandle=DSO_load(NULL, NURON_LIBNAME, NULL,
86                 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY);
87         if(!pvDSOHandle)
88                 {
89                 ENGINEerr(ENGINE_F_NURON_INIT,ENGINE_R_DSO_NOT_FOUND);
90                 return 0;
91                 }
92
93         pfnModExp=(tfnModExp *)DSO_bind_func(pvDSOHandle, NURON_F1);
94         if(!pfnModExp)
95                 {
96                 ENGINEerr(ENGINE_F_NURON_INIT,ENGINE_R_DSO_FUNCTION_NOT_FOUND);
97                 return 0;
98                 }
99
100         return 1;
101         }
102
103 static int nuron_finish(ENGINE *e)
104         {
105         if(pvDSOHandle == NULL)
106                 {
107                 ENGINEerr(ENGINE_F_NURON_FINISH,ENGINE_R_NOT_LOADED);
108                 return 0;
109                 }
110         if(!DSO_free(pvDSOHandle))
111                 {
112                 ENGINEerr(ENGINE_F_NURON_FINISH,ENGINE_R_DSO_FAILURE);
113                 return 0;
114                 }
115         pvDSOHandle=NULL;
116         pfnModExp=NULL;
117         return 1;
118         }
119
120 static int nuron_mod_exp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,
121                          const BIGNUM *m,BN_CTX *ctx)
122         {
123         if(!pvDSOHandle)
124                 {
125                 ENGINEerr(ENGINE_F_NURON_MOD_EXP,ENGINE_R_NOT_LOADED);
126                 return 0;
127                 }
128         return pfnModExp(r,a,p,m);
129         }
130
131 static int nuron_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa)
132         {
133         return nuron_mod_exp(r0,I,rsa->d,rsa->n,NULL);
134         }
135
136 /* This code was liberated and adapted from the commented-out code in
137  * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
138  * (it doesn't have a CRT form for RSA), this function means that an
139  * Atalla system running with a DSA server certificate can handshake
140  * around 5 or 6 times faster/more than an equivalent system running with
141  * RSA. Just check out the "signs" statistics from the RSA and DSA parts
142  * of "openssl speed -engine atalla dsa1024 rsa1024". */
143 static int nuron_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
144                              BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
145                              BN_CTX *ctx, BN_MONT_CTX *in_mont)
146         {
147         BIGNUM t;
148         int to_return = 0;
149  
150         BN_init(&t);
151         /* let rr = a1 ^ p1 mod m */
152         if (!nuron_mod_exp(rr,a1,p1,m,ctx))
153                 goto end;
154         /* let t = a2 ^ p2 mod m */
155         if (!nuron_mod_exp(&t,a2,p2,m,ctx))
156                 goto end;
157         /* let rr = rr * t mod m */
158         if (!BN_mod_mul(rr,rr,&t,m,ctx))
159                 goto end;
160         to_return = 1;
161 end:
162         BN_free(&t);
163         return to_return;
164         }
165
166
167 static int nuron_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
168                              const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
169                              BN_MONT_CTX *m_ctx)
170         {
171         return nuron_mod_exp(r, a, p, m, ctx);
172         }
173
174 /* This function is aliased to mod_exp (with the mont stuff dropped). */
175 static int nuron_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
176                               const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
177         {
178         return nuron_mod_exp(r, a, p, m, ctx);
179         }
180
181 /* This function is aliased to mod_exp (with the dh and mont dropped). */
182 static int nuron_mod_exp_dh(const DH *dh, BIGNUM *r,
183                 const BIGNUM *a, const BIGNUM *p,
184                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
185         {
186         return nuron_mod_exp(r, a, p, m, ctx);
187         }
188
189 static RSA_METHOD nuron_rsa =
190         {
191         "Nuron RSA method",
192         NULL,
193         NULL,
194         NULL,
195         NULL,
196         nuron_rsa_mod_exp,
197         nuron_mod_exp_mont,
198         NULL,
199         NULL,
200         0,
201         NULL,
202         NULL,
203         NULL
204         };
205
206 static DSA_METHOD nuron_dsa =
207         {
208         "Nuron DSA method",
209         NULL, /* dsa_do_sign */
210         NULL, /* dsa_sign_setup */
211         NULL, /* dsa_do_verify */
212         nuron_dsa_mod_exp, /* dsa_mod_exp */
213         nuron_mod_exp_dsa, /* bn_mod_exp */
214         NULL, /* init */
215         NULL, /* finish */
216         0, /* flags */
217         NULL /* app_data */
218         };
219
220 static DH_METHOD nuron_dh =
221         {
222         "Nuron DH method",
223         NULL,
224         NULL,
225         nuron_mod_exp_dh,
226         NULL,
227         NULL,
228         0,
229         NULL
230         };
231
232 /* Constants used when creating the ENGINE */
233 static const char *engine_nuron_id = "nuron";
234 static const char *engine_nuron_name = "Nuron hardware engine support";
235
236 /* As this is only ever called once, there's no need for locking
237  * (indeed - the lock will already be held by our caller!!!) */
238 ENGINE *ENGINE_nuron()
239         {
240         const RSA_METHOD *meth1;
241         const DSA_METHOD *meth2;
242         const DH_METHOD *meth3;
243         ENGINE *ret = ENGINE_new();
244         if(!ret)
245                 return NULL;
246         if(!ENGINE_set_id(ret, engine_nuron_id) ||
247                         !ENGINE_set_name(ret, engine_nuron_name) ||
248                         !ENGINE_set_RSA(ret, &nuron_rsa) ||
249                         !ENGINE_set_DSA(ret, &nuron_dsa) ||
250                         !ENGINE_set_DH(ret, &nuron_dh) ||
251                         !ENGINE_set_BN_mod_exp(ret, nuron_mod_exp) ||
252                         !ENGINE_set_init_function(ret, nuron_init) ||
253                         !ENGINE_set_finish_function(ret, nuron_finish))
254                 {
255                 ENGINE_free(ret);
256                 return NULL;
257                 }
258
259         /* We know that the "PKCS1_SSLeay()" functions hook properly
260          * to the nuron-specific mod_exp and mod_exp_crt so we use
261          * those functions. NB: We don't use ENGINE_openssl() or
262          * anything "more generic" because something like the RSAref
263          * code may not hook properly, and if you own one of these
264          * cards then you have the right to do RSA operations on it
265          * anyway! */ 
266         meth1=RSA_PKCS1_SSLeay();
267         nuron_rsa.rsa_pub_enc=meth1->rsa_pub_enc;
268         nuron_rsa.rsa_pub_dec=meth1->rsa_pub_dec;
269         nuron_rsa.rsa_priv_enc=meth1->rsa_priv_enc;
270         nuron_rsa.rsa_priv_dec=meth1->rsa_priv_dec;
271
272         /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
273          * bits. */
274         meth2=DSA_OpenSSL();
275         nuron_dsa.dsa_do_sign=meth2->dsa_do_sign;
276         nuron_dsa.dsa_sign_setup=meth2->dsa_sign_setup;
277         nuron_dsa.dsa_do_verify=meth2->dsa_do_verify;
278
279         /* Much the same for Diffie-Hellman */
280         meth3=DH_OpenSSL();
281         nuron_dh.generate_key=meth3->generate_key;
282         nuron_dh.compute_key=meth3->compute_key;
283         return ret;
284         }
285
286 #endif /* !OPENSSL_NO_HW_NURON */
287 #endif /* !OPENSSL_NO_HW */