1 /* crypto/engine/eng_rsax.c */
2 /* Copyright (c) 2010-2010 Intel Corp.
3 * Author: Vinodh.Gopal@intel.com
5 * Erdinc.Ozturk@intel.com
6 * Maxim.Perminov@intel.com
9 * More information about algorithm used can be found at:
10 * http://www.cse.buffalo.edu/srds2009/escs2009_submission_Gopal.pdf
12 /* ====================================================================
13 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in
24 * the documentation and/or other materials provided with the
27 * 3. All advertising materials mentioning features or use of this
28 * software must display the following acknowledgment:
29 * "This product includes software developed by the OpenSSL Project
30 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
32 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
33 * endorse or promote products derived from this software without
34 * prior written permission. For written permission, please contact
35 * licensing@OpenSSL.org.
37 * 5. Products derived from this software may not be called "OpenSSL"
38 * nor may "OpenSSL" appear in their names without prior written
39 * permission of the OpenSSL Project.
41 * 6. Redistributions of any form whatsoever must retain the following
43 * "This product includes software developed by the OpenSSL Project
44 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
46 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
47 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
49 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
50 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
51 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
53 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
55 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
56 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
57 * OF THE POSSIBILITY OF SUCH DAMAGE.
58 * ====================================================================
60 * This product includes cryptographic software written by Eric Young
61 * (eay@cryptsoft.com). This product includes software written by Tim
62 * Hudson (tjh@cryptsoft.com).
65 #include <openssl/opensslconf.h>
69 #include <openssl/crypto.h>
70 #include <openssl/buffer.h>
71 #include <openssl/engine.h>
72 #ifndef OPENSSL_NO_RSA
73 #include <openssl/rsa.h>
75 #include <openssl/bn.h>
77 /* RSAX is available **ONLY* on x86_64 CPUs */
80 #if (defined(__x86_64) || defined(__x86_64__) || \
81 defined(_M_AMD64) || defined (_M_X64)) && !defined(OPENSSL_NO_ASM)
83 static ENGINE *ENGINE_rsax (void);
86 void ENGINE_load_rsax (void)
88 /* On non-x86 CPUs it just returns. */
90 ENGINE *toadd = ENGINE_rsax();
99 #define E_RSAX_LIB_NAME "rsax engine"
101 static int e_rsax_destroy(ENGINE *e);
102 static int e_rsax_init(ENGINE *e);
103 static int e_rsax_finish(ENGINE *e);
104 static int e_rsax_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
106 #ifndef OPENSSL_NO_RSA
108 static int e_rsax_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
109 static int e_rsax_rsa_finish(RSA *r);
112 static const ENGINE_CMD_DEFN e_rsax_cmd_defns[] = {
116 #ifndef OPENSSL_NO_RSA
117 /* Our internal RSA_METHOD that we provide pointers to */
118 static RSA_METHOD e_rsax_rsa =
120 "Intel RSA-X method",
129 RSA_FLAG_CACHE_PUBLIC|RSA_FLAG_CACHE_PRIVATE,
136 /* Constants used when creating the ENGINE */
137 static const char *engine_e_rsax_id = "rsax";
138 static const char *engine_e_rsax_name = "RSAX engine support";
140 /* This internal function is used by ENGINE_rsax() */
141 static int bind_helper(ENGINE *e)
143 #ifndef OPENSSL_NO_RSA
144 const RSA_METHOD *meth1;
146 if(!ENGINE_set_id(e, engine_e_rsax_id) ||
147 !ENGINE_set_name(e, engine_e_rsax_name) ||
148 #ifndef OPENSSL_NO_RSA
149 !ENGINE_set_RSA(e, &e_rsax_rsa) ||
151 !ENGINE_set_destroy_function(e, e_rsax_destroy) ||
152 !ENGINE_set_init_function(e, e_rsax_init) ||
153 !ENGINE_set_finish_function(e, e_rsax_finish) ||
154 !ENGINE_set_ctrl_function(e, e_rsax_ctrl) ||
155 !ENGINE_set_cmd_defns(e, e_rsax_cmd_defns))
158 #ifndef OPENSSL_NO_RSA
159 meth1 = RSA_PKCS1_SSLeay();
160 e_rsax_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
161 e_rsax_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
162 e_rsax_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
163 e_rsax_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
164 e_rsax_rsa.bn_mod_exp = meth1->bn_mod_exp;
169 static ENGINE *ENGINE_rsax(void)
171 ENGINE *ret = ENGINE_new();
174 if(!bind_helper(ret))
182 #ifndef OPENSSL_NO_RSA
183 /* Used to attach our own key-data to an RSA structure */
184 static int rsax_ex_data_idx = -1;
187 static int e_rsax_destroy(ENGINE *e)
192 /* (de)initialisation functions. */
193 static int e_rsax_init(ENGINE *e)
195 #ifndef OPENSSL_NO_RSA
196 if (rsax_ex_data_idx == -1)
197 rsax_ex_data_idx = RSA_get_ex_new_index(0,
201 if (rsax_ex_data_idx == -1)
206 static int e_rsax_finish(ENGINE *e)
211 static int e_rsax_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
217 /* The command isn't understood by this engine */
227 #ifndef OPENSSL_NO_RSA
230 typedef uint64_t UINT64;
231 typedef uint16_t UINT16;
233 /* Table t is interleaved in the following manner:
234 * The order in memory is t[0][0], t[0][1], ..., t[0][7], t[1][0], ...
235 * A particular 512-bit value is stored in t[][index] rather than the more
236 * normal t[index][]; i.e. the qwords of a particular entry in t are not
240 /* Init BIGNUM b from the interleaved UINT64 array */
241 static int interleaved_array_to_bn_512(BIGNUM* b, UINT64 *array);
243 /* Extract array elements from BIGNUM b
244 * To set the whole array from b, call with n=8
246 static int bn_extract_to_array_512(const BIGNUM* b, unsigned int n, UINT64 *array);
251 UINT64 m1[8]; /* 2^278 % m */
252 UINT64 m2[8]; /* 2^640 % m */
253 UINT64 k1[2]; /* (- 1/m) % 2^128 */
256 static int mod_exp_pre_compute_data_512(UINT64 *m, struct mod_ctx_512 *data);
258 void mod_exp_512(UINT64 *result, /* 512 bits, 8 qwords */
259 UINT64 *g, /* 512 bits, 8 qwords */
260 UINT64 *exp, /* 512 bits, 8 qwords */
261 struct mod_ctx_512 *data);
263 typedef struct st_e_rsax_mod_ctx
267 struct mod_ctx_512 b512;
272 static E_RSAX_MOD_CTX *e_rsax_get_ctx(RSA *rsa, int idx, BIGNUM* m)
274 E_RSAX_MOD_CTX *hptr;
276 if (idx < 0 || idx > 2)
279 hptr = RSA_get_ex_data(rsa, rsax_ex_data_idx);
281 hptr = OPENSSL_malloc(3*sizeof(E_RSAX_MOD_CTX));
282 if (!hptr) return NULL;
283 hptr[2].type = hptr[1].type= hptr[0].type = 0;
284 RSA_set_ex_data(rsa, rsax_ex_data_idx, hptr);
287 if (hptr[idx].type == BN_num_bits(m))
290 if (BN_num_bits(m) == 512) {
292 bn_extract_to_array_512(m, 8, _m);
293 memset( &hptr[idx].ctx.b512, 0, sizeof(struct mod_ctx_512));
294 mod_exp_pre_compute_data_512(_m, &hptr[idx].ctx.b512);
297 hptr[idx].type = BN_num_bits(m);
301 static int e_rsax_rsa_finish(RSA *rsa)
303 E_RSAX_MOD_CTX *hptr = RSA_get_ex_data(rsa, rsax_ex_data_idx);
307 RSA_set_ex_data(rsa, rsax_ex_data_idx, NULL);
312 static int e_rsax_bn_mod_exp(BIGNUM *r, const BIGNUM *g, const BIGNUM *e,
313 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont, E_RSAX_MOD_CTX* rsax_mod_ctx )
315 if (rsax_mod_ctx && BN_get_flags(e, BN_FLG_CONSTTIME) != 0) {
316 if (BN_num_bits(m) == 512) {
321 /* Init the arrays from the BIGNUMs */
322 bn_extract_to_array_512(g, 8, _g);
323 bn_extract_to_array_512(e, 8, _e);
325 mod_exp_512(_r, _g, _e, &rsax_mod_ctx->ctx.b512);
326 /* Return the result in the BIGNUM */
327 interleaved_array_to_bn_512(r, _r);
332 return BN_mod_exp_mont(r, g, e, m, ctx, in_mont);
335 /* Declares for the Intel CIAP 512-bit / CRT / 1024 bit RSA modular
336 * exponentiation routine precalculations and a structure to hold the
337 * necessary values. These files are meant to live in crypto/rsa/ in
338 * the target openssl.
342 * Local method: extracts a piece from a BIGNUM, to fit it into
343 * an array. Call with n=8 to extract an entire 512-bit BIGNUM
345 static int bn_extract_to_array_512(const BIGNUM* b, unsigned int n, UINT64 *array)
349 unsigned char bn_buff[64];
350 memset(bn_buff, 0, 64);
351 if (BN_num_bytes(b) > 64) {
352 printf ("Can't support this byte size\n");
354 if (BN_num_bytes(b)!=0) {
355 if (!BN_bn2bin(b, bn_buff+(64-BN_num_bytes(b)))) {
356 printf ("Error's in bn2bin\n");
357 /* We have to error, here */
361 for (i=7; i>=0; i--) {
362 tmp = bn_buff[63-(n*8+i)];
363 array[n] |= tmp << (8*i); } }
367 /* Init a 512-bit BIGNUM from the UINT64*_ (8 * 64) interleaved array */
368 static int interleaved_array_to_bn_512(BIGNUM* b, UINT64 *array)
370 unsigned char tmp[64];
374 for (i = 7; i>=0; i--) {
375 tmp[63-(n*8+i)] = (unsigned char)(array[n]>>(8*i)); } }
376 BN_bin2bn(tmp, 64, b);
381 /* The main 512bit precompute call */
382 static int mod_exp_pre_compute_data_512(UINT64 *m, struct mod_ctx_512 *data)
384 BIGNUM two_768, two_640, two_128, two_512, tmp, _m, tmp2;
386 /* We need a BN_CTX for the modulo functions */
394 interleaved_array_to_bn_512(&_m, m);
405 /* Create our context */
406 if ((ctx=BN_CTX_new()) == NULL) { goto err; }
410 * For production, if you care, these only need to be set once,
411 * and may be made constants.
413 BN_lshift(&two_768, BN_value_one(), 768);
414 BN_lshift(&two_640, BN_value_one(), 640);
415 BN_lshift(&two_128, BN_value_one(), 128);
416 BN_lshift(&two_512, BN_value_one(), 512);
418 if (0 == (m[7] & 0x8000000000000000)) {
421 if (0 == (m[0] & 0x1)) { /* Odd modulus required for Mont */
426 BN_mod(&tmp, &two_768, &_m, ctx);
427 if (!bn_extract_to_array_512(&tmp, 8, &data->m1[0])) {
431 BN_mod(&tmp, &two_640, &_m, ctx);
432 if (!bn_extract_to_array_512(&tmp, 8, &data->m2[0])) {
437 * Precompute k1, a 128b number = ((-1)* m-1 ) mod 2128; k1 should
440 BN_mod_inverse(&tmp, &_m, &two_128, ctx);
441 if (!BN_is_zero(&tmp)) { BN_sub(&tmp, &two_128, &tmp); }
442 if (!bn_extract_to_array_512(&tmp, 2, &data->k1[0])) {
446 for (i=0; i<8; i++) {
448 if (i & 1) { BN_add(&tmp, &two_512, &tmp); }
449 if (i & 2) { BN_add(&tmp, &two_512, &tmp); }
450 if (i & 4) { BN_add(&tmp, &two_640, &tmp); }
452 BN_nnmod(&tmp2, &tmp, &_m, ctx);
453 if (!bn_extract_to_array_512(&tmp2, 8, _t)) {
455 for (j=0; j<8; j++) data->t[j][i] = _t[j]; }
458 for (i=0; i<8; i++) {
479 static int e_rsax_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx)
481 BIGNUM *r1,*m1,*vrfy;
482 BIGNUM local_dmp1,local_dmq1,local_c,local_r1;
483 BIGNUM *dmp1,*dmq1,*c,*pr1;
487 r1 = BN_CTX_get(ctx);
488 m1 = BN_CTX_get(ctx);
489 vrfy = BN_CTX_get(ctx);
492 BIGNUM local_p, local_q;
493 BIGNUM *p = NULL, *q = NULL;
496 /* Make sure BN_mod_inverse in Montgomery
497 * intialization uses the BN_FLG_CONSTTIME flag
498 * (unless RSA_FLAG_NO_CONSTTIME is set)
500 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
504 BN_with_flags(p, rsa->p, BN_FLG_CONSTTIME);
508 BN_with_flags(q, rsa->q, BN_FLG_CONSTTIME);
516 if (rsa->flags & RSA_FLAG_CACHE_PRIVATE)
518 if (!BN_MONT_CTX_set_locked(&rsa->_method_mod_p, CRYPTO_LOCK_RSA, p, ctx))
520 if (!BN_MONT_CTX_set_locked(&rsa->_method_mod_q, CRYPTO_LOCK_RSA, q, ctx))
525 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
534 if (rsa->flags & RSA_FLAG_CACHE_PUBLIC)
535 if (!BN_MONT_CTX_set_locked(&rsa->_method_mod_n, CRYPTO_LOCK_RSA, rsa->n, ctx))
538 /* compute I mod q */
539 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
542 BN_with_flags(c, I, BN_FLG_CONSTTIME);
543 if (!BN_mod(r1,c,rsa->q,ctx)) goto err;
547 if (!BN_mod(r1,I,rsa->q,ctx)) goto err;
550 /* compute r1^dmq1 mod q */
551 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
554 BN_with_flags(dmq1, rsa->dmq1, BN_FLG_CONSTTIME);
559 if (!e_rsax_bn_mod_exp(m1,r1,dmq1,rsa->q,ctx,
560 rsa->_method_mod_q, e_rsax_get_ctx(rsa, 0, rsa->q) )) goto err;
562 /* compute I mod p */
563 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
566 BN_with_flags(c, I, BN_FLG_CONSTTIME);
567 if (!BN_mod(r1,c,rsa->p,ctx)) goto err;
571 if (!BN_mod(r1,I,rsa->p,ctx)) goto err;
574 /* compute r1^dmp1 mod p */
575 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
578 BN_with_flags(dmp1, rsa->dmp1, BN_FLG_CONSTTIME);
583 if (!e_rsax_bn_mod_exp(r0,r1,dmp1,rsa->p,ctx,
584 rsa->_method_mod_p, e_rsax_get_ctx(rsa, 1, rsa->p) )) goto err;
586 if (!BN_sub(r0,r0,m1)) goto err;
587 /* This will help stop the size of r0 increasing, which does
588 * affect the multiply if it optimised for a power of 2 size */
589 if (BN_is_negative(r0))
590 if (!BN_add(r0,r0,rsa->p)) goto err;
592 if (!BN_mul(r1,r0,rsa->iqmp,ctx)) goto err;
594 /* Turn BN_FLG_CONSTTIME flag on before division operation */
595 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
598 BN_with_flags(pr1, r1, BN_FLG_CONSTTIME);
602 if (!BN_mod(r0,pr1,rsa->p,ctx)) goto err;
604 /* If p < q it is occasionally possible for the correction of
605 * adding 'p' if r0 is negative above to leave the result still
606 * negative. This can break the private key operations: the following
607 * second correction should *always* correct this rare occurrence.
608 * This will *never* happen with OpenSSL generated keys because
609 * they ensure p > q [steve]
611 if (BN_is_negative(r0))
612 if (!BN_add(r0,r0,rsa->p)) goto err;
613 if (!BN_mul(r1,r0,rsa->q,ctx)) goto err;
614 if (!BN_add(r0,r1,m1)) goto err;
616 if (rsa->e && rsa->n)
618 if (!e_rsax_bn_mod_exp(vrfy,r0,rsa->e,rsa->n,ctx,rsa->_method_mod_n, e_rsax_get_ctx(rsa, 2, rsa->n) ))
621 /* If 'I' was greater than (or equal to) rsa->n, the operation
622 * will be equivalent to using 'I mod n'. However, the result of
623 * the verify will *always* be less than 'n' so we don't check
624 * for absolute equality, just congruency. */
625 if (!BN_sub(vrfy, vrfy, I)) goto err;
626 if (!BN_mod(vrfy, vrfy, rsa->n, ctx)) goto err;
627 if (BN_is_negative(vrfy))
628 if (!BN_add(vrfy, vrfy, rsa->n)) goto err;
629 if (!BN_is_zero(vrfy))
631 /* 'I' and 'vrfy' aren't congruent mod n. Don't leak
632 * miscalculated CRT output, just do a raw (slower)
633 * mod_exp and return that instead. */
638 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
641 BN_with_flags(d, rsa->d, BN_FLG_CONSTTIME);
645 if (!e_rsax_bn_mod_exp(r0,I,d,rsa->n,ctx,
646 rsa->_method_mod_n, e_rsax_get_ctx(rsa, 2, rsa->n) )) goto err;
656 #endif /* !OPENSSL_NO_RSA */
657 #endif /* !COMPILE_RSAX */