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