ec.h revision 217eaab310220731646f2a1a0159d71e4eb09d4a
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 * openssl-core@openssl.org. 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 * (eay@cryptsoft.com). This product includes software written by Tim 52 * Hudson (tjh@cryptsoft.com). 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) 74extern "C" { 75#endif 76 77 78/* Low-level operations on elliptic curves. */ 79 80 81typedef struct ec_group_st EC_GROUP; 82typedef struct ec_point_st EC_POINT; 83 84/** Enum for the point conversion form as defined in X9.62 (ECDSA) 85 * for the encoding of a elliptic curve point (x,y) */ 86typedef enum { 87 /** the point is encoded as z||x, where the octet z specifies 88 * which solution of the quadratic equation y is */ 89 POINT_CONVERSION_COMPRESSED = 2, 90 /** the point is encoded as z||x||y, where z is the octet 0x02 */ 91 POINT_CONVERSION_UNCOMPRESSED = 4 92} point_conversion_form_t; 93 94 95/* Elliptic curve groups. */ 96 97/* EC_GROUP_new_by_curve_name returns a fresh EC_GROUP object for the elliptic 98 * curve specified by |nid|, or NULL on error. 99 * 100 * The supported NIDs are: 101 * NID_secp224r1, 102 * NID_X9_62_prime256v1, 103 * NID_secp384r1, 104 * NID_secp521r1 */ 105OPENSSL_EXPORT EC_GROUP *EC_GROUP_new_by_curve_name(int nid); 106 107/* EC_GROUP_free frees |group| and the data that it points to. */ 108OPENSSL_EXPORT void EC_GROUP_free(EC_GROUP *group); 109 110/* EC_GROUP_copy sets |*dest| equal to |*src|. It returns one on success and 111 * zero otherwise. */ 112OPENSSL_EXPORT int EC_GROUP_copy(EC_GROUP *dest, const EC_GROUP *src); 113 114/* EC_GROUP_dup returns a fresh |EC_GROUP| which is equal to |a| or NULL on 115 * error. */ 116OPENSSL_EXPORT EC_GROUP *EC_GROUP_dup(const EC_GROUP *a); 117 118/* EC_GROUP_cmp returns zero if |a| and |b| are the same group and non-zero 119 * otherwise. */ 120OPENSSL_EXPORT int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, 121 BN_CTX *ignored); 122 123/* EC_GROUP_get0_generator returns a pointer to the internal |EC_POINT| object 124 * in |group| that specifies the generator for the group. */ 125OPENSSL_EXPORT const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group); 126 127/* EC_GROUP_get_order sets |*order| to the order of |group|, if it's not 128 * NULL. It returns one on success and zero otherwise. |ctx| is ignored. */ 129OPENSSL_EXPORT int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, 130 BN_CTX *ctx); 131 132/* EC_GROUP_get_cofactor sets |*cofactor| to the cofactor of |group| using 133 * |ctx|, if it's not NULL. It returns one on success and zero otherwise. */ 134OPENSSL_EXPORT int EC_GROUP_get_cofactor(const EC_GROUP *group, 135 BIGNUM *cofactor, BN_CTX *ctx); 136 137/* EC_GROUP_get_curve_GFp gets various parameters about a group. It sets 138 * |*out_p| to the order of the coordinate field and |*out_a| and |*out_b| to 139 * the parameters of the curve when expressed as y² = x³ + ax + b. Any of the 140 * output parameters can be NULL. It returns one on success and zero on 141 * error. */ 142OPENSSL_EXPORT int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *out_p, 143 BIGNUM *out_a, BIGNUM *out_b, 144 BN_CTX *ctx); 145 146/* EC_GROUP_get_curve_name returns a NID that identifies |group|. */ 147OPENSSL_EXPORT int EC_GROUP_get_curve_name(const EC_GROUP *group); 148 149/* EC_GROUP_get_degree returns the number of bits needed to represent an 150 * element of the field underlying |group|. */ 151OPENSSL_EXPORT int EC_GROUP_get_degree(const EC_GROUP *group); 152 153/* EC_GROUP_precompute_mult precomputes multiplies of the generator in order to 154 * speed up operations that involve calculating generator multiples. It returns 155 * one on sucess and zero otherwise. If |ctx| is not NULL, it may be used. */ 156OPENSSL_EXPORT int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx); 157 158/* EC_GROUP_have_precompute_mult returns one if |group| contains precomputed 159 * generator multiples. */ 160OPENSSL_EXPORT int EC_GROUP_have_precompute_mult(const EC_GROUP *group); 161 162 163/* Points on elliptic curves. */ 164 165/* EC_POINT_new returns a fresh |EC_POINT| object in the given group, or NULL 166 * on error. */ 167OPENSSL_EXPORT EC_POINT *EC_POINT_new(const EC_GROUP *group); 168 169/* EC_POINT_free frees |point| and the data that it points to. */ 170OPENSSL_EXPORT void EC_POINT_free(EC_POINT *point); 171 172/* EC_POINT_clear_free clears the data that |point| points to, frees it and 173 * then frees |point| itself. */ 174OPENSSL_EXPORT void EC_POINT_clear_free(EC_POINT *point); 175 176/* EC_POINT_copy sets |*dest| equal to |*src|. It returns one on success and 177 * zero otherwise. */ 178OPENSSL_EXPORT int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src); 179 180/* EC_POINT_dup returns a fresh |EC_POINT| that contains the same values as 181 * |src|, or NULL on error. */ 182OPENSSL_EXPORT EC_POINT *EC_POINT_dup(const EC_POINT *src, 183 const EC_GROUP *group); 184 185/* EC_POINT_set_to_infinity sets |point| to be the "point at infinity" for the 186 * given group. */ 187OPENSSL_EXPORT int EC_POINT_set_to_infinity(const EC_GROUP *group, 188 EC_POINT *point); 189 190/* EC_POINT_is_at_infinity returns one iff |point| is the point at infinity and 191 * zero otherwise. */ 192OPENSSL_EXPORT int EC_POINT_is_at_infinity(const EC_GROUP *group, 193 const EC_POINT *point); 194 195/* EC_POINT_is_on_curve returns one if |point| is an element of |group| and 196 * zero otheriwse. If |ctx| is non-NULL, it may be used. */ 197OPENSSL_EXPORT int EC_POINT_is_on_curve(const EC_GROUP *group, 198 const EC_POINT *point, BN_CTX *ctx); 199 200/* EC_POINT_cmp returns zero if |a| is equal to |b|, greater than zero is 201 * non-equal and -1 on error. If |ctx| is not NULL, it may be used. */ 202OPENSSL_EXPORT int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, 203 const EC_POINT *b, BN_CTX *ctx); 204 205/* EC_POINT_make_affine converts |point| to affine form, internally. It returns 206 * one on success and zero otherwise. If |ctx| is not NULL, it may be used. */ 207OPENSSL_EXPORT int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, 208 BN_CTX *ctx); 209 210/* EC_POINTs_make_affine converts |num| points from |points| to affine form, 211 * internally. It returns one on success and zero otherwise. If |ctx| is not 212 * NULL, it may be used. */ 213OPENSSL_EXPORT int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, 214 EC_POINT *points[], BN_CTX *ctx); 215 216 217/* Point conversion. */ 218 219/* EC_POINT_get_affine_coordinates_GFp sets |x| and |y| to the affine value of 220 * |point| using |ctx|, if it's not NULL. It returns one on success and zero 221 * otherwise. */ 222OPENSSL_EXPORT int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, 223 const EC_POINT *point, 224 BIGNUM *x, BIGNUM *y, 225 BN_CTX *ctx); 226 227/* EC_POINT_set_affine_coordinates sets the value of |p| to be (|x|, |y|). The 228 * |ctx| argument may be used if not NULL. */ 229OPENSSL_EXPORT int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, 230 EC_POINT *point, 231 const BIGNUM *x, 232 const BIGNUM *y, 233 BN_CTX *ctx); 234 235/* EC_POINT_point2oct serialises |point| into the X9.62 form given by |form| 236 * into, at most, |len| bytes at |buf|. It returns the number of bytes written 237 * or zero on error if |buf| is non-NULL, else the number of bytes needed. The 238 * |ctx| argument may be used if not NULL. */ 239OPENSSL_EXPORT size_t EC_POINT_point2oct(const EC_GROUP *group, 240 const EC_POINT *point, 241 point_conversion_form_t form, 242 uint8_t *buf, size_t len, BN_CTX *ctx); 243 244/* EC_POINT_oct2point sets |point| from |len| bytes of X9.62 format 245 * serialisation in |buf|. It returns one on success and zero otherwise. The 246 * |ctx| argument may be used if not NULL. */ 247OPENSSL_EXPORT int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point, 248 const uint8_t *buf, size_t len, 249 BN_CTX *ctx); 250 251/* EC_POINT_set_compressed_coordinates_GFp sets |point| to equal the point with 252 * the given |x| coordinate and the y coordinate specified by |y_bit| (see 253 * X9.62). It returns one on success and zero otherwise. */ 254OPENSSL_EXPORT int EC_POINT_set_compressed_coordinates_GFp( 255 const EC_GROUP *group, EC_POINT *point, const BIGNUM *x, int y_bit, 256 BN_CTX *ctx); 257 258 259/* Group operations. */ 260 261/* EC_POINT_add sets |r| equal to |a| plus |b|. It returns one on success and 262 * zero otherwise. If |ctx| is not NULL, it may be used. */ 263OPENSSL_EXPORT int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, 264 const EC_POINT *a, const EC_POINT *b, 265 BN_CTX *ctx); 266 267/* EC_POINT_dbl sets |r| equal to |a| plus |a|. It returns one on success and 268 * zero otherwise. If |ctx| is not NULL, it may be used. */ 269OPENSSL_EXPORT int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, 270 const EC_POINT *a, BN_CTX *ctx); 271 272/* EC_POINT_dbl sets |a| equal to minus |a|. It returns one on success and zero 273 * otherwise. If |ctx| is not NULL, it may be used. */ 274OPENSSL_EXPORT int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, 275 BN_CTX *ctx); 276 277/* EC_POINT_mul sets r = generator*n + q*m. It returns one on success and zero 278 * otherwise. If |ctx| is not NULL, it may be used. */ 279OPENSSL_EXPORT int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, 280 const BIGNUM *n, const EC_POINT *q, 281 const BIGNUM *m, BN_CTX *ctx); 282 283/* EC_POINTs_mul sets r = generator*n + sum(p[i]*m[i]). It returns one on 284 * success and zero otherwise. If |ctx| is not NULL, it may be used. */ 285OPENSSL_EXPORT int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, 286 const BIGNUM *n, size_t num, 287 const EC_POINT *p[], const BIGNUM *m[], 288 BN_CTX *ctx); 289 290 291/* Deprecated functions. */ 292 293/* EC_GROUP_set_asn1_flag does nothing. */ 294OPENSSL_EXPORT void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag); 295 296#define OPENSSL_EC_NAMED_CURVE 0 297 298typedef struct ec_method_st EC_METHOD; 299 300/* EC_GROUP_method_of returns NULL. */ 301OPENSSL_EXPORT const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group); 302 303/* EC_METHOD_get_field_type returns NID_X9_62_prime_field. */ 304OPENSSL_EXPORT int EC_METHOD_get_field_type(const EC_METHOD *meth); 305 306/* EC_GROUP_set_point_conversion_form aborts the process if |form| is not 307 * |POINT_CONVERSION_UNCOMPRESSED| and otherwise does nothing. */ 308OPENSSL_EXPORT void EC_GROUP_set_point_conversion_form( 309 EC_GROUP *group, point_conversion_form_t form); 310 311 312/* Old code expects to get EC_KEY from ec.h. */ 313#if !defined(OPENSSL_HEADER_EC_KEY_H) 314#include <openssl/ec_key.h> 315#endif 316 317 318#if defined(__cplusplus) 319} /* extern C */ 320#endif 321 322#define EC_F_ec_pre_comp_new 100 323#define EC_F_ec_GFp_mont_field_decode 101 324#define EC_F_ec_group_new_from_data 102 325#define EC_F_ec_GFp_simple_point_get_affine_coordinates 103 326#define EC_F_ec_GFp_simple_make_affine 104 327#define EC_F_EC_KEY_new_method 105 328#define EC_F_ec_GFp_mont_field_encode 106 329#define EC_F_EC_GROUP_new_by_curve_name 107 330#define EC_F_ec_group_new 108 331#define EC_F_ec_asn1_group2pkparameters 109 332#define EC_F_EC_POINT_set_compressed_coordinates_GFp 110 333#define EC_F_ec_GFp_mont_field_sqr 111 334#define EC_F_EC_POINT_make_affine 112 335#define EC_F_i2d_ECParameters 113 336#define EC_F_ec_wNAF_mul 114 337#define EC_F_EC_GROUP_copy 115 338#define EC_F_EC_POINT_cmp 116 339#define EC_F_ec_GFp_mont_field_mul 117 340#define EC_F_EC_POINT_dup 118 341#define EC_F_EC_POINT_invert 119 342#define EC_F_ec_GFp_simple_point_set_affine_coordinates 120 343#define EC_F_ec_GFp_simple_points_make_affine 121 344#define EC_F_i2o_ECPublicKey 122 345#define EC_F_EC_KEY_check_key 123 346#define EC_F_ec_wNAF_precompute_mult 124 347#define EC_F_EC_POINT_oct2point 125 348#define EC_F_EC_POINT_is_at_infinity 126 349#define EC_F_EC_POINT_get_affine_coordinates_GFp 127 350#define EC_F_ec_point_set_Jprojective_coordinates_GFp 128 351#define EC_F_o2i_ECPublicKey 129 352#define EC_F_ec_GFp_mont_field_set_to_one 130 353#define EC_F_ec_group_new_curve_GFp 131 354#define EC_F_EC_POINT_dbl 132 355#define EC_F_ec_asn1_pkparameters2group 133 356#define EC_F_i2d_ECPKParameters 134 357#define EC_F_EC_KEY_copy 135 358#define EC_F_EC_POINT_new 136 359#define EC_F_EC_POINT_point2oct 137 360#define EC_F_EC_POINT_copy 138 361#define EC_F_EC_POINT_is_on_curve 139 362#define EC_F_ec_GFp_simple_group_set_curve 140 363#define EC_F_i2d_ECPrivateKey 141 364#define EC_F_d2i_ECParameters 142 365#define EC_F_ec_GFp_mont_group_set_curve 143 366#define EC_F_EC_POINT_set_to_infinity 144 367#define EC_F_EC_POINTs_make_affine 145 368#define EC_F_compute_wNAF 146 369#define EC_F_ec_GFp_simple_point2oct 147 370#define EC_F_EC_GROUP_get_degree 148 371#define EC_F_ec_GFp_simple_group_check_discriminant 149 372#define EC_F_d2i_ECPKParameters 150 373#define EC_F_d2i_ECPrivateKey 151 374#define EC_F_ec_GFp_simple_oct2point 152 375#define EC_F_EC_POINT_set_affine_coordinates_GFp 153 376#define EC_F_EC_KEY_set_public_key_affine_coordinates 154 377#define EC_F_EC_KEY_generate_key 155 378#define EC_F_ec_GFp_simple_set_compressed_coordinates 156 379#define EC_F_EC_POINT_add 157 380#define EC_F_EC_GROUP_get_curve_GFp 158 381#define EC_R_PKPARAMETERS2GROUP_FAILURE 100 382#define EC_R_NON_NAMED_CURVE 101 383#define EC_R_COORDINATES_OUT_OF_RANGE 102 384#define EC_R_POINT_AT_INFINITY 103 385#define EC_R_NOT_INITIALIZED 104 386#define EC_R_MISSING_PRIVATE_KEY 105 387#define EC_R_GROUP2PKPARAMETERS_FAILURE 106 388#define EC_R_INVALID_ENCODING 107 389#define EC_R_BUFFER_TOO_SMALL 108 390#define EC_R_D2I_ECPKPARAMETERS_FAILURE 109 391#define EC_R_INVALID_FORM 110 392#define EC_R_INVALID_PRIVATE_KEY 111 393#define EC_R_INVALID_COMPRESSED_POINT 112 394#define EC_R_MISSING_PARAMETERS 113 395#define EC_R_INVALID_FIELD 114 396#define EC_R_INVALID_COMPRESSION_BIT 115 397#define EC_R_GF2M_NOT_SUPPORTED 116 398#define EC_R_POINT_IS_NOT_ON_CURVE 117 399#define EC_R_UNKNOWN_ORDER 118 400#define EC_R_UNKNOWN_GROUP 119 401#define EC_R_WRONG_ORDER 120 402#define EC_R_UNDEFINED_GENERATOR 121 403#define EC_R_INCOMPATIBLE_OBJECTS 122 404#define EC_R_I2D_ECPKPARAMETERS_FAILURE 123 405#define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE 124 406#define EC_R_INVALID_GROUP_ORDER 125 407#define EC_R_SLOT_FULL 126 408 409#endif /* OPENSSL_HEADER_EC_H */ 410