]> git.proxmox.com Git - mirror_edk2.git/commitdiff
ModulePkg/DxeHttpLib: Adding Functions to HttpLib
authorGhazi Belaam <Ghazi.belaam@hpe.com>
Fri, 4 Mar 2016 22:07:49 +0000 (06:07 +0800)
committerFu Siyuan <siyuan.fu@intel.com>
Thu, 10 Mar 2016 01:51:42 +0000 (09:51 +0800)
There some usefull functions in edk2 private modules that could be used,
so we added them to the httpLib

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ghazi Belaam <Ghazi.belaam@hpe.com>
Reviewed-by: Jiaxin Wu <jiaxin.wu@intel.com>
Reviewed-by: Samer EL-Haj-Mahmoud <elhaj@hpe.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
MdeModulePkg/Include/Library/HttpLib.h
MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.c
MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.h [new file with mode: 0644]
MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.inf

index cd97b644f1e9a975c3da58c62e519e42c0a958cb..af9ab5f012c6b71e8353875bb10856ffee320bbc 100644 (file)
@@ -3,6 +3,7 @@
   It provides the helper routines to parse the HTTP message byte stream.\r
 \r
 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2016 Hewlett Packard Enterprise Development LP<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
@@ -18,6 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <Protocol/Http.h>\r
 \r
+\r
 /**\r
   Decode a percent-encoded URI component to the ASCII character.\r
   \r
@@ -343,5 +345,132 @@ HttpFreeMsgParser (
   );\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
+EFIAPI\r
+HttpFindHeader (\r
+  IN  UINTN                HeaderCount,\r
+  IN  EFI_HTTP_HEADER      *Headers,\r
+  IN  CHAR8                *FieldName\r
+  );\r
+\r
+/**\r
+  Set FieldName and FieldValue into specified HttpHeader.\r
+\r
+  @param[in,out]  HttpHeader          Specified HttpHeader.\r
+  @param[in]      FieldName           FieldName of this HttpHeader, a NULL terminated ASCII string.\r
+  @param[in]      FieldValue          FieldValue of this HttpHeader, a NULL terminated ASCII string.\r
+\r
+\r
+  @retval EFI_SUCCESS             The FieldName and FieldValue are set into HttpHeader successfully.\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HttpSetFieldNameAndValue (\r
+   IN  OUT   EFI_HTTP_HEADER       *HttpHeader,\r
+   IN  CONST CHAR8                 *FieldName,\r
+   IN  CONST CHAR8                 *FieldValue\r
+  );\r
+\r
+/**\r
+  Get one key/value header pair from the raw string.\r
+\r
+  @param[in]  String             Pointer to the raw string.\r
+  @param[out] FieldName          Points directly to field name within 'HttpHeader'.\r
+  @param[out] FieldValue         Points directly to field value within 'HttpHeader'.\r
+\r
+  @return     Pointer to the next raw string.\r
+  @return     NULL if no key/value header pair from this raw string.\r
+\r
+**/\r
+CHAR8 *\r
+EFIAPI\r
+HttpGetFieldNameAndValue (\r
+  IN     CHAR8   *String,\r
+     OUT CHAR8   **FieldName,\r
+     OUT CHAR8   **FieldValue\r
+  );\r
+\r
+/**\r
+  Free existing HeaderFields.\r
+\r
+  @param[in]  HeaderFields       Pointer to array of key/value header pairs waiting for free.\r
+  @param[in]  FieldCount         The number of header pairs in HeaderFields.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HttpFreeHeaderFields (\r
+  IN  EFI_HTTP_HEADER  *HeaderFields,\r
+  IN  UINTN            FieldCount\r
+  );\r
+\r
+/**\r
+  Generate HTTP request string.\r
+\r
+  @param[in]   Message            Pointer to storage containing HTTP message data.\r
+  @param[in]   Url                The URL of a remote host.\r
+  @param[out]  RequestString      Pointer to the created HTTP request string.\r
+                                  NULL if any error occured.\r
+\r
+  @return EFI_SUCCESS             If HTTP request string was created successfully\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate resources.\r
+  @retval EFI_INVALID_PARAMETER   The input arguments are invalid\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HttpGenRequestString (\r
+  IN     CONST EFI_HTTP_MESSAGE        *Message,\r
+  IN     CONST CHAR8                   *Url,\r
+     OUT CHAR8                         **RequestString\r
+  );\r
+\r
+/**\r
+  Translate the status code in HTTP message to EFI_HTTP_STATUS_CODE defined\r
+  in UEFI 2.5 specification.\r
+\r
+  @param[in]  StatusCode         The status code value in HTTP message.\r
+\r
+  @return                        Value defined in EFI_HTTP_STATUS_CODE .\r
+\r
+**/\r
+EFI_HTTP_STATUS_CODE\r
+EFIAPI\r
+HttpMappingToStatusCode (\r
+  IN UINTN                  StatusCode\r
+  );\r
+\r
+/**\r
+  Check whether header field called FieldName is in DeleteList.\r
+\r
+  @param[in]  DeleteList        Pointer to array of key/value header pairs.\r
+  @param[in]  DeleteCount       The number of header pairs.\r
+  @param[in]  FieldName         Pointer to header field's name.\r
+\r
+  @return     TRUE if FieldName is not in DeleteList, that means this header field is valid.\r
+  @return     FALSE if FieldName is in DeleteList, that means this header field is invalid.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HttpIsValidHttpHeader (\r
+  IN  CHAR8            *DeleteList[],\r
+  IN  UINTN            DeleteCount,\r
+  IN  CHAR8            *FieldName\r
+  );\r
+\r
+\r
 #endif\r
 \r
index 49c2b9c99e92c5c29be874cf2a85eabe7d02084a..662c40c644b1e8f69f97f46915e0dff01b6ce4ea 100644 (file)
@@ -3,6 +3,7 @@
   It provides the helper routines to parse the HTTP message byte stream.\r
 \r
 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2016 Hewlett Packard Enterprise Development LP<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
@@ -13,68 +14,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \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
+#include "DxeHttpLib.h"\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
-  UrlParserHostIpv6,      // "["(Ipv6 address) "]"\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
@@ -869,14 +811,15 @@ HttpUrlFreeParser (
 \r
 **/\r
 EFI_HTTP_HEADER *\r
-HttpIoFindHeader (\r
+EFIAPI\r
+HttpFindHeader (\r
   IN  UINTN                HeaderCount,\r
   IN  EFI_HTTP_HEADER      *Headers,\r
   IN  CHAR8                *FieldName\r
   )\r
 {\r
   UINTN                 Index;\r
-  \r
+\r
   if (HeaderCount == 0 || Headers == NULL || FieldName == NULL) {\r
     return NULL;\r
   }\r
@@ -914,7 +857,7 @@ typedef struct {
   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
+\r
   HTTP_BODY_PARSER_CALLBACK     Callback;\r
   VOID                          *Context;\r
   UINTN                         ParsedBodyLength;\r
@@ -983,8 +926,8 @@ HttpIoParseContentLengthHeader (
   )\r
 {\r
   EFI_HTTP_HEADER       *Header;\r
-  \r
-  Header = HttpIoFindHeader (HeaderCount, Headers, "Content-Length");\r
+\r
+  Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_CONTENT_LENGTH);\r
   if (Header == NULL) {\r
     return EFI_NOT_FOUND;\r
   }\r
@@ -1012,7 +955,7 @@ HttpIoIsChunked (
   EFI_HTTP_HEADER       *Header;\r
 \r
 \r
-  Header = HttpIoFindHeader (HeaderCount, Headers, "Transfer-Encoding");\r
+  Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_TRANSFER_ENCODING);\r
   if (Header == NULL) {\r
     return FALSE;\r
   }\r
@@ -1484,3 +1427,523 @@ HttpFreeMsgParser (
 {\r
   FreePool (MsgParser);\r
 }\r
+\r
+\r
+/**\r
+  Get the next string, which is distinguished by specified seperator.\r
+\r
+  @param[in]  String             Pointer to the string.\r
+  @param[in]  Seperator          Specified seperator used to distinguish where is the beginning\r
+                                 of next string.\r
+\r
+  @return     Pointer to the next string.\r
+  @return     NULL if not find or String is NULL.\r
+\r
+**/\r
+CHAR8 *\r
+EFIAPI\r
+AsciiStrGetNextToken (\r
+  IN CONST CHAR8 *String,\r
+  IN       CHAR8 Seperator\r
+  )\r
+{\r
+  CONST CHAR8 *Token;\r
+\r
+  Token = String;\r
+  while (TRUE) {\r
+    if (*Token == 0) {\r
+      return NULL;\r
+    }\r
+    if (*Token == Seperator) {\r
+      return (CHAR8 *)(Token + 1);\r
+    }\r
+    Token++;\r
+  }\r
+}\r
+\r
+/**\r
+  Set FieldName and FieldValue into specified HttpHeader.\r
+\r
+  @param[in,out]  HttpHeader      Specified HttpHeader.\r
+  @param[in]  FieldName           FieldName of this HttpHeader, a NULL terminated ASCII string.\r
+  @param[in]  FieldValue          FieldValue of this HttpHeader, a NULL terminated ASCII string.\r
+\r
+\r
+  @retval EFI_SUCCESS             The FieldName and FieldValue are set into HttpHeader successfully.\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HttpSetFieldNameAndValue (\r
+  IN  OUT   EFI_HTTP_HEADER       *HttpHeader,\r
+  IN  CONST CHAR8                 *FieldName,\r
+  IN  CONST CHAR8                 *FieldValue\r
+  )\r
+{\r
+  UINTN                       FieldNameSize;\r
+  UINTN                       FieldValueSize;\r
+\r
+  if (HttpHeader->FieldName != NULL) {\r
+    FreePool (HttpHeader->FieldName);\r
+  }\r
+  if (HttpHeader->FieldValue != NULL) {\r
+    FreePool (HttpHeader->FieldValue);\r
+  }\r
+\r
+  FieldNameSize = AsciiStrSize (FieldName);\r
+  HttpHeader->FieldName = AllocateZeroPool (FieldNameSize);\r
+  if (HttpHeader->FieldName == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+  CopyMem (HttpHeader->FieldName, FieldName, FieldNameSize);\r
+  HttpHeader->FieldName[FieldNameSize - 1] = 0;\r
+\r
+  FieldValueSize = AsciiStrSize (FieldValue);\r
+  HttpHeader->FieldValue = AllocateZeroPool (FieldValueSize);\r
+  if (HttpHeader->FieldValue == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+  CopyMem (HttpHeader->FieldValue, FieldValue, FieldValueSize);\r
+  HttpHeader->FieldValue[FieldValueSize - 1] = 0;\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Get one key/value header pair from the raw string.\r
+\r
+  @param[in]  String             Pointer to the raw string.\r
+  @param[out] FieldName          Points directly to field name within 'HttpHeader'.\r
+  @param[out] FieldValue         Points directly to field value within 'HttpHeader'.\r
+\r
+  @return     Pointer to the next raw string.\r
+  @return     NULL if no key/value header pair from this raw string.\r
+\r
+**/\r
+CHAR8 *\r
+EFIAPI\r
+HttpGetFieldNameAndValue (\r
+  IN     CHAR8   *String,\r
+     OUT CHAR8   **FieldName,\r
+     OUT CHAR8   **FieldValue\r
+  )\r
+{\r
+  CHAR8  *FieldNameStr;\r
+  CHAR8  *FieldValueStr;\r
+  CHAR8  *StrPtr;\r
+\r
+  if (String == NULL || FieldName == NULL || FieldValue == NULL) {\r
+    return NULL;\r
+  }\r
+\r
+  *FieldName    = NULL;\r
+  *FieldValue   = NULL;\r
+  FieldNameStr  = NULL;\r
+  FieldValueStr = NULL;\r
+  StrPtr        = NULL;\r
+\r
+  //\r
+  // Each header field consists of a name followed by a colon (":") and the field value.\r
+  //\r
+  FieldNameStr = String;\r
+  FieldValueStr = AsciiStrGetNextToken (FieldNameStr, ':');\r
+  if (FieldValueStr == NULL) {\r
+    return NULL;\r
+  }\r
+\r
+  //\r
+  // Replace ':' with 0\r
+  //\r
+  *(FieldValueStr - 1) = 0;\r
+\r
+  //\r
+  // The field value MAY be preceded by any amount of LWS, though a single SP is preferred.\r
+  //\r
+  while (TRUE) {\r
+    if (*FieldValueStr == ' ' || *FieldValueStr == '\t') {\r
+      FieldValueStr ++;\r
+    } else if (*FieldValueStr == '\r' && *(FieldValueStr + 1) == '\n' &&\r
+               (*(FieldValueStr + 2) == ' ' || *(FieldValueStr + 2) == '\t')) {\r
+      FieldValueStr = FieldValueStr + 3;\r
+    } else {\r
+      break;\r
+    }\r
+  }\r
+\r
+  //\r
+  // Header fields can be extended over multiple lines by preceding each extra\r
+  // line with at least one SP or HT.\r
+  //\r
+  StrPtr = FieldValueStr;\r
+  do {\r
+    StrPtr = AsciiStrGetNextToken (StrPtr, '\r');\r
+    if (StrPtr == NULL || *StrPtr != '\n') {\r
+      return NULL;\r
+    }\r
+\r
+    StrPtr++;\r
+  } while (*StrPtr == ' ' || *StrPtr == '\t');\r
+\r
+  //\r
+  // Replace '\r' with 0\r
+  //\r
+  *(StrPtr - 2) = 0;\r
+\r
+  //\r
+  // Get FieldName and FieldValue.\r
+  //\r
+  *FieldName = FieldNameStr;\r
+  *FieldValue = FieldValueStr;\r
+\r
+  return StrPtr;\r
+}\r
+\r
+/**\r
+  Free existing HeaderFields.\r
+\r
+  @param[in]  HeaderFields       Pointer to array of key/value header pairs waitting for free.\r
+  @param[in]  FieldCount         The number of header pairs in HeaderFields.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HttpFreeHeaderFields (\r
+  IN  EFI_HTTP_HEADER  *HeaderFields,\r
+  IN  UINTN            FieldCount\r
+  )\r
+{\r
+  UINTN                       Index;\r
+\r
+  if (HeaderFields != NULL) {\r
+    for (Index = 0; Index < FieldCount; Index++) {\r
+      if (HeaderFields[Index].FieldName != NULL) {\r
+        FreePool (HeaderFields[Index].FieldName);\r
+      }\r
+      if (HeaderFields[Index].FieldValue != NULL) {\r
+        FreePool (HeaderFields[Index].FieldValue);\r
+      }\r
+    }\r
+\r
+    FreePool (HeaderFields);\r
+  }\r
+}\r
+\r
+/**\r
+  Generate HTTP request string.\r
+\r
+  @param[in]   Message            Pointer to storage containing HTTP message data.\r
+  @param[in]   Url                The URL of a remote host.\r
+  @param[out]  RequestString      Pointer to the created HTTP request string.\r
+                                  NULL if any error occured.\r
+\r
+  @return EFI_SUCCESS             If HTTP request string was created successfully\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate resources.\r
+  @retval EFI_INVALID_PARAMETER   The input arguments are invalid\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HttpGenRequestString (\r
+  IN     CONST EFI_HTTP_MESSAGE        *Message,\r
+  IN     CONST CHAR8                   *Url,\r
+     OUT CHAR8                         **Request\r
+  )\r
+{\r
+  EFI_STATUS                       Status;\r
+  UINTN                            StrLength;\r
+  CHAR8                            *RequestPtr;\r
+  UINTN                            HttpHdrSize;\r
+  UINTN                            MsgSize;\r
+  BOOLEAN                          Success;\r
+  VOID                             *HttpHdr;\r
+  EFI_HTTP_HEADER                  **AppendList;\r
+  UINTN                            Index;\r
+  EFI_HTTP_UTILITIES_PROTOCOL      *HttpUtilitiesProtocol;\r
+\r
+\r
+  ASSERT (Message != NULL);\r
+\r
+  *Request = NULL;\r
+  MsgSize = 0;\r
+  Success = FALSE;\r
+  HttpHdr = NULL;\r
+  AppendList = NULL;\r
+  HttpUtilitiesProtocol = NULL;\r
+\r
+  //\r
+  // Locate the HTTP_UTILITIES protocol.\r
+  //\r
+  Status = gBS->LocateProtocol (\r
+                  &gEfiHttpUtilitiesProtocolGuid,\r
+                  NULL,\r
+                  (VOID **)&HttpUtilitiesProtocol\r
+                  );\r
+\r
+  if (EFI_ERROR (Status)) {\r
+    DEBUG ((DEBUG_ERROR,"Failed to locate Http Utilities protocol. Status = %r.\n", Status));\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Build AppendList to send into HttpUtilitiesBuild\r
+  //\r
+  AppendList = AllocateZeroPool (sizeof (EFI_HTTP_HEADER *) * (Message->HeaderCount));\r
+  if (AppendList == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  for(Index = 0; Index < Message->HeaderCount; Index++){\r
+    AppendList[Index] = &Message->Headers[Index];\r
+  }\r
+\r
+  //\r
+  // Build raw HTTP Headers\r
+  //\r
+  Status = HttpUtilitiesProtocol->Build (\r
+              HttpUtilitiesProtocol,\r
+              0,\r
+              NULL,\r
+              0,\r
+              NULL,\r
+              Message->HeaderCount,\r
+              AppendList,\r
+              &HttpHdrSize,\r
+              &HttpHdr\r
+              );\r
+\r
+  if (AppendList != NULL) {\r
+    FreePool (AppendList);\r
+  }\r
+\r
+  if (EFI_ERROR (Status) || HttpHdr == NULL){\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Calculate HTTP message length.\r
+  //\r
+  MsgSize = Message->BodyLength + HTTP_METHOD_MAXIMUM_LEN + AsciiStrLen (Url) +\r
+            AsciiStrLen (HTTP_VERSION_CRLF_STR) + HttpHdrSize;\r
+\r
+\r
+  *Request = AllocateZeroPool (MsgSize);\r
+  if (*Request == NULL) {\r
+    Status = EFI_OUT_OF_RESOURCES;\r
+    goto Exit;\r
+  }\r
+\r
+  RequestPtr = *Request;\r
+  //\r
+  // Construct header request\r
+  //\r
+  switch (Message->Data.Request->Method) {\r
+  case HttpMethodGet:\r
+    StrLength = sizeof (HTTP_METHOD_GET) - 1;\r
+    CopyMem (RequestPtr, HTTP_METHOD_GET, StrLength);\r
+    RequestPtr += StrLength;\r
+    break;\r
+  case HttpMethodPut:\r
+    StrLength = sizeof (HTTP_METHOD_PUT) - 1;\r
+    CopyMem (RequestPtr, HTTP_METHOD_PUT, StrLength);\r
+    RequestPtr += StrLength;\r
+    break;\r
+  case HttpMethodPatch:\r
+    StrLength = sizeof (HTTP_METHOD_PATCH) - 1;\r
+    CopyMem (RequestPtr, HTTP_METHOD_PATCH, StrLength);\r
+    RequestPtr += StrLength;\r
+    break;\r
+  case HttpMethodPost:\r
+    StrLength = sizeof (HTTP_METHOD_POST) - 1;\r
+    CopyMem (RequestPtr, HTTP_METHOD_POST, StrLength);\r
+    RequestPtr += StrLength;\r
+    break;\r
+  case HttpMethodHead:\r
+    StrLength = sizeof (HTTP_METHOD_HEAD) - 1;\r
+    CopyMem (RequestPtr, HTTP_METHOD_HEAD, StrLength);\r
+    RequestPtr += StrLength;\r
+    break;\r
+  case HttpMethodDelete:\r
+    StrLength = sizeof (HTTP_METHOD_DELETE) - 1;\r
+    CopyMem (RequestPtr, HTTP_METHOD_DELETE, StrLength);\r
+    RequestPtr += StrLength;\r
+    break;\r
+  default:\r
+    ASSERT (FALSE);\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto Exit;\r
+  }\r
+\r
+  StrLength = AsciiStrLen(EMPTY_SPACE);\r
+  CopyMem (RequestPtr, EMPTY_SPACE, StrLength);\r
+  RequestPtr += StrLength;\r
+\r
+  StrLength = AsciiStrLen (Url);\r
+  CopyMem (RequestPtr, Url, StrLength);\r
+  RequestPtr += StrLength;\r
+\r
+  StrLength = sizeof (HTTP_VERSION_CRLF_STR) - 1;\r
+  CopyMem (RequestPtr, HTTP_VERSION_CRLF_STR, StrLength);\r
+  RequestPtr += StrLength;\r
+\r
+  //\r
+  // Construct header\r
+  //\r
+  CopyMem (RequestPtr, HttpHdr, HttpHdrSize);\r
+  RequestPtr += HttpHdrSize;\r
+\r
+  //\r
+  // Done\r
+  //\r
+  *RequestPtr = 0;\r
+  Success     = TRUE;\r
+\r
+Exit:\r
+\r
+  if (!Success) {\r
+    if (*Request != NULL) {\r
+      FreePool (*Request);\r
+    }\r
+    *Request = NULL;\r
+    return Status;\r
+  }\r
+\r
+  if (HttpHdr != NULL) {\r
+    FreePool (HttpHdr);\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Translate the status code in HTTP message to EFI_HTTP_STATUS_CODE defined\r
+  in UEFI 2.5 specification.\r
+\r
+  @param[in]  StatusCode         The status code value in HTTP message.\r
+\r
+  @return                        Value defined in EFI_HTTP_STATUS_CODE .\r
+\r
+**/\r
+EFI_HTTP_STATUS_CODE\r
+EFIAPI\r
+HttpMappingToStatusCode (\r
+  IN UINTN                  StatusCode\r
+  )\r
+{\r
+  switch (StatusCode) {\r
+  case 100:\r
+    return HTTP_STATUS_100_CONTINUE;\r
+  case 101:\r
+    return HTTP_STATUS_101_SWITCHING_PROTOCOLS;\r
+  case 200:\r
+    return HTTP_STATUS_200_OK;\r
+  case 201:\r
+    return HTTP_STATUS_201_CREATED;\r
+  case 202:\r
+    return HTTP_STATUS_202_ACCEPTED;\r
+  case 203:\r
+    return HTTP_STATUS_203_NON_AUTHORITATIVE_INFORMATION;\r
+  case 204:\r
+    return HTTP_STATUS_204_NO_CONTENT;\r
+  case 205:\r
+    return HTTP_STATUS_205_RESET_CONTENT;\r
+  case 206:\r
+    return HTTP_STATUS_206_PARTIAL_CONTENT;\r
+  case 300:\r
+    return HTTP_STATUS_300_MULTIPLE_CHIOCES;\r
+  case 301:\r
+    return HTTP_STATUS_301_MOVED_PERMANENTLY;\r
+  case 302:\r
+    return HTTP_STATUS_302_FOUND;\r
+  case 303:\r
+    return HTTP_STATUS_303_SEE_OTHER;\r
+  case 304:\r
+    return HTTP_STATUS_304_NOT_MODIFIED;\r
+  case 305:\r
+    return HTTP_STATUS_305_USE_PROXY;\r
+  case 307:\r
+    return HTTP_STATUS_307_TEMPORARY_REDIRECT;\r
+  case 400:\r
+    return HTTP_STATUS_400_BAD_REQUEST;\r
+  case 401:\r
+    return HTTP_STATUS_401_UNAUTHORIZED;\r
+  case 402:\r
+    return HTTP_STATUS_402_PAYMENT_REQUIRED;\r
+  case 403:\r
+    return HTTP_STATUS_403_FORBIDDEN;\r
+  case 404:\r
+    return HTTP_STATUS_404_NOT_FOUND;\r
+  case 405:\r
+    return HTTP_STATUS_405_METHOD_NOT_ALLOWED;\r
+  case 406:\r
+    return HTTP_STATUS_406_NOT_ACCEPTABLE;\r
+  case 407:\r
+    return HTTP_STATUS_407_PROXY_AUTHENTICATION_REQUIRED;\r
+  case 408:\r
+    return HTTP_STATUS_408_REQUEST_TIME_OUT;\r
+  case 409:\r
+    return HTTP_STATUS_409_CONFLICT;\r
+  case 410:\r
+    return HTTP_STATUS_410_GONE;\r
+  case 411:\r
+    return HTTP_STATUS_411_LENGTH_REQUIRED;\r
+  case 412:\r
+    return HTTP_STATUS_412_PRECONDITION_FAILED;\r
+  case 413:\r
+    return HTTP_STATUS_413_REQUEST_ENTITY_TOO_LARGE;\r
+  case 414:\r
+    return HTTP_STATUS_414_REQUEST_URI_TOO_LARGE;\r
+  case 415:\r
+    return HTTP_STATUS_415_UNSUPPORTED_MEDIA_TYPE;\r
+  case 416:\r
+    return HTTP_STATUS_416_REQUESTED_RANGE_NOT_SATISFIED;\r
+  case 417:\r
+    return HTTP_STATUS_417_EXPECTATION_FAILED;\r
+  case 500:\r
+    return HTTP_STATUS_500_INTERNAL_SERVER_ERROR;\r
+  case 501:\r
+    return HTTP_STATUS_501_NOT_IMPLEMENTED;\r
+  case 502:\r
+    return HTTP_STATUS_502_BAD_GATEWAY;\r
+  case 503:\r
+    return HTTP_STATUS_503_SERVICE_UNAVAILABLE;\r
+  case 504:\r
+    return HTTP_STATUS_504_GATEWAY_TIME_OUT;\r
+  case 505:\r
+    return HTTP_STATUS_505_HTTP_VERSION_NOT_SUPPORTED;\r
+\r
+  default:\r
+    return HTTP_STATUS_UNSUPPORTED_STATUS;\r
+  }\r
+}\r
+\r
+/**\r
+  Check whether header field called FieldName is in DeleteList.\r
+\r
+  @param[in]  DeleteList        Pointer to array of key/value header pairs.\r
+  @param[in]  DeleteCount       The number of header pairs.\r
+  @param[in]  FieldName         Pointer to header field's name.\r
+\r
+  @return     TRUE if FieldName is not in DeleteList, that means this header field is valid.\r
+  @return     FALSE if FieldName is in DeleteList, that means this header field is invalid.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HttpIsValidHttpHeader (\r
+  IN  CHAR8            *DeleteList[],\r
+  IN  UINTN            DeleteCount,\r
+  IN  CHAR8            *FieldName\r
+  )\r
+{\r
+  UINTN                       Index;\r
+\r
+  for (Index = 0; Index < DeleteCount; Index++) {\r
+    if (AsciiStrCmp (FieldName, DeleteList[Index]) == 0) {\r
+      return FALSE;\r
+    }\r
+  }\r
+\r
+  return TRUE;\r
+}\r
+\r
diff --git a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.h b/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.h
new file mode 100644 (file)
index 0000000..0d0ad3d
--- /dev/null
@@ -0,0 +1,89 @@
+/** @file\r
+Header file for HttpLib.\r
+\r
+  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
+  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
+\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\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
+#ifndef _DXE_HTTP_LIB_H_\r
+#define _DXE_HTTP_LIB_H_\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
+#include <IndustryStandard/Http11.h>\r
+#include <Protocol/HttpUtilities.h>\r
+\r
+#define BIT(x)  (1 << x)\r
+\r
+#define HTTP_VERSION_CRLF_STR  " HTTP/1.1\r\n"\r
+#define EMPTY_SPACE            " "\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
+  UrlParserHostIpv6,      // "["(Ipv6 address) "]"\r
+  UrlParserPortStart,     // ":"\r
+  UrlParserPort,\r
+  UrlParserStateMax\r
+} HTTP_URL_PARSE_STATE;\r
+\r
+#endif\r
+\r
index e26f6fa6913168a46a1965c61c84b187149f888e..99fbe8da84870c9b4cbad7ab81f801f319cfc901 100644 (file)
@@ -2,6 +2,7 @@
 #  It provides the helper routines to parse the HTTP message byte stream.\r
 #\r
 #  Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
+#  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<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\r
@@ -30,6 +31,7 @@
 \r
 [Sources]\r
   DxeHttpLib.c\r
+  DxeHttpLib.h\r
 \r
 [Packages]\r
   MdePkg/MdePkg.dec\r
@@ -40,3 +42,7 @@
   DebugLib\r
   UefiBootServicesTableLib\r
   MemoryAllocationLib\r
+  NetLib\r
+\r
+[Protocols]\r
+  gEfiHttpUtilitiesProtocolGuid\r