2 Diffie-Hellman Wrapper Implementation over OpenSSL.
4 Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "InternalCryptLib.h"
16 #include <openssl/dh.h>
20 Allocates and Initializes one Diffie-Hellman Context for subsequent use.
22 @return Pointer to the Diffie-Hellman Context that has been initialized.
23 If the allocations fails, DhNew() returns NULL.
33 // Allocates & Initializes DH Context by OpenSSL DH_new()
35 return (VOID
*) DH_new ();
39 Release the specified DH context.
41 If DhContext is NULL, then return FALSE.
43 @param[in] DhContext Pointer to the DH context to be released.
53 // Free OpenSSL DH Context
55 DH_free ((DH
*) DhContext
);
59 Generates DH parameter.
61 Given generator g, and length of prime number p in bits, this function generates p,
62 and sets DH context according to value of g and p.
64 Before this function can be invoked, pseudorandom number generator must be correctly
65 initialized by RandomSeed().
67 If DhContext is NULL, then return FALSE.
68 If Prime is NULL, then return FALSE.
70 @param[in, out] DhContext Pointer to the DH context.
71 @param[in] Generator Value of generator.
72 @param[in] PrimeLength Length in bits of prime to be generated.
73 @param[out] Prime Pointer to the buffer to receive the generated prime number.
75 @retval TRUE DH pamameter generation succeeded.
76 @retval FALSE Value of Generator is not supported.
77 @retval FALSE PRNG fails to generate random prime number with PrimeLength.
83 IN OUT VOID
*DhContext
,
92 // Check input parameters.
94 if (DhContext
== NULL
|| Prime
== NULL
) {
98 if (Generator
!= DH_GENERATOR_2
&& Generator
!= DH_GENERATOR_5
) {
102 RetVal
= (BOOLEAN
) DH_generate_parameters_ex (DhContext
, (UINT32
) PrimeLength
, (UINT32
) Generator
, NULL
);
107 BN_bn2bin (((DH
*) DhContext
)->p
, Prime
);
113 Sets generator and prime parameters for DH.
115 Given generator g, and prime number p, this function and sets DH
118 If DhContext is NULL, then return FALSE.
119 If Prime is NULL, then return FALSE.
121 @param[in, out] DhContext Pointer to the DH context.
122 @param[in] Generator Value of generator.
123 @param[in] PrimeLength Length in bits of prime to be generated.
124 @param[in] Prime Pointer to the prime number.
126 @retval TRUE DH pamameter setting succeeded.
127 @retval FALSE Value of Generator is not supported.
128 @retval FALSE Value of Generator is not suitable for the Prime.
129 @retval FALSE Value of Prime is not a prime number.
130 @retval FALSE Value of Prime is not a safe prime number.
136 IN OUT VOID
*DhContext
,
138 IN UINTN PrimeLength
,
139 IN CONST UINT8
*Prime
145 // Check input parameters.
147 if (DhContext
== NULL
|| Prime
== NULL
) {
151 if (Generator
!= DH_GENERATOR_2
&& Generator
!= DH_GENERATOR_5
) {
155 Dh
= (DH
*) DhContext
;
159 BN_bin2bn (Prime
, (UINT32
) (PrimeLength
/ 8), Dh
->p
);
160 BN_set_word (Dh
->g
, (UINT32
) Generator
);
166 Generates DH public key.
168 This function generates random secret exponent, and computes the public key, which is
169 returned via parameter PublicKey and PublicKeySize. DH context is updated accordingly.
170 If the PublicKey buffer is too small to hold the public key, FALSE is returned and
171 PublicKeySize is set to the required buffer size to obtain the public key.
173 If DhContext is NULL, then return FALSE.
174 If PublicKeySize is NULL, then return FALSE.
175 If PublicKeySize is large enough but PublicKey is NULL, then return FALSE.
177 @param[in, out] DhContext Pointer to the DH context.
178 @param[out] PublicKey Pointer to the buffer to receive generated public key.
179 @param[in, out] PublicKeySize On input, the size of PublicKey buffer in bytes.
180 On output, the size of data returned in PublicKey buffer in bytes.
182 @retval TRUE DH public key generation succeeded.
183 @retval FALSE DH public key generation failed.
184 @retval FALSE PublicKeySize is not large enough.
190 IN OUT VOID
*DhContext
,
191 OUT UINT8
*PublicKey
,
192 IN OUT UINTN
*PublicKeySize
199 // Check input parameters.
201 if (DhContext
== NULL
|| PublicKeySize
== NULL
) {
205 if (PublicKey
== NULL
&& *PublicKeySize
!= 0) {
209 Dh
= (DH
*) DhContext
;
212 RetVal
= (BOOLEAN
) DH_generate_key (DhContext
);
214 BN_bn2bin (Dh
->pub_key
, PublicKey
);
215 *PublicKeySize
= BN_num_bytes (Dh
->pub_key
);
222 Computes exchanged common key.
224 Given peer's public key, this function computes the exchanged common key, based on its own
225 context including value of prime modulus and random secret exponent.
227 If DhContext is NULL, then return FALSE.
228 If PeerPublicKey is NULL, then return FALSE.
229 If KeySize is NULL, then return FALSE.
230 If KeySize is large enough but Key is NULL, then return FALSE.
232 @param[in, out] DhContext Pointer to the DH context.
233 @param[in] PeerPublicKey Pointer to the peer's public key.
234 @param[in] PeerPublicKeySize Size of peer's public key in bytes.
235 @param[out] Key Pointer to the buffer to receive generated key.
236 @param[in, out] KeySize On input, the size of Key buffer in bytes.
237 On output, the size of data returned in Key buffer in bytes.
239 @retval TRUE DH exchanged key generation succeeded.
240 @retval FALSE DH exchanged key generation failed.
241 @retval FALSE KeySize is not large enough.
247 IN OUT VOID
*DhContext
,
248 IN CONST UINT8
*PeerPublicKey
,
249 IN UINTN PeerPublicKeySize
,
251 IN OUT UINTN
*KeySize
257 // Check input parameters.
259 if (DhContext
== NULL
|| PeerPublicKey
== NULL
|| KeySize
== NULL
) {
263 if (Key
== NULL
&& *KeySize
!= 0) {
267 Bn
= BN_bin2bn (PeerPublicKey
, (UINT32
) PeerPublicKeySize
, NULL
);
269 *KeySize
= (BOOLEAN
) DH_compute_key (Key
, Bn
, DhContext
);