99c722bf03924c186a1fe73ef4de3b35e93265c6
[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 #ifdef OPENSSL_FIPS
65 #include <openssl/fips.h>
66 #endif
67
68 static int generate_key(DH *dh);
69 static int compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
70 static int dh_bn_mod_exp(const DH *dh, BIGNUM *r,
71                         const BIGNUM *a, const BIGNUM *p,
72                         const BIGNUM *m, BN_CTX *ctx,
73                         BN_MONT_CTX *m_ctx);
74 static int dh_init(DH *dh);
75 static int dh_finish(DH *dh);
76
77 int DH_generate_key(DH *dh)
78         {
79         return dh->meth->generate_key(dh);
80         }
81
82 int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh)
83         {
84         return dh->meth->compute_key(key, pub_key, dh);
85         }
86
87 static DH_METHOD dh_ossl = {
88 "OpenSSL DH Method",
89 generate_key,
90 compute_key,
91 dh_bn_mod_exp,
92 dh_init,
93 dh_finish,
94 0,
95 NULL,
96 NULL
97 };
98
99 const DH_METHOD *DH_OpenSSL(void)
100 {
101         return &dh_ossl;
102 }
103
104 static int generate_key(DH *dh)
105         {
106         int ok=0;
107         int generate_new_key=0;
108         unsigned l;
109         BN_CTX *ctx;
110         BN_MONT_CTX *mont=NULL;
111         BIGNUM *pub_key=NULL,*priv_key=NULL;
112
113 #ifdef OPENSSL_FIPS
114         if (FIPS_mode() && (BN_num_bits(dh->p) < OPENSSL_DH_FIPS_MIN_MODULUS_BITS))
115                 {
116                 DHerr(DH_F_GENERATE_KEY, DH_R_KEY_SIZE_TOO_SMALL);
117                 return 0;
118                 }
119 #endif
120
121         ctx = BN_CTX_new();
122         if (ctx == NULL) goto err;
123
124         if (dh->priv_key == NULL)
125                 {
126                 priv_key=BN_new();
127                 if (priv_key == NULL) goto err;
128                 generate_new_key=1;
129                 }
130         else
131                 priv_key=dh->priv_key;
132
133         if (dh->pub_key == NULL)
134                 {
135                 pub_key=BN_new();
136                 if (pub_key == NULL) goto err;
137                 }
138         else
139                 pub_key=dh->pub_key;
140
141
142         if (dh->flags & DH_FLAG_CACHE_MONT_P)
143                 {
144                 mont = BN_MONT_CTX_set_locked(&dh->method_mont_p,
145                                 CRYPTO_LOCK_DH, dh->p, ctx);
146                 if (!mont)
147                         goto err;
148                 }
149
150         if (generate_new_key)
151                 {
152                 l = dh->length ? dh->length : BN_num_bits(dh->p)-1; /* secret exponent length */
153                 if (!BN_rand(priv_key, l, 0, 0)) goto err;
154                 }
155
156         {
157                 BIGNUM local_prk;
158                 BIGNUM *prk;
159
160                 if ((dh->flags & DH_FLAG_NO_EXP_CONSTTIME) == 0)
161                         {
162                         BN_init(&local_prk);
163                         prk = &local_prk;
164                         BN_with_flags(prk, priv_key, BN_FLG_CONSTTIME);
165                         }
166                 else
167                         prk = priv_key;
168
169                 if (!dh->meth->bn_mod_exp(dh, pub_key, dh->g, prk, dh->p, ctx, mont)) goto err;
170         }
171                 
172         dh->pub_key=pub_key;
173         dh->priv_key=priv_key;
174         ok=1;
175 err:
176         if (ok != 1)
177                 DHerr(DH_F_GENERATE_KEY,ERR_R_BN_LIB);
178
179         if ((pub_key != NULL)  && (dh->pub_key == NULL))  BN_free(pub_key);
180         if ((priv_key != NULL) && (dh->priv_key == NULL)) BN_free(priv_key);
181         BN_CTX_free(ctx);
182         return(ok);
183         }
184
185 static int compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh)
186         {
187         BN_CTX *ctx=NULL;
188         BN_MONT_CTX *mont=NULL;
189         BIGNUM *tmp;
190         int ret= -1;
191         int check_result;
192
193         if (BN_num_bits(dh->p) > OPENSSL_DH_MAX_MODULUS_BITS)
194                 {
195                 DHerr(DH_F_COMPUTE_KEY,DH_R_MODULUS_TOO_LARGE);
196                 goto err;
197                 }
198
199 #ifdef OPENSSL_FIPS
200         if (FIPS_mode() && (BN_num_bits(dh->p) < OPENSSL_DH_FIPS_MIN_MODULUS_BITS))
201                 {
202                 DHerr(DH_F_COMPUTE_KEY, DH_R_KEY_SIZE_TOO_SMALL);
203                 goto err;
204                 }
205 #endif
206
207         ctx = BN_CTX_new();
208         if (ctx == NULL) goto err;
209         BN_CTX_start(ctx);
210         tmp = BN_CTX_get(ctx);
211         
212         if (dh->priv_key == NULL)
213                 {
214                 DHerr(DH_F_COMPUTE_KEY,DH_R_NO_PRIVATE_VALUE);
215                 goto err;
216                 }
217
218         if (dh->flags & DH_FLAG_CACHE_MONT_P)
219                 {
220                 mont = BN_MONT_CTX_set_locked(&dh->method_mont_p,
221                                 CRYPTO_LOCK_DH, dh->p, ctx);
222                 if ((dh->flags & DH_FLAG_NO_EXP_CONSTTIME) == 0)
223                         {
224                         /* XXX */
225                         BN_set_flags(dh->priv_key, BN_FLG_CONSTTIME);
226                         }
227                 if (!mont)
228                         goto err;
229                 }
230
231         if (!DH_check_pub_key(dh, pub_key, &check_result) || check_result)
232                 {
233                 DHerr(DH_F_COMPUTE_KEY,DH_R_INVALID_PUBKEY);
234                 goto err;
235                 }
236
237         if (!dh->meth->bn_mod_exp(dh, tmp, pub_key, dh->priv_key,dh->p,ctx,mont))
238                 {
239                 DHerr(DH_F_COMPUTE_KEY,ERR_R_BN_LIB);
240                 goto err;
241                 }
242
243         ret=BN_bn2bin(tmp,key);
244 err:
245         if (ctx != NULL)
246                 {
247                 BN_CTX_end(ctx);
248                 BN_CTX_free(ctx);
249                 }
250         return(ret);
251         }
252
253 static int dh_bn_mod_exp(const DH *dh, BIGNUM *r,
254                         const BIGNUM *a, const BIGNUM *p,
255                         const BIGNUM *m, BN_CTX *ctx,
256                         BN_MONT_CTX *m_ctx)
257         {
258         /* If a is only one word long and constant time is false, use the faster
259          * exponenentiation function.
260          */
261         if (a->top == 1 && ((dh->flags & DH_FLAG_NO_EXP_CONSTTIME) != 0))
262                 {
263                 BN_ULONG A = a->d[0];
264                 return BN_mod_exp_mont_word(r,A,p,m,ctx,m_ctx);
265                 }
266         else
267                 return BN_mod_exp_mont(r,a,p,m,ctx,m_ctx);
268         }
269
270
271 static int dh_init(DH *dh)
272         {
273 #ifdef OPENSSL_FIPS
274         FIPS_selftest_check();
275 #endif
276         dh->flags |= DH_FLAG_CACHE_MONT_P;
277         return(1);
278         }
279
280 static int dh_finish(DH *dh)
281         {
282         if(dh->method_mont_p)
283                 BN_MONT_CTX_free(dh->method_mont_p);
284         return(1);
285         }