From a397aca43598ef20c84e69f6d6e5d95652aa0325 Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Thu, 3 Oct 2019 22:28:40 -0400 Subject: [PATCH] Refactor many common flags into openssl.pod Options moved: -rand, -writerand, -CApath, -CAfile, -no-CApath, -no-CAfile Added rand to dgst and srp manpages (they were missing them). New sections in openssl.pod: Random State Options, Trusted Certificate Options. Cleanup and add comments to find-doc-nits Remove ".in" file support; unless giving specific arguments, this only runs after configuration Reviewed-by: Tomas Mraz Reviewed-by: Dmitry Belyavskiy Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/10118) --- doc/man1/openssl-ca.pod | 12 +-- doc/man1/openssl-cms.pod | 31 +------ doc/man1/openssl-crl.pod | 14 +--- doc/man1/openssl-dgst.pod | 13 +-- doc/man1/openssl-dhparam.pod | 12 +-- doc/man1/openssl-dsaparam.pod | 12 +-- doc/man1/openssl-ecparam.pod | 12 +-- doc/man1/openssl-enc.pod | 12 +-- doc/man1/openssl-gendsa.pod | 12 +-- doc/man1/openssl-genrsa.pod | 12 +-- doc/man1/openssl-ocsp.pod | 13 +-- doc/man1/openssl-passwd.pod | 12 +-- doc/man1/openssl-pkcs12.pod | 30 +------ doc/man1/openssl-pkcs8.pod | 12 +-- doc/man1/openssl-pkeyutl.pod | 12 +-- doc/man1/openssl-rand.pod | 18 +---- doc/man1/openssl-req.pod | 12 +-- doc/man1/openssl-rsautl.pod | 12 +-- doc/man1/openssl-s_client.pod | 31 +------ doc/man1/openssl-s_server.pod | 33 +------- doc/man1/openssl-s_time.pod | 13 +-- doc/man1/openssl-smime.pod | 31 +------ doc/man1/openssl-speed.pod | 12 +-- doc/man1/openssl-srp.pod | 6 ++ doc/man1/openssl-ts.pod | 27 +------ doc/man1/openssl-verify.pod | 21 +---- doc/man1/openssl-x509.pod | 12 +-- doc/man1/openssl.pod | 75 +++++++++++++++++ doc/man1/tsget.pod | 4 +- util/find-doc-nits | 147 +++++++++++++++++----------------- 30 files changed, 225 insertions(+), 450 deletions(-) diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod index e51e5dda6f..5ff5fd954c 100644 --- a/doc/man1/openssl-ca.pod +++ b/doc/man1/openssl-ca.pod @@ -294,17 +294,9 @@ C If B<-multi-rdn> is not used then the UID value is C<123456+CN=John Doe>. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-sm2-id> I diff --git a/doc/man1/openssl-cms.pod b/doc/man1/openssl-cms.pod index 507490498c..54620fef32 100644 --- a/doc/man1/openssl-cms.pod +++ b/doc/man1/openssl-cms.pod @@ -285,24 +285,9 @@ structure is being checked. For the B<-cmsout> operation print out all fields of the CMS structure. This is mainly useful for testing purposes. -=item B<-CAfile> I +=item B<-CAfile> I, B<-no-CAfile>, B<-CApath> I, B<-no-CApath> -A file containing trusted CA certificates, only used with B<-verify>. - -=item B<-CApath> I - -A directory containing trusted CA certificates, only used with -B<-verify>. This directory must be a standard certificate directory: that -is a hash of each subject name (using C) should be linked -to each certificate. - -=item B<-no-CAfile> - -Do not load the trusted CA certificates from the default file location - -=item B<-no-CApath> - -Do not load the trusted CA certificates from the default directory location +See L for more information. =item B<-md> I @@ -476,17 +461,9 @@ or to modify default parameters for ECDH. The private key password source. For more information about the format of B see L. -=item B<-rand> I - -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I +=item B<-rand> I, B<-writerand> I -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item I ... diff --git a/doc/man1/openssl-crl.pod b/doc/man1/openssl-crl.pod index fa29d4b0c4..9e5f6ca7c0 100644 --- a/doc/man1/openssl-crl.pod +++ b/doc/man1/openssl-crl.pod @@ -21,6 +21,8 @@ B B [B<-nextupdate>] [B<-CAfile> I] [B<-CApath> I] +[B<-no-CAfile>] +[B<-no-CApath>] =for openssl ifdef hash_old @@ -92,17 +94,9 @@ Output the lastUpdate field. Output the nextUpdate field. -=item B<-CAfile> I +=item B<-CAfile> I, B<-no-CAfile>, B<-CApath> I, B<-no-CApath> -Verify the signature on a CRL by looking up the issuing certificate in -I. - -=item B<-CApath> I - -Verify the signature on a CRL by looking up the issuing certificate in -I. This directory must be a standard certificate directory: that -is a hash of each subject name (using the L B<-hash> option) -should be linked to each certificate. +See L for more information. =back diff --git a/doc/man1/openssl-dgst.pod b/doc/man1/openssl-dgst.pod index b2da9229cf..7859d75da7 100644 --- a/doc/man1/openssl-dgst.pod +++ b/doc/man1/openssl-dgst.pod @@ -25,6 +25,7 @@ B B|I [B<-hmac> I] [B<-fips-fingerprint>] [B<-rand> I] +[B<-writerand> I] [B<-engine> I] [B<-engine_impl>] [I ...] @@ -158,17 +159,9 @@ for example exactly 32 chars for gost-mac. The L command should be preferred to using this command line option. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-fips-fingerprint> diff --git a/doc/man1/openssl-dhparam.pod b/doc/man1/openssl-dhparam.pod index c7929e8126..a28d1b81f8 100644 --- a/doc/man1/openssl-dhparam.pod +++ b/doc/man1/openssl-dhparam.pod @@ -86,17 +86,9 @@ input file is ignored and parameters are generated instead. If not present but I is present, parameters are generated with the default generator 2. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item I diff --git a/doc/man1/openssl-dsaparam.pod b/doc/man1/openssl-dsaparam.pod index cc5570f333..5c145ef1fb 100644 --- a/doc/man1/openssl-dsaparam.pod +++ b/doc/man1/openssl-dsaparam.pod @@ -76,17 +76,9 @@ be loaded by calling the get_dsaXXX() function. This option will generate a DSA either using the specified or generated parameters. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-engine> I diff --git a/doc/man1/openssl-ecparam.pod b/doc/man1/openssl-ecparam.pod index e52d1833e1..09c6927320 100644 --- a/doc/man1/openssl-ecparam.pod +++ b/doc/man1/openssl-ecparam.pod @@ -124,17 +124,9 @@ is included in the ECParameters structure (see RFC 3279). This option will generate an EC private key using the specified parameters. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-engine> I diff --git a/doc/man1/openssl-enc.pod b/doc/man1/openssl-enc.pod index 99486ee152..592e4f5764 100644 --- a/doc/man1/openssl-enc.pod +++ b/doc/man1/openssl-enc.pod @@ -185,17 +185,9 @@ or zlib-dynamic option. Use NULL cipher (no encryption or decryption of input). -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =back diff --git a/doc/man1/openssl-gendsa.pod b/doc/man1/openssl-gendsa.pod index 62fc25089e..451a3c4835 100644 --- a/doc/man1/openssl-gendsa.pod +++ b/doc/man1/openssl-gendsa.pod @@ -53,17 +53,9 @@ These options encrypt the private key with specified cipher before outputting it. A pass phrase is prompted for. If none of these options is specified no encryption is used. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-engine> I diff --git a/doc/man1/openssl-genrsa.pod b/doc/man1/openssl-genrsa.pod index 2b3c5c303f..d04c8eeb19 100644 --- a/doc/man1/openssl-genrsa.pod +++ b/doc/man1/openssl-genrsa.pod @@ -65,17 +65,9 @@ for if it is not supplied via the B<-passout> argument. The public exponent to use, either 65537 or 3. The default is 65537. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-engine> I diff --git a/doc/man1/openssl-ocsp.pod b/doc/man1/openssl-ocsp.pod index 5e75e6af53..6fc077506f 100644 --- a/doc/man1/openssl-ocsp.pod +++ b/doc/man1/openssl-ocsp.pod @@ -207,18 +207,9 @@ each child is willing to wait for the client's OCSP response. This option is available on POSIX systems (that support the fork() and other required unix system-calls). -=item B<-CAfile> I, B<-CApath> I +=item B<-CAfile> I, B<-no-CAfile>, B<-CApath> I, B<-no-CApath> -File or pathname containing trusted CA certificates. These are used to verify -the signature on the OCSP response. - -=item B<-no-CAfile> - -Do not load the trusted CA certificates from the default file location - -=item B<-no-CApath> - -Do not load the trusted CA certificates from the default directory location +See L for more information. =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>, B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>, diff --git a/doc/man1/openssl-passwd.pod b/doc/man1/openssl-passwd.pod index c1daac17ab..e7502ae332 100644 --- a/doc/man1/openssl-passwd.pod +++ b/doc/man1/openssl-passwd.pod @@ -93,17 +93,9 @@ Don't output warnings when passwords given at the command line are truncated. In the output list, prepend the cleartext password and a TAB character to each password hash. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =back diff --git a/doc/man1/openssl-pkcs12.pod b/doc/man1/openssl-pkcs12.pod index 412438285f..5742549891 100644 --- a/doc/man1/openssl-pkcs12.pod +++ b/doc/man1/openssl-pkcs12.pod @@ -263,35 +263,13 @@ to be needed to use MAC iterations counts but they are now used by default. Don't attempt to provide the MAC integrity. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. +See L for more information. -=item B<-writerand> I +=item B<-CAfile> I, B<-no-CAfile>, B<-CApath> I, B<-no-CApath> -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. - -=item B<-CAfile> I - -CA storage as a file. - -=item B<-CApath> I - -CA storage as a directory. This directory must be a standard certificate -directory: that is a hash of each subject name (using C) -should be linked to each certificate. - -=item B<-no-CAfile> - -Do not load the trusted CA certificates from the default file location. - -=item B<-no-CApath> - -Do not load the trusted CA certificates from the default directory location. +See L for more information. =item B<-CSP> I diff --git a/doc/man1/openssl-pkcs8.pod b/doc/man1/openssl-pkcs8.pod index 01c13487b6..e3d779a165 100644 --- a/doc/man1/openssl-pkcs8.pod +++ b/doc/man1/openssl-pkcs8.pod @@ -101,17 +101,9 @@ This option does not encrypt private keys at all and should only be used when absolutely necessary. Certain software such as some versions of Java code signing software used unencrypted private keys. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-v2> I diff --git a/doc/man1/openssl-pkeyutl.pod b/doc/man1/openssl-pkeyutl.pod index 6ad2306421..58c90436b8 100644 --- a/doc/man1/openssl-pkeyutl.pod +++ b/doc/man1/openssl-pkeyutl.pod @@ -177,17 +177,9 @@ hex dump the output data. Parse the ASN.1 output data, this is useful when combined with the B<-verifyrecover> option when an ASN1 structure is signed. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-engine> I diff --git a/doc/man1/openssl-rand.pod b/doc/man1/openssl-rand.pod index f63859e304..c32b10242e 100644 --- a/doc/man1/openssl-rand.pod +++ b/doc/man1/openssl-rand.pod @@ -20,11 +20,7 @@ I =head1 DESCRIPTION This command outputs I pseudo-random bytes after seeding -the random number generator once. As in other B command -line tools, PRNG seeding uses the file F<$HOME/.rnd> or F<.rnd> -in addition to the files given in the B<-rand> option. A new -F<$HOME/.rnd> or F<.rnd> file will be written back if enough -seeding was obtained from these sources. +the random number generator once. =head1 OPTIONS @@ -38,17 +34,9 @@ Print out a usage message. Write to I instead of standard output. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-base64> diff --git a/doc/man1/openssl-req.pod b/doc/man1/openssl-req.pod index 13f6257492..b84a4c92ab 100644 --- a/doc/man1/openssl-req.pod +++ b/doc/man1/openssl-req.pod @@ -137,17 +137,9 @@ in the configuration file and any requested extensions. If the B<-key> option is not used it will generate a new RSA private key using information specified in the configuration file. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-newkey> I diff --git a/doc/man1/openssl-rsautl.pod b/doc/man1/openssl-rsautl.pod index 508237364c..0b5fc73830 100644 --- a/doc/man1/openssl-rsautl.pod +++ b/doc/man1/openssl-rsautl.pod @@ -84,17 +84,9 @@ Encrypt the input data using an RSA public key. Decrypt the input data using an RSA private key. -=item B<-rand> I +=item B<-rand> I, B<-writerand> I -The files containing random data used to seed the random number generator. -Multiple files can be specified separated by an OS-dependent character. -The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for -all others. - -=item B<-writerand> I - -Writes random data to the specified I upon exit. -This can be used with a subsequent B<-rand> flag. +See L for more information. =item B<-pkcs>, B<-oaep>, B<-ssl>, B<-raw> diff --git a/doc/man1/openssl-s_client.pod b/doc/man1/openssl-s_client.pod index b7021cdf9a..0bb8781947 100644 --- a/doc/man1/openssl-s_client.pod +++ b/doc/man1/openssl-s_client.pod @@ -306,16 +306,9 @@ I