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 #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(*dctx
));
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
;
156 OPENSSL_free(dctx
->kdf_ukm
);
157 ASN1_OBJECT_free(dctx
->kdf_oid
);
162 static int pkey_dh_ctrl(EVP_PKEY_CTX
*ctx
, int type
, int p1
, void *p2
)
164 DH_PKEY_CTX
*dctx
= ctx
->data
;
166 case EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN
:
169 dctx
->prime_len
= p1
;
172 case EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN
:
173 if (dctx
->use_dsa
== 0)
175 dctx
->subprime_len
= p1
;
178 case EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR
:
181 dctx
->generator
= p1
;
184 case EVP_PKEY_CTRL_DH_PARAMGEN_TYPE
:
185 #ifdef OPENSSL_NO_DSA
189 if (p1
< 0 || p1
> 2)
195 case EVP_PKEY_CTRL_DH_RFC5114
:
196 if (p1
< 1 || p1
> 3)
198 dctx
->rfc5114_param
= p1
;
201 case EVP_PKEY_CTRL_PEER_KEY
:
202 /* Default behaviour is OK */
205 case EVP_PKEY_CTRL_DH_KDF_TYPE
:
207 return dctx
->kdf_type
;
208 #ifdef OPENSSL_NO_CMS
209 if (p1
!= EVP_PKEY_DH_KDF_NONE
)
211 if (p1
!= EVP_PKEY_DH_KDF_NONE
&& p1
!= EVP_PKEY_DH_KDF_X9_42
)
217 case EVP_PKEY_CTRL_DH_KDF_MD
:
221 case EVP_PKEY_CTRL_GET_DH_KDF_MD
:
222 *(const EVP_MD
**)p2
= dctx
->kdf_md
;
225 case EVP_PKEY_CTRL_DH_KDF_OUTLEN
:
228 dctx
->kdf_outlen
= (size_t)p1
;
231 case EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN
:
232 *(int *)p2
= dctx
->kdf_outlen
;
235 case EVP_PKEY_CTRL_DH_KDF_UKM
:
236 OPENSSL_free(dctx
->kdf_ukm
);
239 dctx
->kdf_ukmlen
= p1
;
241 dctx
->kdf_ukmlen
= 0;
244 case EVP_PKEY_CTRL_GET_DH_KDF_UKM
:
245 *(unsigned char **)p2
= dctx
->kdf_ukm
;
246 return dctx
->kdf_ukmlen
;
248 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") == 0) {
269 return EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx
, len
);
271 if (strcmp(type
, "dh_rfc5114") == 0) {
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") == 0) {
283 return EVP_PKEY_CTX_set_dh_paramgen_generator(ctx
, len
);
285 if (strcmp(type
, "dh_paramgen_subprime_len") == 0) {
288 return EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx
, len
);
290 if (strcmp(type
, "dh_paramgen_type") == 0) {
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
) {
380 pcb
= BN_GENCB_new();
381 evp_pkey_set_cb_translate(pcb
, ctx
);
384 #ifndef OPENSSL_NO_DSA
387 dsa_dh
= dsa_dh_generate(dctx
, pcb
);
391 dh
= DSA_dup_DH(dsa_dh
);
395 EVP_PKEY_assign(pkey
, EVP_PKEY_DHX
, dh
);
404 ret
= DH_generate_parameters_ex(dh
,
405 dctx
->prime_len
, dctx
->generator
, pcb
);
408 EVP_PKEY_assign_DH(pkey
, dh
);
414 static int pkey_dh_keygen(EVP_PKEY_CTX
*ctx
, EVP_PKEY
*pkey
)
417 if (ctx
->pkey
== NULL
) {
418 DHerr(DH_F_PKEY_DH_KEYGEN
, DH_R_NO_PARAMETERS_SET
);
424 EVP_PKEY_assign(pkey
, ctx
->pmeth
->pkey_id
, dh
);
425 /* Note: if error return, pkey is freed by parent routine */
426 if (!EVP_PKEY_copy_parameters(pkey
, ctx
->pkey
))
428 return DH_generate_key(pkey
->pkey
.dh
);
431 static int pkey_dh_derive(EVP_PKEY_CTX
*ctx
, unsigned char *key
,
436 DH_PKEY_CTX
*dctx
= ctx
->data
;
438 if (!ctx
->pkey
|| !ctx
->peerkey
) {
439 DHerr(DH_F_PKEY_DH_DERIVE
, DH_R_KEYS_NOT_SET
);
442 dh
= ctx
->pkey
->pkey
.dh
;
443 dhpub
= ctx
->peerkey
->pkey
.dh
->pub_key
;
444 if (dctx
->kdf_type
== EVP_PKEY_DH_KDF_NONE
) {
446 *keylen
= DH_size(dh
);
449 ret
= DH_compute_key(key
, dhpub
, dh
);
455 #ifndef OPENSSL_NO_CMS
456 else if (dctx
->kdf_type
== EVP_PKEY_DH_KDF_X9_42
) {
458 unsigned char *Z
= NULL
;
460 if (!dctx
->kdf_outlen
|| !dctx
->kdf_oid
)
463 *keylen
= dctx
->kdf_outlen
;
466 if (*keylen
!= dctx
->kdf_outlen
)
470 Z
= OPENSSL_malloc(Zlen
);
474 if (DH_compute_key_padded(Z
, dhpub
, dh
) <= 0)
476 if (!DH_KDF_X9_42(key
, *keylen
, Z
, Zlen
, dctx
->kdf_oid
,
477 dctx
->kdf_ukm
, dctx
->kdf_ukmlen
, dctx
->kdf_md
))
479 *keylen
= dctx
->kdf_outlen
;
482 OPENSSL_clear_free(Z
, Zlen
);
489 const EVP_PKEY_METHOD dh_pkey_meth
= {
523 const EVP_PKEY_METHOD dhx_pkey_meth
= {