1 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57 /* ====================================================================
58 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
108 *
109 */
110 /* ====================================================================
111 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
112 *
113 * Portions of the attached software ("Contribution") are developed by
114 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
115 *
116 * The Contribution is licensed pursuant to the Eric Young open source
117 * license provided above.
118 *
119 * The binary polynomial arithmetic software is originally written by
120 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems
121 * Laboratories. */
122
123 #ifndef OPENSSL_HEADER_BN_INTERNAL_H
124 #define OPENSSL_HEADER_BN_INTERNAL_H
125
126 #include <openssl/base.h>
127
128 #if defined(OPENSSL_X86_64) && defined(_MSC_VER)
129 OPENSSL_MSVC_PRAGMA(warning(push, 3))
130 #include <intrin.h>
OPENSSL_MSVC_PRAGMA(warning (pop))131 OPENSSL_MSVC_PRAGMA(warning(pop))
132 #pragma intrinsic(__umulh, _umul128)
133 #endif
134
135 #include "../../internal.h"
136
137 #if defined(__cplusplus)
138 extern "C" {
139 #endif
140
141 #if defined(OPENSSL_64_BIT)
142
143 #if !defined(_MSC_VER)
144 /* MSVC doesn't support two-word integers on 64-bit. */
145 #define BN_ULLONG uint128_t
146 #endif
147
148 #define BN_BITS2 64
149 #define BN_BYTES 8
150 #define BN_BITS4 32
151 #define BN_MASK2 (0xffffffffffffffffUL)
152 #define BN_MASK2l (0xffffffffUL)
153 #define BN_MASK2h (0xffffffff00000000UL)
154 #define BN_MASK2h1 (0xffffffff80000000UL)
155 #define BN_MONT_CTX_N0_LIMBS 1
156 #define BN_TBIT (0x8000000000000000UL)
157 #define BN_DEC_CONV (10000000000000000000UL)
158 #define BN_DEC_NUM 19
159 #define TOBN(hi, lo) ((BN_ULONG)(hi) << 32 | (lo))
160
161 #elif defined(OPENSSL_32_BIT)
162
163 #define BN_ULLONG uint64_t
164 #define BN_BITS2 32
165 #define BN_BYTES 4
166 #define BN_BITS4 16
167 #define BN_MASK2 (0xffffffffUL)
168 #define BN_MASK2l (0xffffUL)
169 #define BN_MASK2h1 (0xffff8000UL)
170 #define BN_MASK2h (0xffff0000UL)
171 /* On some 32-bit platforms, Montgomery multiplication is done using 64-bit
172 * arithmetic with SIMD instructions. On such platforms, |BN_MONT_CTX::n0|
173 * needs to be two words long. Only certain 32-bit platforms actually make use
174 * of n0[1] and shorter R value would suffice for the others. However,
175 * currently only the assembly files know which is which. */
176 #define BN_MONT_CTX_N0_LIMBS 2
177 #define BN_TBIT (0x80000000UL)
178 #define BN_DEC_CONV (1000000000UL)
179 #define BN_DEC_NUM 9
180 #define TOBN(hi, lo) (lo), (hi)
181
182 #else
183 #error "Must define either OPENSSL_32_BIT or OPENSSL_64_BIT"
184 #endif
185
186
187 #define STATIC_BIGNUM(x) \
188 { \
189 (BN_ULONG *)(x), sizeof(x) / sizeof(BN_ULONG), \
190 sizeof(x) / sizeof(BN_ULONG), 0, BN_FLG_STATIC_DATA \
191 }
192
193 #if defined(BN_ULLONG)
194 #define Lw(t) (((BN_ULONG)(t))&BN_MASK2)
195 #define Hw(t) (((BN_ULONG)((t)>>BN_BITS2))&BN_MASK2)
196 #endif
197
198 /* bn_correct_top decrements |bn->top| until |bn->d[top-1]| is non-zero or
199 * until |top| is zero. If |bn| is zero, |bn->neg| is set to zero. */
200 void bn_correct_top(BIGNUM *bn);
201
202 /* bn_wexpand ensures that |bn| has at least |words| works of space without
203 * altering its value. It returns one on success or zero on allocation
204 * failure. */
205 int bn_wexpand(BIGNUM *bn, size_t words);
206
207 /* bn_expand acts the same as |bn_wexpand|, but takes a number of bits rather
208 * than a number of words. */
209 int bn_expand(BIGNUM *bn, size_t bits);
210
211 /* bn_set_words sets |bn| to the value encoded in the |num| words in |words|,
212 * least significant word first. */
213 int bn_set_words(BIGNUM *bn, const BN_ULONG *words, size_t num);
214
215 BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
216 BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
217 void bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num);
218 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
219 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
220
221 void bn_mul_comba4(BN_ULONG *r, BN_ULONG *a, BN_ULONG *b);
222 void bn_mul_comba8(BN_ULONG *r, BN_ULONG *a, BN_ULONG *b);
223 void bn_sqr_comba8(BN_ULONG *r, const BN_ULONG *a);
224 void bn_sqr_comba4(BN_ULONG *r, const BN_ULONG *a);
225
226 /* bn_cmp_words returns a value less than, equal to or greater than zero if
227 * the, length |n|, array |a| is less than, equal to or greater than |b|. */
228 int bn_cmp_words(const BN_ULONG *a, const BN_ULONG *b, int n);
229
230 /* bn_cmp_words returns a value less than, equal to or greater than zero if the
231 * array |a| is less than, equal to or greater than |b|. The arrays can be of
232 * different lengths: |cl| gives the minimum of the two lengths and |dl| gives
233 * the length of |a| minus the length of |b|. */
234 int bn_cmp_part_words(const BN_ULONG *a, const BN_ULONG *b, int cl, int dl);
235
236 int bn_mul_mont(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,
237 const BN_ULONG *np, const BN_ULONG *n0, int num);
238
239 uint64_t bn_mont_n0(const BIGNUM *n);
240 int bn_mod_exp_base_2_vartime(BIGNUM *r, unsigned p, const BIGNUM *n);
241
242 #if defined(OPENSSL_X86_64) && defined(_MSC_VER)
243 #define BN_UMULT_LOHI(low, high, a, b) ((low) = _umul128((a), (b), &(high)))
244 #endif
245
246 #if !defined(BN_ULLONG) && !defined(BN_UMULT_LOHI)
247 #error "Either BN_ULLONG or BN_UMULT_LOHI must be defined on every platform."
248 #endif
249
250 /* bn_mod_inverse_prime sets |out| to the modular inverse of |a| modulo |p|,
251 * computed with Fermat's Little Theorem. It returns one on success and zero on
252 * error. If |mont_p| is NULL, one will be computed temporarily. */
253 int bn_mod_inverse_prime(BIGNUM *out, const BIGNUM *a, const BIGNUM *p,
254 BN_CTX *ctx, const BN_MONT_CTX *mont_p);
255
256 /* bn_mod_inverse_secret_prime behaves like |bn_mod_inverse_prime| but uses
257 * |BN_mod_exp_mont_consttime| instead of |BN_mod_exp_mont| in hopes of
258 * protecting the exponent. */
259 int bn_mod_inverse_secret_prime(BIGNUM *out, const BIGNUM *a, const BIGNUM *p,
260 BN_CTX *ctx, const BN_MONT_CTX *mont_p);
261
262 /* bn_jacobi returns the Jacobi symbol of |a| and |b| (which is -1, 0 or 1), or
263 * -2 on error. */
264 int bn_jacobi(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
265
266
267 #if defined(__cplusplus)
268 } /* extern C */
269 #endif
270
271 #endif /* OPENSSL_HEADER_BN_INTERNAL_H */
272