Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / dsa.3
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
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-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
984263bc 41'br\}
8b0cefbb 42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
8b0cefbb 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
8b0cefbb
JR
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 54..
8b0cefbb
JR
55. nr % 0
56. rr F
984263bc 57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 62.\"
8b0cefbb
JR
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
984263bc 66.if n \{\
8b0cefbb
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
8b0cefbb
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
8b0cefbb 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
8b0cefbb
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
8b0cefbb
JR
90. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 96.\}
8b0cefbb 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 107. \" corrections for vroff
984263bc
MD
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
8b0cefbb
JR
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
8b0cefbb
JR
124.\" ========================================================================
125.\"
126.IX Title "dsa 3"
e3261593 127.TH dsa 3 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
984263bc
MD
132.SH "NAME"
133dsa \- Digital Signature Algorithm
134.SH "SYNOPSIS"
8b0cefbb 135.IX Header "SYNOPSIS"
984263bc
MD
136.Vb 2
137\& #include <openssl/dsa.h>
138\& #include <openssl/engine.h>
e257b235 139\&
984263bc
MD
140\& DSA * DSA_new(void);
141\& void DSA_free(DSA *dsa);
e257b235 142\&
984263bc 143\& int DSA_size(const DSA *dsa);
e257b235 144\&
984263bc
MD
145\& DSA * DSA_generate_parameters(int bits, unsigned char *seed,
146\& int seed_len, int *counter_ret, unsigned long *h_ret,
147\& void (*callback)(int, int, void *), void *cb_arg);
e257b235 148\&
984263bc 149\& DH * DSA_dup_DH(const DSA *r);
e257b235 150\&
984263bc 151\& int DSA_generate_key(DSA *dsa);
e257b235 152\&
984263bc
MD
153\& int DSA_sign(int dummy, const unsigned char *dgst, int len,
154\& unsigned char *sigret, unsigned int *siglen, DSA *dsa);
155\& int DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp,
156\& BIGNUM **rp);
157\& int DSA_verify(int dummy, const unsigned char *dgst, int len,
158\& const unsigned char *sigbuf, int siglen, DSA *dsa);
e257b235 159\&
984263bc
MD
160\& void DSA_set_default_method(const DSA_METHOD *meth);
161\& const DSA_METHOD *DSA_get_default_method(void);
162\& int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
163\& DSA *DSA_new_method(ENGINE *engine);
164\& const DSA_METHOD *DSA_OpenSSL(void);
e257b235 165\&
984263bc
MD
166\& int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
167\& int (*dup_func)(), void (*free_func)());
168\& int DSA_set_ex_data(DSA *d, int idx, char *arg);
169\& char *DSA_get_ex_data(DSA *d, int idx);
e257b235 170\&
984263bc
MD
171\& DSA_SIG *DSA_SIG_new(void);
172\& void DSA_SIG_free(DSA_SIG *a);
173\& int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
174\& DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
e257b235 175\&
984263bc
MD
176\& DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
177\& int DSA_do_verify(const unsigned char *dgst, int dgst_len,
178\& DSA_SIG *sig, DSA *dsa);
e257b235 179\&
984263bc
MD
180\& DSA * d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
181\& DSA * d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
182\& DSA * d2i_DSAparams(DSA **a, unsigned char **pp, long length);
183\& int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
184\& int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
185\& int i2d_DSAparams(const DSA *a,unsigned char **pp);
e257b235 186\&
984263bc
MD
187\& int DSAparams_print(BIO *bp, const DSA *x);
188\& int DSAparams_print_fp(FILE *fp, const DSA *x);
189\& int DSA_print(BIO *bp, const DSA *x, int off);
190\& int DSA_print_fp(FILE *bp, const DSA *x, int off);
191.Ve
192.SH "DESCRIPTION"
8b0cefbb
JR
193.IX Header "DESCRIPTION"
194These functions implement the Digital Signature Algorithm (\s-1DSA\s0). The
195generation of shared \s-1DSA\s0 parameters is described in
196\&\fIDSA_generate_parameters\fR\|(3);
197\&\fIDSA_generate_key\fR\|(3) describes how to
984263bc 198generate a signature key. Signature generation and verification are
8b0cefbb 199described in \fIDSA_sign\fR\|(3).
984263bc 200.PP
8b0cefbb 201The \fB\s-1DSA\s0\fR structure consists of several \s-1BIGNUM\s0 components.
984263bc
MD
202.PP
203.Vb 10
204\& struct
205\& {
206\& BIGNUM *p; // prime number (public)
e257b235 207\& BIGNUM *q; // 160\-bit subprime, q | p\-1 (public)
984263bc
MD
208\& BIGNUM *g; // generator of subgroup (public)
209\& BIGNUM *priv_key; // private key x
210\& BIGNUM *pub_key; // public key y = g^x
211\& // ...
212\& }
213\& DSA;
214.Ve
984263bc 215.PP
8b0cefbb
JR
216In public keys, \fBpriv_key\fR is \s-1NULL\s0.
217.PP
218Note that \s-1DSA\s0 keys may use non-standard \fB\s-1DSA_METHOD\s0\fR implementations,
219either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
220\&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
984263bc 221will not be used by the implementation or may be used for alternative data
8b0cefbb
JR
222storage. For this reason, applications should generally avoid using \s-1DSA\s0
223structure elements directly and instead use \s-1API\s0 functions to query or
984263bc
MD
224modify keys.
225.SH "CONFORMING TO"
74dab6c2 226.IX Header "CONFORMING TO"
8b0cefbb
JR
227\&\s-1US\s0 Federal Information Processing Standard \s-1FIPS\s0 186 (Digital Signature
228Standard, \s-1DSS\s0), \s-1ANSI\s0 X9.30
229.SH "SEE ALSO"
74dab6c2 230.IX Header "SEE ALSO"
8b0cefbb
JR
231\&\fIbn\fR\|(3), \fIdh\fR\|(3), \fIerr\fR\|(3), \fIrand\fR\|(3),
232\&\fIrsa\fR\|(3), \fIsha\fR\|(3), \fIengine\fR\|(3),
233\&\fIDSA_new\fR\|(3),
234\&\fIDSA_size\fR\|(3),
235\&\fIDSA_generate_parameters\fR\|(3),
236\&\fIDSA_dup_DH\fR\|(3),
237\&\fIDSA_generate_key\fR\|(3),
238\&\fIDSA_sign\fR\|(3), \fIDSA_set_method\fR\|(3),
239\&\fIDSA_get_ex_new_index\fR\|(3),
240\&\fIRSA_print\fR\|(3)