Update copyright; generated files.
[openssl.git] / crypto / bn / bn_kron.c
1 /* ====================================================================
2  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This product includes cryptographic software written by Eric Young
50  * (eay@cryptsoft.com).  This product includes software written by Tim
51  * Hudson (tjh@cryptsoft.com).
52  *
53  */
54
55 #include "internal/cryptlib.h"
56 #include "bn_lcl.h"
57
58 /* least significant word */
59 #define BN_lsw(n) (((n)->top == 0) ? (BN_ULONG) 0 : (n)->d[0])
60
61 /* Returns -2 for errors because both -1 and 0 are valid results. */
62 int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
63 {
64     int i;
65     int ret = -2;               /* avoid 'uninitialized' warning */
66     int err = 0;
67     BIGNUM *A, *B, *tmp;
68     /*-
69      * In 'tab', only odd-indexed entries are relevant:
70      * For any odd BIGNUM n,
71      *     tab[BN_lsw(n) & 7]
72      * is $(-1)^{(n^2-1)/8}$ (using TeX notation).
73      * Note that the sign of n does not matter.
74      */
75     static const int tab[8] = { 0, 1, 0, -1, 0, -1, 0, 1 };
76
77     bn_check_top(a);
78     bn_check_top(b);
79
80     BN_CTX_start(ctx);
81     A = BN_CTX_get(ctx);
82     B = BN_CTX_get(ctx);
83     if (B == NULL)
84         goto end;
85
86     err = !BN_copy(A, a);
87     if (err)
88         goto end;
89     err = !BN_copy(B, b);
90     if (err)
91         goto end;
92
93     /*
94      * Kronecker symbol, implemented according to Henri Cohen,
95      * "A Course in Computational Algebraic Number Theory"
96      * (algorithm 1.4.10).
97      */
98
99     /* Cohen's step 1: */
100
101     if (BN_is_zero(B)) {
102         ret = BN_abs_is_word(A, 1);
103         goto end;
104     }
105
106     /* Cohen's step 2: */
107
108     if (!BN_is_odd(A) && !BN_is_odd(B)) {
109         ret = 0;
110         goto end;
111     }
112
113     /* now  B  is non-zero */
114     i = 0;
115     while (!BN_is_bit_set(B, i))
116         i++;
117     err = !BN_rshift(B, B, i);
118     if (err)
119         goto end;
120     if (i & 1) {
121         /* i is odd */
122         /* (thus  B  was even, thus  A  must be odd!)  */
123
124         /* set 'ret' to $(-1)^{(A^2-1)/8}$ */
125         ret = tab[BN_lsw(A) & 7];
126     } else {
127         /* i is even */
128         ret = 1;
129     }
130
131     if (B->neg) {
132         B->neg = 0;
133         if (A->neg)
134             ret = -ret;
135     }
136
137     /*
138      * now B is positive and odd, so what remains to be done is to compute
139      * the Jacobi symbol (A/B) and multiply it by 'ret'
140      */
141
142     while (1) {
143         /* Cohen's step 3: */
144
145         /*  B  is positive and odd */
146
147         if (BN_is_zero(A)) {
148             ret = BN_is_one(B) ? ret : 0;
149             goto end;
150         }
151
152         /* now  A  is non-zero */
153         i = 0;
154         while (!BN_is_bit_set(A, i))
155             i++;
156         err = !BN_rshift(A, A, i);
157         if (err)
158             goto end;
159         if (i & 1) {
160             /* i is odd */
161             /* multiply 'ret' by  $(-1)^{(B^2-1)/8}$ */
162             ret = ret * tab[BN_lsw(B) & 7];
163         }
164
165         /* Cohen's step 4: */
166         /* multiply 'ret' by  $(-1)^{(A-1)(B-1)/4}$ */
167         if ((A->neg ? ~BN_lsw(A) : BN_lsw(A)) & BN_lsw(B) & 2)
168             ret = -ret;
169
170         /* (A, B) := (B mod |A|, |A|) */
171         err = !BN_nnmod(B, B, A, ctx);
172         if (err)
173             goto end;
174         tmp = A;
175         A = B;
176         B = tmp;
177         tmp->neg = 0;
178     }
179  end:
180     BN_CTX_end(ctx);
181     if (err)
182         return -2;
183     else
184         return ret;
185 }