3cc4a3404e9aad39a6395600940f0a4ea6b76b80
[dragonfly.git] / secure / lib / libcrypto / man / ecdsa.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
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-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
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' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
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"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
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
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
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'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
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
116 .    \" corrections for vroff
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'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
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
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "ecdsa 3"
136 .TH ecdsa 3 "2015-03-19" "1.0.1m" "OpenSSL"
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
141 .SH "NAME"
142 ecdsa \- Elliptic Curve Digital Signature Algorithm
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/ecdsa.h>
147 \&
148 \& ECDSA_SIG*     ECDSA_SIG_new(void);
149 \& void           ECDSA_SIG_free(ECDSA_SIG *sig);
150 \& int            i2d_ECDSA_SIG(const ECDSA_SIG *sig, unsigned char **pp);
151 \& ECDSA_SIG*     d2i_ECDSA_SIG(ECDSA_SIG **sig, const unsigned char **pp, 
152 \&                long len);
153 \&
154 \& ECDSA_SIG*     ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
155 \&                        EC_KEY *eckey);
156 \& ECDSA_SIG*     ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen, 
157 \&                        const BIGNUM *kinv, const BIGNUM *rp,
158 \&                        EC_KEY *eckey);
159 \& int            ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
160 \&                        const ECDSA_SIG *sig, EC_KEY* eckey);
161 \& int            ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx,
162 \&                        BIGNUM **kinv, BIGNUM **rp);
163 \& int            ECDSA_sign(int type, const unsigned char *dgst,
164 \&                        int dgstlen, unsigned char *sig,
165 \&                        unsigned int *siglen, EC_KEY *eckey);
166 \& int            ECDSA_sign_ex(int type, const unsigned char *dgst,
167 \&                        int dgstlen, unsigned char *sig,
168 \&                        unsigned int *siglen, const BIGNUM *kinv, 
169 \&                        const BIGNUM *rp, EC_KEY *eckey);
170 \& int            ECDSA_verify(int type, const unsigned char *dgst,
171 \&                        int dgstlen, const unsigned char *sig,
172 \&                        int siglen, EC_KEY *eckey);
173 \& int            ECDSA_size(const EC_KEY *eckey);
174 \&
175 \& const ECDSA_METHOD*    ECDSA_OpenSSL(void);
176 \& void           ECDSA_set_default_method(const ECDSA_METHOD *meth);
177 \& const ECDSA_METHOD*    ECDSA_get_default_method(void);
178 \& int            ECDSA_set_method(EC_KEY *eckey,const ECDSA_METHOD *meth);
179 \&
180 \& int            ECDSA_get_ex_new_index(long argl, void *argp,
181 \&                        CRYPTO_EX_new *new_func,
182 \&                        CRYPTO_EX_dup *dup_func,
183 \&                        CRYPTO_EX_free *free_func);
184 \& int            ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
185 \& void*          ECDSA_get_ex_data(EC_KEY *d, int idx);
186 .Ve
187 .SH "DESCRIPTION"
188 .IX Header "DESCRIPTION"
189 The \fB\s-1ECDSA_SIG\s0\fR structure consists of two BIGNUMs for the
190 r and s value of a \s-1ECDSA\s0 signature (see X9.62 or \s-1FIPS 186\-2\s0).
191 .PP
192 .Vb 5
193 \& struct
194 \&        {
195 \&        BIGNUM *r;
196 \&        BIGNUM *s;
197 \& } ECDSA_SIG;
198 .Ve
199 .PP
200 \&\fIECDSA_SIG_new()\fR allocates a new \fB\s-1ECDSA_SIG\s0\fR structure (note: this
201 function also allocates the BIGNUMs) and initialize it.
202 .PP
203 \&\fIECDSA_SIG_free()\fR frees the \fB\s-1ECDSA_SIG\s0\fR structure \fBsig\fR.
204 .PP
205 \&\fIi2d_ECDSA_SIG()\fR creates the \s-1DER\s0 encoding of the \s-1ECDSA\s0 signature
206 \&\fBsig\fR and writes the encoded signature to \fB*pp\fR (note: if \fBpp\fR
207 is \s-1NULL \s0\fBi2d_ECDSA_SIG\fR returns the expected length in bytes of 
208 the \s-1DER\s0 encoded signature). \fBi2d_ECDSA_SIG\fR returns the length
209 of the \s-1DER\s0 encoded signature (or 0 on error).
210 .PP
211 \&\fId2i_ECDSA_SIG()\fR decodes a \s-1DER\s0 encoded \s-1ECDSA\s0 signature and returns
212 the decoded signature in a newly allocated \fB\s-1ECDSA_SIG\s0\fR structure.
213 \&\fB*sig\fR points to the buffer containing the \s-1DER\s0 encoded signature
214 of size \fBlen\fR.
215 .PP
216 \&\fIECDSA_size()\fR returns the maximum length of a \s-1DER\s0 encoded
217 \&\s-1ECDSA\s0 signature created with the private \s-1EC\s0 key \fBeckey\fR.
218 .PP
219 \&\fIECDSA_sign_setup()\fR may be used to precompute parts of the
220 signing operation. \fBeckey\fR is the private \s-1EC\s0 key and \fBctx\fR
221 is a pointer to \fB\s-1BN_CTX\s0\fR structure (or \s-1NULL\s0). The precomputed
222 values or returned in \fBkinv\fR and \fBrp\fR and can be used in a
223 later call to \fBECDSA_sign_ex\fR or \fBECDSA_do_sign_ex\fR.
224 .PP
225 \&\fIECDSA_sign()\fR is wrapper function for ECDSA_sign_ex with \fBkinv\fR
226 and \fBrp\fR set to \s-1NULL.\s0
227 .PP
228 \&\fIECDSA_sign_ex()\fR computes a digital signature of the \fBdgstlen\fR bytes
229 hash value \fBdgst\fR using the private \s-1EC\s0 key \fBeckey\fR and the optional
230 pre-computed values \fBkinv\fR and \fBrp\fR. The \s-1DER\s0 encoded signatures is
231 stored in \fBsig\fR and it's length is returned in \fBsig_len\fR. Note: \fBsig\fR
232 must point to \fBECDSA_size\fR bytes of memory. The parameter \fBtype\fR
233 is ignored.
234 .PP
235 \&\fIECDSA_verify()\fR verifies that the signature in \fBsig\fR of size
236 \&\fBsiglen\fR is a valid \s-1ECDSA\s0 signature of the hash value
237 \&\fBdgst\fR of size \fBdgstlen\fR using the public key \fBeckey\fR.
238 The parameter \fBtype\fR is ignored.
239 .PP
240 \&\fIECDSA_do_sign()\fR is wrapper function for ECDSA_do_sign_ex with \fBkinv\fR
241 and \fBrp\fR set to \s-1NULL.\s0
242 .PP
243 \&\fIECDSA_do_sign_ex()\fR computes a digital signature of the \fBdgst_len\fR
244 bytes hash value \fBdgst\fR using the private key \fBeckey\fR and the
245 optional pre-computed values \fBkinv\fR and \fBrp\fR. The signature is
246 returned in a newly allocated \fB\s-1ECDSA_SIG\s0\fR structure (or \s-1NULL\s0 on error).
247 .PP
248 \&\fIECDSA_do_verify()\fR verifies that the signature \fBsig\fR is a valid
249 \&\s-1ECDSA\s0 signature of the hash value \fBdgst\fR of size \fBdgst_len\fR
250 using the public key \fBeckey\fR.
251 .SH "RETURN VALUES"
252 .IX Header "RETURN VALUES"
253 \&\fIECDSA_size()\fR returns the maximum length signature or 0 on error.
254 .PP
255 \&\fIECDSA_sign_setup()\fR and \fIECDSA_sign()\fR return 1 if successful or 0
256 on error.
257 .PP
258 \&\fIECDSA_verify()\fR and \fIECDSA_do_verify()\fR return 1 for a valid
259 signature, 0 for an invalid signature and \-1 on error.
260 The error codes can be obtained by \fIERR_get_error\fR\|(3).
261 .SH "EXAMPLES"
262 .IX Header "EXAMPLES"
263 Creating a \s-1ECDSA\s0 signature of given \s-1SHA\-1\s0 hash value using the
264 named curve secp192k1.
265 .PP
266 First step: create a \s-1EC_KEY\s0 object (note: this part is \fBnot\fR \s-1ECDSA\s0
267 specific)
268 .PP
269 .Vb 12
270 \& int        ret;
271 \& ECDSA_SIG *sig;
272 \& EC_KEY    *eckey;
273 \& eckey = EC_KEY_new_by_curve_name(NID_secp192k1);
274 \& if (eckey == NULL)
275 \&        {
276 \&        /* error */
277 \&        }
278 \& if (!EC_KEY_generate_key(eckey))
279 \&        {
280 \&        /* error */
281 \&        }
282 .Ve
283 .PP
284 Second step: compute the \s-1ECDSA\s0 signature of a \s-1SHA\-1\s0 hash value 
285 using \fBECDSA_do_sign\fR
286 .PP
287 .Vb 5
288 \& sig = ECDSA_do_sign(digest, 20, eckey);
289 \& if (sig == NULL)
290 \&        {
291 \&        /* error */
292 \&        }
293 .Ve
294 .PP
295 or using \fBECDSA_sign\fR
296 .PP
297 .Vb 9
298 \& unsigned char *buffer, *pp;
299 \& int            buf_len;
300 \& buf_len = ECDSA_size(eckey);
301 \& buffer  = OPENSSL_malloc(buf_len);
302 \& pp = buffer;
303 \& if (!ECDSA_sign(0, dgst, dgstlen, pp, &buf_len, eckey);
304 \&        {
305 \&        /* error */
306 \&        }
307 .Ve
308 .PP
309 Third step: verify the created \s-1ECDSA\s0 signature using \fBECDSA_do_verify\fR
310 .PP
311 .Vb 1
312 \& ret = ECDSA_do_verify(digest, 20, sig, eckey);
313 .Ve
314 .PP
315 or using \fBECDSA_verify\fR
316 .PP
317 .Vb 1
318 \& ret = ECDSA_verify(0, digest, 20, buffer, buf_len, eckey);
319 .Ve
320 .PP
321 and finally evaluate the return value:
322 .PP
323 .Vb 12
324 \& if (ret == \-1)
325 \&        {
326 \&        /* error */
327 \&        }
328 \& else if (ret == 0)
329 \&        {
330 \&        /* incorrect signature */
331 \&        }
332 \& else   /* ret == 1 */
333 \&        {
334 \&        /* signature ok */
335 \&        }
336 .Ve
337 .SH "CONFORMING TO"
338 .IX Header "CONFORMING TO"
339 \&\s-1ANSI X9.62, US\s0 Federal Information Processing Standard \s-1FIPS 186\-2
340 \&\s0(Digital Signature Standard, \s-1DSS\s0)
341 .SH "SEE ALSO"
342 .IX Header "SEE ALSO"
343 \&\fIdsa\fR\|(3), \fIrsa\fR\|(3)
344 .SH "HISTORY"
345 .IX Header "HISTORY"
346 The ecdsa implementation was first introduced in OpenSSL 0.9.8
347 .SH "AUTHOR"
348 .IX Header "AUTHOR"
349 Nils Larsch for the OpenSSL project (http://www.openssl.org).