- new ECDH_compute_key interface (KDF is no longer a fixed built-in)
[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
71 #include <limits.h>
72
73 #include <openssl/ecdh.h>
74 #include <openssl/err.h>
75 #include <openssl/sha.h>
76 #include <openssl/obj_mac.h>
77
78 static int ecdh_compute_key(void *out, size_t len, const EC_POINT *pub_key, EC_KEY *ecdh,
79                             void *(*KDF)(void *in, size_t inlen, void *out, size_t outlen));
80
81 static ECDH_METHOD openssl_ecdh_meth = {
82         "OpenSSL ECDH method",
83         ecdh_compute_key,
84 #if 0
85         NULL, /* init     */
86         NULL, /* finish   */
87 #endif
88         0,    /* flags    */
89         NULL  /* app_data */
90 };
91
92 const ECDH_METHOD *ECDH_OpenSSL(void)
93         {
94         return &openssl_ecdh_meth;
95         }
96
97
98 /* This implementation is based on the following primitives in the IEEE 1363 standard:
99  *  - ECKAS-DH1
100  *  - ECSVDP-DH
101  * Finally an optional KDF is applied.
102  */
103 static int ecdh_compute_key(void *out, size_t outlen, const EC_POINT *pub_key, EC_KEY *ecdh,
104                             void *(*KDF)(void *in, size_t inlen, void *out, size_t outlen))
105         {
106         BN_CTX *ctx;
107         EC_POINT *tmp=NULL;
108         BIGNUM *x=NULL, *y=NULL;
109         int ret= -1, buflen, len;
110         unsigned char *buf=NULL;
111
112         if (outlen > INT_MAX)
113                 {
114                 ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ERR_R_MALLOC_FAILURE); /* sort of, anyway */
115                 return -1;
116                 }
117
118         if ((ctx = BN_CTX_new()) == NULL) goto err;
119         BN_CTX_start(ctx);
120         x = BN_CTX_get(ctx);
121         y = BN_CTX_get(ctx);
122         
123         if (ecdh->priv_key == NULL)
124                 {
125                 ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ECDH_R_NO_PRIVATE_VALUE);
126                 goto err;
127                 }
128
129         if ((tmp=EC_POINT_new(ecdh->group)) == NULL)
130                 {
131                 ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ERR_R_MALLOC_FAILURE);
132                 goto err;
133                 }
134
135         if (!EC_POINT_mul(ecdh->group, tmp, NULL, pub_key, ecdh->priv_key, ctx)) 
136                 {
137                 ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ECDH_R_POINT_ARITHMETIC_FAILURE);
138                 goto err;
139                 }
140                 
141         if (EC_METHOD_get_field_type(EC_GROUP_method_of(ecdh->group)) == NID_X9_62_prime_field) 
142                 {
143                 if (!EC_POINT_get_affine_coordinates_GFp(ecdh->group, tmp, x, y, ctx)) 
144                         {
145                         ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ECDH_R_POINT_ARITHMETIC_FAILURE);
146                         goto err;
147                         }
148                 }
149         else
150                 {
151                 if (!EC_POINT_get_affine_coordinates_GF2m(ecdh->group, tmp, x, y, ctx)) 
152                         {
153                         ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ECDH_R_POINT_ARITHMETIC_FAILURE);
154                         goto err;
155                         }
156                 }
157
158         buflen = (EC_GROUP_get_degree(ecdh->group) + 7)/8;
159         len = BN_num_bytes(x);
160         if (len > buflen)
161                 {
162                 ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ERR_R_INTERNAL_ERROR);
163                 goto err;
164                 }
165         if ((buf = OPENSSL_malloc(buflen)) == NULL)
166                 {
167                 ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ERR_R_MALLOC_FAILURE);
168                 goto err;
169                 }
170         
171         memset(buf, 0, buflen - len);
172         if (len != BN_bn2bin(x, buf + buflen - len))
173                 {
174                 ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ERR_R_BN_LIB);
175                 goto err;
176                 }
177
178         if (KDF != 0)
179                 {
180                 if (KDF(buf, buflen, out, outlen) == NULL)
181                         {
182                         ECDHerr(ECDH_F_ECDH_COMPUTE_KEY,ECDH_R_KDF_FAILED);
183                         goto err;
184                         }
185                 ret = outlen;
186                 }
187         else
188                 {
189                 /* no KDF, just copy as much as we can */
190                 if (outlen > buflen)
191                         outlen = buflen;
192                 memcpy(out, buf, outlen);
193                 ret = outlen;
194                 }
195         
196 err:
197         if (tmp) EC_POINT_free(tmp);
198         if (ctx) BN_CTX_end(ctx);
199         if (ctx) BN_CTX_free(ctx);
200         if (buf) OPENSSL_free(buf);
201         return(ret);
202         }