Fix some minor documentation issues
[openssl.git] / apps / prime.c
1 /* ====================================================================
2  * Copyright (c) 2004 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  *
48  */
49
50 #include <string.h>
51
52 #include "apps.h"
53 #include <openssl/bn.h>
54
55 #undef PROG
56 #define PROG prime_main
57
58 int MAIN(int, char **);
59
60 int MAIN(int argc, char **argv)
61 {
62     int hex = 0;
63     int checks = 20;
64     int generate = 0;
65     int bits = 0;
66     int safe = 0;
67     BIGNUM *bn = NULL;
68     BIO *bio_out;
69
70     apps_startup();
71
72     if (bio_err == NULL)
73         if ((bio_err = BIO_new(BIO_s_file())) != NULL)
74             BIO_set_fp(bio_err, stderr, BIO_NOCLOSE | BIO_FP_TEXT);
75
76     --argc;
77     ++argv;
78     while (argc >= 1 && **argv == '-') {
79         if (!strcmp(*argv, "-hex"))
80             hex = 1;
81         else if (!strcmp(*argv, "-generate"))
82             generate = 1;
83         else if (!strcmp(*argv, "-bits"))
84             if (--argc < 1)
85                 goto bad;
86             else
87                 bits = atoi(*++argv);
88         else if (!strcmp(*argv, "-safe"))
89             safe = 1;
90         else if (!strcmp(*argv, "-checks"))
91             if (--argc < 1)
92                 goto bad;
93             else
94                 checks = atoi(*++argv);
95         else {
96             BIO_printf(bio_err, "Unknown option '%s'\n", *argv);
97             goto bad;
98         }
99         --argc;
100         ++argv;
101     }
102
103     if (argv[0] == NULL && !generate) {
104         BIO_printf(bio_err, "No prime specified\n");
105         goto bad;
106     }
107
108     if ((bio_out = BIO_new(BIO_s_file())) != NULL) {
109         BIO_set_fp(bio_out, stdout, BIO_NOCLOSE);
110 #ifdef OPENSSL_SYS_VMS
111         {
112             BIO *tmpbio = BIO_new(BIO_f_linebuffer());
113             bio_out = BIO_push(tmpbio, bio_out);
114         }
115 #endif
116     }
117
118     if (generate) {
119         char *s;
120
121         if (!bits) {
122             BIO_printf(bio_err, "Specifiy the number of bits.\n");
123             return 1;
124         }
125         bn = BN_new();
126         BN_generate_prime_ex(bn, bits, safe, NULL, NULL, NULL);
127         s = hex ? BN_bn2hex(bn) : BN_bn2dec(bn);
128         BIO_printf(bio_out, "%s\n", s);
129         OPENSSL_free(s);
130     } else {
131         if (hex)
132             BN_hex2bn(&bn, argv[0]);
133         else
134             BN_dec2bn(&bn, argv[0]);
135
136         BN_print(bio_out, bn);
137         BIO_printf(bio_out, " is %sprime\n",
138                    BN_is_prime_ex(bn, checks, NULL, NULL) ? "" : "not ");
139     }
140
141     BN_free(bn);
142     BIO_free_all(bio_out);
143
144     return 0;
145
146  bad:
147     BIO_printf(bio_err, "options are\n");
148     BIO_printf(bio_err, "%-14s hex\n", "-hex");
149     BIO_printf(bio_err, "%-14s number of checks\n", "-checks <n>");
150     return 1;
151 }