1 /* crypto/bn/bn_mont.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
58 /* ====================================================================
59 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
113 * Details about Montgomery multiplication algorithms can be found at
114 * http://security.ece.orst.edu/publications.html, e.g.
115 * http://security.ece.orst.edu/koc/papers/j37acmon.pdf and
116 * sections 3.8 and 4.2 in http://security.ece.orst.edu/koc/papers/r01rsasw.pdf
119 #define OPENSSL_FIPSAPI
122 #include "cryptlib.h"
126 #include <openssl/fips.h>
129 #define MONT_WORD /* use the faster word-based algorithm */
132 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont);
135 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
136 BN_MONT_CTX *mont, BN_CTX *ctx)
140 #if defined(OPENSSL_BN_ASM_MONT) && defined(MONT_WORD)
141 int num = mont->N.top;
143 if (num>1 && a->top==num && b->top==num)
145 if (bn_wexpand(r,num) == NULL) return(0);
146 if (bn_mul_mont(r->d,a->d,b->d,mont->N.d,mont->n0,num))
148 r->neg = a->neg^b->neg;
157 tmp = BN_CTX_get(ctx);
158 if (tmp == NULL) goto err;
163 if (!BN_sqr(tmp,a,ctx)) goto err;
167 if (!BN_mul(tmp,a,b,ctx)) goto err;
169 /* reduce from aRR to aR */
171 if (!BN_from_montgomery_word(r,tmp,mont)) goto err;
173 if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
183 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont)
186 BN_ULONG *ap,*np,*rp,n0,v,*nrp;
187 int al,nl,max,i,x,ri;
190 /* mont->ri is the size of mont->N in bits (rounded up
192 al=ri=mont->ri/BN_BITS2;
195 if ((al == 0) || (nl == 0)) { ret->top=0; return(1); }
197 max=(nl+al+1); /* allow for overflow (no?) XXX */
198 if (bn_wexpand(r,max) == NULL) return(0);
205 /* clear the top words of T */
207 for (i=r->top; i<max; i++) /* memset? XXX */
210 memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG));
217 fprintf(stderr,"word BN_from_montgomery_word %d * %d\n",nl,nl);
226 t1 = rp[0] * (n0 & 0177777);
229 t3 = rp[0] & 0177777;
230 t2 = (t3 * t2) & BN_MASK2;
232 v=bn_mul_add_words(rp,np,nl,(BN_ULONG) t1);
235 v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
239 if (((nrp[-1]+=v)&BN_MASK2) >= v)
243 if (((++nrp[0])&BN_MASK2) != 0) continue;
244 if (((++nrp[1])&BN_MASK2) != 0) continue;
245 for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
250 /* mont->ri will be a multiple of the word size and below code
251 * is kind of BN_rshift(ret,r,mont->ri) equivalent */
259 #define BRANCH_FREE 1
261 if (bn_wexpand(ret,ri) == NULL) return(0);
262 x=0-(((al-ri)>>(sizeof(al)*8-1))&1);
263 ret->top=x=(ri&~x)|(al&x); /* min(ri,al) */
272 v=bn_sub_words(rp,ap,np,ri);
273 /* this ----------------^^ works even in al<ri case
274 * thanks to zealous zeroing of top of the vector in the
277 /* if (al==ri && !v) || al>ri) nrp=rp; else nrp=ap; */
278 /* in other words if subtraction result is real, then
279 * trick unconditional memcpy below to perform in-place
280 * "refresh" instead of actual copy. */
281 m1=0-(size_t)(((al-ri)>>(sizeof(al)*8-1))&1); /* al<ri */
282 m2=0-(size_t)(((ri-al)>>(sizeof(al)*8-1))&1); /* al>ri */
283 m1|=m2; /* (al!=ri) */
284 m1|=(0-(size_t)v); /* (al!=ri || v) */
285 m1&=~m2; /* (al!=ri || v) && !al>ri */
286 nrp=(BN_ULONG *)(((size_t)rp&~m1)|((size_t)ap&m1));
289 /* 'i<ri' is chosen to eliminate dependency on input data, even
290 * though it results in redundant copy in al<ri case. */
291 for (i=0,ri-=4; i<ri; i+=4)
293 BN_ULONG t1,t2,t3,t4;
297 t3=nrp[i+2]; ap[i+0]=0;
298 t4=nrp[i+3]; ap[i+1]=0;
299 rp[i+0]=t1; ap[i+2]=0;
300 rp[i+1]=t2; ap[i+3]=0;
304 for (ri+=4; i<ri; i++)
305 rp[i]=nrp[i], ap[i]=0;
309 if (bn_wexpand(ret,al) == NULL) return(0);
316 for (i=0; i<al; i+=4)
318 BN_ULONG t1,t2,t3,t4;
333 if (BN_ucmp(ret, &(mont->N)) >= 0)
335 if (!BN_usub(ret,ret,&(mont->N))) return(0);
342 #endif /* MONT_WORD */
344 int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a, BN_MONT_CTX *mont,
352 if ((t = BN_CTX_get(ctx)) && BN_copy(t,a))
353 retn = BN_from_montgomery_word(ret,t,mont);
355 #else /* !MONT_WORD */
359 t1 = BN_CTX_get(ctx);
360 t2 = BN_CTX_get(ctx);
361 if (t1 == NULL || t2 == NULL) goto err;
363 if (!BN_copy(t1,a)) goto err;
364 BN_mask_bits(t1,mont->ri);
366 if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
367 BN_mask_bits(t2,mont->ri);
369 if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
370 if (!BN_add(t2,a,t1)) goto err;
371 if (!BN_rshift(ret,t2,mont->ri)) goto err;
373 if (BN_ucmp(ret, &(mont->N)) >= 0)
375 if (!BN_usub(ret,ret,&(mont->N))) goto err;
381 #endif /* MONT_WORD */
385 BN_MONT_CTX *BN_MONT_CTX_new(void)
389 if ((ret=(BN_MONT_CTX *)OPENSSL_malloc(sizeof(BN_MONT_CTX))) == NULL)
392 BN_MONT_CTX_init(ret);
393 ret->flags=BN_FLG_MALLOCED;
397 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
403 ctx->n0[0] = ctx->n0[1] = 0;
407 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
412 BN_free(&(mont->RR));
414 BN_free(&(mont->Ni));
415 if (mont->flags & BN_FLG_MALLOCED)
419 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
425 if((Ri = BN_CTX_get(ctx)) == NULL) goto err;
426 R= &(mont->RR); /* grab RR as a temp */
427 if (!BN_copy(&(mont->N),mod)) goto err; /* Set N */
440 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
442 #if defined(OPENSSL_BN_ASM_MONT) && (BN_BITS2<=32)
443 /* Only certain BN_BITS2<=32 platforms actually make use of
444 * n0[1], and we could use the #else case (with a shorter R
445 * value) for the others. However, currently only the assembler
446 * files do know which is which. */
449 if (!(BN_set_bit(R,2*BN_BITS2))) goto err;
452 if ((buf[0] = mod->d[0])) tmod.top=1;
453 if ((buf[1] = mod->top>1 ? mod->d[1] : 0)) tmod.top=2;
455 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
457 if (!BN_lshift(Ri,Ri,2*BN_BITS2)) goto err; /* R*Ri */
460 if (!BN_sub_word(Ri,1)) goto err;
462 else /* if N mod word size == 1 */
464 if (bn_expand(Ri,(int)sizeof(BN_ULONG)*2) == NULL)
466 /* Ri-- (mod double word size) */
472 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
474 * keep only couple of least significant words: */
475 mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
476 mont->n0[1] = (Ri->top > 1) ? Ri->d[1] : 0;
479 if (!(BN_set_bit(R,BN_BITS2))) goto err; /* R */
481 buf[0]=mod->d[0]; /* tmod = N mod word size */
483 tmod.top = buf[0] != 0 ? 1 : 0;
485 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
487 if (!BN_lshift(Ri,Ri,BN_BITS2)) goto err; /* R*Ri */
490 if (!BN_sub_word(Ri,1)) goto err;
492 else /* if N mod word size == 1 */
494 if (!BN_set_word(Ri,BN_MASK2)) goto err; /* Ri-- (mod word size) */
496 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
498 * keep only least significant word: */
499 mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
503 #else /* !MONT_WORD */
504 { /* bignum version */
505 mont->ri=BN_num_bits(&mont->N);
507 if (!BN_set_bit(R,mont->ri)) goto err; /* R = 2^ri */
509 if ((BN_mod_inverse(Ri,R,&mont->N,ctx)) == NULL)
511 if (!BN_lshift(Ri,Ri,mont->ri)) goto err; /* R*Ri */
512 if (!BN_sub_word(Ri,1)) goto err;
513 /* Ni = (R*Ri-1) / N */
514 if (!BN_div(&(mont->Ni),NULL,Ri,&mont->N,ctx)) goto err;
518 /* setup RR for conversions */
519 BN_zero(&(mont->RR));
520 if (!BN_set_bit(&(mont->RR),mont->ri*2)) goto err;
521 if (!BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx)) goto err;
529 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
531 if (to == from) return(to);
533 if (!BN_copy(&(to->RR),&(from->RR))) return NULL;
534 if (!BN_copy(&(to->N),&(from->N))) return NULL;
535 if (!BN_copy(&(to->Ni),&(from->Ni))) return NULL;
537 to->n0[0]=from->n0[0];
538 to->n0[1]=from->n0[1];
542 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
543 const BIGNUM *mod, BN_CTX *ctx)
545 int got_write_lock = 0;
551 CRYPTO_r_unlock(lock);
557 ret = BN_MONT_CTX_new();
558 if (ret && !BN_MONT_CTX_set(ret, mod, ctx))
559 BN_MONT_CTX_free(ret);
568 CRYPTO_w_unlock(lock);
570 CRYPTO_r_unlock(lock);