1 /** @file
2   MD4 Digest Wrapper Implementation over OpenSSL.
3 
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
9 
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.
12 
13 **/
14 
15 #include "InternalCryptLib.h"
16 #include <openssl/md4.h>
17 
18 /**
19   Retrieves the size, in bytes, of the context buffer required for MD4 hash operations.
20 
21   @return  The size, in bytes, of the context buffer required for MD4 hash operations.
22 
23 **/
24 UINTN
25 EFIAPI
Md4GetContextSize(VOID)26 Md4GetContextSize (
27   VOID
28   )
29 {
30   //
31   // Retrieves the OpenSSL MD4 Context Size
32   //
33   return (UINTN) (sizeof (MD4_CTX));
34 }
35 
36 /**
37   Initializes user-supplied memory pointed by Md4Context as MD4 hash context for
38   subsequent use.
39 
40   If Md4Context is NULL, then return FALSE.
41 
42   @param[out]  Md4Context  Pointer to MD4 context being initialized.
43 
44   @retval TRUE   MD4 context initialization succeeded.
45   @retval FALSE  MD4 context initialization failed.
46 
47 **/
48 BOOLEAN
49 EFIAPI
Md4Init(OUT VOID * Md4Context)50 Md4Init (
51   OUT  VOID  *Md4Context
52   )
53 {
54   //
55   // Check input parameters.
56   //
57   if (Md4Context == NULL) {
58     return FALSE;
59   }
60 
61   //
62   // OpenSSL MD4 Context Initialization
63   //
64   return (BOOLEAN) (MD4_Init ((MD4_CTX *) Md4Context));
65 }
66 
67 /**
68   Makes a copy of an existing MD4 context.
69 
70   If Md4Context is NULL, then return FALSE.
71   If NewMd4Context is NULL, then return FALSE.
72 
73   @param[in]  Md4Context     Pointer to MD4 context being copied.
74   @param[out] NewMd4Context  Pointer to new MD4 context.
75 
76   @retval TRUE   MD4 context copy succeeded.
77   @retval FALSE  MD4 context copy failed.
78 
79 **/
80 BOOLEAN
81 EFIAPI
Md4Duplicate(IN CONST VOID * Md4Context,OUT VOID * NewMd4Context)82 Md4Duplicate (
83   IN   CONST VOID  *Md4Context,
84   OUT  VOID        *NewMd4Context
85   )
86 {
87   //
88   // Check input parameters.
89   //
90   if (Md4Context == NULL || NewMd4Context == NULL) {
91     return FALSE;
92   }
93 
94   CopyMem (NewMd4Context, Md4Context, sizeof (MD4_CTX));
95 
96   return TRUE;
97 }
98 
99 /**
100   Digests the input data and updates MD4 context.
101 
102   This function performs MD4 digest on a data buffer of the specified size.
103   It can be called multiple times to compute the digest of long or discontinuous data streams.
104   MD4 context should be already correctly intialized by Md4Init(), and should not be finalized
105   by Md4Final(). Behavior with invalid context is undefined.
106 
107   If Md4Context is NULL, then return FALSE.
108 
109   @param[in, out]  Md4Context  Pointer to the MD4 context.
110   @param[in]       Data        Pointer to the buffer containing the data to be hashed.
111   @param[in]       DataSize    Size of Data buffer in bytes.
112 
113   @retval TRUE   MD4 data digest succeeded.
114   @retval FALSE  MD4 data digest failed.
115 
116 **/
117 BOOLEAN
118 EFIAPI
Md4Update(IN OUT VOID * Md4Context,IN CONST VOID * Data,IN UINTN DataSize)119 Md4Update (
120   IN OUT  VOID        *Md4Context,
121   IN      CONST VOID  *Data,
122   IN      UINTN       DataSize
123   )
124 {
125   //
126   // Check input parameters.
127   //
128   if (Md4Context == NULL) {
129     return FALSE;
130   }
131 
132   //
133   // Check invalid parameters, in case that only DataLength was checked in OpenSSL
134   //
135   if (Data == NULL && DataSize != 0) {
136     return FALSE;
137   }
138 
139   //
140   // OpenSSL MD4 Hash Update
141   //
142   return (BOOLEAN) (MD4_Update ((MD4_CTX *) Md4Context, Data, DataSize));
143 }
144 
145 /**
146   Completes computation of the MD4 digest value.
147 
148   This function completes MD4 hash computation and retrieves the digest value into
149   the specified memory. After this function has been called, the MD4 context cannot
150   be used again.
151   MD4 context should be already correctly intialized by Md4Init(), and should not be
152   finalized by Md4Final(). Behavior with invalid MD4 context is undefined.
153 
154   If Md4Context is NULL, then return FALSE.
155   If HashValue is NULL, then return FALSE.
156 
157   @param[in, out]  Md4Context  Pointer to the MD4 context.
158   @param[out]      HashValue   Pointer to a buffer that receives the MD4 digest
159                                value (16 bytes).
160 
161   @retval TRUE   MD4 digest computation succeeded.
162   @retval FALSE  MD4 digest computation failed.
163 
164 **/
165 BOOLEAN
166 EFIAPI
Md4Final(IN OUT VOID * Md4Context,OUT UINT8 * HashValue)167 Md4Final (
168   IN OUT  VOID   *Md4Context,
169   OUT     UINT8  *HashValue
170   )
171 {
172   //
173   // Check input parameters.
174   //
175   if (Md4Context == NULL || HashValue == NULL) {
176     return FALSE;
177   }
178 
179   //
180   // OpenSSL MD4 Hash Finalization
181   //
182   return (BOOLEAN) (MD4_Final (HashValue, (MD4_CTX *) Md4Context));
183 }
184