1 /* crypto/engine/e_gmp.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-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).
59 /* This engine is not (currently) compiled in by default. Do enable it,
60 * reconfigure OpenSSL with "enable-gmp -lgmp". The GMP libraries and
61 * headers must reside in one of the paths searched by the compiler/linker,
62 * otherwise paths must be specified - eg. try configuring with
63 * "enable-gmp -I<includepath> -L<libpath> -lgmp". YMMV. */
66 * As for what this does - it's a largely unoptimised implementation of an
67 * ENGINE that uses the GMP library to perform RSA private key operations. To
68 * obtain more information about what "unoptimised" means, see my original mail
69 * on the subject (though ignore the build instructions which have since
72 * http://www.mail-archive.com/openssl-dev@openssl.org/msg12227.html
74 * On my athlon system at least, it appears the builtin OpenSSL code is now
75 * slightly faster, which is to say that the RSA-related MPI performance
76 * between OpenSSL's BIGNUM and GMP's mpz implementations is probably pretty
77 * balanced for this chip, and so the performance degradation in this ENGINE by
78 * having to convert to/from GMP formats (and not being able to cache
79 * montgomery forms) is probably the difference. However, if some unconfirmed
80 * reports from users is anything to go by, the situation on some other
81 * chipsets might be a good deal more favourable to the GMP version (eg. PPC).
82 * Feedback welcome. */
86 #include <openssl/crypto.h>
87 #include <openssl/buffer.h>
88 #include <openssl/engine.h>
89 #ifndef OPENSSL_NO_RSA
90 #include <openssl/rsa.h>
92 #include <openssl/bn.h>
95 #ifndef OPENSSL_NO_GMP
99 #define E_GMP_LIB_NAME "gmp engine"
100 #include "e_gmp_err.c"
102 static int e_gmp_destroy(ENGINE *e);
103 static int e_gmp_init(ENGINE *e);
104 static int e_gmp_finish(ENGINE *e);
105 static int e_gmp_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
107 #ifndef OPENSSL_NO_RSA
109 static int e_gmp_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
110 static int e_gmp_rsa_finish(RSA *r);
113 /* The definitions for control commands specific to this engine */
114 /* #define E_GMP_CMD_SO_PATH ENGINE_CMD_BASE */
115 static const ENGINE_CMD_DEFN e_gmp_cmd_defns[] = {
119 "Specifies the path to the 'e_gmp' shared library",
120 ENGINE_CMD_FLAG_STRING},
125 #ifndef OPENSSL_NO_RSA
126 /* Our internal RSA_METHOD that we provide pointers to */
127 static RSA_METHOD e_gmp_rsa =
138 /* These flags initialise montgomery crud that GMP ignores, however it
139 * makes sure the public key ops (which are done in openssl) don't seem
140 * *slower* than usual :-) */
141 RSA_FLAG_CACHE_PUBLIC|RSA_FLAG_CACHE_PRIVATE,
148 /* Constants used when creating the ENGINE */
149 static const char *engine_e_gmp_id = "gmp";
150 static const char *engine_e_gmp_name = "GMP engine support";
152 /* This internal function is used by ENGINE_gmp() and possibly by the
153 * "dynamic" ENGINE support too */
154 static int bind_helper(ENGINE *e)
156 #ifndef OPENSSL_NO_RSA
157 const RSA_METHOD *meth1;
159 if(!ENGINE_set_id(e, engine_e_gmp_id) ||
160 !ENGINE_set_name(e, engine_e_gmp_name) ||
161 #ifndef OPENSSL_NO_RSA
162 !ENGINE_set_RSA(e, &e_gmp_rsa) ||
164 !ENGINE_set_destroy_function(e, e_gmp_destroy) ||
165 !ENGINE_set_init_function(e, e_gmp_init) ||
166 !ENGINE_set_finish_function(e, e_gmp_finish) ||
167 !ENGINE_set_ctrl_function(e, e_gmp_ctrl) ||
168 !ENGINE_set_cmd_defns(e, e_gmp_cmd_defns))
171 #ifndef OPENSSL_NO_RSA
172 meth1 = RSA_PKCS1_SSLeay();
173 e_gmp_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
174 e_gmp_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
175 e_gmp_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
176 e_gmp_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
177 e_gmp_rsa.bn_mod_exp = meth1->bn_mod_exp;
180 /* Ensure the e_gmp error handling is set up */
181 ERR_load_GMP_strings();
185 static ENGINE *engine_gmp(void)
187 ENGINE *ret = ENGINE_new();
190 if(!bind_helper(ret))
198 void ENGINE_load_gmp(void)
200 /* Copied from eng_[openssl|dyn].c */
201 ENGINE *toadd = engine_gmp();
208 #ifndef OPENSSL_NO_RSA
209 /* Used to attach our own key-data to an RSA structure */
210 static int hndidx_rsa = -1;
213 static int e_gmp_destroy(ENGINE *e)
215 ERR_unload_GMP_strings();
219 /* (de)initialisation functions. */
220 static int e_gmp_init(ENGINE *e)
222 #ifndef OPENSSL_NO_RSA
223 if (hndidx_rsa == -1)
224 hndidx_rsa = RSA_get_ex_new_index(0,
225 "GMP-based RSA key handle",
228 if (hndidx_rsa == -1)
233 static int e_gmp_finish(ENGINE *e)
238 static int e_gmp_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
245 case E_GMP_CMD_SO_PATH:
248 /* The command isn't understood by this engine */
250 GMPerr(GMP_F_E_GMP_CTRL,
251 GMP_R_CTRL_COMMAND_NOT_IMPLEMENTED);
260 /* Most often limb sizes will be the same. If not, we use hex conversion
261 * which is neat, but extremely inefficient. */
262 static int bn2gmp(const BIGNUM *bn, mpz_t g)
265 if(((sizeof(bn->d[0]) * 8) == GMP_NUMB_BITS) &&
266 (BN_BITS2 == GMP_NUMB_BITS))
268 /* The common case */
269 if(!_mpz_realloc (g, bn->top))
271 memcpy(&g->_mp_d[0], &bn->d[0], bn->top * sizeof(bn->d[0]));
272 g->_mp_size = bn->top;
274 g->_mp_size = -g->_mp_size;
280 char *tmpchar = BN_bn2hex(bn);
281 if(!tmpchar) return 0;
282 toret = (mpz_set_str(g, tmpchar, 16) == 0 ? 1 : 0);
283 OPENSSL_free(tmpchar);
288 static int gmp2bn(mpz_t g, BIGNUM *bn)
290 if(((sizeof(bn->d[0]) * 8) == GMP_NUMB_BITS) &&
291 (BN_BITS2 == GMP_NUMB_BITS))
293 /* The common case */
294 int s = (g->_mp_size >= 0) ? g->_mp_size : -g->_mp_size;
296 if(bn_expand2 (bn, s) == NULL)
299 memcpy(&bn->d[0], &g->_mp_d[0], s * sizeof(bn->d[0]));
301 bn->neg = g->_mp_size >= 0 ? 0 : 1;
307 char *tmpchar = OPENSSL_malloc(mpz_sizeinbase(g, 16) + 10);
308 if(!tmpchar) return 0;
309 mpz_get_str(tmpchar, 16, g);
310 toret = BN_hex2bn(&bn, tmpchar);
311 OPENSSL_free(tmpchar);
316 #ifndef OPENSSL_NO_RSA
317 typedef struct st_e_gmp_rsa_ctx
328 mpz_t r0, r1, I0, m1;
331 static E_GMP_RSA_CTX *e_gmp_get_rsa(RSA *rsa)
333 E_GMP_RSA_CTX *hptr = RSA_get_ex_data(rsa, hndidx_rsa);
334 if(hptr) return hptr;
335 hptr = OPENSSL_malloc(sizeof(E_GMP_RSA_CTX));
336 if(!hptr) return NULL;
337 /* These inits could probably be replaced by more intelligent
338 * mpz_init2() versions, to reduce malloc-thrashing. */
344 mpz_init(hptr->dmp1);
345 mpz_init(hptr->dmq1);
346 mpz_init(hptr->iqmp);
351 if(!bn2gmp(rsa->n, hptr->n) || !bn2gmp(rsa->e, hptr->e))
353 if(!rsa->p || !rsa->q || !rsa->d || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp)
355 hptr->public_only = 1;
358 if(!bn2gmp(rsa->d, hptr->d) || !bn2gmp(rsa->p, hptr->p) ||
359 !bn2gmp(rsa->q, hptr->q) || !bn2gmp(rsa->dmp1, hptr->dmp1) ||
360 !bn2gmp(rsa->dmq1, hptr->dmq1) || !bn2gmp(rsa->iqmp, hptr->iqmp))
362 hptr->public_only = 0;
363 RSA_set_ex_data(rsa, hndidx_rsa, hptr);
371 mpz_clear(hptr->dmp1);
372 mpz_clear(hptr->dmq1);
373 mpz_clear(hptr->iqmp);
382 static int e_gmp_rsa_finish(RSA *rsa)
384 E_GMP_RSA_CTX *hptr = RSA_get_ex_data(rsa, hndidx_rsa);
391 mpz_clear(hptr->dmp1);
392 mpz_clear(hptr->dmq1);
393 mpz_clear(hptr->iqmp);
399 RSA_set_ex_data(rsa, hndidx_rsa, NULL);
403 static int e_gmp_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa, BN_CTX *ctx)
408 hptr = e_gmp_get_rsa(rsa);
411 GMPerr(GMP_F_E_GMP_RSA_MOD_EXP,
412 GMP_R_KEY_CONTEXT_ERROR);
415 if(hptr->public_only)
417 GMPerr(GMP_F_E_GMP_RSA_MOD_EXP,
418 GMP_R_MISSING_KEY_COMPONENTS);
423 if(!bn2gmp(I, hptr->I0))
426 /* This is basically the CRT logic in crypto/rsa/rsa_eay.c reworded into
427 * GMP-speak. It may be that GMP's API facilitates cleaner formulations
428 * of this stuff, eg. better handling of negatives, or functions that
429 * combine operations. */
431 mpz_mod(hptr->r1, hptr->I0, hptr->q);
432 mpz_powm(hptr->m1, hptr->r1, hptr->dmq1, hptr->q);
434 mpz_mod(hptr->r1, hptr->I0, hptr->p);
435 mpz_powm(hptr->r0, hptr->r1, hptr->dmp1, hptr->p);
437 mpz_sub(hptr->r0, hptr->r0, hptr->m1);
439 if(mpz_sgn(hptr->r0) < 0)
440 mpz_add(hptr->r0, hptr->r0, hptr->p);
441 mpz_mul(hptr->r1, hptr->r0, hptr->iqmp);
442 mpz_mod(hptr->r0, hptr->r1, hptr->p);
444 if(mpz_sgn(hptr->r0) < 0)
445 mpz_add(hptr->r0, hptr->r0, hptr->p);
446 mpz_mul(hptr->r1, hptr->r0, hptr->q);
447 mpz_add(hptr->r0, hptr->r1, hptr->m1);
450 if(gmp2bn(hptr->r0, r))
457 #endif /* !OPENSSL_NO_GMP */
459 /* This stuff is needed if this ENGINE is being compiled into a self-contained
461 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
462 IMPLEMENT_DYNAMIC_CHECK_FN()
463 #ifndef OPENSSL_NO_GMP
464 static int bind_fn(ENGINE *e, const char *id)
466 if(id && (strcmp(id, engine_e_gmp_id) != 0))
472 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
475 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns);
477 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { return 0; }
479 #endif /* !OPENSSL_NO_DYNAMIC_ENGINE */
481 #endif /* !OPENSSL_NO_HW */