Document recent changes.
[openssl.git] / apps / dh.c
1 /* apps/dh.c */
2 /* obsoleted by dhparam.c */
3 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4  * All rights reserved.
5  *
6  * This package is an SSL implementation written
7  * by Eric Young (eay@cryptsoft.com).
8  * The implementation was written so as to conform with Netscapes SSL.
9  * 
10  * This library is free for commercial and non-commercial use as long as
11  * the following conditions are aheared to.  The following conditions
12  * apply to all code found in this distribution, be it the RC4, RSA,
13  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
14  * included with this distribution is covered by the same copyright terms
15  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16  * 
17  * Copyright remains Eric Young's, and as such any Copyright notices in
18  * the code are not to be removed.
19  * If this package is used in a product, Eric Young should be given attribution
20  * as the author of the parts of the library used.
21  * This can be in the form of a textual message at program startup or
22  * in documentation (online or textual) provided with the package.
23  * 
24  * Redistribution and use in source and binary forms, with or without
25  * modification, are permitted provided that the following conditions
26  * are met:
27  * 1. Redistributions of source code must retain the copyright
28  *    notice, this list of conditions and the following disclaimer.
29  * 2. Redistributions in binary form must reproduce the above copyright
30  *    notice, this list of conditions and the following disclaimer in the
31  *    documentation and/or other materials provided with the distribution.
32  * 3. All advertising materials mentioning features or use of this software
33  *    must display the following acknowledgement:
34  *    "This product includes cryptographic software written by
35  *     Eric Young (eay@cryptsoft.com)"
36  *    The word 'cryptographic' can be left out if the rouines from the library
37  *    being used are not cryptographic related :-).
38  * 4. If you include any Windows specific code (or a derivative thereof) from 
39  *    the apps directory (application code) you must include an acknowledgement:
40  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41  * 
42  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * 
54  * The licence and distribution terms for any publically available version or
55  * derivative of this code cannot be changed.  i.e. this code cannot simply be
56  * copied and put under another distribution licence
57  * [including the GNU Public Licence.]
58  */
59
60 #ifndef OPENSSL_NO_DH
61 #include <stdio.h>
62 #include <stdlib.h>
63 #include <time.h>
64 #include <string.h>
65 #include "apps.h"
66 #include <openssl/bio.h>
67 #include <openssl/err.h>
68 #include <openssl/bn.h>
69 #include <openssl/dh.h>
70 #include <openssl/x509.h>
71 #include <openssl/pem.h>
72 #include <openssl/engine.h>
73
74 #undef PROG
75 #define PROG    dh_main
76
77 /* -inform arg  - input format - default PEM (DER or PEM)
78  * -outform arg - output format - default PEM
79  * -in arg      - input file - default stdin
80  * -out arg     - output file - default stdout
81  * -check       - check the parameters are ok
82  * -noout
83  * -text
84  * -C
85  */
86
87 int MAIN(int, char **);
88
89 int MAIN(int argc, char **argv)
90         {
91         ENGINE *e = NULL;
92         DH *dh=NULL;
93         int i,badops=0,text=0;
94         BIO *in=NULL,*out=NULL;
95         int informat,outformat,check=0,noout=0,C=0,ret=1;
96         char *infile,*outfile,*prog,*engine;
97
98         apps_startup();
99
100         if (bio_err == NULL)
101                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
102                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
103
104         engine=NULL;
105         infile=NULL;
106         outfile=NULL;
107         informat=FORMAT_PEM;
108         outformat=FORMAT_PEM;
109
110         prog=argv[0];
111         argc--;
112         argv++;
113         while (argc >= 1)
114                 {
115                 if      (strcmp(*argv,"-inform") == 0)
116                         {
117                         if (--argc < 1) goto bad;
118                         informat=str2fmt(*(++argv));
119                         }
120                 else if (strcmp(*argv,"-outform") == 0)
121                         {
122                         if (--argc < 1) goto bad;
123                         outformat=str2fmt(*(++argv));
124                         }
125                 else if (strcmp(*argv,"-in") == 0)
126                         {
127                         if (--argc < 1) goto bad;
128                         infile= *(++argv);
129                         }
130                 else if (strcmp(*argv,"-out") == 0)
131                         {
132                         if (--argc < 1) goto bad;
133                         outfile= *(++argv);
134                         }
135                 else if (strcmp(*argv,"-engine") == 0)
136                         {
137                         if (--argc < 1) goto bad;
138                         engine= *(++argv);
139                         }
140                 else if (strcmp(*argv,"-check") == 0)
141                         check=1;
142                 else if (strcmp(*argv,"-text") == 0)
143                         text=1;
144                 else if (strcmp(*argv,"-C") == 0)
145                         C=1;
146                 else if (strcmp(*argv,"-noout") == 0)
147                         noout=1;
148                 else
149                         {
150                         BIO_printf(bio_err,"unknown option %s\n",*argv);
151                         badops=1;
152                         break;
153                         }
154                 argc--;
155                 argv++;
156                 }
157
158         if (badops)
159                 {
160 bad:
161                 BIO_printf(bio_err,"%s [options] <infile >outfile\n",prog);
162                 BIO_printf(bio_err,"where options are\n");
163                 BIO_printf(bio_err," -inform arg   input format - one of DER PEM\n");
164                 BIO_printf(bio_err," -outform arg  output format - one of DER PEM\n");
165                 BIO_printf(bio_err," -in arg       input file\n");
166                 BIO_printf(bio_err," -out arg      output file\n");
167                 BIO_printf(bio_err," -check        check the DH parameters\n");
168                 BIO_printf(bio_err," -text         print a text form of the DH parameters\n");
169                 BIO_printf(bio_err," -C            Output C code\n");
170                 BIO_printf(bio_err," -noout        no output\n");
171                 BIO_printf(bio_err," -engine e     use engine e, possibly a hardware device.\n");
172                 goto end;
173                 }
174
175         ERR_load_crypto_strings();
176
177         e = setup_engine(bio_err, engine, 0);
178
179         in=BIO_new(BIO_s_file());
180         out=BIO_new(BIO_s_file());
181         if ((in == NULL) || (out == NULL))
182                 {
183                 ERR_print_errors(bio_err);
184                 goto end;
185                 }
186
187         if (infile == NULL)
188                 BIO_set_fp(in,stdin,BIO_NOCLOSE);
189         else
190                 {
191                 if (BIO_read_filename(in,infile) <= 0)
192                         {
193                         perror(infile);
194                         goto end;
195                         }
196                 }
197         if (outfile == NULL)
198                 {
199                 BIO_set_fp(out,stdout,BIO_NOCLOSE);
200 #ifdef OPENSSL_SYS_VMS
201                 {
202                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
203                 out = BIO_push(tmpbio, out);
204                 }
205 #endif
206                 }
207         else
208                 {
209                 if (BIO_write_filename(out,outfile) <= 0)
210                         {
211                         perror(outfile);
212                         goto end;
213                         }
214                 }
215
216         if      (informat == FORMAT_ASN1)
217                 dh=d2i_DHparams_bio(in,NULL);
218         else if (informat == FORMAT_PEM)
219                 dh=PEM_read_bio_DHparams(in,NULL,NULL,NULL);
220         else
221                 {
222                 BIO_printf(bio_err,"bad input format specified\n");
223                 goto end;
224                 }
225         if (dh == NULL)
226                 {
227                 BIO_printf(bio_err,"unable to load DH parameters\n");
228                 ERR_print_errors(bio_err);
229                 goto end;
230                 }
231
232         
233
234         if (text)
235                 {
236                 DHparams_print(out,dh);
237 #ifdef undef
238                 printf("p=");
239                 BN_print(stdout,dh->p);
240                 printf("\ng=");
241                 BN_print(stdout,dh->g);
242                 printf("\n");
243                 if (dh->length != 0)
244                         printf("recommended private length=%ld\n",dh->length);
245 #endif
246                 }
247         
248         if (check)
249                 {
250                 if (!DH_check(dh,&i))
251                         {
252                         ERR_print_errors(bio_err);
253                         goto end;
254                         }
255                 if (i & DH_CHECK_P_NOT_PRIME)
256                         printf("p value is not prime\n");
257                 if (i & DH_CHECK_P_NOT_SAFE_PRIME)
258                         printf("p value is not a safe prime\n");
259                 if (i & DH_UNABLE_TO_CHECK_GENERATOR)
260                         printf("unable to check the generator value\n");
261                 if (i & DH_NOT_SUITABLE_GENERATOR)
262                         printf("the g value is not a generator\n");
263                 if (i == 0)
264                         printf("DH parameters appear to be ok.\n");
265                 }
266         if (C)
267                 {
268                 unsigned char *data;
269                 int len,l,bits;
270
271                 len=BN_num_bytes(dh->p);
272                 bits=BN_num_bits(dh->p);
273                 data=(unsigned char *)OPENSSL_malloc(len);
274                 if (data == NULL)
275                         {
276                         perror("OPENSSL_malloc");
277                         goto end;
278                         }
279                 l=BN_bn2bin(dh->p,data);
280                 printf("static unsigned char dh%d_p[]={",bits);
281                 for (i=0; i<l; i++)
282                         {
283                         if ((i%12) == 0) printf("\n\t");
284                         printf("0x%02X,",data[i]);
285                         }
286                 printf("\n\t};\n");
287
288                 l=BN_bn2bin(dh->g,data);
289                 printf("static unsigned char dh%d_g[]={",bits);
290                 for (i=0; i<l; i++)
291                         {
292                         if ((i%12) == 0) printf("\n\t");
293                         printf("0x%02X,",data[i]);
294                         }
295                 printf("\n\t};\n\n");
296
297                 printf("DH *get_dh%d()\n\t{\n",bits);
298                 printf("\tDH *dh;\n\n");
299                 printf("\tif ((dh=DH_new()) == NULL) return(NULL);\n");
300                 printf("\tdh->p=BN_bin2bn(dh%d_p,sizeof(dh%d_p),NULL);\n",
301                         bits,bits);
302                 printf("\tdh->g=BN_bin2bn(dh%d_g,sizeof(dh%d_g),NULL);\n",
303                         bits,bits);
304                 printf("\tif ((dh->p == NULL) || (dh->g == NULL))\n");
305                 printf("\t\treturn(NULL);\n");
306                 printf("\treturn(dh);\n\t}\n");
307                 OPENSSL_free(data);
308                 }
309
310
311         if (!noout)
312                 {
313                 if      (outformat == FORMAT_ASN1)
314                         i=i2d_DHparams_bio(out,dh);
315                 else if (outformat == FORMAT_PEM)
316                         i=PEM_write_bio_DHparams(out,dh);
317                 else    {
318                         BIO_printf(bio_err,"bad output format specified for outfile\n");
319                         goto end;
320                         }
321                 if (!i)
322                         {
323                         BIO_printf(bio_err,"unable to write DH parameters\n");
324                         ERR_print_errors(bio_err);
325                         goto end;
326                         }
327                 }
328         ret=0;
329 end:
330         if (in != NULL) BIO_free(in);
331         if (out != NULL) BIO_free_all(out);
332         if (dh != NULL) DH_free(dh);
333         EXIT(ret);
334         }
335 #endif