1 /* crypto/engine/e_gmp.c */
3 * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
61 * This engine is not (currently) compiled in by default. Do enable it,
62 * reconfigure OpenSSL with "enable-gmp -lgmp". The GMP libraries and headers
63 * must reside in one of the paths searched by the compiler/linker, otherwise
64 * paths must be specified - eg. try configuring with "enable-gmp
65 * -I<includepath> -L<libpath> -lgmp". YMMV.
69 * As for what this does - it's a largely unoptimised implementation of an
70 * ENGINE that uses the GMP library to perform RSA private key operations. To
71 * obtain more information about what "unoptimised" means, see my original mail
72 * on the subject (though ignore the build instructions which have since
75 * http://www.mail-archive.com/openssl-dev@openssl.org/msg12227.html
77 * On my athlon system at least, it appears the builtin OpenSSL code is now
78 * slightly faster, which is to say that the RSA-related MPI performance
79 * between OpenSSL's BIGNUM and GMP's mpz implementations is probably pretty
80 * balanced for this chip, and so the performance degradation in this ENGINE by
81 * having to convert to/from GMP formats (and not being able to cache
82 * montgomery forms) is probably the difference. However, if some unconfirmed
83 * reports from users is anything to go by, the situation on some other
84 * chipsets might be a good deal more favourable to the GMP version (eg. PPC).
85 * Feedback welcome. */
89 #include <openssl/crypto.h>
90 #include <openssl/buffer.h>
91 #include <openssl/engine.h>
92 #include <openssl/rsa.h>
93 #include <openssl/bn.h>
96 # ifndef OPENSSL_NO_GMP
100 # define E_GMP_LIB_NAME "gmp engine"
101 # include "e_gmp_err.c"
103 static int e_gmp_destroy(ENGINE *e);
104 static int e_gmp_init(ENGINE *e);
105 static int e_gmp_finish(ENGINE *e);
106 static int e_gmp_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
108 # ifndef OPENSSL_NO_RSA
110 static int e_gmp_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
112 static int e_gmp_rsa_finish(RSA *r);
115 /* The definitions for control commands specific to this engine */
116 /* #define E_GMP_CMD_SO_PATH ENGINE_CMD_BASE */
117 static const ENGINE_CMD_DEFN e_gmp_cmd_defns[] = {
121 "Specifies the path to the 'e_gmp' shared library",
122 ENGINE_CMD_FLAG_STRING},
127 # ifndef OPENSSL_NO_RSA
128 /* Our internal RSA_METHOD that we provide pointers to */
129 static RSA_METHOD e_gmp_rsa = {
140 * These flags initialise montgomery crud that GMP ignores, however it
141 * makes sure the public key ops (which are done in openssl) don't seem
142 * *slower* than usual :-)
144 RSA_FLAG_CACHE_PUBLIC | RSA_FLAG_CACHE_PRIVATE,
151 /* Constants used when creating the ENGINE */
152 static const char *engine_e_gmp_id = "gmp";
153 static const char *engine_e_gmp_name = "GMP engine support";
156 * This internal function is used by ENGINE_gmp() and possibly by the
157 * "dynamic" ENGINE support too
159 static int bind_helper(ENGINE *e)
161 # ifndef OPENSSL_NO_RSA
162 const RSA_METHOD *meth1;
164 if (!ENGINE_set_id(e, engine_e_gmp_id) ||
165 !ENGINE_set_name(e, engine_e_gmp_name) ||
166 # ifndef OPENSSL_NO_RSA
167 !ENGINE_set_RSA(e, &e_gmp_rsa) ||
169 !ENGINE_set_destroy_function(e, e_gmp_destroy) ||
170 !ENGINE_set_init_function(e, e_gmp_init) ||
171 !ENGINE_set_finish_function(e, e_gmp_finish) ||
172 !ENGINE_set_ctrl_function(e, e_gmp_ctrl) ||
173 !ENGINE_set_cmd_defns(e, e_gmp_cmd_defns))
176 # ifndef OPENSSL_NO_RSA
177 meth1 = RSA_PKCS1_SSLeay();
178 e_gmp_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
179 e_gmp_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
180 e_gmp_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
181 e_gmp_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
182 e_gmp_rsa.bn_mod_exp = meth1->bn_mod_exp;
185 /* Ensure the e_gmp error handling is set up */
186 ERR_load_GMP_strings();
190 static ENGINE *engine_gmp(void)
192 ENGINE *ret = ENGINE_new();
195 if (!bind_helper(ret)) {
202 void ENGINE_load_gmp(void)
204 /* Copied from eng_[openssl|dyn].c */
205 ENGINE *toadd = engine_gmp();
213 # ifndef OPENSSL_NO_RSA
214 /* Used to attach our own key-data to an RSA structure */
215 static int hndidx_rsa = -1;
218 static int e_gmp_destroy(ENGINE *e)
220 ERR_unload_GMP_strings();
224 /* (de)initialisation functions. */
225 static int e_gmp_init(ENGINE *e)
227 # ifndef OPENSSL_NO_RSA
228 if (hndidx_rsa == -1)
229 hndidx_rsa = RSA_get_ex_new_index(0,
230 "GMP-based RSA key handle",
233 if (hndidx_rsa == -1)
238 static int e_gmp_finish(ENGINE *e)
243 static int e_gmp_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
249 case E_GMP_CMD_SO_PATH:
252 /* The command isn't understood by this engine */
254 GMPerr(GMP_F_E_GMP_CTRL, GMP_R_CTRL_COMMAND_NOT_IMPLEMENTED);
263 * Most often limb sizes will be the same. If not, we use hex conversion
264 * which is neat, but extremely inefficient.
266 static int bn2gmp(const BIGNUM *bn, mpz_t g)
269 if (((sizeof(bn->d[0]) * 8) == GMP_NUMB_BITS) &&
270 (BN_BITS2 == GMP_NUMB_BITS)) {
271 /* The common case */
272 if (!_mpz_realloc(g, bn->top))
274 memcpy(&g->_mp_d[0], &bn->d[0], bn->top * sizeof(bn->d[0]));
275 g->_mp_size = bn->top;
277 g->_mp_size = -g->_mp_size;
281 char *tmpchar = BN_bn2hex(bn);
284 toret = (mpz_set_str(g, tmpchar, 16) == 0 ? 1 : 0);
285 OPENSSL_free(tmpchar);
290 static int gmp2bn(mpz_t g, BIGNUM *bn)
292 if (((sizeof(bn->d[0]) * 8) == GMP_NUMB_BITS) &&
293 (BN_BITS2 == GMP_NUMB_BITS)) {
294 /* The common case */
295 int s = (g->_mp_size >= 0) ? g->_mp_size : -g->_mp_size;
297 if (bn_expand2(bn, s) == NULL)
300 memcpy(&bn->d[0], &g->_mp_d[0], s * sizeof(bn->d[0]));
302 bn->neg = g->_mp_size >= 0 ? 0 : 1;
306 char *tmpchar = OPENSSL_malloc(mpz_sizeinbase(g, 16) + 10);
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 {
327 mpz_t r0, r1, I0, m1;
330 static E_GMP_RSA_CTX *e_gmp_get_rsa(RSA *rsa)
332 E_GMP_RSA_CTX *hptr = RSA_get_ex_data(rsa, hndidx_rsa);
335 hptr = OPENSSL_malloc(sizeof(E_GMP_RSA_CTX));
339 * These inits could probably be replaced by more intelligent mpz_init2()
340 * versions, to reduce malloc-thrashing.
347 mpz_init(hptr->dmp1);
348 mpz_init(hptr->dmq1);
349 mpz_init(hptr->iqmp);
354 if (!bn2gmp(rsa->n, hptr->n) || !bn2gmp(rsa->e, hptr->e))
356 if (!rsa->p || !rsa->q || !rsa->d || !rsa->dmp1 || !rsa->dmq1
358 hptr->public_only = 1;
361 if (!bn2gmp(rsa->d, hptr->d) || !bn2gmp(rsa->p, hptr->p) ||
362 !bn2gmp(rsa->q, hptr->q) || !bn2gmp(rsa->dmp1, hptr->dmp1) ||
363 !bn2gmp(rsa->dmq1, hptr->dmq1) || !bn2gmp(rsa->iqmp, hptr->iqmp))
365 hptr->public_only = 0;
366 RSA_set_ex_data(rsa, hndidx_rsa, hptr);
374 mpz_clear(hptr->dmp1);
375 mpz_clear(hptr->dmq1);
376 mpz_clear(hptr->iqmp);
385 static int e_gmp_rsa_finish(RSA *rsa)
387 E_GMP_RSA_CTX *hptr = RSA_get_ex_data(rsa, hndidx_rsa);
395 mpz_clear(hptr->dmp1);
396 mpz_clear(hptr->dmq1);
397 mpz_clear(hptr->iqmp);
403 RSA_set_ex_data(rsa, hndidx_rsa, NULL);
407 static int e_gmp_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
413 hptr = e_gmp_get_rsa(rsa);
415 GMPerr(GMP_F_E_GMP_RSA_MOD_EXP, GMP_R_KEY_CONTEXT_ERROR);
418 if (hptr->public_only) {
419 GMPerr(GMP_F_E_GMP_RSA_MOD_EXP, GMP_R_MISSING_KEY_COMPONENTS);
424 if (!bn2gmp(I, hptr->I0))
428 * This is basically the CRT logic in crypto/rsa/rsa_eay.c reworded into
429 * GMP-speak. It may be that GMP's API facilitates cleaner formulations
430 * of this stuff, eg. better handling of negatives, or functions that
431 * combine operations.
434 mpz_mod(hptr->r1, hptr->I0, hptr->q);
435 mpz_powm(hptr->m1, hptr->r1, hptr->dmq1, hptr->q);
437 mpz_mod(hptr->r1, hptr->I0, hptr->p);
438 mpz_powm(hptr->r0, hptr->r1, hptr->dmp1, hptr->p);
440 mpz_sub(hptr->r0, hptr->r0, hptr->m1);
442 if (mpz_sgn(hptr->r0) < 0)
443 mpz_add(hptr->r0, hptr->r0, hptr->p);
444 mpz_mul(hptr->r1, hptr->r0, hptr->iqmp);
445 mpz_mod(hptr->r0, hptr->r1, hptr->p);
447 if (mpz_sgn(hptr->r0) < 0)
448 mpz_add(hptr->r0, hptr->r0, hptr->p);
449 mpz_mul(hptr->r1, hptr->r0, hptr->q);
450 mpz_add(hptr->r0, hptr->r1, hptr->m1);
453 if (gmp2bn(hptr->r0, r))
460 # endif /* !OPENSSL_NO_GMP */
463 * This stuff is needed if this ENGINE is being compiled into a
464 * self-contained shared-library.
466 # ifndef OPENSSL_NO_DYNAMIC_ENGINE
467 IMPLEMENT_DYNAMIC_CHECK_FN()
468 # ifndef OPENSSL_NO_GMP
469 static int bind_fn(ENGINE *e, const char *id)
471 if (id && (strcmp(id, engine_e_gmp_id) != 0))
478 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
481 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns)
486 # endif /* OPENSSL_NO_DYNAMIC_ENGINE */
488 #endif /* !OPENSSL_NO_HW */