secure/lib/libcrypto/man/DSA_generate_parameters.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:42:51 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "DSA_generate_parameters 3"
 141 .TH DSA_generate_parameters 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 DSA_generate_parameters \- generate \s-1DSA\s0 parameters
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .Vb 1
 148 \& #include <openssl/dsa.h>
 149 .Ve
 150 .Vb 3
 151 \& DSA *DSA_generate_parameters(int bits, unsigned char *seed,
 152 \&                int seed_len, int *counter_ret, unsigned long *h_ret,
 153 \&                void (*callback)(int, int, void *), void *cb_arg);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 \&\fIDSA_generate_parameters()\fR generates primes p and q and a generator g
 158 for use in the \s-1DSA\s0.
 159 .PP
 160 \&\fBbits\fR is the length of the prime to be generated; the \s-1DSS\s0 allows a
 161 maximum of 1024 bits.
 162 .PP
 163 If \fBseed\fR is \fB\s-1NULL\s0\fR or \fBseed_len\fR < 20, the primes will be
 164 generated at random. Otherwise, the seed is used to generate
 165 them. If the given seed does not yield a prime q, a new random
 166 seed is chosen and placed at \fBseed\fR.
 167 .PP
 168 \&\fIDSA_generate_parameters()\fR places the iteration count in
 169 *\fBcounter_ret\fR and a counter used for finding a generator in
 170 *\fBh_ret\fR, unless these are \fB\s-1NULL\s0\fR.
 171 .PP
 172 A callback function may be used to provide feedback about the progress
 173 of the key generation. If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it will be
 174 called as follows:
 175 .Ip "\(bu" 4
 176 When a candidate for q is generated, \fBcallback(0, m++, cb_arg)\fR is called
 177 (m is 0 for the first candidate).
 178 .Ip "\(bu" 4
 179 When a candidate for q has passed a test by trial division,
 180 \&\fBcallback(1, \-1, cb_arg)\fR is called.
 181 While a candidate for q is tested by Miller-Rabin primality tests,
 182 \&\fBcallback(1, i, cb_arg)\fR is called in the outer loop
 183 (once for each witness that confirms that the candidate may be prime);
 184 i is the loop counter (starting at 0).
 185 .Ip "\(bu" 4
 186 When a prime q has been found, \fBcallback(2, 0, cb_arg)\fR and
 187 \&\fBcallback(3, 0, cb_arg)\fR are called.
 188 .Ip "\(bu" 4
 189 Before a candidate for p (other than the first) is generated and tested,
 190 \&\fBcallback(0, counter, cb_arg)\fR is called.
 191 .Ip "\(bu" 4
 192 When a candidate for p has passed the test by trial division,
 193 \&\fBcallback(1, \-1, cb_arg)\fR is called.
 194 While it is tested by the Miller-Rabin primality test,
 195 \&\fBcallback(1, i, cb_arg)\fR is called in the outer loop
 196 (once for each witness that confirms that the candidate may be prime).
 197 i is the loop counter (starting at 0).
 198 .Ip "\(bu" 4
 199 When p has been found, \fBcallback(2, 1, cb_arg)\fR is called.
 200 .Ip "\(bu" 4
 201 When the generator has been found, \fBcallback(3, 1, cb_arg)\fR is called.
 202 .SH "RETURN VALUE"
 203 .IX Header "RETURN VALUE"
 204 \&\fIDSA_generate_parameters()\fR returns a pointer to the \s-1DSA\s0 structure, or
 205 \&\fB\s-1NULL\s0\fR if the parameter generation fails. The error codes can be
 206 obtained by ERR_get_error(3).
 207 .SH "BUGS"
 208 .IX Header "BUGS"
 209 Seed lengths > 20 are not supported.
 210 .SH "SEE ALSO"
 211 .IX Header "SEE ALSO"
 212 dsa(3), ERR_get_error(3), rand(3),
 213 DSA_free(3)
 214 .SH "HISTORY"
 215 .IX Header "HISTORY"
 216 \&\fIDSA_generate_parameters()\fR appeared in SSLeay 0.8. The \fBcb_arg\fR
 217 argument was added in SSLeay 0.9.0.
 218 In versions up to OpenSSL 0.9.4, \fBcallback(1, ...)\fR was called
 219 in the inner loop of the Miller-Rabin test whenever it reached the
 220 squaring step (the parameters to \fBcallback\fR did not reveal how many
 221 witnesses had been tested); since OpenSSL 0.9.5, \fBcallback(1, ...)\fR
 222 is called as in \fIBN_is_prime\fR\|(3), i.e. once for each witness.
 223 =cut