secure/lib/libcrypto/man/DH_generate_parameters.3

   1 .\" Automatically generated by Pod::Man 4.09 (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-11-20" "1.1.1a" "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, DH_check, DH_check_params, DH_check_ex, DH_check_params_ex, DH_check_pub_key_ex \&\- generate and check Diffie\-Hellman parameters
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/dh.h>
 143 \&
 144 \& int DH_generate_parameters_ex(DH *dh, int prime_len, int generator, BN_GENCB *cb);
 145 \&
 146 \& int DH_check(DH *dh, int *codes);
 147 \& int DH_check_params(DH *dh, int *codes);
 148 \&
 149 \& int DH_check_ex(const DH *dh);
 150 \& int DH_check_params_ex(const DH *dh);
 151 \& int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key);
 152 .Ve
 153 .PP
 154 Deprecated:
 155 .PP
 156 .Vb 4
 157 \& #if OPENSSL_API_COMPAT < 0x00908000L
 158 \& DH *DH_generate_parameters(int prime_len, int generator,
 159 \&                            void (*callback)(int, int, void *), void *cb_arg);
 160 \& #endif
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 \&\fIDH_generate_parameters_ex()\fR generates Diffie-Hellman parameters that can
 165 be shared among a group of users, and stores them in the provided \fB\s-1DH\s0\fR
 166 structure. The pseudo-random number generator must be
 167 seeded before calling it.
 168 The parameters generated by \fIDH_generate_parameters_ex()\fR should not be used in
 169 signature schemes.
 170 .PP
 171 \&\fBprime_len\fR is the length in bits of the safe prime to be generated.
 172 \&\fBgenerator\fR is a small number > 1, typically 2 or 5.
 173 .PP
 174 A callback function may be used to provide feedback about the progress
 175 of the key generation. If \fBcb\fR is not \fB\s-1NULL\s0\fR, it will be
 176 called as described in \fIBN_generate_prime\fR\|(3) while a random prime
 177 number is generated, and when a prime has been found, \fBBN_GENCB_call(cb, 3, 0)\fR
 178 is called. See \fIBN_generate_prime_ex\fR\|(3) for information on
 179 the \fIBN_GENCB_call()\fR function.
 180 .PP
 181 \&\fIDH_generate_parameters()\fR is similar to \fIDH_generate_prime_ex()\fR but
 182 expects an old-style callback function; see
 183 \&\fIBN_generate_prime\fR\|(3) for information on the old-style callback.
 184 .PP
 185 \&\fIDH_check_params()\fR confirms that the \fBp\fR and \fBg\fR are likely enough to
 186 be valid.
 187 This is a lightweight check, if a more thorough check is needed, use
 188 \&\fIDH_check()\fR.
 189 The value of \fB*codes\fR is updated with any problems found.
 190 If \fB*codes\fR is zero then no problems were found, otherwise the
 191 following bits may be set:
 192 .IP "\s-1DH_CHECK_P_NOT_PRIME\s0" 4
 193 .IX Item "DH_CHECK_P_NOT_PRIME"
 194 The parameter \fBp\fR has been determined to not being an odd prime.
 195 Note that the lack of this bit doesn't guarantee that \fBp\fR is a
 196 prime.
 197 .IP "\s-1DH_NOT_SUITABLE_GENERATOR\s0" 4
 198 .IX Item "DH_NOT_SUITABLE_GENERATOR"
 199 The generator \fBg\fR is not suitable.
 200 Note that the lack of this bit doesn't guarantee that \fBg\fR is
 201 suitable, unless \fBp\fR is known to be a strong prime.
 202 .PP
 203 \&\fIDH_check()\fR confirms that the Diffie-Hellman parameters \fBdh\fR are valid. The
 204 value of \fB*codes\fR is updated with any problems found. If \fB*codes\fR is zero then
 205 no problems were found, otherwise the following bits may be set:
 206 .IP "\s-1DH_CHECK_P_NOT_PRIME\s0" 4
 207 .IX Item "DH_CHECK_P_NOT_PRIME"
 208 The parameter \fBp\fR is not prime.
 209 .IP "\s-1DH_CHECK_P_NOT_SAFE_PRIME\s0" 4
 210 .IX Item "DH_CHECK_P_NOT_SAFE_PRIME"
 211 The parameter \fBp\fR is not a safe prime and no \fBq\fR value is present.
 212 .IP "\s-1DH_UNABLE_TO_CHECK_GENERATOR\s0" 4
 213 .IX Item "DH_UNABLE_TO_CHECK_GENERATOR"
 214 The generator \fBg\fR cannot be checked for suitability.
 215 .IP "\s-1DH_NOT_SUITABLE_GENERATOR\s0" 4
 216 .IX Item "DH_NOT_SUITABLE_GENERATOR"
 217 The generator \fBg\fR is not suitable.
 218 .IP "\s-1DH_CHECK_Q_NOT_PRIME\s0" 4
 219 .IX Item "DH_CHECK_Q_NOT_PRIME"
 220 The parameter \fBq\fR is not prime.
 221 .IP "\s-1DH_CHECK_INVALID_Q_VALUE\s0" 4
 222 .IX Item "DH_CHECK_INVALID_Q_VALUE"
 223 The parameter \fBq\fR is invalid.
 224 .IP "\s-1DH_CHECK_INVALID_J_VALUE\s0" 4
 225 .IX Item "DH_CHECK_INVALID_J_VALUE"
 226 The parameter \fBj\fR is invalid.
 227 .PP
 228 \&\fIDH_check_ex()\fR, \fIDH_check_params()\fR and \fIDH_check_pub_key_ex()\fR are similar to
 229 \&\fIDH_check()\fR and \fIDH_check_params()\fR respectively, but the error reasons are added
 230 to the thread's error queue instead of provided as return values from the
 231 function.
 232 .SH "RETURN VALUES"
 233 .IX Header "RETURN VALUES"
 234 \&\fIDH_generate_parameters_ex()\fR, \fIDH_check()\fR and \fIDH_check_params()\fR return 1
 235 if the check could be performed, 0 otherwise.
 236 .PP
 237 \&\fIDH_generate_parameters()\fR returns a pointer to the \s-1DH\s0 structure or \s-1NULL\s0 if
 238 the parameter generation fails.
 239 .PP
 240 \&\fIDH_check_ex()\fR, \fIDH_check_params()\fR and \fIDH_check_pub_key_ex()\fR return 1 if the
 241 check is successful, 0 for failed.
 242 .PP
 243 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 244 .SH "SEE ALSO"
 245 .IX Header "SEE ALSO"
 246 \&\fIDH_new\fR\|(3), \fIERR_get_error\fR\|(3), \fIRAND_bytes\fR\|(3),
 247 \&\fIDH_free\fR\|(3)
 248 .SH "HISTORY"
 249 .IX Header "HISTORY"
 250 \&\fIDH_generate_parameters()\fR was deprecated in OpenSSL 0.9.8; use
 251 \&\fIDH_generate_parameters_ex()\fR instead.
 252 .SH "COPYRIGHT"
 253 .IX Header "COPYRIGHT"
 254 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 255 .PP
 256 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 257 this file except in compliance with the License.  You can obtain a copy
 258 in the file \s-1LICENSE\s0 in the source distribution or at
 259 <https://www.openssl.org/source/license.html>.