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