2 /* ====================================================================
3 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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
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/)"
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 * openssl-core@openssl.org.
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.
31 * 6. Redistributions of any form whatsoever must retain the following
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
50 * This product includes cryptographic software written by Eric Young
51 * (eay@cryptsoft.com). This product includes software written by Tim
52 * Hudson (tjh@cryptsoft.com).
59 #include <openssl/bn.h>
68 /* values as defined in X9.62 (ECDSA) and elsewhere */
69 POINT_CONVERSION_COMPRESSED = 2,
70 POINT_CONVERSION_UNCOMPRESSED = 4,
71 POINT_CONVERSION_HYBRID = 6
72 } point_conversion_form_t;
75 typedef struct ec_method_st EC_METHOD;
77 typedef struct ec_group_st
82 -- optional generator with associated information (order, cofactor)
83 -- optional Lim/Lee precomputation table
87 typedef struct ec_point_st EC_POINT;
90 /* EC_METHODs for curves over GF(p).
91 * EC_GFp_simple_method provides the basis for the optimized methods.
94 const EC_METHOD *EC_GFp_simple_method(void);
95 const EC_METHOD *EC_GFp_mont_method(void);
96 const EC_METHOD *EC_GFp_recp_method(void);
97 const EC_METHOD *EC_GFp_nist_method(void);
100 EC_GROUP *EC_GROUP_new(const EC_METHOD *);
101 /* We don't have types for field specifications and field elements in general.
102 * Otherwise we would declare
103 * int EC_GROUP_set_curve(EC_GROUP *, .....);
105 int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
106 void EC_GROUP_free(EC_GROUP *);
107 void EC_GROUP_clear_free(EC_GROUP *);
108 int EC_GROUP_copy(EC_GROUP *, const EC_GROUP*);
110 /* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
111 * after choosing an appropriate EC_METHOD */
112 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
114 int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
116 /* TODO: 'set' and 'get' functions for EC_GROUPs */
119 EC_POINT *EC_POINT_new(const EC_GROUP *);
120 void EC_POINT_free(EC_POINT *);
121 void EC_POINT_clear_free(EC_POINT *);
122 int EC_POINT_copy(EC_POINT *, const EC_POINT *);
124 int EC_POINT_set_to_infinity(const EC_GROUP *, EC_POINT *);
125 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *, EC_POINT *,
126 const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
127 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
128 BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
129 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *, EC_POINT *,
130 const BIGNUM *x, const BIGNUM *y, BN_CTX *);
131 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
132 BIGNUM *x, BIGNUM *y, BN_CTX *);
133 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *, EC_POINT *,
134 const BIGNUM *x, int y_bit, BN_CTX *);
136 size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
137 unsigned char *buf, size_t len, BN_CTX *);
138 int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
139 const unsigned char *buf, size_t len, BN_CTX *);
141 int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
142 int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
143 int EC_POINT_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
145 int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
146 int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
147 int EC_POINT_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
149 int EC_POINT_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
153 /* TODO: scalar multiplication */
157 /* BEGIN ERROR CODES */
158 /* The following lines are auto generated by the script mkerr.pl. Any changes
159 * made after this point may be overwritten when the script is next run.
162 /* Error codes for the EC functions. */
164 /* Function codes. */
165 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP 127
166 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR 100
167 #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE 101
168 #define EC_F_EC_GFP_SIMPLE_OCT2POINT 102
169 #define EC_F_EC_GFP_SIMPLE_POINT2OCT 103
170 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 104
171 #define EC_F_EC_GROUP_COPY 105
172 #define EC_F_EC_GROUP_GET_EXTRA_DATA 106
173 #define EC_F_EC_GROUP_NEW 107
174 #define EC_F_EC_GROUP_SET_CURVE_GFP 108
175 #define EC_F_EC_GROUP_SET_EXTRA_DATA 109
176 #define EC_F_EC_GROUP_SET_GENERATOR 110
177 #define EC_F_EC_POINT_ADD 111
178 #define EC_F_EC_POINT_CMP 123
179 #define EC_F_EC_POINT_COPY 112
180 #define EC_F_EC_POINT_DBL 113
181 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP 114
182 #define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP 124
183 #define EC_F_EC_POINT_IS_AT_INFINITY 115
184 #define EC_F_EC_POINT_IS_ON_CURVE 116
185 #define EC_F_EC_POINT_MAKE_AFFINE 117
186 #define EC_F_EC_POINT_NEW 118
187 #define EC_F_EC_POINT_OCT2POINT 119
188 #define EC_F_EC_POINT_POINT2OCT 120
189 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP 121
190 #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP 125
191 #define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP 126
192 #define EC_F_EC_POINT_SET_TO_INFINITY 122
195 #define EC_R_BUFFER_TOO_SMALL 100
196 #define EC_R_INCOMPATIBLE_OBJECTS 101
197 #define EC_R_INVALID_ENCODING 102
198 #define EC_R_INVALID_FIELD 108
199 #define EC_R_INVALID_FORM 103
200 #define EC_R_NO_SUCH_EXTRA_DATA 104
201 #define EC_R_POINT_AT_INFINITY 105
202 #define EC_R_POINT_IS_NOT_ON_CURVE 106
203 #define EC_R_SLOT_FULL 107