Debian Codegraph @

external/boringssl/include/openssl/ec.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_H
69 #define OPENSSL_HEADER_EC_H
70
71 #include <openssl/base.h>
72
73 #if defined(__cplusplus)
74 extern "C" {
75 #endif
76
77
78 /* Low-level operations on elliptic curves. */
79
80
81 typedef struct ec_group_st EC_GROUP;
82 typedef struct ec_point_st EC_POINT;
83
84 /* point_conversion_form_t enumerates forms, as defined in X9.62 (ECDSA), for
85 * the encoding of a elliptic curve point (x,y) */
86 typedef enum {
87 /* POINT_CONVERSION_COMPRESSED indicates that the point is encoded as z||x,
88 * where the octet z specifies which solution of the quadratic equation y
89 * is. */
90 POINT_CONVERSION_COMPRESSED = 2,
91
92 /* POINT_CONVERSION_COMPRESSED indicates that the point is encoded as
93 * z||x||y, where z is the octet 0x04. */
94 POINT_CONVERSION_UNCOMPRESSED = 4,
95
96 /* POINT_CONVERSION_HYBRID indicates that the point is encoded as z||x||y,
97 * where z specifies which solution of the quadratic equation y is. This is
98 * not supported by the code and has never been observed in use.
99 *
100 * TODO(agl): remove once node.js no longer references this. */
101 POINT_CONVERSION_HYBRID = 6,
102 } point_conversion_form_t;
103
104
105 /* Elliptic curve groups. */
106
107 /* EC_GROUP_new_by_curve_name returns a fresh EC_GROUP object for the elliptic
108 * curve specified by |nid|, or NULL on error.
109 *
110 * The supported NIDs are:
111 * NID_secp224r1,
112 * NID_X9_62_prime256v1,
113 * NID_secp384r1,
114 * NID_secp521r1 */
115 OPENSSL_EXPORT EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
116
117 /* EC_GROUP_free frees |group| and the data that it points to. */
118 OPENSSL_EXPORT void EC_GROUP_free(EC_GROUP *group);
119
120 /* EC_GROUP_dup returns a fresh |EC_GROUP| which is equal to |a| or NULL on
121 * error. */
122 OPENSSL_EXPORT EC_GROUP *EC_GROUP_dup(const EC_GROUP *a);
123
124 /* EC_GROUP_cmp returns zero if |a| and |b| are the same group and non-zero
125 * otherwise. */
126 OPENSSL_EXPORT int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b,
127 BN_CTX *ignored);
128
129 /* EC_GROUP_get0_generator returns a pointer to the internal |EC_POINT| object
130 * in |group| that specifies the generator for the group. */
131 OPENSSL_EXPORT const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
132
133 /* EC_GROUP_get0_order returns a pointer to the internal |BIGNUM| object in
134 * |group| that specifies the order of the group. */
135 OPENSSL_EXPORT const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group);
136
137 /* EC_GROUP_get_cofactor sets |*cofactor| to the cofactor of |group| using
138 * |ctx|, if it's not NULL. It returns one on success and zero otherwise. */
139 OPENSSL_EXPORT int EC_GROUP_get_cofactor(const EC_GROUP *group,
140 BIGNUM *cofactor, BN_CTX *ctx);
141
142 /* EC_GROUP_get_curve_GFp gets various parameters about a group. It sets
143 * |*out_p| to the order of the coordinate field and |*out_a| and |*out_b| to
144 * the parameters of the curve when expressed as y² = x³ + ax + b. Any of the
145 * output parameters can be NULL. It returns one on success and zero on
146 * error. */
147 OPENSSL_EXPORT int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *out_p,
148 BIGNUM *out_a, BIGNUM *out_b,
149 BN_CTX *ctx);
150
151 /* EC_GROUP_get_curve_name returns a NID that identifies |group|. */
152 OPENSSL_EXPORT int EC_GROUP_get_curve_name(const EC_GROUP *group);
153
154 /* EC_GROUP_get_degree returns the number of bits needed to represent an
155 * element of the field underlying |group|. */
156 OPENSSL_EXPORT unsigned EC_GROUP_get_degree(const EC_GROUP *group);
157
158
159 /* Points on elliptic curves. */
160
161 /* EC_POINT_new returns a fresh |EC_POINT| object in the given group, or NULL
162 * on error. */
163 OPENSSL_EXPORT EC_POINT *EC_POINT_new(const EC_GROUP *group);
164
165 /* EC_POINT_free frees |point| and the data that it points to. */
166 OPENSSL_EXPORT void EC_POINT_free(EC_POINT *point);
167
168 /* EC_POINT_clear_free clears the data that |point| points to, frees it and
169 * then frees |point| itself. */
170 OPENSSL_EXPORT void EC_POINT_clear_free(EC_POINT *point);
171
172 /* EC_POINT_copy sets |*dest| equal to |*src|. It returns one on success and
173 * zero otherwise. */
174 OPENSSL_EXPORT int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src);
175
176 /* EC_POINT_dup returns a fresh |EC_POINT| that contains the same values as
177 * |src|, or NULL on error. */
178 OPENSSL_EXPORT EC_POINT *EC_POINT_dup(const EC_POINT *src,
179 const EC_GROUP *group);
180
181 /* EC_POINT_set_to_infinity sets |point| to be the "point at infinity" for the
182 * given group. */
183 OPENSSL_EXPORT int EC_POINT_set_to_infinity(const EC_GROUP *group,
184 EC_POINT *point);
185
186 /* EC_POINT_is_at_infinity returns one iff |point| is the point at infinity and
187 * zero otherwise. */
188 OPENSSL_EXPORT int EC_POINT_is_at_infinity(const EC_GROUP *group,
189 const EC_POINT *point);
190
191 /* EC_POINT_is_on_curve returns one if |point| is an element of |group| and
192 * and zero otherwise or when an error occurs. This is different from OpenSSL,
193 * which returns -1 on error. If |ctx| is non-NULL, it may be used. */
194 OPENSSL_EXPORT int EC_POINT_is_on_curve(const EC_GROUP *group,
195 const EC_POINT *point, BN_CTX *ctx);
196
197 /* EC_POINT_cmp returns zero if |a| is equal to |b|, greater than zero if
198 * not equal and -1 on error. If |ctx| is not NULL, it may be used. */
199 OPENSSL_EXPORT int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a,
200 const EC_POINT *b, BN_CTX *ctx);
201
202 /* EC_POINT_make_affine converts |point| to affine form, internally. It returns
203 * one on success and zero otherwise. If |ctx| is not NULL, it may be used. */
204 OPENSSL_EXPORT int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point,
205 BN_CTX *ctx);
206
207 /* EC_POINTs_make_affine converts |num| points from |points| to affine form,
208 * internally. It returns one on success and zero otherwise. If |ctx| is not
209 * NULL, it may be used. */
210 OPENSSL_EXPORT int EC_POINTs_make_affine(const EC_GROUP *group, size_t num,
211 EC_POINT *points[], BN_CTX *ctx);
212
213
214 /* Point conversion. */
215
216 /* EC_POINT_get_affine_coordinates_GFp sets |x| and |y| to the affine value of
217 * |point| using |ctx|, if it's not NULL. It returns one on success and zero
218 * otherwise. */
219 OPENSSL_EXPORT int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
220 const EC_POINT *point,
221 BIGNUM *x, BIGNUM *y,
222 BN_CTX *ctx);
223
224 /* EC_POINT_set_affine_coordinates_GFp sets the value of |point| to be
225 * (|x|, |y|). The |ctx| argument may be used if not NULL. It returns one
226 * on success or zero on error. Note that, unlike with OpenSSL, it's
227 * considered an error if the point is not on the curve. */
228 OPENSSL_EXPORT int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group,
229 EC_POINT *point,
230 const BIGNUM *x,
231 const BIGNUM *y,
232 BN_CTX *ctx);
233
234 /* EC_POINT_point2oct serialises |point| into the X9.62 form given by |form|
235 * into, at most, |len| bytes at |buf|. It returns the number of bytes written
236 * or zero on error if |buf| is non-NULL, else the number of bytes needed. The
237 * |ctx| argument may be used if not NULL. */
238 OPENSSL_EXPORT size_t EC_POINT_point2oct(const EC_GROUP *group,
239 const EC_POINT *point,
240 point_conversion_form_t form,
241 uint8_t *buf, size_t len, BN_CTX *ctx);
242
243 /* EC_POINT_point2cbb behaves like |EC_POINT_point2oct| but appends the
244 * serialised point to |cbb|. It returns one on success and zero on error. */
245 OPENSSL_EXPORT int EC_POINT_point2cbb(CBB *out, const EC_GROUP *group,
246 const EC_POINT *point,
247 point_conversion_form_t form,
248 BN_CTX *ctx);
249
250 /* EC_POINT_oct2point sets |point| from |len| bytes of X9.62 format
251 * serialisation in |buf|. It returns one on success and zero otherwise. The
252 * |ctx| argument may be used if not NULL. */
253 OPENSSL_EXPORT int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point,
254 const uint8_t *buf, size_t len,
255 BN_CTX *ctx);
256
257 /* EC_POINT_set_compressed_coordinates_GFp sets |point| to equal the point with
258 * the given |x| coordinate and the y coordinate specified by |y_bit| (see
259 * X9.62). It returns one on success and zero otherwise. */
260 OPENSSL_EXPORT int EC_POINT_set_compressed_coordinates_GFp(
261 const EC_GROUP *group, EC_POINT *point, const BIGNUM *x, int y_bit,
262 BN_CTX *ctx);
263
264
265 /* Group operations. */
266
267 /* EC_POINT_add sets |r| equal to |a| plus |b|. It returns one on success and
268 * zero otherwise. If |ctx| is not NULL, it may be used. */
269 OPENSSL_EXPORT int EC_POINT_add(const EC_GROUP *group, EC_POINT *r,
270 const EC_POINT *a, const EC_POINT *b,
271 BN_CTX *ctx);
272
273 /* EC_POINT_dbl sets |r| equal to |a| plus |a|. It returns one on success and
274 * zero otherwise. If |ctx| is not NULL, it may be used. */
275 OPENSSL_EXPORT int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r,
276 const EC_POINT *a, BN_CTX *ctx);
277
278 /* EC_POINT_invert sets |a| equal to minus |a|. It returns one on success and zero
279 * otherwise. If |ctx| is not NULL, it may be used. */
280 OPENSSL_EXPORT int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a,
281 BN_CTX *ctx);
282
283 /* EC_POINT_mul sets r = generator*n + q*m. It returns one on success and zero
284 * otherwise. If |ctx| is not NULL, it may be used. */
285 OPENSSL_EXPORT int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r,
286 const BIGNUM *n, const EC_POINT *q,
287 const BIGNUM *m, BN_CTX *ctx);
288
289
290 /* Deprecated functions. */
291
292 /* EC_GROUP_new_curve_GFp creates a new, arbitrary elliptic curve group based
293 * on the equation y² = x³ + a·x + b. It returns the new group or NULL on
294 * error.
295 *
296 * This new group has no generator. It is an error to use a generator-less group
297 * with any functions except for |EC_GROUP_free|, |EC_POINT_new|,
298 * |EC_POINT_set_affine_coordinates_GFp|, and |EC_GROUP_set_generator|.
299 *
300 * |EC_GROUP|s returned by this function will always compare as unequal via
301 * |EC_GROUP_cmp| (even to themselves). |EC_GROUP_get_curve_name| will always
302 * return |NID_undef|.
303 *
304 * Avoid using arbitrary curves and use |EC_GROUP_new_by_curve_name| instead. */
305 OPENSSL_EXPORT EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p,
306 const BIGNUM *a,
307 const BIGNUM *b, BN_CTX *ctx);
308
309 /* EC_GROUP_set_generator sets the generator for |group| to |generator|, which
310 * must have the given order and cofactor. It may only be used with |EC_GROUP|
311 * objects returned by |EC_GROUP_new_curve_GFp| and may only be used once on
312 * each group. */
313 OPENSSL_EXPORT int EC_GROUP_set_generator(EC_GROUP *group,
314 const EC_POINT *generator,
315 const BIGNUM *order,
316 const BIGNUM *cofactor);
317
318 /* EC_GROUP_new_arbitrary calls |EC_GROUP_new_curve_GFp| and
319 * |EC_GROUP_set_generator|.
320 *
321 * TODO(davidben): Remove this once
322 * https://android-review.googlesource.com/#/c/207990/ has cycled in. */
323 OPENSSL_EXPORT EC_GROUP *EC_GROUP_new_arbitrary(
324 const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, const BIGNUM *gx,
325 const BIGNUM *gy, const BIGNUM *order, const BIGNUM *cofactor);
326
327 /* EC_GROUP_get_order sets |*order| to the order of |group|, if it's not
328 * NULL. It returns one on success and zero otherwise. |ctx| is ignored. Use
329 * |EC_GROUP_get0_order| instead. */
330 OPENSSL_EXPORT int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order,
331 BN_CTX *ctx);
332
333 /* EC_GROUP_set_asn1_flag does nothing. */
334 OPENSSL_EXPORT void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
335
336 #define OPENSSL_EC_NAMED_CURVE 0
337
338 typedef struct ec_method_st EC_METHOD;
339
340 /* EC_GROUP_method_of returns NULL. */
341 OPENSSL_EXPORT const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
342
343 /* EC_METHOD_get_field_type returns NID_X9_62_prime_field. */
344 OPENSSL_EXPORT int EC_METHOD_get_field_type(const EC_METHOD *meth);
345
346 /* EC_GROUP_set_point_conversion_form aborts the process if |form| is not
347 * |POINT_CONVERSION_UNCOMPRESSED| and otherwise does nothing. */
348 OPENSSL_EXPORT void EC_GROUP_set_point_conversion_form(
349 EC_GROUP *group, point_conversion_form_t form);
350
351 /* EC_builtin_curve describes a supported elliptic curve. */
352 typedef struct {
353 int nid;
354 const char *comment;
355 } EC_builtin_curve;
356
357 /* EC_get_builtin_curves writes at most |max_num_curves| elements to
358 * |out_curves| and returns the total number that it would have written, had
359 * |max_num_curves| been large enough.
360 *
361 * The |EC_builtin_curve| items describe the supported elliptic curves. */
362 OPENSSL_EXPORT size_t EC_get_builtin_curves(EC_builtin_curve *out_curves,
363 size_t max_num_curves);
364
365 /* Old code expects to get EC_KEY from ec.h. */
366 #include <openssl/ec_key.h>
367
368
369 #if defined(__cplusplus)
370 } /* extern C */
371 #endif
372
373 #define EC_R_BUFFER_TOO_SMALL 100
374 #define EC_R_COORDINATES_OUT_OF_RANGE 101
375 #define EC_R_D2I_ECPKPARAMETERS_FAILURE 102
376 #define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE 103
377 #define EC_R_GROUP2PKPARAMETERS_FAILURE 104
378 #define EC_R_I2D_ECPKPARAMETERS_FAILURE 105
379 #define EC_R_INCOMPATIBLE_OBJECTS 106
380 #define EC_R_INVALID_COMPRESSED_POINT 107
381 #define EC_R_INVALID_COMPRESSION_BIT 108
382 #define EC_R_INVALID_ENCODING 109
383 #define EC_R_INVALID_FIELD 110
384 #define EC_R_INVALID_FORM 111
385 #define EC_R_INVALID_GROUP_ORDER 112
386 #define EC_R_INVALID_PRIVATE_KEY 113
387 #define EC_R_MISSING_PARAMETERS 114
388 #define EC_R_MISSING_PRIVATE_KEY 115
389 #define EC_R_NON_NAMED_CURVE 116
390 #define EC_R_NOT_INITIALIZED 117
391 #define EC_R_PKPARAMETERS2GROUP_FAILURE 118
392 #define EC_R_POINT_AT_INFINITY 119
393 #define EC_R_POINT_IS_NOT_ON_CURVE 120
394 #define EC_R_SLOT_FULL 121
395 #define EC_R_UNDEFINED_GENERATOR 122
396 #define EC_R_UNKNOWN_GROUP 123
397 #define EC_R_UNKNOWN_ORDER 124
398 #define EC_R_WRONG_ORDER 125
399 #define EC_R_BIGNUM_OUT_OF_RANGE 126
400 #define EC_R_WRONG_CURVE_PARAMETERS 127
401 #define EC_R_DECODE_ERROR 128
402 #define EC_R_ENCODE_ERROR 129
403 #define EC_R_GROUP_MISMATCH 130
404
405 #endif /* OPENSSL_HEADER_EC_H */