Replace overrides.
[openssl.git] / crypto / ec / ecdh_ossl.c
1 /* ====================================================================
2  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
3  *
4  * The Elliptic Curve Public-Key Crypto Library (ECC Code) included
5  * herein is developed by SUN MICROSYSTEMS, INC., and is contributed
6  * to the OpenSSL project.
7  *
8  * The ECC Code is licensed pursuant to the OpenSSL open source
9  * license provided below.
10  *
11  * The ECDH software is originally written by Douglas Stebila of
12  * Sun Microsystems Laboratories.
13  *
14  */
15 /* ====================================================================
16  * Copyright (c) 1998-2003 The OpenSSL Project.  All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  *
22  * 1. Redistributions of source code must retain the above copyright
23  *    notice, this list of conditions and the following disclaimer.
24  *
25  * 2. Redistributions in binary form must reproduce the above copyright
26  *    notice, this list of conditions and the following disclaimer in
27  *    the documentation and/or other materials provided with the
28  *    distribution.
29  *
30  * 3. All advertising materials mentioning features or use of this
31  *    software must display the following acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
34  *
35  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
36  *    endorse or promote products derived from this software without
37  *    prior written permission. For written permission, please contact
38  *    openssl-core@OpenSSL.org.
39  *
40  * 5. Products derived from this software may not be called "OpenSSL"
41  *    nor may "OpenSSL" appear in their names without prior written
42  *    permission of the OpenSSL Project.
43  *
44  * 6. Redistributions of any form whatsoever must retain the following
45  *    acknowledgment:
46  *    "This product includes software developed by the OpenSSL Project
47  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
50  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
52  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
53  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
54  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
56  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
58  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
59  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
60  * OF THE POSSIBILITY OF SUCH DAMAGE.
61  * ====================================================================
62  *
63  * This product includes cryptographic software written by Eric Young
64  * (eay@cryptsoft.com).  This product includes software written by Tim
65  * Hudson (tjh@cryptsoft.com).
66  *
67  */
68
69 #include <string.h>
70 #include <limits.h>
71
72 #include "internal/cryptlib.h"
73
74 #include <openssl/err.h>
75 #include <openssl/bn.h>
76 #include <openssl/objects.h>
77 #include <openssl/ec.h>
78 #include "ec_lcl.h"
79
80 int ossl_ecdh_compute_key(void *out, size_t outlen, const EC_POINT *pub_key,
81                           const EC_KEY *ecdh,
82                           void *(*KDF) (const void *in, size_t inlen,
83                                         void *out, size_t *outlen))
84 {
85     if (ecdh->group->meth->ecdh_compute_key == 0) {
86         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY,
87               ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
88         return -1;
89     }
90
91     return ecdh->group->meth->ecdh_compute_key(out, outlen, pub_key, ecdh,
92                                                KDF);
93 }
94
95 /*-
96  * This implementation is based on the following primitives in the IEEE 1363 standard:
97  *  - ECKAS-DH1
98  *  - ECSVDP-DH
99  * Finally an optional KDF is applied.
100  */
101 int ecdh_simple_compute_key(void *out, size_t outlen, const EC_POINT *pub_key,
102                             const EC_KEY *ecdh,
103                             void *(*KDF) (const void *in, size_t inlen,
104                                           void *out, size_t *outlen))
105 {
106     BN_CTX *ctx;
107     EC_POINT *tmp = NULL;
108     BIGNUM *x = NULL, *y = NULL;
109     const BIGNUM *priv_key;
110     const EC_GROUP *group;
111     int ret = -1;
112     size_t buflen, len;
113     unsigned char *buf = NULL;
114
115     if (outlen > INT_MAX) {
116         ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, ERR_R_MALLOC_FAILURE); /* sort of,
117                                                                  * anyway */
118         return -1;
119     }
120
121     if ((ctx = BN_CTX_new()) == NULL)
122         goto err;
123     BN_CTX_start(ctx);
124     x = BN_CTX_get(ctx);
125     y = BN_CTX_get(ctx);
126
127     priv_key = EC_KEY_get0_private_key(ecdh);
128     if (priv_key == NULL) {
129         ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, EC_R_NO_PRIVATE_VALUE);
130         goto err;
131     }
132
133     group = EC_KEY_get0_group(ecdh);
134
135     if (EC_KEY_get_flags(ecdh) & EC_FLAG_COFACTOR_ECDH) {
136         if (!EC_GROUP_get_cofactor(group, x, NULL) ||
137             !BN_mul(x, x, priv_key, ctx)) {
138             ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, ERR_R_MALLOC_FAILURE);
139             goto err;
140         }
141         priv_key = x;
142     }
143
144     if ((tmp = EC_POINT_new(group)) == NULL) {
145         ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, ERR_R_MALLOC_FAILURE);
146         goto err;
147     }
148
149     if (!EC_POINT_mul(group, tmp, NULL, pub_key, priv_key, ctx)) {
150         ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, EC_R_POINT_ARITHMETIC_FAILURE);
151         goto err;
152     }
153
154     if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) ==
155         NID_X9_62_prime_field) {
156         if (!EC_POINT_get_affine_coordinates_GFp(group, tmp, x, y, ctx)) {
157             ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, EC_R_POINT_ARITHMETIC_FAILURE);
158             goto err;
159         }
160     }
161 #ifndef OPENSSL_NO_EC2M
162     else {
163         if (!EC_POINT_get_affine_coordinates_GF2m(group, tmp, x, y, ctx)) {
164             ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, EC_R_POINT_ARITHMETIC_FAILURE);
165             goto err;
166         }
167     }
168 #endif
169
170     buflen = (EC_GROUP_get_degree(group) + 7) / 8;
171     len = BN_num_bytes(x);
172     if (len > buflen) {
173         ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, ERR_R_INTERNAL_ERROR);
174         goto err;
175     }
176     if ((buf = OPENSSL_malloc(buflen)) == NULL) {
177         ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, ERR_R_MALLOC_FAILURE);
178         goto err;
179     }
180
181     memset(buf, 0, buflen - len);
182     if (len != (size_t)BN_bn2bin(x, buf + buflen - len)) {
183         ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, ERR_R_BN_LIB);
184         goto err;
185     }
186
187     if (KDF != 0) {
188         if (KDF(buf, buflen, out, &outlen) == NULL) {
189             ECerr(EC_F_ECDH_SIMPLE_COMPUTE_KEY, EC_R_KDF_FAILED);
190             goto err;
191         }
192         ret = outlen;
193     } else {
194         /* no KDF, just copy as much as we can */
195         if (outlen > buflen)
196             outlen = buflen;
197         memcpy(out, buf, outlen);
198         ret = outlen;
199     }
200
201  err:
202     EC_POINT_free(tmp);
203     if (ctx)
204         BN_CTX_end(ctx);
205     BN_CTX_free(ctx);
206     OPENSSL_free(buf);
207     return (ret);
208 }