2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include <openssl/opensslconf.h>
18 #include <openssl/bio.h>
19 #include <openssl/err.h>
20 #include <openssl/rsa.h>
21 #include <openssl/evp.h>
22 #include <openssl/x509.h>
23 #include <openssl/pem.h>
24 #include <openssl/bn.h>
25 #include <openssl/encoder.h>
28 * TODO: This include is to get OSSL_KEYMGMT_SELECT_*, which feels a bit
29 * much just for those macros... they might serve better as EVP macros.
31 #include <openssl/core_dispatch.h>
33 #ifndef OPENSSL_NO_RC4
34 # define DEFAULT_PVK_ENCR_STRENGTH 2
36 # define DEFAULT_PVK_ENCR_STRENGTH 0
39 typedef enum OPTION_choice
{
40 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
,
41 OPT_INFORM
, OPT_OUTFORM
, OPT_ENGINE
, OPT_IN
, OPT_OUT
,
42 OPT_PUBIN
, OPT_PUBOUT
, OPT_PASSOUT
, OPT_PASSIN
,
43 OPT_RSAPUBKEY_IN
, OPT_RSAPUBKEY_OUT
,
44 /* Do not change the order here; see case statements below */
45 OPT_PVK_NONE
, OPT_PVK_WEAK
, OPT_PVK_STRONG
,
46 OPT_NOOUT
, OPT_TEXT
, OPT_MODULUS
, OPT_CHECK
, OPT_CIPHER
,
47 OPT_PROV_ENUM
, OPT_TRADITIONAL
50 const OPTIONS rsa_options
[] = {
51 OPT_SECTION("General"),
52 {"help", OPT_HELP
, '-', "Display this summary"},
53 {"check", OPT_CHECK
, '-', "Verify key consistency"},
54 {"", OPT_CIPHER
, '-', "Any supported cipher"},
55 #ifndef OPENSSL_NO_ENGINE
56 {"engine", OPT_ENGINE
, 's', "Use engine, possibly a hardware device"},
60 {"in", OPT_IN
, 's', "Input file"},
61 {"inform", OPT_INFORM
, 'f', "Input format (DER/PEM/P12/ENGINE"},
62 {"pubin", OPT_PUBIN
, '-', "Expect a public key in input file"},
63 {"RSAPublicKey_in", OPT_RSAPUBKEY_IN
, '-', "Input is an RSAPublicKey"},
64 {"passin", OPT_PASSIN
, 's', "Input file pass phrase source"},
66 OPT_SECTION("Output"),
67 {"out", OPT_OUT
, '>', "Output file"},
68 {"outform", OPT_OUTFORM
, 'f', "Output format, one of DER PEM PVK"},
69 {"pubout", OPT_PUBOUT
, '-', "Output a public key"},
70 {"RSAPublicKey_out", OPT_RSAPUBKEY_OUT
, '-', "Output is an RSAPublicKey"},
71 {"passout", OPT_PASSOUT
, 's', "Output file pass phrase source"},
72 {"noout", OPT_NOOUT
, '-', "Don't print key out"},
73 {"text", OPT_TEXT
, '-', "Print the key in text"},
74 {"modulus", OPT_MODULUS
, '-', "Print the RSA key modulus"},
75 {"traditional", OPT_TRADITIONAL
, '-',
76 "Use traditional format for private keys"},
78 #ifndef OPENSSL_NO_RC4
80 {"pvk-strong", OPT_PVK_STRONG
, '-', "Enable 'Strong' PVK encoding level (default)"},
81 {"pvk-weak", OPT_PVK_WEAK
, '-', "Enable 'Weak' PVK encoding level"},
82 {"pvk-none", OPT_PVK_NONE
, '-', "Don't enforce PVK encoding"},
89 int rsa_main(int argc
, char **argv
)
93 EVP_PKEY
*pkey
= NULL
;
95 const EVP_CIPHER
*enc
= NULL
;
96 char *infile
= NULL
, *outfile
= NULL
, *ciphername
= NULL
, *prog
;
97 char *passin
= NULL
, *passout
= NULL
, *passinarg
= NULL
, *passoutarg
= NULL
;
99 int informat
= FORMAT_PEM
, outformat
= FORMAT_PEM
, text
= 0, check
= 0;
100 int noout
= 0, modulus
= 0, pubin
= 0, pubout
= 0, ret
= 1;
101 int pvk_encr
= DEFAULT_PVK_ENCR_STRENGTH
;
104 const char *output_type
= NULL
;
105 const char *output_structure
= NULL
;
107 OSSL_ENCODER_CTX
*ectx
= NULL
;
109 prog
= opt_init(argc
, argv
, rsa_options
);
110 while ((o
= opt_next()) != OPT_EOF
) {
115 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
118 opt_help(rsa_options
);
122 if (!opt_format(opt_arg(), OPT_FMT_ANY
, &informat
))
129 if (!opt_format(opt_arg(), OPT_FMT_ANY
, &outformat
))
136 passinarg
= opt_arg();
139 passoutarg
= opt_arg();
142 e
= setup_engine(opt_arg(), 0);
150 case OPT_RSAPUBKEY_IN
:
153 case OPT_RSAPUBKEY_OUT
:
156 case OPT_PVK_STRONG
: /* pvk_encr:= 2 */
157 case OPT_PVK_WEAK
: /* pvk_encr:= 1 */
158 case OPT_PVK_NONE
: /* pvk_encr:= 0 */
159 pvk_encr
= (o
- OPT_PVK_NONE
);
174 ciphername
= opt_unknown();
177 if (!opt_provider(o
))
180 case OPT_TRADITIONAL
:
186 /* No extra arguments. */
187 argc
= opt_num_rest();
191 if (ciphername
!= NULL
) {
192 if (!opt_cipher(ciphername
, &enc
))
195 private = (text
&& !pubin
) || (!pubout
&& !noout
) ? 1 : 0;
197 if (!app_passwd(passinarg
, passoutarg
, &passin
, &passout
)) {
198 BIO_printf(bio_err
, "Error getting passwords\n");
201 if (check
&& pubin
) {
202 BIO_printf(bio_err
, "Only private keys can be checked\n");
210 if (informat
== FORMAT_PEM
)
211 tmpformat
= FORMAT_PEMRSA
;
212 else if (informat
== FORMAT_ASN1
)
213 tmpformat
= FORMAT_ASN1RSA
;
215 tmpformat
= informat
;
218 pkey
= load_pubkey(infile
, tmpformat
, 1, passin
, e
, "public key");
220 pkey
= load_key(infile
, informat
, 1, passin
, e
, "private key");
224 ERR_print_errors(bio_err
);
227 if (!EVP_PKEY_is_a(pkey
, "RSA")) {
228 BIO_printf(bio_err
, "Not an RSA key\n");
232 out
= bio_open_owner(outfile
, outformat
, private);
237 assert(pubin
|| private);
238 if ((pubin
&& EVP_PKEY_print_public(out
, pkey
, 0, NULL
) <= 0)
239 || (!pubin
&& EVP_PKEY_print_private(out
, pkey
, 0, NULL
) <= 0)) {
241 ERR_print_errors(bio_err
);
249 /* Every RSA key has an 'n' */
250 EVP_PKEY_get_bn_param(pkey
, "n", &n
);
251 BIO_printf(out
, "Modulus=");
253 BIO_printf(out
, "\n");
260 pctx
= EVP_PKEY_CTX_new_from_pkey(NULL
, pkey
, NULL
);
262 BIO_printf(bio_err
, "RSA unable to create PKEY context\n");
263 ERR_print_errors(bio_err
);
266 r
= EVP_PKEY_check(pctx
);
267 EVP_PKEY_CTX_free(pctx
);
270 BIO_printf(out
, "RSA key ok\n");
272 BIO_printf(bio_err
, "RSA key not ok\n");
273 ERR_print_errors(bio_err
);
274 } else if (r
== -1) {
275 ERR_print_errors(bio_err
);
284 BIO_printf(bio_err
, "writing RSA key\n");
286 /* Choose output type for the format */
287 if (outformat
== FORMAT_ASN1
) {
289 } else if (outformat
== FORMAT_PEM
) {
291 } else if (outformat
== FORMAT_MSBLOB
) {
292 output_type
= "MSBLOB";
293 } else if (outformat
== FORMAT_PVK
) {
295 BIO_printf(bio_err
, "PVK form impossible with public key input\n");
300 BIO_printf(bio_err
, "bad output format specified for outfile\n");
304 /* Select what you want in the output */
305 if (pubout
|| pubin
) {
306 selection
= OSSL_KEYMGMT_SELECT_PUBLIC_KEY
;
309 selection
= (OSSL_KEYMGMT_SELECT_KEYPAIR
310 | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
);
313 /* For DER based output, select the desired output structure */
314 if (outformat
== FORMAT_ASN1
|| outformat
== FORMAT_PEM
) {
315 if (pubout
|| pubin
) {
317 output_structure
= "pkcs1"; /* "type-specific" would work too */
319 output_structure
= "SubjectPublicKeyInfo";
323 output_structure
= "pkcs1"; /* "type-specific" would work too */
325 output_structure
= "pkcs8";
329 /* Now, perform the encoding */
330 ectx
= OSSL_ENCODER_CTX_new_for_pkey(pkey
, selection
,
331 output_type
, output_structure
,
333 if (OSSL_ENCODER_CTX_get_num_encoders(ectx
) == 0) {
334 BIO_printf(bio_err
, "%s format not supported\n", output_type
);
338 /* PVK is a bit special... */
339 if (outformat
== FORMAT_PVK
) {
340 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
342 params
[0] = OSSL_PARAM_construct_int("encrypt-level", &pvk_encr
);
343 if (!OSSL_ENCODER_CTX_set_params(ectx
, params
)) {
344 BIO_printf(bio_err
, "invalid PVK encryption level\n");
349 if (!OSSL_ENCODER_to_bio(ectx
, out
)) {
350 BIO_printf(bio_err
, "unable to write key\n");
351 ERR_print_errors(bio_err
);
356 OSSL_ENCODER_CTX_free(ectx
);
360 OPENSSL_free(passin
);
361 OPENSSL_free(passout
);