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>
70 #include "internal/evp_int.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);
158 ASN1_OBJECT_free(dctx->kdf_oid);
163 static int pkey_dh_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
165 DH_PKEY_CTX *dctx = ctx->data;
167 case EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN:
170 dctx->prime_len = p1;
173 case EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN:
174 if (dctx->use_dsa == 0)
176 dctx->subprime_len = p1;
179 case EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR:
182 dctx->generator = p1;
185 case EVP_PKEY_CTRL_DH_PARAMGEN_TYPE:
186 #ifdef OPENSSL_NO_DSA
190 if (p1 < 0 || p1 > 2)
196 case EVP_PKEY_CTRL_DH_RFC5114:
197 if (p1 < 1 || p1 > 3)
199 dctx->rfc5114_param = p1;
202 case EVP_PKEY_CTRL_PEER_KEY:
203 /* Default behaviour is OK */
206 case EVP_PKEY_CTRL_DH_KDF_TYPE:
208 return dctx->kdf_type;
209 if (p1 != EVP_PKEY_DH_KDF_NONE && p1 != EVP_PKEY_DH_KDF_X9_42)
214 case EVP_PKEY_CTRL_DH_KDF_MD:
218 case EVP_PKEY_CTRL_GET_DH_KDF_MD:
219 *(const EVP_MD **)p2 = dctx->kdf_md;
222 case EVP_PKEY_CTRL_DH_KDF_OUTLEN:
225 dctx->kdf_outlen = (size_t)p1;
228 case EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN:
229 *(int *)p2 = dctx->kdf_outlen;
232 case EVP_PKEY_CTRL_DH_KDF_UKM:
234 OPENSSL_free(dctx->kdf_ukm);
237 dctx->kdf_ukmlen = p1;
239 dctx->kdf_ukmlen = 0;
242 case EVP_PKEY_CTRL_GET_DH_KDF_UKM:
243 *(unsigned char **)p2 = dctx->kdf_ukm;
244 return dctx->kdf_ukmlen;
246 case EVP_PKEY_CTRL_DH_KDF_OID:
247 ASN1_OBJECT_free(dctx->kdf_oid);
251 case EVP_PKEY_CTRL_GET_DH_KDF_OID:
252 *(ASN1_OBJECT **)p2 = dctx->kdf_oid;
261 static int pkey_dh_ctrl_str(EVP_PKEY_CTX *ctx,
262 const char *type, const char *value)
264 if (!strcmp(type, "dh_paramgen_prime_len")) {
267 return EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len);
269 if (!strcmp(type, "dh_rfc5114")) {
270 DH_PKEY_CTX *dctx = ctx->data;
273 if (len < 0 || len > 3)
275 dctx->rfc5114_param = len;
278 if (!strcmp(type, "dh_paramgen_generator")) {
281 return EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, len);
283 if (!strcmp(type, "dh_paramgen_subprime_len")) {
286 return EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len);
288 if (!strcmp(type, "dh_paramgen_type")) {
291 return EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ);
296 #ifndef OPENSSL_NO_DSA
298 extern int dsa_builtin_paramgen(DSA *ret, size_t bits, size_t qbits,
300 const unsigned char *seed_in, size_t seed_len,
301 unsigned char *seed_out, int *counter_ret,
302 unsigned long *h_ret, BN_GENCB *cb);
304 extern int dsa_builtin_paramgen2(DSA *ret, size_t L, size_t N,
306 const unsigned char *seed_in,
307 size_t seed_len, int idx,
308 unsigned char *seed_out, int *counter_ret,
309 unsigned long *h_ret, BN_GENCB *cb);
311 static DSA *dsa_dh_generate(DH_PKEY_CTX *dctx, BN_GENCB *pcb)
315 int prime_len = dctx->prime_len;
316 int subprime_len = dctx->subprime_len;
317 const EVP_MD *md = dctx->md;
318 if (dctx->use_dsa > 2)
323 if (subprime_len == -1) {
324 if (prime_len >= 2048)
330 if (prime_len >= 2048)
335 if (dctx->use_dsa == 1)
336 rv = dsa_builtin_paramgen(ret, prime_len, subprime_len, md,
337 NULL, 0, NULL, NULL, NULL, pcb);
338 else if (dctx->use_dsa == 2)
339 rv = dsa_builtin_paramgen2(ret, prime_len, subprime_len, md,
340 NULL, 0, -1, NULL, NULL, NULL, pcb);
350 static int pkey_dh_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
353 DH_PKEY_CTX *dctx = ctx->data;
356 if (dctx->rfc5114_param) {
357 switch (dctx->rfc5114_param) {
359 dh = DH_get_1024_160();
363 dh = DH_get_2048_224();
367 dh = DH_get_2048_256();
373 EVP_PKEY_assign(pkey, EVP_PKEY_DHX, dh);
377 if (ctx->pkey_gencb) {
378 pcb = BN_GENCB_new();
379 evp_pkey_set_cb_translate(pcb, ctx);
382 #ifndef OPENSSL_NO_DSA
385 dsa_dh = dsa_dh_generate(dctx, pcb);
390 dh = DSA_dup_DH(dsa_dh);
394 EVP_PKEY_assign(pkey, EVP_PKEY_DHX, dh);
404 ret = DH_generate_parameters_ex(dh,
405 dctx->prime_len, dctx->generator, pcb);
409 EVP_PKEY_assign_DH(pkey, dh);
415 static int pkey_dh_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
418 if (ctx->pkey == NULL) {
419 DHerr(DH_F_PKEY_DH_KEYGEN, DH_R_NO_PARAMETERS_SET);
425 EVP_PKEY_assign(pkey, ctx->pmeth->pkey_id, dh);
426 /* Note: if error return, pkey is freed by parent routine */
427 if (!EVP_PKEY_copy_parameters(pkey, ctx->pkey))
429 return DH_generate_key(pkey->pkey.dh);
432 static int pkey_dh_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
437 DH_PKEY_CTX *dctx = ctx->data;
439 if (!ctx->pkey || !ctx->peerkey) {
440 DHerr(DH_F_PKEY_DH_DERIVE, DH_R_KEYS_NOT_SET);
443 dh = ctx->pkey->pkey.dh;
444 dhpub = ctx->peerkey->pkey.dh->pub_key;
445 if (dctx->kdf_type == EVP_PKEY_DH_KDF_NONE) {
447 *keylen = DH_size(dh);
450 ret = DH_compute_key(key, dhpub, dh);
455 } else if (dctx->kdf_type == EVP_PKEY_DH_KDF_X9_42) {
456 unsigned char *Z = NULL;
458 if (!dctx->kdf_outlen || !dctx->kdf_oid)
461 *keylen = dctx->kdf_outlen;
464 if (*keylen != dctx->kdf_outlen)
468 Z = OPENSSL_malloc(Zlen);
472 if (DH_compute_key_padded(Z, dhpub, dh) <= 0)
474 if (!DH_KDF_X9_42(key, *keylen, Z, Zlen, dctx->kdf_oid,
475 dctx->kdf_ukm, dctx->kdf_ukmlen, dctx->kdf_md))
477 *keylen = dctx->kdf_outlen;
481 OPENSSL_cleanse(Z, Zlen);
489 const EVP_PKEY_METHOD dh_pkey_meth = {
523 const EVP_PKEY_METHOD dhx_pkey_meth = {