/** @file\r
Functions implementation related with DHCPv4 for HTTP boot driver.\r
\r
-Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
-The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
@param[in] Dst Pointer to the cache buffer for DHCPv4 packet.\r
@param[in] Src Pointer to the DHCPv4 packet to be cached.\r
\r
+ @retval EFI_SUCCESS Packet is copied.\r
+ @retval EFI_BUFFER_TOO_SMALL Cache buffer is not big enough to hold the packet.\r
+\r
**/\r
-VOID\r
+EFI_STATUS\r
HttpBootCacheDhcp4Packet (\r
IN EFI_DHCP4_PACKET *Dst,\r
IN EFI_DHCP4_PACKET *Src\r
)\r
{\r
- ASSERT (Dst->Size >= Src->Length);\r
+ if (Dst->Size < Src->Length) {\r
+ return EFI_BUFFER_TOO_SMALL;\r
+ }\r
\r
CopyMem (&Dst->Dhcp4, &Src->Dhcp4, Src->Length);\r
Dst->Length = Src->Length;\r
+\r
+ return EFI_SUCCESS;\r
}\r
\r
/**\r
HTTP_BOOT_OFFER_TYPE OfferType;\r
EFI_IPv4_ADDRESS IpAddr;\r
BOOLEAN FileFieldOverloaded;\r
- \r
+\r
IsDnsOffer = FALSE;\r
IpExpressedUri = FALSE;\r
IsProxyOffer = FALSE;\r
);\r
}\r
//\r
- // Second, Check if bootfilename and serverhostname is overloaded to carry DHCP options refers to rfc-2132. \r
+ // Second, Check if bootfilename and serverhostname is overloaded to carry DHCP options refers to rfc-2132.\r
// If yes, try to parse options from the BootFileName field, then ServerName field.\r
//\r
Option = Options[HTTP_BOOT_DHCP4_TAG_INDEX_OVERLOAD];\r
// The offer with "HTTPClient" is a Http offer.\r
//\r
Option = Options[HTTP_BOOT_DHCP4_TAG_INDEX_CLASS_ID];\r
- if ((Option != NULL) && (Option->Length >= 9) &&\r
- (CompareMem (Option->Data, DEFAULT_CLASS_ID_DATA, 9) == 0)) {\r
+ if ((Option != NULL) && (Option->Length >= 10) &&\r
+ (CompareMem (Option->Data, DEFAULT_CLASS_ID_DATA, 10) == 0)) {\r
IsHttpOffer = TRUE;\r
}\r
\r
}\r
\r
//\r
- // Try to retrieve the IP of HTTP server from URI. \r
+ // Try to retrieve the IP of HTTP server from URI.\r
//\r
if (IsHttpOffer) {\r
Status = HttpParseUrl (\r
if (!IsProxyOffer) {\r
OfferType = IsDnsOffer ? HttpOfferTypeDhcpDns : HttpOfferTypeDhcpOnly;\r
} else {\r
+ if (Cache4->UriParser != NULL) {\r
+ FreePool (Cache4->UriParser);\r
+ }\r
return EFI_DEVICE_ERROR;\r
}\r
}\r
- \r
+\r
Cache4->OfferType = OfferType;\r
return EFI_SUCCESS;\r
}\r
@param[in] Private Pointer to HTTP boot driver private data.\r
@param[in] RcvdOffer Pointer to the received offer packet.\r
\r
+ @retval EFI_SUCCESS Cache and parse the packet successfully.\r
+ @retval Others Operation failed.\r
**/\r
-VOID\r
+EFI_STATUS\r
HttpBootCacheDhcp4Offer (\r
IN HTTP_BOOT_PRIVATE_DATA *Private,\r
IN EFI_DHCP4_PACKET *RcvdOffer\r
HTTP_BOOT_DHCP4_PACKET_CACHE *Cache4;\r
EFI_DHCP4_PACKET *Offer;\r
HTTP_BOOT_OFFER_TYPE OfferType;\r
+ EFI_STATUS Status;\r
\r
ASSERT (Private->OfferNum < HTTP_BOOT_OFFER_MAX_NUM);\r
Cache4 = &Private->OfferBuffer[Private->OfferNum].Dhcp4;\r
//\r
// Cache the content of DHCPv4 packet firstly.\r
//\r
- HttpBootCacheDhcp4Packet (Offer, RcvdOffer);\r
+ Status = HttpBootCacheDhcp4Packet (Offer, RcvdOffer);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
//\r
// Validate the DHCPv4 packet, and parse the options and offer type.\r
//\r
if (EFI_ERROR (HttpBootParseDhcp4Packet (Cache4))) {\r
- return;\r
+ return EFI_ABORTED;\r
}\r
\r
//\r
Private->OfferIndex[OfferType][Private->OfferCount[OfferType]] = Private->OfferNum;\r
Private->OfferCount[OfferType]++;\r
Private->OfferNum++;\r
+\r
+ return EFI_SUCCESS;\r
}\r
\r
/**\r
// The offer with DNS server address takes priority here.\r
//\r
if (Private->OfferCount[HttpOfferTypeDhcpDns] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpDns][0] + 1;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpIpUriDns] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpIpUriDns][0] + 1;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpNameUriDns] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpNameUriDns][0] + 1;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpOnly] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpOnly][0] + 1;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpIpUri] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpIpUri][0] + 1;\r
}\r
- \r
+\r
} else {\r
//\r
// We are in corporate environment.\r
//\r
// Priority1: HttpOfferTypeDhcpIpUri or HttpOfferTypeDhcpIpUriDns\r
- // Priority2: HttpOfferTypeDhcpNameUriDns \r
- // Priority3: HttpOfferTypeDhcpOnly + HttpOfferTypeProxyIpUri \r
- // Priority4: HttpOfferTypeDhcpDns + HttpOfferTypeProxyIpUri \r
+ // Priority2: HttpOfferTypeDhcpNameUriDns\r
+ // Priority3: HttpOfferTypeDhcpOnly + HttpOfferTypeProxyIpUri\r
+ // Priority4: HttpOfferTypeDhcpDns + HttpOfferTypeProxyIpUri\r
// Priority5: HttpOfferTypeDhcpDns + HttpOfferTypeProxyNameUri\r
- // Priority6: HttpOfferTypeDhcpDns + HttpOfferTypeDhcpNameUri \r
- // \r
+ // Priority6: HttpOfferTypeDhcpDns + HttpOfferTypeDhcpNameUri\r
+ //\r
if (Private->OfferCount[HttpOfferTypeDhcpIpUri] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpIpUri][0] + 1;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpIpUriDns] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpIpUriDns][0] + 1;\r
- \r
+\r
}else if (Private->OfferCount[HttpOfferTypeDhcpNameUriDns] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpNameUriDns][0] + 1;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpOnly] > 0 &&\r
Private->OfferCount[HttpOfferTypeProxyIpUri] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpOnly][0] + 1;\r
Private->SelectProxyType = HttpOfferTypeProxyIpUri;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpDns] > 0 &&\r
Private->OfferCount[HttpOfferTypeProxyIpUri] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpDns][0] + 1;\r
Private->SelectProxyType = HttpOfferTypeProxyIpUri;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpDns] > 0 &&\r
Private->OfferCount[HttpOfferTypeProxyNameUri] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpDns][0] + 1;\r
Private->SelectProxyType = HttpOfferTypeProxyNameUri;\r
- \r
+\r
} else if (Private->OfferCount[HttpOfferTypeDhcpDns] > 0 &&\r
Private->OfferCount[HttpOfferTypeDhcpNameUri] > 0) {\r
- \r
+\r
Private->SelectIndex = Private->OfferIndex[HttpOfferTypeDhcpDns][0] + 1;\r
Private->SelectProxyType = HttpOfferTypeDhcpNameUri;\r
}\r
EFI_DHCP4_PACKET_OPTION *MaxMsgSize;\r
UINT16 Value;\r
EFI_STATUS Status;\r
+ BOOLEAN Received;\r
\r
- if ((Dhcp4Event != Dhcp4RcvdOffer) && (Dhcp4Event != Dhcp4SelectOffer)) {\r
+ if ((Dhcp4Event != Dhcp4SendDiscover) &&\r
+ (Dhcp4Event != Dhcp4RcvdOffer) &&\r
+ (Dhcp4Event != Dhcp4SendRequest) &&\r
+ (Dhcp4Event != Dhcp4RcvdAck) &&\r
+ (Dhcp4Event != Dhcp4SelectOffer)) {\r
return EFI_SUCCESS;\r
}\r
- \r
+\r
Private = (HTTP_BOOT_PRIVATE_DATA *) Context;\r
\r
//\r
CopyMem (MaxMsgSize->Data, &Value, sizeof (Value));\r
}\r
\r
+ //\r
+ // Callback to user if any packets sent or received.\r
+ //\r
+ if (Private->HttpBootCallback != NULL && Dhcp4Event != Dhcp4SelectOffer) {\r
+ Received = (BOOLEAN) (Dhcp4Event == Dhcp4RcvdOffer || Dhcp4Event == Dhcp4RcvdAck);\r
+ Status = Private->HttpBootCallback->Callback (\r
+ Private->HttpBootCallback,\r
+ HttpBootDhcp4,\r
+ Received,\r
+ Packet->Length,\r
+ &Packet->Dhcp4\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_ABORTED;\r
+ }\r
+ }\r
+\r
Status = EFI_SUCCESS;\r
switch (Dhcp4Event) {\r
case Dhcp4RcvdOffer:\r
Status = EFI_NOT_READY;\r
+ if (Packet->Length > HTTP_BOOT_DHCP4_PACKET_MAX_SIZE) {\r
+ //\r
+ // Ignore the incoming packets which exceed the maximum length.\r
+ //\r
+ break;\r
+ }\r
if (Private->OfferNum < HTTP_BOOT_OFFER_MAX_NUM) {\r
//\r
// Cache the DHCPv4 offers to OfferBuffer[] for select later, and record\r
// the OfferIndex and OfferCount.\r
+ // If error happens, just ignore this packet and continue to wait more offer.\r
//\r
HttpBootCacheDhcp4Offer (Private, Packet);\r
}\r
\r
case Dhcp4SelectOffer:\r
//\r
- // Select offer according to the priority in UEFI spec, and record the SelectIndex \r
+ // Select offer according to the priority in UEFI spec, and record the SelectIndex\r
// and SelectProxyType.\r
//\r
HttpBootSelectDhcpOffer (Private);\r
*NewPacket = &Private->OfferBuffer[Private->SelectIndex - 1].Dhcp4.Packet.Offer;\r
}\r
break;\r
- \r
+\r
default:\r
break;\r
}\r
\r
/**\r
This function will register the IPv4 gateway address to the network device.\r
- \r
+\r
@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r
\r
@retval EFI_SUCCESS The new IP configuration has been configured successfully.\r
\r
/**\r
This function will register the default DNS addresses to the network device.\r
- \r
+\r
@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r
@param[in] DataLength Size of the buffer pointed to by DnsServerData in bytes.\r
@param[in] DnsServerData Point a list of DNS server address in an array\r
)\r
{\r
EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2;\r
- \r
+\r
ASSERT (!Private->UsingIpv6);\r
\r
Ip4Config2 = Private->Ip4Config2;\r
- \r
+\r
return Ip4Config2->SetData (\r
Ip4Config2,\r
Ip4Config2DataTypeDnsServer,\r
);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
- } \r
+ }\r
}\r
\r
return EFI_SUCCESS;\r
EFI_DHCP4_CONFIG_DATA Config;\r
EFI_STATUS Status;\r
EFI_DHCP4_MODE_DATA Mode;\r
- \r
+\r
Dhcp4 = Private->Dhcp4;\r
ASSERT (Dhcp4 != NULL);\r
\r