crypto/ec/ec.h

   1 /* crypto/ec/ec.h */
   2 /* ====================================================================
   3  * Copyright (c) 1998-2001 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 Elliptic curves are 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 (Lim/Lee precomputation table)
  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
  98 const EC_METHOD *EC_GFp_simple_method(void);
  99 const EC_METHOD *EC_GFp_mont_method(void);
 100 const EC_METHOD *EC_GFp_recp_method(void);
 101 const EC_METHOD *EC_GFp_nist_method(void);
 102
 103
 104 EC_GROUP *EC_GROUP_new(const EC_METHOD *);
 105 /* We don't have types for field specifications and field elements in general.
 106  * Otherwise we would declare
 107  *     int EC_GROUP_set_curve(EC_GROUP *, .....);
 108  */
 109 void EC_GROUP_free(EC_GROUP *);
 110 void EC_GROUP_clear_free(EC_GROUP *);
 111 int EC_GROUP_copy(EC_GROUP *, const EC_GROUP*);
 112 int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 113 int EC_GROUP_get_curve_GFp(EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
 114
 115 /* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
 116  * after choosing an appropriate EC_METHOD */
 117 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 118
 119 int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
 120 EC_POINT *EC_group_get0_generator(EC_GROUP *);
 121 int EC_GROUP_get_order(EC_GROUP *, BIGNUM *order, BN_CTX *);
 122 int EC_GROUP_get_cofactor(EC_GROUP *, BIGNUM *cofactor, BN_CTX *);
 123
 124 EC_POINT *EC_POINT_new(const EC_GROUP *);
 125 void EC_POINT_free(EC_POINT *);
 126 void EC_POINT_clear_free(EC_POINT *);
 127 int EC_POINT_copy(EC_POINT *, const EC_POINT *);
 128
 129 int EC_POINT_set_to_infinity(const EC_GROUP *, EC_POINT *);
 130 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *, EC_POINT *,
 131         const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
 132 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
 133         BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
 134 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *, EC_POINT *,
 135         const BIGNUM *x, const BIGNUM *y, BN_CTX *);
 136 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
 137         BIGNUM *x, BIGNUM *y, BN_CTX *);
 138 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *, EC_POINT *,
 139         const BIGNUM *x, int y_bit, BN_CTX *);
 140
 141 size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
 142         unsigned char *buf, size_t len, BN_CTX *);
 143 int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
 144         const unsigned char *buf, size_t len, BN_CTX *);
 145
 146 int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 147 int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
 148 int EC_POINT_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
 149
 150 int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
 151 int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
 152 int EC_POINT_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 153
 154 int EC_POINT_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
 155
 156
 157
 158 /* TODO: scalar multiplication */
 159
 160
 161
 162 /* BEGIN ERROR CODES */
 163 /* The following lines are auto generated by the script mkerr.pl. Any changes
 164  * made after this point may be overwritten when the script is next run.
 165  */
 166 void ERR_load_EC_strings(void);
 167
 168 /* Error codes for the EC functions. */
 169
 170 /* Function codes. */
 171 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP           100
 172 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR           101
 173 #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE                   102
 174 #define EC_F_EC_GFP_SIMPLE_OCT2POINT                     103
 175 #define EC_F_EC_GFP_SIMPLE_POINT2OCT                     104
 176 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105
 177 #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128
 178 #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129
 179 #define EC_F_EC_GROUP_COPY                               106
 180 #define EC_F_EC_GROUP_GET_CURVE_GFP                      130
 181 #define EC_F_EC_GROUP_GET_EXTRA_DATA                     107
 182 #define EC_F_EC_GROUP_NEW                                108
 183 #define EC_F_EC_GROUP_SET_CURVE_GFP                      109
 184 #define EC_F_EC_GROUP_SET_EXTRA_DATA                     110
 185 #define EC_F_EC_GROUP_SET_GENERATOR                      111
 186 #define EC_F_EC_POINT_ADD                                112
 187 #define EC_F_EC_POINT_CMP                                113
 188 #define EC_F_EC_POINT_COPY                               114
 189 #define EC_F_EC_POINT_DBL                                115
 190 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP         116
 191 #define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP    117
 192 #define EC_F_EC_POINT_IS_AT_INFINITY                     118
 193 #define EC_F_EC_POINT_IS_ON_CURVE                        119
 194 #define EC_F_EC_POINT_MAKE_AFFINE                        120
 195 #define EC_F_EC_POINT_NEW                                121
 196 #define EC_F_EC_POINT_OCT2POINT                          122
 197 #define EC_F_EC_POINT_POINT2OCT                          123
 198 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP         124
 199 #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP     125
 200 #define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP    126
 201 #define EC_F_EC_POINT_SET_TO_INFINITY                    127
 202
 203 /* Reason codes. */
 204 #define EC_R_BUFFER_TOO_SMALL                            100
 205 #define EC_R_INCOMPATIBLE_OBJECTS                        101
 206 #define EC_R_INVALID_COMPRESSED_POINT                    110
 207 #define EC_R_INVALID_COMPRESSION_BIT                     109
 208 #define EC_R_INVALID_ENCODING                            102
 209 #define EC_R_INVALID_FIELD                               103
 210 #define EC_R_INVALID_FORM                                104
 211 #define EC_R_NO_SUCH_EXTRA_DATA                          105
 212 #define EC_R_POINT_AT_INFINITY                           106
 213 #define EC_R_POINT_IS_NOT_ON_CURVE                       107
 214 #define EC_R_SLOT_FULL                                   108
 215
 216 #ifdef  __cplusplus
 217 }
 218 #endif
 219 #endif