lib/libcrypto/man/DH_generate_parameters.3

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   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 turned on, 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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "DH_generate_parameters 3"
 136 .TH DH_generate_parameters 3 "2016-05-03" "1.0.2h" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 DH_generate_parameters_ex, DH_generate_parameters,
 143 DH_check \- generate and check Diffie\-Hellman parameters
 144 .SH "SYNOPSIS"
 145 .IX Header "SYNOPSIS"
 146 .Vb 1
 147 \& #include <openssl/dh.h>
 148 \&
 149 \& int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
 150 \&
 151 \& int DH_check(DH *dh, int *codes);
 152 .Ve
 153 .PP
 154 Deprecated:
 155 .PP
 156 .Vb 2
 157 \& DH *DH_generate_parameters(int prime_len, int generator,
 158 \&     void (*callback)(int, int, void *), void *cb_arg);
 159 .Ve
 160 .SH "DESCRIPTION"
 161 .IX Header "DESCRIPTION"
 162 \&\fIDH_generate_parameters_ex()\fR generates Diffie-Hellman parameters that can
 163 be shared among a group of users, and stores them in the provided \fB\s-1DH\s0\fR
 164 structure. The pseudo-random number generator must be
 165 seeded prior to calling \fIDH_generate_parameters()\fR.
 166 .PP
 167 \&\fBprime_len\fR is the length in bits of the safe prime to be generated.
 168 \&\fBgenerator\fR is a small number > 1, typically 2 or 5.
 169 .PP
 170 A callback function may be used to provide feedback about the progress
 171 of the key generation. If \fBcb\fR is not \fB\s-1NULL\s0\fR, it will be
 172 called as described in \fIBN_generate_prime\fR\|(3) while a random prime
 173 number is generated, and when a prime has been found, \fBBN_GENCB_call(cb, 3, 0)\fR
 174 is called. See \fIBN_generate_prime\fR\|(3) for information on
 175 the \fIBN_GENCB_call()\fR function.
 176 .PP
 177 \&\fIDH_check()\fR validates Diffie-Hellman parameters. It checks that \fBp\fR is
 178 a safe prime, and that \fBg\fR is a suitable generator. In the case of an
 179 error, the bit flags \s-1DH_CHECK_P_NOT_SAFE_PRIME\s0 or
 180 \&\s-1DH_NOT_SUITABLE_GENERATOR\s0 are set in \fB*codes\fR.
 181 \&\s-1DH_UNABLE_TO_CHECK_GENERATOR\s0 is set if the generator cannot be
 182 checked, i.e. it does not equal 2 or 5.
 183 .SH "RETURN VALUES"
 184 .IX Header "RETURN VALUES"
 185 \&\fIDH_generate_parameters_ex()\fR and \fIDH_check()\fR return 1 if the check could be
 186 performed, 0 otherwise.
 187 .PP
 188 \&\fIDH_generate_parameters()\fR (deprecated) returns a pointer to the \s-1DH\s0 structure, or
 189 \&\s-1NULL\s0 if the parameter generation fails.
 190 .PP
 191 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 192 .SH "NOTES"
 193 .IX Header "NOTES"
 194 \&\fIDH_generate_parameters_ex()\fR and \fIDH_generate_parameters()\fR may run for several
 195 hours before finding a suitable prime.
 196 .PP
 197 The parameters generated by \fIDH_generate_parameters_ex()\fR and \fIDH_generate_parameters()\fR
 198 are not to be used in signature schemes.
 199 .SH "BUGS"
 200 .IX Header "BUGS"
 201 If \fBgenerator\fR is not 2 or 5, \fBdh\->g\fR=\fBgenerator\fR is not
 202 a usable generator.
 203 .SH "SEE ALSO"
 204 .IX Header "SEE ALSO"
 205 \&\fIdh\fR\|(3), \fIERR_get_error\fR\|(3), \fIrand\fR\|(3),
 206 \&\fIDH_free\fR\|(3)
 207 .SH "HISTORY"
 208 .IX Header "HISTORY"
 209 \&\fIDH_check()\fR is available in all versions of SSLeay and OpenSSL.
 210 The \fBcb_arg\fR argument to \fIDH_generate_parameters()\fR was added in SSLeay 0.9.0.
 211 .PP
 212 In versions before OpenSSL 0.9.5, \s-1DH_CHECK_P_NOT_STRONG_PRIME\s0 is used
 213 instead of \s-1DH_CHECK_P_NOT_SAFE_PRIME.\s0