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 #include <openssl/bn.h>
  60
  61 #ifdef  __cplusplus
  62 extern "C" {
  63 #endif
  64
  65
  66
  67 typedef enum {
  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;
  73
  74
  75 typedef struct ec_method_st EC_METHOD;
  76
  77 typedef struct ec_group_st
  78         /*
  79          EC_METHOD *meth;
  80          -- field definition
  81          -- curve coefficients
  82          -- optional generator with associated information (order, cofactor)
  83          -- optional Lim/Lee precomputation table
  84         */
  85         EC_GROUP;
  86
  87 typedef struct ec_point_st EC_POINT;
  88
  89
  90 /* EC_METHODs for curves over GF(p).
  91  * EC_GFp_simple_method provides the basis for the optimized methods.
  92  */
  93
  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);
  98
  99
 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 *, .....);
 104  */
 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*);
 109
 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 *);
 113
 114 int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
 115
 116 /* TODO: 'set' and 'get' functions for EC_GROUPs */
 117
 118
 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 *);
 123
 124 int EC_POINT_set_to_infinity(const EC_GROUP *, EC_POINT *);
 125 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *, EC_POINT *,
 126         const BIGNUM *x, const BIGNUM *y, BN_CTX *);
 127 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
 128         BIGNUM *x, BIGNUM *y, BN_CTX *);
 129 /* TODO: other 'set' and 'get' functions for EC_POINTs */
 130
 131 size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
 132         unsigned char *buf, size_t len, BN_CTX *);
 133 int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
 134         const unsigned char *buf, size_t len, BN_CTX *);
 135
 136 int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 137 int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
 138
 139 int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
 140 int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
 141
 142 int EC_POINT_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
 143
 144
 145
 146 /* TODO: scalar multiplication */
 147
 148
 149
 150 /* BEGIN ERROR CODES */
 151 /* The following lines are auto generated by the script mkerr.pl. Any changes
 152  * made after this point may be overwritten when the script is next run.
 153  */
 154
 155 /* Error codes for the EC functions. */
 156
 157 /* Function codes. */
 158 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR           100
 159 #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE                   101
 160 #define EC_F_EC_GFP_SIMPLE_OCT2POINT                     102
 161 #define EC_F_EC_GFP_SIMPLE_POINT2OCT                     103
 162 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 104
 163 #define EC_F_EC_GROUP_COPY                               105
 164 #define EC_F_EC_GROUP_GET_EXTRA_DATA                     106
 165 #define EC_F_EC_GROUP_NEW                                107
 166 #define EC_F_EC_GROUP_SET_CURVE_GFP                      108
 167 #define EC_F_EC_GROUP_SET_EXTRA_DATA                     109
 168 #define EC_F_EC_GROUP_SET_GENERATOR                      110
 169 #define EC_F_EC_POINT_ADD                                111
 170 #define EC_F_EC_POINT_COPY                               112
 171 #define EC_F_EC_POINT_DBL                                113
 172 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP         114
 173 #define EC_F_EC_POINT_IS_AT_INFINITY                     115
 174 #define EC_F_EC_POINT_IS_ON_CURVE                        116
 175 #define EC_F_EC_POINT_MAKE_AFFINE                        117
 176 #define EC_F_EC_POINT_NEW                                118
 177 #define EC_F_EC_POINT_OCT2POINT                          119
 178 #define EC_F_EC_POINT_POINT2OCT                          120
 179 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP         121
 180 #define EC_F_EC_POINT_SET_TO_INFINITY                    122
 181
 182 /* Reason codes. */
 183 #define EC_R_BUFFER_TOO_SMALL                            100
 184 #define EC_R_INCOMPATIBLE_OBJECTS                        101
 185 #define EC_R_INVALID_ENCODING                            102
 186 #define EC_R_INVALID_FORM                                103
 187 #define EC_R_NO_SUCH_EXTRA_DATA                          104
 188 #define EC_R_POINT_AT_INFINITY                           105
 189 #define EC_R_POINT_IS_NOT_ON_CURVE                       106
 190 #define EC_R_SLOT_FULL                                   107
 191
 192 #ifdef  __cplusplus
 193 }
 194 #endif
 195 #endif