Complete rewrite of the error code generation script. It now runs as a single
[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 #include <openssl/bn.h>
67         
68 #define DH_FLAG_CACHE_MONT_P    0x01
69
70 typedef struct dh_st
71         {
72         /* This first argument is used to pick up errors when
73          * a DH is passed instead of a EVP_PKEY */
74         int pad;
75         int version;
76         BIGNUM *p;
77         BIGNUM *g;
78         int length; /* optional */
79         BIGNUM *pub_key;        /* y */
80         BIGNUM *priv_key;       /* x */
81
82         int flags;
83         char *method_mont_p;
84         } DH;
85
86 #define DH_GENERATOR_2          2
87 /* #define DH_GENERATOR_3       3 */
88 #define DH_GENERATOR_5          5
89
90 /* DH_check error codes */
91 #define DH_CHECK_P_NOT_PRIME            0x01
92 #define DH_CHECK_P_NOT_STRONG_PRIME     0x02
93 #define DH_UNABLE_TO_CHECK_GENERATOR    0x04
94 #define DH_NOT_SUITABLE_GENERATOR       0x08
95
96 #define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \
97                 (char *(*)())d2i_DHparams,(char *)(x))
98 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
99                 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
100 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
101                 (unsigned char *)(x))
102 #define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \
103                 (char *(*)())d2i_DHparams,(bp),(unsigned char **)(x))
104 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \
105                 (unsigned char *)(x))
106
107 #ifndef NOPROTO
108 DH *    DH_new(void);
109 void    DH_free(DH *dh);
110 int     DH_size(DH *dh);
111 DH *    DH_generate_parameters(int prime_len,int generator,
112                 void (*callback)(int,int,char *),char *cb_arg);
113 int     DH_check(DH *dh,int *codes);
114 int     DH_generate_key(DH *dh);
115 int     DH_compute_key(unsigned char *key,BIGNUM *pub_key,DH *dh);
116 DH *    d2i_DHparams(DH **a,unsigned char **pp, long length);
117 int     i2d_DHparams(DH *a,unsigned char **pp);
118 #ifndef NO_FP_API
119 int     DHparams_print_fp(FILE *fp, DH *x);
120 #endif
121 #ifdef HEADER_BIO_H
122 int     DHparams_print(BIO *bp, DH *x);
123 #else
124 int     DHparams_print(char *bp, DH *x);
125 #endif
126 void    ERR_load_DH_strings(void );
127
128 #else
129
130 DH *    DH_new();
131 void    DH_free();
132 int     DH_size();
133 DH *    DH_generate_parameters();
134 int     DH_check();
135 int     DH_generate_key();
136 int     DH_compute_key();
137 DH *    d2i_DHparams();
138 int     i2d_DHparams();
139 #ifndef NO_FP_API
140 int     DHparams_print_fp();
141 #endif
142 int     DHparams_print();
143 void    ERR_load_DH_strings();
144
145 #endif
146
147 /* BEGIN ERROR CODES */
148 /* The following lines are auto generated by the script mkerr.pl. Any changes
149  * made after this point may be overwritten when the script is next run.
150  */
151
152 /* Error codes for the DH functions. */
153
154 /* Function codes. */
155 #define DH_F_DHPARAMS_PRINT                              100
156 #define DH_F_DHPARAMS_PRINT_FP                           101
157 #define DH_F_DH_COMPUTE_KEY                              102
158 #define DH_F_DH_GENERATE_KEY                             103
159 #define DH_F_DH_GENERATE_PARAMETERS                      104
160 #define DH_F_DH_NEW                                      105
161
162 /* Reason codes. */
163 #define DH_R_NO_PRIVATE_VALUE                            100
164
165 #ifdef  __cplusplus
166 }
167 #endif
168 #endif
169