fad74bf435b701271812e017989f3c9c367b1ae4
[openssl.git] / crypto / ec / ec_kmeth.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project.
4  */
5 /* ====================================================================
6  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  */
53
54 #include <string.h>
55 #include <openssl/ec.h>
56 #ifndef OPENSSL_NO_ENGINE
57 # include <openssl/engine.h>
58 #endif
59 #include <openssl/err.h>
60 #include "ec_lcl.h"
61
62
63 static const EC_KEY_METHOD openssl_ec_key_method = {
64     "OpenSSL EC_KEY method",
65     0,
66     0,0,0,0,0,0,
67     ossl_ec_key_gen,
68     ossl_ecdh_compute_key,
69     ossl_ecdsa_sign,
70     ossl_ecdsa_sign_setup,
71     ossl_ecdsa_sign_sig,
72     ossl_ecdsa_verify,
73     ossl_ecdsa_verify_sig
74 };
75
76 static const EC_KEY_METHOD *default_ec_key_meth = &openssl_ec_key_method;
77
78 const EC_KEY_METHOD *EC_KEY_OpenSSL(void)
79 {
80     return &openssl_ec_key_method;
81 }
82
83 const EC_KEY_METHOD *EC_KEY_get_default_method(void)
84 {
85     return default_ec_key_meth;
86 }
87
88 void EC_KEY_set_default_method(const EC_KEY_METHOD *meth)
89 {
90     if (meth == NULL)
91         default_ec_key_meth = &openssl_ec_key_method;
92     else
93         default_ec_key_meth = meth;
94 }
95
96 const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key)
97 {
98     return key->meth;
99 }
100
101 int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth)
102 {
103     void (*finish)(EC_KEY *key) = key->meth->finish;
104
105     if (finish != NULL)
106         finish(key);
107
108 #ifndef OPENSSL_NO_ENGINE
109     ENGINE_finish(key->engine);
110     key->engine = NULL;
111 #endif
112
113     key->meth = meth;
114     if (meth->init != NULL)
115         return meth->init(key);
116     return 1;
117 }
118
119 EC_KEY *EC_KEY_new_method(ENGINE *engine)
120 {
121     EC_KEY *ret = OPENSSL_zalloc(sizeof(*ret));
122
123     if (ret == NULL) {
124         ECerr(EC_F_EC_KEY_NEW_METHOD, ERR_R_MALLOC_FAILURE);
125         return (NULL);
126     }
127     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EC_KEY, ret, &ret->ex_data)) {
128         OPENSSL_free(ret);
129         return NULL;
130     }
131
132     ret->meth = EC_KEY_get_default_method();
133 #ifndef OPENSSL_NO_ENGINE
134     if (engine != NULL) {
135         if (!ENGINE_init(engine)) {
136             ECerr(EC_F_EC_KEY_NEW_METHOD, ERR_R_ENGINE_LIB);
137             OPENSSL_free(ret);
138             return NULL;
139         }
140         ret->engine = engine;
141     } else
142         ret->engine = ENGINE_get_default_EC();
143     if (ret->engine != NULL) {
144         ret->meth = ENGINE_get_EC(ret->engine);
145         if (ret->meth == NULL) {
146             ECerr(EC_F_EC_KEY_NEW_METHOD, ERR_R_ENGINE_LIB);
147             ENGINE_finish(ret->engine);
148             OPENSSL_free(ret);
149             return NULL;
150         }
151     }
152 #endif
153
154     ret->version = 1;
155     ret->conv_form = POINT_CONVERSION_UNCOMPRESSED;
156     ret->references = 1;
157     if (ret->meth->init != NULL && ret->meth->init(ret) == 0) {
158         EC_KEY_free(ret);
159         return NULL;
160     }
161     return ret;
162 }
163
164 int ECDH_compute_key(void *out, size_t outlen, const EC_POINT *pub_key,
165                      const EC_KEY *eckey,
166                      void *(*KDF) (const void *in, size_t inlen, void *out,
167                                    size_t *outlen))
168 {
169     unsigned char *sec = NULL;
170     size_t seclen;
171     if (eckey->meth->compute_key == NULL) {
172         ECerr(EC_F_ECDH_COMPUTE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
173         return 0;
174     }
175     if (outlen > INT_MAX) {
176         ECerr(EC_F_ECDH_COMPUTE_KEY, EC_R_INVALID_OUTPUT_LENGTH);
177         return 0;
178     }
179     if (!eckey->meth->compute_key(&sec, &seclen, pub_key, eckey))
180         return 0;
181     if (KDF != NULL) {
182         KDF(sec, seclen, out, &outlen);
183     } else {
184         if (outlen > seclen)
185             outlen = seclen;
186         memcpy(out, sec, outlen);
187     }
188     OPENSSL_clear_free(sec, seclen);
189     return outlen;
190 }
191
192 EC_KEY_METHOD *EC_KEY_METHOD_new(const EC_KEY_METHOD *meth)
193 {
194     EC_KEY_METHOD *ret = OPENSSL_zalloc(sizeof(*meth));
195
196     if (ret == NULL)
197         return NULL;
198     if (meth != NULL)
199         *ret = *meth;
200     ret->flags |= EC_KEY_METHOD_DYNAMIC;
201     return ret;
202 }
203
204 void EC_KEY_METHOD_free(EC_KEY_METHOD *meth)
205 {
206     if (meth->flags & EC_KEY_METHOD_DYNAMIC)
207         OPENSSL_free(meth);
208 }
209
210 void EC_KEY_METHOD_set_init(EC_KEY_METHOD *meth,
211                             int (*init)(EC_KEY *key),
212                             void (*finish)(EC_KEY *key),
213                             int (*copy)(EC_KEY *dest, const EC_KEY *src),
214                             int (*set_group)(EC_KEY *key, const EC_GROUP *grp),
215                             int (*set_private)(EC_KEY *key,
216                                                const BIGNUM *priv_key),
217                             int (*set_public)(EC_KEY *key,
218                                               const EC_POINT *pub_key))
219 {
220     meth->init = init;
221     meth->finish = finish;
222     meth->copy = copy;
223     meth->set_group = set_group;
224     meth->set_private = set_private;
225     meth->set_public = set_public;
226 }
227
228 void EC_KEY_METHOD_set_keygen(EC_KEY_METHOD *meth,
229                               int (*keygen)(EC_KEY *key))
230 {
231     meth->keygen = keygen;
232 }
233
234 void EC_KEY_METHOD_set_compute_key(EC_KEY_METHOD *meth,
235                                    int (*ckey)(unsigned char **psec,
236                                                size_t *pseclen,
237                                                const EC_POINT *pub_key,
238                                                const EC_KEY *ecdh))
239 {
240     meth->compute_key = ckey;
241 }
242
243 void EC_KEY_METHOD_set_sign(EC_KEY_METHOD *meth,
244                             int (*sign)(int type, const unsigned char *dgst,
245                                         int dlen, unsigned char *sig,
246                                         unsigned int *siglen,
247                                         const BIGNUM *kinv, const BIGNUM *r,
248                                         EC_KEY *eckey),
249                             int (*sign_setup)(EC_KEY *eckey, BN_CTX *ctx_in,
250                                               BIGNUM **kinvp, BIGNUM **rp),
251                             ECDSA_SIG *(*sign_sig)(const unsigned char *dgst,
252                                                    int dgst_len,
253                                                    const BIGNUM *in_kinv,
254                                                    const BIGNUM *in_r,
255                                                    EC_KEY *eckey))
256 {
257     meth->sign = sign;
258     meth->sign_setup = sign_setup;
259     meth->sign_sig = sign_sig;
260 }
261
262 void EC_KEY_METHOD_set_verify(EC_KEY_METHOD *meth,
263                               int (*verify)(int type, const unsigned
264                                             char *dgst, int dgst_len,
265                                             const unsigned char *sigbuf,
266                                             int sig_len, EC_KEY *eckey),
267                               int (*verify_sig)(const unsigned char *dgst,
268                                                 int dgst_len,
269                                                 const ECDSA_SIG *sig,
270                                                 EC_KEY *eckey))
271 {
272     meth->verify = verify;
273     meth->verify_sig = verify_sig;
274 }
275
276 void EC_KEY_METHOD_get_init(EC_KEY_METHOD *meth,
277                             int (**pinit)(EC_KEY *key),
278                             void (**pfinish)(EC_KEY *key),
279                             int (**pcopy)(EC_KEY *dest, const EC_KEY *src),
280                             int (**pset_group)(EC_KEY *key,
281                                                const EC_GROUP *grp),
282                             int (**pset_private)(EC_KEY *key,
283                                                  const BIGNUM *priv_key),
284                             int (**pset_public)(EC_KEY *key,
285                                                 const EC_POINT *pub_key))
286 {
287     if (pinit != NULL)
288         *pinit = meth->init;
289     if (pfinish != NULL)
290         *pfinish = meth->finish;
291     if (pcopy != NULL)
292         *pcopy = meth->copy;
293     if (pset_group != NULL)
294         *pset_group = meth->set_group;
295     if (pset_private != NULL)
296         *pset_private = meth->set_private;
297     if (pset_public != NULL)
298         *pset_public = meth->set_public;
299 }
300
301 void EC_KEY_METHOD_get_keygen(EC_KEY_METHOD *meth,
302                               int (**pkeygen)(EC_KEY *key))
303 {
304     if (pkeygen != NULL)
305         *pkeygen = meth->keygen;
306 }
307
308 void EC_KEY_METHOD_get_compute_key(EC_KEY_METHOD *meth,
309                                    int (**pck)(unsigned char **pout,
310                                                size_t *poutlen,
311                                                const EC_POINT *pub_key,
312                                                const EC_KEY *ecdh))
313 {
314     if (pck != NULL)
315         *pck = meth->compute_key;
316 }
317
318 void EC_KEY_METHOD_get_sign(EC_KEY_METHOD *meth,
319                             int (**psign)(int type, const unsigned char *dgst,
320                                           int dlen, unsigned char *sig,
321                                           unsigned int *siglen,
322                                           const BIGNUM *kinv, const BIGNUM *r,
323                                           EC_KEY *eckey),
324                             int (**psign_setup)(EC_KEY *eckey, BN_CTX *ctx_in,
325                                                 BIGNUM **kinvp, BIGNUM **rp),
326                             ECDSA_SIG *(**psign_sig)(const unsigned char *dgst,
327                                                      int dgst_len,
328                                                      const BIGNUM *in_kinv,
329                                                      const BIGNUM *in_r,
330                                                      EC_KEY *eckey))
331 {
332     if (psign != NULL)
333         *psign = meth->sign;
334     if (psign_setup != NULL)
335         *psign_setup = meth->sign_setup;
336     if (psign_sig != NULL)
337         *psign_sig = meth->sign_sig;
338 }
339
340 void EC_KEY_METHOD_get_verify(EC_KEY_METHOD *meth,
341                               int (**pverify)(int type, const unsigned
342                                               char *dgst, int dgst_len,
343                                               const unsigned char *sigbuf,
344                                               int sig_len, EC_KEY *eckey),
345                               int (**pverify_sig)(const unsigned char *dgst,
346                                                   int dgst_len,
347                                                   const ECDSA_SIG *sig,
348                                                   EC_KEY *eckey))
349 {
350     if (pverify != NULL)
351         *pverify = meth->verify;
352     if (pverify_sig != NULL)
353         *pverify_sig = meth->verify_sig;
354 }