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).
60 #include "internal/cryptlib.h"
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 #include <openssl/dsa.h>
67 #include <openssl/objects.h>
68 #include "internal/evp_int.h"
70 /* DH pkey context structure */
73 /* Parameter gen parameters */
78 /* message digest used for parameter generation */
81 /* Keygen callback info */
83 /* KDF (if any) to use for DH */
85 /* OID to use for KDF */
87 /* Message digest to use for key derivation */
89 /* User key material */
90 unsigned char *kdf_ukm;
92 /* KDF output length */
96 static int pkey_dh_init(EVP_PKEY_CTX *ctx)
100 dctx = OPENSSL_zalloc(sizeof(*dctx));
103 dctx->prime_len = 1024;
104 dctx->subprime_len = -1;
106 dctx->kdf_type = EVP_PKEY_DH_KDF_NONE;
109 ctx->keygen_info = dctx->gentmp;
110 ctx->keygen_info_count = 2;
115 static int pkey_dh_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
117 DH_PKEY_CTX *dctx, *sctx;
118 if (!pkey_dh_init(dst))
122 dctx->prime_len = sctx->prime_len;
123 dctx->subprime_len = sctx->subprime_len;
124 dctx->generator = sctx->generator;
125 dctx->use_dsa = sctx->use_dsa;
127 dctx->rfc5114_param = sctx->rfc5114_param;
129 dctx->kdf_type = sctx->kdf_type;
130 dctx->kdf_oid = OBJ_dup(sctx->kdf_oid);
133 dctx->kdf_md = sctx->kdf_md;
135 dctx->kdf_ukm = OPENSSL_memdup(sctx->kdf_ukm, sctx->kdf_ukmlen);
136 dctx->kdf_ukmlen = sctx->kdf_ukmlen;
138 dctx->kdf_outlen = sctx->kdf_outlen;
142 static void pkey_dh_cleanup(EVP_PKEY_CTX *ctx)
144 DH_PKEY_CTX *dctx = ctx->data;
146 OPENSSL_free(dctx->kdf_ukm);
147 ASN1_OBJECT_free(dctx->kdf_oid);
152 static int pkey_dh_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
154 DH_PKEY_CTX *dctx = ctx->data;
156 case EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN:
159 dctx->prime_len = p1;
162 case EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN:
163 if (dctx->use_dsa == 0)
165 dctx->subprime_len = p1;
168 case EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR:
171 dctx->generator = p1;
174 case EVP_PKEY_CTRL_DH_PARAMGEN_TYPE:
175 #ifdef OPENSSL_NO_DSA
179 if (p1 < 0 || p1 > 2)
185 case EVP_PKEY_CTRL_DH_RFC5114:
186 if (p1 < 1 || p1 > 3)
188 dctx->rfc5114_param = p1;
191 case EVP_PKEY_CTRL_PEER_KEY:
192 /* Default behaviour is OK */
195 case EVP_PKEY_CTRL_DH_KDF_TYPE:
197 return dctx->kdf_type;
198 #ifdef OPENSSL_NO_CMS
199 if (p1 != EVP_PKEY_DH_KDF_NONE)
201 if (p1 != EVP_PKEY_DH_KDF_NONE && p1 != EVP_PKEY_DH_KDF_X9_42)
207 case EVP_PKEY_CTRL_DH_KDF_MD:
211 case EVP_PKEY_CTRL_GET_DH_KDF_MD:
212 *(const EVP_MD **)p2 = dctx->kdf_md;
215 case EVP_PKEY_CTRL_DH_KDF_OUTLEN:
218 dctx->kdf_outlen = (size_t)p1;
221 case EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN:
222 *(int *)p2 = dctx->kdf_outlen;
225 case EVP_PKEY_CTRL_DH_KDF_UKM:
226 OPENSSL_free(dctx->kdf_ukm);
229 dctx->kdf_ukmlen = p1;
231 dctx->kdf_ukmlen = 0;
234 case EVP_PKEY_CTRL_GET_DH_KDF_UKM:
235 *(unsigned char **)p2 = dctx->kdf_ukm;
236 return dctx->kdf_ukmlen;
238 case EVP_PKEY_CTRL_DH_KDF_OID:
239 ASN1_OBJECT_free(dctx->kdf_oid);
243 case EVP_PKEY_CTRL_GET_DH_KDF_OID:
244 *(ASN1_OBJECT **)p2 = dctx->kdf_oid;
253 static int pkey_dh_ctrl_str(EVP_PKEY_CTX *ctx,
254 const char *type, const char *value)
256 if (strcmp(type, "dh_paramgen_prime_len") == 0) {
259 return EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len);
261 if (strcmp(type, "dh_rfc5114") == 0) {
262 DH_PKEY_CTX *dctx = ctx->data;
265 if (len < 0 || len > 3)
267 dctx->rfc5114_param = len;
270 if (strcmp(type, "dh_paramgen_generator") == 0) {
273 return EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, len);
275 if (strcmp(type, "dh_paramgen_subprime_len") == 0) {
278 return EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len);
280 if (strcmp(type, "dh_paramgen_type") == 0) {
283 return EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ);
288 #ifndef OPENSSL_NO_DSA
290 extern int dsa_builtin_paramgen(DSA *ret, size_t bits, size_t qbits,
292 const unsigned char *seed_in, size_t seed_len,
293 unsigned char *seed_out, int *counter_ret,
294 unsigned long *h_ret, BN_GENCB *cb);
296 extern int dsa_builtin_paramgen2(DSA *ret, size_t L, size_t N,
298 const unsigned char *seed_in,
299 size_t seed_len, int idx,
300 unsigned char *seed_out, int *counter_ret,
301 unsigned long *h_ret, BN_GENCB *cb);
303 static DSA *dsa_dh_generate(DH_PKEY_CTX *dctx, BN_GENCB *pcb)
307 int prime_len = dctx->prime_len;
308 int subprime_len = dctx->subprime_len;
309 const EVP_MD *md = dctx->md;
310 if (dctx->use_dsa > 2)
315 if (subprime_len == -1) {
316 if (prime_len >= 2048)
322 if (prime_len >= 2048)
327 if (dctx->use_dsa == 1)
328 rv = dsa_builtin_paramgen(ret, prime_len, subprime_len, md,
329 NULL, 0, NULL, NULL, NULL, pcb);
330 else if (dctx->use_dsa == 2)
331 rv = dsa_builtin_paramgen2(ret, prime_len, subprime_len, md,
332 NULL, 0, -1, NULL, NULL, NULL, pcb);
342 static int pkey_dh_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
345 DH_PKEY_CTX *dctx = ctx->data;
348 if (dctx->rfc5114_param) {
349 switch (dctx->rfc5114_param) {
351 dh = DH_get_1024_160();
355 dh = DH_get_2048_224();
359 dh = DH_get_2048_256();
365 EVP_PKEY_assign(pkey, EVP_PKEY_DHX, dh);
369 if (ctx->pkey_gencb) {
370 pcb = BN_GENCB_new();
373 evp_pkey_set_cb_translate(pcb, ctx);
376 #ifndef OPENSSL_NO_DSA
379 dsa_dh = dsa_dh_generate(dctx, pcb);
383 dh = DSA_dup_DH(dsa_dh);
387 EVP_PKEY_assign(pkey, EVP_PKEY_DHX, dh);
396 ret = DH_generate_parameters_ex(dh,
397 dctx->prime_len, dctx->generator, pcb);
400 EVP_PKEY_assign_DH(pkey, dh);
406 static int pkey_dh_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
409 if (ctx->pkey == NULL) {
410 DHerr(DH_F_PKEY_DH_KEYGEN, DH_R_NO_PARAMETERS_SET);
416 EVP_PKEY_assign(pkey, ctx->pmeth->pkey_id, dh);
417 /* Note: if error return, pkey is freed by parent routine */
418 if (!EVP_PKEY_copy_parameters(pkey, ctx->pkey))
420 return DH_generate_key(pkey->pkey.dh);
423 static int pkey_dh_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
428 DH_PKEY_CTX *dctx = ctx->data;
430 if (!ctx->pkey || !ctx->peerkey) {
431 DHerr(DH_F_PKEY_DH_DERIVE, DH_R_KEYS_NOT_SET);
434 dh = ctx->pkey->pkey.dh;
435 dhpub = ctx->peerkey->pkey.dh->pub_key;
436 if (dctx->kdf_type == EVP_PKEY_DH_KDF_NONE) {
438 *keylen = DH_size(dh);
441 ret = DH_compute_key(key, dhpub, dh);
447 #ifndef OPENSSL_NO_CMS
448 else if (dctx->kdf_type == EVP_PKEY_DH_KDF_X9_42) {
450 unsigned char *Z = NULL;
452 if (!dctx->kdf_outlen || !dctx->kdf_oid)
455 *keylen = dctx->kdf_outlen;
458 if (*keylen != dctx->kdf_outlen)
462 Z = OPENSSL_malloc(Zlen);
466 if (DH_compute_key_padded(Z, dhpub, dh) <= 0)
468 if (!DH_KDF_X9_42(key, *keylen, Z, Zlen, dctx->kdf_oid,
469 dctx->kdf_ukm, dctx->kdf_ukmlen, dctx->kdf_md))
471 *keylen = dctx->kdf_outlen;
474 OPENSSL_clear_free(Z, Zlen);
481 const EVP_PKEY_METHOD dh_pkey_meth = {
515 const EVP_PKEY_METHOD dhx_pkey_meth = {