]> git.ipfire.org Git - thirdparty/openssl.git/blob - apps/rsa.c
Add "sections" to -help output
[thirdparty/openssl.git] / apps / rsa.c
1 /*
2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10 #include <openssl/opensslconf.h>
11 #ifdef OPENSSL_NO_RSA
12 NON_EMPTY_TRANSLATION_UNIT
13 #else
14
15 # include <stdio.h>
16 # include <stdlib.h>
17 # include <string.h>
18 # include <time.h>
19 # include "apps.h"
20 # include "progs.h"
21 # include <openssl/bio.h>
22 # include <openssl/err.h>
23 # include <openssl/rsa.h>
24 # include <openssl/evp.h>
25 # include <openssl/x509.h>
26 # include <openssl/pem.h>
27 # include <openssl/bn.h>
28
29 typedef enum OPTION_choice {
30 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
31 OPT_INFORM, OPT_OUTFORM, OPT_ENGINE, OPT_IN, OPT_OUT,
32 OPT_PUBIN, OPT_PUBOUT, OPT_PASSOUT, OPT_PASSIN,
33 OPT_RSAPUBKEY_IN, OPT_RSAPUBKEY_OUT,
34 /* Do not change the order here; see case statements below */
35 OPT_PVK_NONE, OPT_PVK_WEAK, OPT_PVK_STRONG,
36 OPT_NOOUT, OPT_TEXT, OPT_MODULUS, OPT_CHECK, OPT_CIPHER
37 } OPTION_CHOICE;
38
39 const OPTIONS rsa_options[] = {
40 OPT_SECTION("General"),
41 {"help", OPT_HELP, '-', "Display this summary"},
42 {"check", OPT_CHECK, '-', "Verify key consistency"},
43 {"", OPT_CIPHER, '-', "Any supported cipher"},
44 # ifndef OPENSSL_NO_ENGINE
45 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
46 # endif
47
48 OPT_SECTION("Input"),
49 {"in", OPT_IN, 's', "Input file"},
50 {"inform", OPT_INFORM, 'f', "Input format, one of DER PEM"},
51 {"pubin", OPT_PUBIN, '-', "Expect a public key in input file"},
52 {"RSAPublicKey_in", OPT_RSAPUBKEY_IN, '-', "Input is an RSAPublicKey"},
53 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
54
55 OPT_SECTION("Output"),
56 {"out", OPT_OUT, '>', "Output file"},
57 {"outform", OPT_OUTFORM, 'f', "Output format, one of DER PEM PVK"},
58 {"pubout", OPT_PUBOUT, '-', "Output a public key"},
59 {"RSAPublicKey_out", OPT_RSAPUBKEY_OUT, '-', "Output is an RSAPublicKey"},
60 {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
61 {"noout", OPT_NOOUT, '-', "Don't print key out"},
62 {"text", OPT_TEXT, '-', "Print the key in text"},
63 {"modulus", OPT_MODULUS, '-', "Print the RSA key modulus"},
64
65 # if !defined(OPENSSL_NO_DSA) && !defined(OPENSSL_NO_RC4)
66 OPT_SECTION("PVK"),
67 {"pvk-strong", OPT_PVK_STRONG, '-', "Enable 'Strong' PVK encoding level (default)"},
68 {"pvk-weak", OPT_PVK_WEAK, '-', "Enable 'Weak' PVK encoding level"},
69 {"pvk-none", OPT_PVK_NONE, '-', "Don't enforce PVK encoding"},
70 # endif
71 {NULL}
72 };
73
74 int rsa_main(int argc, char **argv)
75 {
76 ENGINE *e = NULL;
77 BIO *out = NULL;
78 RSA *rsa = NULL;
79 const EVP_CIPHER *enc = NULL;
80 char *infile = NULL, *outfile = NULL, *prog;
81 char *passin = NULL, *passout = NULL, *passinarg = NULL, *passoutarg = NULL;
82 int i, private = 0;
83 int informat = FORMAT_PEM, outformat = FORMAT_PEM, text = 0, check = 0;
84 int noout = 0, modulus = 0, pubin = 0, pubout = 0, ret = 1;
85 # if !defined(OPENSSL_NO_DSA) && !defined(OPENSSL_NO_RC4)
86 int pvk_encr = 2;
87 # endif
88 OPTION_CHOICE o;
89
90 prog = opt_init(argc, argv, rsa_options);
91 while ((o = opt_next()) != OPT_EOF) {
92 switch (o) {
93 case OPT_EOF:
94 case OPT_ERR:
95 opthelp:
96 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
97 goto end;
98 case OPT_HELP:
99 opt_help(rsa_options);
100 ret = 0;
101 goto end;
102 case OPT_INFORM:
103 if (!opt_format(opt_arg(), OPT_FMT_ANY, &informat))
104 goto opthelp;
105 break;
106 case OPT_IN:
107 infile = opt_arg();
108 break;
109 case OPT_OUTFORM:
110 if (!opt_format(opt_arg(), OPT_FMT_ANY, &outformat))
111 goto opthelp;
112 break;
113 case OPT_OUT:
114 outfile = opt_arg();
115 break;
116 case OPT_PASSIN:
117 passinarg = opt_arg();
118 break;
119 case OPT_PASSOUT:
120 passoutarg = opt_arg();
121 break;
122 case OPT_ENGINE:
123 e = setup_engine(opt_arg(), 0);
124 break;
125 case OPT_PUBIN:
126 pubin = 1;
127 break;
128 case OPT_PUBOUT:
129 pubout = 1;
130 break;
131 case OPT_RSAPUBKEY_IN:
132 pubin = 2;
133 break;
134 case OPT_RSAPUBKEY_OUT:
135 pubout = 2;
136 break;
137 case OPT_PVK_STRONG: /* pvk_encr:= 2 */
138 case OPT_PVK_WEAK: /* pvk_encr:= 1 */
139 case OPT_PVK_NONE: /* pvk_encr:= 0 */
140 # if !defined(OPENSSL_NO_DSA) && !defined(OPENSSL_NO_RC4)
141 pvk_encr = (o - OPT_PVK_NONE);
142 # endif
143 break;
144 case OPT_NOOUT:
145 noout = 1;
146 break;
147 case OPT_TEXT:
148 text = 1;
149 break;
150 case OPT_MODULUS:
151 modulus = 1;
152 break;
153 case OPT_CHECK:
154 check = 1;
155 break;
156 case OPT_CIPHER:
157 if (!opt_cipher(opt_unknown(), &enc))
158 goto opthelp;
159 break;
160 }
161 }
162 argc = opt_num_rest();
163 if (argc != 0)
164 goto opthelp;
165
166 private = (text && !pubin) || (!pubout && !noout) ? 1 : 0;
167
168 if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
169 BIO_printf(bio_err, "Error getting passwords\n");
170 goto end;
171 }
172 if (check && pubin) {
173 BIO_printf(bio_err, "Only private keys can be checked\n");
174 goto end;
175 }
176
177 {
178 EVP_PKEY *pkey;
179
180 if (pubin) {
181 int tmpformat = -1;
182 if (pubin == 2) {
183 if (informat == FORMAT_PEM)
184 tmpformat = FORMAT_PEMRSA;
185 else if (informat == FORMAT_ASN1)
186 tmpformat = FORMAT_ASN1RSA;
187 } else {
188 tmpformat = informat;
189 }
190
191 pkey = load_pubkey(infile, tmpformat, 1, passin, e, "Public Key");
192 } else {
193 pkey = load_key(infile, informat, 1, passin, e, "Private Key");
194 }
195
196 if (pkey != NULL)
197 rsa = EVP_PKEY_get1_RSA(pkey);
198 EVP_PKEY_free(pkey);
199 }
200
201 if (rsa == NULL) {
202 ERR_print_errors(bio_err);
203 goto end;
204 }
205
206 out = bio_open_owner(outfile, outformat, private);
207 if (out == NULL)
208 goto end;
209
210 if (text) {
211 assert(pubin || private);
212 if (!RSA_print(out, rsa, 0)) {
213 perror(outfile);
214 ERR_print_errors(bio_err);
215 goto end;
216 }
217 }
218
219 if (modulus) {
220 const BIGNUM *n;
221 RSA_get0_key(rsa, &n, NULL, NULL);
222 BIO_printf(out, "Modulus=");
223 BN_print(out, n);
224 BIO_printf(out, "\n");
225 }
226
227 if (check) {
228 int r = RSA_check_key_ex(rsa, NULL);
229
230 if (r == 1) {
231 BIO_printf(out, "RSA key ok\n");
232 } else if (r == 0) {
233 unsigned long err;
234
235 while ((err = ERR_peek_error()) != 0 &&
236 ERR_GET_LIB(err) == ERR_LIB_RSA &&
237 ERR_GET_REASON(err) != ERR_R_MALLOC_FAILURE) {
238 BIO_printf(out, "RSA key error: %s\n",
239 ERR_reason_error_string(err));
240 ERR_get_error(); /* remove err from error stack */
241 }
242 } else if (r == -1) {
243 ERR_print_errors(bio_err);
244 goto end;
245 }
246 }
247
248 if (noout) {
249 ret = 0;
250 goto end;
251 }
252 BIO_printf(bio_err, "writing RSA key\n");
253 if (outformat == FORMAT_ASN1) {
254 if (pubout || pubin) {
255 if (pubout == 2)
256 i = i2d_RSAPublicKey_bio(out, rsa);
257 else
258 i = i2d_RSA_PUBKEY_bio(out, rsa);
259 } else {
260 assert(private);
261 i = i2d_RSAPrivateKey_bio(out, rsa);
262 }
263 } else if (outformat == FORMAT_PEM) {
264 if (pubout || pubin) {
265 if (pubout == 2)
266 i = PEM_write_bio_RSAPublicKey(out, rsa);
267 else
268 i = PEM_write_bio_RSA_PUBKEY(out, rsa);
269 } else {
270 assert(private);
271 i = PEM_write_bio_RSAPrivateKey(out, rsa,
272 enc, NULL, 0, NULL, passout);
273 }
274 # ifndef OPENSSL_NO_DSA
275 } else if (outformat == FORMAT_MSBLOB || outformat == FORMAT_PVK) {
276 EVP_PKEY *pk;
277 pk = EVP_PKEY_new();
278 if (pk == NULL)
279 goto end;
280
281 EVP_PKEY_set1_RSA(pk, rsa);
282 if (outformat == FORMAT_PVK) {
283 if (pubin) {
284 BIO_printf(bio_err, "PVK form impossible with public key input\n");
285 EVP_PKEY_free(pk);
286 goto end;
287 }
288 assert(private);
289 # ifdef OPENSSL_NO_RC4
290 BIO_printf(bio_err, "PVK format not supported\n");
291 EVP_PKEY_free(pk);
292 goto end;
293 # else
294 i = i2b_PVK_bio(out, pk, pvk_encr, 0, passout);
295 # endif
296 } else if (pubin || pubout) {
297 i = i2b_PublicKey_bio(out, pk);
298 } else {
299 assert(private);
300 i = i2b_PrivateKey_bio(out, pk);
301 }
302 EVP_PKEY_free(pk);
303 # endif
304 } else {
305 BIO_printf(bio_err, "bad output format specified for outfile\n");
306 goto end;
307 }
308 if (i <= 0) {
309 BIO_printf(bio_err, "unable to write key\n");
310 ERR_print_errors(bio_err);
311 } else {
312 ret = 0;
313 }
314 end:
315 release_engine(e);
316 BIO_free_all(out);
317 RSA_free(rsa);
318 OPENSSL_free(passin);
319 OPENSSL_free(passout);
320 return ret;
321 }
322 #endif