From ef7eaa4cb0cf07c79cb0d294c7d24c2f74e1bdcf Mon Sep 17 00:00:00 2001 From: "Dr. Stephen Henson" Date: Sat, 8 Jan 2000 13:36:17 +0000 Subject: [PATCH] Manpages for the DH utils and fix for a memory leak in dh program --- apps/dh.c | 5 +-- doc/man/dh.pod | 87 ++++++++++++++++++++++++++++++++++++++++++++++ doc/man/gendh.pod | 72 ++++++++++++++++++++++++++++++++++++++ doc/man/pkcs12.pod | 2 +- 4 files changed, 163 insertions(+), 3 deletions(-) create mode 100644 doc/man/dh.pod create mode 100644 doc/man/gendh.pod diff --git a/apps/dh.c b/apps/dh.c index 9efdcd78a3..d68b388085 100644 --- a/apps/dh.c +++ b/apps/dh.c @@ -149,8 +149,8 @@ int MAIN(int argc, char **argv) bad: BIO_printf(bio_err,"%s [options] outfile\n",prog); BIO_printf(bio_err,"where options are\n"); - BIO_printf(bio_err," -inform arg input format - one of DER TXT PEM\n"); - BIO_printf(bio_err," -outform arg output format - one of DER TXT PEM\n"); + BIO_printf(bio_err," -inform arg input format - one of DER PEM\n"); + BIO_printf(bio_err," -outform arg output format - one of DER PEM\n"); BIO_printf(bio_err," -in arg input file\n"); BIO_printf(bio_err," -out arg output file\n"); BIO_printf(bio_err," -check check the DH parameters\n"); @@ -282,6 +282,7 @@ bad: printf("\tif ((dh->p == NULL) || (dh->g == NULL))\n"); printf("\t\treturn(NULL);\n"); printf("\treturn(dh);\n\t}\n"); + Free(data); } diff --git a/doc/man/dh.pod b/doc/man/dh.pod new file mode 100644 index 0000000000..99b307368f --- /dev/null +++ b/doc/man/dh.pod @@ -0,0 +1,87 @@ +=pod + +=head1 NAME + +dh - DH parameter manipulation and generation + +=head1 SYNOPSIS + +B +[B<-inform DER|PEM>] +[B<-outform DER|PEM>] +[B<-in filename>] +[B<-out filename>] +[B<-noout>] +[B<-text>] +[B<-C>] + +=head1 DESCRIPTION + +This command is used to manipulate DH parameter files. + +=head1 OPTIONS + +=over 4 + +=item B<-inform DER|PEM> + +This specifies the input format. The B option uses an ASN1 DER encoded +form compatible with the PKCS#3 DHparameter structure. The PEM form is the +default format: it consists of the B format base64 encoded with +additional header and footer lines. + +=item B<-outform DER|PEM> + +This specifies the output format, the options have the same meaning as the +B<-inform> option. + +=item B<-in filename> + +This specifies the input filename to read parameters from or standard input if +this option is not specified. + +=item B<-out filename> + +This specifies the output filename parameters to. Standard output is used +if this option is not present. The output filename should B be the same +as the input filename. + +=item B<-noout> + +this option inhibits the output of the encoded version of the parameters. + +=item B<-text> + +this option prints out the DH parameters in human readable form. + +=item B<-C> + +this option converts the parameters into C code. The parameters can then +be loaded by calling the B function. + +=back + +=head1 NOTES + +PEM format DH parameters use the header and footer lines: + + -----BEGIN DH PARAMETERS----- + -----END DH PARAMETERS----- + +OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42 +DH. + +This program manipulates DH parameters not keys. + +=head1 BUGS + +This program is badly named: the B and B programs manipulate keys +and not parameters. + +There should be a way to generate and manipulate DH keys. + +=head1 SEE ALSO + +dsaparam(1) + +=cut diff --git a/doc/man/gendh.pod b/doc/man/gendh.pod new file mode 100644 index 0000000000..d51ebf0b44 --- /dev/null +++ b/doc/man/gendh.pod @@ -0,0 +1,72 @@ +=pod + +=head1 NAME + +gendh - DH parameter generation + +=head1 SYNOPSIS + +B +[B<-out filename>] +[B<-2>] +[B<-5>] +[B<-rand file:file>] +[numbits] + +=head1 DESCRIPTION + +This command is used to generate DH parameter files. + +=head1 OPTIONS + +=over 4 + +=item B<-out filename> + +This specifies the output filename parameters to. Standard output is used +if this option is not present. The output format is a base64 encoded form of +a PKCS#5 DHParameter structure. + +=item B<-2>, B<-5> + +The generator to use, either 2 or 5. 2 is the default. + +=item B<-rand file:file> + +a file or files containing random data used to seed the random number +generator. Multiple files can be specified separated by B<:>. + +=item B + +this option specifies that a parameter set should be generated of size +B. It must be the last option. If not present then a value of 512 +is used. + +=back + +=head1 NOTES + +PEM format DH parameters use the header and footer lines: + + -----BEGIN DH PARAMETERS----- + -----END DH PARAMETERS----- + +DH parameter generation is a slow process and as a result the same set of +DH parameters is often reused. + +OpenSSL currently uses PKCS#3 DH not the more recent X9.42 DH. + +This program creates DH parameters only, not DH keys. + +=head1 BUGS + +The program is badly named. The programs B and B generate +actual keys and not parameters. + +There should be a way to generate and manipulate DH keys. + +=head1 SEE ALSO + +dsaparam(1) + +=cut diff --git a/doc/man/pkcs12.pod b/doc/man/pkcs12.pod index 7b40f6cbc4..b97abb2772 100644 --- a/doc/man/pkcs12.pod +++ b/doc/man/pkcs12.pod @@ -42,7 +42,7 @@ B<-envpass pass> The B command allows PKCS#12 files (sometimes referred to as PFX files) to be created and parsed. PKCS#12 files are used by several -software programs including Netscape, MSIE and MS Outlook. +programs including Netscape, MSIE and MS Outlook. =head1 COMMAND OPTIONS -- 2.34.1