2 This library is used to share code between UEFI network stack modules.
3 It provides the helper routines to parse the HTTP message byte stream.
5 Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
6 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at<BR>
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "DxeHttpLib.h"
22 Decode a percent-encoded URI component to the ASCII character.
24 Decode the input component in Buffer according to RFC 3986. The caller is responsible to make
25 sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer))
28 @param[in] Buffer The pointer to a percent-encoded URI component.
29 @param[in] BufferLength Length of Buffer in bytes.
30 @param[out] ResultBuffer Point to the buffer to store the decode result.
31 @param[out] ResultLength Length of decoded string in ResultBuffer in bytes.
33 @retval EFI_SUCCESS Successfully decoded the URI.
34 @retval EFI_INVALID_PARAMETER Buffer is not a valid percent-encoded string.
41 IN UINT32 BufferLength
,
42 OUT CHAR8
*ResultBuffer
,
43 OUT UINT32
*ResultLength
50 if (Buffer
== NULL
|| BufferLength
== 0 || ResultBuffer
== NULL
) {
51 return EFI_INVALID_PARAMETER
;
57 while (Index
< BufferLength
) {
58 if (Buffer
[Index
] == '%') {
59 if (!NET_IS_HEX_CHAR (Buffer
[Index
+1]) || !NET_IS_HEX_CHAR (Buffer
[Index
+2])) {
60 return EFI_INVALID_PARAMETER
;
62 HexStr
[0] = Buffer
[Index
+1];
63 HexStr
[1] = Buffer
[Index
+2];
64 ResultBuffer
[Offset
] = (CHAR8
) AsciiStrHexToUintn (HexStr
);
67 ResultBuffer
[Offset
] = Buffer
[Index
];
73 *ResultLength
= (UINT32
) Offset
;
79 This function return the updated state according to the input state and next character of
82 @param[in] Char Next character.
83 @param[in] State Current value of the parser state machine.
84 @param[in] IsRightBracket TRUE if there is an sign ']' in the authority component and
85 indicates the next part is ':' before Port.
87 @return Updated state value.
90 NetHttpParseAuthorityChar (
92 IN HTTP_URL_PARSE_STATE State
,
93 IN BOOLEAN
*IsRightBracket
99 // The authority component is preceded by a double slash ("//") and is
100 // terminated by the next slash ("/"), question mark ("?"), or number
101 // sign ("#") character, or by the end of the URI.
103 if (Char
== ' ' || Char
== '\r' || Char
== '\n') {
104 return UrlParserStateMax
;
108 // authority = [ userinfo "@" ] host [ ":" port ]
111 case UrlParserUserInfo
:
113 return UrlParserHostStart
;
118 case UrlParserHostStart
:
120 return UrlParserHostIpv6
;
124 return UrlParserPortStart
;
127 return UrlParserHost
;
129 case UrlParserHostIpv6
:
131 *IsRightBracket
= TRUE
;
134 if (Char
== ':' && *IsRightBracket
) {
135 return UrlParserPortStart
;
137 return UrlParserHostIpv6
;
140 case UrlParserPortStart
:
141 return UrlParserPort
;
151 This function parse the authority component of the input URL and update the parser.
153 @param[in] Url The pointer to a HTTP URL string.
154 @param[in] FoundAt TRUE if there is an at sign ('@') in the authority component.
155 @param[in, out] UrlParser Pointer to the buffer of the parse result.
157 @retval EFI_SUCCESS Successfully parse the authority.
158 @retval Other Error happened.
162 NetHttpParseAuthority (
165 IN OUT HTTP_URL_PARSER
*UrlParser
171 HTTP_URL_PARSE_STATE State
;
174 BOOLEAN IsrightBracket
;
176 ASSERT ((UrlParser
->FieldBitMap
& BIT (HTTP_URI_FIELD_AUTHORITY
)) != 0);
179 // authority = [ userinfo "@" ] host [ ":" port ]
182 State
= UrlParserUserInfo
;
184 State
= UrlParserHost
;
187 IsrightBracket
= FALSE
;
188 Field
= HTTP_URI_FIELD_MAX
;
190 Authority
= Url
+ UrlParser
->FieldData
[HTTP_URI_FIELD_AUTHORITY
].Offset
;
191 Length
= UrlParser
->FieldData
[HTTP_URI_FIELD_AUTHORITY
].Length
;
192 for (Char
= Authority
; Char
< Authority
+ Length
; Char
++) {
193 State
= NetHttpParseAuthorityChar (*Char
, State
, &IsrightBracket
);
195 case UrlParserStateMax
:
196 return EFI_INVALID_PARAMETER
;
198 case UrlParserHostStart
:
199 case UrlParserPortStart
:
202 case UrlParserUserInfo
:
203 Field
= HTTP_URI_FIELD_USERINFO
;
207 Field
= HTTP_URI_FIELD_HOST
;
210 case UrlParserHostIpv6
:
211 Field
= HTTP_URI_FIELD_HOST
;
215 Field
= HTTP_URI_FIELD_PORT
;
223 // Field not changed, count the length.
225 ASSERT (Field
< HTTP_URI_FIELD_MAX
);
226 if (Field
== OldField
) {
227 UrlParser
->FieldData
[Field
].Length
++;
234 UrlParser
->FieldBitMap
|= BIT (Field
);
235 UrlParser
->FieldData
[Field
].Offset
= (UINT32
) (Char
- Url
);
236 UrlParser
->FieldData
[Field
].Length
= 1;
244 This function return the updated state according to the input state and next character of a URL.
246 @param[in] Char Next character.
247 @param[in] State Current value of the parser state machine.
249 @return Updated state value.
253 NetHttpParseUrlChar (
255 IN HTTP_URL_PARSE_STATE State
258 if (Char
== ' ' || Char
== '\r' || Char
== '\n') {
259 return UrlParserStateMax
;
263 // http_URL = "http:" "//" host [ ":" port ] [ abs_path [ "?" query ]]
265 // Request-URI = "*" | absolute-URI | path-absolute | authority
267 // absolute-URI = scheme ":" hier-part [ "?" query ]
268 // path-absolute = "/" [ segment-nz *( "/" segment ) ]
269 // authority = [ userinfo "@" ] host [ ":" port ]
272 case UrlParserUrlStart
:
273 if (Char
== '*' || Char
== '/') {
274 return UrlParserPath
;
276 return UrlParserScheme
;
278 case UrlParserScheme
:
280 return UrlParserSchemeColon
;
284 case UrlParserSchemeColon
:
286 return UrlParserSchemeColonSlash
;
290 case UrlParserSchemeColonSlash
:
292 return UrlParserSchemeColonSlashSlash
;
296 case UrlParserAtInAuthority
:
298 return UrlParserStateMax
;
301 case UrlParserAuthority
:
302 case UrlParserSchemeColonSlashSlash
:
304 return UrlParserAtInAuthority
;
307 return UrlParserPath
;
310 return UrlParserQueryStart
;
313 return UrlParserFragmentStart
;
315 return UrlParserAuthority
;
319 return UrlParserQueryStart
;
322 return UrlParserFragmentStart
;
327 case UrlParserQueryStart
:
329 return UrlParserFragmentStart
;
331 return UrlParserQuery
;
333 case UrlParserFragmentStart
:
334 return UrlParserFragment
;
343 Create a URL parser for the input URL string.
345 This function will parse and dereference the input HTTP URL into it components. The original
346 content of the URL won't be modified and the result will be returned in UrlParser, which can
347 be used in other functions like NetHttpUrlGetHostName().
349 @param[in] Url The pointer to a HTTP URL string.
350 @param[in] Length Length of Url in bytes.
351 @param[in] IsConnectMethod Whether the Url is used in HTTP CONNECT method or not.
352 @param[out] UrlParser Pointer to the returned buffer to store the parse result.
354 @retval EFI_SUCCESS Successfully dereferenced the HTTP URL.
355 @retval EFI_INVALID_PARAMETER UrlParser is NULL or Url is not a valid HTTP URL.
356 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
364 IN BOOLEAN IsConnectMethod
,
368 HTTP_URL_PARSE_STATE State
;
374 HTTP_URL_PARSER
*Parser
;
376 if (Url
== NULL
|| Length
== 0 || UrlParser
== NULL
) {
377 return EFI_INVALID_PARAMETER
;
380 Parser
= AllocateZeroPool (sizeof (HTTP_URL_PARSER
));
381 if (Parser
== NULL
) {
382 return EFI_OUT_OF_RESOURCES
;
385 if (IsConnectMethod
) {
387 // According to RFC 2616, the authority form is only used by the CONNECT method.
389 State
= UrlParserAuthority
;
391 State
= UrlParserUrlStart
;
394 Field
= HTTP_URI_FIELD_MAX
;
397 for (Char
= Url
; Char
< Url
+ Length
; Char
++) {
399 // Update state machine according to next char.
401 State
= NetHttpParseUrlChar (*Char
, State
);
404 case UrlParserStateMax
:
405 return EFI_INVALID_PARAMETER
;
407 case UrlParserSchemeColon
:
408 case UrlParserSchemeColonSlash
:
409 case UrlParserSchemeColonSlashSlash
:
410 case UrlParserQueryStart
:
411 case UrlParserFragmentStart
:
413 // Skip all the delimiting char: "://" "?" "@"
417 case UrlParserScheme
:
418 Field
= HTTP_URI_FIELD_SCHEME
;
421 case UrlParserAtInAuthority
:
423 case UrlParserAuthority
:
424 Field
= HTTP_URI_FIELD_AUTHORITY
;
428 Field
= HTTP_URI_FIELD_PATH
;
432 Field
= HTTP_URI_FIELD_QUERY
;
435 case UrlParserFragment
:
436 Field
= HTTP_URI_FIELD_FRAGMENT
;
444 // Field not changed, count the length.
446 ASSERT (Field
< HTTP_URI_FIELD_MAX
);
447 if (Field
== OldField
) {
448 Parser
->FieldData
[Field
].Length
++;
455 Parser
->FieldBitMap
|= BIT (Field
);
456 Parser
->FieldData
[Field
].Offset
= (UINT32
) (Char
- Url
);
457 Parser
->FieldData
[Field
].Length
= 1;
462 // If has authority component, continue to parse the username, host and port.
464 if ((Parser
->FieldBitMap
& BIT (HTTP_URI_FIELD_AUTHORITY
)) != 0) {
465 Status
= NetHttpParseAuthority (Url
, FoundAt
, Parser
);
466 if (EFI_ERROR (Status
)) {
476 Get the Hostname from a HTTP URL.
478 This function will return the HostName according to the Url and previous parse result ,and
479 it is the caller's responsibility to free the buffer returned in *HostName.
481 @param[in] Url The pointer to a HTTP URL string.
482 @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
483 @param[out] HostName Pointer to a buffer to store the HostName.
485 @retval EFI_SUCCESS Successfully get the required component.
486 @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid.
487 @retval EFI_NOT_FOUND No hostName component in the URL.
488 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
502 HTTP_URL_PARSER
*Parser
;
504 if (Url
== NULL
|| UrlParser
== NULL
|| HostName
== NULL
) {
505 return EFI_INVALID_PARAMETER
;
508 Parser
= (HTTP_URL_PARSER
*) UrlParser
;
510 if ((Parser
->FieldBitMap
& BIT (HTTP_URI_FIELD_HOST
)) == 0) {
511 return EFI_NOT_FOUND
;
514 Name
= AllocatePool (Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Length
+ 1);
516 return EFI_OUT_OF_RESOURCES
;
519 Status
= UriPercentDecode (
520 Url
+ Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Offset
,
521 Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Length
,
525 if (EFI_ERROR (Status
)) {
529 Name
[ResultLength
] = '\0';
536 Get the IPv4 address from a HTTP URL.
538 This function will return the IPv4 address according to the Url and previous parse result.
540 @param[in] Url The pointer to a HTTP URL string.
541 @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
542 @param[out] Ip4Address Pointer to a buffer to store the IP address.
544 @retval EFI_SUCCESS Successfully get the required component.
545 @retval EFI_INVALID_PARAMETER Uri is NULL or Ip4Address is NULL or UrlParser is invalid.
546 @retval EFI_NOT_FOUND No IPv4 address component in the URL.
547 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
555 OUT EFI_IPv4_ADDRESS
*Ip4Address
561 HTTP_URL_PARSER
*Parser
;
563 if (Url
== NULL
|| UrlParser
== NULL
|| Ip4Address
== NULL
) {
564 return EFI_INVALID_PARAMETER
;
567 Parser
= (HTTP_URL_PARSER
*) UrlParser
;
569 if ((Parser
->FieldBitMap
& BIT (HTTP_URI_FIELD_HOST
)) == 0) {
570 return EFI_INVALID_PARAMETER
;
573 Ip4String
= AllocatePool (Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Length
+ 1);
574 if (Ip4String
== NULL
) {
575 return EFI_OUT_OF_RESOURCES
;
578 Status
= UriPercentDecode (
579 Url
+ Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Offset
,
580 Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Length
,
584 if (EFI_ERROR (Status
)) {
588 Ip4String
[ResultLength
] = '\0';
589 Status
= NetLibAsciiStrToIp4 (Ip4String
, Ip4Address
);
590 FreePool (Ip4String
);
596 Get the IPv6 address from a HTTP URL.
598 This function will return the IPv6 address according to the Url and previous parse result.
600 @param[in] Url The pointer to a HTTP URL string.
601 @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
602 @param[out] Ip6Address Pointer to a buffer to store the IP address.
604 @retval EFI_SUCCESS Successfully get the required component.
605 @retval EFI_INVALID_PARAMETER Uri is NULL or Ip6Address is NULL or UrlParser is invalid.
606 @retval EFI_NOT_FOUND No IPv6 address component in the URL.
607 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
615 OUT EFI_IPv6_ADDRESS
*Ip6Address
623 HTTP_URL_PARSER
*Parser
;
625 if (Url
== NULL
|| UrlParser
== NULL
|| Ip6Address
== NULL
) {
626 return EFI_INVALID_PARAMETER
;
629 Parser
= (HTTP_URL_PARSER
*) UrlParser
;
631 if ((Parser
->FieldBitMap
& BIT (HTTP_URI_FIELD_HOST
)) == 0) {
632 return EFI_INVALID_PARAMETER
;
636 // IP-literal = "[" ( IPv6address / IPvFuture ) "]"
638 Length
= Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Length
;
640 return EFI_INVALID_PARAMETER
;
643 Ptr
= Url
+ Parser
->FieldData
[HTTP_URI_FIELD_HOST
].Offset
;
644 if ((Ptr
[0] != '[') || (Ptr
[Length
- 1] != ']')) {
645 return EFI_INVALID_PARAMETER
;
648 Ip6String
= AllocatePool (Length
);
649 if (Ip6String
== NULL
) {
650 return EFI_OUT_OF_RESOURCES
;
653 Status
= UriPercentDecode (
659 if (EFI_ERROR (Status
)) {
663 Ip6String
[ResultLength
] = '\0';
664 Status
= NetLibAsciiStrToIp6 (Ip6String
, Ip6Address
);
665 FreePool (Ip6String
);
671 Get the port number from a HTTP URL.
673 This function will return the port number according to the Url and previous parse result.
675 @param[in] Url The pointer to a HTTP URL string.
676 @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
677 @param[out] Port Pointer to a buffer to store the port number.
679 @retval EFI_SUCCESS Successfully get the required component.
680 @retval EFI_INVALID_PARAMETER Uri is NULL or Port is NULL or UrlParser is invalid.
681 @retval EFI_NOT_FOUND No port number in the URL.
682 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
697 HTTP_URL_PARSER
*Parser
;
699 if (Url
== NULL
|| UrlParser
== NULL
|| Port
== NULL
) {
700 return EFI_INVALID_PARAMETER
;
703 Parser
= (HTTP_URL_PARSER
*) UrlParser
;
705 if ((Parser
->FieldBitMap
& BIT (HTTP_URI_FIELD_PORT
)) == 0) {
706 return EFI_INVALID_PARAMETER
;
709 PortString
= AllocatePool (Parser
->FieldData
[HTTP_URI_FIELD_PORT
].Length
+ 1);
710 if (PortString
== NULL
) {
711 return EFI_OUT_OF_RESOURCES
;
714 Status
= UriPercentDecode (
715 Url
+ Parser
->FieldData
[HTTP_URI_FIELD_PORT
].Offset
,
716 Parser
->FieldData
[HTTP_URI_FIELD_PORT
].Length
,
720 if (EFI_ERROR (Status
)) {
724 PortString
[ResultLength
] = '\0';
726 Status
= AsciiStrDecimalToUintnS (Url
+ Parser
->FieldData
[HTTP_URI_FIELD_PORT
].Offset
, (CHAR8
**) NULL
, &Data
);
728 *Port
= (UINT16
) Data
;
733 Get the Path from a HTTP URL.
735 This function will return the Path according to the Url and previous parse result,and
736 it is the caller's responsibility to free the buffer returned in *Path.
738 @param[in] Url The pointer to a HTTP URL string.
739 @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
740 @param[out] Path Pointer to a buffer to store the Path.
742 @retval EFI_SUCCESS Successfully get the required component.
743 @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid.
744 @retval EFI_NOT_FOUND No hostName component in the URL.
745 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
759 HTTP_URL_PARSER
*Parser
;
761 if (Url
== NULL
|| UrlParser
== NULL
|| Path
== NULL
) {
762 return EFI_INVALID_PARAMETER
;
765 Parser
= (HTTP_URL_PARSER
*) UrlParser
;
767 if ((Parser
->FieldBitMap
& BIT (HTTP_URI_FIELD_PATH
)) == 0) {
768 return EFI_NOT_FOUND
;
771 PathStr
= AllocatePool (Parser
->FieldData
[HTTP_URI_FIELD_PATH
].Length
+ 1);
772 if (PathStr
== NULL
) {
773 return EFI_OUT_OF_RESOURCES
;
776 Status
= UriPercentDecode (
777 Url
+ Parser
->FieldData
[HTTP_URI_FIELD_PATH
].Offset
,
778 Parser
->FieldData
[HTTP_URI_FIELD_PATH
].Length
,
782 if (EFI_ERROR (Status
)) {
786 PathStr
[ResultLength
] = '\0';
792 Release the resource of the URL parser.
794 @param[in] UrlParser Pointer to the parser.
803 FreePool (UrlParser
);
807 Find a specified header field according to the field name.
809 @param[in] HeaderCount Number of HTTP header structures in Headers list.
810 @param[in] Headers Array containing list of HTTP headers.
811 @param[in] FieldName Null terminated string which describes a field name.
813 @return Pointer to the found header or NULL.
819 IN UINTN HeaderCount
,
820 IN EFI_HTTP_HEADER
*Headers
,
826 if (HeaderCount
== 0 || Headers
== NULL
|| FieldName
== NULL
) {
830 for (Index
= 0; Index
< HeaderCount
; Index
++){
832 // Field names are case-insensitive (RFC 2616).
834 if (AsciiStriCmp (Headers
[Index
].FieldName
, FieldName
) == 0) {
835 return &Headers
[Index
];
843 BodyParserBodyIdentity
,
844 BodyParserChunkSizeStart
,
846 BodyParserChunkSizeEndCR
,
847 BodyParserChunkExtStart
,
848 BodyParserChunkDataStart
,
849 BodyParserChunkDataEnd
,
850 BodyParserChunkDataEndCR
,
853 BodyParserLastCRLFEnd
,
856 } HTTP_BODY_PARSE_STATE
;
859 BOOLEAN IgnoreBody
; // "MUST NOT" include a message-body
860 BOOLEAN IsChunked
; // "chunked" transfer-coding.
861 BOOLEAN ContentLengthIsValid
;
862 UINTN ContentLength
; // Entity length (not the message-body length), invalid until ContentLengthIsValid is TRUE
864 HTTP_BODY_PARSER_CALLBACK Callback
;
866 UINTN ParsedBodyLength
;
867 HTTP_BODY_PARSE_STATE State
;
868 UINTN CurrentChunkSize
;
869 UINTN CurrentChunkParsedSize
;
874 Convert an Ascii char to its uppercase.
876 @param[in] Char Ascii character.
878 @return Uppercase value of the input Char.
886 if (Char
>= 'a' && Char
<= 'z') {
887 return Char
- ('a' - 'A');
894 Convert an hexadecimal char to a value of type UINTN.
896 @param[in] Char Ascii character.
898 @return Value translated from Char.
902 HttpIoHexCharToUintn (
906 if (Char
>= '0' && Char
<= '9') {
910 return (10 + HttpIoCharToUpper (Char
) - 'A');
914 Get the value of the content length if there is a "Content-Length" header.
916 @param[in] HeaderCount Number of HTTP header structures in Headers.
917 @param[in] Headers Array containing list of HTTP headers.
918 @param[out] ContentLength Pointer to save the value of the content length.
920 @retval EFI_SUCCESS Successfully get the content length.
921 @retval EFI_NOT_FOUND No "Content-Length" header in the Headers.
925 HttpIoParseContentLengthHeader (
926 IN UINTN HeaderCount
,
927 IN EFI_HTTP_HEADER
*Headers
,
928 OUT UINTN
*ContentLength
931 EFI_HTTP_HEADER
*Header
;
933 Header
= HttpFindHeader (HeaderCount
, Headers
, HTTP_HEADER_CONTENT_LENGTH
);
934 if (Header
== NULL
) {
935 return EFI_NOT_FOUND
;
938 return AsciiStrDecimalToUintnS (Header
->FieldValue
, (CHAR8
**) NULL
, ContentLength
);
943 Check whether the HTTP message is using the "chunked" transfer-coding.
945 @param[in] HeaderCount Number of HTTP header structures in Headers.
946 @param[in] Headers Array containing list of HTTP headers.
948 @return The message is "chunked" transfer-coding (TRUE) or not (FALSE).
953 IN UINTN HeaderCount
,
954 IN EFI_HTTP_HEADER
*Headers
957 EFI_HTTP_HEADER
*Header
;
960 Header
= HttpFindHeader (HeaderCount
, Headers
, HTTP_HEADER_TRANSFER_ENCODING
);
961 if (Header
== NULL
) {
965 if (AsciiStriCmp (Header
->FieldValue
, "identity") != 0) {
973 Check whether the HTTP message should have a message-body.
975 @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message.
976 @param[in] StatusCode Response status code returned by the remote host.
978 @return The message should have a message-body (FALSE) or not (TRUE).
982 HttpIoNoMessageBody (
983 IN EFI_HTTP_METHOD Method
,
984 IN EFI_HTTP_STATUS_CODE StatusCode
989 // All responses to the HEAD request method
990 // MUST NOT include a message-body, even though the presence of entity-
991 // header fields might lead one to believe they do. All 1xx
992 // (informational), 204 (no content), and 304 (not modified) responses
993 // MUST NOT include a message-body. All other responses do include a
994 // message-body, although it MAY be of zero length.
996 if (Method
== HttpMethodHead
) {
1000 if ((StatusCode
== HTTP_STATUS_100_CONTINUE
) ||
1001 (StatusCode
== HTTP_STATUS_101_SWITCHING_PROTOCOLS
) ||
1002 (StatusCode
== HTTP_STATUS_204_NO_CONTENT
) ||
1003 (StatusCode
== HTTP_STATUS_304_NOT_MODIFIED
))
1012 Initialize a HTTP message-body parser.
1014 This function will create and initialize a HTTP message parser according to caller provided HTTP message
1015 header information. It is the caller's responsibility to free the buffer returned in *UrlParser by HttpFreeMsgParser().
1017 @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message.
1018 @param[in] StatusCode Response status code returned by the remote host.
1019 @param[in] HeaderCount Number of HTTP header structures in Headers.
1020 @param[in] Headers Array containing list of HTTP headers.
1021 @param[in] Callback Callback function that is invoked when parsing the HTTP message-body,
1022 set to NULL to ignore all events.
1023 @param[in] Context Pointer to the context that will be passed to Callback.
1024 @param[out] MsgParser Pointer to the returned buffer to store the message parser.
1026 @retval EFI_SUCCESS Successfully initialized the parser.
1027 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
1028 @retval EFI_INVALID_PARAMETER MsgParser is NULL or HeaderCount is not NULL but Headers is NULL.
1029 @retval Others Failed to initialize the parser.
1035 IN EFI_HTTP_METHOD Method
,
1036 IN EFI_HTTP_STATUS_CODE StatusCode
,
1037 IN UINTN HeaderCount
,
1038 IN EFI_HTTP_HEADER
*Headers
,
1039 IN HTTP_BODY_PARSER_CALLBACK Callback
,
1041 OUT VOID
**MsgParser
1045 HTTP_BODY_PARSER
*Parser
;
1047 if (HeaderCount
!= 0 && Headers
== NULL
) {
1048 return EFI_INVALID_PARAMETER
;
1051 if (MsgParser
== NULL
) {
1052 return EFI_INVALID_PARAMETER
;
1055 Parser
= AllocateZeroPool (sizeof (HTTP_BODY_PARSER
));
1056 if (Parser
== NULL
) {
1057 return EFI_OUT_OF_RESOURCES
;
1060 Parser
->State
= BodyParserBodyStart
;
1063 // Determine the message length according to RFC 2616.
1064 // 1. Check whether the message "MUST NOT" have a message-body.
1066 Parser
->IgnoreBody
= HttpIoNoMessageBody (Method
, StatusCode
);
1068 // 2. Check whether the message using "chunked" transfer-coding.
1070 Parser
->IsChunked
= HttpIoIsChunked (HeaderCount
, Headers
);
1072 // 3. Check whether the message has a Content-Length header field.
1074 Status
= HttpIoParseContentLengthHeader (HeaderCount
, Headers
, &Parser
->ContentLength
);
1075 if (!EFI_ERROR (Status
)) {
1076 Parser
->ContentLengthIsValid
= TRUE
;
1079 // 4. Range header is not supported now, so we won't meet media type "multipart/byteranges".
1080 // 5. By server closing the connection
1084 // Set state to skip body parser if the message shouldn't have a message body.
1086 if (Parser
->IgnoreBody
) {
1087 Parser
->State
= BodyParserComplete
;
1089 Parser
->Callback
= Callback
;
1090 Parser
->Context
= Context
;
1093 *MsgParser
= Parser
;
1100 Parse BodyLength of message-body. This function can be called repeatedly to parse the message-body partially.
1102 @param[in, out] MsgParser Pointer to the message parser.
1103 @param[in] BodyLength Length in bytes of the Body.
1104 @param[in] Body Pointer to the buffer of the message-body to be parsed.
1106 @retval EFI_SUCCESS Successfully parse the message-body.
1107 @retval EFI_INVALID_PARAMETER MsgParser is NULL or Body is NULL or BodyLength is 0.
1108 @retval Others Operation aborted.
1113 HttpParseMessageBody (
1114 IN OUT VOID
*MsgParser
,
1115 IN UINTN BodyLength
,
1120 UINTN RemainderLengthInThis
;
1121 UINTN LengthForCallback
;
1123 HTTP_BODY_PARSER
*Parser
;
1125 if (BodyLength
== 0 || Body
== NULL
) {
1126 return EFI_INVALID_PARAMETER
;
1129 if (MsgParser
== NULL
) {
1130 return EFI_INVALID_PARAMETER
;
1133 Parser
= (HTTP_BODY_PARSER
*) MsgParser
;
1135 if (Parser
->IgnoreBody
) {
1136 Parser
->State
= BodyParserComplete
;
1137 if (Parser
->Callback
!= NULL
) {
1138 Status
= Parser
->Callback (
1139 BodyParseEventOnComplete
,
1144 if (EFI_ERROR (Status
)) {
1151 if (Parser
->State
== BodyParserBodyStart
) {
1152 Parser
->ParsedBodyLength
= 0;
1153 if (Parser
->IsChunked
) {
1154 Parser
->State
= BodyParserChunkSizeStart
;
1156 Parser
->State
= BodyParserBodyIdentity
;
1161 // The message body might be truncated in anywhere, so we need to parse is byte-by-byte.
1163 for (Char
= Body
; Char
< Body
+ BodyLength
; ) {
1165 switch (Parser
->State
) {
1166 case BodyParserStateMax
:
1169 case BodyParserBodyIdentity
:
1171 // Identity transfer-coding, just notify user to save the body data.
1173 if (Parser
->Callback
!= NULL
) {
1174 Status
= Parser
->Callback (
1175 BodyParseEventOnData
,
1177 MIN (BodyLength
, Parser
->ContentLength
- Parser
->ParsedBodyLength
),
1180 if (EFI_ERROR (Status
)) {
1184 Char
+= MIN (BodyLength
, Parser
->ContentLength
- Parser
->ParsedBodyLength
);
1185 Parser
->ParsedBodyLength
+= MIN (BodyLength
, Parser
->ContentLength
- Parser
->ParsedBodyLength
);
1186 if (Parser
->ParsedBodyLength
== Parser
->ContentLength
) {
1187 Parser
->State
= BodyParserComplete
;
1188 if (Parser
->Callback
!= NULL
) {
1189 Status
= Parser
->Callback (
1190 BodyParseEventOnComplete
,
1195 if (EFI_ERROR (Status
)) {
1202 case BodyParserChunkSizeStart
:
1204 // First byte of chunk-size, the chunk-size might be truncated.
1206 Parser
->CurrentChunkSize
= 0;
1207 Parser
->State
= BodyParserChunkSize
;
1208 case BodyParserChunkSize
:
1209 if (!NET_IS_HEX_CHAR (*Char
)) {
1211 Parser
->State
= BodyParserChunkExtStart
;
1213 } else if (*Char
== '\r') {
1214 Parser
->State
= BodyParserChunkSizeEndCR
;
1217 Parser
->State
= BodyParserStateMax
;
1222 if (Parser
->CurrentChunkSize
> (((~((UINTN
) 0)) - 16) / 16)) {
1223 return EFI_INVALID_PARAMETER
;
1225 Parser
->CurrentChunkSize
= Parser
->CurrentChunkSize
* 16 + HttpIoHexCharToUintn (*Char
);
1229 case BodyParserChunkExtStart
:
1231 // Ignore all the chunk extensions.
1233 if (*Char
== '\r') {
1234 Parser
->State
= BodyParserChunkSizeEndCR
;
1239 case BodyParserChunkSizeEndCR
:
1240 if (*Char
!= '\n') {
1241 Parser
->State
= BodyParserStateMax
;
1245 if (Parser
->CurrentChunkSize
== 0) {
1247 // The last chunk has been parsed and now assumed the state
1248 // of HttpBodyParse is ParserLastCRLF. So it need to decide
1249 // whether the rest message is trailer or last CRLF in the next round.
1251 Parser
->ContentLengthIsValid
= TRUE
;
1252 Parser
->State
= BodyParserLastCRLF
;
1255 Parser
->State
= BodyParserChunkDataStart
;
1256 Parser
->CurrentChunkParsedSize
= 0;
1259 case BodyParserLastCRLF
:
1261 // Judge the byte is belong to the Last CRLF or trailer, and then
1262 // configure the state of HttpBodyParse to corresponding state.
1264 if (*Char
== '\r') {
1266 Parser
->State
= BodyParserLastCRLFEnd
;
1269 Parser
->State
= BodyParserTrailer
;
1273 case BodyParserLastCRLFEnd
:
1274 if (*Char
== '\n') {
1275 Parser
->State
= BodyParserComplete
;
1277 if (Parser
->Callback
!= NULL
) {
1278 Status
= Parser
->Callback (
1279 BodyParseEventOnComplete
,
1284 if (EFI_ERROR (Status
)) {
1290 Parser
->State
= BodyParserStateMax
;
1294 case BodyParserTrailer
:
1295 if (*Char
== '\r') {
1296 Parser
->State
= BodyParserChunkSizeEndCR
;
1301 case BodyParserChunkDataStart
:
1303 // First byte of chunk-data, the chunk data also might be truncated.
1305 RemainderLengthInThis
= BodyLength
- (Char
- Body
);
1306 LengthForCallback
= MIN (Parser
->CurrentChunkSize
- Parser
->CurrentChunkParsedSize
, RemainderLengthInThis
);
1307 if (Parser
->Callback
!= NULL
) {
1308 Status
= Parser
->Callback (
1309 BodyParseEventOnData
,
1314 if (EFI_ERROR (Status
)) {
1318 Char
+= LengthForCallback
;
1319 Parser
->ContentLength
+= LengthForCallback
;
1320 Parser
->CurrentChunkParsedSize
+= LengthForCallback
;
1321 if (Parser
->CurrentChunkParsedSize
== Parser
->CurrentChunkSize
) {
1322 Parser
->State
= BodyParserChunkDataEnd
;
1326 case BodyParserChunkDataEnd
:
1327 if (*Char
== '\r') {
1328 Parser
->State
= BodyParserChunkDataEndCR
;
1330 Parser
->State
= BodyParserStateMax
;
1335 case BodyParserChunkDataEndCR
:
1336 if (*Char
!= '\n') {
1337 Parser
->State
= BodyParserStateMax
;
1341 Parser
->State
= BodyParserChunkSizeStart
;
1350 if (Parser
->State
== BodyParserStateMax
) {
1358 Check whether the message-body is complete or not.
1360 @param[in] MsgParser Pointer to the message parser.
1362 @retval TRUE Message-body is complete.
1363 @retval FALSE Message-body is not complete.
1368 HttpIsMessageComplete (
1372 HTTP_BODY_PARSER
*Parser
;
1374 Parser
= (HTTP_BODY_PARSER
*) MsgParser
;
1376 if (Parser
->State
== BodyParserComplete
) {
1383 Get the content length of the entity.
1385 Note that in trunk transfer, the entity length is not valid until the whole message body is received.
1387 @param[in] MsgParser Pointer to the message parser.
1388 @param[out] ContentLength Pointer to store the length of the entity.
1390 @retval EFI_SUCCESS Successfully to get the entity length.
1391 @retval EFI_NOT_READY Entity length is not valid yet.
1392 @retval EFI_INVALID_PARAMETER MsgParser is NULL or ContentLength is NULL.
1397 HttpGetEntityLength (
1399 OUT UINTN
*ContentLength
1402 HTTP_BODY_PARSER
*Parser
;
1404 if (MsgParser
== NULL
|| ContentLength
== NULL
) {
1405 return EFI_INVALID_PARAMETER
;
1408 Parser
= (HTTP_BODY_PARSER
*) MsgParser
;
1410 if (!Parser
->ContentLengthIsValid
) {
1411 return EFI_NOT_READY
;
1414 *ContentLength
= Parser
->ContentLength
;
1419 Release the resource of the message parser.
1421 @param[in] MsgParser Pointer to the message parser.
1430 FreePool (MsgParser
);
1435 Get the next string, which is distinguished by specified separator.
1437 @param[in] String Pointer to the string.
1438 @param[in] Separator Specified separator used to distinguish where is the beginning
1441 @return Pointer to the next string.
1442 @return NULL if not find or String is NULL.
1447 AsciiStrGetNextToken (
1448 IN CONST CHAR8
*String
,
1459 if (*Token
== Separator
) {
1460 return (CHAR8
*)(Token
+ 1);
1467 Set FieldName and FieldValue into specified HttpHeader.
1469 @param[in,out] HttpHeader Specified HttpHeader.
1470 @param[in] FieldName FieldName of this HttpHeader, a NULL terminated ASCII string.
1471 @param[in] FieldValue FieldValue of this HttpHeader, a NULL terminated ASCII string.
1474 @retval EFI_SUCCESS The FieldName and FieldValue are set into HttpHeader successfully.
1475 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
1480 HttpSetFieldNameAndValue (
1481 IN OUT EFI_HTTP_HEADER
*HttpHeader
,
1482 IN CONST CHAR8
*FieldName
,
1483 IN CONST CHAR8
*FieldValue
1486 UINTN FieldNameSize
;
1487 UINTN FieldValueSize
;
1489 if (HttpHeader
->FieldName
!= NULL
) {
1490 FreePool (HttpHeader
->FieldName
);
1492 if (HttpHeader
->FieldValue
!= NULL
) {
1493 FreePool (HttpHeader
->FieldValue
);
1496 FieldNameSize
= AsciiStrSize (FieldName
);
1497 HttpHeader
->FieldName
= AllocateZeroPool (FieldNameSize
);
1498 if (HttpHeader
->FieldName
== NULL
) {
1499 return EFI_OUT_OF_RESOURCES
;
1501 CopyMem (HttpHeader
->FieldName
, FieldName
, FieldNameSize
);
1502 HttpHeader
->FieldName
[FieldNameSize
- 1] = 0;
1504 FieldValueSize
= AsciiStrSize (FieldValue
);
1505 HttpHeader
->FieldValue
= AllocateZeroPool (FieldValueSize
);
1506 if (HttpHeader
->FieldValue
== NULL
) {
1507 return EFI_OUT_OF_RESOURCES
;
1509 CopyMem (HttpHeader
->FieldValue
, FieldValue
, FieldValueSize
);
1510 HttpHeader
->FieldValue
[FieldValueSize
- 1] = 0;
1516 Get one key/value header pair from the raw string.
1518 @param[in] String Pointer to the raw string.
1519 @param[out] FieldName Points directly to field name within 'HttpHeader'.
1520 @param[out] FieldValue Points directly to field value within 'HttpHeader'.
1522 @return Pointer to the next raw string.
1523 @return NULL if no key/value header pair from this raw string.
1528 HttpGetFieldNameAndValue (
1530 OUT CHAR8
**FieldName
,
1531 OUT CHAR8
**FieldValue
1534 CHAR8
*FieldNameStr
;
1535 CHAR8
*FieldValueStr
;
1538 if (String
== NULL
|| FieldName
== NULL
|| FieldValue
== NULL
) {
1544 FieldNameStr
= NULL
;
1545 FieldValueStr
= NULL
;
1549 // Each header field consists of a name followed by a colon (":") and the field value.
1551 FieldNameStr
= String
;
1552 FieldValueStr
= AsciiStrGetNextToken (FieldNameStr
, ':');
1553 if (FieldValueStr
== NULL
) {
1558 // Replace ':' with 0
1560 *(FieldValueStr
- 1) = 0;
1563 // The field value MAY be preceded by any amount of LWS, though a single SP is preferred.
1566 if (*FieldValueStr
== ' ' || *FieldValueStr
== '\t') {
1568 } else if (*FieldValueStr
== '\r' && *(FieldValueStr
+ 1) == '\n' &&
1569 (*(FieldValueStr
+ 2) == ' ' || *(FieldValueStr
+ 2) == '\t')) {
1570 FieldValueStr
= FieldValueStr
+ 3;
1577 // Header fields can be extended over multiple lines by preceding each extra
1578 // line with at least one SP or HT.
1580 StrPtr
= FieldValueStr
;
1582 StrPtr
= AsciiStrGetNextToken (StrPtr
, '\r');
1583 if (StrPtr
== NULL
|| *StrPtr
!= '\n') {
1588 } while (*StrPtr
== ' ' || *StrPtr
== '\t');
1591 // Replace '\r' with 0
1596 // Get FieldName and FieldValue.
1598 *FieldName
= FieldNameStr
;
1599 *FieldValue
= FieldValueStr
;
1605 Free existing HeaderFields.
1607 @param[in] HeaderFields Pointer to array of key/value header pairs waitting for free.
1608 @param[in] FieldCount The number of header pairs in HeaderFields.
1613 HttpFreeHeaderFields (
1614 IN EFI_HTTP_HEADER
*HeaderFields
,
1620 if (HeaderFields
!= NULL
) {
1621 for (Index
= 0; Index
< FieldCount
; Index
++) {
1622 if (HeaderFields
[Index
].FieldName
!= NULL
) {
1623 FreePool (HeaderFields
[Index
].FieldName
);
1625 if (HeaderFields
[Index
].FieldValue
!= NULL
) {
1626 FreePool (HeaderFields
[Index
].FieldValue
);
1630 FreePool (HeaderFields
);
1635 Generate HTTP request message.
1637 This function will allocate memory for the whole HTTP message and generate a
1638 well formatted HTTP Request message in it, include the Request-Line, header
1639 fields and also the message body. It is the caller's responsibility to free
1640 the buffer returned in *RequestMsg.
1642 @param[in] Message Pointer to the EFI_HTTP_MESSAGE structure which
1643 contains the required information to generate
1644 the HTTP request message.
1645 @param[in] Url The URL of a remote host.
1646 @param[out] RequestMsg Pointer to the created HTTP request message.
1647 NULL if any error occured.
1648 @param[out] RequestMsgSize Size of the RequestMsg (in bytes).
1650 @return EFI_SUCCESS If HTTP request string was created successfully
1651 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
1652 @retval EFI_INVALID_PARAMETER The input arguments are invalid
1657 HttpGenRequestMessage (
1658 IN CONST EFI_HTTP_MESSAGE
*Message
,
1659 IN CONST CHAR8
*Url
,
1660 OUT CHAR8
**RequestMsg
,
1661 OUT UINTN
*RequestMsgSize
1671 EFI_HTTP_HEADER
**AppendList
;
1673 EFI_HTTP_UTILITIES_PROTOCOL
*HttpUtilitiesProtocol
;
1676 ASSERT (Message
!= NULL
);
1679 Status
= EFI_SUCCESS
;
1685 HttpUtilitiesProtocol
= NULL
;
1688 // 1. If we have a Request, we cannot have a NULL Url
1689 // 2. If we have a Request, HeaderCount can not be non-zero
1690 // 3. If we do not have a Request, HeaderCount should be zero
1691 // 4. If we do not have Request and Headers, we need at least a message-body
1693 if ((Message
->Data
.Request
!= NULL
&& Url
== NULL
) ||
1694 (Message
->Data
.Request
!= NULL
&& Message
->HeaderCount
== 0) ||
1695 (Message
->Data
.Request
== NULL
&& Message
->HeaderCount
!= 0) ||
1696 (Message
->Data
.Request
== NULL
&& Message
->HeaderCount
== 0 && Message
->BodyLength
== 0)) {
1697 return EFI_INVALID_PARAMETER
;
1700 if (Message
->HeaderCount
!= 0) {
1702 // Locate the HTTP_UTILITIES protocol.
1704 Status
= gBS
->LocateProtocol (
1705 &gEfiHttpUtilitiesProtocolGuid
,
1707 (VOID
**)&HttpUtilitiesProtocol
1710 if (EFI_ERROR (Status
)) {
1711 DEBUG ((DEBUG_ERROR
,"Failed to locate Http Utilities protocol. Status = %r.\n", Status
));
1716 // Build AppendList to send into HttpUtilitiesBuild
1718 AppendList
= AllocateZeroPool (sizeof (EFI_HTTP_HEADER
*) * (Message
->HeaderCount
));
1719 if (AppendList
== NULL
) {
1720 return EFI_OUT_OF_RESOURCES
;
1723 for(Index
= 0; Index
< Message
->HeaderCount
; Index
++){
1724 AppendList
[Index
] = &Message
->Headers
[Index
];
1728 // Build raw HTTP Headers
1730 Status
= HttpUtilitiesProtocol
->Build (
1731 HttpUtilitiesProtocol
,
1736 Message
->HeaderCount
,
1742 if (AppendList
!= NULL
) {
1743 FreePool (AppendList
);
1746 if (EFI_ERROR (Status
) || HttpHdr
== NULL
){
1752 // If we have headers to be sent, account for it.
1754 if (Message
->HeaderCount
!= 0) {
1755 MsgSize
= HttpHdrSize
;
1759 // If we have a request line, account for the fields.
1761 if (Message
->Data
.Request
!= NULL
) {
1762 MsgSize
+= HTTP_METHOD_MAXIMUM_LEN
+ AsciiStrLen (HTTP_VERSION_CRLF_STR
) + AsciiStrLen (Url
);
1767 // If we have a message body to be sent, account for it.
1769 MsgSize
+= Message
->BodyLength
;
1772 // memory for the string that needs to be sent to TCP
1774 *RequestMsg
= AllocateZeroPool (MsgSize
);
1775 if (*RequestMsg
== NULL
) {
1776 Status
= EFI_OUT_OF_RESOURCES
;
1780 RequestPtr
= *RequestMsg
;
1782 // Construct header request
1784 if (Message
->Data
.Request
!= NULL
) {
1785 switch (Message
->Data
.Request
->Method
) {
1787 StrLength
= sizeof (HTTP_METHOD_GET
) - 1;
1788 CopyMem (RequestPtr
, HTTP_METHOD_GET
, StrLength
);
1789 RequestPtr
+= StrLength
;
1792 StrLength
= sizeof (HTTP_METHOD_PUT
) - 1;
1793 CopyMem (RequestPtr
, HTTP_METHOD_PUT
, StrLength
);
1794 RequestPtr
+= StrLength
;
1796 case HttpMethodPatch
:
1797 StrLength
= sizeof (HTTP_METHOD_PATCH
) - 1;
1798 CopyMem (RequestPtr
, HTTP_METHOD_PATCH
, StrLength
);
1799 RequestPtr
+= StrLength
;
1801 case HttpMethodPost
:
1802 StrLength
= sizeof (HTTP_METHOD_POST
) - 1;
1803 CopyMem (RequestPtr
, HTTP_METHOD_POST
, StrLength
);
1804 RequestPtr
+= StrLength
;
1806 case HttpMethodHead
:
1807 StrLength
= sizeof (HTTP_METHOD_HEAD
) - 1;
1808 CopyMem (RequestPtr
, HTTP_METHOD_HEAD
, StrLength
);
1809 RequestPtr
+= StrLength
;
1811 case HttpMethodDelete
:
1812 StrLength
= sizeof (HTTP_METHOD_DELETE
) - 1;
1813 CopyMem (RequestPtr
, HTTP_METHOD_DELETE
, StrLength
);
1814 RequestPtr
+= StrLength
;
1818 Status
= EFI_INVALID_PARAMETER
;
1822 StrLength
= AsciiStrLen(EMPTY_SPACE
);
1823 CopyMem (RequestPtr
, EMPTY_SPACE
, StrLength
);
1824 RequestPtr
+= StrLength
;
1826 StrLength
= AsciiStrLen (Url
);
1827 CopyMem (RequestPtr
, Url
, StrLength
);
1828 RequestPtr
+= StrLength
;
1830 StrLength
= sizeof (HTTP_VERSION_CRLF_STR
) - 1;
1831 CopyMem (RequestPtr
, HTTP_VERSION_CRLF_STR
, StrLength
);
1832 RequestPtr
+= StrLength
;
1834 if (HttpHdr
!= NULL
) {
1838 CopyMem (RequestPtr
, HttpHdr
, HttpHdrSize
);
1839 RequestPtr
+= HttpHdrSize
;
1846 if (Message
->Body
!= NULL
) {
1847 CopyMem (RequestPtr
, Message
->Body
, Message
->BodyLength
);
1848 RequestPtr
+= Message
->BodyLength
;
1854 (*RequestMsgSize
) = (UINTN
)(RequestPtr
) - (UINTN
)(*RequestMsg
);
1860 if (*RequestMsg
!= NULL
) {
1861 FreePool (*RequestMsg
);
1867 if (HttpHdr
!= NULL
) {
1875 Translate the status code in HTTP message to EFI_HTTP_STATUS_CODE defined
1876 in UEFI 2.5 specification.
1878 @param[in] StatusCode The status code value in HTTP message.
1880 @return Value defined in EFI_HTTP_STATUS_CODE .
1883 EFI_HTTP_STATUS_CODE
1885 HttpMappingToStatusCode (
1889 switch (StatusCode
) {
1891 return HTTP_STATUS_100_CONTINUE
;
1893 return HTTP_STATUS_101_SWITCHING_PROTOCOLS
;
1895 return HTTP_STATUS_200_OK
;
1897 return HTTP_STATUS_201_CREATED
;
1899 return HTTP_STATUS_202_ACCEPTED
;
1901 return HTTP_STATUS_203_NON_AUTHORITATIVE_INFORMATION
;
1903 return HTTP_STATUS_204_NO_CONTENT
;
1905 return HTTP_STATUS_205_RESET_CONTENT
;
1907 return HTTP_STATUS_206_PARTIAL_CONTENT
;
1909 return HTTP_STATUS_300_MULTIPLE_CHIOCES
;
1911 return HTTP_STATUS_301_MOVED_PERMANENTLY
;
1913 return HTTP_STATUS_302_FOUND
;
1915 return HTTP_STATUS_303_SEE_OTHER
;
1917 return HTTP_STATUS_304_NOT_MODIFIED
;
1919 return HTTP_STATUS_305_USE_PROXY
;
1921 return HTTP_STATUS_307_TEMPORARY_REDIRECT
;
1923 return HTTP_STATUS_400_BAD_REQUEST
;
1925 return HTTP_STATUS_401_UNAUTHORIZED
;
1927 return HTTP_STATUS_402_PAYMENT_REQUIRED
;
1929 return HTTP_STATUS_403_FORBIDDEN
;
1931 return HTTP_STATUS_404_NOT_FOUND
;
1933 return HTTP_STATUS_405_METHOD_NOT_ALLOWED
;
1935 return HTTP_STATUS_406_NOT_ACCEPTABLE
;
1937 return HTTP_STATUS_407_PROXY_AUTHENTICATION_REQUIRED
;
1939 return HTTP_STATUS_408_REQUEST_TIME_OUT
;
1941 return HTTP_STATUS_409_CONFLICT
;
1943 return HTTP_STATUS_410_GONE
;
1945 return HTTP_STATUS_411_LENGTH_REQUIRED
;
1947 return HTTP_STATUS_412_PRECONDITION_FAILED
;
1949 return HTTP_STATUS_413_REQUEST_ENTITY_TOO_LARGE
;
1951 return HTTP_STATUS_414_REQUEST_URI_TOO_LARGE
;
1953 return HTTP_STATUS_415_UNSUPPORTED_MEDIA_TYPE
;
1955 return HTTP_STATUS_416_REQUESTED_RANGE_NOT_SATISFIED
;
1957 return HTTP_STATUS_417_EXPECTATION_FAILED
;
1959 return HTTP_STATUS_500_INTERNAL_SERVER_ERROR
;
1961 return HTTP_STATUS_501_NOT_IMPLEMENTED
;
1963 return HTTP_STATUS_502_BAD_GATEWAY
;
1965 return HTTP_STATUS_503_SERVICE_UNAVAILABLE
;
1967 return HTTP_STATUS_504_GATEWAY_TIME_OUT
;
1969 return HTTP_STATUS_505_HTTP_VERSION_NOT_SUPPORTED
;
1972 return HTTP_STATUS_UNSUPPORTED_STATUS
;
1977 Check whether header field called FieldName is in DeleteList.
1979 @param[in] DeleteList Pointer to array of key/value header pairs.
1980 @param[in] DeleteCount The number of header pairs.
1981 @param[in] FieldName Pointer to header field's name.
1983 @return TRUE if FieldName is not in DeleteList, that means this header field is valid.
1984 @return FALSE if FieldName is in DeleteList, that means this header field is invalid.
1989 HttpIsValidHttpHeader (
1990 IN CHAR8
*DeleteList
[],
1991 IN UINTN DeleteCount
,
1997 for (Index
= 0; Index
< DeleteCount
; Index
++) {
1998 if (AsciiStrCmp (FieldName
, DeleteList
[Index
]) == 0) {