'version' is not optional in the encoding
[openssl.git] / crypto / ecdsa / ecdsa.h
1 /* crypto/ecdsa/ecdsa.h */
2 /* ====================================================================
3  * Copyright (c) 2000-2002 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer. 
11  *
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
15  *    distribution.
16  *
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/)"
21  *
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.
26  *
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.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
35  *
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  * ====================================================================
49  *
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).
53  *
54  */
55 #ifndef HEADER_ECDSA_H
56 #define HEADER_ECDSA_H
57
58 #ifdef OPENSSL_NO_ECDSA
59 #error ECDSA is disabled.
60 #endif
61
62 #ifndef OPENSSL_NO_BIO
63 #include <openssl/bio.h>
64 #endif
65 #include <openssl/bn.h>
66 #include <openssl/ec.h>
67 #include <openssl/crypto.h>
68 #include <openssl/ossl_typ.h>
69 #include <openssl/asn1.h>
70 #include <openssl/asn1t.h>
71
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75
76 typedef struct ecdsa_st ECDSA;
77
78 typedef struct ECDSA_SIG_st
79 {
80         BIGNUM *r;
81         BIGNUM *s;
82 } ECDSA_SIG;
83
84 typedef struct ecdsa_method 
85 {
86         const char *name;
87         ECDSA_SIG *(*ecdsa_do_sign)(const unsigned char *dgst, int dgst_len, ECDSA *ecdsa);
88         int (*ecdsa_sign_setup)(ECDSA *ecdsa, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **r);
89         int (*ecdsa_do_verify)(const unsigned char *dgst, int dgst_len, ECDSA_SIG *sig, ECDSA *ecdsa);
90         int (*init)(ECDSA *ecdsa);
91         int (*finish)(ECDSA *ecdsa);
92         int flags;
93         char *app_data;
94 } ECDSA_METHOD;
95
96 #define ECDSA_FLAG_NAMED_CURVE  1
97 #define ECDSA_FLAG_IMPLICITLYCA 2
98
99 struct ecdsa_st
100 {
101         int version;
102         point_conversion_form_t conversion_form;
103
104         EC_GROUP *group;
105
106         EC_POINT *pub_key;
107         BIGNUM   *priv_key;
108
109         BIGNUM   *kinv; /* signing pre-calc */
110         BIGNUM   *r;    /* signing pre-calc */
111
112         unsigned char *seed;    /* seed for curve generation */
113         unsigned int  seed_len; 
114
115         int     parameter_flags;
116
117         int     references;
118         int     flags;
119         CRYPTO_EX_DATA ex_data;
120         const ECDSA_METHOD *meth;
121         struct engine_st *engine;
122 };
123
124 ECDSA_SIG *ECDSA_SIG_new(void);
125 void      ECDSA_SIG_free(ECDSA_SIG *a);
126 int       i2d_ECDSA_SIG(const ECDSA_SIG *a, unsigned char **pp);
127 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **v, const unsigned char **pp, long length);
128
129 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len, ECDSA *ecdsa);
130 int       ECDSA_do_verify(const unsigned char *dgst, int dgst_len, ECDSA_SIG *sig, ECDSA* ecdsa);
131 int       ECDSA_generate_key(ECDSA *ecdsa);
132 int       ECDSA_check_key(ECDSA *ecdsa);
133
134 const ECDSA_METHOD *ECDSA_OpenSSL(void);
135
136 void      ECDSA_set_default_method(const ECDSA_METHOD *);
137 const ECDSA_METHOD *ECDSA_get_default_method(void);
138 int       ECDSA_set_method(ECDSA *, const ECDSA_METHOD *);
139
140 ECDSA     *ECDSA_new(void);
141 ECDSA     *ECDSA_new_method(ENGINE *engine);
142 int       ECDSA_size(const ECDSA *);
143 int       ECDSA_sign_setup(ECDSA *ecdsa, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
144 int       ECDSA_sign(int type, const unsigned char *dgst, int dgst_len, unsigned char *sig, 
145                      unsigned int *siglen, ECDSA *ecdsa);
146 int       ECDSA_verify(int type, const unsigned char *dgst, int dgst_len, const unsigned char *sig,
147                        const int sig_len, ECDSA *ecdsa);
148 int       ECDSA_up_ref(ECDSA *ecdsa);
149 void      ECDSA_free(ECDSA *a);
150 int       ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
151                                  CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
152 int       ECDSA_set_ex_data(ECDSA *d, int idx, void *arg);
153 void      *ECDSA_get_ex_data(ECDSA *d, int idx);
154
155 #ifndef OPENSSL_NO_BIO
156 int     ECDSAParameters_print(BIO *bp, const ECDSA *x);
157 int     ECDSA_print(BIO *bp, const ECDSA *x, int off);
158 #endif
159 #ifndef OPENSSL_NO_FP_API
160 int     ECDSAParameters_print_fp(FILE *fp, const ECDSA *x);
161 int     ECDSA_print_fp(FILE *fp, const ECDSA *x, int off);
162 #endif 
163
164 void    ECDSA_set_parameter_flags(ECDSA *, int);
165 int     ECDSA_get_parameter_flags(const ECDSA*);
166
167 /* The ECDSA_{set|get}_conversion_type() functions set/get the
168  * conversion form for ec-points (see ec.h) in a ECDSA-structure */
169 void    ECDSA_set_conversion_form(ECDSA *, const point_conversion_form_t);
170 point_conversion_form_t ECDSA_get_conversion_form(const ECDSA *);
171 /* The ECDSA_{set|get}_default_conversion_form() functions set/get the 
172  * default conversion form */
173 void    ECDSA_set_default_conversion_form(const point_conversion_form_t);
174 point_conversion_form_t ECDSA_get_default_conversion_form(void);
175
176 /* the basic de- and encode functions ( see ecs_asn1.c ) */
177 ECDSA   *d2i_ECDSAParameters(ECDSA **a, const unsigned char **in, long len);
178 int     i2d_ECDSAParameters(ECDSA *a, unsigned char **out);
179
180 ECDSA   *d2i_ECDSAPrivateKey(ECDSA **a, const unsigned char **in, long len);
181 int     i2d_ECDSAPrivateKey(ECDSA *a, unsigned char **out);
182
183 /* ECDSAPublicKey_set_octet_string() sets the public key in the ECDSA-structure.
184  * (*a) must be a pointer to a ECDSA-structure with (*a)->group not zero 
185  * (e.g. a ECDSA-structure with a valid EC_GROUP-structure) */
186 ECDSA   *ECDSAPublicKey_set_octet_string(ECDSA **a, const unsigned char **in, long len);
187 /* ECDSAPublicKey_get_octet_string() returns the length of the octet string encoding
188  * of the public key. If out != NULL then the function returns in *out 
189  * a pointer to the octet string */
190 int     ECDSAPublicKey_get_octet_string(ECDSA *a, unsigned char **out);
191
192
193 #define ECDSAParameters_dup(x) (ECDSA *)ASN1_dup((int (*)())i2d_ECDSAParameters, \
194                 (char *(*)())d2i_ECDSAParameters,(char *)(x))
195 #define d2i_ECDSAParameters_fp(fp,x) (ECDSA *)ASN1_d2i_fp((char *(*)())ECDSA_new, \
196                 (char *(*)())d2i_ECDSAParameters,(fp),(unsigned char **)(x))
197 #define i2d_ECDSAParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECDSAParameters,(fp), \
198                 (unsigned char *)(x))
199 #define d2i_ECDSAParameters_bio(bp,x) (ECDSA *)ASN1_d2i_bio((char *(*)())ECDSA_new, \
200                 (char *(*)())d2i_ECDSAParameters,(bp),(unsigned char **)(x))
201 #define i2d_ECDSAParameters_bio(bp,x) ASN1_i2d_bio(i2d_ECDSAParameters,(bp), \
202                 (unsigned char *)(x))
203
204 /* BEGIN ERROR CODES */
205 /* The following lines are auto generated by the script mkerr.pl. Any changes
206  * made after this point may be overwritten when the script is next run.
207  */
208 void ERR_load_ECDSA_strings(void);
209
210 /* Error codes for the ECDSA functions. */
211
212 /* Function codes. */
213 #define ECDSA_F_D2I_ECDSAPARAMETERS                      100
214 #define ECDSA_F_D2I_ECDSAPRIVATEKEY                      101
215 #define ECDSA_F_ECDSAPARAMETERS_PRINT                    102
216 #define ECDSA_F_ECDSAPARAMETERS_PRINT_FP                 103
217 #define ECDSA_F_ECDSA_DO_SIGN                            104
218 #define ECDSA_F_ECDSA_DO_VERIFY                          105
219 #define ECDSA_F_ECDSA_GENERATE_KEY                       106
220 #define ECDSA_F_ECDSA_GET                                107
221 #define ECDSA_F_ECDSA_GET_CURVE_NID                      120
222 #define ECDSA_F_ECDSA_GET_ECDSA                          121
223 #define ECDSA_F_ECDSA_GET_EC_PARAMETERS                  122
224 #define ECDSA_F_ECDSA_GET_X9_62_CURVE                    108
225 #define ECDSA_F_ECDSA_GET_X9_62_EC_PARAMETERS            109
226 #define ECDSA_F_ECDSA_GET_X9_62_FIELDID                  110
227 #define ECDSA_F_ECDSA_NEW                                111
228 #define ECDSA_F_ECDSA_PRINT                              112
229 #define ECDSA_F_ECDSA_PRINT_FP                           113
230 #define ECDSA_F_ECDSA_SET_GROUP_P                        114
231 #define ECDSA_F_ECDSA_SET_PRIME_GROUP                    123
232 #define ECDSA_F_ECDSA_SIGN_SETUP                         115
233 #define ECDSA_F_I2D_ECDSAPARAMETERS                      116
234 #define ECDSA_F_I2D_ECDSAPRIVATEKEY                      117
235 #define ECDSA_F_I2D_ECDSAPUBLICKEY                       118
236 #define ECDSA_F_SIG_CB                                   119
237
238 /* Reason codes. */
239 #define ECDSA_R_BAD_SIGNATURE                            100
240 #define ECDSA_R_CAN_NOT_GET_GENERATOR                    101
241 #define ECDSA_R_D2I_ECDSAPRIVATEKEY_MISSING_PRIVATE_KEY  102
242 #define ECDSA_R_D2I_ECDSA_PRIVATEKEY_FAILURE             103
243 #define ECDSA_R_D2I_EC_PARAMETERS_FAILURE                133
244 #define ECDSA_R_D2I_X9_62_EC_PARAMETERS_FAILURE          104
245 #define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              105
246 #define ECDSA_R_ECDSAPRIVATEKEY_NEW_FAILURE              106
247 #define ECDSA_R_ECDSA_F_ECDSA_NEW                        107
248 #define ECDSA_R_ECDSA_GET_EC_PARAMETERS_FAILURE          134
249 #define ECDSA_R_ECDSA_GET_FAILURE                        108
250 #define ECDSA_R_ECDSA_GET_X9_62_CURVE_FAILURE            109
251 #define ECDSA_R_ECDSA_GET_X9_62_EC_PARAMETERS_FAILURE    110
252 #define ECDSA_R_ECDSA_GET_X9_62_FIELDID_FAILURE          111
253 #define ECDSA_R_ECDSA_NEW_FAILURE                        112
254 #define ECDSA_R_ECDSA_R_D2I_EC_PARAMETERS_FAILURE        135
255 #define ECDSA_R_ECDSA_R_D2I_X9_62_EC_PARAMETERS_FAILURE  113
256 #define ECDSA_R_ECPARAMETERS2ECDSA_FAILURE               138
257 #define ECDSA_R_EC_GROUP_NID2CURVE_FAILURE               136
258 #define ECDSA_R_ERR_EC_LIB                               114
259 #define ECDSA_R_I2D_ECDSA_PRIVATEKEY                     115
260 #define ECDSA_R_I2D_ECDSA_PUBLICKEY                      116
261 #define ECDSA_R_MISSING_PARAMETERS                       117
262 #define ECDSA_R_NOT_SUPPORTED                            118
263 #define ECDSA_R_NO_CURVE_PARAMETER_A_SPECIFIED           119
264 #define ECDSA_R_NO_CURVE_PARAMETER_B_SPECIFIED           120
265 #define ECDSA_R_NO_CURVE_SPECIFIED                       121
266 #define ECDSA_R_NO_FIELD_SPECIFIED                       122
267 #define ECDSA_R_PRIME_MISSING                            123
268 #define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          124
269 #define ECDSA_R_SIGNATURE_MALLOC_FAILED                  125
270 #define ECDSA_R_UNEXPECTED_ASN1_TYPE                     126
271 #define ECDSA_R_UNEXPECTED_PARAMETER                     127
272 #define ECDSA_R_UNEXPECTED_PARAMETER_LENGTH              128
273 #define ECDSA_R_UNEXPECTED_VERSION_NUMER                 129
274 #define ECDSA_R_UNKNOWN_PARAMETERS_TYPE                  137
275 #define ECDSA_R_WRONG_FIELD_IDENTIFIER                   130
276 #define ECDSA_R_X9_62_CURVE_NEW_FAILURE                  131
277 #define ECDSA_R_X9_62_EC_PARAMETERS_NEW_FAILURE          132
278
279 #ifdef  __cplusplus
280 }
281 #endif
282 #endif