Make {RSA,DSA,DH}_new_method obtain and release an ENGINE

[openssl.git] / crypto / dh / dh.h

diff --git a/crypto/dh/dh.h b/crypto/dh/dh.h
index 5d17a27a2a93416e65c431d15b745db409de0413..15cf70de0b6badf3bd3669bcbc0409de8de2142b 100644 (file)
--- a/crypto/dh/dh.h
+++ b/crypto/dh/dh.h
@@ -59,28 +59,32 @@
 #ifndef HEADER_DH_H
 #define HEADER_DH_H
 
-#ifdef  __cplusplus
-extern "C" {
-#endif
-
-#ifdef NO_DH
+#ifdef OPENSSL_NO_DH
 #error DH is disabled.
 #endif
 
+#ifndef OPENSSL_NO_BIO
+#include <openssl/bio.h>
+#endif
 #include <openssl/bn.h>
 #include <openssl/crypto.h>
+#include <openssl/ossl_typ.h>
        
 #define DH_FLAG_CACHE_MONT_P   0x01
 
+#ifdef  __cplusplus
+extern "C" {
+#endif
+
 typedef struct dh_st DH;
 
 typedef struct dh_method {
        const char *name;
        /* Methods here */
        int (*generate_key)(DH *dh);
-       int (*compute_key)(unsigned char *key,BIGNUM *pub_key,DH *dh);
-       int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
-                               const BIGNUM *m, BN_CTX *ctx,
+       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);
@@ -97,8 +101,8 @@ 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;
@@ -106,13 +110,14 @@ struct dh_st
        /* Place holders if we want to do X9.42 DH */
        BIGNUM *q;
        BIGNUM *j;
-       unsigned *seed;
+       unsigned char *seed;
        int seedlen;
        BIGNUM *counter;
 
        int references;
        CRYPTO_EX_DATA ex_data;
-       DH_METHOD *meth;
+       const DH_METHOD *meth;
+       ENGINE *engine;
        };
 
 #define DH_GENERATOR_2         2
@@ -121,10 +126,14 @@ 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
 
+/* 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) (DH *)ASN1_dup((int (*)())i2d_DHparams, \
                (char *(*)())d2i_DHparams,(char *)(x))
 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
@@ -141,41 +150,42 @@ struct dh_st
                (unsigned char *)(x))
 #endif
 
-DH_METHOD *DH_OpenSSL(void);
+const DH_METHOD *DH_OpenSSL(void);
 
-void DH_set_default_method(DH_METHOD *meth);
-DH_METHOD *DH_get_default_method(void);
-DH_METHOD *DH_set_method(DH *dh, DH_METHOD *meth);
-DH *DH_new_method(DH_METHOD *meth);
+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);
 
 DH *   DH_new(void);
 void   DH_free(DH *dh);
-int    DH_size(DH *dh);
-int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
-            int (*dup_func)(), void (*free_func)());
-int DH_set_ex_data(DH *d, int idx, char *arg);
-char *DH_get_ex_data(DH *d, int idx);
+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);
 DH *   DH_generate_parameters(int prime_len,int generator,
                void (*callback)(int,int,void *),void *cb_arg);
-int    DH_check(DH *dh,int *codes);
+int    DH_check(const 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);
+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
-#ifdef HEADER_BIO_H
-int    DHparams_print(BIO *bp, DH *x);
+#ifndef OPENSSL_NO_BIO
+int    DHparams_print(BIO *bp, const DH *x);
 #else
-int    DHparams_print(char *bp, DH *x);
+int    DHparams_print(char *bp, const DH *x);
 #endif
-void   ERR_load_DH_strings(void );
 
 /* 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. */
 
@@ -185,7 +195,7 @@ void        ERR_load_DH_strings(void );
 #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_NEW_METHOD                              105
 
 /* Reason codes. */
 #define DH_R_NO_PRIVATE_VALUE                           100
@@ -194,4 +204,3 @@ void        ERR_load_DH_strings(void );
 }
 #endif
 #endif
-