]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/HttpUtilitiesDxe/HttpUtilitiesProtocol.c
NetworkPkg: Fix suspicious dereference of pointer 'FieldCount'
[mirror_edk2.git] / NetworkPkg / HttpUtilitiesDxe / HttpUtilitiesProtocol.c
CommitLineData
d933e70a
JW
1/** @file\r
2 Implementation of EFI_HTTP_PROTOCOL protocol interfaces.\r
3\r
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "HttpUtilitiesDxe.h"\r
16\r
17EFI_HTTP_UTILITIES_PROTOCOL mHttpUtilitiesProtocol = {\r
18 HttpUtilitiesBuild,\r
19 HttpUtilitiesParse\r
20};\r
21\r
22\r
23/**\r
24 Create HTTP header based on a combination of seed header, fields\r
25 to delete, and fields to append.\r
26\r
27 The Build() function is used to manage the headers portion of an\r
28 HTTP message by providing the ability to add, remove, or replace\r
29 HTTP headers.\r
30\r
31 @param[in] This Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.\r
32 @param[in] SeedMessageSize Size of the initial HTTP header. This can be zero.\r
33 @param[in] SeedMessage Initial HTTP header to be used as a base for\r
34 building a new HTTP header. If NULL,\r
35 SeedMessageSize is ignored.\r
36 @param[in] DeleteCount Number of null-terminated HTTP header field names\r
37 in DeleteList.\r
38 @param[in] DeleteList List of null-terminated HTTP header field names to\r
39 remove from SeedMessage. Only the field names are\r
40 in this list because the field values are irrelevant\r
41 to this operation.\r
42 @param[in] AppendCount Number of header fields in AppendList.\r
43 @param[in] AppendList List of HTTP headers to populate NewMessage with.\r
44 If SeedMessage is not NULL, AppendList will be\r
45 appended to the existing list from SeedMessage in\r
46 NewMessage.\r
47 @param[out] NewMessageSize Pointer to number of header fields in NewMessage.\r
48 @param[out] NewMessage Pointer to a new list of HTTP headers based on.\r
49\r
50 @retval EFI_SUCCESS Add, remove, and replace operations succeeded.\r
51 @retval EFI_OUT_OF_RESOURCES Could not allocate memory for NewMessage.\r
52 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
53 This is NULL.\r
54**/\r
55EFI_STATUS\r
56EFIAPI\r
57HttpUtilitiesBuild (\r
58 IN EFI_HTTP_UTILITIES_PROTOCOL *This,\r
59 IN UINTN SeedMessageSize,\r
60 IN VOID *SeedMessage, OPTIONAL\r
61 IN UINTN DeleteCount,\r
62 IN CHAR8 *DeleteList[], OPTIONAL\r
63 IN UINTN AppendCount,\r
64 IN EFI_HTTP_HEADER *AppendList[], OPTIONAL\r
65 OUT UINTN *NewMessageSize,\r
66 OUT VOID **NewMessage\r
67 )\r
68{\r
69 EFI_STATUS Status;\r
70 EFI_HTTP_HEADER *SeedHeaderFields;\r
71 UINTN SeedFieldCount;\r
72 UINTN Index;\r
73 EFI_HTTP_HEADER *TempHeaderFields;\r
74 UINTN TempFieldCount;\r
75 EFI_HTTP_HEADER *NewHeaderFields;\r
76 UINTN NewFieldCount;\r
77 EFI_HTTP_HEADER *HttpHeader;\r
78 UINTN StrLength;\r
79 UINT8 *NewMessagePtr;\r
80\r
81 SeedHeaderFields = NULL;\r
82 SeedFieldCount = 0;\r
83 TempHeaderFields = NULL;\r
84 TempFieldCount = 0;\r
85 NewHeaderFields = NULL;\r
86 NewFieldCount = 0;\r
87\r
88 HttpHeader = NULL;\r
89 StrLength = 0;\r
90 NewMessagePtr = NULL;\r
91 *NewMessageSize = 0;\r
92 Status = EFI_SUCCESS;\r
93 \r
94 if (This == NULL) {\r
95 return EFI_INVALID_PARAMETER;\r
96 }\r
97\r
98 if (SeedMessage != NULL) {\r
99 Status = This->Parse (\r
100 This, \r
101 SeedMessage, \r
102 SeedMessageSize, \r
103 &SeedHeaderFields, \r
104 &SeedFieldCount\r
105 );\r
106 if (EFI_ERROR (Status)) {\r
107 goto ON_EXIT;\r
108 }\r
109 }\r
110\r
111 //\r
112 // Handle DeleteList\r
113 //\r
114 if (SeedFieldCount != 0 && DeleteCount != 0) {\r
115 TempHeaderFields = AllocateZeroPool (SeedFieldCount * sizeof(EFI_HTTP_HEADER));\r
116 if (TempHeaderFields == NULL) {\r
117 Status = EFI_OUT_OF_RESOURCES;\r
118 goto ON_EXIT;\r
119 }\r
120 \r
121 for (Index = 0, TempFieldCount = 0; Index < SeedFieldCount; Index++) {\r
122 //\r
123 // Check whether each SeedHeaderFields member is in DeleteList\r
124 //\r
125 if (IsValidHttpHeader( DeleteList, DeleteCount, SeedHeaderFields[Index].FieldName)) {\r
126 Status = SetFieldNameAndValue (\r
127 &TempHeaderFields[TempFieldCount], \r
128 SeedHeaderFields[Index].FieldName, \r
129 SeedHeaderFields[Index].FieldValue\r
130 );\r
131 if (EFI_ERROR (Status)) {\r
132 goto ON_EXIT;\r
133 }\r
134 TempFieldCount++;\r
135 }\r
136 }\r
137 } else {\r
138 TempHeaderFields = SeedHeaderFields;\r
139 TempFieldCount = SeedFieldCount;\r
140 }\r
141\r
142 //\r
143 // Handle AppendList\r
144 //\r
145 NewHeaderFields = AllocateZeroPool ((TempFieldCount + AppendCount) * sizeof (EFI_HTTP_HEADER));\r
146 if (NewHeaderFields == NULL) {\r
147 Status = EFI_OUT_OF_RESOURCES;\r
148 goto ON_EXIT;\r
149 }\r
150\r
151 for (Index = 0; Index < TempFieldCount; Index++) {\r
152 Status = SetFieldNameAndValue (\r
153 &NewHeaderFields[Index], \r
154 TempHeaderFields[Index].FieldName, \r
155 TempHeaderFields[Index].FieldValue\r
156 );\r
157 if (EFI_ERROR (Status)) {\r
158 goto ON_EXIT;\r
159 }\r
160 }\r
161 \r
162 NewFieldCount = TempFieldCount;\r
163\r
164 for (Index = 0; Index < AppendCount; Index++) {\r
165 HttpHeader = FindHttpHeader (NewHeaderFields, NewFieldCount, AppendList[Index]->FieldName);\r
166 if (HttpHeader != NULL) {\r
167 Status = SetFieldNameAndValue (\r
168 HttpHeader, \r
169 AppendList[Index]->FieldName, \r
170 AppendList[Index]->FieldValue\r
171 );\r
172 if (EFI_ERROR (Status)) {\r
173 goto ON_EXIT;\r
174 }\r
175 } else {\r
176 Status = SetFieldNameAndValue (\r
177 &NewHeaderFields[NewFieldCount], \r
178 AppendList[Index]->FieldName, \r
179 AppendList[Index]->FieldValue\r
180 );\r
181 if (EFI_ERROR (Status)) {\r
182 goto ON_EXIT;\r
183 }\r
184 NewFieldCount++;\r
185 }\r
186 }\r
187\r
188 //\r
189 // Calculate NewMessageSize, then build NewMessage\r
190 //\r
191 for (Index = 0; Index < NewFieldCount; Index++) {\r
192 HttpHeader = &NewHeaderFields[Index];\r
193\r
194 StrLength = AsciiStrLen (HttpHeader->FieldName);\r
195 *NewMessageSize += StrLength;\r
196\r
197 StrLength = sizeof(": ") - 1;\r
198 *NewMessageSize += StrLength;\r
199\r
200 StrLength = AsciiStrLen (HttpHeader->FieldValue);\r
201 *NewMessageSize += StrLength;\r
202\r
203 StrLength = sizeof("\r\n") - 1;\r
204 *NewMessageSize += StrLength;\r
205 }\r
206 StrLength = sizeof("\r\n") - 1;\r
207 *NewMessageSize += StrLength;\r
208\r
209 //\r
210 // Final 0 for end flag\r
211 //\r
212 *NewMessageSize += 1; \r
213\r
214 *NewMessage = AllocateZeroPool (*NewMessageSize);\r
215 if (*NewMessage == NULL) {\r
216 Status = EFI_OUT_OF_RESOURCES;\r
217 goto ON_EXIT;\r
218 }\r
219\r
220 NewMessagePtr = (UINT8 *)(*NewMessage);\r
221\r
222 for (Index = 0; Index < NewFieldCount; Index++) {\r
223 HttpHeader = &NewHeaderFields[Index];\r
224\r
225 StrLength = AsciiStrLen (HttpHeader->FieldName);\r
226 CopyMem (NewMessagePtr, HttpHeader->FieldName, StrLength);\r
227 NewMessagePtr += StrLength;\r
228\r
229 StrLength = sizeof(": ") - 1;\r
230 CopyMem (NewMessagePtr, ": ", StrLength);\r
231 NewMessagePtr += StrLength;\r
232\r
233 StrLength = AsciiStrLen (HttpHeader->FieldValue);\r
234 CopyMem (NewMessagePtr, HttpHeader->FieldValue, StrLength);\r
235 NewMessagePtr += StrLength;\r
236\r
237 StrLength = sizeof("\r\n") - 1;\r
238 CopyMem (NewMessagePtr, "\r\n", StrLength);\r
239 NewMessagePtr += StrLength;\r
240 }\r
241 StrLength = sizeof("\r\n") - 1;\r
242 CopyMem (NewMessagePtr, "\r\n", StrLength);\r
243 NewMessagePtr += StrLength;\r
244\r
245 *NewMessagePtr = 0;\r
246\r
247 ASSERT (*NewMessageSize == (UINTN)NewMessagePtr - (UINTN)(*NewMessage) + 1);\r
248\r
249 //\r
250 // Free allocated buffer \r
251 //\r
252ON_EXIT:\r
253 if (SeedHeaderFields != NULL) {\r
254 FreeHeaderFields(SeedHeaderFields, SeedFieldCount);\r
255 }\r
256 \r
257 if (TempHeaderFields != NULL) {\r
258 FreeHeaderFields(TempHeaderFields, TempFieldCount);\r
259 }\r
260\r
261 if (NewHeaderFields != NULL) {\r
262 FreeHeaderFields(NewHeaderFields, NewFieldCount);\r
263 }\r
264 \r
265 return Status;\r
266}\r
267\r
268\r
269/**\r
270 Parses HTTP header and produces an array of key/value pairs.\r
271\r
272 The Parse() function is used to transform data stored in HttpHeader\r
273 into a list of fields paired with their corresponding values.\r
274\r
275 @param[in] This Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.\r
276 @param[in] HttpMessage Contains raw unformatted HTTP header string.\r
277 @param[in] HttpMessageSize Size of HTTP header.\r
278 @param[out] HeaderFields Array of key/value header pairs.\r
279 @param[out] FieldCount Number of headers in HeaderFields.\r
280\r
281 @retval EFI_SUCCESS Allocation succeeded.\r
282 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been\r
283 initialized.\r
284 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
285 This is NULL.\r
286 HttpMessage is NULL.\r
287 HeaderFields is NULL.\r
288 FieldCount is NULL.\r
289**/\r
290EFI_STATUS\r
291EFIAPI\r
292HttpUtilitiesParse (\r
293 IN EFI_HTTP_UTILITIES_PROTOCOL *This,\r
294 IN CHAR8 *HttpMessage,\r
295 IN UINTN HttpMessageSize,\r
296 OUT EFI_HTTP_HEADER **HeaderFields,\r
297 OUT UINTN *FieldCount\r
298 )\r
299{\r
300 EFI_STATUS Status;\r
301 CHAR8 *TempHttpMessage;\r
302 CHAR8 *Token;\r
303 CHAR8 *NextToken;\r
304 CHAR8 *FieldName;\r
305 CHAR8 *FieldValue;\r
306 UINTN Index;\r
307 \r
308 Status = EFI_SUCCESS;\r
309 TempHttpMessage = NULL;\r
d933e70a
JW
310 Token = NULL;\r
311 NextToken = NULL;\r
312 FieldName = NULL;\r
313 FieldValue = NULL;\r
314 Index = 0;\r
315 \r
316 if (This == NULL || HttpMessage == NULL || HeaderFields == NULL || FieldCount == NULL) {\r
317 return EFI_INVALID_PARAMETER;\r
318 }\r
319 \r
320 TempHttpMessage = AllocateZeroPool (HttpMessageSize);\r
321 if (TempHttpMessage == NULL) {\r
322 return EFI_OUT_OF_RESOURCES;\r
323 }\r
324\r
325 CopyMem (TempHttpMessage, HttpMessage, HttpMessageSize);\r
326 \r
327 //\r
328 // Get header number\r
329 //\r
2ba88dc5 330 *FieldCount = 0;\r
d933e70a
JW
331 Token = TempHttpMessage;\r
332 while (TRUE) {\r
333 FieldName = NULL;\r
334 FieldValue = NULL;\r
335 NextToken = GetFieldNameAndValue (Token, &FieldName, &FieldValue);\r
336 Token = NextToken;\r
337 if (FieldName == NULL || FieldValue == NULL) {\r
338 break;\r
339 }\r
340\r
341 (*FieldCount)++;\r
342 }\r
343\r
344 if (*FieldCount == 0) {\r
345 Status = EFI_INVALID_PARAMETER;\r
346 goto ON_EXIT;\r
347 }\r
348 \r
349 //\r
350 // Allocate buffer for header\r
351 //\r
352 *HeaderFields = AllocateZeroPool ((*FieldCount) * sizeof(EFI_HTTP_HEADER));\r
353 if (*HeaderFields == NULL) {\r
354 *FieldCount = 0;\r
355 Status = EFI_OUT_OF_RESOURCES;\r
356 goto ON_EXIT;\r
357 }\r
358 \r
359 CopyMem (TempHttpMessage, HttpMessage, HttpMessageSize);\r
360 \r
361 //\r
362 // Set Field and Value to each header\r
363 //\r
364 Token = TempHttpMessage;\r
365 while (Index < *FieldCount) {\r
366 FieldName = NULL;\r
367 FieldValue = NULL;\r
368 NextToken = GetFieldNameAndValue (Token, &FieldName, &FieldValue);\r
369 Token = NextToken;\r
370 if (FieldName == NULL || FieldValue == NULL) {\r
371 break;\r
372 }\r
373\r
374 Status = SetFieldNameAndValue (&(*HeaderFields)[Index], FieldName, FieldValue);\r
375 if (EFI_ERROR (Status)) {\r
376 *FieldCount = 0;\r
377 FreeHeaderFields (*HeaderFields, Index);\r
378 goto ON_EXIT;\r
379 }\r
380 \r
381 Index++;\r
382 }\r
383\r
384 //\r
385 // Free allocated buffer \r
386 //\r
387ON_EXIT:\r
388 if (TempHttpMessage != NULL) {\r
389 FreePool (TempHttpMessage);\r
390 }\r
391 \r
392 return Status;\r
aa498f8c 393}