1 /* crypto/ecdsa/ecdsa.h */
3 * \file crypto/ecdsa/ecdsa.h Include file for the OpenSSL ECDSA functions
4 * \author Written by Nils Larsch for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2000-2005 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
59 #ifndef HEADER_ECDSA_H
60 #define HEADER_ECDSA_H
62 #include <openssl/opensslconf.h>
64 #ifdef OPENSSL_NO_ECDSA
65 #error ECDSA is disabled.
68 #include <openssl/ec.h>
69 #include <openssl/ossl_typ.h>
70 #ifdef OPENSSL_USE_DEPRECATED
71 #include <openssl/bn.h>
78 typedef struct ECDSA_SIG_st
84 /** Allocates and initialize a ECDSA_SIG structure
85 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
87 ECDSA_SIG *ECDSA_SIG_new(void);
89 /** frees a ECDSA_SIG structure
90 * \param sig pointer to the ECDSA_SIG structure
92 void ECDSA_SIG_free(ECDSA_SIG *sig);
94 /** DER encode content of ECDSA_SIG object (note: this function modifies *pp
95 * (*pp += length of the DER encoded signature)).
96 * \param sig pointer to the ECDSA_SIG object
97 * \param pp pointer to a unsigned char pointer for the output or NULL
98 * \return the length of the DER encoded ECDSA_SIG object or 0
100 int i2d_ECDSA_SIG(const ECDSA_SIG *sig, unsigned char **pp);
102 /** Decodes a DER encoded ECDSA signature (note: this function changes *pp
104 * \param sig pointer to ECDSA_SIG pointer (may be NULL)
105 * \param pp memory buffer with the DER encoded signature
106 * \param len length of the buffer
107 * \return pointer to the decoded ECDSA_SIG structure (or NULL)
109 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **sig, const unsigned char **pp, long len);
111 /** Computes the ECDSA signature of the given hash value using
112 * the supplied private key and returns the created signature.
113 * \param dgst pointer to the hash value
114 * \param dgst_len length of the hash value
115 * \param eckey EC_KEY object containing a private EC key
116 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
118 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst,int dgst_len,EC_KEY *eckey);
120 /** Computes ECDSA signature of a given hash value using the supplied
121 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
122 * \param dgst pointer to the hash value to sign
123 * \param dgstlen length of the hash value
124 * \param kinv BIGNUM with a pre-computed inverse k (optional)
125 * \param rp BIGNUM with a pre-computed rp value (optioanl),
126 * see ECDSA_sign_setup
127 * \param eckey EC_KEY object containing a private EC key
128 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
130 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
131 const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
133 /** Verifies that the supplied signature is a valid ECDSA
134 * signature of the supplied hash value using the supplied public key.
135 * \param dgst pointer to the hash value
136 * \param dgst_len length of the hash value
137 * \param sig ECDSA_SIG structure
138 * \param eckey EC_KEY object containing a public EC key
139 * \return 1 if the signature is valid, 0 if the signature is invalid
142 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
143 const ECDSA_SIG *sig, EC_KEY* eckey);
145 const ECDSA_METHOD *ECDSA_OpenSSL(void);
147 /** Sets the default ECDSA method
148 * \param meth new default ECDSA_METHOD
150 void ECDSA_set_default_method(const ECDSA_METHOD *meth);
152 /** Returns the default ECDSA method
153 * \return pointer to ECDSA_METHOD structure containing the default method
155 const ECDSA_METHOD *ECDSA_get_default_method(void);
157 /** Sets method to be used for the ECDSA operations
158 * \param eckey EC_KEY object
159 * \param meth new method
160 * \return 1 on success and 0 otherwise
162 int ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth);
164 /** Returns the maximum length of the DER encoded signature
165 * \param eckey EC_KEY object
166 * \return numbers of bytes required for the DER encoded signature
168 int ECDSA_size(const EC_KEY *eckey);
170 /** Precompute parts of the signing operation
171 * \param eckey EC_KEY object containing a private EC key
172 * \param ctx BN_CTX object (optional)
173 * \param kinv BIGNUM pointer for the inverse of k
174 * \param rp BIGNUM pointer for x coordinate of k * generator
175 * \return 1 on success and 0 otherwise
177 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv,
180 /** Computes ECDSA signature of a given hash value using the supplied
181 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
182 * \param type this parameter is ignored
183 * \param dgst pointer to the hash value to sign
184 * \param dgstlen length of the hash value
185 * \param sig memory for the DER encoded created signature
186 * \param siglen pointer to the length of the returned signature
187 * \param eckey EC_KEY object containing a private EC key
188 * \return 1 on success and 0 otherwise
190 int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
191 unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
194 /** Computes ECDSA signature of a given hash value using the supplied
195 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
196 * \param type this parameter is ignored
197 * \param dgst pointer to the hash value to sign
198 * \param dgstlen length of the hash value
199 * \param sig buffer to hold the DER encoded signature
200 * \param siglen pointer to the length of the returned signature
201 * \param kinv BIGNUM with a pre-computed inverse k (optional)
202 * \param rp BIGNUM with a pre-computed rp value (optioanl),
203 * see ECDSA_sign_setup
204 * \param eckey EC_KEY object containing a private EC key
205 * \return 1 on success and 0 otherwise
207 int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
208 unsigned char *sig, unsigned int *siglen, const BIGNUM *kinv,
209 const BIGNUM *rp, EC_KEY *eckey);
211 /** Verifies that the given signature is valid ECDSA signature
212 * of the supplied hash value using the specified public key.
213 * \param type this parameter is ignored
214 * \param dgst pointer to the hash value
215 * \param dgstlen length of the hash value
216 * \param sig pointer to the DER encoded signature
217 * \param siglen length of the DER encoded signature
218 * \param eckey EC_KEY object containing a public EC key
219 * \return 1 if the signature is valid, 0 if the signature is invalid
222 int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
223 const unsigned char *sig, int siglen, EC_KEY *eckey);
225 /* the standard ex_data functions */
226 int ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new
227 *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
228 int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
229 void *ECDSA_get_ex_data(EC_KEY *d, int idx);
231 /** Allocates and initialize a ECDSA_METHOD structure
232 * \param ecdsa_method pointer to ECDSA_METHOD to copy. (May be NULL)
233 * \return pointer to a ECDSA_METHOD structure or NULL if an error occurred
236 ECDSA_METHOD *ECDSA_METHOD_new(ECDSA_METHOD *ecdsa_method);
238 /** frees a ECDSA_METHOD structure
239 * \param ecdsa_method pointer to the ECDSA_METHOD structure
241 void ECDSA_METHOD_free(ECDSA_METHOD *ecdsa_method);
243 /** Sets application specific data in the ECDSA_METHOD
244 * \param ecdsa_method pointer to existing ECDSA_METHOD
245 * \param app application specific data to set
248 void ECDSA_METHOD_set_app_data(ECDSA_METHOD *ecdsa_method, void *app);
250 /** Returns application specific data from a ECDSA_METHOD structure
251 * \param ecdsa_method pointer to ECDSA_METHOD structure
252 * \return pointer to application specific data.
256 void * ECDSA_METHOD_get_app_data(ECDSA_METHOD *ecdsa_method);
258 /** Set the ECDSA_do_sign function in the ECDSA_METHOD
259 * \param ecdsa_method pointer to existing ECDSA_METHOD
260 * \param ecdsa_do_sign a funtion of type ECDSA_do_sign
263 void ECDSA_METHOD_set_sign(ECDSA_METHOD *ecdsa_method,
264 ECDSA_SIG *(*ecdsa_do_sign)(const unsigned char *dgst, int dgst_len,
265 const BIGNUM *inv, const BIGNUM *rp, EC_KEY *eckey));
267 /** Set the ECDSA_sign_setup function in the ECDSA_METHOD
268 * \param ecdsa_method pointer to existing ECDSA_METHOD
269 * \param ecdsa_sign_setup a funtion of type ECDSA_sign_setup
272 void ECDSA_METHOD_set_sign_setup(ECDSA_METHOD *ecdsa_method,
273 int (*ecdsa_sign_setup)(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv,
276 /** Set the ECDSA_do_verify function in the ECDSA_METHOD
277 * \param ecdsa_method pointer to existing ECDSA_METHOD
278 * \param ecdsa_do_verify a funtion of type ECDSA_do_verify
281 void ECDSA_METHOD_set_verify(ECDSA_METHOD *ecdsa_method,
282 int (*ecdsa_do_verify)(const unsigned char *dgst, int dgst_len,
283 const ECDSA_SIG *sig, EC_KEY *eckey));
285 void ECDSA_METHOD_set_flags(ECDSA_METHOD *ecdsa_method, int flags);
287 /** Set the flags field in the ECDSA_METHOD
288 * \param ecdsa_method pointer to existing ECDSA_METHOD
289 * \param flags flags value to set
292 void ECDSA_METHOD_set_name(ECDSA_METHOD *ecdsa_method, char *name);
294 /** Set the name field in the ECDSA_METHOD
295 * \param ecdsa_method pointer to existing ECDSA_METHOD
296 * \param name name to set
299 /* BEGIN ERROR CODES */
300 /* The following lines are auto generated by the script mkerr.pl. Any changes
301 * made after this point may be overwritten when the script is next run.
303 void ERR_load_ECDSA_strings(void);
305 /* Error codes for the ECDSA functions. */
307 /* Function codes. */
308 #define ECDSA_F_ECDSA_DATA_NEW_METHOD 100
309 #define ECDSA_F_ECDSA_DO_SIGN 101
310 #define ECDSA_F_ECDSA_DO_VERIFY 102
311 #define ECDSA_F_ECDSA_METHOD_NEW 105
312 #define ECDSA_F_ECDSA_SIGN_SETUP 103
315 #define ECDSA_R_BAD_SIGNATURE 100
316 #define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 101
317 #define ECDSA_R_ERR_EC_LIB 102
318 #define ECDSA_R_MISSING_PARAMETERS 103
319 #define ECDSA_R_NEED_NEW_SETUP_VALUES 106
320 #define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED 104
321 #define ECDSA_R_SIGNATURE_MALLOC_FAILED 105