secure/lib/libcrypto/man/DSA_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 "DSA_GENERATE_PARAMETERS 3"
 132 .TH DSA_GENERATE_PARAMETERS 3 "2018-09-11" "1.1.1" "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 DSA_generate_parameters_ex, DSA_generate_parameters \- generate DSA parameters
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/dsa.h>
 143 \&
 144 \& int DSA_generate_parameters_ex(DSA *dsa, int bits,
 145 \&                                const unsigned char *seed, int seed_len,
 146 \&                                int *counter_ret, unsigned long *h_ret,
 147 \&                                BN_GENCB *cb);
 148 .Ve
 149 .PP
 150 Deprecated:
 151 .PP
 152 .Vb 5
 153 \& #if OPENSSL_API_COMPAT < 0x00908000L
 154 \& DSA *DSA_generate_parameters(int bits, unsigned char *seed, int seed_len,
 155 \&                              int *counter_ret, unsigned long *h_ret,
 156 \&                              void (*callback)(int, int, void *), void *cb_arg);
 157 \& #endif
 158 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 \&\fIDSA_generate_parameters_ex()\fR generates primes p and q and a generator g
 162 for use in the \s-1DSA\s0 and stores the result in \fBdsa\fR.
 163 .PP
 164 \&\fBbits\fR is the length of the prime p to be generated.
 165 For lengths under 2048 bits, the length of q is 160 bits; for lengths
 166 greater than or equal to 2048 bits, the length of q is set to 256 bits.
 167 .PP
 168 If \fBseed\fR is \s-1NULL,\s0 the primes will be generated at random.
 169 If \fBseed_len\fR is less than the length of q, an error is returned.
 170 .PP
 171 \&\fIDSA_generate_parameters_ex()\fR places the iteration count in
 172 *\fBcounter_ret\fR and a counter used for finding a generator in
 173 *\fBh_ret\fR, unless these are \fB\s-1NULL\s0\fR.
 174 .PP
 175 A callback function may be used to provide feedback about the progress
 176 of the key generation. If \fBcb\fR is not \fB\s-1NULL\s0\fR, it will be
 177 called as shown below. For information on the \s-1BN_GENCB\s0 structure and the
 178 BN_GENCB_call function discussed below, refer to
 179 \&\fIBN_generate_prime\fR\|(3).
 180 .PP
 181 \&\fIDSA_generate_prime()\fR is similar to \fIDSA_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 .IP "\(bu" 2
 185 When a candidate for q is generated, \fBBN_GENCB_call(cb, 0, m++)\fR is called
 186 (m is 0 for the first candidate).
 187 .IP "\(bu" 2
 188 When a candidate for q has passed a test by trial division,
 189 \&\fBBN_GENCB_call(cb, 1, \-1)\fR is called.
 190 While a candidate for q is tested by Miller-Rabin primality tests,
 191 \&\fBBN_GENCB_call(cb, 1, i)\fR is called in the outer loop
 192 (once for each witness that confirms that the candidate may be prime);
 193 i is the loop counter (starting at 0).
 194 .IP "\(bu" 2
 195 When a prime q has been found, \fBBN_GENCB_call(cb, 2, 0)\fR and
 196 \&\fBBN_GENCB_call(cb, 3, 0)\fR are called.
 197 .IP "\(bu" 2
 198 Before a candidate for p (other than the first) is generated and tested,
 199 \&\fBBN_GENCB_call(cb, 0, counter)\fR is called.
 200 .IP "\(bu" 2
 201 When a candidate for p has passed the test by trial division,
 202 \&\fBBN_GENCB_call(cb, 1, \-1)\fR is called.
 203 While it is tested by the Miller-Rabin primality test,
 204 \&\fBBN_GENCB_call(cb, 1, i)\fR is called in the outer loop
 205 (once for each witness that confirms that the candidate may be prime).
 206 i is the loop counter (starting at 0).
 207 .IP "\(bu" 2
 208 When p has been found, \fBBN_GENCB_call(cb, 2, 1)\fR is called.
 209 .IP "\(bu" 2
 210 When the generator has been found, \fBBN_GENCB_call(cb, 3, 1)\fR is called.
 211 .SH "RETURN VALUES"
 212 .IX Header "RETURN VALUES"
 213 \&\fIDSA_generate_parameters_ex()\fR returns a 1 on success, or 0 otherwise.
 214 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 215 .PP
 216 \&\fIDSA_generate_parameters()\fR returns a pointer to the \s-1DSA\s0 structure or
 217 \&\fB\s-1NULL\s0\fR if the parameter generation fails.
 218 .SH "BUGS"
 219 .IX Header "BUGS"
 220 Seed lengths greater than 20 are not supported.
 221 .SH "SEE ALSO"
 222 .IX Header "SEE ALSO"
 223 \&\fIDSA_new\fR\|(3), \fIERR_get_error\fR\|(3), \fIRAND_bytes\fR\|(3),
 224 \&\fIDSA_free\fR\|(3), \fIBN_generate_prime\fR\|(3)
 225 .SH "HISTORY"
 226 .IX Header "HISTORY"
 227 \&\fIDSA_generate_parameters()\fR was deprecated in OpenSSL 0.9.8; use
 228 \&\fIDSA_generate_parameters_ex()\fR instead.
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.