Fix some minor documentation issues
[openssl.git] / apps / pkeyparam.c
1 /* apps/pkeyparam.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2006
5  */
6 /* ====================================================================
7  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59 #include <stdio.h>
60 #include <string.h>
61 #include "apps.h"
62 #include <openssl/pem.h>
63 #include <openssl/err.h>
64 #include <openssl/evp.h>
65
66 #define PROG pkeyparam_main
67
68 int MAIN(int, char **);
69
70 int MAIN(int argc, char **argv)
71 {
72     char **args, *infile = NULL, *outfile = NULL;
73     BIO *in = NULL, *out = NULL;
74     int text = 0, noout = 0;
75     EVP_PKEY *pkey = NULL;
76     int badarg = 0;
77 #ifndef OPENSSL_NO_ENGINE
78     char *engine = NULL;
79 #endif
80     int ret = 1;
81
82     if (bio_err == NULL)
83         bio_err = BIO_new_fp(stderr, BIO_NOCLOSE);
84
85     if (!load_config(bio_err, NULL))
86         goto end;
87
88     ERR_load_crypto_strings();
89     OpenSSL_add_all_algorithms();
90     args = argv + 1;
91     while (!badarg && *args && *args[0] == '-') {
92         if (!strcmp(*args, "-in")) {
93             if (args[1]) {
94                 args++;
95                 infile = *args;
96             } else
97                 badarg = 1;
98         } else if (!strcmp(*args, "-out")) {
99             if (args[1]) {
100                 args++;
101                 outfile = *args;
102             } else
103                 badarg = 1;
104         }
105 #ifndef OPENSSL_NO_ENGINE
106         else if (strcmp(*args, "-engine") == 0) {
107             if (!args[1])
108                 goto bad;
109             engine = *(++args);
110         }
111 #endif
112
113         else if (strcmp(*args, "-text") == 0)
114             text = 1;
115         else if (strcmp(*args, "-noout") == 0)
116             noout = 1;
117         args++;
118     }
119
120     if (badarg) {
121 #ifndef OPENSSL_NO_ENGINE
122  bad:
123 #endif
124         BIO_printf(bio_err, "Usage pkeyparam [options]\n");
125         BIO_printf(bio_err, "where options are\n");
126         BIO_printf(bio_err, "-in file        input file\n");
127         BIO_printf(bio_err, "-out file       output file\n");
128         BIO_printf(bio_err, "-text           print parameters as text\n");
129         BIO_printf(bio_err,
130                    "-noout          don't output encoded parameters\n");
131 #ifndef OPENSSL_NO_ENGINE
132         BIO_printf(bio_err,
133                    "-engine e       use engine e, possibly a hardware device.\n");
134 #endif
135         return 1;
136     }
137 #ifndef OPENSSL_NO_ENGINE
138     setup_engine(bio_err, engine, 0);
139 #endif
140
141     if (infile) {
142         if (!(in = BIO_new_file(infile, "r"))) {
143             BIO_printf(bio_err, "Can't open input file %s\n", infile);
144             goto end;
145         }
146     } else
147         in = BIO_new_fp(stdin, BIO_NOCLOSE);
148
149     if (outfile) {
150         if (!(out = BIO_new_file(outfile, "w"))) {
151             BIO_printf(bio_err, "Can't open output file %s\n", outfile);
152             goto end;
153         }
154     } else {
155         out = BIO_new_fp(stdout, BIO_NOCLOSE);
156 #ifdef OPENSSL_SYS_VMS
157         {
158             BIO *tmpbio = BIO_new(BIO_f_linebuffer());
159             out = BIO_push(tmpbio, out);
160         }
161 #endif
162     }
163
164     pkey = PEM_read_bio_Parameters(in, NULL);
165     if (!pkey) {
166         BIO_printf(bio_err, "Error reading parameters\n");
167         ERR_print_errors(bio_err);
168         goto end;
169     }
170
171     if (!noout)
172         PEM_write_bio_Parameters(out, pkey);
173
174     if (text)
175         EVP_PKEY_print_params(out, pkey, 0, NULL);
176
177     ret = 0;
178
179  end:
180     EVP_PKEY_free(pkey);
181     BIO_free_all(out);
182     BIO_free(in);
183
184     return ret;
185 }