Refactor -passin/-passout documentation

Always refer to openssl.pod instead of repeating the same description
everywhere.

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10126)
This commit is contained in:
Rich Salz 2019-10-08 13:10:04 -04:00 committed by Richard Levitte
parent e20ba0a515
commit 3a4e43de47
22 changed files with 69 additions and 95 deletions

View File

@ -331,11 +331,14 @@ static void list_options_for_command(const char *command)
return;
for ( ; o->name != NULL; o++) {
char c = o->valtype;
if (o->name == OPT_HELP_STR
|| o->name == OPT_MORE_STR
|| o->name[0] == '\0')
continue;
BIO_printf(bio_out, "%s %c\n", o->name, o->valtype);
BIO_printf(bio_out, "%s %c\n", o->name, c == '\0' ? '-' : c);
}
/* Always output the -- marker since it is sometimes documented. */
BIO_printf(bio_out, "- -\n");

View File

@ -166,7 +166,7 @@ self-signed certificate.
=item B<-passin> I<arg>
The key password source. For more information about the format of B<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-notext>

View File

@ -474,7 +474,7 @@ or to modify default parameters for ECDH.
=item B<-passin> I<arg>
The private key password source. For more information about the format of B<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-rand> I<files>

View File

@ -101,7 +101,7 @@ Names and values of these options are algorithm-specific.
=item B<-passin> I<arg>
The private key password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-verify> I<filename>

View File

@ -73,11 +73,6 @@ This specifies the input filename to read a key from or standard input if this
option is not specified. If the key is encrypted a pass phrase will be
prompted for.
=item B<-passin> I<arg>
The input file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-out> I<filename>
This specifies the output filename to write a key to or standard output by
@ -85,10 +80,11 @@ is not specified. If any encryption options are set then a pass phrase will be
prompted for. The output filename should B<not> be the same as the input
filename.
=item B<-passout> I<arg>
=item B<-passin> I<arg>, B<-passout> I<arg>
The output file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
The password source for the input and output file.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>

View File

@ -66,11 +66,6 @@ This specifies the input filename to read a key from or standard input if this
option is not specified. If the key is encrypted a pass phrase will be
prompted for.
=item B<-passin> I<arg>
The input file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-out> I<filename>
This specifies the output filename to write a key to or standard output by
@ -78,10 +73,11 @@ is not specified. If any encryption options are set then a pass phrase will be
prompted for. The output filename should B<not> be the same as the input
filename.
=item B<-passout> I<arg>
=item B<-passin> I<arg>, B<-passout> I<arg>
The output file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
The password source for the input and output file.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=item B<-des>|B<-des3>|B<-idea>

View File

@ -73,7 +73,7 @@ The output filename, standard output by default.
=item B<-pass> I<arg>
The password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-e>

View File

@ -45,7 +45,7 @@ This specifies the output format DER or PEM. The default format is PEM.
=item B<-pass> I<arg>
The output file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-I<cipher>>

View File

@ -52,7 +52,7 @@ standard output is used.
=item B<-passout> I<arg>
The output file password source. For more information about the format
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>

View File

@ -76,22 +76,10 @@ by default.
The filename to write certificates and private keys to, standard output by
default. They are all written in PEM format.
=item B<-passin> I<arg>
The PKCS#12 file (i.e. input file) password source. For more information about
the format of I<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-passout> I<arg>
Pass phrase source to encrypt any outputted private keys with. For more
information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-password> I<arg>
With -export, -password is equivalent to -passout.
Otherwise, -password is equivalent to -passin.
With B<-export>, B<-password> is equivalent to B<-passout>,
otherwise it is equivalent to B<-passin>.
=item B<-noout>
@ -156,7 +144,7 @@ Don't attempt to verify the integrity MAC before reading the file.
Prompt for separate integrity and encryption passwords: most software
always assumes these are the same so this option will render such
PKCS#12 files unreadable. Cannot be used in combination with the options
-password, -passin (if importing) or -passout (if exporting).
B<-password>, B<-passin> if importing, or B<-passout> if exporting.
=back
@ -204,15 +192,12 @@ used multiple times to specify names for all certificates in the order they
appear. Netscape ignores friendly names on other certificates whereas MSIE
displays them.
=item B<-pass> I<arg>, B<-passout> I<arg>
=item B<-passin> I<arg>, B<-passout> I<arg>
The PKCS#12 file (i.e. output file) password source. For more information about
the format of I<arg> see L<openssl(1)/Pass phrase options>.
=item B<-passin> I<password>
Pass phrase source to decrypt any input private keys with. For more information
about the format of I<arg> see L<openssl(1)/Pass phrase options>.
The password source for the input, and for encrypting any private keys that
are output.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=item B<-chain>

View File

@ -73,10 +73,11 @@ This specifies the input filename to read a key from or standard input if this
option is not specified. If the key is encrypted a pass phrase will be
prompted for.
=item B<-passin> I<arg>
=item B<-passin> I<arg>, B<-passout> I<arg>
The input file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
The password source for the input and output file.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=item B<-out> I<filename>
@ -85,11 +86,6 @@ default. If any encryption options are set then a pass phrase will be
prompted for. The output filename should B<not> be the same as the input
filename.
=item B<-passout> I<arg>
The output file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-iter> I<count>
When creating new PKCS#8 containers, use a given number of iterations on

View File

@ -55,10 +55,11 @@ This specifies the input filename to read a key from or standard input if this
option is not specified. If the key is encrypted a pass phrase will be
prompted for.
=item B<-passin> I<arg>
=item B<-passin> I<arg>, B<-passout> I<arg>
The input file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
The password source for the input and output file.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=item B<-out> I<filename>
@ -67,11 +68,6 @@ option is not specified. If any encryption options are set then a pass phrase
will be prompted for. The output filename should B<not> be the same as the input
filename.
=item B<-passout> I<arg>
The output file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-traditional>
Normally a private key is written using standard format: this is PKCS#8 form

View File

@ -95,7 +95,7 @@ The key format PEM, DER or ENGINE. Default is PEM.
=item B<-passin> I<arg>
The input key password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-peerkey> I<file>

View File

@ -90,21 +90,17 @@ options (B<-new> and B<-newkey>) are not specified.
Pass options to the signature algorithm during sign or verify operations.
Names and values of these options are algorithm-specific.
=item B<-passin> I<arg>
=item B<-passin> I<arg>, B<-passout> I<arg>
The input file password source. For more information about the format of B<arg>
see L<openssl(1)/Pass phrase options>.
The password source for the input and output file.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=item B<-out> I<filename>
This specifies the output filename to write to or standard output by
default.
=item B<-passout> I<arg>
The output file password source. For more information about the format of B<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-text>
Prints out the certificate request in text form.

View File

@ -73,10 +73,11 @@ This specifies the input filename to read a key from or standard input if this
option is not specified. If the key is encrypted a pass phrase will be
prompted for.
=item B<-passin> I<arg>
=item B<-passin> I<arg>, B<-passout> I<arg>
The input file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
The password source for the input and output file.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=item B<-out> I<filename>
@ -85,11 +86,6 @@ option is not specified. If any encryption options are set then a pass phrase
will be prompted for. The output filename should B<not> be the same as the input
filename.
=item B<-passout> I<arg>
The output file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
=item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
These options encrypt the private key with the specified

View File

@ -200,7 +200,7 @@ the network. Use with caution.
The proxy password source, used with the B<-proxy_user> flag.
For more information about the format of B<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-unix> I<path>

View File

@ -306,7 +306,7 @@ The private format to use: DER or PEM. PEM is the default.
=item B<-pass> I<val>
The private key password source. For more information about the format of B<val>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-dcert> I<infile>, B<-dkey> I<infile>

View File

@ -296,7 +296,7 @@ specified, the argument is given to the engine as a key identifier.
=item B<-passin> I<arg>
The private key password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-rand> I<files>

View File

@ -61,7 +61,7 @@ The default is PEM.
=item B<-passin> I<arg>
The input file password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-challenge> I<string>

View File

@ -35,17 +35,6 @@ For B<-list>, if no I<user> is given then all users are displayed.
The configuration file to use, and the section within the file, can be
specified with the B<-config> and B<-name> flags, respectively.
If the config file is not specified, the B<-srpvfile> can be used to
just specify the file to operate on.
The B<-userinfo> option specifies additional information to add when
adding or modifying a user.
The B<-gn> flag specifies the I<g> and I<N> values, using one of
the strengths defined in IETF RFC 5054.
The B<-passin> and B<-passout> arguments are parsed as described in
the L<openssl(1)/Pass phrase options> command.
=head1 OPTIONS
@ -59,6 +48,27 @@ Display an option summary.
Generate verbose output while processing.
=item B<-srpvfile> I<file>
If the config file is not specified,
B<-srpvfile> can be used to specify the file to operate on.
=item B<-gn>
Specifies the B<g> and B<N> values, using one of
the strengths defined in IETF RFC 5054.
=item B<-userinfo>
specifies additional information to add when
adding or modifying a user.
=item B<-passin> I<arg>, B<-passout> I<arg>
The password source for the input and output file.
For more information about the format of B<arg>
see L<openssl(1)/Pass Phrase Options>.
=back
=head1 COPYRIGHT

View File

@ -50,7 +50,7 @@ this option prevents output of the PEM data.
=item B<-passin> I<arg>
the key password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-text>

View File

@ -373,7 +373,7 @@ Names and values of these options are algorithm-specific.
=item B<-passin> I<arg>
The key password source. For more information about the format of I<arg>
see L<openssl(1)/Pass phrase options>.
see L<openssl(1)/Pass Phrase Options>.
=item B<-clrext>