1 /* crypto/ec/ec_key.c */
3 * Written by Nils Larsch for the OpenSSL project.
5 /* ====================================================================
6 * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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 * openssl-core@openssl.org.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
58 /* ====================================================================
59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60 * Portions originally developed by SUN MICROSYSTEMS, INC., and
61 * contributed to the OpenSSL project.
66 #include <openssl/err.h>
69 EC_KEY
*EC_KEY_new(void)
73 ret
=(EC_KEY
*)OPENSSL_malloc(sizeof(EC_KEY
));
76 ECerr(EC_F_EC_KEY_NEW
, ERR_R_MALLOC_FAILURE
);
85 ret
->conv_form
= POINT_CONVERSION_UNCOMPRESSED
;
87 ret
->method_data
= NULL
;
91 EC_KEY
*EC_KEY_new_by_curve_name(int nid
)
93 EC_KEY
*ret
= EC_KEY_new();
96 ret
->group
= EC_GROUP_new_by_curve_name(nid
);
97 if (ret
->group
== NULL
)
105 void EC_KEY_free(EC_KEY
*r
)
109 if (r
== NULL
) return;
111 i
=CRYPTO_add(&r
->references
,-1,CRYPTO_LOCK_EC
);
113 REF_PRINT("EC_KEY",r
);
119 fprintf(stderr
,"EC_KEY_free, bad reference count\n");
124 if (r
->group
!= NULL
)
125 EC_GROUP_free(r
->group
);
126 if (r
->pub_key
!= NULL
)
127 EC_POINT_free(r
->pub_key
);
128 if (r
->priv_key
!= NULL
)
129 BN_clear_free(r
->priv_key
);
131 EC_EX_DATA_free_all_data(&r
->method_data
);
133 OPENSSL_cleanse((void *)r
, sizeof(EC_KEY
));
138 EC_KEY
*EC_KEY_copy(EC_KEY
*dest
, const EC_KEY
*src
)
142 if (dest
== NULL
|| src
== NULL
)
144 ECerr(EC_F_EC_KEY_COPY
, ERR_R_PASSED_NULL_PARAMETER
);
147 /* copy the parameters */
150 const EC_METHOD
*meth
= EC_GROUP_method_of(src
->group
);
151 /* clear the old group */
153 EC_GROUP_free(dest
->group
);
154 dest
->group
= EC_GROUP_new(meth
);
155 if (dest
->group
== NULL
)
157 if (!EC_GROUP_copy(dest
->group
, src
->group
))
160 /* copy the public key */
161 if (src
->pub_key
&& src
->group
)
164 EC_POINT_free(dest
->pub_key
);
165 dest
->pub_key
= EC_POINT_new(src
->group
);
166 if (dest
->pub_key
== NULL
)
168 if (!EC_POINT_copy(dest
->pub_key
, src
->pub_key
))
171 /* copy the private key */
174 if (dest
->priv_key
== NULL
)
176 dest
->priv_key
= BN_new();
177 if (dest
->priv_key
== NULL
)
180 if (!BN_copy(dest
->priv_key
, src
->priv_key
))
183 /* copy method/extra data */
184 EC_EX_DATA_free_all_data(&dest
->method_data
);
186 for (d
= src
->method_data
; d
!= NULL
; d
= d
->next
)
188 void *t
= d
->dup_func(d
->data
);
192 if (!EC_EX_DATA_set_data(&dest
->method_data
, t
, d
->dup_func
, d
->free_func
, d
->clear_free_func
))
197 dest
->enc_flag
= src
->enc_flag
;
198 dest
->conv_form
= src
->conv_form
;
199 dest
->version
= src
->version
;
204 EC_KEY
*EC_KEY_dup(const EC_KEY
*eckey
)
212 /* copy the parameters */
215 ret
->group
= EC_GROUP_dup(eckey
->group
);
216 if (ret
->group
== NULL
)
219 /* copy the public key */
220 if (eckey
->pub_key
&& eckey
->group
)
222 ret
->pub_key
= EC_POINT_dup(eckey
->pub_key
, eckey
->group
);
223 if (ret
->pub_key
== NULL
)
226 /* copy the private key */
229 ret
->priv_key
= BN_dup(eckey
->priv_key
);
230 if (ret
->priv_key
== NULL
)
234 ret
->enc_flag
= eckey
->enc_flag
;
235 ret
->conv_form
= eckey
->conv_form
;
236 ret
->version
= eckey
->version
;
247 int EC_KEY_up_ref(EC_KEY
*r
)
249 int i
= CRYPTO_add(&r
->references
, 1, CRYPTO_LOCK_EC
);
251 REF_PRINT("EC_KEY",r
);
256 fprintf(stderr
, "EC_KEY_up, bad reference count\n");
260 return ((i
> 1) ? 1 : 0);
263 int EC_KEY_generate_key(EC_KEY
*eckey
)
267 BIGNUM
*priv_key
= NULL
, *order
= NULL
;
268 EC_POINT
*pub_key
= NULL
;
270 if (!eckey
|| !eckey
->group
)
272 ECerr(EC_F_EC_KEY_GENERATE_KEY
, ERR_R_PASSED_NULL_PARAMETER
);
276 if ((order
= BN_new()) == NULL
) goto err
;
277 if ((ctx
= BN_CTX_new()) == NULL
) goto err
;
279 if (eckey
->priv_key
== NULL
)
282 if (priv_key
== NULL
)
286 priv_key
= eckey
->priv_key
;
288 if (!EC_GROUP_get_order(eckey
->group
, order
, ctx
))
292 if (!BN_rand_range(priv_key
, order
))
294 while (BN_is_zero(priv_key
));
296 if (eckey
->pub_key
== NULL
)
298 pub_key
= EC_POINT_new(eckey
->group
);
303 pub_key
= eckey
->pub_key
;
305 if (!EC_POINT_mul(eckey
->group
, pub_key
, priv_key
, NULL
, NULL
, ctx
))
308 eckey
->priv_key
= priv_key
;
309 eckey
->pub_key
= pub_key
;
316 if (pub_key
!= NULL
&& eckey
->pub_key
== NULL
)
317 EC_POINT_free(pub_key
);
318 if (priv_key
!= NULL
&& eckey
->priv_key
== NULL
)
325 int EC_KEY_check_key(const EC_KEY
*eckey
)
329 BIGNUM
*order
= NULL
;
330 EC_POINT
*point
= NULL
;
332 if (!eckey
|| !eckey
->group
|| !eckey
->pub_key
)
334 ECerr(EC_F_EC_KEY_CHECK_KEY
, ERR_R_PASSED_NULL_PARAMETER
);
338 if ((ctx
= BN_CTX_new()) == NULL
)
340 if ((order
= BN_new()) == NULL
)
342 if ((point
= EC_POINT_new(eckey
->group
)) == NULL
)
345 /* testing whether the pub_key is on the elliptic curve */
346 if (!EC_POINT_is_on_curve(eckey
->group
, eckey
->pub_key
, ctx
))
348 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_POINT_IS_NOT_ON_CURVE
);
351 /* testing whether pub_key * order is the point at infinity */
352 if (!EC_GROUP_get_order(eckey
->group
, order
, ctx
))
354 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_INVALID_GROUP_ORDER
);
357 if (!EC_POINT_copy(point
, eckey
->pub_key
))
359 ECerr(EC_F_EC_KEY_CHECK_KEY
, ERR_R_EC_LIB
);
362 if (!EC_POINT_mul(eckey
->group
, point
, order
, NULL
, NULL
, ctx
))
364 ECerr(EC_F_EC_KEY_CHECK_KEY
, ERR_R_EC_LIB
);
367 if (!EC_POINT_is_at_infinity(eckey
->group
, point
))
369 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_WRONG_ORDER
);
372 /* in case the priv_key is present :
373 * check if generator * priv_key == pub_key
377 if (BN_cmp(eckey
->priv_key
, order
) >= 0)
379 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_WRONG_ORDER
);
382 if (!EC_POINT_mul(eckey
->group
, point
, eckey
->priv_key
,
385 ECerr(EC_F_EC_KEY_CHECK_KEY
, ERR_R_EC_LIB
);
388 if (EC_POINT_cmp(eckey
->group
, point
, eckey
->pub_key
,
391 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_INVALID_PRIVATE_KEY
);
402 EC_POINT_free(point
);
406 const EC_GROUP
*EC_KEY_get0_group(const EC_KEY
*key
)
411 int EC_KEY_set_group(EC_KEY
*key
, const EC_GROUP
*group
)
413 if (key
->group
!= NULL
)
414 EC_GROUP_free(key
->group
);
415 key
->group
= EC_GROUP_dup(group
);
416 return (key
->group
== NULL
) ? 0 : 1;
419 const BIGNUM
*EC_KEY_get0_private_key(const EC_KEY
*key
)
421 return key
->priv_key
;
424 int EC_KEY_set_private_key(EC_KEY
*key
, const BIGNUM
*priv_key
)
427 BN_clear_free(key
->priv_key
);
428 key
->priv_key
= BN_dup(priv_key
);
429 return (key
->priv_key
== NULL
) ? 0 : 1;
432 const EC_POINT
*EC_KEY_get0_public_key(const EC_KEY
*key
)
437 int EC_KEY_set_public_key(EC_KEY
*key
, const EC_POINT
*pub_key
)
439 if (key
->pub_key
!= NULL
)
440 EC_POINT_free(key
->pub_key
);
441 key
->pub_key
= EC_POINT_dup(pub_key
, key
->group
);
442 return (key
->pub_key
== NULL
) ? 0 : 1;
445 unsigned int EC_KEY_get_enc_flags(const EC_KEY
*key
)
447 return key
->enc_flag
;
450 void EC_KEY_set_enc_flags(EC_KEY
*key
, unsigned int flags
)
452 key
->enc_flag
= flags
;
455 point_conversion_form_t
EC_KEY_get_conv_form(const EC_KEY
*key
)
457 return key
->conv_form
;
460 void EC_KEY_set_conv_form(EC_KEY
*key
, point_conversion_form_t cform
)
462 key
->conv_form
= cform
;
463 if (key
->group
!= NULL
)
464 EC_GROUP_set_point_conversion_form(key
->group
, cform
);
467 void *EC_KEY_get_key_method_data(EC_KEY
*key
,
468 void *(*dup_func
)(void *), void (*free_func
)(void *), void (*clear_free_func
)(void *))
470 return EC_EX_DATA_get_data(key
->method_data
, dup_func
, free_func
, clear_free_func
);
473 void EC_KEY_insert_key_method_data(EC_KEY
*key
, void *data
,
474 void *(*dup_func
)(void *), void (*free_func
)(void *), void (*clear_free_func
)(void *))
476 EC_EXTRA_DATA
*ex_data
;
477 CRYPTO_w_lock(CRYPTO_LOCK_EC
);
478 ex_data
= EC_EX_DATA_get_data(key
->method_data
, dup_func
, free_func
, clear_free_func
);
480 EC_EX_DATA_set_data(&key
->method_data
, data
, dup_func
, free_func
, clear_free_func
);
481 CRYPTO_w_unlock(CRYPTO_LOCK_EC
);
484 void EC_KEY_set_asn1_flag(EC_KEY
*key
, int flag
)
486 if (key
->group
!= NULL
)
487 EC_GROUP_set_asn1_flag(key
->group
, flag
);
490 int EC_KEY_precompute_mult(EC_KEY
*key
, BN_CTX
*ctx
)
492 if (key
->group
== NULL
)
494 return EC_GROUP_precompute_mult(key
->group
, ctx
);