7f4b65032fe77a68724e059c979d980e2cedcc4f
[libgcrypt.git] / mpi / mpi-pow.c
1 /* mpi-pow.c  -  MPI functions
2  * Copyright (C) 1994, 1996, 1998, 2000, 2002, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  *
20  * Note: This code is heavily based on the GNU MP Library.
21  *       Actually it's the same code with only minor changes in the
22  *       way the data is stored; this is to support the abstraction
23  *       of an optional secure memory allocation which may be used
24  *       to avoid revealing of sensitive data due to paging etc.
25  */
26
27 #include <config.h>
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include "mpi-internal.h"
32 #include "longlong.h"
33 #include <assert.h>
34
35
36 /****************
37  * RES = BASE ^ EXP mod MOD
38  */
39 void
40 gcry_mpi_powm( gcry_mpi_t res, gcry_mpi_t base, gcry_mpi_t exp, gcry_mpi_t mod)
41 {
42     mpi_ptr_t  rp, ep, mp, bp;
43     mpi_size_t esize, msize, bsize, rsize;
44     int        esign, msign, bsign, rsign;
45     int        esec,  msec,  bsec,  rsec;
46     mpi_size_t size;
47     int mod_shift_cnt;
48     int negative_result;
49     mpi_ptr_t mp_marker=NULL, bp_marker=NULL, ep_marker=NULL;
50     mpi_ptr_t xp_marker=NULL;
51     int assign_rp=0;
52     mpi_ptr_t tspace = NULL;
53     mpi_size_t tsize=0;   /* to avoid compiler warning */
54                           /* fixme: we should check that the warning is void*/
55
56     esize = exp->nlimbs;
57     msize = mod->nlimbs;
58     size = 2 * msize;
59     esign = exp->sign;
60     msign = mod->sign;
61
62     esec = mpi_is_secure(exp);
63     msec = mpi_is_secure(mod);
64     bsec = mpi_is_secure(base);
65     rsec = mpi_is_secure(res);
66
67     rp = res->d;
68     ep = exp->d;
69
70     if( !msize )
71         msize = 1 / msize;          /* provoke a signal */
72
73     if( !esize ) {
74         /* Exponent is zero, result is 1 mod MOD, i.e., 1 or 0
75          * depending on if MOD equals 1.  */
76         rp[0] = 1;
77         res->nlimbs = (msize == 1 && mod->d[0] == 1) ? 0 : 1;
78         res->sign = 0;
79         goto leave;
80     }
81
82     /* Normalize MOD (i.e. make its most significant bit set) as required by
83      * mpn_divrem.  This will make the intermediate values in the calculation
84      * slightly larger, but the correct result is obtained after a final
85      * reduction using the original MOD value.  */
86     mp = mp_marker = mpi_alloc_limb_space(msize, msec);
87     count_leading_zeros( mod_shift_cnt, mod->d[msize-1] );
88     if( mod_shift_cnt )
89         _gcry_mpih_lshift( mp, mod->d, msize, mod_shift_cnt );
90     else
91         MPN_COPY( mp, mod->d, msize );
92
93     bsize = base->nlimbs;
94     bsign = base->sign;
95     if( bsize > msize ) { /* The base is larger than the module. Reduce it. */
96         /* Allocate (BSIZE + 1) with space for remainder and quotient.
97          * (The quotient is (bsize - msize + 1) limbs.)  */
98         bp = bp_marker = mpi_alloc_limb_space( bsize + 1, bsec );
99         MPN_COPY( bp, base->d, bsize );
100         /* We don't care about the quotient, store it above the remainder,
101          * at BP + MSIZE.  */
102         _gcry_mpih_divrem( bp + msize, 0, bp, bsize, mp, msize );
103         bsize = msize;
104         /* Canonicalize the base, since we are going to multiply with it
105          * quite a few times.  */
106         MPN_NORMALIZE( bp, bsize );
107     }
108     else
109         bp = base->d;
110
111     if( !bsize ) {
112         res->nlimbs = 0;
113         res->sign = 0;
114         goto leave;
115     }
116
117     if( res->alloced < size ) {
118         /* We have to allocate more space for RES.  If any of the input
119          * parameters are identical to RES, defer deallocation of the old
120          * space.  */
121         if( rp == ep || rp == mp || rp == bp ) {
122             rp = mpi_alloc_limb_space( size, rsec );
123             assign_rp = 1;
124         }
125         else {
126             mpi_resize( res, size );
127             rp = res->d;
128         }
129     }
130     else { /* Make BASE, EXP and MOD not overlap with RES.  */
131         if( rp == bp ) {
132             /* RES and BASE are identical.  Allocate temp. space for BASE.  */
133             assert( !bp_marker );
134             bp = bp_marker = mpi_alloc_limb_space( bsize, bsec );
135             MPN_COPY(bp, rp, bsize);
136         }
137         if( rp == ep ) {
138             /* RES and EXP are identical.  Allocate temp. space for EXP.  */
139             ep = ep_marker = mpi_alloc_limb_space( esize, esec );
140             MPN_COPY(ep, rp, esize);
141         }
142         if( rp == mp ) {
143             /* RES and MOD are identical.  Allocate temporary space for MOD.*/
144             assert( !mp_marker );
145             mp = mp_marker = mpi_alloc_limb_space( msize, msec );
146             MPN_COPY(mp, rp, msize);
147         }
148     }
149
150     MPN_COPY( rp, bp, bsize );
151     rsize = bsize;
152     rsign = bsign;
153
154     {
155         mpi_size_t i;
156         mpi_ptr_t xp = xp_marker = mpi_alloc_limb_space( 2 * (msize + 1), msec );
157         int c;
158         mpi_limb_t e;
159         mpi_limb_t carry_limb;
160         struct karatsuba_ctx karactx;
161
162         memset( &karactx, 0, sizeof karactx );
163         negative_result = (ep[0] & 1) && base->sign;
164
165         i = esize - 1;
166         e = ep[i];
167         count_leading_zeros (c, e);
168         e = (e << c) << 1;     /* shift the exp bits to the left, lose msb */
169         c = BITS_PER_MPI_LIMB - 1 - c;
170
171         /* Main loop.
172          *
173          * Make the result be pointed to alternately by XP and RP.  This
174          * helps us avoid block copying, which would otherwise be necessary
175          * with the overlap restrictions of _gcry_mpih_divmod. With 50% probability
176          * the result after this loop will be in the area originally pointed
177          * by RP (==RES->d), and with 50% probability in the area originally
178          * pointed to by XP.
179          */
180
181         for(;;) {
182             while( c ) {
183                 mpi_ptr_t tp;
184                 mpi_size_t xsize;
185
186                 /*mpih_mul_n(xp, rp, rp, rsize);*/
187                 if( rsize < KARATSUBA_THRESHOLD )
188                     _gcry_mpih_sqr_n_basecase( xp, rp, rsize );
189                 else {
190                     if( !tspace ) {
191                         tsize = 2 * rsize;
192                         tspace = mpi_alloc_limb_space( tsize, 0 );
193                     }
194                     else if( tsize < (2*rsize) ) {
195                         mpi_free_limb_space( tspace );
196                         tsize = 2 * rsize;
197                         tspace = mpi_alloc_limb_space( tsize, 0 );
198                     }
199                     _gcry_mpih_sqr_n( xp, rp, rsize, tspace );
200                 }
201
202                 xsize = 2 * rsize;
203                 if( xsize > msize ) {
204                     _gcry_mpih_divrem(xp + msize, 0, xp, xsize, mp, msize);
205                     xsize = msize;
206                 }
207
208                 tp = rp; rp = xp; xp = tp;
209                 rsize = xsize;
210
211                 if( (mpi_limb_signed_t)e < 0 ) {
212                     /*mpih_mul( xp, rp, rsize, bp, bsize );*/
213                     if( bsize < KARATSUBA_THRESHOLD ) {
214                         _gcry_mpih_mul( xp, rp, rsize, bp, bsize );
215                     }
216                     else {
217                         _gcry_mpih_mul_karatsuba_case(
218                                      xp, rp, rsize, bp, bsize, &karactx );
219                     }
220
221                     xsize = rsize + bsize;
222                     if( xsize > msize ) {
223                         _gcry_mpih_divrem(xp + msize, 0, xp, xsize, mp, msize);
224                         xsize = msize;
225                     }
226
227                     tp = rp; rp = xp; xp = tp;
228                     rsize = xsize;
229                 }
230                 e <<= 1;
231                 c--;
232             }
233
234             i--;
235             if( i < 0 )
236                 break;
237             e = ep[i];
238             c = BITS_PER_MPI_LIMB;
239         }
240
241         /* We shifted MOD, the modulo reduction argument, left MOD_SHIFT_CNT
242          * steps.  Adjust the result by reducing it with the original MOD.
243          *
244          * Also make sure the result is put in RES->d (where it already
245          * might be, see above).
246          */
247         if( mod_shift_cnt ) {
248             carry_limb = _gcry_mpih_lshift( res->d, rp, rsize, mod_shift_cnt);
249             rp = res->d;
250             if( carry_limb ) {
251                 rp[rsize] = carry_limb;
252                 rsize++;
253             }
254         }
255         else {
256             MPN_COPY( res->d, rp, rsize);
257             rp = res->d;
258         }
259
260         if( rsize >= msize ) {
261             _gcry_mpih_divrem(rp + msize, 0, rp, rsize, mp, msize);
262             rsize = msize;
263         }
264
265         /* Remove any leading zero words from the result.  */
266         if( mod_shift_cnt )
267             _gcry_mpih_rshift( rp, rp, rsize, mod_shift_cnt);
268         MPN_NORMALIZE (rp, rsize);
269
270         _gcry_mpih_release_karatsuba_ctx( &karactx );
271     }
272
273     if( negative_result && rsize ) {
274         if( mod_shift_cnt )
275             _gcry_mpih_rshift( mp, mp, msize, mod_shift_cnt);
276         _gcry_mpih_sub( rp, mp, msize, rp, rsize);
277         rsize = msize;
278         rsign = msign;
279         MPN_NORMALIZE(rp, rsize);
280     }
281     res->nlimbs = rsize;
282     res->sign = rsign;
283
284   leave:
285     if( assign_rp ) _gcry_mpi_assign_limb_space( res, rp, size );
286     if( mp_marker ) _gcry_mpi_free_limb_space( mp_marker );
287     if( bp_marker ) _gcry_mpi_free_limb_space( bp_marker );
288     if( ep_marker ) _gcry_mpi_free_limb_space( ep_marker );
289     if( xp_marker ) _gcry_mpi_free_limb_space( xp_marker );
290     if( tspace )    _gcry_mpi_free_limb_space( tspace );
291 }
292