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