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>
76 #include <openssl/err.h>
78 /* RSAX is available **ONLY* on x86_64 CPUs */
81 #if (defined(__x86_64) || defined(__x86_64__) || \
82 defined(_M_AMD64) || defined (_M_X64)) && !defined(OPENSSL_NO_ASM)
84 static ENGINE *ENGINE_rsax (void);
87 void ENGINE_load_rsax (void)
89 /* On non-x86 CPUs it just returns. */
91 ENGINE *toadd = ENGINE_rsax();
100 #define E_RSAX_LIB_NAME "rsax engine"
102 static int e_rsax_destroy(ENGINE *e);
103 static int e_rsax_init(ENGINE *e);
104 static int e_rsax_finish(ENGINE *e);
105 static int e_rsax_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
107 #ifndef OPENSSL_NO_RSA
109 static int e_rsax_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
110 static int e_rsax_rsa_finish(RSA *r);
113 static const ENGINE_CMD_DEFN e_rsax_cmd_defns[] = {
117 #ifndef OPENSSL_NO_RSA
118 /* Our internal RSA_METHOD that we provide pointers to */
119 static RSA_METHOD e_rsax_rsa =
121 "Intel RSA-X method",
130 RSA_FLAG_CACHE_PUBLIC|RSA_FLAG_CACHE_PRIVATE,
137 /* Constants used when creating the ENGINE */
138 static const char *engine_e_rsax_id = "rsax";
139 static const char *engine_e_rsax_name = "RSAX engine support";
141 /* This internal function is used by ENGINE_rsax() */
142 static int bind_helper(ENGINE *e)
144 #ifndef OPENSSL_NO_RSA
145 const RSA_METHOD *meth1;
147 if(!ENGINE_set_id(e, engine_e_rsax_id) ||
148 !ENGINE_set_name(e, engine_e_rsax_name) ||
149 #ifndef OPENSSL_NO_RSA
150 !ENGINE_set_RSA(e, &e_rsax_rsa) ||
152 !ENGINE_set_destroy_function(e, e_rsax_destroy) ||
153 !ENGINE_set_init_function(e, e_rsax_init) ||
154 !ENGINE_set_finish_function(e, e_rsax_finish) ||
155 !ENGINE_set_ctrl_function(e, e_rsax_ctrl) ||
156 !ENGINE_set_cmd_defns(e, e_rsax_cmd_defns))
159 #ifndef OPENSSL_NO_RSA
160 meth1 = RSA_PKCS1_SSLeay();
161 e_rsax_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
162 e_rsax_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
163 e_rsax_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
164 e_rsax_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
165 e_rsax_rsa.bn_mod_exp = meth1->bn_mod_exp;
166 e_rsax_rsa.finish = meth1->finish;
171 static ENGINE *ENGINE_rsax(void)
173 ENGINE *ret = ENGINE_new();
176 if(!bind_helper(ret))
184 #ifndef OPENSSL_NO_RSA
185 /* Used to attach our own key-data to an RSA structure */
186 static int rsax_ex_data_idx = -1;
189 static int e_rsax_destroy(ENGINE *e)
194 /* (de)initialisation functions. */
195 static int e_rsax_init(ENGINE *e)
197 #ifndef OPENSSL_NO_RSA
198 if (rsax_ex_data_idx == -1)
199 rsax_ex_data_idx = RSA_get_ex_new_index(0,
203 if (rsax_ex_data_idx == -1)
208 static int e_rsax_finish(ENGINE *e)
213 static int e_rsax_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
219 /* The command isn't understood by this engine */
229 #ifndef OPENSSL_NO_RSA
232 typedef unsigned __int64 UINT64;
234 typedef unsigned long long UINT64;
236 typedef unsigned short UINT16;
238 /* Table t is interleaved in the following manner:
239 * The order in memory is t[0][0], t[0][1], ..., t[0][7], t[1][0], ...
240 * A particular 512-bit value is stored in t[][index] rather than the more
241 * normal t[index][]; i.e. the qwords of a particular entry in t are not
245 /* Init BIGNUM b from the interleaved UINT64 array */
246 static int interleaved_array_to_bn_512(BIGNUM* b, UINT64 *array);
248 /* Extract array elements from BIGNUM b
249 * To set the whole array from b, call with n=8
251 static int bn_extract_to_array_512(const BIGNUM* b, unsigned int n, UINT64 *array);
256 UINT64 m1[8]; /* 2^278 % m */
257 UINT64 m2[8]; /* 2^640 % m */
258 UINT64 k1[2]; /* (- 1/m) % 2^128 */
261 static int mod_exp_pre_compute_data_512(UINT64 *m, struct mod_ctx_512 *data);
263 void mod_exp_512(UINT64 *result, /* 512 bits, 8 qwords */
264 UINT64 *g, /* 512 bits, 8 qwords */
265 UINT64 *exp, /* 512 bits, 8 qwords */
266 struct mod_ctx_512 *data);
268 typedef struct st_e_rsax_mod_ctx
272 struct mod_ctx_512 b512;
277 static E_RSAX_MOD_CTX *e_rsax_get_ctx(RSA *rsa, int idx, BIGNUM* m)
279 E_RSAX_MOD_CTX *hptr;
281 if (idx < 0 || idx > 2)
284 hptr = RSA_get_ex_data(rsa, rsax_ex_data_idx);
286 hptr = OPENSSL_malloc(3*sizeof(E_RSAX_MOD_CTX));
287 if (!hptr) return NULL;
288 hptr[2].type = hptr[1].type= hptr[0].type = 0;
289 RSA_set_ex_data(rsa, rsax_ex_data_idx, hptr);
292 if (hptr[idx].type == (UINT64)BN_num_bits(m))
295 if (BN_num_bits(m) == 512) {
297 bn_extract_to_array_512(m, 8, _m);
298 memset( &hptr[idx].ctx.b512, 0, sizeof(struct mod_ctx_512));
299 mod_exp_pre_compute_data_512(_m, &hptr[idx].ctx.b512);
302 hptr[idx].type = BN_num_bits(m);
306 static int e_rsax_rsa_finish(RSA *rsa)
308 E_RSAX_MOD_CTX *hptr = RSA_get_ex_data(rsa, rsax_ex_data_idx);
312 RSA_set_ex_data(rsa, rsax_ex_data_idx, NULL);
317 static int e_rsax_bn_mod_exp(BIGNUM *r, const BIGNUM *g, const BIGNUM *e,
318 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont, E_RSAX_MOD_CTX* rsax_mod_ctx )
320 if (rsax_mod_ctx && BN_get_flags(e, BN_FLG_CONSTTIME) != 0) {
321 if (BN_num_bits(m) == 512) {
326 /* Init the arrays from the BIGNUMs */
327 bn_extract_to_array_512(g, 8, _g);
328 bn_extract_to_array_512(e, 8, _e);
330 mod_exp_512(_r, _g, _e, &rsax_mod_ctx->ctx.b512);
331 /* Return the result in the BIGNUM */
332 interleaved_array_to_bn_512(r, _r);
337 return BN_mod_exp_mont(r, g, e, m, ctx, in_mont);
340 /* Declares for the Intel CIAP 512-bit / CRT / 1024 bit RSA modular
341 * exponentiation routine precalculations and a structure to hold the
342 * necessary values. These files are meant to live in crypto/rsa/ in
343 * the target openssl.
347 * Local method: extracts a piece from a BIGNUM, to fit it into
348 * an array. Call with n=8 to extract an entire 512-bit BIGNUM
350 static int bn_extract_to_array_512(const BIGNUM* b, unsigned int n, UINT64 *array)
354 unsigned char bn_buff[64];
355 memset(bn_buff, 0, 64);
356 if (BN_num_bytes(b) > 64) {
357 printf ("Can't support this byte size\n");
359 if (BN_num_bytes(b)!=0) {
360 if (!BN_bn2bin(b, bn_buff+(64-BN_num_bytes(b)))) {
361 printf ("Error's in bn2bin\n");
362 /* We have to error, here */
366 for (i=7; i>=0; i--) {
367 tmp = bn_buff[63-(n*8+i)];
368 array[n] |= tmp << (8*i); } }
372 /* Init a 512-bit BIGNUM from the UINT64*_ (8 * 64) interleaved array */
373 static int interleaved_array_to_bn_512(BIGNUM* b, UINT64 *array)
375 unsigned char tmp[64];
379 for (i = 7; i>=0; i--) {
380 tmp[63-(n*8+i)] = (unsigned char)(array[n]>>(8*i)); } }
381 BN_bin2bn(tmp, 64, b);
386 /* The main 512bit precompute call */
387 static int mod_exp_pre_compute_data_512(UINT64 *m, struct mod_ctx_512 *data)
389 BIGNUM two_768, two_640, two_128, two_512, tmp, _m, tmp2;
391 /* We need a BN_CTX for the modulo functions */
399 interleaved_array_to_bn_512(&_m, m);
410 /* Create our context */
411 if ((ctx=BN_CTX_new()) == NULL) { goto err; }
415 * For production, if you care, these only need to be set once,
416 * and may be made constants.
418 BN_lshift(&two_768, BN_value_one(), 768);
419 BN_lshift(&two_640, BN_value_one(), 640);
420 BN_lshift(&two_128, BN_value_one(), 128);
421 BN_lshift(&two_512, BN_value_one(), 512);
423 if (0 == (m[7] & 0x8000000000000000)) {
426 if (0 == (m[0] & 0x1)) { /* Odd modulus required for Mont */
431 BN_mod(&tmp, &two_768, &_m, ctx);
432 if (!bn_extract_to_array_512(&tmp, 8, &data->m1[0])) {
436 BN_mod(&tmp, &two_640, &_m, ctx);
437 if (!bn_extract_to_array_512(&tmp, 8, &data->m2[0])) {
442 * Precompute k1, a 128b number = ((-1)* m-1 ) mod 2128; k1 should
445 BN_mod_inverse(&tmp, &_m, &two_128, ctx);
446 if (!BN_is_zero(&tmp)) { BN_sub(&tmp, &two_128, &tmp); }
447 if (!bn_extract_to_array_512(&tmp, 2, &data->k1[0])) {
451 for (i=0; i<8; i++) {
453 if (i & 1) { BN_add(&tmp, &two_512, &tmp); }
454 if (i & 2) { BN_add(&tmp, &two_512, &tmp); }
455 if (i & 4) { BN_add(&tmp, &two_640, &tmp); }
457 BN_nnmod(&tmp2, &tmp, &_m, ctx);
458 if (!bn_extract_to_array_512(&tmp2, 8, _t)) {
460 for (j=0; j<8; j++) data->t[j][i] = _t[j]; }
463 for (i=0; i<8; i++) {
484 static int e_rsax_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx)
486 BIGNUM *r1,*m1,*vrfy;
487 BIGNUM local_dmp1,local_dmq1,local_c,local_r1;
488 BIGNUM *dmp1,*dmq1,*c,*pr1;
492 r1 = BN_CTX_get(ctx);
493 m1 = BN_CTX_get(ctx);
494 vrfy = BN_CTX_get(ctx);
497 BIGNUM local_p, local_q;
498 BIGNUM *p = NULL, *q = NULL;
501 /* Make sure BN_mod_inverse in Montgomery
502 * intialization uses the BN_FLG_CONSTTIME flag
503 * (unless RSA_FLAG_NO_CONSTTIME is set)
505 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
509 BN_with_flags(p, rsa->p, BN_FLG_CONSTTIME);
513 BN_with_flags(q, rsa->q, BN_FLG_CONSTTIME);
521 if (rsa->flags & RSA_FLAG_CACHE_PRIVATE)
523 if (!BN_MONT_CTX_set_locked(&rsa->_method_mod_p, CRYPTO_LOCK_RSA, p, ctx))
525 if (!BN_MONT_CTX_set_locked(&rsa->_method_mod_q, CRYPTO_LOCK_RSA, q, ctx))
530 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
539 if (rsa->flags & RSA_FLAG_CACHE_PUBLIC)
540 if (!BN_MONT_CTX_set_locked(&rsa->_method_mod_n, CRYPTO_LOCK_RSA, rsa->n, ctx))
543 /* compute I mod q */
544 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
547 BN_with_flags(c, I, BN_FLG_CONSTTIME);
548 if (!BN_mod(r1,c,rsa->q,ctx)) goto err;
552 if (!BN_mod(r1,I,rsa->q,ctx)) goto err;
555 /* compute r1^dmq1 mod q */
556 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
559 BN_with_flags(dmq1, rsa->dmq1, BN_FLG_CONSTTIME);
564 if (!e_rsax_bn_mod_exp(m1,r1,dmq1,rsa->q,ctx,
565 rsa->_method_mod_q, e_rsax_get_ctx(rsa, 0, rsa->q) )) goto err;
567 /* compute I mod p */
568 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
571 BN_with_flags(c, I, BN_FLG_CONSTTIME);
572 if (!BN_mod(r1,c,rsa->p,ctx)) goto err;
576 if (!BN_mod(r1,I,rsa->p,ctx)) goto err;
579 /* compute r1^dmp1 mod p */
580 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
583 BN_with_flags(dmp1, rsa->dmp1, BN_FLG_CONSTTIME);
588 if (!e_rsax_bn_mod_exp(r0,r1,dmp1,rsa->p,ctx,
589 rsa->_method_mod_p, e_rsax_get_ctx(rsa, 1, rsa->p) )) goto err;
591 if (!BN_sub(r0,r0,m1)) goto err;
592 /* This will help stop the size of r0 increasing, which does
593 * affect the multiply if it optimised for a power of 2 size */
594 if (BN_is_negative(r0))
595 if (!BN_add(r0,r0,rsa->p)) goto err;
597 if (!BN_mul(r1,r0,rsa->iqmp,ctx)) goto err;
599 /* Turn BN_FLG_CONSTTIME flag on before division operation */
600 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
603 BN_with_flags(pr1, r1, BN_FLG_CONSTTIME);
607 if (!BN_mod(r0,pr1,rsa->p,ctx)) goto err;
609 /* If p < q it is occasionally possible for the correction of
610 * adding 'p' if r0 is negative above to leave the result still
611 * negative. This can break the private key operations: the following
612 * second correction should *always* correct this rare occurrence.
613 * This will *never* happen with OpenSSL generated keys because
614 * they ensure p > q [steve]
616 if (BN_is_negative(r0))
617 if (!BN_add(r0,r0,rsa->p)) goto err;
618 if (!BN_mul(r1,r0,rsa->q,ctx)) goto err;
619 if (!BN_add(r0,r1,m1)) goto err;
621 if (rsa->e && rsa->n)
623 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) ))
626 /* If 'I' was greater than (or equal to) rsa->n, the operation
627 * will be equivalent to using 'I mod n'. However, the result of
628 * the verify will *always* be less than 'n' so we don't check
629 * for absolute equality, just congruency. */
630 if (!BN_sub(vrfy, vrfy, I)) goto err;
631 if (!BN_mod(vrfy, vrfy, rsa->n, ctx)) goto err;
632 if (BN_is_negative(vrfy))
633 if (!BN_add(vrfy, vrfy, rsa->n)) goto err;
634 if (!BN_is_zero(vrfy))
636 /* 'I' and 'vrfy' aren't congruent mod n. Don't leak
637 * miscalculated CRT output, just do a raw (slower)
638 * mod_exp and return that instead. */
643 if (!(rsa->flags & RSA_FLAG_NO_CONSTTIME))
646 BN_with_flags(d, rsa->d, BN_FLG_CONSTTIME);
650 if (!e_rsax_bn_mod_exp(r0,I,d,rsa->n,ctx,
651 rsa->_method_mod_n, e_rsax_get_ctx(rsa, 2, rsa->n) )) goto err;
661 #endif /* !OPENSSL_NO_RSA */
662 #endif /* !COMPILE_RSAX */