secure/lib/libcrypto/man/DH_generate_parameters.3

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