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