Debian Codegraph @

external/boringssl/crypto/ec/internal.h

raw
1 /* Originally written by Bodo Moeller for the OpenSSL project.
2 * ====================================================================
3 * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 *
17 * 3. All advertising materials mentioning features or use of this
18 * software must display the following acknowledgment:
19 * "This product includes software developed by the OpenSSL Project
20 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 *
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 * endorse or promote products derived from this software without
24 * prior written permission. For written permission, please contact
25 * [email protected].
26 *
27 * 5. Products derived from this software may not be called "OpenSSL"
28 * nor may "OpenSSL" appear in their names without prior written
29 * permission of the OpenSSL Project.
30 *
31 * 6. Redistributions of any form whatsoever must retain the following
32 * acknowledgment:
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 *
36 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47 * OF THE POSSIBILITY OF SUCH DAMAGE.
48 * ====================================================================
49 *
50 * This product includes cryptographic software written by Eric Young
51 * ([email protected]). This product includes software written by Tim
52 * Hudson ([email protected]).
53 *
54 */
55 /* ====================================================================
56 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
57 *
58 * Portions of the attached software ("Contribution") are developed by
59 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
60 *
61 * The Contribution is licensed pursuant to the OpenSSL open source
62 * license provided above.
63 *
64 * The elliptic curve binary polynomial software is originally written by
65 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems
66 * Laboratories. */
67
68 #ifndef OPENSSL_HEADER_EC_INTERNAL_H
69 #define OPENSSL_HEADER_EC_INTERNAL_H
70
71 #include <openssl/base.h>
72
73 #include <openssl/bn.h>
74 #include <openssl/ex_data.h>
75 #include <openssl/thread.h>
76
77 #if defined(__cplusplus)
78 extern "C" {
79 #endif
80
81
82 struct ec_method_st {
83 int (*group_init)(EC_GROUP *);
84 void (*group_finish)(EC_GROUP *);
85 int (*group_copy)(EC_GROUP *, const EC_GROUP *);
86 int (*group_set_curve)(EC_GROUP *, const BIGNUM *p, const BIGNUM *a,
87 const BIGNUM *b, BN_CTX *);
88 int (*point_get_affine_coordinates)(const EC_GROUP *, const EC_POINT *,
89 BIGNUM *x, BIGNUM *y, BN_CTX *);
90
91 /* Computes |r = g_scalar*generator + p_scalar*p| if |g_scalar| and |p_scalar|
92 * are both non-null. Computes |r = g_scalar*generator| if |p_scalar| is null.
93 * Computes |r = p_scalar*p| if g_scalar is null. At least one of |g_scalar|
94 * and |p_scalar| must be non-null, and |p| must be non-null if |p_scalar| is
95 * non-null. */
96 int (*mul)(const EC_GROUP *group, EC_POINT *r, const BIGNUM *g_scalar,
97 const EC_POINT *p, const BIGNUM *p_scalar, BN_CTX *ctx);
98
99 /* |check_pub_key_order| checks that the public key is in the proper subgroup
100 * by checking that |pub_key*group->order| is the point at infinity. This may
101 * be NULL for |EC_METHOD|s specialized for prime-order curves (i.e. with
102 * cofactor one), as this check is not necessary for such curves (See section
103 * A.3 of the NSA's "Suite B Implementer's Guide to FIPS 186-3
104 * (ECDSA)"). */
105 int (*check_pub_key_order)(const EC_GROUP *group, const EC_POINT *pub_key,
106 BN_CTX *ctx);
107
108 /* 'field_mul' and 'field_sqr' can be used by 'add' and 'dbl' so that the
109 * same implementations of point operations can be used with different
110 * optimized implementations of expensive field operations: */
111 int (*field_mul)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
112 const BIGNUM *b, BN_CTX *);
113 int (*field_sqr)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
114
115 int (*field_encode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
116 BN_CTX *); /* e.g. to Montgomery */
117 int (*field_decode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
118 BN_CTX *); /* e.g. from Montgomery */
119 } /* EC_METHOD */;
120
121 const EC_METHOD* EC_GFp_mont_method(void);
122
123 struct ec_group_st {
124 const EC_METHOD *meth;
125
126 EC_POINT *generator;
127 BIGNUM order, cofactor;
128
129 int curve_name; /* optional NID for named curve */
130
131 const BN_MONT_CTX *mont_data; /* data for ECDSA inverse */
132
133 /* The following members are handled by the method functions,
134 * even if they appear generic */
135
136 BIGNUM field; /* For curves over GF(p), this is the modulus. */
137
138 BIGNUM a, b; /* Curve coefficients. */
139
140 int a_is_minus3; /* enable optimized point arithmetics for special case */
141
142 BN_MONT_CTX *mont; /* Montgomery structure. */
143
144 BIGNUM one; /* The value one. */
145 } /* EC_GROUP */;
146
147 struct ec_point_st {
148 const EC_METHOD *meth;
149
150 BIGNUM X;
151 BIGNUM Y;
152 BIGNUM Z; /* Jacobian projective coordinates:
153 * (X, Y, Z) represents (X/Z^2, Y/Z^3) if Z != 0 */
154 } /* EC_POINT */;
155
156 EC_GROUP *ec_group_new(const EC_METHOD *meth);
157 int ec_group_copy(EC_GROUP *dest, const EC_GROUP *src);
158
159 /* ec_group_get_mont_data returns a Montgomery context for operations in the
160 * scalar field of |group|. It may return NULL in the case that |group| is not
161 * a built-in group. */
162 const BN_MONT_CTX *ec_group_get_mont_data(const EC_GROUP *group);
163
164 int ec_wNAF_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *g_scalar,
165 const EC_POINT *p, const BIGNUM *p_scalar, BN_CTX *ctx);
166
167 /* method functions in simple.c */
168 int ec_GFp_simple_group_init(EC_GROUP *);
169 void ec_GFp_simple_group_finish(EC_GROUP *);
170 int ec_GFp_simple_group_copy(EC_GROUP *, const EC_GROUP *);
171 int ec_GFp_simple_group_set_curve(EC_GROUP *, const BIGNUM *p, const BIGNUM *a,
172 const BIGNUM *b, BN_CTX *);
173 int ec_GFp_simple_group_get_curve(const EC_GROUP *, BIGNUM *p, BIGNUM *a,
174 BIGNUM *b, BN_CTX *);
175 unsigned ec_GFp_simple_group_get_degree(const EC_GROUP *);
176 int ec_GFp_simple_point_init(EC_POINT *);
177 void ec_GFp_simple_point_finish(EC_POINT *);
178 void ec_GFp_simple_point_clear_finish(EC_POINT *);
179 int ec_GFp_simple_point_copy(EC_POINT *, const EC_POINT *);
180 int ec_GFp_simple_point_set_to_infinity(const EC_GROUP *, EC_POINT *);
181 int ec_GFp_simple_set_Jprojective_coordinates_GFp(const EC_GROUP *, EC_POINT *,
182 const BIGNUM *x,
183 const BIGNUM *y,
184 const BIGNUM *z, BN_CTX *);
185 int ec_GFp_simple_get_Jprojective_coordinates_GFp(const EC_GROUP *,
186 const EC_POINT *, BIGNUM *x,
187 BIGNUM *y, BIGNUM *z,
188 BN_CTX *);
189 int ec_GFp_simple_point_set_affine_coordinates(const EC_GROUP *, EC_POINT *,
190 const BIGNUM *x, const BIGNUM *y,
191 BN_CTX *);
192 int ec_GFp_simple_set_compressed_coordinates(const EC_GROUP *, EC_POINT *,
193 const BIGNUM *x, int y_bit,
194 BN_CTX *);
195 int ec_GFp_simple_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a,
196 const EC_POINT *b, BN_CTX *);
197 int ec_GFp_simple_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a,
198 BN_CTX *);
199 int ec_GFp_simple_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
200 int ec_GFp_simple_is_at_infinity(const EC_GROUP *, const EC_POINT *);
201 int ec_GFp_simple_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
202 int ec_GFp_simple_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b,
203 BN_CTX *);
204 int ec_GFp_simple_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
205 int ec_GFp_simple_points_make_affine(const EC_GROUP *, size_t num,
206 EC_POINT * [], BN_CTX *);
207 int ec_GFp_simple_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
208 const BIGNUM *b, BN_CTX *);
209 int ec_GFp_simple_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
210 BN_CTX *);
211
212 /* method functions in montgomery.c */
213 int ec_GFp_mont_group_init(EC_GROUP *);
214 int ec_GFp_mont_group_set_curve(EC_GROUP *, const BIGNUM *p, const BIGNUM *a,
215 const BIGNUM *b, BN_CTX *);
216 void ec_GFp_mont_group_finish(EC_GROUP *);
217 int ec_GFp_mont_group_copy(EC_GROUP *, const EC_GROUP *);
218 int ec_GFp_mont_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
219 const BIGNUM *b, BN_CTX *);
220 int ec_GFp_mont_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
221 BN_CTX *);
222 int ec_GFp_mont_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
223 BN_CTX *);
224 int ec_GFp_mont_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
225 BN_CTX *);
226
227 int ec_point_set_Jprojective_coordinates_GFp(const EC_GROUP *group,
228 EC_POINT *point, const BIGNUM *x,
229 const BIGNUM *y, const BIGNUM *z,
230 BN_CTX *ctx);
231
232 void ec_GFp_nistp_recode_scalar_bits(uint8_t *sign, uint8_t *digit, uint8_t in);
233
234 const EC_METHOD *EC_GFp_nistp224_method(void);
235 const EC_METHOD *EC_GFp_nistp256_method(void);
236
237 /* Returns GFp methods using montgomery multiplication, with x86-64
238 * optimized P256. See http://eprint.iacr.org/2013/816. */
239 const EC_METHOD *EC_GFp_nistz256_method(void);
240
241 struct ec_key_st {
242 EC_GROUP *group;
243
244 EC_POINT *pub_key;
245 BIGNUM *priv_key;
246
247 unsigned int enc_flag;
248 point_conversion_form_t conv_form;
249
250 CRYPTO_refcount_t references;
251
252 ECDSA_METHOD *ecdsa_meth;
253
254 CRYPTO_EX_DATA ex_data;
255 } /* EC_KEY */;
256
257 /* curve_data contains data about a built-in elliptic curve. */
258 struct curve_data {
259 /* comment is a human-readable string describing the curve. */
260 const char *comment;
261 /* param_len is the number of bytes needed to store a field element. */
262 uint8_t param_len;
263 /* cofactor is the cofactor of the group (i.e. the number of elements in the
264 * group divided by the size of the main subgroup. */
265 uint8_t cofactor; /* promoted to BN_ULONG */
266 /* data points to an array of 6*|param_len| bytes which hold the field
267 * elements of the following (in big-endian order): prime, a, b, generator x,
268 * generator y, order. */
269 const uint8_t data[];
270 };
271
272 struct built_in_curve {
273 int nid;
274 uint8_t oid[8];
275 uint8_t oid_len;
276 const struct curve_data *data;
277 const EC_METHOD *(*method)(void);
278 };
279
280 /* OPENSSL_built_in_curves is terminated with an entry where |nid| is
281 * |NID_undef|. */
282 extern const struct built_in_curve OPENSSL_built_in_curves[];
283
284 #if defined(__cplusplus)
285 } /* extern C */
286 #endif
287
288 #endif /* OPENSSL_HEADER_EC_INTERNAL_H */