Commit ef7eaa4c authored by Dr. Stephen Henson's avatar Dr. Stephen Henson
Browse files

Manpages for the DH utils and fix for a memory leak in dh program

parent dad666fb
Loading
Loading
Loading
Loading
+3 −2
Original line number Diff line number Diff line
@@ -149,8 +149,8 @@ int MAIN(int argc, char **argv)
bad:
		BIO_printf(bio_err,"%s [options] <infile >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);
		}


doc/man/dh.pod

0 → 100644
+87 −0
Original line number Diff line number Diff line
=pod

=head1 NAME

dh - DH parameter manipulation and generation

=head1 SYNOPSIS

B<openssl dh>
[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<DER> 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<DER> 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<not> 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<get_dhXXX()> 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<rsa> and B<dsa> programs manipulate keys
and not parameters.

There should be a way to generate and manipulate DH keys.

=head1 SEE ALSO

dsaparam(1)

=cut

doc/man/gendh.pod

0 → 100644
+72 −0
Original line number Diff line number Diff line
=pod

=head1 NAME

gendh - DH parameter generation

=head1 SYNOPSIS

B<openssl gendh>
[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<numbits>

this option specifies that a parameter set should be generated of size
B<numbits>. 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<gendsa> and B<genrsa> generate
actual keys and not parameters.

There should be a way to generate and manipulate DH keys.

=head1 SEE ALSO

dsaparam(1)

=cut
+1 −1
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ B<-envpass pass>

The B<pkcs12> 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