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