[mirror_edk2.git] / MdeModulePkg / Library / DxeHttpLib / DxeHttpLib.c

/** @file\r
  This library is used to share code between UEFI network stack modules.\r
  It provides the helper routines to parse the HTTP message byte stream.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at<BR>\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
\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/NetLib.h>\r
#include <Library/HttpLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#define BIT(x)  (1 << x)\r
\r
#define NET_IS_HEX_CHAR(Ch)   \\r
  ((('0' <= (Ch)) && ((Ch) <= '9')) ||  \\r
   (('A' <= (Ch)) && ((Ch) <= 'F')) ||  \\r
   (('a' <= (Ch)) && ((Ch) <= 'f')))\r
\r
//\r
// Field index of the HTTP URL parse result.\r
//\r
#define   HTTP_URI_FIELD_SCHEME           0\r
#define   HTTP_URI_FIELD_AUTHORITY        1\r
#define   HTTP_URI_FIELD_PATH             2\r
#define   HTTP_URI_FIELD_QUERY            3\r
#define   HTTP_URI_FIELD_FRAGMENT         4\r
#define   HTTP_URI_FIELD_USERINFO         5\r
#define   HTTP_URI_FIELD_HOST             6\r
#define   HTTP_URI_FIELD_PORT             7\r
#define   HTTP_URI_FIELD_MAX              8\r
\r
//\r
// Structure to store the parse result of a HTTP URL.\r
//\r
typedef struct {\r
    UINT32      Offset;\r
    UINT32      Length;\r
} HTTP_URL_FILED_DATA;\r
\r
typedef struct {\r
  UINT16                  FieldBitMap;\r
  HTTP_URL_FILED_DATA     FieldData[HTTP_URI_FIELD_MAX];\r
} HTTP_URL_PARSER;\r
\r
typedef enum {\r
  UrlParserUrlStart,\r
  UrlParserScheme,\r
  UrlParserSchemeColon,            // ":"\r
  UrlParserSchemeColonSlash,       // ":/"\r
  UrlParserSchemeColonSlashSlash,  // "://"\r
  UrlParserAuthority,\r
  UrlParserAtInAuthority,\r
  UrlParserPath,\r
  UrlParserQueryStart,    // "?"\r
  UrlParserQuery,\r
  UrlParserFragmentStart, // "#"\r
  UrlParserFragment,\r
  UrlParserUserInfo,\r
  UrlParserHostStart,     // "@"\r
  UrlParserHost,\r
  UrlParserPortStart,     // ":"\r
  UrlParserPort,\r
  UrlParserStateMax\r
} HTTP_URL_PARSE_STATE;\r
\r
/**\r
  Decode a percent-encoded URI component to the ASCII character.\r
  \r
  Decode the input component in Buffer according to RFC 3986. The caller is responsible to make \r
  sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer))\r
  in bytes. \r
\r
  @param[in]    Buffer           The pointer to a percent-encoded URI component.\r
  @param[in]    BufferLength     Length of Buffer in bytes.\r
  @param[out]   ResultBuffer     Point to the buffer to store the decode result.\r
  @param[out]   ResultLength     Length of decoded string in ResultBuffer in bytes.\r
\r
  @retval EFI_SUCCESS            Successfully decoded the URI.\r
  @retval EFI_INVALID_PARAMETER  Buffer is not a valid percent-encoded string.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
UriPercentDecode (\r
  IN      CHAR8            *Buffer,\r
  IN      UINT32            BufferLength,\r
     OUT  CHAR8            *ResultBuffer,\r
     OUT  UINT32           *ResultLength\r
  )\r
{\r
  UINTN           Index;\r
  UINTN           Offset;\r
  CHAR8           HexStr[3];\r
\r
  if (Buffer == NULL || BufferLength == 0 || ResultBuffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  Index = 0;\r
  Offset = 0;\r
  HexStr[2] = '\0';\r
  while (Index < BufferLength) {\r
    if (Buffer[Index] == '%') {\r
      if (!NET_IS_HEX_CHAR (Buffer[Index+1]) || !NET_IS_HEX_CHAR (Buffer[Index+2])) {\r
        return EFI_INVALID_PARAMETER;\r
      }\r
      HexStr[0] = Buffer[Index+1];\r
      HexStr[1] = Buffer[Index+2];\r
      ResultBuffer[Offset] = (CHAR8) AsciiStrHexToUintn (HexStr);\r
      Index += 3;\r
    } else {\r
      ResultBuffer[Offset] = Buffer[Index];\r
      Index++;\r
    }\r
    Offset++;\r
  }\r
\r
  *ResultLength = (UINT32) Offset;\r
    \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function return the updated state accroding to the input state and next character of\r
  the authority.\r
\r
  @param[in]       Char           Next character.\r
  @param[in]       State          Current value of the parser state machine.\r
\r
  @return          Updated state value.\r
**/\r
HTTP_URL_PARSE_STATE\r
NetHttpParseAuthorityChar (\r
  IN  CHAR8                  Char,\r
  IN  HTTP_URL_PARSE_STATE   State\r
  )\r
{\r
\r
  //\r
  // RFC 3986:\r
  // The authority component is preceded by a double slash ("//") and is\r
  // terminated by the next slash ("/"), question mark ("?"), or number\r
  // sign ("#") character, or by the end of the URI.\r
  //\r
  if (Char == ' ' || Char == '\r' || Char == '\n') {\r
    return UrlParserStateMax;\r
  }\r
\r
  //\r
  // authority   = [ userinfo "@" ] host [ ":" port ]\r
  //\r
  switch (State) {\r
  case UrlParserUserInfo:\r
    if (Char == '@') {\r
      return UrlParserHostStart;\r
    }\r
    break;\r
\r
  case UrlParserHost:\r
  case UrlParserHostStart:\r
    if (Char == ':') {\r
      return UrlParserPortStart;\r
    }\r
    return UrlParserHost;\r
\r
  case UrlParserPort:\r
  case UrlParserPortStart:\r
    return UrlParserPort;\r
\r
  default:\r
    break;\r
  }\r
\r
  return State;\r
}\r
\r
/**\r
  This function parse the authority component of the input URL and update the parser.\r
\r
  @param[in]       Url            The pointer to a HTTP URL string.\r
  @param[in]       FoundAt        TRUE if there is an at sign ('@') in the authority component.\r
  @param[in, out]  UrlParser      Pointer to the buffer of the parse result.\r
\r
  @retval EFI_SUCCESS             Successfully parse the authority.\r
  @retval Other                   Error happened.\r
\r
**/\r
EFI_STATUS\r
NetHttpParseAuthority (\r
  IN      CHAR8              *Url,\r
  IN      BOOLEAN            FoundAt,\r
  IN OUT  HTTP_URL_PARSER    *UrlParser\r
  )\r
{\r
  CHAR8                 *Char;\r
  CHAR8                 *Authority;\r
  UINT32                Length;\r
  HTTP_URL_PARSE_STATE  State;\r
  UINT32                Field;\r
  UINT32                OldField;\r
  \r
  ASSERT ((UrlParser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0);\r
\r
  //\r
  // authority   = [ userinfo "@" ] host [ ":" port ]\r
  //\r
  if (FoundAt) {\r
    State = UrlParserUserInfo;\r
  } else {\r
    State = UrlParserHost;\r
  }\r
\r
  Field = HTTP_URI_FIELD_MAX;\r
  OldField = Field;\r
  Authority = Url + UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Offset;\r
  Length = UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Length;\r
  for (Char = Authority; Char < Authority + Length; Char++) {\r
    State = NetHttpParseAuthorityChar (*Char, State);\r
    switch (State) {\r
    case UrlParserStateMax:\r
      return EFI_INVALID_PARAMETER;\r
\r
    case UrlParserHostStart:\r
    case UrlParserPortStart:\r
      continue;\r
\r
    case UrlParserUserInfo:\r
      Field = HTTP_URI_FIELD_USERINFO;\r
      break;\r
      \r
    case UrlParserHost:\r
      Field = HTTP_URI_FIELD_HOST;\r
      break;\r
      \r
    case UrlParserPort:\r
      Field = HTTP_URI_FIELD_PORT;\r
      break;\r
\r
    default:\r
      ASSERT (FALSE);\r
    }\r
\r
    //\r
    // Field not changed, count the length.\r
    //\r
    ASSERT (Field < HTTP_URI_FIELD_MAX);\r
    if (Field == OldField) {\r
      UrlParser->FieldData[Field].Length++;\r
      continue;\r
    }\r
\r
    //\r
    // New field start\r
    //\r
    UrlParser->FieldBitMap |= BIT (Field);\r
    UrlParser->FieldData[Field].Offset = (UINT32) (Char - Url);\r
    UrlParser->FieldData[Field].Length = 1;\r
    OldField = Field;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function return the updated state accroding to the input state and next character of a URL.\r
\r
  @param[in]       Char           Next character.\r
  @param[in]       State          Current value of the parser state machine.\r
\r
  @return          Updated state value.\r
\r
**/\r
HTTP_URL_PARSE_STATE\r
NetHttpParseUrlChar (\r
  IN  CHAR8                  Char,\r
  IN  HTTP_URL_PARSE_STATE   State\r
  )\r
{\r
  if (Char == ' ' || Char == '\r' || Char == '\n') {\r
    return UrlParserStateMax;\r
  }\r
  \r
  //\r
  // http_URL = "http:" "//" host [ ":" port ] [ abs_path [ "?" query ]]\r
  // \r
  // Request-URI    = "*" | absolute-URI | path-absolute | authority\r
  // \r
  // absolute-URI  = scheme ":" hier-part [ "?" query ]\r
  // path-absolute = "/" [ segment-nz *( "/" segment ) ]\r
  // authority   = [ userinfo "@" ] host [ ":" port ]\r
  //\r
  switch (State) {\r
  case UrlParserUrlStart:\r
    if (Char == '*' || Char == '/') {\r
      return UrlParserPath;\r
    }\r
    return UrlParserScheme;\r
\r
  case UrlParserScheme:\r
    if (Char == ':') {\r
      return UrlParserSchemeColon;\r
    }\r
    break;\r
\r
  case UrlParserSchemeColon:\r
    if (Char == '/') {\r
      return UrlParserSchemeColonSlash;\r
    }\r
    break;\r
\r
  case UrlParserSchemeColonSlash:\r
    if (Char == '/') {\r
      return UrlParserSchemeColonSlashSlash;\r
    }\r
    break;\r
\r
  case UrlParserAtInAuthority:\r
    if (Char == '@') {\r
      return UrlParserStateMax;\r
    }\r
\r
  case UrlParserAuthority:\r
  case UrlParserSchemeColonSlashSlash:\r
    if (Char == '@') {\r
      return UrlParserAtInAuthority;\r
    }\r
    if (Char == '/') {\r
      return UrlParserPath;\r
    }\r
    if (Char == '?') {\r
      return UrlParserQueryStart;\r
    }\r
    if (Char == '#') {\r
      return UrlParserFragmentStart;\r
    }\r
    return UrlParserAuthority;\r
\r
  case UrlParserPath:\r
    if (Char == '?') {\r
      return UrlParserQueryStart;\r
    }\r
    if (Char == '#') {\r
      return UrlParserFragmentStart;\r
    }\r
    break;\r
\r
  case UrlParserQuery:\r
  case UrlParserQueryStart:\r
    if (Char == '#') {\r
      return UrlParserFragmentStart;\r
    }\r
    return UrlParserQuery;\r
\r
  case UrlParserFragmentStart:\r
    return UrlParserFragment;\r
    \r
  default:\r
    break;\r
  }\r
\r
  return State;\r
}\r
/**\r
  Create a URL parser for the input URL string.\r
\r
  This function will parse and dereference the input HTTP URL into it components. The original\r
  content of the URL won't be modified and the result will be returned in UrlParser, which can\r
  be used in other functions like NetHttpUrlGetHostName().\r
\r
  @param[in]    Url                The pointer to a HTTP URL string.\r
  @param[in]    Length             Length of Url in bytes.\r
  @param[in]    IsConnectMethod    Whether the Url is used in HTTP CONNECT method or not.\r
  @param[out]   UrlParser          Pointer to the returned buffer to store the parse result.\r
\r
  @retval EFI_SUCCESS              Successfully dereferenced the HTTP URL.\r
  @retval EFI_INVALID_PARAMETER    UrlParser is NULL or Url is not a valid HTTP URL.\r
  @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpParseUrl (\r
  IN      CHAR8              *Url,\r
  IN      UINT32             Length,\r
  IN      BOOLEAN            IsConnectMethod,\r
     OUT  VOID               **UrlParser\r
  )\r
{\r
  HTTP_URL_PARSE_STATE  State;\r
  CHAR8                 *Char;\r
  UINT32                Field;\r
  UINT32                OldField;\r
  BOOLEAN               FoundAt;\r
  EFI_STATUS            Status;\r
  HTTP_URL_PARSER       *Parser;\r
  \r
  if (Url == NULL || Length == 0 || UrlParser == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = AllocateZeroPool (sizeof (HTTP_URL_PARSER));\r
  if (Parser == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  \r
  if (IsConnectMethod) {\r
    //\r
    // According to RFC 2616, the authority form is only used by the CONNECT method.\r
    //\r
    State = UrlParserAuthority;\r
  } else {\r
    State = UrlParserUrlStart;\r
  }\r
\r
  Field = HTTP_URI_FIELD_MAX;\r
  OldField = Field;\r
  FoundAt = FALSE;\r
  for (Char = Url; Char < Url + Length; Char++) {\r
    //\r
    // Update state machine accoring to next char.\r
    //\r
    State = NetHttpParseUrlChar (*Char, State);\r
\r
    switch (State) {\r
    case UrlParserStateMax:\r
      return EFI_INVALID_PARAMETER;\r
      \r
    case UrlParserSchemeColon:\r
    case UrlParserSchemeColonSlash:\r
    case UrlParserSchemeColonSlashSlash:\r
    case UrlParserQueryStart:\r
    case UrlParserFragmentStart:\r
      //\r
      // Skip all the delimiting char: "://" "?" "@"\r
      //\r
      continue;\r
    \r
    case UrlParserScheme:\r
      Field = HTTP_URI_FIELD_SCHEME;\r
      break;\r
\r
    case UrlParserAtInAuthority:\r
      FoundAt = TRUE;\r
    case UrlParserAuthority:\r
      Field = HTTP_URI_FIELD_AUTHORITY;\r
      break;\r
\r
    case UrlParserPath:\r
      Field = HTTP_URI_FIELD_PATH;\r
      break;\r
\r
    case UrlParserQuery:\r
      Field = HTTP_URI_FIELD_QUERY;\r
      break;\r
\r
    case UrlParserFragment:\r
      Field = HTTP_URI_FIELD_FRAGMENT;\r
      break;\r
\r
    default:\r
      ASSERT (FALSE);\r
    }\r
\r
    //\r
    // Field not changed, count the length.\r
    //\r
    ASSERT (Field < HTTP_URI_FIELD_MAX);\r
    if (Field == OldField) {\r
      Parser->FieldData[Field].Length++;\r
      continue;\r
    }\r
\r
    //\r
    // New field start\r
    //\r
    Parser->FieldBitMap |= BIT (Field);\r
    Parser->FieldData[Field].Offset = (UINT32) (Char - Url);\r
    Parser->FieldData[Field].Length = 1;\r
    OldField = Field;\r
  }\r
\r
  //\r
  // If has authority component, continue to parse the username, host and port.\r
  //\r
  if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0) {\r
    Status = NetHttpParseAuthority (Url, FoundAt, Parser);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  *UrlParser = Parser;\r
  return EFI_SUCCESS;  \r
}\r
\r
/**\r
  Get the Hostname from a HTTP URL.\r
\r
  This function will return the HostName according to the Url and previous parse result ,and\r
  it is the caller's responsibility to free the buffer returned in *HostName.\r
\r
  @param[in]    Url                The pointer to a HTTP URL string.\r
  @param[in]    UrlParser          URL Parse result returned by NetHttpParseUrl().\r
  @param[out]   HostName           Pointer to a buffer to store the HostName.\r
\r
  @retval EFI_SUCCESS              Successfully get the required component.\r
  @retval EFI_INVALID_PARAMETER    Uri is NULL or HostName is NULL or UrlParser is invalid.\r
  @retval EFI_NOT_FOUND            No hostName component in the URL.\r
  @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpUrlGetHostName (\r
  IN      CHAR8              *Url,\r
  IN      VOID               *UrlParser,\r
     OUT  CHAR8              **HostName\r
  )\r
{\r
  CHAR8                *Name;\r
  EFI_STATUS           Status;\r
  UINT32               ResultLength;\r
  HTTP_URL_PARSER      *Parser;\r
\r
  if (Url == NULL || UrlParser == NULL || HostName == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = (HTTP_URL_PARSER*) UrlParser;\r
\r
  if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  Name = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1);\r
  if (Name == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  \r
  Status = UriPercentDecode (\r
             Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset,\r
             Parser->FieldData[HTTP_URI_FIELD_HOST].Length,\r
             Name,\r
             &ResultLength\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Name[ResultLength] = '\0';\r
  *HostName = Name;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Get the IPv4 address from a HTTP URL.\r
\r
  This function will return the IPv4 address according to the Url and previous parse result.\r
\r
  @param[in]    Url                The pointer to a HTTP URL string.\r
  @param[in]    UrlParser          URL Parse result returned by NetHttpParseUrl().\r
  @param[out]   Ip4Address         Pointer to a buffer to store the IP address.\r
\r
  @retval EFI_SUCCESS              Successfully get the required component.\r
  @retval EFI_INVALID_PARAMETER    Uri is NULL or Ip4Address is NULL or UrlParser is invalid.\r
  @retval EFI_NOT_FOUND            No IPv4 address component in the URL.\r
  @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpUrlGetIp4 (\r
  IN      CHAR8              *Url,\r
  IN      VOID               *UrlParser,\r
     OUT  EFI_IPv4_ADDRESS   *Ip4Address\r
  )\r
{\r
  CHAR8                *Ip4String;\r
  EFI_STATUS           Status;\r
  UINT32               ResultLength;\r
  HTTP_URL_PARSER      *Parser;\r
  \r
  if (Url == NULL || UrlParser == NULL || Ip4Address == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = (HTTP_URL_PARSER*) UrlParser;\r
\r
  if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Ip4String = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1);\r
  if (Ip4String == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  \r
  Status = UriPercentDecode (\r
             Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset,\r
             Parser->FieldData[HTTP_URI_FIELD_HOST].Length,\r
             Ip4String,\r
             &ResultLength\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Ip4String[ResultLength] = '\0';\r
  Status = NetLibAsciiStrToIp4 (Ip4String, Ip4Address);\r
  FreePool (Ip4String);\r
\r
  return Status;\r
}\r
\r
/**\r
  Get the IPv6 address from a HTTP URL.\r
\r
  This function will return the IPv6 address according to the Url and previous parse result.\r
\r
  @param[in]    Url                The pointer to a HTTP URL string.\r
  @param[in]    UrlParser          URL Parse result returned by NetHttpParseUrl().\r
  @param[out]   Ip6Address         Pointer to a buffer to store the IP address.\r
\r
  @retval EFI_SUCCESS              Successfully get the required component.\r
  @retval EFI_INVALID_PARAMETER    Uri is NULL or Ip6Address is NULL or UrlParser is invalid.\r
  @retval EFI_NOT_FOUND            No IPv6 address component in the URL.\r
  @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpUrlGetIp6 (\r
  IN      CHAR8              *Url,\r
  IN      VOID               *UrlParser,\r
     OUT  EFI_IPv6_ADDRESS   *Ip6Address\r
  )\r
{\r
  CHAR8                *Ip6String;\r
  CHAR8                *Ptr;\r
  UINT32               Length;\r
  EFI_STATUS           Status;\r
  UINT32               ResultLength;\r
  HTTP_URL_PARSER      *Parser;\r
  \r
  if (Url == NULL || UrlParser == NULL || Ip6Address == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = (HTTP_URL_PARSER*) UrlParser;\r
\r
  if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // IP-literal = "[" ( IPv6address / IPvFuture  ) "]"\r
  //\r
  Length = Parser->FieldData[HTTP_URI_FIELD_HOST].Length;\r
  if (Length < 2) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Ptr    = Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset;\r
  if ((Ptr[0] != '[') || (Ptr[Length - 1] != ']')) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Ip6String = AllocatePool (Length);\r
  if (Ip6String == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  \r
  Status = UriPercentDecode (\r
             Ptr + 1,\r
             Length - 2,\r
             Ip6String,\r
             &ResultLength\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  \r
  Ip6String[ResultLength] = '\0';\r
  Status = NetLibAsciiStrToIp6 (Ip6String, Ip6Address);\r
  FreePool (Ip6String);\r
\r
  return Status;\r
}\r
\r
/**\r
  Get the port number from a HTTP URL.\r
\r
  This function will return the port number according to the Url and previous parse result.\r
\r
  @param[in]    Url                The pointer to a HTTP URL string.\r
  @param[in]    UrlParser          URL Parse result returned by NetHttpParseUrl().\r
  @param[out]   Port               Pointer to a buffer to store the port number.\r
\r
  @retval EFI_SUCCESS              Successfully get the required component.\r
  @retval EFI_INVALID_PARAMETER    Uri is NULL or Port is NULL or UrlParser is invalid.\r
  @retval EFI_NOT_FOUND            No port number in the URL.\r
  @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpUrlGetPort (\r
  IN      CHAR8              *Url,\r
  IN      VOID               *UrlParser,\r
     OUT  UINT16             *Port\r
  )\r
{\r
  CHAR8         *PortString;\r
  EFI_STATUS    Status;\r
  UINT32        ResultLength;\r
  HTTP_URL_PARSER      *Parser;\r
\r
  if (Url == NULL || UrlParser == NULL || Port == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = (HTTP_URL_PARSER*) UrlParser;\r
\r
  if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PORT)) == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PortString = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PORT].Length + 1);\r
  if (PortString == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = UriPercentDecode (\r
             Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset,\r
             Parser->FieldData[HTTP_URI_FIELD_PORT].Length,\r
             PortString,\r
             &ResultLength\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  PortString[ResultLength] = '\0';\r
  *Port = (UINT16) AsciiStrDecimalToUintn (Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset);\r
\r
  return  EFI_SUCCESS;\r
}\r
\r
/**\r
  Release the resource of the URL parser.\r
\r
  @param[in]    UrlParser            Pointer to the parser.\r
  \r
**/\r
VOID\r
EFIAPI\r
HttpUrlFreeParser (\r
  IN      VOID               *UrlParser\r
  )\r
{\r
  FreePool (UrlParser);\r
}\r
\r
/**\r
  Find a specified header field according to the field name.\r
\r
  @param[in]   HeaderCount      Number of HTTP header structures in Headers list. \r
  @param[in]   Headers          Array containing list of HTTP headers.\r
  @param[in]   FieldName        Null terminated string which describes a field name. \r
\r
  @return    Pointer to the found header or NULL.\r
\r
**/\r
EFI_HTTP_HEADER *\r
HttpIoFindHeader (\r
  IN  UINTN                HeaderCount,\r
  IN  EFI_HTTP_HEADER      *Headers,\r
  IN  CHAR8                *FieldName\r
  )\r
{\r
  UINTN                 Index;\r
  \r
  if (HeaderCount == 0 || Headers == NULL || FieldName == NULL) {\r
    return NULL;\r
  }\r
\r
  for (Index = 0; Index < HeaderCount; Index++){\r
    //\r
    // Field names are case-insensitive (RFC 2616).\r
    //\r
    if (AsciiStriCmp (Headers[Index].FieldName, FieldName) == 0) {\r
      return &Headers[Index];\r
    }\r
  }\r
  return NULL;\r
}\r
\r
typedef enum {\r
  BodyParserBodyStart,\r
  BodyParserBodyIdentity,\r
  BodyParserChunkSizeStart,\r
  BodyParserChunkSize,\r
  BodyParserChunkSizeEndCR,\r
  BodyParserChunkExtStart,\r
  BodyParserChunkDataStart,\r
  BodyParserChunkDataEnd,\r
  BodyParserChunkDataEndCR,\r
  BodyParserTrailer,\r
  BodyParserLastCRLF,\r
  BodyParserLastCRLFEnd,\r
  BodyParserComplete,\r
  BodyParserStateMax\r
} HTTP_BODY_PARSE_STATE;\r
\r
typedef struct {\r
  BOOLEAN                       IgnoreBody;    // "MUST NOT" include a message-body\r
  BOOLEAN                       IsChunked;     // "chunked" transfer-coding.\r
  BOOLEAN                       ContentLengthIsValid;\r
  UINTN                         ContentLength; // Entity length (not the message-body length), invalid until ContentLengthIsValid is TRUE\r
  \r
  HTTP_BODY_PARSER_CALLBACK     Callback;\r
  VOID                          *Context;\r
  UINTN                         ParsedBodyLength;\r
  HTTP_BODY_PARSE_STATE         State;\r
  UINTN                         CurrentChunkSize;\r
  UINTN                         CurrentChunkParsedSize;\r
} HTTP_BODY_PARSER;\r
\r
/**\r
\r
  Convert an Ascii char to its uppercase.\r
\r
  @param[in]       Char           Ascii character.\r
\r
  @return          Uppercase value of the input Char.\r
\r
**/\r
CHAR8\r
HttpIoCharToUpper (\r
  IN      CHAR8                    Char\r
  )\r
{\r
  if (Char >= 'a' && Char <= 'z') {\r
    return  Char - ('a' - 'A');\r
  }\r
\r
  return Char;\r
}\r
\r
/**\r
  Convert an hexadecimal char to a value of type UINTN.\r
\r
  @param[in]       Char           Ascii character.\r
\r
  @return          Value translated from Char.\r
\r
**/\r
UINTN\r
HttpIoHexCharToUintn (\r
  IN CHAR8           Char\r
  )\r
{\r
  if (Char >= '0' && Char <= '9') {\r
    return Char - '0';\r
  }\r
\r
  return (10 + HttpIoCharToUpper (Char) - 'A');\r
}\r
\r
/**\r
  Get the value of the content length if there is a "Content-Length" header.\r
\r
  @param[in]    HeaderCount        Number of HTTP header structures in Headers.\r
  @param[in]    Headers            Array containing list of HTTP headers.\r
  @param[out]   ContentLength      Pointer to save the value of the content length.\r
\r
  @retval EFI_SUCCESS              Successfully get the content length.\r
  @retval EFI_NOT_FOUND            No "Content-Length" header in the Headers.\r
\r
**/\r
EFI_STATUS\r
HttpIoParseContentLengthHeader (\r
  IN     UINTN                HeaderCount,\r
  IN     EFI_HTTP_HEADER      *Headers,\r
     OUT UINTN                *ContentLength\r
  )\r
{\r
  EFI_HTTP_HEADER       *Header;\r
  \r
  Header = HttpIoFindHeader (HeaderCount, Headers, "Content-Length");\r
  if (Header == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  *ContentLength = AsciiStrDecimalToUintn (Header->FieldValue);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Check whether the HTTP message is using the "chunked" transfer-coding.\r
\r
  @param[in]    HeaderCount        Number of HTTP header structures in Headers.\r
  @param[in]    Headers            Array containing list of HTTP headers.\r
\r
  @return       The message is "chunked" transfer-coding (TRUE) or not (FALSE).\r
 \r
**/\r
BOOLEAN\r
HttpIoIsChunked (\r
  IN   UINTN                    HeaderCount,\r
  IN   EFI_HTTP_HEADER          *Headers\r
  )\r
{\r
  EFI_HTTP_HEADER       *Header;\r
\r
\r
  Header = HttpIoFindHeader (HeaderCount, Headers, "Transfer-Encoding");\r
  if (Header == NULL) {\r
    return FALSE;\r
  }\r
\r
  if (AsciiStriCmp (Header->FieldValue, "identity") != 0) {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Check whether the HTTP message should have a message-body.\r
\r
  @param[in]    Method             The HTTP method (e.g. GET, POST) for this HTTP message.\r
  @param[in]    StatusCode         Response status code returned by the remote host.\r
\r
  @return       The message should have a message-body (FALSE) or not (TRUE).\r
\r
**/\r
BOOLEAN\r
HttpIoNoMessageBody (\r
  IN   EFI_HTTP_METHOD          Method,\r
  IN   EFI_HTTP_STATUS_CODE     StatusCode\r
  )\r
{\r
  //\r
  // RFC 2616:\r
  // All responses to the HEAD request method\r
  // MUST NOT include a message-body, even though the presence of entity-\r
  // header fields might lead one to believe they do. All 1xx\r
  // (informational), 204 (no content), and 304 (not modified) responses\r
  // MUST NOT include a message-body. All other responses do include a\r
  // message-body, although it MAY be of zero length.\r
  //\r
  if (Method == HttpMethodHead) {\r
    return TRUE;\r
  }\r
\r
  if ((StatusCode == HTTP_STATUS_100_CONTINUE) ||\r
      (StatusCode == HTTP_STATUS_101_SWITCHING_PROTOCOLS) ||\r
      (StatusCode == HTTP_STATUS_204_NO_CONTENT) ||\r
      (StatusCode == HTTP_STATUS_304_NOT_MODIFIED))\r
  {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Initialize a HTTP message-body parser.\r
\r
  This function will create and initialize a HTTP message parser according to caller provided HTTP message\r
  header information. It is the caller's responsibility to free the buffer returned in *UrlParser by HttpFreeMsgParser().\r
\r
  @param[in]    Method             The HTTP method (e.g. GET, POST) for this HTTP message.\r
  @param[in]    StatusCode         Response status code returned by the remote host.\r
  @param[in]    HeaderCount        Number of HTTP header structures in Headers.\r
  @param[in]    Headers            Array containing list of HTTP headers.\r
  @param[in]    Callback           Callback function that is invoked when parsing the HTTP message-body,\r
                                   set to NULL to ignore all events.\r
  @param[in]    Context            Pointer to the context that will be passed to Callback.\r
  @param[out]   MsgParser          Pointer to the returned buffer to store the message parser.\r
\r
  @retval EFI_SUCCESS              Successfully initialized the parser.\r
  @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
  @retval EFI_INVALID_PARAMETER    MsgParser is NULL or HeaderCount is not NULL but Headers is NULL.\r
  @retval Others                   Failed to initialize the parser.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpInitMsgParser (\r
  IN     EFI_HTTP_METHOD               Method,\r
  IN     EFI_HTTP_STATUS_CODE          StatusCode,\r
  IN     UINTN                         HeaderCount,\r
  IN     EFI_HTTP_HEADER               *Headers,\r
  IN     HTTP_BODY_PARSER_CALLBACK     Callback,\r
  IN     VOID                          *Context,\r
    OUT  VOID                          **MsgParser\r
  )\r
{\r
  EFI_STATUS            Status;\r
  HTTP_BODY_PARSER      *Parser;\r
  \r
  if (HeaderCount != 0 && Headers == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (MsgParser == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = AllocateZeroPool (sizeof (HTTP_BODY_PARSER));\r
  if (Parser == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Parser->State = BodyParserBodyStart;\r
  \r
  //\r
  // Determine the message length accroding to RFC 2616.\r
  // 1. Check whether the message "MUST NOT" have a message-body.\r
  //\r
  Parser->IgnoreBody = HttpIoNoMessageBody (Method, StatusCode);\r
  //\r
  // 2. Check whether the message using "chunked" transfer-coding.\r
  //\r
  Parser->IsChunked  = HttpIoIsChunked (HeaderCount, Headers);\r
  //\r
  // 3. Check whether the message has a Content-Length header field.\r
  //\r
  Status = HttpIoParseContentLengthHeader (HeaderCount, Headers, &Parser->ContentLength);\r
  if (!EFI_ERROR (Status)) {\r
    Parser->ContentLengthIsValid = TRUE;\r
  }\r
  //\r
  // 4. Range header is not supported now, so we won't meet media type "multipart/byteranges".\r
  // 5. By server closing the connection\r
  //\r
  \r
  //\r
  // Set state to skip body parser if the message shouldn't have a message body.\r
  //\r
  if (Parser->IgnoreBody) {\r
    Parser->State = BodyParserComplete;\r
  } else {\r
    Parser->Callback = Callback;\r
    Parser->Context  = Context;\r
  }\r
\r
  *MsgParser = Parser;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Parse message body.\r
\r
  Parse BodyLength of message-body. This function can be called repeatedly to parse the message-body partially.\r
\r
  @param[in, out]    MsgParser            Pointer to the message parser.\r
  @param[in]         BodyLength           Length in bytes of the Body.\r
  @param[in]         Body                 Pointer to the buffer of the message-body to be parsed.\r
\r
  @retval EFI_SUCCESS                Successfully parse the message-body.\r
  @retval EFI_INVALID_PARAMETER      MsgParser is NULL or Body is NULL or BodyLength is 0.\r
  @retval Others                     Operation aborted.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpParseMessageBody (\r
  IN OUT VOID              *MsgParser,\r
  IN     UINTN             BodyLength,\r
  IN     CHAR8             *Body\r
  )\r
{\r
  CHAR8                 *Char;\r
  UINTN                 RemainderLengthInThis;\r
  UINTN                 LengthForCallback;\r
  EFI_STATUS            Status;\r
  HTTP_BODY_PARSER      *Parser;\r
  \r
  if (BodyLength == 0 || Body == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (MsgParser == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = (HTTP_BODY_PARSER*) MsgParser;\r
\r
  if (Parser->IgnoreBody) {\r
    Parser->State = BodyParserComplete;\r
    if (Parser->Callback != NULL) {\r
      Status = Parser->Callback (\r
                 BodyParseEventOnComplete,\r
                 Body,\r
                 0,\r
                 Parser->Context\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        return Status;\r
      }\r
    }\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (Parser->State == BodyParserBodyStart) {\r
    Parser->ParsedBodyLength = 0;\r
    if (Parser->IsChunked) {\r
      Parser->State = BodyParserChunkSizeStart;\r
    } else {\r
      Parser->State = BodyParserBodyIdentity;\r
    }\r
  }\r
\r
  //\r
  // The message body might be truncated in anywhere, so we need to parse is byte-by-byte.\r
  //\r
  for (Char = Body; Char < Body + BodyLength; ) {\r
\r
    switch (Parser->State) {\r
    case BodyParserStateMax:\r
      return EFI_ABORTED;\r
\r
    case BodyParserComplete:\r
      if (Parser->Callback != NULL) {\r
        Status = Parser->Callback (\r
                   BodyParseEventOnComplete,\r
                   Char,\r
                   0,\r
                   Parser->Context\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
      }\r
      return EFI_SUCCESS;\r
    \r
    case BodyParserBodyIdentity:\r
      //\r
      // Identity transfer-coding, just notify user to save the body data.\r
      //\r
      if (Parser->Callback != NULL) {\r
        Status = Parser->Callback (\r
                   BodyParseEventOnData,\r
                   Char,\r
                   MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength),\r
                   Parser->Context\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
      }\r
      Char += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength);\r
      Parser->ParsedBodyLength += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength);\r
      if (Parser->ParsedBodyLength == Parser->ContentLength) {\r
        Parser->State = BodyParserComplete;\r
      }\r
      break;\r
\r
    case BodyParserChunkSizeStart:\r
      //\r
      // First byte of chunk-size, the chunk-size might be truncated.\r
      //\r
      Parser->CurrentChunkSize = 0;\r
      Parser->State = BodyParserChunkSize;\r
    case BodyParserChunkSize:\r
      if (!NET_IS_HEX_CHAR (*Char)) {\r
        if (*Char == ';') {\r
          Parser->State = BodyParserChunkExtStart;\r
          Char++;\r
        } else if (*Char == '\r') {\r
          Parser->State = BodyParserChunkSizeEndCR;\r
          Char++;\r
        } else {\r
          Parser->State = BodyParserStateMax;\r
        }\r
        break;\r
      }\r
\r
      if (Parser->CurrentChunkSize > (((~((UINTN) 0)) - 16) / 16)) {\r
        return EFI_INVALID_PARAMETER;\r
      }\r
      Parser->CurrentChunkSize = Parser->CurrentChunkSize * 16 + HttpIoHexCharToUintn (*Char);\r
      Char++;\r
      break;\r
\r
    case BodyParserChunkExtStart:\r
      //\r
      // Ignore all the chunk extensions.\r
      //\r
      if (*Char == '\r') {\r
        Parser->State = BodyParserChunkSizeEndCR;\r
       }\r
      Char++;\r
      break;\r
      \r
    case BodyParserChunkSizeEndCR:\r
      if (*Char != '\n') {\r
        Parser->State = BodyParserStateMax;\r
        break;\r
      }\r
      Char++;\r
      if (Parser->CurrentChunkSize == 0) {\r
        //\r
        // The last chunk has been parsed and now assumed the state \r
        // of HttpBodyParse is ParserLastCRLF. So it need to decide\r
        // whether the rest message is trailer or last CRLF in the next round.\r
        //\r
        Parser->ContentLengthIsValid = TRUE;\r
        Parser->State = BodyParserLastCRLF;\r
        break;\r
      }\r
      Parser->State = BodyParserChunkDataStart;\r
      Parser->CurrentChunkParsedSize = 0;\r
      break;\r
      \r
    case BodyParserLastCRLF:\r
      //\r
      // Judge the byte is belong to the Last CRLF or trailer, and then \r
      // configure the state of HttpBodyParse to corresponding state.\r
      //\r
      if (*Char == '\r') {\r
        Char++;\r
        Parser->State = BodyParserLastCRLFEnd;\r
        break;\r
      } else {\r
        Parser->State = BodyParserTrailer;\r
        break;\r
      }\r
      \r
    case BodyParserLastCRLFEnd:\r
      if (*Char == '\n') {\r
        Parser->State = BodyParserComplete;\r
        break;\r
      } else {\r
        Parser->State = BodyParserStateMax;\r
        break;\r
      }\r
      \r
    case BodyParserTrailer:\r
      if (*Char == '\r') {\r
        Parser->State = BodyParserChunkSizeEndCR;\r
      }\r
      Char++;\r
      break;      \r
\r
    case BodyParserChunkDataStart:\r
      //\r
      // First byte of chunk-data, the chunk data also might be truncated.\r
      //\r
      RemainderLengthInThis = BodyLength - (Char - Body);\r
      LengthForCallback = MIN (Parser->CurrentChunkSize - Parser->CurrentChunkParsedSize, RemainderLengthInThis);\r
      if (Parser->Callback != NULL) {\r
        Status = Parser->Callback (\r
                   BodyParseEventOnData,\r
                   Char,\r
                   LengthForCallback,\r
                   Parser->Context\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
      }\r
      Char += LengthForCallback;\r
      Parser->ContentLength += LengthForCallback;\r
      Parser->CurrentChunkParsedSize += LengthForCallback;\r
      if (Parser->CurrentChunkParsedSize == Parser->CurrentChunkSize) {\r
        Parser->State = BodyParserChunkDataEnd;\r
      }           \r
      break;\r
\r
    case BodyParserChunkDataEnd:\r
      if (*Char == '\r') {\r
        Parser->State = BodyParserChunkDataEndCR;\r
      } else {\r
        Parser->State = BodyParserStateMax;\r
      }\r
      Char++;\r
      break;\r
\r
    case BodyParserChunkDataEndCR:\r
      if (*Char != '\n') {\r
        Parser->State = BodyParserStateMax;\r
        break;\r
      }\r
      Char++;\r
      Parser->State = BodyParserChunkSizeStart;\r
      break;     \r
\r
    default:\r
      break;\r
    }\r
\r
  }\r
\r
  if (Parser->State == BodyParserStateMax) {\r
    return EFI_ABORTED;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Check whether the message-body is complete or not.\r
\r
  @param[in]    MsgParser            Pointer to the message parser.\r
\r
  @retval TRUE                       Message-body is complete.\r
  @retval FALSE                      Message-body is not complete.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HttpIsMessageComplete (\r
  IN VOID              *MsgParser\r
  )\r
{\r
  HTTP_BODY_PARSER      *Parser;\r
\r
  Parser = (HTTP_BODY_PARSER*) MsgParser;\r
\r
  if (Parser->State == BodyParserComplete) {\r
    return TRUE;\r
  }\r
  return FALSE;\r
}\r
\r
/**\r
  Get the content length of the entity.\r
\r
  Note that in trunk transfer, the entity length is not valid until the whole message body is received.\r
\r
  @param[in]    MsgParser            Pointer to the message parser.\r
  @param[out]   ContentLength        Pointer to store the length of the entity.\r
\r
  @retval EFI_SUCCESS                Successfully to get the entity length.\r
  @retval EFI_NOT_READY              Entity length is not valid yet.\r
  @retval EFI_INVALID_PARAMETER      MsgParser is NULL or ContentLength is NULL.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpGetEntityLength (\r
  IN  VOID              *MsgParser,\r
  OUT UINTN             *ContentLength\r
  )\r
{\r
  HTTP_BODY_PARSER      *Parser;\r
\r
  if (MsgParser == NULL || ContentLength == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Parser = (HTTP_BODY_PARSER*) MsgParser;\r
\r
  if (!Parser->ContentLengthIsValid) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  *ContentLength = Parser->ContentLength;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Release the resource of the message parser.\r
\r
  @param[in]    MsgParser            Pointer to the message parser.\r
  \r
**/\r
VOID\r
EFIAPI\r
HttpFreeMsgParser (\r
  IN  VOID           *MsgParser\r
  )\r
{\r
  FreePool (MsgParser);\r
}\r