Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libcrypto / man / dsa.3
... / ...
CommitLineData
1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
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-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
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' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
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.
59.ie \nF \{\
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
62..
63. nr % 0
64. rr F
65.\}
66.el \{\
67. de IX
68..
69.\}
70.\"
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
74.if n \{\
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
80.\}
81.if t \{\
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
87.\}
88. \" simple accents for nroff and troff
89.if n \{\
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
96.\}
97.if t \{\
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'
104.\}
105. \" troff and (daisy-wheel) nroff accents
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
115. \" corrections for vroff
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'
118. \" for low resolution devices (crt and lpr)
119.if \n(.H>23 .if \n(.V>19 \
120\{\
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
130.\}
131.rm #[ #] #H #V #F C
132.\" ========================================================================
133.\"
134.IX Title "dsa 3"
135.TH dsa 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
140.SH "NAME"
141dsa \- Digital Signature Algorithm
142.SH "SYNOPSIS"
143.IX Header "SYNOPSIS"
144.Vb 2
145\& #include <openssl/dsa.h>
146\& #include <openssl/engine.h>
147\&
148\& DSA * DSA_new(void);
149\& void DSA_free(DSA *dsa);
150\&
151\& int DSA_size(const DSA *dsa);
152\&
153\& DSA * DSA_generate_parameters(int bits, unsigned char *seed,
154\& int seed_len, int *counter_ret, unsigned long *h_ret,
155\& void (*callback)(int, int, void *), void *cb_arg);
156\&
157\& DH * DSA_dup_DH(const DSA *r);
158\&
159\& int DSA_generate_key(DSA *dsa);
160\&
161\& int DSA_sign(int dummy, const unsigned char *dgst, int len,
162\& unsigned char *sigret, unsigned int *siglen, DSA *dsa);
163\& int DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp,
164\& BIGNUM **rp);
165\& int DSA_verify(int dummy, const unsigned char *dgst, int len,
166\& const unsigned char *sigbuf, int siglen, DSA *dsa);
167\&
168\& void DSA_set_default_method(const DSA_METHOD *meth);
169\& const DSA_METHOD *DSA_get_default_method(void);
170\& int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
171\& DSA *DSA_new_method(ENGINE *engine);
172\& const DSA_METHOD *DSA_OpenSSL(void);
173\&
174\& int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
175\& int (*dup_func)(), void (*free_func)());
176\& int DSA_set_ex_data(DSA *d, int idx, char *arg);
177\& char *DSA_get_ex_data(DSA *d, int idx);
178\&
179\& DSA_SIG *DSA_SIG_new(void);
180\& void DSA_SIG_free(DSA_SIG *a);
181\& int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
182\& DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
183\&
184\& DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
185\& int DSA_do_verify(const unsigned char *dgst, int dgst_len,
186\& DSA_SIG *sig, DSA *dsa);
187\&
188\& DSA * d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
189\& DSA * d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
190\& DSA * d2i_DSAparams(DSA **a, unsigned char **pp, long length);
191\& int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
192\& int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
193\& int i2d_DSAparams(const DSA *a,unsigned char **pp);
194\&
195\& int DSAparams_print(BIO *bp, const DSA *x);
196\& int DSAparams_print_fp(FILE *fp, const DSA *x);
197\& int DSA_print(BIO *bp, const DSA *x, int off);
198\& int DSA_print_fp(FILE *bp, const DSA *x, int off);
199.Ve
200.SH "DESCRIPTION"
201.IX Header "DESCRIPTION"
202These functions implement the Digital Signature Algorithm (\s-1DSA\s0). The
203generation of shared \s-1DSA\s0 parameters is described in
204\&\fIDSA_generate_parameters\fR\|(3);
205\&\fIDSA_generate_key\fR\|(3) describes how to
206generate a signature key. Signature generation and verification are
207described in \fIDSA_sign\fR\|(3).
208.PP
209The \fB\s-1DSA\s0\fR structure consists of several \s-1BIGNUM\s0 components.
210.PP
211.Vb 10
212\& struct
213\& {
214\& BIGNUM *p; // prime number (public)
215\& BIGNUM *q; // 160\-bit subprime, q | p\-1 (public)
216\& BIGNUM *g; // generator of subgroup (public)
217\& BIGNUM *priv_key; // private key x
218\& BIGNUM *pub_key; // public key y = g^x
219\& // ...
220\& }
221\& DSA;
222.Ve
223.PP
224In public keys, \fBpriv_key\fR is \s-1NULL\s0.
225.PP
226Note that \s-1DSA\s0 keys may use non-standard \fB\s-1DSA_METHOD\s0\fR implementations,
227either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
228\&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
229will not be used by the implementation or may be used for alternative data
230storage. For this reason, applications should generally avoid using \s-1DSA\s0
231structure elements directly and instead use \s-1API\s0 functions to query or
232modify keys.
233.SH "CONFORMING TO"
234.IX Header "CONFORMING TO"
235\&\s-1US\s0 Federal Information Processing Standard \s-1FIPS\s0 186 (Digital Signature
236Standard, \s-1DSS\s0), \s-1ANSI\s0 X9.30
237.SH "SEE ALSO"
238.IX Header "SEE ALSO"
239\&\fIbn\fR\|(3), \fIdh\fR\|(3), \fIerr\fR\|(3), \fIrand\fR\|(3),
240\&\fIrsa\fR\|(3), \fIsha\fR\|(3), \fIengine\fR\|(3),
241\&\fIDSA_new\fR\|(3),
242\&\fIDSA_size\fR\|(3),
243\&\fIDSA_generate_parameters\fR\|(3),
244\&\fIDSA_dup_DH\fR\|(3),
245\&\fIDSA_generate_key\fR\|(3),
246\&\fIDSA_sign\fR\|(3), \fIDSA_set_method\fR\|(3),
247\&\fIDSA_get_ex_new_index\fR\|(3),
248\&\fIRSA_print\fR\|(3)