New -pkcs12 option to CA.pl.
[openssl.git] / crypto / dh / dh.h
1 /* crypto/dh/dh.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #ifndef HEADER_DH_H
60 #define HEADER_DH_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 #ifdef NO_DH
67 #error DH is disabled.
68 #endif
69
70 #include <openssl/bn.h>
71 #include <openssl/crypto.h>
72         
73 #define DH_FLAG_CACHE_MONT_P    0x01
74
75 typedef struct dh_st DH;
76
77 typedef struct dh_method {
78         const char *name;
79         /* Methods here */
80         int (*generate_key)(DH *dh);
81         int (*compute_key)(unsigned char *key,BIGNUM *pub_key,DH *dh);
82         int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
83                                 const BIGNUM *m, BN_CTX *ctx,
84                                 BN_MONT_CTX *m_ctx); /* Can be null */
85
86         int (*init)(DH *dh);
87         int (*finish)(DH *dh);
88         int flags;
89         char *app_data;
90 } DH_METHOD;
91
92 struct dh_st
93         {
94         /* This first argument is used to pick up errors when
95          * a DH is passed instead of a EVP_PKEY */
96         int pad;
97         int version;
98         BIGNUM *p;
99         BIGNUM *g;
100         int length; /* optional */
101         BIGNUM *pub_key;        /* g^x */
102         BIGNUM *priv_key;       /* x */
103
104         int flags;
105         char *method_mont_p;
106         /* Place holders if we want to do X9.42 DH */
107         BIGNUM *q;
108         BIGNUM *j;
109         unsigned char *seed;
110         int seedlen;
111         BIGNUM *counter;
112
113         int references;
114         CRYPTO_EX_DATA ex_data;
115         DH_METHOD *meth;
116         };
117
118 #define DH_GENERATOR_2          2
119 /* #define DH_GENERATOR_3       3 */
120 #define DH_GENERATOR_5          5
121
122 /* DH_check error codes */
123 #define DH_CHECK_P_NOT_PRIME            0x01
124 #define DH_CHECK_P_NOT_SAFE_PRIME       0x02
125 #define DH_UNABLE_TO_CHECK_GENERATOR    0x04
126 #define DH_NOT_SUITABLE_GENERATOR       0x08
127
128 /* primes p where (p-1)/2 is prime too are called "safe"; we define
129    this for backward compatibility: */
130 #define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
131
132 #define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \
133                 (char *(*)())d2i_DHparams,(char *)(x))
134 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
135                 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
136 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
137                 (unsigned char *)(x))
138 #define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \
139                 (char *(*)())d2i_DHparams,(bp),(unsigned char **)(x))
140 #ifdef  __cplusplus
141 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio((int (*)())i2d_DHparams,(bp), \
142                 (unsigned char *)(x))
143 #else
144 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \
145                 (unsigned char *)(x))
146 #endif
147
148 DH_METHOD *DH_OpenSSL(void);
149
150 void DH_set_default_method(DH_METHOD *meth);
151 DH_METHOD *DH_get_default_method(void);
152 DH_METHOD *DH_set_method(DH *dh, DH_METHOD *meth);
153 DH *DH_new_method(DH_METHOD *meth);
154
155 DH *    DH_new(void);
156 void    DH_free(DH *dh);
157 int     DH_size(DH *dh);
158 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
159              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
160 int DH_set_ex_data(DH *d, int idx, void *arg);
161 void *DH_get_ex_data(DH *d, int idx);
162 DH *    DH_generate_parameters(int prime_len,int generator,
163                 void (*callback)(int,int,void *),void *cb_arg);
164 int     DH_check(DH *dh,int *codes);
165 int     DH_generate_key(DH *dh);
166 int     DH_compute_key(unsigned char *key,BIGNUM *pub_key,DH *dh);
167 DH *    d2i_DHparams(DH **a,unsigned char **pp, long length);
168 int     i2d_DHparams(DH *a,unsigned char **pp);
169 #ifndef NO_FP_API
170 int     DHparams_print_fp(FILE *fp, DH *x);
171 #endif
172 #ifdef HEADER_BIO_H
173 int     DHparams_print(BIO *bp, DH *x);
174 #else
175 int     DHparams_print(char *bp, DH *x);
176 #endif
177 void    ERR_load_DH_strings(void );
178
179 /* BEGIN ERROR CODES */
180 /* The following lines are auto generated by the script mkerr.pl. Any changes
181  * made after this point may be overwritten when the script is next run.
182  */
183
184 /* Error codes for the DH functions. */
185
186 /* Function codes. */
187 #define DH_F_DHPARAMS_PRINT                              100
188 #define DH_F_DHPARAMS_PRINT_FP                           101
189 #define DH_F_DH_COMPUTE_KEY                              102
190 #define DH_F_DH_GENERATE_KEY                             103
191 #define DH_F_DH_GENERATE_PARAMETERS                      104
192 #define DH_F_DH_NEW                                      105
193
194 /* Reason codes. */
195 #define DH_R_NO_PRIVATE_VALUE                            100
196
197 #ifdef  __cplusplus
198 }
199 #endif
200 #endif
201