Simplify handling of named curves: get rid of EC_GROUP_new_by_name(),
[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 #include <openssl/bn.h>
63 #include <openssl/ec.h>
64 #include <openssl/ossl_typ.h>
65
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69
70 typedef struct ECDSA_SIG_st
71 {
72         BIGNUM *r;
73         BIGNUM *s;
74 } ECDSA_SIG;
75
76 typedef struct ecdsa_method 
77 {
78         const char *name;
79         ECDSA_SIG *(*ecdsa_do_sign)(const unsigned char *dgst, int dgst_len, 
80                         EC_KEY *eckey);
81         int (*ecdsa_sign_setup)(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, 
82                         BIGNUM **r);
83         int (*ecdsa_do_verify)(const unsigned char *dgst, int dgst_len, 
84                         ECDSA_SIG *sig, EC_KEY *eckey);
85 #if 0
86         int (*init)(EC_KEY *eckey);
87         int (*finish)(EC_KEY *eckey);
88 #endif
89         int flags;
90         char *app_data;
91 } ECDSA_METHOD;
92
93 typedef struct ecdsa_data_st {
94         /* EC_KEY_METH_DATA part */
95         int (*init)(EC_KEY *);
96         void (*finish)(EC_KEY *);
97         /* method specific part */
98         BIGNUM  *kinv;  /* signing pre-calc */
99         BIGNUM  *r;     /* signing pre-calc */
100         ENGINE  *engine;
101         int     flags;
102         const ECDSA_METHOD *meth;
103         CRYPTO_EX_DATA ex_data;
104 } ECDSA_DATA; 
105
106 /* signature functions */
107 ECDSA_SIG *ECDSA_SIG_new(void);
108 void      ECDSA_SIG_free(ECDSA_SIG *a);
109 int       i2d_ECDSA_SIG(const ECDSA_SIG *a, unsigned char **pp);
110 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **v, const unsigned char **pp, long length);
111
112 /* ECDSA_DATA functions */
113 ECDSA_DATA *ECDSA_DATA_new(void);
114 ECDSA_DATA *ECDSA_DATA_new_method(ENGINE *);
115 void ECDSA_DATA_free(ECDSA_DATA *);
116
117 ECDSA_DATA *ecdsa_check(EC_KEY *);
118
119 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len, EC_KEY *);
120 int       ECDSA_do_verify(const unsigned char *dgst, int dgst_len, ECDSA_SIG 
121                 *sig, EC_KEY* eckey);
122
123 const ECDSA_METHOD *ECDSA_OpenSSL(void);
124
125 void      ECDSA_set_default_method(const ECDSA_METHOD *);
126 const ECDSA_METHOD *ECDSA_get_default_method(void);
127 int       ECDSA_set_method(EC_KEY *, const ECDSA_METHOD *);
128
129 int       ECDSA_size(const EC_KEY *);
130 int       ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, 
131                 BIGNUM **rp);
132 int       ECDSA_sign(int type, const unsigned char *dgst, int dgst_len, 
133                 unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
134 int       ECDSA_verify(int type, const unsigned char *dgst, int dgst_len, 
135                 const unsigned char *sig, int sig_len, EC_KEY *eckey);
136
137
138 int       ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new 
139                 *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
140 int       ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
141 void      *ECDSA_get_ex_data(EC_KEY *d, int idx);
142
143
144 /* BEGIN ERROR CODES */
145 /* The following lines are auto generated by the script mkerr.pl. Any changes
146  * made after this point may be overwritten when the script is next run.
147  */
148 void ERR_load_ECDSA_strings(void);
149
150 /* Error codes for the ECDSA functions. */
151
152 /* Function codes. */
153 #define ECDSA_F_ECDSA_DATA_NEW                           100
154 #define ECDSA_F_ECDSA_DO_SIGN                            101
155 #define ECDSA_F_ECDSA_DO_VERIFY                          102
156 #define ECDSA_F_ECDSA_SIGN_SETUP                         103
157
158 /* Reason codes. */
159 #define ECDSA_R_BAD_SIGNATURE                            100
160 #define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              101
161 #define ECDSA_R_ERR_EC_LIB                               102
162 #define ECDSA_R_MISSING_PARAMETERS                       103
163 #define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          104
164 #define ECDSA_R_SIGNATURE_MALLOC_FAILED                  105
165
166 #ifdef  __cplusplus
167 }
168 #endif
169 #endif