1 /* $OpenBSD: ecdsa.h,v 1.3 2014/11/17 20:25:50 miod Exp $ */
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 #ifndef OPENSSL_NO_DEPRECATED
71 #include <openssl/bn.h>
78 typedef struct ECDSA_SIG_st ECDSA_SIG;
82 ECDSA_SIG *(*ecdsa_do_sign)(const unsigned char *dgst, int dgst_len,
83 const BIGNUM *inv, const BIGNUM *rp, EC_KEY *eckey);
84 int (*ecdsa_sign_setup)(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv,
86 int (*ecdsa_do_verify)(const unsigned char *dgst, int dgst_len,
87 const ECDSA_SIG *sig, EC_KEY *eckey);
89 int (*init)(EC_KEY *eckey);
90 int (*finish)(EC_KEY *eckey);
96 /* If this flag is set the ECDSA method is FIPS compliant and can be used
97 * in FIPS mode. This is set in the validated module method. If an
98 * application sets this flag in its own methods it is its responsibility
99 * to ensure the result is compliant.
102 #define ECDSA_FLAG_FIPS_METHOD 0x1
104 struct ECDSA_SIG_st {
109 /** Allocates and initialize a ECDSA_SIG structure
110 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
112 ECDSA_SIG *ECDSA_SIG_new(void);
114 /** frees a ECDSA_SIG structure
115 * \param sig pointer to the ECDSA_SIG structure
117 void ECDSA_SIG_free(ECDSA_SIG *sig);
119 /** DER encode content of ECDSA_SIG object (note: this function modifies *pp
120 * (*pp += length of the DER encoded signature)).
121 * \param sig pointer to the ECDSA_SIG object
122 * \param pp pointer to a unsigned char pointer for the output or NULL
123 * \return the length of the DER encoded ECDSA_SIG object or 0
125 int i2d_ECDSA_SIG(const ECDSA_SIG *sig, unsigned char **pp);
127 /** Decodes a DER encoded ECDSA signature (note: this function changes *pp
129 * \param sig pointer to ECDSA_SIG pointer (may be NULL)
130 * \param pp memory buffer with the DER encoded signature
131 * \param len length of the buffer
132 * \return pointer to the decoded ECDSA_SIG structure (or NULL)
134 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **sig, const unsigned char **pp, long len);
136 /** Computes the ECDSA signature of the given hash value using
137 * the supplied private key and returns the created signature.
138 * \param dgst pointer to the hash value
139 * \param dgst_len length of the hash value
140 * \param eckey EC_KEY object containing a private EC key
141 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
143 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
146 /** Computes ECDSA signature of a given hash value using the supplied
147 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
148 * \param dgst pointer to the hash value to sign
149 * \param dgstlen length of the hash value
150 * \param kinv BIGNUM with a pre-computed inverse k (optional)
151 * \param rp BIGNUM with a pre-computed rp value (optioanl),
152 * see ECDSA_sign_setup
153 * \param eckey EC_KEY object containing a private EC key
154 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
156 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
157 const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
159 /** Verifies that the supplied signature is a valid ECDSA
160 * signature of the supplied hash value using the supplied public key.
161 * \param dgst pointer to the hash value
162 * \param dgst_len length of the hash value
163 * \param sig ECDSA_SIG structure
164 * \param eckey EC_KEY object containing a public EC key
165 * \return 1 if the signature is valid, 0 if the signature is invalid
168 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
169 const ECDSA_SIG *sig, EC_KEY* eckey);
171 const ECDSA_METHOD *ECDSA_OpenSSL(void);
173 /** Sets the default ECDSA method
174 * \param meth new default ECDSA_METHOD
176 void ECDSA_set_default_method(const ECDSA_METHOD *meth);
178 /** Returns the default ECDSA method
179 * \return pointer to ECDSA_METHOD structure containing the default method
181 const ECDSA_METHOD *ECDSA_get_default_method(void);
183 /** Sets method to be used for the ECDSA operations
184 * \param eckey EC_KEY object
185 * \param meth new method
186 * \return 1 on success and 0 otherwise
188 int ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth);
190 /** Returns the maximum length of the DER encoded signature
191 * \param eckey EC_KEY object
192 * \return numbers of bytes required for the DER encoded signature
194 int ECDSA_size(const EC_KEY *eckey);
196 /** Precompute parts of the signing operation
197 * \param eckey EC_KEY object containing a private EC key
198 * \param ctx BN_CTX object (optional)
199 * \param kinv BIGNUM pointer for the inverse of k
200 * \param rp BIGNUM pointer for x coordinate of k * generator
201 * \return 1 on success and 0 otherwise
203 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv,
206 /** Computes ECDSA signature of a given hash value using the supplied
207 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
208 * \param type this parameter is ignored
209 * \param dgst pointer to the hash value to sign
210 * \param dgstlen length of the hash value
211 * \param sig memory for the DER encoded created signature
212 * \param siglen pointer to the length of the returned signature
213 * \param eckey EC_KEY object containing a private EC key
214 * \return 1 on success and 0 otherwise
216 int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
217 unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
220 /** Computes ECDSA signature of a given hash value using the supplied
221 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
222 * \param type this parameter is ignored
223 * \param dgst pointer to the hash value to sign
224 * \param dgstlen length of the hash value
225 * \param sig buffer to hold the DER encoded signature
226 * \param siglen pointer to the length of the returned signature
227 * \param kinv BIGNUM with a pre-computed inverse k (optional)
228 * \param rp BIGNUM with a pre-computed rp value (optioanl),
229 * see ECDSA_sign_setup
230 * \param eckey EC_KEY object containing a private EC key
231 * \return 1 on success and 0 otherwise
233 int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
234 unsigned char *sig, unsigned int *siglen, const BIGNUM *kinv,
235 const BIGNUM *rp, EC_KEY *eckey);
237 /** Verifies that the given signature is valid ECDSA signature
238 * of the supplied hash value using the specified public key.
239 * \param type this parameter is ignored
240 * \param dgst pointer to the hash value
241 * \param dgstlen length of the hash value
242 * \param sig pointer to the DER encoded signature
243 * \param siglen length of the DER encoded signature
244 * \param eckey EC_KEY object containing a public EC key
245 * \return 1 if the signature is valid, 0 if the signature is invalid
248 int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
249 const unsigned char *sig, int siglen, EC_KEY *eckey);
251 /* the standard ex_data functions */
252 int ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
253 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
254 int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
255 void *ECDSA_get_ex_data(EC_KEY *d, int idx);
258 /* BEGIN ERROR CODES */
259 /* The following lines are auto generated by the script mkerr.pl. Any changes
260 * made after this point may be overwritten when the script is next run.
262 void ERR_load_ECDSA_strings(void);
264 /* Error codes for the ECDSA functions. */
266 /* Function codes. */
267 #define ECDSA_F_ECDSA_CHECK 104
268 #define ECDSA_F_ECDSA_DATA_NEW_METHOD 100
269 #define ECDSA_F_ECDSA_DO_SIGN 101
270 #define ECDSA_F_ECDSA_DO_VERIFY 102
271 #define ECDSA_F_ECDSA_SIGN_SETUP 103
274 #define ECDSA_R_BAD_SIGNATURE 100
275 #define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 101
276 #define ECDSA_R_ERR_EC_LIB 102
277 #define ECDSA_R_MISSING_PARAMETERS 103
278 #define ECDSA_R_NEED_NEW_SETUP_VALUES 106
279 #define ECDSA_R_NON_FIPS_METHOD 107
280 #define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED 104
281 #define ECDSA_R_SIGNATURE_MALLOC_FAILED 105