1 /* crypto/ecdsa/ecdsa.h */
2 /* ====================================================================
3 * Copyright (c) 2000-2002 The OpenSSL Project. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
17 * 3. All advertising materials mentioning features or use of this
18 * software must display the following acknowledgment:
19 * "This product includes software developed by the OpenSSL Project
20 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 * endorse or promote products derived from this software without
24 * prior written permission. For written permission, please contact
25 * licensing@OpenSSL.org.
27 * 5. Products derived from this software may not be called "OpenSSL"
28 * nor may "OpenSSL" appear in their names without prior written
29 * permission of the OpenSSL Project.
31 * 6. Redistributions of any form whatsoever must retain the following
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
36 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47 * OF THE POSSIBILITY OF SUCH DAMAGE.
48 * ====================================================================
50 * This product includes cryptographic software written by Eric Young
51 * (eay@cryptsoft.com). This product includes software written by Tim
52 * Hudson (tjh@cryptsoft.com).
55 #ifndef HEADER_ECDSA_H
56 #define HEADER_ECDSA_H
58 #ifdef OPENSSL_NO_ECDSA
59 #error ECDSA is disabled.
62 #ifndef OPENSSL_NO_BIO
63 #include <openssl/bio.h>
65 #include <openssl/bn.h>
66 #include <openssl/ec.h>
67 #include <openssl/ossl_typ.h>
73 typedef struct ecdsa_st ECDSA;
75 typedef struct ECDSA_SIG_st
81 typedef struct ecdsa_method
84 ECDSA_SIG *(*ecdsa_do_sign)(const unsigned char *dgst, int dgst_len, ECDSA *ecdsa);
85 int (*ecdsa_sign_setup)(ECDSA *ecdsa, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **r);
86 int (*ecdsa_do_verify)(const unsigned char *dgst, int dgst_len, ECDSA_SIG *sig, ECDSA *ecdsa);
87 int (*init)(ECDSA *ecdsa);
88 int (*finish)(ECDSA *ecdsa);
96 point_conversion_form_t conversion_form;
103 BIGNUM *kinv; /* signing pre-calc */
104 BIGNUM *r; /* signing pre-calc */
106 unsigned int enc_flag;
110 CRYPTO_EX_DATA ex_data;
111 const ECDSA_METHOD *meth;
112 struct engine_st *engine;
115 /* some values for the encoding_flag */
116 #define ECDSA_PKEY_NO_PARAMETERS 0x001
117 #define ECDSA_PKEY_NO_PUBKEY 0x002
119 ECDSA_SIG *ECDSA_SIG_new(void);
120 void ECDSA_SIG_free(ECDSA_SIG *a);
121 int i2d_ECDSA_SIG(const ECDSA_SIG *a, unsigned char **pp);
122 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **v, const unsigned char **pp, long length);
124 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len, ECDSA *ecdsa);
125 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len, ECDSA_SIG *sig, ECDSA* ecdsa);
126 int ECDSA_generate_key(ECDSA *ecdsa);
127 int ECDSA_check_key(ECDSA *ecdsa);
129 const ECDSA_METHOD *ECDSA_OpenSSL(void);
131 void ECDSA_set_default_method(const ECDSA_METHOD *);
132 const ECDSA_METHOD *ECDSA_get_default_method(void);
133 int ECDSA_set_method(ECDSA *, const ECDSA_METHOD *);
135 ECDSA *ECDSA_new(void);
136 ECDSA *ECDSA_new_method(ENGINE *engine);
137 int ECDSA_size(const ECDSA *);
138 int ECDSA_sign_setup(ECDSA *ecdsa, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
139 int ECDSA_sign(int type, const unsigned char *dgst, int dgst_len, unsigned char *sig,
140 unsigned int *siglen, ECDSA *ecdsa);
141 int ECDSA_verify(int type, const unsigned char *dgst, int dgst_len, const unsigned char *sig,
142 int sig_len, ECDSA *ecdsa);
143 int ECDSA_up_ref(ECDSA *ecdsa);
144 void ECDSA_free(ECDSA *a);
145 int ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
146 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
147 int ECDSA_set_ex_data(ECDSA *d, int idx, void *arg);
148 void *ECDSA_get_ex_data(ECDSA *d, int idx);
150 #ifndef OPENSSL_NO_BIO
151 int ECDSAParameters_print(BIO *bp, const ECDSA *x);
152 int ECDSA_print(BIO *bp, const ECDSA *x, int off);
154 #ifndef OPENSSL_NO_FP_API
155 int ECDSAParameters_print_fp(FILE *fp, const ECDSA *x);
156 int ECDSA_print_fp(FILE *fp, const ECDSA *x, int off);
159 /* the ECDSA_{set|get}_enc_flag() specify the encoding
160 * of the elliptic curve private key */
161 unsigned int ECDSA_get_enc_flag(const ECDSA *);
162 void ECDSA_set_enc_flag(ECDSA *, unsigned int);
164 /* The ECDSA_{set|get}_conversion_type() functions set/get the
165 * conversion form for ec-points (see ec.h) in a ECDSA-structure */
166 void ECDSA_set_conversion_form(ECDSA *, const point_conversion_form_t);
167 point_conversion_form_t ECDSA_get_conversion_form(const ECDSA *);
168 /* The ECDSA_{set|get}_default_conversion_form() functions set/get the
169 * default conversion form */
170 void ECDSA_set_default_conversion_form(const point_conversion_form_t);
171 point_conversion_form_t ECDSA_get_default_conversion_form(void);
173 /* the basic de- and encode functions ( see ecs_asn1.c ) */
174 ECDSA *d2i_ECDSAParameters(ECDSA **a, const unsigned char **in, long len);
175 int i2d_ECDSAParameters(ECDSA *a, unsigned char **out);
177 ECDSA *d2i_ECDSAPrivateKey(ECDSA **a, const unsigned char **in, long len);
178 int i2d_ECDSAPrivateKey(ECDSA *a, unsigned char **out);
180 /* ECDSAPublicKey_set_octet_string() sets the public key in the ECDSA-structure.
181 * (*a) must be a pointer to a ECDSA-structure with (*a)->group not zero
182 * (e.g. a ECDSA-structure with a valid EC_GROUP-structure) */
183 ECDSA *ECDSAPublicKey_set_octet_string(ECDSA **a, const unsigned char **in, long len);
184 /* ECDSAPublicKey_get_octet_string() returns the length of the octet string encoding
185 * of the public key. If out != NULL then the function returns in *out
186 * a pointer to the octet string */
187 int ECDSAPublicKey_get_octet_string(ECDSA *a, unsigned char **out);
190 #define ECDSAParameters_dup(x) (ECDSA *)ASN1_dup((int (*)())i2d_ECDSAParameters, \
191 (char *(*)())d2i_ECDSAParameters,(char *)(x))
192 #define d2i_ECDSAParameters_fp(fp,x) (ECDSA *)ASN1_d2i_fp((char *(*)())ECDSA_new, \
193 (char *(*)())d2i_ECDSAParameters,(fp),(unsigned char **)(x))
194 #define i2d_ECDSAParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECDSAParameters,(fp), \
195 (unsigned char *)(x))
196 #define d2i_ECDSAParameters_bio(bp,x) (ECDSA *)ASN1_d2i_bio((char *(*)())ECDSA_new, \
197 (char *(*)())d2i_ECDSAParameters,(bp),(unsigned char **)(x))
198 #define i2d_ECDSAParameters_bio(bp,x) ASN1_i2d_bio(i2d_ECDSAParameters,(bp), \
199 (unsigned char *)(x))
201 /* BEGIN ERROR CODES */
202 /* The following lines are auto generated by the script mkerr.pl. Any changes
203 * made after this point may be overwritten when the script is next run.
205 void ERR_load_ECDSA_strings(void);
207 /* Error codes for the ECDSA functions. */
209 /* Function codes. */
210 #define ECDSA_F_D2I_ECDSAPARAMETERS 100
211 #define ECDSA_F_D2I_ECDSAPRIVATEKEY 101
212 #define ECDSA_F_ECDSAPARAMETERS_PRINT 102
213 #define ECDSA_F_ECDSAPARAMETERS_PRINT_FP 103
214 #define ECDSA_F_ECDSA_DO_SIGN 104
215 #define ECDSA_F_ECDSA_DO_VERIFY 105
216 #define ECDSA_F_ECDSA_GENERATE_KEY 106
217 #define ECDSA_F_ECDSA_GET 107
218 #define ECDSA_F_ECDSA_GET_CURVE_NID 120
219 #define ECDSA_F_ECDSA_GET_ECDSA 121
220 #define ECDSA_F_ECDSA_GET_EC_PARAMETERS 122
221 #define ECDSA_F_ECDSA_GET_X9_62_CURVE 108
222 #define ECDSA_F_ECDSA_GET_X9_62_EC_PARAMETERS 109
223 #define ECDSA_F_ECDSA_GET_X9_62_FIELDID 110
224 #define ECDSA_F_ECDSA_NEW 111
225 #define ECDSA_F_ECDSA_PRINT 112
226 #define ECDSA_F_ECDSA_PRINT_FP 113
227 #define ECDSA_F_ECDSA_SET_GROUP_P 114
228 #define ECDSA_F_ECDSA_SET_PRIME_GROUP 123
229 #define ECDSA_F_ECDSA_SIGN_SETUP 115
230 #define ECDSA_F_I2D_ECDSAPARAMETERS 116
231 #define ECDSA_F_I2D_ECDSAPRIVATEKEY 117
232 #define ECDSA_F_I2D_ECDSAPUBLICKEY 118
233 #define ECDSA_F_SIG_CB 119
236 #define ECDSA_R_BAD_SIGNATURE 100
237 #define ECDSA_R_CAN_NOT_GET_GENERATOR 101
238 #define ECDSA_R_D2I_ECDSAPRIVATEKEY_MISSING_PRIVATE_KEY 102
239 #define ECDSA_R_D2I_ECDSA_PRIVATEKEY_FAILURE 103
240 #define ECDSA_R_D2I_EC_PARAMETERS_FAILURE 133
241 #define ECDSA_R_D2I_X9_62_EC_PARAMETERS_FAILURE 104
242 #define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 105
243 #define ECDSA_R_ECDSAPRIVATEKEY_NEW_FAILURE 106
244 #define ECDSA_R_ECDSA_F_ECDSA_NEW 107
245 #define ECDSA_R_ECDSA_GET_EC_PARAMETERS_FAILURE 134
246 #define ECDSA_R_ECDSA_GET_FAILURE 108
247 #define ECDSA_R_ECDSA_GET_X9_62_CURVE_FAILURE 109
248 #define ECDSA_R_ECDSA_GET_X9_62_EC_PARAMETERS_FAILURE 110
249 #define ECDSA_R_ECDSA_GET_X9_62_FIELDID_FAILURE 111
250 #define ECDSA_R_ECDSA_NEW_FAILURE 112
251 #define ECDSA_R_ECDSA_R_D2I_EC_PARAMETERS_FAILURE 135
252 #define ECDSA_R_ECDSA_R_D2I_X9_62_EC_PARAMETERS_FAILURE 113
253 #define ECDSA_R_ECPARAMETERS2ECDSA_FAILURE 138
254 #define ECDSA_R_EC_GROUP_NID2CURVE_FAILURE 136
255 #define ECDSA_R_ERR_EC_LIB 114
256 #define ECDSA_R_I2D_ECDSA_PRIVATEKEY 115
257 #define ECDSA_R_I2D_ECDSA_PUBLICKEY 116
258 #define ECDSA_R_MISSING_PARAMETERS 117
259 #define ECDSA_R_MISSING_PRIVATE_KEY 139
260 #define ECDSA_R_NOT_SUPPORTED 118
261 #define ECDSA_R_NO_CURVE_PARAMETER_A_SPECIFIED 119
262 #define ECDSA_R_NO_CURVE_PARAMETER_B_SPECIFIED 120
263 #define ECDSA_R_NO_CURVE_SPECIFIED 121
264 #define ECDSA_R_NO_FIELD_SPECIFIED 122
265 #define ECDSA_R_PRIME_MISSING 123
266 #define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED 124
267 #define ECDSA_R_SIGNATURE_MALLOC_FAILED 125
268 #define ECDSA_R_UNEXPECTED_ASN1_TYPE 126
269 #define ECDSA_R_UNEXPECTED_PARAMETER 127
270 #define ECDSA_R_UNEXPECTED_PARAMETER_LENGTH 128
271 #define ECDSA_R_UNEXPECTED_VERSION_NUMER 129
272 #define ECDSA_R_UNKNOWN_PARAMETERS_TYPE 137
273 #define ECDSA_R_WRONG_FIELD_IDENTIFIER 130
274 #define ECDSA_R_X9_62_CURVE_NEW_FAILURE 131
275 #define ECDSA_R_X9_62_EC_PARAMETERS_NEW_FAILURE 132