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 #ifndef OPENSSL_NO_RSA
93 # include <openssl/rsa.h>
95 #include <openssl/bn.h>
98 # ifndef OPENSSL_NO_GMP
102 # define E_GMP_LIB_NAME "gmp engine"
103 # include "e_gmp_err.c"
105 static int e_gmp_destroy(ENGINE
*e
);
106 static int e_gmp_init(ENGINE
*e
);
107 static int e_gmp_finish(ENGINE
*e
);
108 static int e_gmp_ctrl(ENGINE
*e
, int cmd
, long i
, void *p
, void (*f
) (void));
110 # ifndef OPENSSL_NO_RSA
112 static int e_gmp_rsa_mod_exp(BIGNUM
*r
, const BIGNUM
*I
, RSA
*rsa
,
114 static int e_gmp_rsa_finish(RSA
*r
);
117 /* The definitions for control commands specific to this engine */
118 /* #define E_GMP_CMD_SO_PATH ENGINE_CMD_BASE */
119 static const ENGINE_CMD_DEFN e_gmp_cmd_defns
[] = {
123 "Specifies the path to the 'e_gmp' shared library",
124 ENGINE_CMD_FLAG_STRING
},
129 # ifndef OPENSSL_NO_RSA
130 /* Our internal RSA_METHOD that we provide pointers to */
131 static RSA_METHOD e_gmp_rsa
= {
142 * These flags initialise montgomery crud that GMP ignores, however it
143 * makes sure the public key ops (which are done in openssl) don't seem
144 * *slower* than usual :-)
146 RSA_FLAG_CACHE_PUBLIC
| RSA_FLAG_CACHE_PRIVATE
,
153 /* Constants used when creating the ENGINE */
154 static const char *engine_e_gmp_id
= "gmp";
155 static const char *engine_e_gmp_name
= "GMP engine support";
158 * This internal function is used by ENGINE_gmp() and possibly by the
159 * "dynamic" ENGINE support too
161 static int bind_helper(ENGINE
*e
)
163 # ifndef OPENSSL_NO_RSA
164 const RSA_METHOD
*meth1
;
166 if (!ENGINE_set_id(e
, engine_e_gmp_id
) ||
167 !ENGINE_set_name(e
, engine_e_gmp_name
) ||
168 # ifndef OPENSSL_NO_RSA
169 !ENGINE_set_RSA(e
, &e_gmp_rsa
) ||
171 !ENGINE_set_destroy_function(e
, e_gmp_destroy
) ||
172 !ENGINE_set_init_function(e
, e_gmp_init
) ||
173 !ENGINE_set_finish_function(e
, e_gmp_finish
) ||
174 !ENGINE_set_ctrl_function(e
, e_gmp_ctrl
) ||
175 !ENGINE_set_cmd_defns(e
, e_gmp_cmd_defns
))
178 # ifndef OPENSSL_NO_RSA
179 meth1
= RSA_PKCS1_SSLeay();
180 e_gmp_rsa
.rsa_pub_enc
= meth1
->rsa_pub_enc
;
181 e_gmp_rsa
.rsa_pub_dec
= meth1
->rsa_pub_dec
;
182 e_gmp_rsa
.rsa_priv_enc
= meth1
->rsa_priv_enc
;
183 e_gmp_rsa
.rsa_priv_dec
= meth1
->rsa_priv_dec
;
184 e_gmp_rsa
.bn_mod_exp
= meth1
->bn_mod_exp
;
187 /* Ensure the e_gmp error handling is set up */
188 ERR_load_GMP_strings();
192 static ENGINE
*engine_gmp(void)
194 ENGINE
*ret
= ENGINE_new();
197 if (!bind_helper(ret
)) {
204 void ENGINE_load_gmp(void)
206 /* Copied from eng_[openssl|dyn].c */
207 ENGINE
*toadd
= engine_gmp();
215 # ifndef OPENSSL_NO_RSA
216 /* Used to attach our own key-data to an RSA structure */
217 static int hndidx_rsa
= -1;
220 static int e_gmp_destroy(ENGINE
*e
)
222 ERR_unload_GMP_strings();
226 /* (de)initialisation functions. */
227 static int e_gmp_init(ENGINE
*e
)
229 # ifndef OPENSSL_NO_RSA
230 if (hndidx_rsa
== -1)
231 hndidx_rsa
= RSA_get_ex_new_index(0,
232 "GMP-based RSA key handle",
235 if (hndidx_rsa
== -1)
240 static int e_gmp_finish(ENGINE
*e
)
245 static int e_gmp_ctrl(ENGINE
*e
, int cmd
, long i
, void *p
, void (*f
) (void))
251 case E_GMP_CMD_SO_PATH
:
254 /* The command isn't understood by this engine */
256 GMPerr(GMP_F_E_GMP_CTRL
, GMP_R_CTRL_COMMAND_NOT_IMPLEMENTED
);
265 * Most often limb sizes will be the same. If not, we use hex conversion
266 * which is neat, but extremely inefficient.
268 static int bn2gmp(const BIGNUM
*bn
, mpz_t g
)
271 if (((sizeof(bn
->d
[0]) * 8) == GMP_NUMB_BITS
) &&
272 (BN_BITS2
== GMP_NUMB_BITS
)) {
273 /* The common case */
274 if (!_mpz_realloc(g
, bn
->top
))
276 memcpy(&g
->_mp_d
[0], &bn
->d
[0], bn
->top
* sizeof(bn
->d
[0]));
277 g
->_mp_size
= bn
->top
;
279 g
->_mp_size
= -g
->_mp_size
;
283 char *tmpchar
= BN_bn2hex(bn
);
286 toret
= (mpz_set_str(g
, tmpchar
, 16) == 0 ? 1 : 0);
287 OPENSSL_free(tmpchar
);
292 static int gmp2bn(mpz_t g
, BIGNUM
*bn
)
294 if (((sizeof(bn
->d
[0]) * 8) == GMP_NUMB_BITS
) &&
295 (BN_BITS2
== GMP_NUMB_BITS
)) {
296 /* The common case */
297 int s
= (g
->_mp_size
>= 0) ? g
->_mp_size
: -g
->_mp_size
;
299 if (bn_expand2(bn
, s
) == NULL
)
302 memcpy(&bn
->d
[0], &g
->_mp_d
[0], s
* sizeof(bn
->d
[0]));
304 bn
->neg
= g
->_mp_size
>= 0 ? 0 : 1;
308 char *tmpchar
= OPENSSL_malloc(mpz_sizeinbase(g
, 16) + 10);
311 mpz_get_str(tmpchar
, 16, g
);
312 toret
= BN_hex2bn(&bn
, tmpchar
);
313 OPENSSL_free(tmpchar
);
318 # ifndef OPENSSL_NO_RSA
319 typedef struct st_e_gmp_rsa_ctx
{
329 mpz_t r0
, r1
, I0
, m1
;
332 static E_GMP_RSA_CTX
*e_gmp_get_rsa(RSA
*rsa
)
334 E_GMP_RSA_CTX
*hptr
= RSA_get_ex_data(rsa
, hndidx_rsa
);
337 hptr
= OPENSSL_malloc(sizeof(E_GMP_RSA_CTX
));
341 * These inits could probably be replaced by more intelligent mpz_init2()
342 * versions, to reduce malloc-thrashing.
349 mpz_init(hptr
->dmp1
);
350 mpz_init(hptr
->dmq1
);
351 mpz_init(hptr
->iqmp
);
356 if (!bn2gmp(rsa
->n
, hptr
->n
) || !bn2gmp(rsa
->e
, hptr
->e
))
358 if (!rsa
->p
|| !rsa
->q
|| !rsa
->d
|| !rsa
->dmp1
|| !rsa
->dmq1
360 hptr
->public_only
= 1;
363 if (!bn2gmp(rsa
->d
, hptr
->d
) || !bn2gmp(rsa
->p
, hptr
->p
) ||
364 !bn2gmp(rsa
->q
, hptr
->q
) || !bn2gmp(rsa
->dmp1
, hptr
->dmp1
) ||
365 !bn2gmp(rsa
->dmq1
, hptr
->dmq1
) || !bn2gmp(rsa
->iqmp
, hptr
->iqmp
))
367 hptr
->public_only
= 0;
368 RSA_set_ex_data(rsa
, hndidx_rsa
, hptr
);
376 mpz_clear(hptr
->dmp1
);
377 mpz_clear(hptr
->dmq1
);
378 mpz_clear(hptr
->iqmp
);
387 static int e_gmp_rsa_finish(RSA
*rsa
)
389 E_GMP_RSA_CTX
*hptr
= RSA_get_ex_data(rsa
, hndidx_rsa
);
397 mpz_clear(hptr
->dmp1
);
398 mpz_clear(hptr
->dmq1
);
399 mpz_clear(hptr
->iqmp
);
405 RSA_set_ex_data(rsa
, hndidx_rsa
, NULL
);
409 static int e_gmp_rsa_mod_exp(BIGNUM
*r
, const BIGNUM
*I
, RSA
*rsa
,
415 hptr
= e_gmp_get_rsa(rsa
);
417 GMPerr(GMP_F_E_GMP_RSA_MOD_EXP
, GMP_R_KEY_CONTEXT_ERROR
);
420 if (hptr
->public_only
) {
421 GMPerr(GMP_F_E_GMP_RSA_MOD_EXP
, GMP_R_MISSING_KEY_COMPONENTS
);
426 if (!bn2gmp(I
, hptr
->I0
))
430 * This is basically the CRT logic in crypto/rsa/rsa_eay.c reworded into
431 * GMP-speak. It may be that GMP's API facilitates cleaner formulations
432 * of this stuff, eg. better handling of negatives, or functions that
433 * combine operations.
436 mpz_mod(hptr
->r1
, hptr
->I0
, hptr
->q
);
437 mpz_powm(hptr
->m1
, hptr
->r1
, hptr
->dmq1
, hptr
->q
);
439 mpz_mod(hptr
->r1
, hptr
->I0
, hptr
->p
);
440 mpz_powm(hptr
->r0
, hptr
->r1
, hptr
->dmp1
, hptr
->p
);
442 mpz_sub(hptr
->r0
, hptr
->r0
, hptr
->m1
);
444 if (mpz_sgn(hptr
->r0
) < 0)
445 mpz_add(hptr
->r0
, hptr
->r0
, hptr
->p
);
446 mpz_mul(hptr
->r1
, hptr
->r0
, hptr
->iqmp
);
447 mpz_mod(hptr
->r0
, hptr
->r1
, hptr
->p
);
449 if (mpz_sgn(hptr
->r0
) < 0)
450 mpz_add(hptr
->r0
, hptr
->r0
, hptr
->p
);
451 mpz_mul(hptr
->r1
, hptr
->r0
, hptr
->q
);
452 mpz_add(hptr
->r0
, hptr
->r1
, hptr
->m1
);
455 if (gmp2bn(hptr
->r0
, r
))
462 # endif /* !OPENSSL_NO_GMP */
465 * This stuff is needed if this ENGINE is being compiled into a
466 * self-contained shared-library.
468 # ifndef OPENSSL_NO_DYNAMIC_ENGINE
469 IMPLEMENT_DYNAMIC_CHECK_FN()
470 # ifndef OPENSSL_NO_GMP
471 static int bind_fn(ENGINE
*e
, const char *id
)
473 if (id
&& (strcmp(id
, engine_e_gmp_id
) != 0))
480 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn
)
483 int bind_engine(ENGINE
*e
, const char *id
, const dynamic_fns
*fns
);
485 int bind_engine(ENGINE
*e
, const char *id
, const dynamic_fns
*fns
)
490 # endif /* !OPENSSL_NO_DYNAMIC_ENGINE */
492 #endif /* !OPENSSL_NO_HW */