2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
61 #include <openssl/asn1t.h>
62 #include <openssl/x509.h>
63 #include <openssl/evp.h>
64 #include <openssl/dh.h>
65 #include <openssl/bn.h>
66 #ifndef OPENSSL_NO_DSA
67 # include <openssl/dsa.h>
69 #include <openssl/objects.h>
72 /* DH pkey context structure */
75 /* Parameter gen parameters */
80 /* message digest used for parameter generation */
83 /* Keygen callback info */
85 /* KDF (if any) to use for DH */
87 /* OID to use for KDF */
89 /* Message digest to use for key derivation */
91 /* User key material */
92 unsigned char *kdf_ukm;
94 /* KDF output length */
98 static int pkey_dh_init(EVP_PKEY_CTX *ctx)
101 dctx = OPENSSL_malloc(sizeof(DH_PKEY_CTX));
104 dctx->prime_len = 1024;
105 dctx->subprime_len = -1;
109 dctx->rfc5114_param = 0;
111 dctx->kdf_type = EVP_PKEY_DH_KDF_NONE;
112 dctx->kdf_oid = NULL;
114 dctx->kdf_ukm = NULL;
115 dctx->kdf_ukmlen = 0;
116 dctx->kdf_outlen = 0;
119 ctx->keygen_info = dctx->gentmp;
120 ctx->keygen_info_count = 2;
125 static int pkey_dh_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
127 DH_PKEY_CTX *dctx, *sctx;
128 if (!pkey_dh_init(dst))
132 dctx->prime_len = sctx->prime_len;
133 dctx->subprime_len = sctx->subprime_len;
134 dctx->generator = sctx->generator;
135 dctx->use_dsa = sctx->use_dsa;
137 dctx->rfc5114_param = sctx->rfc5114_param;
139 dctx->kdf_type = sctx->kdf_type;
140 dctx->kdf_oid = OBJ_dup(sctx->kdf_oid);
143 dctx->kdf_md = sctx->kdf_md;
145 dctx->kdf_ukm = BUF_memdup(sctx->kdf_ukm, sctx->kdf_ukmlen);
146 dctx->kdf_ukmlen = sctx->kdf_ukmlen;
148 dctx->kdf_outlen = sctx->kdf_outlen;
152 static void pkey_dh_cleanup(EVP_PKEY_CTX *ctx)
154 DH_PKEY_CTX *dctx = ctx->data;
157 OPENSSL_free(dctx->kdf_ukm);
159 ASN1_OBJECT_free(dctx->kdf_oid);
164 static int pkey_dh_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
166 DH_PKEY_CTX *dctx = ctx->data;
168 case EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN:
171 dctx->prime_len = p1;
174 case EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN:
175 if (dctx->use_dsa == 0)
177 dctx->subprime_len = p1;
180 case EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR:
183 dctx->generator = p1;
186 case EVP_PKEY_CTRL_DH_PARAMGEN_TYPE:
187 #ifdef OPENSSL_NO_DSA
191 if (p1 < 0 || p1 > 2)
197 case EVP_PKEY_CTRL_DH_RFC5114:
198 if (p1 < 1 || p1 > 3)
200 dctx->rfc5114_param = p1;
203 case EVP_PKEY_CTRL_PEER_KEY:
204 /* Default behaviour is OK */
207 case EVP_PKEY_CTRL_DH_KDF_TYPE:
209 return dctx->kdf_type;
210 if (p1 != EVP_PKEY_DH_KDF_NONE && p1 != EVP_PKEY_DH_KDF_X9_42)
215 case EVP_PKEY_CTRL_DH_KDF_MD:
219 case EVP_PKEY_CTRL_GET_DH_KDF_MD:
220 *(const EVP_MD **)p2 = dctx->kdf_md;
223 case EVP_PKEY_CTRL_DH_KDF_OUTLEN:
226 dctx->kdf_outlen = (size_t)p1;
229 case EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN:
230 *(int *)p2 = dctx->kdf_outlen;
233 case EVP_PKEY_CTRL_DH_KDF_UKM:
235 OPENSSL_free(dctx->kdf_ukm);
238 dctx->kdf_ukmlen = p1;
240 dctx->kdf_ukmlen = 0;
243 case EVP_PKEY_CTRL_GET_DH_KDF_UKM:
244 *(unsigned char **)p2 = dctx->kdf_ukm;
245 return dctx->kdf_ukmlen;
247 case EVP_PKEY_CTRL_DH_KDF_OID:
249 ASN1_OBJECT_free(dctx->kdf_oid);
253 case EVP_PKEY_CTRL_GET_DH_KDF_OID:
254 *(ASN1_OBJECT **)p2 = dctx->kdf_oid;
263 static int pkey_dh_ctrl_str(EVP_PKEY_CTX *ctx,
264 const char *type, const char *value)
266 if (!strcmp(type, "dh_paramgen_prime_len")) {
269 return EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len);
271 if (!strcmp(type, "dh_rfc5114")) {
272 DH_PKEY_CTX *dctx = ctx->data;
275 if (len < 0 || len > 3)
277 dctx->rfc5114_param = len;
280 if (!strcmp(type, "dh_paramgen_generator")) {
283 return EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, len);
285 if (!strcmp(type, "dh_paramgen_subprime_len")) {
288 return EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len);
290 if (!strcmp(type, "dh_paramgen_type")) {
293 return EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ);
298 #ifndef OPENSSL_NO_DSA
300 extern int dsa_builtin_paramgen(DSA *ret, size_t bits, size_t qbits,
302 const unsigned char *seed_in, size_t seed_len,
303 unsigned char *seed_out, int *counter_ret,
304 unsigned long *h_ret, BN_GENCB *cb);
306 extern int dsa_builtin_paramgen2(DSA *ret, size_t L, size_t N,
308 const unsigned char *seed_in,
309 size_t seed_len, int idx,
310 unsigned char *seed_out, int *counter_ret,
311 unsigned long *h_ret, BN_GENCB *cb);
313 static DSA *dsa_dh_generate(DH_PKEY_CTX *dctx, BN_GENCB *pcb)
317 int prime_len = dctx->prime_len;
318 int subprime_len = dctx->subprime_len;
319 const EVP_MD *md = dctx->md;
320 if (dctx->use_dsa > 2)
325 if (subprime_len == -1) {
326 if (prime_len >= 2048)
332 if (prime_len >= 2048)
337 if (dctx->use_dsa == 1)
338 rv = dsa_builtin_paramgen(ret, prime_len, subprime_len, md,
339 NULL, 0, NULL, NULL, NULL, pcb);
340 else if (dctx->use_dsa == 2)
341 rv = dsa_builtin_paramgen2(ret, prime_len, subprime_len, md,
342 NULL, 0, -1, NULL, NULL, NULL, pcb);
352 static int pkey_dh_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
355 DH_PKEY_CTX *dctx = ctx->data;
358 if (dctx->rfc5114_param) {
359 switch (dctx->rfc5114_param) {
361 dh = DH_get_1024_160();
365 dh = DH_get_2048_224();
369 dh = DH_get_2048_256();
375 EVP_PKEY_assign(pkey, EVP_PKEY_DHX, dh);
379 if (ctx->pkey_gencb) {
381 evp_pkey_set_cb_translate(pcb, ctx);
384 #ifndef OPENSSL_NO_DSA
387 dsa_dh = dsa_dh_generate(dctx, pcb);
390 dh = DSA_dup_DH(dsa_dh);
394 EVP_PKEY_assign(pkey, EVP_PKEY_DHX, dh);
401 ret = DH_generate_parameters_ex(dh,
402 dctx->prime_len, dctx->generator, pcb);
405 EVP_PKEY_assign_DH(pkey, dh);
411 static int pkey_dh_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
414 if (ctx->pkey == NULL) {
415 DHerr(DH_F_PKEY_DH_KEYGEN, DH_R_NO_PARAMETERS_SET);
421 EVP_PKEY_assign(pkey, ctx->pmeth->pkey_id, dh);
422 /* Note: if error return, pkey is freed by parent routine */
423 if (!EVP_PKEY_copy_parameters(pkey, ctx->pkey))
425 return DH_generate_key(pkey->pkey.dh);
428 static int pkey_dh_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
433 DH_PKEY_CTX *dctx = ctx->data;
435 if (!ctx->pkey || !ctx->peerkey) {
436 DHerr(DH_F_PKEY_DH_DERIVE, DH_R_KEYS_NOT_SET);
439 dh = ctx->pkey->pkey.dh;
440 dhpub = ctx->peerkey->pkey.dh->pub_key;
441 if (dctx->kdf_type == EVP_PKEY_DH_KDF_NONE) {
443 *keylen = DH_size(dh);
446 ret = DH_compute_key(key, dhpub, dh);
451 } else if (dctx->kdf_type == EVP_PKEY_DH_KDF_X9_42) {
452 unsigned char *Z = NULL;
454 if (!dctx->kdf_outlen || !dctx->kdf_oid)
457 *keylen = dctx->kdf_outlen;
460 if (*keylen != dctx->kdf_outlen)
464 Z = OPENSSL_malloc(Zlen);
468 if (DH_compute_key_padded(Z, dhpub, dh) <= 0)
470 if (!DH_KDF_X9_42(key, *keylen, Z, Zlen, dctx->kdf_oid,
471 dctx->kdf_ukm, dctx->kdf_ukmlen, dctx->kdf_md))
473 *keylen = dctx->kdf_outlen;
477 OPENSSL_cleanse(Z, Zlen);
485 const EVP_PKEY_METHOD dh_pkey_meth = {
519 const EVP_PKEY_METHOD dhx_pkey_meth = {