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