Extended EC_METHOD customisation support.
[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 /*-
81  * This implementation is based on the following primitives in the IEEE 1363 standard:
82  *  - ECKAS-DH1
83  *  - ECSVDP-DH
84  * Finally an optional KDF is applied.
85  */
86 int ossl_ecdh_compute_key(void *out, size_t outlen, const EC_POINT *pub_key,
87                           const EC_KEY *ecdh,
88                           void *(*KDF) (const void *in, size_t inlen,
89                                         void *out, size_t *outlen))
90 {
91     BN_CTX *ctx;
92     EC_POINT *tmp = NULL;
93     BIGNUM *x = NULL, *y = NULL;
94     const BIGNUM *priv_key;
95     const EC_GROUP *group;
96     int ret = -1;
97     size_t buflen, len;
98     unsigned char *buf = NULL;
99
100     if (outlen > INT_MAX) {
101         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, ERR_R_MALLOC_FAILURE); /* sort of,
102                                                                  * anyway */
103         return -1;
104     }
105
106     if (ecdh->group->meth->ecdh_compute_key != 0)
107         return ecdh->group->meth->ecdh_compute_key(out, outlen, pub_key, ecdh,
108                                                    KDF);
109
110     if ((ctx = BN_CTX_new()) == NULL)
111         goto err;
112     BN_CTX_start(ctx);
113     x = BN_CTX_get(ctx);
114     y = BN_CTX_get(ctx);
115
116     priv_key = EC_KEY_get0_private_key(ecdh);
117     if (priv_key == NULL) {
118         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, EC_R_NO_PRIVATE_VALUE);
119         goto err;
120     }
121
122     group = EC_KEY_get0_group(ecdh);
123
124     if (EC_KEY_get_flags(ecdh) & EC_FLAG_COFACTOR_ECDH) {
125         if (!EC_GROUP_get_cofactor(group, x, NULL) ||
126             !BN_mul(x, x, priv_key, ctx)) {
127             ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, ERR_R_MALLOC_FAILURE);
128             goto err;
129         }
130         priv_key = x;
131     }
132
133     if ((tmp = EC_POINT_new(group)) == NULL) {
134         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, ERR_R_MALLOC_FAILURE);
135         goto err;
136     }
137
138     if (!EC_POINT_mul(group, tmp, NULL, pub_key, priv_key, ctx)) {
139         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, EC_R_POINT_ARITHMETIC_FAILURE);
140         goto err;
141     }
142
143     if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) ==
144         NID_X9_62_prime_field) {
145         if (!EC_POINT_get_affine_coordinates_GFp(group, tmp, x, y, ctx)) {
146             ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, EC_R_POINT_ARITHMETIC_FAILURE);
147             goto err;
148         }
149     }
150 #ifndef OPENSSL_NO_EC2M
151     else {
152         if (!EC_POINT_get_affine_coordinates_GF2m(group, tmp, x, y, ctx)) {
153             ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, EC_R_POINT_ARITHMETIC_FAILURE);
154             goto err;
155         }
156     }
157 #endif
158
159     buflen = (EC_GROUP_get_degree(group) + 7) / 8;
160     len = BN_num_bytes(x);
161     if (len > buflen) {
162         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, ERR_R_INTERNAL_ERROR);
163         goto err;
164     }
165     if ((buf = OPENSSL_malloc(buflen)) == NULL) {
166         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, ERR_R_MALLOC_FAILURE);
167         goto err;
168     }
169
170     memset(buf, 0, buflen - len);
171     if (len != (size_t)BN_bn2bin(x, buf + buflen - len)) {
172         ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, ERR_R_BN_LIB);
173         goto err;
174     }
175
176     if (KDF != 0) {
177         if (KDF(buf, buflen, out, &outlen) == NULL) {
178             ECerr(EC_F_OSSL_ECDH_COMPUTE_KEY, EC_R_KDF_FAILED);
179             goto err;
180         }
181         ret = outlen;
182     } else {
183         /* no KDF, just copy as much as we can */
184         if (outlen > buflen)
185             outlen = buflen;
186         memcpy(out, buf, outlen);
187         ret = outlen;
188     }
189
190  err:
191     EC_POINT_free(tmp);
192     if (ctx)
193         BN_CTX_end(ctx);
194     BN_CTX_free(ctx);
195     OPENSSL_free(buf);
196     return (ret);
197 }