Sign-related fixes (and tests).
[openssl.git] / crypto / bn / bn_sqrt.c
1 /* crypto/bn/bn_mod.c */
2 /* Written by Lenka Fibikova <fibikova@exp-math.uni-essen.de>
3  * and Bodo Moeller for the OpenSSL project. */
4 /* ====================================================================
5  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer. 
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  *
19  * 3. All advertising materials mentioning features or use of this
20  *    software must display the following acknowledgment:
21  *    "This product includes software developed by the OpenSSL Project
22  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23  *
24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25  *    endorse or promote products derived from this software without
26  *    prior written permission. For written permission, please contact
27  *    openssl-core@openssl.org.
28  *
29  * 5. Products derived from this software may not be called "OpenSSL"
30  *    nor may "OpenSSL" appear in their names without prior written
31  *    permission of the OpenSSL Project.
32  *
33  * 6. Redistributions of any form whatsoever must retain the following
34  *    acknowledgment:
35  *    "This product includes software developed by the OpenSSL Project
36  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37  *
38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49  * OF THE POSSIBILITY OF SUCH DAMAGE.
50  * ====================================================================
51  *
52  * This product includes cryptographic software written by Eric Young
53  * (eay@cryptsoft.com).  This product includes software written by Tim
54  * Hudson (tjh@cryptsoft.com).
55  *
56  */
57
58 #include "cryptlib.h"
59 #include "bn_lcl.h"
60
61
62 BIGNUM *BN_mod_sqrt(BIGNUM *in, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx) 
63 /* Returns 'ret' such that
64  *      ret^2 == a (mod p),
65  * using the Tonelli/Shanks algorithm (cf. Henri Cohen, "A Course
66  * in Algebraic Computational Number Theory", algorithm 1.5.1).
67  * 'p' must be prime!
68  */
69         {
70         BIGNUM *ret = in;
71         int err = 1;
72         int r;
73         BIGNUM *b, *q, *t, *x, *y;
74         int e, i, j;
75         
76         if (!BN_is_odd(p) || BN_abs_is_word(p, 1))
77                 {
78                 if (BN_abs_is_word(p, 2))
79                         {
80                         if (ret == NULL)
81                                 ret = BN_new();
82                         if (ret == NULL)
83                                 goto end;
84                         if (!BN_set_word(ret, BN_is_bit_set(a, 0)))
85                                 {
86                                 BN_free(ret);
87                                 return NULL;
88                                 }
89                         return ret;
90                         }
91
92                 BNerr(BN_F_BN_MOD_SQRT, BN_R_P_IS_NOT_PRIME);
93                 return(NULL);
94                 }
95
96         if (BN_is_zero(a) || BN_is_one(a))
97                 {
98                 if (ret == NULL)
99                         ret = BN_new();
100                 if (ret == NULL)
101                         goto end;
102                 if (!BN_set_word(ret, BN_is_one(a)))
103                         {
104                         BN_free(ret);
105                         return NULL;
106                         }
107                 return ret;
108                 }
109
110 #if 0 /* if BN_mod_sqrt is used with correct input, this just wastes time */
111         r = BN_kronecker(a, p, ctx);
112         if (r < -1) return NULL;
113         if (r == -1)
114                 {
115                 BNerr(BN_F_BN_MOD_SQRT, BN_R_NOT_A_SQUARE);
116                 return(NULL);
117                 }
118 #endif
119
120         BN_CTX_start(ctx);
121         b = BN_CTX_get(ctx);
122         q = BN_CTX_get(ctx);
123         t = BN_CTX_get(ctx);
124         x = BN_CTX_get(ctx);
125         y = BN_CTX_get(ctx);
126         if (y == NULL) goto end;
127         
128         if (ret == NULL)
129                 ret = BN_new();
130         if (ret == NULL) goto end;
131
132         /* now write  |p| - 1  as  2^e*q  where  q  is odd */
133         e = 1;
134         while (!BN_is_bit_set(p, e))
135                 e++;
136         /* we'll set  q  later (if needed) */
137
138         if (e == 1)
139                 {
140                 /* The easy case:  (|p|-1)/2  is odd, so 2 has an inverse
141                  * modulo  (|p|-1)/2,  and square roots can be computed
142                  * directly by modular exponentiation.
143                  * We have
144                  *     2 * (|p|+1)/4 == 1   (mod (|p|-1)/2),
145                  * so we can use exponent  (|p|+1)/4,  i.e.  (|p|-3)/4 + 1.
146                  */
147                 if (!BN_rshift(q, p, 2)) goto end;
148                 q->neg = 0;
149                 if (!BN_add_word(q, 1)) goto end;
150                 if (!BN_mod_exp(ret, a, q, p, ctx)) goto end;
151                 err = 0;
152                 goto end;
153                 }
154         
155         if (e == 2)
156                 {
157                 /* |p| == 5  (mod 8)
158                  *
159                  * In this case  2  is always a non-square since
160                  * Legendre(2,p) = (-1)^((p^2-1)/8)  for any odd prime.
161                  * So if  a  really is a square, then  2*a  is a non-square.
162                  * Thus for
163                  *      b := (2*a)^((|p|-5)/8),
164                  *      i := (2*a)*b^2
165                  * we have
166                  *     i^2 = (2*a)^((1 + (|p|-5)/4)*2)
167                  *         = (2*a)^((p-1)/2)
168                  *         = -1;
169                  * so if we set
170                  *      x := a*b*(i-1),
171                  * then
172                  *     x^2 = a^2 * b^2 * (i^2 - 2*i + 1)
173                  *         = a^2 * b^2 * (-2*i)
174                  *         = a*(-i)*(2*a*b^2)
175                  *         = a*(-i)*i
176                  *         = a.
177                  *
178                  * (This is due to A.O.L. Atkin, 
179                  * <URL: http://listserv.nodak.edu/scripts/wa.exe?A2=ind9211&L=nmbrthry&O=T&P=562>,
180                  * November 1992.)
181                  */
182
183                 /* make sure that  a  is reduced modulo p */
184                 if (a->neg || BN_ucmp(a, p) >= 0)
185                         {
186                         if (!BN_nnmod(x, a, p, ctx)) goto end;
187                         a = x; /* use x as temporary variable */
188                         }
189
190                 /* t := 2*a */
191                 if (!BN_mod_lshift1_quick(t, a, p)) goto end;
192
193                 /* b := (2*a)^((|p|-5)/8) */
194                 if (!BN_rshift(q, p, 3)) goto end;
195                 q->neg = 0;
196                 if (!BN_mod_exp(b, t, q, p, ctx)) goto end;
197
198                 /* y := b^2 */
199                 if (!BN_mod_sqr(y, b, p, ctx)) goto end;
200
201                 /* t := (2*a)*b^2 - 1*/
202                 if (!BN_mod_mul(t, t, y, p, ctx)) goto end;
203                 if (!BN_sub_word(t, 1)) goto end;
204
205                 /* x = a*b*t */
206                 if (!BN_mod_mul(x, a, b, p, ctx)) goto end;
207                 if (!BN_mod_mul(x, x, t, p, ctx)) goto end;
208
209                 if (!BN_copy(ret, x)) goto end;
210                 err = 0;
211                 goto end;
212                 }
213         
214         /* e > 2, so we really have to use the Tonelli/Shanks algorithm.
215          * First, find some  y  that is not a square. */
216         if (!BN_copy(q, p)) goto end; /* use 'q' as temp */
217         q->neg = 0;
218         i = 2;
219         do
220                 {
221                 /* For efficiency, try small numbers first;
222                  * if this fails, try random numbers.
223                  */
224                 if (i < 22)
225                         {
226                         if (!BN_set_word(y, i)) goto end;
227                         }
228                 else
229                         {
230                         if (!BN_pseudo_rand(y, BN_num_bits(p), 0, 0)) goto end;
231                         if (BN_ucmp(y, p) >= 0)
232                                 {
233                                 if (!(p->neg ? BN_add : BN_sub)(y, y, p)) goto end;
234                                 }
235                         /* now 0 <= y < |p| */
236                         if (BN_is_zero(y))
237                                 if (!BN_set_word(y, i)) goto end;
238                         }
239                 
240                 r = BN_kronecker(y, q, ctx); /* here 'q' is |p| */
241                 if (r < -1) goto end;
242                 if (r == 0)
243                         {
244                         /* m divides p */
245                         BNerr(BN_F_BN_MOD_SQRT, BN_R_P_IS_NOT_PRIME);
246                         goto end;
247                         }
248                 }
249         while (r == 1 && ++i < 82);
250         
251         if (r != -1)
252                 {
253                 /* Many rounds and still no non-square -- this is more likely
254                  * a bug than just bad luck.
255                  * Even if  p  is not prime, we should have found some  y
256                  * such that r == -1.
257                  */
258                 BNerr(BN_F_BN_MOD_SQRT, BN_R_TOO_MANY_ITERATIONS);
259                 goto end;
260                 }
261
262         /* Here's our actual 'q': */
263         if (!BN_rshift(q, q, e)) goto end;
264
265         /* Now that we have some non-square, we can find an element
266          * of order  2^e  by computing its q'th power. */
267         if (!BN_mod_exp(y, y, q, p, ctx)) goto end;
268         if (BN_is_one(y))
269                 {
270                 BNerr(BN_F_BN_MOD_SQRT, BN_R_P_IS_NOT_PRIME);
271                 goto end;
272                 }
273
274         /* Now we know that (if  p  is indeed prime) there is an integer
275          * k,  0 <= k < 2^e,  such that
276          *
277          *      a^q * y^k == 1   (mod p).
278          *
279          * As  a^q  is a square and  y  is not,  k  must be even.
280          * q+1  is even, too, so there is an element
281          *
282          *     X := a^((q+1)/2) * y^(k/2),
283          *
284          * and it satisfies
285          *
286          *     X^2 = a^q * a     * y^k
287          *         = a,
288          *
289          * so it is the square root that we are looking for.
290          */
291         
292         /* t := (q-1)/2  (note that  q  is odd) */
293         if (!BN_rshift1(t, q)) goto end;
294         
295         /* x := a^((q-1)/2) */
296         if (BN_is_zero(t)) /* special case: p = 2^e + 1 */
297                 {
298                 if (!BN_nnmod(t, a, p, ctx)) goto end;
299                 if (BN_is_zero(t))
300                         {
301                         /* special case: a == 0  (mod p) */
302                         if (!BN_zero(ret)) goto end;
303                         err = 0;
304                         goto end;
305                         }
306                 else
307                         if (!BN_one(x)) goto end;
308                 }
309         else
310                 {
311                 if (!BN_mod_exp(x, a, t, p, ctx)) goto end;
312                 if (BN_is_zero(x))
313                         {
314                         /* special case: a == 0  (mod p) */
315                         if (!BN_zero(ret)) goto end;
316                         err = 0;
317                         goto end;
318                         }
319                 }
320
321         /* b := a*x^2  (= a^q) */
322         if (!BN_mod_sqr(b, x, p, ctx)) goto end;
323         if (!BN_mod_mul(b, b, a, p, ctx)) goto end;
324         
325         /* x := a*x    (= a^((q+1)/2)) */
326         if (!BN_mod_mul(x, x, a, p, ctx)) goto end;
327
328         while (1)
329                 {
330                 /* Now  b  is  a^q * y^k  for some even  k  (0 <= k < 2^E
331                  * where  E  refers to the original value of  e,  which we
332                  * don't keep in a variable),  and  x  is  a^((q+1)/2) * y^(k/2).
333                  *
334                  * We have  a*b = x^2,
335                  *    y^2^(e-1) = -1,
336                  *    b^2^(e-1) = 1.
337                  */
338
339                 if (BN_is_one(b))
340                         {
341                         if (!BN_copy(ret, x)) goto end;
342                         err = 0;
343                         goto end;
344                         }
345
346
347                 /* find smallest  i  such that  b^(2^i) = 1 */
348                 i = 1;
349                 if (!BN_mod_sqr(t, b, p, ctx)) goto end;
350                 while (!BN_is_one(t))
351                         {
352                         i++;
353                         if (i == e)
354                                 {
355                                 BNerr(BN_F_BN_MOD_SQRT, BN_R_NOT_A_SQUARE);
356                                 goto end;
357                                 }
358                         if (!BN_mod_mul(t, t, t, p, ctx)) goto end;
359                         }
360                 
361
362                 /* t := y^2^(e - i - 1) */
363                 if (!BN_copy(t, y)) goto end;
364                 for (j = e - i - 1; j > 0; j--)
365                         {
366                         if (!BN_mod_sqr(t, t, p, ctx)) goto end;
367                         }
368                 if (!BN_mod_mul(y, t, t, p, ctx)) goto end;
369                 if (!BN_mod_mul(x, x, t, p, ctx)) goto end;
370                 if (!BN_mod_mul(b, b, y, p, ctx)) goto end;
371                 e = i;
372                 }
373
374  end:
375         if (err)
376                 {
377                 if (ret != NULL && ret != in)
378                         {
379                         BN_clear_free(ret);
380                         }
381                 ret = NULL;
382                 }
383         BN_CTX_end(ctx);
384         return ret;
385         }