xref: /freebsd/secure/usr.bin/openssl/man/openssl-dhparam.1 (revision 9f23cbd6cae82fd77edfad7173432fa8dccd0a95)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OPENSSL-DHPARAM 1"
OPENSSL-DHPARAM 1 "2023-06-02" "3.0.9" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
openssl-dhparam - DH parameter manipulation and generation
"SYNOPSIS"
Header "SYNOPSIS" \fBopenssl dhparam [-help] [-inform \s-1DER\s0|\s-1PEM\s0] [-outform \s-1DER\s0|\s-1PEM\s0] [-in filename] [-out filename] [-dsaparam] [-check] [-noout] [-text] [-2] [-3] [-5] [-engine id] [-rand files] [-writerand file] [-provider name] [-provider-path path] [-propquery propq] [numbits]
"DESCRIPTION"
Header "DESCRIPTION" This command is used to manipulate \s-1DH\s0 parameter files.

See \*(L"\s-1EXAMPLES\*(R"\s0 in openssl-genpkey\|(1) for examples on how to generate a key using a named safe prime group without generating intermediate parameters.

"OPTIONS"
Header "OPTIONS"
"-help" 4
Item "-help" Print out a usage message.
"-inform \s-1DER\s0|\s-1PEM\s0, -outform \s-1DER\s0|\s-1PEM\s0" 4
Item "-inform DER|PEM, -outform DER|PEM" The input format and output format; the default is \s-1PEM\s0. The object is compatible with the PKCS#3 DHparameter structure. See openssl-format-options\|(1) for details.
"-in filename" 4
Item "-in filename" This specifies the input filename to read parameters from or standard input if this option is not specified.
"-out filename" 4
Item "-out filename" This specifies the output filename parameters to. Standard output is used if this option is not present. The output filename should not be the same as the input filename.
"-dsaparam" 4
Item "-dsaparam" If this option is used, \s-1DSA\s0 rather than \s-1DH\s0 parameters are read or created; they are converted to \s-1DH\s0 format. Otherwise, \*(L"strong\*(R" primes (such that (p-1)/2 is also prime) will be used for \s-1DH\s0 parameter generation. .Sp \s-1DH\s0 parameter generation with the -dsaparam option is much faster, and the recommended exponent length is shorter, which makes \s-1DH\s0 key exchange more efficient. Beware that with such DSA-style \s-1DH\s0 parameters, a fresh \s-1DH\s0 key should be created for each use to avoid small-subgroup attacks that may be possible otherwise.
"-check" 4
Item "-check" Performs numerous checks to see if the supplied parameters are valid and displays a warning if not.
"-2, -3, -5" 4
Item "-2, -3, -5" The generator to use, either 2, 3 or 5. If present then the input file is ignored and parameters are generated instead. If not present but numbits is present, parameters are generated with the default generator 2.
"numbits" 4
Item "numbits" This option specifies that a parameter set should be generated of size \fInumbits. It must be the last option. If this option is present then the input file is ignored and parameters are generated instead. If this option is not present but a generator (-2, -3 or -5) is present, parameters are generated with a default length of 2048 bits. The minimim length is 512 bits. The maximum length is 10000 bits.
"-noout" 4
Item "-noout" This option inhibits the output of the encoded version of the parameters.
"-text" 4
Item "-text" This option prints out the \s-1DH\s0 parameters in human readable form.
"-engine id" 4
Item "-engine id" See \*(L"Engine Options\*(R" in openssl\|(1). This option is deprecated.
"-rand files, -writerand file" 4
Item "-rand files, -writerand file" See \*(L"Random State Options\*(R" in openssl\|(1) for details.
"-provider name" 4
Item "-provider name"

0

"-provider-path path" 4
Item "-provider-path path"
"-propquery propq" 4
Item "-propquery propq"

See \*(L"Provider Options\*(R" in openssl\|(1), provider\|(7), and property\|(7).

"NOTES"
Header "NOTES" This command replaces the dh and gendh commands of previous releases.
"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1), \fBopenssl-pkeyparam\|(1), \fBopenssl-dsaparam\|(1), \fBopenssl-genpkey\|(1).
"HISTORY"
Header "HISTORY" The -engine option was deprecated in OpenSSL 3.0.

The -C option was removed in OpenSSL 3.0.

"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.