Backport GCM support from HEAD. Minimal support at present: no assembly
[openssl.git] / crypto / dh / dh_key.c
1 /* crypto/dh/dh_key.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/bn.h>
62 #include <openssl/rand.h>
63 #include <openssl/dh.h>
64
65 static int generate_key(DH *dh);
66 static int compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
67 static int dh_bn_mod_exp(const DH *dh, BIGNUM *r,
68                         const BIGNUM *a, const BIGNUM *p,
69                         const BIGNUM *m, BN_CTX *ctx,
70                         BN_MONT_CTX *m_ctx);
71 static int dh_init(DH *dh);
72 static int dh_finish(DH *dh);
73
74 int DH_generate_key(DH *dh)
75         {
76 #ifdef OPENSSL_FIPS
77         if (FIPS_mode() && !(dh->meth->flags & DH_FLAG_FIPS_METHOD)
78                         && !(dh->flags & DH_FLAG_NON_FIPS_ALLOW))
79                 {
80                 DHerr(DH_F_DH_GENERATE_KEY, DH_R_NON_FIPS_METHOD);
81                 return 0;
82                 }
83 #endif
84         return dh->meth->generate_key(dh);
85         }
86
87 int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh)
88         {
89 #ifdef OPENSSL_FIPS
90         if (FIPS_mode() && !(dh->meth->flags & DH_FLAG_FIPS_METHOD)
91                         && !(dh->flags & DH_FLAG_NON_FIPS_ALLOW))
92                 {
93                 DHerr(DH_F_DH_COMPUTE_KEY, DH_R_NON_FIPS_METHOD);
94                 return 0;
95                 }
96 #endif
97         return dh->meth->compute_key(key, pub_key, dh);
98         }
99
100 static DH_METHOD dh_ossl = {
101 "OpenSSL DH Method",
102 generate_key,
103 compute_key,
104 dh_bn_mod_exp,
105 dh_init,
106 dh_finish,
107 0,
108 NULL,
109 NULL
110 };
111
112 const DH_METHOD *DH_OpenSSL(void)
113 {
114         return &dh_ossl;
115 }
116
117 static int generate_key(DH *dh)
118         {
119         int ok=0;
120         int generate_new_key=0;
121         unsigned l;
122         BN_CTX *ctx;
123         BN_MONT_CTX *mont=NULL;
124         BIGNUM *pub_key=NULL,*priv_key=NULL;
125
126         ctx = BN_CTX_new();
127         if (ctx == NULL) goto err;
128
129         if (dh->priv_key == NULL)
130                 {
131                 priv_key=BN_new();
132                 if (priv_key == NULL) goto err;
133                 generate_new_key=1;
134                 }
135         else
136                 priv_key=dh->priv_key;
137
138         if (dh->pub_key == NULL)
139                 {
140                 pub_key=BN_new();
141                 if (pub_key == NULL) goto err;
142                 }
143         else
144                 pub_key=dh->pub_key;
145
146
147         if (dh->flags & DH_FLAG_CACHE_MONT_P)
148                 {
149                 mont = BN_MONT_CTX_set_locked(&dh->method_mont_p,
150                                 CRYPTO_LOCK_DH, dh->p, ctx);
151                 if (!mont)
152                         goto err;
153                 }
154
155         if (generate_new_key)
156                 {
157                 l = dh->length ? dh->length : BN_num_bits(dh->p)-1; /* secret exponent length */
158                 if (!BN_rand(priv_key, l, 0, 0)) goto err;
159                 }
160
161         {
162                 BIGNUM local_prk;
163                 BIGNUM *prk;
164
165                 if ((dh->flags & DH_FLAG_NO_EXP_CONSTTIME) == 0)
166                         {
167                         BN_init(&local_prk);
168                         prk = &local_prk;
169                         BN_with_flags(prk, priv_key, BN_FLG_CONSTTIME);
170                         }
171                 else
172                         prk = priv_key;
173
174                 if (!dh->meth->bn_mod_exp(dh, pub_key, dh->g, prk, dh->p, ctx, mont)) goto err;
175         }
176                 
177         dh->pub_key=pub_key;
178         dh->priv_key=priv_key;
179         ok=1;
180 err:
181         if (ok != 1)
182                 DHerr(DH_F_GENERATE_KEY,ERR_R_BN_LIB);
183
184         if ((pub_key != NULL)  && (dh->pub_key == NULL))  BN_free(pub_key);
185         if ((priv_key != NULL) && (dh->priv_key == NULL)) BN_free(priv_key);
186         BN_CTX_free(ctx);
187         return(ok);
188         }
189
190 static int compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh)
191         {
192         BN_CTX *ctx=NULL;
193         BN_MONT_CTX *mont=NULL;
194         BIGNUM *tmp;
195         int ret= -1;
196         int check_result;
197
198         if (BN_num_bits(dh->p) > OPENSSL_DH_MAX_MODULUS_BITS)
199                 {
200                 DHerr(DH_F_COMPUTE_KEY,DH_R_MODULUS_TOO_LARGE);
201                 goto err;
202                 }
203
204         ctx = BN_CTX_new();
205         if (ctx == NULL) goto err;
206         BN_CTX_start(ctx);
207         tmp = BN_CTX_get(ctx);
208         
209         if (dh->priv_key == NULL)
210                 {
211                 DHerr(DH_F_COMPUTE_KEY,DH_R_NO_PRIVATE_VALUE);
212                 goto err;
213                 }
214
215         if (dh->flags & DH_FLAG_CACHE_MONT_P)
216                 {
217                 mont = BN_MONT_CTX_set_locked(&dh->method_mont_p,
218                                 CRYPTO_LOCK_DH, dh->p, ctx);
219                 if ((dh->flags & DH_FLAG_NO_EXP_CONSTTIME) == 0)
220                         {
221                         /* XXX */
222                         BN_set_flags(dh->priv_key, BN_FLG_CONSTTIME);
223                         }
224                 if (!mont)
225                         goto err;
226                 }
227
228         if (!DH_check_pub_key(dh, pub_key, &check_result) || check_result)
229                 {
230                 DHerr(DH_F_COMPUTE_KEY,DH_R_INVALID_PUBKEY);
231                 goto err;
232                 }
233
234         if (!dh->meth->bn_mod_exp(dh, tmp, pub_key, dh->priv_key,dh->p,ctx,mont))
235                 {
236                 DHerr(DH_F_COMPUTE_KEY,ERR_R_BN_LIB);
237                 goto err;
238                 }
239
240         ret=BN_bn2bin(tmp,key);
241 err:
242         if (ctx != NULL)
243                 {
244                 BN_CTX_end(ctx);
245                 BN_CTX_free(ctx);
246                 }
247         return(ret);
248         }
249
250 static int dh_bn_mod_exp(const DH *dh, BIGNUM *r,
251                         const BIGNUM *a, const BIGNUM *p,
252                         const BIGNUM *m, BN_CTX *ctx,
253                         BN_MONT_CTX *m_ctx)
254         {
255         /* If a is only one word long and constant time is false, use the faster
256          * exponenentiation function.
257          */
258         if (a->top == 1 && ((dh->flags & DH_FLAG_NO_EXP_CONSTTIME) != 0))
259                 {
260                 BN_ULONG A = a->d[0];
261                 return BN_mod_exp_mont_word(r,A,p,m,ctx,m_ctx);
262                 }
263         else
264                 return BN_mod_exp_mont(r,a,p,m,ctx,m_ctx);
265         }
266
267
268 static int dh_init(DH *dh)
269         {
270         dh->flags |= DH_FLAG_CACHE_MONT_P;
271         return(1);
272         }
273
274 static int dh_finish(DH *dh)
275         {
276         if(dh->method_mont_p)
277                 BN_MONT_CTX_free(dh->method_mont_p);
278         return(1);
279         }