Apply OID fixes for elliptic curves as supplied by
[openssl.git] / crypto / ec / ec.h
index 7f7f7078efff6a49540d5edc4e27157220cad6dd..05b454c9217bd252277da264a6abe7b5ca3cbe23 100644 (file)
@@ -1,6 +1,6 @@
 /* crypto/ec/ec.h */
 /* ====================================================================
- * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
+ * Copyright (c) 1998-2002 The OpenSSL Project.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -57,7 +57,7 @@
 #define HEADER_EC_H
 
 #ifdef OPENSSL_NO_EC
-#error Elliptic curves are disabled.
+#error EC is disabled.
 #endif
 
 #include <openssl/bn.h>
@@ -84,7 +84,7 @@ typedef struct ec_group_st
         -- field definition
         -- curve coefficients
         -- optional generator with associated information (order, cofactor)
-        -- optional extra data (Lim/Lee precomputation table)
+        -- optional extra data (TODO: precomputed table for fast computation of multiples of generator)
        */
        EC_GROUP;
 
@@ -96,8 +96,10 @@ typedef struct ec_point_st EC_POINT;
  */
 const EC_METHOD *EC_GFp_simple_method(void);
 const EC_METHOD *EC_GFp_mont_method(void);
+#if 0
 const EC_METHOD *EC_GFp_recp_method(void); /* TODO */
 const EC_METHOD *EC_GFp_nist_method(void); /* TODO */
+#endif
 
 
 EC_GROUP *EC_GROUP_new(const EC_METHOD *);
@@ -105,8 +107,11 @@ void EC_GROUP_free(EC_GROUP *);
 void EC_GROUP_clear_free(EC_GROUP *);
 int EC_GROUP_copy(EC_GROUP *, const EC_GROUP *);
 
+void EC_GROUP_set_nid(EC_GROUP *, int);
+int EC_GROUP_get_nid(const EC_GROUP *);
+
 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *);
-       
+
 
 /* We don't have types for field specifications and field elements in general.
  * Otherwise we could declare
@@ -115,15 +120,60 @@ const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *);
 int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 int EC_GROUP_get_curve_GFp(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
 
-/* 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);
 EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *);
 int EC_GROUP_get_order(const EC_GROUP *, BIGNUM *order, BN_CTX *);
 int EC_GROUP_get_cofactor(const EC_GROUP *, BIGNUM *cofactor, BN_CTX *);
 
+/* EC_GROUP_check() returns 1 if 'group' defines a valid group, 0 otherwise */
+int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
+/* EC_GROUP_check_discriminant() returns 1 if the discriminant of the
+ * elliptic curve is not zero, 0 otherwise */
+int EC_GROUP_check_discriminant(const EC_GROUP *, BN_CTX *);
+
+/* 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 *);
+
+/* EC_GROUP_new_by_nid() and EC_GROUP_new_by_name() also set
+ * generator and order */
+EC_GROUP *EC_GROUP_new_by_nid(int nid);
+EC_GROUP *EC_GROUP_new_by_name(int name);
+/* Currently valid arguments to EC_GROUP_new_by_name() */
+#define EC_GROUP_NO_CURVE              0
+#define EC_GROUP_NIST_PRIME_192                NID_X9_62_prime192v1
+#define EC_GROUP_NIST_PRIME_224                NID_secp224r1
+#define EC_GROUP_NIST_PRIME_256                NID_X9_62_prime256v1
+#define EC_GROUP_NIST_PRIME_384                NID_secp384r1
+#define EC_GROUP_NIST_PRIME_521                NID_secp521r1
+#define EC_GROUP_X9_62_PRIME_192V1     NID_X9_62_prime192v1
+#define EC_GROUP_X9_62_PRIME_192V2     NID_X9_62_prime192v2
+#define EC_GROUP_X9_62_PRIME_192V3     NID_X9_62_prime192v3
+#define EC_GROUP_X9_62_PRIME_239V1     NID_X9_62_prime239v1
+#define EC_GROUP_X9_62_PRIME_239V2     NID_X9_62_prime239v2
+#define EC_GROUP_X9_62_PRIME_239V3     NID_X9_62_prime239v3
+#define EC_GROUP_X9_62_PRIME_256V1     NID_X9_62_prime256v1
+#define EC_GROUP_SECG_PRIME_112R1      NID_secp112r1
+#define EC_GROUP_SECG_PRIME_112R2      NID_secp112r2
+#define EC_GROUP_SECG_PRIME_128R1      NID_secp128r1
+#define EC_GROUP_SECG_PRIME_128R2      NID_secp128r2
+#define EC_GROUP_SECG_PRIME_160K1      NID_secp160k1
+#define EC_GROUP_SECG_PRIME_160R1      NID_secp160r1
+#define EC_GROUP_SECG_PRIME_160R2      NID_secp160r2
+#define EC_GROUP_SECG_PRIME_192K1      NID_secp192k1
+#define EC_GROUP_SECG_PRIME_192R1      NID_X9_62_prime192v1
+#define EC_GROUP_SECG_PRIME_224K1      NID_secp224k1
+#define EC_GROUP_SECG_PRIME_224R1      NID_secp224r1
+#define EC_GROUP_SECG_PRIME_256K1      NID_secp256k1
+#define EC_GROUP_SECG_PRIME_256R1      NID_X9_62_prime256v1
+#define EC_GROUP_SECG_PRIME_384R1      NID_secp384r1
+#define EC_GROUP_SECG_PRIME_521R1      NID_secp521r1
+#define EC_GROUP_WTLS_6                        NID_wap_wsg_idm_ecid_wtls6
+#define EC_GROUP_WTLS_7                        NID_secp160r1
+#define EC_GROUP_WTLS_8                        NID_wap_wsg_idm_ecid_wtls8
+#define EC_GROUP_WTLS_9                        NID_wap_wsg_idm_ecid_wtls9
+#define EC_GROUP_WTLS_12               NID_secp224r1
+
 EC_POINT *EC_POINT_new(const EC_GROUP *);
 void EC_POINT_free(EC_POINT *);
 void EC_POINT_clear_free(EC_POINT *);
@@ -175,10 +225,12 @@ void ERR_load_EC_strings(void);
 /* Error codes for the EC functions. */
 
 /* Function codes. */
+#define EC_F_COMPUTE_WNAF                               143
 #define EC_F_EC_GFP_MONT_FIELD_DECODE                   133
 #define EC_F_EC_GFP_MONT_FIELD_ENCODE                   134
 #define EC_F_EC_GFP_MONT_FIELD_MUL                      131
 #define EC_F_EC_GFP_MONT_FIELD_SQR                      132
+#define EC_F_EC_GFP_SIMPLE_GROUP_CHECK_DISCRIMINANT     152
 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP          100
 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR          101
 #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE                  102
@@ -188,13 +240,19 @@ void ERR_load_EC_strings(void);
 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105
 #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128
 #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129
+#define EC_F_EC_GROUP_CHECK                             150
+#define EC_F_EC_GROUP_CHECK_DISCRIMINANT                153
 #define EC_F_EC_GROUP_COPY                              106
 #define EC_F_EC_GROUP_GET0_GENERATOR                    139
 #define EC_F_EC_GROUP_GET_COFACTOR                      140
 #define EC_F_EC_GROUP_GET_CURVE_GFP                     130
 #define EC_F_EC_GROUP_GET_EXTRA_DATA                    107
 #define EC_F_EC_GROUP_GET_ORDER                                 141
+#define EC_F_EC_GROUP_GROUP2NID                                 147
 #define EC_F_EC_GROUP_NEW                               108
+#define EC_F_EC_GROUP_NEW_BY_NAME                       144
+#define EC_F_EC_GROUP_NEW_BY_NID                        146
+#define EC_F_EC_GROUP_NEW_GFP_FROM_HEX                  148
 #define EC_F_EC_GROUP_PRECOMPUTE_MULT                   142
 #define EC_F_EC_GROUP_SET_CURVE_GFP                     109
 #define EC_F_EC_GROUP_SET_EXTRA_DATA                    110
@@ -221,6 +279,7 @@ void ERR_load_EC_strings(void);
 
 /* Reason codes. */
 #define EC_R_BUFFER_TOO_SMALL                           100
+#define EC_R_DISCRIMINANT_IS_ZERO                       118
 #define EC_R_INCOMPATIBLE_OBJECTS                       101
 #define EC_R_INVALID_ARGUMENT                           112
 #define EC_R_INVALID_COMPRESSED_POINT                   110
@@ -228,12 +287,16 @@ void ERR_load_EC_strings(void);
 #define EC_R_INVALID_ENCODING                           102
 #define EC_R_INVALID_FIELD                              103
 #define EC_R_INVALID_FORM                               104
+#define EC_R_INVALID_GROUP_ORDER                        119
 #define EC_R_NOT_INITIALIZED                            111
 #define EC_R_NO_SUCH_EXTRA_DATA                                 105
 #define EC_R_POINT_AT_INFINITY                          106
 #define EC_R_POINT_IS_NOT_ON_CURVE                      107
 #define EC_R_SLOT_FULL                                  108
 #define EC_R_UNDEFINED_GENERATOR                        113
+#define EC_R_UNDEFINED_ORDER                            122
+#define EC_R_UNKNOWN_GROUP                              116
+#define EC_R_UNKNOWN_NID                                117
 #define EC_R_UNKNOWN_ORDER                              114
 
 #ifdef  __cplusplus