Fix various incorrect error function codes.
[openssl.git] / crypto / dh / dh.h
index 8d60ae5c52f201c67648f9f2e067e7380a46b802..a933601245652831bf42e8cdf348bfe171d623df 100644 (file)
 #ifndef HEADER_DH_H
 #define HEADER_DH_H
 
+#include <openssl/e_os2.h>
+
+#ifdef OPENSSL_NO_DH
+#error DH is disabled.
+#endif
+
+#ifndef OPENSSL_NO_BIO
+#include <openssl/bio.h>
+#endif
+#include <openssl/ossl_typ.h>
+#ifndef OPENSSL_NO_DEPRECATED
+#include <openssl/bn.h>
+#endif
+       
+#define DH_FLAG_CACHE_MONT_P   0x01
+
 #ifdef  __cplusplus
 extern "C" {
 #endif
 
-#ifndef HEADER_BN_H
-#define BIGNUM                 char
-#endif
+/* Already defined in ossl_typ.h */
+/* typedef struct dh_st DH; */
+/* typedef struct dh_method DH_METHOD; */
 
-#define DH_FLAG_CACHE_MONT_P   0x01
+struct dh_method
+       {
+       const char *name;
+       /* Methods here */
+       int (*generate_key)(DH *dh);
+       int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
+       int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
+                               const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
+                               BN_MONT_CTX *m_ctx); /* Can be null */
+
+       int (*init)(DH *dh);
+       int (*finish)(DH *dh);
+       int flags;
+       char *app_data;
+       /* If this is non-NULL, it will be used to generate parameters */
+       int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
+       };
 
-typedef struct dh_st
+struct dh_st
        {
        /* This first argument is used to pick up errors when
         * a DH is passed instead of a EVP_PKEY */
@@ -77,13 +109,24 @@ typedef struct dh_st
        int version;
        BIGNUM *p;
        BIGNUM *g;
-       int length; /* optional */
-       BIGNUM *pub_key;        /* y */
+       long length; /* optional */
+       BIGNUM *pub_key;        /* g^x */
        BIGNUM *priv_key;       /* x */
 
        int flags;
        char *method_mont_p;
-       } DH;
+       /* Place holders if we want to do X9.42 DH */
+       BIGNUM *q;
+       BIGNUM *j;
+       unsigned char *seed;
+       int seedlen;
+       BIGNUM *counter;
+
+       int references;
+       CRYPTO_EX_DATA ex_data;
+       const DH_METHOD *meth;
+       ENGINE *engine;
+       };
 
 #define DH_GENERATOR_2         2
 /* #define DH_GENERATOR_3      3 */
@@ -91,77 +134,83 @@ typedef struct dh_st
 
 /* DH_check error codes */
 #define DH_CHECK_P_NOT_PRIME           0x01
-#define DH_CHECK_P_NOT_STRONG_PRIME    0x02
+#define DH_CHECK_P_NOT_SAFE_PRIME      0x02
 #define DH_UNABLE_TO_CHECK_GENERATOR   0x04
 #define DH_NOT_SUITABLE_GENERATOR      0x08
 
-#define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \
-               (char *(*)())d2i_DHparams,(char *)(x))
+/* primes p where (p-1)/2 is prime too are called "safe"; we define
+   this for backward compatibility: */
+#define DH_CHECK_P_NOT_STRONG_PRIME    DH_CHECK_P_NOT_SAFE_PRIME
+
+#define DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x)
 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
                (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
                (unsigned char *)(x))
-#define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \
-               (char *(*)())d2i_DHparams,(bp),(unsigned char **)(x))
-#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \
-               (unsigned char *)(x))
+#define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
+#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
+
+const DH_METHOD *DH_OpenSSL(void);
+
+void DH_set_default_method(const DH_METHOD *meth);
+const DH_METHOD *DH_get_default_method(void);
+int DH_set_method(DH *dh, const DH_METHOD *meth);
+DH *DH_new_method(ENGINE *engine);
 
-#ifndef NOPROTO
 DH *   DH_new(void);
 void   DH_free(DH *dh);
-int    DH_size(DH *dh);
+int    DH_up_ref(DH *dh);
+int    DH_size(const DH *dh);
+int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
+            CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
+int DH_set_ex_data(DH *d, int idx, void *arg);
+void *DH_get_ex_data(DH *d, int idx);
+
+/* Deprecated version */
+#ifndef OPENSSL_NO_DEPRECATED
 DH *   DH_generate_parameters(int prime_len,int generator,
-               void (*callback)(int,int,char *),char *cb_arg);
-int    DH_check(DH *dh,int *codes);
-int    DH_generate_key(DH *dh);
-int    DH_compute_key(unsigned char *key,BIGNUM *pub_key,DH *dh);
-DH *   d2i_DHparams(DH **a,unsigned char **pp, long length);
-int    i2d_DHparams(DH *a,unsigned char **pp);
-#ifndef NO_FP_API
-int    DHparams_print_fp(FILE *fp, DH *x);
-#endif
-#ifdef HEADER_BIO_H
-int    DHparams_print(BIO *bp, DH *x);
-#else
-int    DHparams_print(char *bp, DH *x);
-#endif
-void   ERR_load_DH_strings(void );
+               void (*callback)(int,int,void *),void *cb_arg);
+#endif /* !defined(OPENSSL_NO_DEPRECATED) */
 
-#else
+/* New version */
+int    DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
 
-DH *   DH_new();
-void   DH_free();
-int    DH_size();
-DH *   DH_generate_parameters();
-int    DH_check();
-int    DH_generate_key();
-int    DH_compute_key();
-DH *   d2i_DHparams();
-int    i2d_DHparams();
-#ifndef NO_FP_API
-int    DHparams_print_fp();
+int    DH_check(const DH *dh,int *codes);
+int    DH_generate_key(DH *dh);
+int    DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
+DH *   d2i_DHparams(DH **a,const unsigned char **pp, long length);
+int    i2d_DHparams(const DH *a,unsigned char **pp);
+#ifndef OPENSSL_NO_FP_API
+int    DHparams_print_fp(FILE *fp, const DH *x);
 #endif
-int    DHparams_print();
-void   ERR_load_DH_strings();
-
+#ifndef OPENSSL_NO_BIO
+int    DHparams_print(BIO *bp, const DH *x);
+#else
+int    DHparams_print(char *bp, const DH *x);
 #endif
 
 /* 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.
+ */
+void ERR_load_DH_strings(void);
+
 /* Error codes for the DH functions. */
 
 /* Function codes. */
+#define DH_F_COMPUTE_KEY                                102
 #define DH_F_DHPARAMS_PRINT                             100
 #define DH_F_DHPARAMS_PRINT_FP                          101
-#define DH_F_DH_COMPUTE_KEY                             102
-#define DH_F_DH_GENERATE_KEY                            103
-#define DH_F_DH_GENERATE_PARAMETERS                     104
-#define DH_F_DH_NEW                                     105
+#define DH_F_DH_BUILTIN_GENPARAMS                       106
+#define DH_F_DH_NEW_METHOD                              105
+#define DH_F_GENERATE_KEY                               103
+#define DH_F_GENERATE_PARAMETERS                        104
 
 /* Reason codes. */
+#define DH_R_BAD_GENERATOR                              101
 #define DH_R_NO_PRIVATE_VALUE                           100
+
 #ifdef  __cplusplus
 }
 #endif
 #endif
-