]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/HttpBootDxe/HttpBootSupport.c
NetworkPkg/DxeHttpLib: Migrate HTTP header manipulation APIs
[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootSupport.c
CommitLineData
d933e70a
JW
1/** @file\r
2 Support functions implementation for UEFI HTTP boot driver.\r
3\r
f75a7f56 4Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
97e2b622 5(C) Copyright 2016 - 2020 Hewlett Packard Enterprise Development LP<BR>\r
ecf98fbc 6SPDX-License-Identifier: BSD-2-Clause-Patent\r
d933e70a
JW
7\r
8**/\r
9\r
10#include "HttpBootDxe.h"\r
11\r
12\r
13/**\r
14 Get the Nic handle using any child handle in the IPv4 stack.\r
15\r
16 @param[in] ControllerHandle Pointer to child handle over IPv4.\r
17\r
18 @return NicHandle The pointer to the Nic handle.\r
19 @return NULL Can't find the Nic handle.\r
20\r
21**/\r
22EFI_HANDLE\r
23HttpBootGetNicByIp4Children (\r
24 IN EFI_HANDLE ControllerHandle\r
25 )\r
26{\r
27 EFI_HANDLE NicHandle;\r
28\r
29 NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiHttpProtocolGuid);\r
30 if (NicHandle == NULL) {\r
31 NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp4ProtocolGuid);\r
32 if (NicHandle == NULL) {\r
33 return NULL;\r
34 }\r
35 }\r
36\r
37 return NicHandle;\r
38}\r
39\r
b659408b
ZL
40/**\r
41 Get the Nic handle using any child handle in the IPv6 stack.\r
42\r
43 @param[in] ControllerHandle Pointer to child handle over IPv6.\r
44\r
45 @return NicHandle The pointer to the Nic handle.\r
46 @return NULL Can't find the Nic handle.\r
47\r
48**/\r
49EFI_HANDLE\r
50HttpBootGetNicByIp6Children (\r
51 IN EFI_HANDLE ControllerHandle\r
52 )\r
53{\r
54 EFI_HANDLE NicHandle;\r
55 NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiHttpProtocolGuid);\r
56 if (NicHandle == NULL) {\r
57 NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp6ProtocolGuid);\r
58 if (NicHandle == NULL) {\r
59 return NULL;\r
60 }\r
61 }\r
62\r
63 return NicHandle;\r
64}\r
d933e70a
JW
65\r
66/**\r
67 This function is to convert UINTN to ASCII string with the required formatting.\r
68\r
69 @param[in] Number Numeric value to be converted.\r
70 @param[in] Buffer The pointer to the buffer for ASCII string.\r
71 @param[in] Length The length of the required format.\r
72\r
73**/\r
74VOID\r
75HttpBootUintnToAscDecWithFormat (\r
76 IN UINTN Number,\r
77 IN UINT8 *Buffer,\r
78 IN INTN Length\r
79 )\r
80{\r
81 UINTN Remainder;\r
82\r
413535bb 83 for (; Length > 0; Length--) {\r
d933e70a
JW
84 Remainder = Number % 10;\r
85 Number /= 10;\r
413535bb 86 Buffer[Length - 1] = (UINT8) ('0' + Remainder);\r
d933e70a
JW
87 }\r
88}\r
89\r
90/**\r
91 This function is to display the IPv4 address.\r
92\r
93 @param[in] Ip The pointer to the IPv4 address.\r
94\r
95**/\r
96VOID\r
97HttpBootShowIp4Addr (\r
98 IN EFI_IPv4_ADDRESS *Ip\r
99 )\r
100{\r
101 UINTN Index;\r
102\r
103 for (Index = 0; Index < 4; Index++) {\r
104 AsciiPrint ("%d", Ip->Addr[Index]);\r
105 if (Index < 3) {\r
106 AsciiPrint (".");\r
107 }\r
108 }\r
109}\r
110\r
b659408b
ZL
111/**\r
112 This function is to display the IPv6 address.\r
113\r
114 @param[in] Ip The pointer to the IPv6 address.\r
115\r
116**/\r
117VOID\r
118HttpBootShowIp6Addr (\r
119 IN EFI_IPv6_ADDRESS *Ip\r
120 )\r
121{\r
122 UINTN Index;\r
123\r
124 for (Index = 0; Index < 16; Index++) {\r
125\r
126 if (Ip->Addr[Index] != 0) {\r
127 AsciiPrint ("%x", Ip->Addr[Index]);\r
128 }\r
129 Index++;\r
130 if (Index > 15) {\r
131 return;\r
132 }\r
133 if (((Ip->Addr[Index] & 0xf0) == 0) && (Ip->Addr[Index - 1] != 0)) {\r
134 AsciiPrint ("0");\r
135 }\r
136 AsciiPrint ("%x", Ip->Addr[Index]);\r
137 if (Index < 15) {\r
138 AsciiPrint (":");\r
139 }\r
140 }\r
141}\r
142\r
62cae351
ZL
143/**\r
144 This function is to display the HTTP error status.\r
145\r
146 @param[in] StatusCode The status code value in HTTP message.\r
147\r
148**/\r
149VOID\r
150HttpBootPrintErrorMessage (\r
151 EFI_HTTP_STATUS_CODE StatusCode\r
152 )\r
153{\r
154 AsciiPrint ("\n");\r
155\r
156 switch (StatusCode) {\r
d58bb59d 157 case HTTP_STATUS_300_MULTIPLE_CHOICES:\r
62cae351 158 AsciiPrint ("\n Redirection: 300 Multiple Choices");\r
f75a7f56
LG
159 break;\r
160\r
62cae351
ZL
161 case HTTP_STATUS_301_MOVED_PERMANENTLY:\r
162 AsciiPrint ("\n Redirection: 301 Moved Permanently");\r
f75a7f56
LG
163 break;\r
164\r
62cae351
ZL
165 case HTTP_STATUS_302_FOUND:\r
166 AsciiPrint ("\n Redirection: 302 Found");\r
f75a7f56
LG
167 break;\r
168\r
62cae351
ZL
169 case HTTP_STATUS_303_SEE_OTHER:\r
170 AsciiPrint ("\n Redirection: 303 See Other");\r
f75a7f56 171 break;\r
62cae351
ZL
172\r
173 case HTTP_STATUS_304_NOT_MODIFIED:\r
174 AsciiPrint ("\n Redirection: 304 Not Modified");\r
f75a7f56 175 break;\r
62cae351
ZL
176\r
177 case HTTP_STATUS_305_USE_PROXY:\r
178 AsciiPrint ("\n Redirection: 305 Use Proxy");\r
f75a7f56 179 break;\r
62cae351
ZL
180\r
181 case HTTP_STATUS_307_TEMPORARY_REDIRECT:\r
182 AsciiPrint ("\n Redirection: 307 Temporary Redirect");\r
406d1d92 183 break;\r
184\r
185 case HTTP_STATUS_308_PERMANENT_REDIRECT:\r
186 AsciiPrint ("\n Redirection: 308 Permanent Redirect");\r
f75a7f56 187 break;\r
62cae351
ZL
188\r
189 case HTTP_STATUS_400_BAD_REQUEST:\r
190 AsciiPrint ("\n Client Error: 400 Bad Request");\r
191 break;\r
f75a7f56 192\r
62cae351
ZL
193 case HTTP_STATUS_401_UNAUTHORIZED:\r
194 AsciiPrint ("\n Client Error: 401 Unauthorized");\r
195 break;\r
f75a7f56 196\r
62cae351
ZL
197 case HTTP_STATUS_402_PAYMENT_REQUIRED:\r
198 AsciiPrint ("\n Client Error: 402 Payment Required");\r
199 break;\r
200\r
201 case HTTP_STATUS_403_FORBIDDEN:\r
202 AsciiPrint ("\n Client Error: 403 Forbidden");\r
203 break;\r
204\r
205 case HTTP_STATUS_404_NOT_FOUND:\r
206 AsciiPrint ("\n Client Error: 404 Not Found");\r
207 break;\r
208\r
209 case HTTP_STATUS_405_METHOD_NOT_ALLOWED:\r
210 AsciiPrint ("\n Client Error: 405 Method Not Allowed");\r
211 break;\r
212\r
213 case HTTP_STATUS_406_NOT_ACCEPTABLE:\r
214 AsciiPrint ("\n Client Error: 406 Not Acceptable");\r
215 break;\r
216\r
217 case HTTP_STATUS_407_PROXY_AUTHENTICATION_REQUIRED:\r
218 AsciiPrint ("\n Client Error: 407 Proxy Authentication Required");\r
219 break;\r
220\r
221 case HTTP_STATUS_408_REQUEST_TIME_OUT:\r
222 AsciiPrint ("\n Client Error: 408 Request Timeout");\r
223 break;\r
224\r
225 case HTTP_STATUS_409_CONFLICT:\r
226 AsciiPrint ("\n Client Error: 409 Conflict");\r
227 break;\r
228\r
229 case HTTP_STATUS_410_GONE:\r
230 AsciiPrint ("\n Client Error: 410 Gone");\r
231 break;\r
232\r
233 case HTTP_STATUS_411_LENGTH_REQUIRED:\r
234 AsciiPrint ("\n Client Error: 411 Length Required");\r
235 break;\r
236\r
237 case HTTP_STATUS_412_PRECONDITION_FAILED:\r
238 AsciiPrint ("\n Client Error: 412 Precondition Failed");\r
239 break;\r
240\r
241 case HTTP_STATUS_413_REQUEST_ENTITY_TOO_LARGE:\r
242 AsciiPrint ("\n Client Error: 413 Request Entity Too Large");\r
243 break;\r
244\r
245 case HTTP_STATUS_414_REQUEST_URI_TOO_LARGE:\r
246 AsciiPrint ("\n Client Error: 414 Request URI Too Long");\r
247 break;\r
248\r
249 case HTTP_STATUS_415_UNSUPPORTED_MEDIA_TYPE:\r
250 AsciiPrint ("\n Client Error: 415 Unsupported Media Type");\r
251 break;\r
252\r
253 case HTTP_STATUS_416_REQUESTED_RANGE_NOT_SATISFIED:\r
254 AsciiPrint ("\n Client Error: 416 Requested Range Not Satisfiable");\r
255 break;\r
256\r
257 case HTTP_STATUS_417_EXPECTATION_FAILED:\r
258 AsciiPrint ("\n Client Error: 417 Expectation Failed");\r
259 break;\r
260\r
261 case HTTP_STATUS_500_INTERNAL_SERVER_ERROR:\r
262 AsciiPrint ("\n Server Error: 500 Internal Server Error");\r
263 break;\r
264\r
265 case HTTP_STATUS_501_NOT_IMPLEMENTED:\r
266 AsciiPrint ("\n Server Error: 501 Not Implemented");\r
267 break;\r
268\r
269 case HTTP_STATUS_502_BAD_GATEWAY:\r
270 AsciiPrint ("\n Server Error: 502 Bad Gateway");\r
271 break;\r
272\r
273 case HTTP_STATUS_503_SERVICE_UNAVAILABLE:\r
274 AsciiPrint ("\n Server Error: 503 Service Unavailable");\r
275 break;\r
276\r
277 case HTTP_STATUS_504_GATEWAY_TIME_OUT:\r
278 AsciiPrint ("\n Server Error: 504 Gateway Timeout");\r
279 break;\r
280\r
281 case HTTP_STATUS_505_HTTP_VERSION_NOT_SUPPORTED:\r
282 AsciiPrint ("\n Server Error: 505 HTTP Version Not Supported");\r
283 break;\r
284\r
285 default: ;\r
f75a7f56 286\r
62cae351
ZL
287 }\r
288}\r
289\r
b659408b
ZL
290/**\r
291 Notify the callback function when an event is triggered.\r
292\r
293 @param[in] Event The triggered event.\r
294 @param[in] Context The opaque parameter to the function.\r
295\r
296**/\r
297VOID\r
298EFIAPI\r
299HttpBootCommonNotify (\r
300 IN EFI_EVENT Event,\r
301 IN VOID *Context\r
302 )\r
303{\r
304 *((BOOLEAN *) Context) = TRUE;\r
305}\r
306\r
307/**\r
308 Retrieve the host address using the EFI_DNS6_PROTOCOL.\r
309\r
310 @param[in] Private The pointer to the driver's private data.\r
311 @param[in] HostName Pointer to buffer containing hostname.\r
312 @param[out] IpAddress On output, pointer to buffer containing IPv6 address.\r
313\r
314 @retval EFI_SUCCESS Operation succeeded.\r
315 @retval EFI_DEVICE_ERROR An unexpected network error occurred.\r
f75a7f56 316 @retval Others Other errors as indicated.\r
b659408b
ZL
317**/\r
318EFI_STATUS\r
319HttpBootDns (\r
320 IN HTTP_BOOT_PRIVATE_DATA *Private,\r
321 IN CHAR16 *HostName,\r
f75a7f56 322 OUT EFI_IPv6_ADDRESS *IpAddress\r
b659408b
ZL
323 )\r
324{\r
325 EFI_STATUS Status;\r
326 EFI_DNS6_PROTOCOL *Dns6;\r
327 EFI_DNS6_CONFIG_DATA Dns6ConfigData;\r
328 EFI_DNS6_COMPLETION_TOKEN Token;\r
329 EFI_HANDLE Dns6Handle;\r
330 EFI_IP6_CONFIG_PROTOCOL *Ip6Config;\r
331 EFI_IPv6_ADDRESS *DnsServerList;\r
332 UINTN DnsServerListCount;\r
333 UINTN DataSize;\r
f75a7f56
LG
334 BOOLEAN IsDone;\r
335\r
b659408b
ZL
336 DnsServerList = NULL;\r
337 DnsServerListCount = 0;\r
338 Dns6 = NULL;\r
339 Dns6Handle = NULL;\r
340 ZeroMem (&Token, sizeof (EFI_DNS6_COMPLETION_TOKEN));\r
f75a7f56 341\r
b659408b
ZL
342 //\r
343 // Get DNS server list from EFI IPv6 Configuration protocol.\r
344 //\r
345 Status = gBS->HandleProtocol (Private->Controller, &gEfiIp6ConfigProtocolGuid, (VOID **) &Ip6Config);\r
346 if (!EFI_ERROR (Status)) {\r
347 //\r
348 // Get the required size.\r
349 //\r
350 DataSize = 0;\r
351 Status = Ip6Config->GetData (Ip6Config, Ip6ConfigDataTypeDnsServer, &DataSize, NULL);\r
352 if (Status == EFI_BUFFER_TOO_SMALL) {\r
353 DnsServerList = AllocatePool (DataSize);\r
354 if (DnsServerList == NULL) {\r
355 return EFI_OUT_OF_RESOURCES;\r
f75a7f56 356 }\r
b659408b
ZL
357\r
358 Status = Ip6Config->GetData (Ip6Config, Ip6ConfigDataTypeDnsServer, &DataSize, DnsServerList);\r
359 if (EFI_ERROR (Status)) {\r
360 FreePool (DnsServerList);\r
361 DnsServerList = NULL;\r
362 } else {\r
363 DnsServerListCount = DataSize / sizeof (EFI_IPv6_ADDRESS);\r
364 }\r
365 }\r
366 }\r
367 //\r
368 // Create a DNSv6 child instance and get the protocol.\r
369 //\r
370 Status = NetLibCreateServiceChild (\r
371 Private->Controller,\r
75372581 372 Private->Ip6Nic->ImageHandle,\r
b659408b
ZL
373 &gEfiDns6ServiceBindingProtocolGuid,\r
374 &Dns6Handle\r
375 );\r
376 if (EFI_ERROR (Status)) {\r
377 goto Exit;\r
f75a7f56
LG
378 }\r
379\r
b659408b
ZL
380 Status = gBS->OpenProtocol (\r
381 Dns6Handle,\r
382 &gEfiDns6ProtocolGuid,\r
383 (VOID **) &Dns6,\r
75372581 384 Private->Ip6Nic->ImageHandle,\r
b659408b
ZL
385 Private->Controller,\r
386 EFI_OPEN_PROTOCOL_BY_DRIVER\r
387 );\r
388 if (EFI_ERROR (Status)) {\r
389 goto Exit;\r
390 }\r
391\r
392 //\r
393 // Configure DNS6 instance for the DNS server address and protocol.\r
394 //\r
395 ZeroMem (&Dns6ConfigData, sizeof (EFI_DNS6_CONFIG_DATA));\r
396 Dns6ConfigData.DnsServerCount = (UINT32)DnsServerListCount;\r
397 Dns6ConfigData.DnsServerList = DnsServerList;\r
398 Dns6ConfigData.EnableDnsCache = TRUE;\r
399 Dns6ConfigData.Protocol = EFI_IP_PROTO_UDP;\r
400 IP6_COPY_ADDRESS (&Dns6ConfigData.StationIp,&Private->StationIp.v6);\r
401 Status = Dns6->Configure (\r
402 Dns6,\r
403 &Dns6ConfigData\r
404 );\r
405 if (EFI_ERROR (Status)) {\r
406 goto Exit;\r
407 }\r
f75a7f56 408\r
b659408b
ZL
409 Token.Status = EFI_NOT_READY;\r
410 IsDone = FALSE;\r
411 //\r
412 // Create event to set the IsDone flag when name resolution is finished.\r
413 //\r
414 Status = gBS->CreateEvent (\r
415 EVT_NOTIFY_SIGNAL,\r
416 TPL_NOTIFY,\r
417 HttpBootCommonNotify,\r
418 &IsDone,\r
419 &Token.Event\r
420 );\r
421 if (EFI_ERROR (Status)) {\r
422 goto Exit;\r
423 }\r
424\r
425 //\r
426 // Start asynchronous name resolution.\r
427 //\r
428 Status = Dns6->HostNameToIp (Dns6, HostName, &Token);\r
429 if (EFI_ERROR (Status)) {\r
430 goto Exit;\r
431 }\r
432\r
433 while (!IsDone) {\r
434 Dns6->Poll (Dns6);\r
435 }\r
f75a7f56 436\r
b659408b
ZL
437 //\r
438 // Name resolution is done, check result.\r
439 //\r
f75a7f56 440 Status = Token.Status;\r
b659408b
ZL
441 if (!EFI_ERROR (Status)) {\r
442 if (Token.RspData.H2AData == NULL) {\r
443 Status = EFI_DEVICE_ERROR;\r
444 goto Exit;\r
445 }\r
446 if (Token.RspData.H2AData->IpCount == 0 || Token.RspData.H2AData->IpList == NULL) {\r
447 Status = EFI_DEVICE_ERROR;\r
448 goto Exit;\r
449 }\r
450 //\r
451 // We just return the first IPv6 address from DNS protocol.\r
452 //\r
453 IP6_COPY_ADDRESS (IpAddress, Token.RspData.H2AData->IpList);\r
454 Status = EFI_SUCCESS;\r
455 }\r
456Exit:\r
457\r
458 if (Token.Event != NULL) {\r
459 gBS->CloseEvent (Token.Event);\r
460 }\r
461 if (Token.RspData.H2AData != NULL) {\r
462 if (Token.RspData.H2AData->IpList != NULL) {\r
463 FreePool (Token.RspData.H2AData->IpList);\r
464 }\r
465 FreePool (Token.RspData.H2AData);\r
466 }\r
467\r
468 if (Dns6 != NULL) {\r
469 Dns6->Configure (Dns6, NULL);\r
f75a7f56 470\r
b659408b
ZL
471 gBS->CloseProtocol (\r
472 Dns6Handle,\r
473 &gEfiDns6ProtocolGuid,\r
75372581 474 Private->Ip6Nic->ImageHandle,\r
b659408b
ZL
475 Private->Controller\r
476 );\r
477 }\r
478\r
479 if (Dns6Handle != NULL) {\r
480 NetLibDestroyServiceChild (\r
481 Private->Controller,\r
75372581 482 Private->Ip6Nic->ImageHandle,\r
b659408b
ZL
483 &gEfiDns6ServiceBindingProtocolGuid,\r
484 Dns6Handle\r
485 );\r
486 }\r
487\r
488 if (DnsServerList != NULL) {\r
489 FreePool (DnsServerList);\r
490 }\r
f75a7f56
LG
491\r
492 return Status;\r
b659408b 493}\r
d933e70a 494\r
221463c2
JW
495/**\r
496 This function checks the HTTP(S) URI scheme.\r
497\r
498 @param[in] Uri The pointer to the URI string.\r
f75a7f56 499\r
221463c2
JW
500 @retval EFI_SUCCESS The URI scheme is valid.\r
501 @retval EFI_INVALID_PARAMETER The URI scheme is not HTTP or HTTPS.\r
502 @retval EFI_ACCESS_DENIED HTTP is disabled and the URI is HTTP.\r
503\r
504**/\r
505EFI_STATUS\r
506HttpBootCheckUriScheme (\r
507 IN CHAR8 *Uri\r
508 )\r
509{\r
510 UINTN Index;\r
511 EFI_STATUS Status;\r
512\r
513 Status = EFI_SUCCESS;\r
514\r
515 //\r
516 // Convert the scheme to all lower case.\r
517 //\r
518 for (Index = 0; Index < AsciiStrLen (Uri); Index++) {\r
519 if (Uri[Index] == ':') {\r
520 break;\r
521 }\r
522 if (Uri[Index] >= 'A' && Uri[Index] <= 'Z') {\r
523 Uri[Index] -= (CHAR8)('A' - 'a');\r
524 }\r
525 }\r
526\r
527 //\r
528 // Return EFI_INVALID_PARAMETER if the URI is not HTTP or HTTPS.\r
529 //\r
530 if ((AsciiStrnCmp (Uri, "http://", 7) != 0) && (AsciiStrnCmp (Uri, "https://", 8) != 0)) {\r
531 DEBUG ((EFI_D_ERROR, "HttpBootCheckUriScheme: Invalid Uri.\n"));\r
532 return EFI_INVALID_PARAMETER;\r
533 }\r
f75a7f56 534\r
221463c2
JW
535 //\r
536 // HTTP is disabled, return EFI_ACCESS_DENIED if the URI is HTTP.\r
537 //\r
538 if (!PcdGetBool (PcdAllowHttpConnections) && (AsciiStrnCmp (Uri, "http://", 7) == 0)) {\r
539 DEBUG ((EFI_D_ERROR, "HttpBootCheckUriScheme: HTTP is disabled.\n"));\r
540 return EFI_ACCESS_DENIED;\r
541 }\r
542\r
543 return Status;\r
544}\r
545\r
fa848a40
FS
546/**\r
547 Get the URI address string from the input device path.\r
548\r
549 Caller need to free the buffer in the UriAddress pointer.\r
f75a7f56 550\r
fa848a40 551 @param[in] FilePath Pointer to the device path which contains a URI device path node.\r
73617fa6 552 @param[out] UriAddress The URI address string extract from the device path.\r
f75a7f56 553\r
fa848a40
FS
554 @retval EFI_SUCCESS The URI string is returned.\r
555 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
556\r
557**/\r
558EFI_STATUS\r
559HttpBootParseFilePath (\r
560 IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
561 OUT CHAR8 **UriAddress\r
562 )\r
563{\r
564 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
565 URI_DEVICE_PATH *UriDevicePath;\r
566 CHAR8 *Uri;\r
567 UINTN UriStrLength;\r
568\r
569 if (FilePath == NULL) {\r
570 return EFI_INVALID_PARAMETER;\r
571 }\r
572\r
573 *UriAddress = NULL;\r
574\r
575 //\r
576 // Extract the URI address from the FilePath\r
577 //\r
578 TempDevicePath = FilePath;\r
579 while (!IsDevicePathEnd (TempDevicePath)) {\r
580 if ((DevicePathType (TempDevicePath) == MESSAGING_DEVICE_PATH) &&\r
581 (DevicePathSubType (TempDevicePath) == MSG_URI_DP)) {\r
582 UriDevicePath = (URI_DEVICE_PATH*) TempDevicePath;\r
583 //\r
584 // UEFI Spec doesn't require the URI to be a NULL-terminated string\r
585 // So we allocate a new buffer and always append a '\0' to it.\r
586 //\r
587 UriStrLength = DevicePathNodeLength (UriDevicePath) - sizeof(EFI_DEVICE_PATH_PROTOCOL);\r
588 if (UriStrLength == 0) {\r
589 //\r
590 // return a NULL UriAddress if it's a empty URI device path node.\r
591 //\r
592 break;\r
593 }\r
594 Uri = AllocatePool (UriStrLength + 1);\r
595 if (Uri == NULL) {\r
596 return EFI_OUT_OF_RESOURCES;\r
597 }\r
598 CopyMem (Uri, UriDevicePath->Uri, DevicePathNodeLength (UriDevicePath) - sizeof(EFI_DEVICE_PATH_PROTOCOL));\r
599 Uri[DevicePathNodeLength (UriDevicePath) - sizeof(EFI_DEVICE_PATH_PROTOCOL)] = '\0';\r
600\r
601 *UriAddress = Uri;\r
602 }\r
603 TempDevicePath = NextDevicePathNode (TempDevicePath);\r
604 }\r
605\r
606 return EFI_SUCCESS;\r
607}\r
587d204c
FS
608\r
609/**\r
610 This function returns the image type according to server replied HTTP message\r
611 and also the image's URI info.\r
612\r
613 @param[in] Uri The pointer to the image's URI string.\r
f75a7f56
LG
614 @param[in] UriParser URI Parse result returned by NetHttpParseUrl().\r
615 @param[in] HeaderCount Number of HTTP header structures in Headers list.\r
587d204c
FS
616 @param[in] Headers Array containing list of HTTP headers.\r
617 @param[out] ImageType The image type of the downloaded file.\r
f75a7f56 618\r
587d204c
FS
619 @retval EFI_SUCCESS The image type is returned in ImageType.\r
620 @retval EFI_INVALID_PARAMETER ImageType, Uri or UriParser is NULL.\r
621 @retval EFI_INVALID_PARAMETER HeaderCount is not zero, and Headers is NULL.\r
622 @retval EFI_NOT_FOUND Failed to identify the image type.\r
c36b7b51 623 @retval Others Unexpected error happened.\r
587d204c
FS
624\r
625**/\r
626EFI_STATUS\r
627HttpBootCheckImageType (\r
628 IN CHAR8 *Uri,\r
629 IN VOID *UriParser,\r
630 IN UINTN HeaderCount,\r
631 IN EFI_HTTP_HEADER *Headers,\r
632 OUT HTTP_BOOT_IMAGE_TYPE *ImageType\r
633 )\r
634{\r
635 EFI_STATUS Status;\r
636 EFI_HTTP_HEADER *Header;\r
637 CHAR8 *FilePath;\r
638 CHAR8 *FilePost;\r
639\r
640 if (Uri == NULL || UriParser == NULL || ImageType == NULL) {\r
641 return EFI_INVALID_PARAMETER;\r
642 }\r
643\r
644 if (HeaderCount != 0 && Headers == NULL) {\r
645 return EFI_INVALID_PARAMETER;\r
646 }\r
647\r
648 //\r
649 // Determine the image type by the HTTP Content-Type header field first.\r
b173ad78
JW
650 // "application/efi" -> EFI Image\r
651 // "application/vnd.efi-iso" -> CD/DVD Image\r
652 // "application/vnd.efi-img" -> Virtual Disk Image\r
587d204c
FS
653 //\r
654 Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_CONTENT_TYPE);\r
655 if (Header != NULL) {\r
656 if (AsciiStriCmp (Header->FieldValue, HTTP_CONTENT_TYPE_APP_EFI) == 0) {\r
657 *ImageType = ImageTypeEfi;\r
658 return EFI_SUCCESS;\r
b173ad78
JW
659 } else if (AsciiStriCmp (Header->FieldValue, HTTP_CONTENT_TYPE_APP_ISO) == 0) {\r
660 *ImageType = ImageTypeVirtualCd;\r
661 return EFI_SUCCESS;\r
662 } else if (AsciiStriCmp (Header->FieldValue, HTTP_CONTENT_TYPE_APP_IMG) == 0) {\r
663 *ImageType = ImageTypeVirtualDisk;\r
664 return EFI_SUCCESS;\r
587d204c
FS
665 }\r
666 }\r
667\r
668 //\r
669 // Determine the image type by file extension:\r
670 // *.efi -> EFI Image\r
671 // *.iso -> CD/DVD Image\r
672 // *.img -> Virtual Disk Image\r
673 //\r
674 Status = HttpUrlGetPath (\r
675 Uri,\r
676 UriParser,\r
677 &FilePath\r
678 );\r
679 if (EFI_ERROR (Status)) {\r
680 return Status;\r
681 }\r
682\r
683 FilePost = FilePath + AsciiStrLen (FilePath) - 4;\r
684 if (AsciiStrCmp (FilePost, ".efi") == 0) {\r
685 *ImageType = ImageTypeEfi;\r
686 } else if (AsciiStrCmp (FilePost, ".iso") == 0) {\r
687 *ImageType = ImageTypeVirtualCd;\r
688 } else if (AsciiStrCmp (FilePost, ".img") == 0) {\r
689 *ImageType = ImageTypeVirtualDisk;\r
690 } else {\r
691 *ImageType = ImageTypeMax;\r
692 }\r
693\r
694 FreePool (FilePath);\r
695\r
696 return (*ImageType < ImageTypeMax) ? EFI_SUCCESS : EFI_NOT_FOUND;\r
697}\r
698\r
699/**\r
700 This function register the RAM disk info to the system.\r
f75a7f56 701\r
587d204c
FS
702 @param[in] Private The pointer to the driver's private data.\r
703 @param[in] BufferSize The size of Buffer in bytes.\r
704 @param[in] Buffer The base address of the RAM disk.\r
705 @param[in] ImageType The image type of the file in Buffer.\r
706\r
707 @retval EFI_SUCCESS The RAM disk has been registered.\r
708 @retval EFI_NOT_FOUND No RAM disk protocol instances were found.\r
709 @retval EFI_UNSUPPORTED The ImageType is not supported.\r
710 @retval Others Unexpected error happened.\r
711\r
712**/\r
713EFI_STATUS\r
714HttpBootRegisterRamDisk (\r
715 IN HTTP_BOOT_PRIVATE_DATA *Private,\r
716 IN UINTN BufferSize,\r
717 IN VOID *Buffer,\r
718 IN HTTP_BOOT_IMAGE_TYPE ImageType\r
719 )\r
720{\r
721 EFI_RAM_DISK_PROTOCOL *RamDisk;\r
722 EFI_STATUS Status;\r
723 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
724 EFI_GUID *RamDiskType;\r
f75a7f56 725\r
587d204c
FS
726 ASSERT (Private != NULL);\r
727 ASSERT (Buffer != NULL);\r
728 ASSERT (BufferSize != 0);\r
729\r
730 Status = gBS->LocateProtocol (&gEfiRamDiskProtocolGuid, NULL, (VOID**) &RamDisk);\r
731 if (EFI_ERROR (Status)) {\r
732 DEBUG ((EFI_D_ERROR, "HTTP Boot: Couldn't find the RAM Disk protocol - %r\n", Status));\r
733 return Status;\r
734 }\r
735\r
736 if (ImageType == ImageTypeVirtualCd) {\r
737 RamDiskType = &gEfiVirtualCdGuid;\r
738 } else if (ImageType == ImageTypeVirtualDisk) {\r
739 RamDiskType = &gEfiVirtualDiskGuid;\r
740 } else {\r
741 return EFI_UNSUPPORTED;\r
742 }\r
f75a7f56 743\r
587d204c
FS
744 Status = RamDisk->Register (\r
745 (UINTN)Buffer,\r
746 (UINT64)BufferSize,\r
747 RamDiskType,\r
748 Private->UsingIpv6 ? Private->Ip6Nic->DevicePath : Private->Ip4Nic->DevicePath,\r
749 &DevicePath\r
750 );\r
751 if (EFI_ERROR (Status)) {\r
752 DEBUG ((EFI_D_ERROR, "HTTP Boot: Failed to register RAM Disk - %r\n", Status));\r
753 }\r
754\r
755 return Status;\r
756}\r
757\r
bb4831c0
FS
758/**\r
759 Indicate if the HTTP status code indicates a redirection.\r
f75a7f56 760\r
bb4831c0
FS
761 @param[in] StatusCode HTTP status code from server.\r
762\r
763 @return TRUE if it's redirection.\r
764\r
765**/\r
766BOOLEAN\r
767HttpBootIsHttpRedirectStatusCode (\r
768 IN EFI_HTTP_STATUS_CODE StatusCode\r
2913ebb2 769 )\r
bb4831c0
FS
770{\r
771 if (StatusCode == HTTP_STATUS_301_MOVED_PERMANENTLY ||\r
772 StatusCode == HTTP_STATUS_302_FOUND ||\r
773 StatusCode == HTTP_STATUS_307_TEMPORARY_REDIRECT ||\r
774 StatusCode == HTTP_STATUS_308_PERMANENT_REDIRECT) {\r
775 return TRUE;\r
776 }\r
777\r
778 return FALSE;\r
779}\r