secure/lib/libcrypto/man/DH_generate_parameters.3

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "DH_generate_parameters 3"
 132 .TH DH_generate_parameters 3 "2018-03-27" "1.0.2o" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 DH_generate_parameters_ex, DH_generate_parameters,
 139 DH_check \- generate and check Diffie\-Hellman parameters
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 .Vb 1
 143 \& #include <openssl/dh.h>
 144 \&
 145 \& int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
 146 \&
 147 \& int DH_check(DH *dh, int *codes);
 148 .Ve
 149 .PP
 150 Deprecated:
 151 .PP
 152 .Vb 2
 153 \& DH *DH_generate_parameters(int prime_len, int generator,
 154 \&     void (*callback)(int, int, void *), void *cb_arg);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fIDH_generate_parameters_ex()\fR generates Diffie-Hellman parameters that can
 159 be shared among a group of users, and stores them in the provided \fB\s-1DH\s0\fR
 160 structure. The pseudo-random number generator must be
 161 seeded prior to calling \fIDH_generate_parameters()\fR.
 162 .PP
 163 \&\fBprime_len\fR is the length in bits of the safe prime to be generated.
 164 \&\fBgenerator\fR is a small number > 1, typically 2 or 5.
 165 .PP
 166 A callback function may be used to provide feedback about the progress
 167 of the key generation. If \fBcb\fR is not \fB\s-1NULL\s0\fR, it will be
 168 called as described in \fIBN_generate_prime\fR\|(3) while a random prime
 169 number is generated, and when a prime has been found, \fBBN_GENCB_call(cb, 3, 0)\fR
 170 is called. See \fIBN_generate_prime\fR\|(3) for information on
 171 the \fIBN_GENCB_call()\fR function.
 172 .PP
 173 \&\fIDH_check()\fR validates Diffie-Hellman parameters. It checks that \fBp\fR is
 174 a safe prime, and that \fBg\fR is a suitable generator. In the case of an
 175 error, the bit flags \s-1DH_CHECK_P_NOT_SAFE_PRIME\s0 or
 176 \&\s-1DH_NOT_SUITABLE_GENERATOR\s0 are set in \fB*codes\fR.
 177 \&\s-1DH_UNABLE_TO_CHECK_GENERATOR\s0 is set if the generator cannot be
 178 checked, i.e. it does not equal 2 or 5.
 179 .SH "RETURN VALUES"
 180 .IX Header "RETURN VALUES"
 181 \&\fIDH_generate_parameters_ex()\fR and \fIDH_check()\fR return 1 if the check could be
 182 performed, 0 otherwise.
 183 .PP
 184 \&\fIDH_generate_parameters()\fR (deprecated) returns a pointer to the \s-1DH\s0 structure, or
 185 \&\s-1NULL\s0 if the parameter generation fails.
 186 .PP
 187 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 188 .SH "NOTES"
 189 .IX Header "NOTES"
 190 \&\fIDH_generate_parameters_ex()\fR and \fIDH_generate_parameters()\fR may run for several
 191 hours before finding a suitable prime.
 192 .PP
 193 The parameters generated by \fIDH_generate_parameters_ex()\fR and \fIDH_generate_parameters()\fR
 194 are not to be used in signature schemes.
 195 .SH "BUGS"
 196 .IX Header "BUGS"
 197 If \fBgenerator\fR is not 2 or 5, \fBdh\->g\fR=\fBgenerator\fR is not
 198 a usable generator.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fIdh\fR\|(3), \fIERR_get_error\fR\|(3), \fIrand\fR\|(3),
 202 \&\fIDH_free\fR\|(3)
 203 .SH "HISTORY"
 204 .IX Header "HISTORY"
 205 \&\fIDH_check()\fR is available in all versions of SSLeay and OpenSSL.
 206 The \fBcb_arg\fR argument to \fIDH_generate_parameters()\fR was added in SSLeay 0.9.0.
 207 .PP
 208 In versions before OpenSSL 0.9.5, \s-1DH_CHECK_P_NOT_STRONG_PRIME\s0 is used
 209 instead of \s-1DH_CHECK_P_NOT_SAFE_PRIME.\s0