crypto/ec/ec.h

   1 /* crypto/ec/ec.h */
   2 /* ====================================================================
   3  * Copyright (c) 1998-2002 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 #ifndef HEADER_EC_H
  57 #define HEADER_EC_H
  58
  59 #ifdef OPENSSL_NO_EC
  60 #error EC is disabled.
  61 #endif
  62
  63 #include <openssl/bn.h>
  64 #include <openssl/symhacks.h>
  65
  66 #ifdef  __cplusplus
  67 extern "C" {
  68 #endif
  69
  70
  71 typedef enum {
  72         /* values as defined in X9.62 (ECDSA) and elsewhere */
  73         POINT_CONVERSION_COMPRESSED = 2,
  74         POINT_CONVERSION_UNCOMPRESSED = 4,
  75         POINT_CONVERSION_HYBRID = 6
  76 } point_conversion_form_t;
  77
  78
  79 typedef struct ec_method_st EC_METHOD;
  80
  81 typedef struct ec_group_st
  82         /*
  83          EC_METHOD *meth;
  84          -- field definition
  85          -- curve coefficients
  86          -- optional generator with associated information (order, cofactor)
  87          -- optional extra data (TODO: precomputed table for fast computation of multiples of generator)
  88         */
  89         EC_GROUP;
  90
  91 typedef struct ec_point_st EC_POINT;
  92
  93
  94 /* EC_METHODs for curves over GF(p).
  95  * EC_GFp_simple_method provides the basis for the optimized methods.
  96  */
  97 const EC_METHOD *EC_GFp_simple_method(void);
  98 const EC_METHOD *EC_GFp_mont_method(void);
  99 #if 0
 100 const EC_METHOD *EC_GFp_recp_method(void); /* TODO */
 101 const EC_METHOD *EC_GFp_nist_method(void); /* TODO */
 102 #endif
 103
 104
 105 EC_GROUP *EC_GROUP_new(const EC_METHOD *);
 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 *);
 109
 110 void EC_GROUP_set_nid(EC_GROUP *, int);
 111 int EC_GROUP_get_nid(const EC_GROUP *);
 112
 113 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *);
 114
 115
 116 /* We don't have types for field specifications and field elements in general.
 117  * Otherwise we could declare
 118  *     int EC_GROUP_set_curve(EC_GROUP *, .....);
 119  */
 120 int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 121 int EC_GROUP_get_curve_GFp(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
 122
 123 int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
 124 EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *);
 125 int EC_GROUP_get_order(const EC_GROUP *, BIGNUM *order, BN_CTX *);
 126 int EC_GROUP_get_cofactor(const EC_GROUP *, BIGNUM *cofactor, BN_CTX *);
 127
 128 /* EC_GROUP_check() returns 1 if 'group' defines a valid group, 0 otherwise */
 129 int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
 130 /* EC_GROUP_check_discriminant() returns 1 if the discriminant of the
 131  * elliptic curve is not zero, 0 otherwise */
 132 int EC_GROUP_check_discriminant(const EC_GROUP *, BN_CTX *);
 133
 134 /* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
 135  * after choosing an appropriate EC_METHOD */
 136 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 137
 138 /* EC_GROUP_new_by_nid() and EC_GROUP_new_by_name() also set
 139  * generator and order */
 140 EC_GROUP *EC_GROUP_new_by_nid(int nid);
 141 EC_GROUP *EC_GROUP_new_by_name(int name);
 142 /* Currently valid arguments to EC_GROUP_new_by_name() */
 143 #define EC_GROUP_NO_CURVE               0
 144 #define EC_GROUP_NIST_PRIME_192         NID_secp192r1
 145 #define EC_GROUP_NIST_PRIME_224         NID_secp224r1
 146 #define EC_GROUP_NIST_PRIME_256         NID_secp256r1
 147 #define EC_GROUP_NIST_PRIME_384         NID_secp384r1
 148 #define EC_GROUP_NIST_PRIME_521         NID_secp521r1
 149 #define EC_GROUP_X9_62_PRIME_192V1      NID_X9_62_prime192v1
 150 #define EC_GROUP_X9_62_PRIME_192V2      NID_X9_62_prime192v2
 151 #define EC_GROUP_X9_62_PRIME_192V3      NID_X9_62_prime192v3
 152 #define EC_GROUP_X9_62_PRIME_239V1      NID_X9_62_prime239v1
 153 #define EC_GROUP_X9_62_PRIME_239V2      NID_X9_62_prime239v2
 154 #define EC_GROUP_X9_62_PRIME_239V3      NID_X9_62_prime239v3
 155 #define EC_GROUP_X9_62_PRIME_256V1      NID_X9_62_prime256v1
 156 #define EC_GROUP_SECG_PRIME_112R1       NID_secp112r1
 157 #define EC_GROUP_SECG_PRIME_112R2       NID_secp112r2
 158 #define EC_GROUP_SECG_PRIME_128R1       NID_secp128r1
 159 #define EC_GROUP_SECG_PRIME_128R2       NID_secp128r2
 160 #define EC_GROUP_SECG_PRIME_160K1       NID_secp160k1
 161 #define EC_GROUP_SECG_PRIME_160R1       NID_secp160r1
 162 #define EC_GROUP_SECG_PRIME_160R2       NID_secp160r2
 163 #define EC_GROUP_SECG_PRIME_192K1       NID_secp192k1
 164 #define EC_GROUP_SECG_PRIME_192R1       NID_secp192r1
 165 #define EC_GROUP_SECG_PRIME_224K1       NID_secp224k1
 166 #define EC_GROUP_SECG_PRIME_224R1       NID_secp224r1
 167 #define EC_GROUP_SECG_PRIME_256K1       NID_secp256k1
 168 #define EC_GROUP_SECG_PRIME_256R1       NID_secp256r1
 169 #define EC_GROUP_SECG_PRIME_384R1       NID_secp384r1
 170 #define EC_GROUP_SECG_PRIME_521R1       NID_secp521r1
 171 #define EC_GROUP_WTLS_6                 NID_wap_wsg_idm_ecid_wtls6
 172 #define EC_GROUP_WTLS_7                 NID_secp160r1
 173 #define EC_GROUP_WTLS_8                 NID_wap_wsg_idm_ecid_wtls8
 174 #define EC_GROUP_WTLS_9                 NID_wap_wsg_idm_ecid_wtls9
 175 #define EC_GROUP_WTLS_12                NID_secp224r1
 176
 177 EC_POINT *EC_POINT_new(const EC_GROUP *);
 178 void EC_POINT_free(EC_POINT *);
 179 void EC_POINT_clear_free(EC_POINT *);
 180 int EC_POINT_copy(EC_POINT *, const EC_POINT *);
 181
 182 const EC_METHOD *EC_POINT_method_of(const EC_POINT *);
 183
 184 int EC_POINT_set_to_infinity(const EC_GROUP *, EC_POINT *);
 185 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *, EC_POINT *,
 186         const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
 187 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
 188         BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
 189 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *, EC_POINT *,
 190         const BIGNUM *x, const BIGNUM *y, BN_CTX *);
 191 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
 192         BIGNUM *x, BIGNUM *y, BN_CTX *);
 193 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *, EC_POINT *,
 194         const BIGNUM *x, int y_bit, BN_CTX *);
 195
 196 size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
 197         unsigned char *buf, size_t len, BN_CTX *);
 198 int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
 199         const unsigned char *buf, size_t len, BN_CTX *);
 200
 201 int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 202 int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
 203 int EC_POINT_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
 204
 205 int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
 206 int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
 207 int EC_POINT_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 208
 209 int EC_POINT_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
 210 int EC_POINTs_make_affine(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *);
 211
 212
 213 int EC_POINTs_mul(const EC_GROUP *, EC_POINT *r, const BIGNUM *, size_t num, const EC_POINT *[], const BIGNUM *[], BN_CTX *);
 214 int EC_POINT_mul(const EC_GROUP *, EC_POINT *r, const BIGNUM *, const EC_POINT *, const BIGNUM *, BN_CTX *);
 215 int EC_GROUP_precompute_mult(EC_GROUP *, BN_CTX *);
 216
 217
 218
 219 /* BEGIN ERROR CODES */
 220 /* The following lines are auto generated by the script mkerr.pl. Any changes
 221  * made after this point may be overwritten when the script is next run.
 222  */
 223 void ERR_load_EC_strings(void);
 224
 225 /* Error codes for the EC functions. */
 226
 227 /* Function codes. */
 228 #define EC_F_COMPUTE_WNAF                                143
 229 #define EC_F_EC_GFP_MONT_FIELD_DECODE                    133
 230 #define EC_F_EC_GFP_MONT_FIELD_ENCODE                    134
 231 #define EC_F_EC_GFP_MONT_FIELD_MUL                       131
 232 #define EC_F_EC_GFP_MONT_FIELD_SQR                       132
 233 #define EC_F_EC_GFP_SIMPLE_GROUP_CHECK_DISCRIMINANT      152
 234 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP           100
 235 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR           101
 236 #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE                   102
 237 #define EC_F_EC_GFP_SIMPLE_OCT2POINT                     103
 238 #define EC_F_EC_GFP_SIMPLE_POINT2OCT                     104
 239 #define EC_F_EC_GFP_SIMPLE_POINTS_MAKE_AFFINE            137
 240 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105
 241 #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128
 242 #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129
 243 #define EC_F_EC_GROUP_CHECK                              150
 244 #define EC_F_EC_GROUP_CHECK_DISCRIMINANT                 153
 245 #define EC_F_EC_GROUP_COPY                               106
 246 #define EC_F_EC_GROUP_GET0_GENERATOR                     139
 247 #define EC_F_EC_GROUP_GET_COFACTOR                       140
 248 #define EC_F_EC_GROUP_GET_CURVE_GFP                      130
 249 #define EC_F_EC_GROUP_GET_EXTRA_DATA                     107
 250 #define EC_F_EC_GROUP_GET_ORDER                          141
 251 #define EC_F_EC_GROUP_GROUP2NID                          147
 252 #define EC_F_EC_GROUP_NEW                                108
 253 #define EC_F_EC_GROUP_NEW_BY_NAME                        144
 254 #define EC_F_EC_GROUP_NEW_BY_NID                         146
 255 #define EC_F_EC_GROUP_NEW_GFP_FROM_HEX                   148
 256 #define EC_F_EC_GROUP_PRECOMPUTE_MULT                    142
 257 #define EC_F_EC_GROUP_SET_CURVE_GFP                      109
 258 #define EC_F_EC_GROUP_SET_EXTRA_DATA                     110
 259 #define EC_F_EC_GROUP_SET_GENERATOR                      111
 260 #define EC_F_EC_POINTS_MAKE_AFFINE                       136
 261 #define EC_F_EC_POINTS_MUL                               138
 262 #define EC_F_EC_POINT_ADD                                112
 263 #define EC_F_EC_POINT_CMP                                113
 264 #define EC_F_EC_POINT_COPY                               114
 265 #define EC_F_EC_POINT_DBL                                115
 266 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP         116
 267 #define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP    117
 268 #define EC_F_EC_POINT_IS_AT_INFINITY                     118
 269 #define EC_F_EC_POINT_IS_ON_CURVE                        119
 270 #define EC_F_EC_POINT_MAKE_AFFINE                        120
 271 #define EC_F_EC_POINT_NEW                                121
 272 #define EC_F_EC_POINT_OCT2POINT                          122
 273 #define EC_F_EC_POINT_POINT2OCT                          123
 274 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP         124
 275 #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP     125
 276 #define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP    126
 277 #define EC_F_EC_POINT_SET_TO_INFINITY                    127
 278 #define EC_F_GFP_MONT_GROUP_SET_CURVE_GFP                135
 279
 280 /* Reason codes. */
 281 #define EC_R_BUFFER_TOO_SMALL                            100
 282 #define EC_R_DISCRIMINANT_IS_ZERO                        118
 283 #define EC_R_INCOMPATIBLE_OBJECTS                        101
 284 #define EC_R_INVALID_ARGUMENT                            112
 285 #define EC_R_INVALID_COMPRESSED_POINT                    110
 286 #define EC_R_INVALID_COMPRESSION_BIT                     109
 287 #define EC_R_INVALID_ENCODING                            102
 288 #define EC_R_INVALID_FIELD                               103
 289 #define EC_R_INVALID_FORM                                104
 290 #define EC_R_INVALID_GROUP_ORDER                         119
 291 #define EC_R_NOT_INITIALIZED                             111
 292 #define EC_R_NO_SUCH_EXTRA_DATA                          105
 293 #define EC_R_POINT_AT_INFINITY                           106
 294 #define EC_R_POINT_IS_NOT_ON_CURVE                       107
 295 #define EC_R_SLOT_FULL                                   108
 296 #define EC_R_UNDEFINED_GENERATOR                         113
 297 #define EC_R_UNDEFINED_ORDER                             122
 298 #define EC_R_UNKNOWN_GROUP                               116
 299 #define EC_R_UNKNOWN_NID                                 117
 300 #define EC_R_UNKNOWN_ORDER                               114
 301
 302 #ifdef  __cplusplus
 303 }
 304 #endif
 305 #endif