Optimized EC_METHODs need specific 'set_curve' and 'free' functions.
[openssl.git] / crypto / ec / ec.h
index eb1ce0c494d6a7c5dc93e5979c30966b6fcc594b..01234d714d5b7e8a94d935446e035554d9e4795f 100644 (file)
-/*
+/* crypto/ec/ec.h */
+/* ====================================================================
+ * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
  *
- *     ec.h
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
  *
- *     Elliptic Curve Arithmetic Functions
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer. 
  *
- *     Copyright (C) Lenka Fibikova 2000
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
  *
+ * 3. All advertising materials mentioning features or use of this
+ *    software must display the following acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+ *
+ * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission. For written permission, please contact
+ *    openssl-core@openssl.org.
+ *
+ * 5. Products derived from this software may not be called "OpenSSL"
+ *    nor may "OpenSSL" appear in their names without prior written
+ *    permission of the OpenSSL Project.
+ *
+ * 6. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+ * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This product includes cryptographic software written by Eric Young
+ * (eay@cryptsoft.com).  This product includes software written by Tim
+ * Hudson (tjh@cryptsoft.com).
  *
  */
 
-
 #ifndef HEADER_EC_H
 #define HEADER_EC_H
 
-
 #include <openssl/bn.h>
-#include "../bn/bn_mont2.h" /* XXX */
-
-typedef struct bn_ec_struct            /* E: y^2 = x^3 + Ax + B  (mod p) */
-{
-       BIGNUM  *A, *B, *p;
-       int is_in_mont;
-} EC;
-
-typedef struct bn_ec_point_struct /* P = [X, Y, Z] */
-{
-       BIGNUM  *X, *Y, *Z;
-       int is_in_mont;
-} EC_POINT;
-
-typedef struct bn_ecp_precompute_struct /* Pi[i] = [2i + 1]P   i = 0..2^{r-1} - 1 */
-{
-       int r;
-       EC_POINT **Pi;
-} ECP_PRECOMPUTE;
-
-
-#define ECP_is_infty(P) (BN_is_zero(P->Z))
-#define ECP_is_norm(P) (BN_is_one(P->Z))
-
-#define ECP_mont_minus(P, mont) (ECP_minus((P), (mont)->p))
-
-
-EC *EC_new();
-void EC_clear_free(EC *E);
-#ifdef MONTGOMERY
-int EC_to_montgomery(EC *E, BN_MONTGOMERY *mont, BN_CTX *ctx);
-int EC_from_montgomery(EC *E, BN_MONTGOMERY *mont, BN_CTX *ctx);
-#endif /* MONTGOMERY */
-
-
-EC_POINT *ECP_new();
-void ECP_clear_free(EC_POINT *P);
-void ECP_clear_free_precompute(ECP_PRECOMPUTE *prec);
-
-EC_POINT *ECP_generate(BIGNUM *x, BIGNUM *z, EC *E, BN_CTX *ctx);
-EC_POINT *ECP_dup(EC_POINT *P);
-int ECP_copy(EC_POINT *R, EC_POINT *P);
-int ECP_normalize(EC_POINT *P, EC *E, BN_CTX *ctx);
-EC_POINT *ECP_minus(EC_POINT *P, BIGNUM *p);
-int ECP_is_on_ec(EC_POINT *P, EC *E, BN_CTX *ctx);
-int ECP_ecp2bin(EC_POINT *P, unsigned char *to, int form); /* form(ANSI 9.62): 1-compressed; 2-uncompressed; 3-hybrid */
-int ECP_bin2ecp(unsigned char *from, int len, EC_POINT *P, EC *E, BN_CTX *ctx);
-
-#ifdef SIMPLE
-int ECP_cmp(EC_POINT *P, EC_POINT *Q, BIGNUM *p, BN_CTX *ctx);
-int ECP_double(EC_POINT *R, EC_POINT *P, EC *E, BN_CTX *ctx);
-int ECP_add(EC_POINT *R, EC_POINT *P, EC_POINT *Q, EC *E, BN_CTX *ctx);
-ECP_PRECOMPUTE *ECP_precompute(int r, EC_POINT *P, EC *E, BN_CTX *ctx);
-int ECP_multiply(EC_POINT *R, BIGNUM *k, ECP_PRECOMPUTE *prec, EC *E, BN_CTX *ctx);
-#endif /* SIMPLE */
-
-#ifdef MONTGOMERY
-int ECP_to_montgomery(EC_POINT *P, BN_MONTGOMERY *mont, BN_CTX *ctx);
-int ECP_from_montgomery(EC_POINT *P, BN_MONTGOMERY *mont, BN_CTX *ctx);
-int ECP_mont_cmp(EC_POINT *P, EC_POINT *Q, BN_MONTGOMERY *mont, BN_CTX *ctx);
-int ECP_mont_double(EC_POINT *R, EC_POINT *P, EC *E, BN_MONTGOMERY *mont, BN_CTX *ctx);
-int ECP_mont_add(EC_POINT *R, EC_POINT *P, EC_POINT *Q, EC *E, BN_MONTGOMERY *mont, BN_CTX *ctx);
-ECP_PRECOMPUTE *ECP_mont_precompute(int r, EC_POINT *P, EC *E, BN_MONTGOMERY *mont, BN_CTX *ctx);
-int ECP_mont_multiply(EC_POINT *R, BIGNUM *k, ECP_PRECOMPUTE *prec, EC *E, BN_MONTGOMERY *mont, BN_CTX *ctx);
-int ECP_mont_multiply2(EC_POINT *R, BIGNUM *k, EC_POINT *P, EC *E, BN_MONTGOMERY *mont, BN_CTX *ctx);
-#endif /* MONTGOMERY */
 
+#ifdef  __cplusplus
+extern "C" {
+#endif
+
+
+
+typedef enum {
+       POINT_CONVERSION_COMPRESSED = 2,
+       POINT_CONVERSION_UNCOMPRESSED = 4,
+       POINT_CONVERSION_HYBRID = 6
+} point_conversion_form_t;
+
+
+typedef struct ec_method_st EC_METHOD;
+
+typedef struct ec_group_st
+       /*
+        EC_METHOD *meth;
+        -- field definition
+        -- curve coefficients
+        -- optional generator with associated information (order, cofactor)
+        -- optional Lim/Lee precomputation table
+       */
+       EC_GROUP;
+
+typedef struct ec_point_st EC_POINT;
+
+
+/* EC_METHODs for curves over GF(p).
+ * EC_GFp_simple_method provides the basis for the optimized methods.
+ */
+const EC_METHOD *EC_GFp_simple_method(void);
+const EC_METHOD *EC_GFp_mont_method(void);
+const EC_METHOD *EC_GFp_recp_method(void);
+const EC_METHOD *EC_GFp_nist_method(void);
+
+
+EC_GROUP *EC_GROUP_new(const EC_METHOD *);
+/* We don't have types for field specifications and field elements in general.
+ * Otherwise we would declare
+ *     int EC_GROUP_set_curve(EC_GROUP *, .....);
+ */
+int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+void EC_GROUP_free(EC_GROUP *);
+void EC_GROUP_clear_free(EC_GROUP *);
+int EC_GROUP_copy(EC_GROUP *, const EC_GROUP*);
+
+/* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
+ * after choosing an appropriate EC_METHOD */
+EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+
+int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
+
+/* TODO: 'set' and 'get' functions for EC_GROUPs */
+
+
+EC_POINT *EC_POINT_new(const EC_GROUP *);
+void EC_POINT_free(EC_POINT *);
+void EC_POINT_clear_free(EC_POINT *);
+int EC_POINT_copy(EC_POINT *, const EC_POINT *);
+/* TODO: 'set' and 'get' functions for EC_POINTs */
+
+size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
+        unsigned char *buf, size_t len, BN_CTX *);
+int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
+        const unsigned char *buf, size_t len, BN_CTX *);
+
+int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
+int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
+
+int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
+int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
+
+int EC_POINT_make_affine(const EC_GROUP *, const EC_POINT *, BN_CTX *);
+
+
+
+/* TODO: scalar multiplication */
+
+
+
+/* BEGIN ERROR CODES */
+/* The following lines are auto generated by the script mkerr.pl. Any changes
+ * made after this point may be overwritten when the script is next run.
+ */
+
+/* Error codes for the EC functions. */
+
+/* Function codes. */
+#define EC_F_EC_GROUP_CLEAR_FREE                        103
+#define EC_F_EC_GROUP_COPY                              102
+#define EC_F_EC_GROUP_FREE                              104
+#define EC_F_EC_GROUP_GET_EXTRA_DATA                    115
+#define EC_F_EC_GROUP_NEW                               100
+#define EC_F_EC_GROUP_SET_CURVE_GFP                     101
+#define EC_F_EC_GROUP_SET_EXTRA_DATA                    116
+#define EC_F_EC_GROUP_SET_GENERATOR                     106
+#define EC_F_EC_POINT_ADD                               107
+#define EC_F_EC_POINT_COPY                              108
+#define EC_F_EC_POINT_DBL                               109
+#define EC_F_EC_POINT_IS_AT_INFINITY                    110
+#define EC_F_EC_POINT_IS_ON_CURVE                       111
+#define EC_F_EC_POINT_MAKE_AFFINE                       112
+#define EC_F_EC_POINT_NEW                               105
+#define EC_F_EC_POINT_OCT2POINT                                 113
+#define EC_F_EC_POINT_POINT2OCT                                 114
+
+/* Reason codes. */
+#define EC_R_INCOMPATIBLE_OBJECTS                       100
+#define EC_R_NO_SUCH_EXTRA_DATA                                 101
+#define EC_R_SLOT_FULL                                  102
+
+#ifdef  __cplusplus
+}
 #endif
+#endif
+