crypto/ec/ec.h

   1 /* TODO */
   2 /* crypto/ec/ec.h */
   3 /* ====================================================================
   4  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  * 3. All advertising materials mentioning features or use of this
  19  *    software must display the following acknowledgment:
  20  *    "This product includes software developed by the OpenSSL Project
  21  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  22  *
  23  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  24  *    endorse or promote products derived from this software without
  25  *    prior written permission. For written permission, please contact
  26  *    openssl-core@openssl.org.
  27  *
  28  * 5. Products derived from this software may not be called "OpenSSL"
  29  *    nor may "OpenSSL" appear in their names without prior written
  30  *    permission of the OpenSSL Project.
  31  *
  32  * 6. Redistributions of any form whatsoever must retain the following
  33  *    acknowledgment:
  34  *    "This product includes software developed by the OpenSSL Project
  35  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  36  *
  37  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  38  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  39  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  40  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  43  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  45  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  46  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  47  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  48  * OF THE POSSIBILITY OF SUCH DAMAGE.
  49  * ====================================================================
  50  *
  51  * This product includes cryptographic software written by Eric Young
  52  * (eay@cryptsoft.com).  This product includes software written by Tim
  53  * Hudson (tjh@cryptsoft.com).
  54  *
  55  */
  56
  57 #ifndef HEADER_EC_H
  58 #define HEADER_EC_H
  59
  60 #include <openssl/bn.h>
  61
  62 #ifdef  __cplusplus
  63 extern "C" {
  64 #endif
  65
  66
  67 typedef enum {
  68         POINT_CONVERSION_COMPRESSED = 2,
  69         POINT_CONVERSION_UNCOMPRESSED = 4,
  70         POINT_CONVERSION_HYBRID = 6
  71 } point_conversion_form_t;
  72
  73
  74 typedef struct ec_method_st EC_METHOD;
  75
  76 typedef struct ec_group_st
  77         /*
  78          EC_METHOD *meth;
  79          -- field definition
  80          -- curve coefficients
  81          -- optional generator with associated information (order, cofactor)
  82          -- optional Lim/Lee precomputation table
  83         */
  84         EC_GROUP;
  85
  86 typedef struct ec_point_st EC_POINT;
  87
  88
  89 /* EC_METHODs for curves over GF(p).
  90  * EC_GFp_simple_method provides the basis for the optimized methods.
  91  */
  92
  93 const EC_METHOD *EC_GFp_simple_method(void);
  94 const EC_METHOD *EC_GFp_mont_method(void);
  95 const EC_METHOD *EC_GFp_recp_method(void);
  96 const EC_METHOD *EC_GFp_nist_method(void);
  97
  98
  99 EC_GROUP *EC_GROUP_new(const EC_METHOD *);
 100 /* We don't have types for field specifications and field elements in general.
 101  * Otherwise we would declare
 102  *     int EC_GROUP_set(EC_GROUP *, .....);
 103  */
 104 int EC_GROUP_set_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b);
 105 void EC_GROUP_free(EC_GROUP *);
 106
 107 /* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
 108  * after choosing an appropriate EC_METHOD */
 109 EC_GROUP *EC_GROUP_new_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b);
 110
 111
 112 EC_POINT *EC_POINT_new(const EC_GROUP *);
 113 void EC_POINT_free(EC_POINT *);
 114
 115 int EC_POINT_add(const EC_GROUP *, EC_POINT *r, EC_POINT *a, EC_POINT *b);
 116 int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, EC_POINT *a);
 117
 118 size_t EC_POINT_point2oct(const EC_GROUP *, EC_POINT *, unsigned char *buf,
 119         size_t len, point_conversion_form_t form);
 120 int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *, unsigned char *buf, size_t len);
 121
 122
 123 /* TODO: scalar multiplication */
 124
 125
 126
 127 /* BEGIN ERROR CODES */
 128 /* The following lines are auto generated by the script mkerr.pl. Any changes
 129  * made after this point may be overwritten when the script is next run.
 130  */
 131
 132 /* Error codes for the EC functions. */
 133
 134 /* Function codes. */
 135
 136 /* Reason codes. */
 137
 138 #ifdef  __cplusplus
 139 }
 140 #endif
 141 #endif
 142