]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | This library is used to share code between UEFI network stack modules.\r | |
3 | It provides the helper routines to parse the HTTP message byte stream.\r | |
4 | \r | |
5 | Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>\r | |
6 | (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r | |
7 | This program and the accompanying materials\r | |
8 | are licensed and made available under the terms and conditions of the BSD License\r | |
9 | which accompanies this distribution. The full text of the license may be found at<BR>\r | |
10 | http://opensource.org/licenses/bsd-license.php\r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
14 | \r | |
15 | **/\r | |
16 | \r | |
17 | #include "DxeHttpLib.h"\r | |
18 | \r | |
19 | \r | |
20 | \r | |
21 | /**\r | |
22 | Decode a percent-encoded URI component to the ASCII character.\r | |
23 | \r | |
24 | Decode the input component in Buffer according to RFC 3986. The caller is responsible to make\r | |
25 | sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer))\r | |
26 | in bytes.\r | |
27 | \r | |
28 | @param[in] Buffer The pointer to a percent-encoded URI component.\r | |
29 | @param[in] BufferLength Length of Buffer in bytes.\r | |
30 | @param[out] ResultBuffer Point to the buffer to store the decode result.\r | |
31 | @param[out] ResultLength Length of decoded string in ResultBuffer in bytes.\r | |
32 | \r | |
33 | @retval EFI_SUCCESS Successfully decoded the URI.\r | |
34 | @retval EFI_INVALID_PARAMETER Buffer is not a valid percent-encoded string.\r | |
35 | \r | |
36 | **/\r | |
37 | EFI_STATUS\r | |
38 | EFIAPI\r | |
39 | UriPercentDecode (\r | |
40 | IN CHAR8 *Buffer,\r | |
41 | IN UINT32 BufferLength,\r | |
42 | OUT CHAR8 *ResultBuffer,\r | |
43 | OUT UINT32 *ResultLength\r | |
44 | )\r | |
45 | {\r | |
46 | UINTN Index;\r | |
47 | UINTN Offset;\r | |
48 | CHAR8 HexStr[3];\r | |
49 | \r | |
50 | if (Buffer == NULL || BufferLength == 0 || ResultBuffer == NULL) {\r | |
51 | return EFI_INVALID_PARAMETER;\r | |
52 | }\r | |
53 | \r | |
54 | Index = 0;\r | |
55 | Offset = 0;\r | |
56 | HexStr[2] = '\0';\r | |
57 | while (Index < BufferLength) {\r | |
58 | if (Buffer[Index] == '%') {\r | |
59 | if (Index + 1 >= BufferLength || Index + 2 >= BufferLength ||\r | |
60 | !NET_IS_HEX_CHAR (Buffer[Index+1]) || !NET_IS_HEX_CHAR (Buffer[Index+2])) {\r | |
61 | return EFI_INVALID_PARAMETER;\r | |
62 | }\r | |
63 | HexStr[0] = Buffer[Index+1];\r | |
64 | HexStr[1] = Buffer[Index+2];\r | |
65 | ResultBuffer[Offset] = (CHAR8) AsciiStrHexToUintn (HexStr);\r | |
66 | Index += 3;\r | |
67 | } else {\r | |
68 | ResultBuffer[Offset] = Buffer[Index];\r | |
69 | Index++;\r | |
70 | }\r | |
71 | Offset++;\r | |
72 | }\r | |
73 | \r | |
74 | *ResultLength = (UINT32) Offset;\r | |
75 | \r | |
76 | return EFI_SUCCESS;\r | |
77 | }\r | |
78 | \r | |
79 | /**\r | |
80 | This function return the updated state according to the input state and next character of\r | |
81 | the authority.\r | |
82 | \r | |
83 | @param[in] Char Next character.\r | |
84 | @param[in] State Current value of the parser state machine.\r | |
85 | @param[in] IsRightBracket TRUE if there is an sign ']' in the authority component and\r | |
86 | indicates the next part is ':' before Port.\r | |
87 | \r | |
88 | @return Updated state value.\r | |
89 | **/\r | |
90 | HTTP_URL_PARSE_STATE\r | |
91 | NetHttpParseAuthorityChar (\r | |
92 | IN CHAR8 Char,\r | |
93 | IN HTTP_URL_PARSE_STATE State,\r | |
94 | IN BOOLEAN *IsRightBracket\r | |
95 | )\r | |
96 | {\r | |
97 | \r | |
98 | //\r | |
99 | // RFC 3986:\r | |
100 | // The authority component is preceded by a double slash ("//") and is\r | |
101 | // terminated by the next slash ("/"), question mark ("?"), or number\r | |
102 | // sign ("#") character, or by the end of the URI.\r | |
103 | //\r | |
104 | if (Char == ' ' || Char == '\r' || Char == '\n') {\r | |
105 | return UrlParserStateMax;\r | |
106 | }\r | |
107 | \r | |
108 | //\r | |
109 | // authority = [ userinfo "@" ] host [ ":" port ]\r | |
110 | //\r | |
111 | switch (State) {\r | |
112 | case UrlParserUserInfo:\r | |
113 | if (Char == '@') {\r | |
114 | return UrlParserHostStart;\r | |
115 | }\r | |
116 | break;\r | |
117 | \r | |
118 | case UrlParserHost:\r | |
119 | case UrlParserHostStart:\r | |
120 | if (Char == '[') {\r | |
121 | return UrlParserHostIpv6;\r | |
122 | }\r | |
123 | \r | |
124 | if (Char == ':') {\r | |
125 | return UrlParserPortStart;\r | |
126 | }\r | |
127 | \r | |
128 | return UrlParserHost;\r | |
129 | \r | |
130 | case UrlParserHostIpv6:\r | |
131 | if (Char == ']') {\r | |
132 | *IsRightBracket = TRUE;\r | |
133 | }\r | |
134 | \r | |
135 | if (Char == ':' && *IsRightBracket) {\r | |
136 | return UrlParserPortStart;\r | |
137 | }\r | |
138 | return UrlParserHostIpv6;\r | |
139 | \r | |
140 | case UrlParserPort:\r | |
141 | case UrlParserPortStart:\r | |
142 | return UrlParserPort;\r | |
143 | \r | |
144 | default:\r | |
145 | break;\r | |
146 | }\r | |
147 | \r | |
148 | return State;\r | |
149 | }\r | |
150 | \r | |
151 | /**\r | |
152 | This function parse the authority component of the input URL and update the parser.\r | |
153 | \r | |
154 | @param[in] Url The pointer to a HTTP URL string.\r | |
155 | @param[in] FoundAt TRUE if there is an at sign ('@') in the authority component.\r | |
156 | @param[in, out] UrlParser Pointer to the buffer of the parse result.\r | |
157 | \r | |
158 | @retval EFI_SUCCESS Successfully parse the authority.\r | |
159 | @retval EFI_INVALID_PARAMETER The Url is invalid to parse the authority component.\r | |
160 | \r | |
161 | **/\r | |
162 | EFI_STATUS\r | |
163 | NetHttpParseAuthority (\r | |
164 | IN CHAR8 *Url,\r | |
165 | IN BOOLEAN FoundAt,\r | |
166 | IN OUT HTTP_URL_PARSER *UrlParser\r | |
167 | )\r | |
168 | {\r | |
169 | CHAR8 *Char;\r | |
170 | CHAR8 *Authority;\r | |
171 | UINT32 Length;\r | |
172 | HTTP_URL_PARSE_STATE State;\r | |
173 | UINT32 Field;\r | |
174 | UINT32 OldField;\r | |
175 | BOOLEAN IsrightBracket;\r | |
176 | \r | |
177 | ASSERT ((UrlParser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0);\r | |
178 | \r | |
179 | //\r | |
180 | // authority = [ userinfo "@" ] host [ ":" port ]\r | |
181 | //\r | |
182 | if (FoundAt) {\r | |
183 | State = UrlParserUserInfo;\r | |
184 | } else {\r | |
185 | State = UrlParserHost;\r | |
186 | }\r | |
187 | \r | |
188 | IsrightBracket = FALSE;\r | |
189 | Field = HTTP_URI_FIELD_MAX;\r | |
190 | OldField = Field;\r | |
191 | Authority = Url + UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Offset;\r | |
192 | Length = UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Length;\r | |
193 | for (Char = Authority; Char < Authority + Length; Char++) {\r | |
194 | State = NetHttpParseAuthorityChar (*Char, State, &IsrightBracket);\r | |
195 | switch (State) {\r | |
196 | case UrlParserStateMax:\r | |
197 | return EFI_INVALID_PARAMETER;\r | |
198 | \r | |
199 | case UrlParserHostStart:\r | |
200 | case UrlParserPortStart:\r | |
201 | continue;\r | |
202 | \r | |
203 | case UrlParserUserInfo:\r | |
204 | Field = HTTP_URI_FIELD_USERINFO;\r | |
205 | break;\r | |
206 | \r | |
207 | case UrlParserHost:\r | |
208 | Field = HTTP_URI_FIELD_HOST;\r | |
209 | break;\r | |
210 | \r | |
211 | case UrlParserHostIpv6:\r | |
212 | Field = HTTP_URI_FIELD_HOST;\r | |
213 | break;\r | |
214 | \r | |
215 | case UrlParserPort:\r | |
216 | Field = HTTP_URI_FIELD_PORT;\r | |
217 | break;\r | |
218 | \r | |
219 | default:\r | |
220 | ASSERT (FALSE);\r | |
221 | }\r | |
222 | \r | |
223 | //\r | |
224 | // Field not changed, count the length.\r | |
225 | //\r | |
226 | ASSERT (Field < HTTP_URI_FIELD_MAX);\r | |
227 | if (Field == OldField) {\r | |
228 | UrlParser->FieldData[Field].Length++;\r | |
229 | continue;\r | |
230 | }\r | |
231 | \r | |
232 | //\r | |
233 | // New field start\r | |
234 | //\r | |
235 | UrlParser->FieldBitMap |= BIT (Field);\r | |
236 | UrlParser->FieldData[Field].Offset = (UINT32) (Char - Url);\r | |
237 | UrlParser->FieldData[Field].Length = 1;\r | |
238 | OldField = Field;\r | |
239 | }\r | |
240 | \r | |
241 | return EFI_SUCCESS;\r | |
242 | }\r | |
243 | \r | |
244 | /**\r | |
245 | This function return the updated state according to the input state and next character of a URL.\r | |
246 | \r | |
247 | @param[in] Char Next character.\r | |
248 | @param[in] State Current value of the parser state machine.\r | |
249 | \r | |
250 | @return Updated state value.\r | |
251 | \r | |
252 | **/\r | |
253 | HTTP_URL_PARSE_STATE\r | |
254 | NetHttpParseUrlChar (\r | |
255 | IN CHAR8 Char,\r | |
256 | IN HTTP_URL_PARSE_STATE State\r | |
257 | )\r | |
258 | {\r | |
259 | if (Char == ' ' || Char == '\r' || Char == '\n') {\r | |
260 | return UrlParserStateMax;\r | |
261 | }\r | |
262 | \r | |
263 | //\r | |
264 | // http_URL = "http:" "//" host [ ":" port ] [ abs_path [ "?" query ]]\r | |
265 | //\r | |
266 | // Request-URI = "*" | absolute-URI | path-absolute | authority\r | |
267 | //\r | |
268 | // absolute-URI = scheme ":" hier-part [ "?" query ]\r | |
269 | // path-absolute = "/" [ segment-nz *( "/" segment ) ]\r | |
270 | // authority = [ userinfo "@" ] host [ ":" port ]\r | |
271 | //\r | |
272 | switch (State) {\r | |
273 | case UrlParserUrlStart:\r | |
274 | if (Char == '*' || Char == '/') {\r | |
275 | return UrlParserPath;\r | |
276 | }\r | |
277 | return UrlParserScheme;\r | |
278 | \r | |
279 | case UrlParserScheme:\r | |
280 | if (Char == ':') {\r | |
281 | return UrlParserSchemeColon;\r | |
282 | }\r | |
283 | break;\r | |
284 | \r | |
285 | case UrlParserSchemeColon:\r | |
286 | if (Char == '/') {\r | |
287 | return UrlParserSchemeColonSlash;\r | |
288 | }\r | |
289 | break;\r | |
290 | \r | |
291 | case UrlParserSchemeColonSlash:\r | |
292 | if (Char == '/') {\r | |
293 | return UrlParserSchemeColonSlashSlash;\r | |
294 | }\r | |
295 | break;\r | |
296 | \r | |
297 | case UrlParserAtInAuthority:\r | |
298 | if (Char == '@') {\r | |
299 | return UrlParserStateMax;\r | |
300 | }\r | |
301 | \r | |
302 | case UrlParserAuthority:\r | |
303 | case UrlParserSchemeColonSlashSlash:\r | |
304 | if (Char == '@') {\r | |
305 | return UrlParserAtInAuthority;\r | |
306 | }\r | |
307 | if (Char == '/') {\r | |
308 | return UrlParserPath;\r | |
309 | }\r | |
310 | if (Char == '?') {\r | |
311 | return UrlParserQueryStart;\r | |
312 | }\r | |
313 | if (Char == '#') {\r | |
314 | return UrlParserFragmentStart;\r | |
315 | }\r | |
316 | return UrlParserAuthority;\r | |
317 | \r | |
318 | case UrlParserPath:\r | |
319 | if (Char == '?') {\r | |
320 | return UrlParserQueryStart;\r | |
321 | }\r | |
322 | if (Char == '#') {\r | |
323 | return UrlParserFragmentStart;\r | |
324 | }\r | |
325 | break;\r | |
326 | \r | |
327 | case UrlParserQuery:\r | |
328 | case UrlParserQueryStart:\r | |
329 | if (Char == '#') {\r | |
330 | return UrlParserFragmentStart;\r | |
331 | }\r | |
332 | return UrlParserQuery;\r | |
333 | \r | |
334 | case UrlParserFragmentStart:\r | |
335 | return UrlParserFragment;\r | |
336 | \r | |
337 | default:\r | |
338 | break;\r | |
339 | }\r | |
340 | \r | |
341 | return State;\r | |
342 | }\r | |
343 | /**\r | |
344 | Create a URL parser for the input URL string.\r | |
345 | \r | |
346 | This function will parse and dereference the input HTTP URL into it components. The original\r | |
347 | content of the URL won't be modified and the result will be returned in UrlParser, which can\r | |
348 | be used in other functions like NetHttpUrlGetHostName().\r | |
349 | \r | |
350 | @param[in] Url The pointer to a HTTP URL string.\r | |
351 | @param[in] Length Length of Url in bytes.\r | |
352 | @param[in] IsConnectMethod Whether the Url is used in HTTP CONNECT method or not.\r | |
353 | @param[out] UrlParser Pointer to the returned buffer to store the parse result.\r | |
354 | \r | |
355 | @retval EFI_SUCCESS Successfully dereferenced the HTTP URL.\r | |
356 | @retval EFI_INVALID_PARAMETER UrlParser is NULL or Url is not a valid HTTP URL.\r | |
357 | @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.\r | |
358 | \r | |
359 | **/\r | |
360 | EFI_STATUS\r | |
361 | EFIAPI\r | |
362 | HttpParseUrl (\r | |
363 | IN CHAR8 *Url,\r | |
364 | IN UINT32 Length,\r | |
365 | IN BOOLEAN IsConnectMethod,\r | |
366 | OUT VOID **UrlParser\r | |
367 | )\r | |
368 | {\r | |
369 | HTTP_URL_PARSE_STATE State;\r | |
370 | CHAR8 *Char;\r | |
371 | UINT32 Field;\r | |
372 | UINT32 OldField;\r | |
373 | BOOLEAN FoundAt;\r | |
374 | EFI_STATUS Status;\r | |
375 | HTTP_URL_PARSER *Parser;\r | |
376 | \r | |
377 | Parser = NULL;\r | |
378 | \r | |
379 | if (Url == NULL || Length == 0 || UrlParser == NULL) {\r | |
380 | return EFI_INVALID_PARAMETER;\r | |
381 | }\r | |
382 | \r | |
383 | Parser = AllocateZeroPool (sizeof (HTTP_URL_PARSER));\r | |
384 | if (Parser == NULL) {\r | |
385 | return EFI_OUT_OF_RESOURCES;\r | |
386 | }\r | |
387 | \r | |
388 | if (IsConnectMethod) {\r | |
389 | //\r | |
390 | // According to RFC 2616, the authority form is only used by the CONNECT method.\r | |
391 | //\r | |
392 | State = UrlParserAuthority;\r | |
393 | } else {\r | |
394 | State = UrlParserUrlStart;\r | |
395 | }\r | |
396 | \r | |
397 | Field = HTTP_URI_FIELD_MAX;\r | |
398 | OldField = Field;\r | |
399 | FoundAt = FALSE;\r | |
400 | for (Char = Url; Char < Url + Length; Char++) {\r | |
401 | //\r | |
402 | // Update state machine according to next char.\r | |
403 | //\r | |
404 | State = NetHttpParseUrlChar (*Char, State);\r | |
405 | \r | |
406 | switch (State) {\r | |
407 | case UrlParserStateMax:\r | |
408 | FreePool (Parser);\r | |
409 | return EFI_INVALID_PARAMETER;\r | |
410 | \r | |
411 | case UrlParserSchemeColon:\r | |
412 | case UrlParserSchemeColonSlash:\r | |
413 | case UrlParserSchemeColonSlashSlash:\r | |
414 | case UrlParserQueryStart:\r | |
415 | case UrlParserFragmentStart:\r | |
416 | //\r | |
417 | // Skip all the delimiting char: "://" "?" "@"\r | |
418 | //\r | |
419 | continue;\r | |
420 | \r | |
421 | case UrlParserScheme:\r | |
422 | Field = HTTP_URI_FIELD_SCHEME;\r | |
423 | break;\r | |
424 | \r | |
425 | case UrlParserAtInAuthority:\r | |
426 | FoundAt = TRUE;\r | |
427 | case UrlParserAuthority:\r | |
428 | Field = HTTP_URI_FIELD_AUTHORITY;\r | |
429 | break;\r | |
430 | \r | |
431 | case UrlParserPath:\r | |
432 | Field = HTTP_URI_FIELD_PATH;\r | |
433 | break;\r | |
434 | \r | |
435 | case UrlParserQuery:\r | |
436 | Field = HTTP_URI_FIELD_QUERY;\r | |
437 | break;\r | |
438 | \r | |
439 | case UrlParserFragment:\r | |
440 | Field = HTTP_URI_FIELD_FRAGMENT;\r | |
441 | break;\r | |
442 | \r | |
443 | default:\r | |
444 | ASSERT (FALSE);\r | |
445 | }\r | |
446 | \r | |
447 | //\r | |
448 | // Field not changed, count the length.\r | |
449 | //\r | |
450 | ASSERT (Field < HTTP_URI_FIELD_MAX);\r | |
451 | if (Field == OldField) {\r | |
452 | Parser->FieldData[Field].Length++;\r | |
453 | continue;\r | |
454 | }\r | |
455 | \r | |
456 | //\r | |
457 | // New field start\r | |
458 | //\r | |
459 | Parser->FieldBitMap |= BIT (Field);\r | |
460 | Parser->FieldData[Field].Offset = (UINT32) (Char - Url);\r | |
461 | Parser->FieldData[Field].Length = 1;\r | |
462 | OldField = Field;\r | |
463 | }\r | |
464 | \r | |
465 | //\r | |
466 | // If has authority component, continue to parse the username, host and port.\r | |
467 | //\r | |
468 | if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0) {\r | |
469 | Status = NetHttpParseAuthority (Url, FoundAt, Parser);\r | |
470 | if (EFI_ERROR (Status)) {\r | |
471 | FreePool (Parser);\r | |
472 | return Status;\r | |
473 | }\r | |
474 | }\r | |
475 | \r | |
476 | *UrlParser = Parser;\r | |
477 | return EFI_SUCCESS;\r | |
478 | }\r | |
479 | \r | |
480 | /**\r | |
481 | Get the Hostname from a HTTP URL.\r | |
482 | \r | |
483 | This function will return the HostName according to the Url and previous parse result ,and\r | |
484 | it is the caller's responsibility to free the buffer returned in *HostName.\r | |
485 | \r | |
486 | @param[in] Url The pointer to a HTTP URL string.\r | |
487 | @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().\r | |
488 | @param[out] HostName Pointer to a buffer to store the HostName.\r | |
489 | \r | |
490 | @retval EFI_SUCCESS Successfully get the required component.\r | |
491 | @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid.\r | |
492 | @retval EFI_NOT_FOUND No hostName component in the URL.\r | |
493 | @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.\r | |
494 | \r | |
495 | **/\r | |
496 | EFI_STATUS\r | |
497 | EFIAPI\r | |
498 | HttpUrlGetHostName (\r | |
499 | IN CHAR8 *Url,\r | |
500 | IN VOID *UrlParser,\r | |
501 | OUT CHAR8 **HostName\r | |
502 | )\r | |
503 | {\r | |
504 | CHAR8 *Name;\r | |
505 | EFI_STATUS Status;\r | |
506 | UINT32 ResultLength;\r | |
507 | HTTP_URL_PARSER *Parser;\r | |
508 | \r | |
509 | if (Url == NULL || UrlParser == NULL || HostName == NULL) {\r | |
510 | return EFI_INVALID_PARAMETER;\r | |
511 | }\r | |
512 | \r | |
513 | Parser = (HTTP_URL_PARSER *) UrlParser;\r | |
514 | \r | |
515 | if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {\r | |
516 | return EFI_NOT_FOUND;\r | |
517 | }\r | |
518 | \r | |
519 | Name = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1);\r | |
520 | if (Name == NULL) {\r | |
521 | return EFI_OUT_OF_RESOURCES;\r | |
522 | }\r | |
523 | \r | |
524 | Status = UriPercentDecode (\r | |
525 | Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset,\r | |
526 | Parser->FieldData[HTTP_URI_FIELD_HOST].Length,\r | |
527 | Name,\r | |
528 | &ResultLength\r | |
529 | );\r | |
530 | if (EFI_ERROR (Status)) {\r | |
531 | FreePool (Name);\r | |
532 | return Status;\r | |
533 | }\r | |
534 | \r | |
535 | Name[ResultLength] = '\0';\r | |
536 | *HostName = Name;\r | |
537 | return EFI_SUCCESS;\r | |
538 | }\r | |
539 | \r | |
540 | \r | |
541 | /**\r | |
542 | Get the IPv4 address from a HTTP URL.\r | |
543 | \r | |
544 | This function will return the IPv4 address according to the Url and previous parse result.\r | |
545 | \r | |
546 | @param[in] Url The pointer to a HTTP URL string.\r | |
547 | @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().\r | |
548 | @param[out] Ip4Address Pointer to a buffer to store the IP address.\r | |
549 | \r | |
550 | @retval EFI_SUCCESS Successfully get the required component.\r | |
551 | @retval EFI_INVALID_PARAMETER Uri is NULL or Ip4Address is NULL or UrlParser is invalid.\r | |
552 | @retval EFI_NOT_FOUND No IPv4 address component in the URL.\r | |
553 | @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.\r | |
554 | \r | |
555 | **/\r | |
556 | EFI_STATUS\r | |
557 | EFIAPI\r | |
558 | HttpUrlGetIp4 (\r | |
559 | IN CHAR8 *Url,\r | |
560 | IN VOID *UrlParser,\r | |
561 | OUT EFI_IPv4_ADDRESS *Ip4Address\r | |
562 | )\r | |
563 | {\r | |
564 | CHAR8 *Ip4String;\r | |
565 | EFI_STATUS Status;\r | |
566 | UINT32 ResultLength;\r | |
567 | HTTP_URL_PARSER *Parser;\r | |
568 | \r | |
569 | if (Url == NULL || UrlParser == NULL || Ip4Address == NULL) {\r | |
570 | return EFI_INVALID_PARAMETER;\r | |
571 | }\r | |
572 | \r | |
573 | Parser = (HTTP_URL_PARSER *) UrlParser;\r | |
574 | \r | |
575 | if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {\r | |
576 | return EFI_NOT_FOUND;\r | |
577 | }\r | |
578 | \r | |
579 | Ip4String = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1);\r | |
580 | if (Ip4String == NULL) {\r | |
581 | return EFI_OUT_OF_RESOURCES;\r | |
582 | }\r | |
583 | \r | |
584 | Status = UriPercentDecode (\r | |
585 | Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset,\r | |
586 | Parser->FieldData[HTTP_URI_FIELD_HOST].Length,\r | |
587 | Ip4String,\r | |
588 | &ResultLength\r | |
589 | );\r | |
590 | if (EFI_ERROR (Status)) {\r | |
591 | FreePool (Ip4String);\r | |
592 | return Status;\r | |
593 | }\r | |
594 | \r | |
595 | Ip4String[ResultLength] = '\0';\r | |
596 | Status = NetLibAsciiStrToIp4 (Ip4String, Ip4Address);\r | |
597 | FreePool (Ip4String);\r | |
598 | \r | |
599 | return Status;\r | |
600 | }\r | |
601 | \r | |
602 | /**\r | |
603 | Get the IPv6 address from a HTTP URL.\r | |
604 | \r | |
605 | This function will return the IPv6 address according to the Url and previous parse result.\r | |
606 | \r | |
607 | @param[in] Url The pointer to a HTTP URL string.\r | |
608 | @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().\r | |
609 | @param[out] Ip6Address Pointer to a buffer to store the IP address.\r | |
610 | \r | |
611 | @retval EFI_SUCCESS Successfully get the required component.\r | |
612 | @retval EFI_INVALID_PARAMETER Uri is NULL or Ip6Address is NULL or UrlParser is invalid.\r | |
613 | @retval EFI_NOT_FOUND No IPv6 address component in the URL.\r | |
614 | @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.\r | |
615 | \r | |
616 | **/\r | |
617 | EFI_STATUS\r | |
618 | EFIAPI\r | |
619 | HttpUrlGetIp6 (\r | |
620 | IN CHAR8 *Url,\r | |
621 | IN VOID *UrlParser,\r | |
622 | OUT EFI_IPv6_ADDRESS *Ip6Address\r | |
623 | )\r | |
624 | {\r | |
625 | CHAR8 *Ip6String;\r | |
626 | CHAR8 *Ptr;\r | |
627 | UINT32 Length;\r | |
628 | EFI_STATUS Status;\r | |
629 | UINT32 ResultLength;\r | |
630 | HTTP_URL_PARSER *Parser;\r | |
631 | \r | |
632 | if (Url == NULL || UrlParser == NULL || Ip6Address == NULL) {\r | |
633 | return EFI_INVALID_PARAMETER;\r | |
634 | }\r | |
635 | \r | |
636 | Parser = (HTTP_URL_PARSER *) UrlParser;\r | |
637 | \r | |
638 | if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {\r | |
639 | return EFI_NOT_FOUND;\r | |
640 | }\r | |
641 | \r | |
642 | //\r | |
643 | // IP-literal = "[" ( IPv6address / IPvFuture ) "]"\r | |
644 | //\r | |
645 | Length = Parser->FieldData[HTTP_URI_FIELD_HOST].Length;\r | |
646 | if (Length < 2) {\r | |
647 | return EFI_INVALID_PARAMETER;\r | |
648 | }\r | |
649 | \r | |
650 | Ptr = Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset;\r | |
651 | if ((Ptr[0] != '[') || (Ptr[Length - 1] != ']')) {\r | |
652 | return EFI_INVALID_PARAMETER;\r | |
653 | }\r | |
654 | \r | |
655 | Ip6String = AllocatePool (Length);\r | |
656 | if (Ip6String == NULL) {\r | |
657 | return EFI_OUT_OF_RESOURCES;\r | |
658 | }\r | |
659 | \r | |
660 | Status = UriPercentDecode (\r | |
661 | Ptr + 1,\r | |
662 | Length - 2,\r | |
663 | Ip6String,\r | |
664 | &ResultLength\r | |
665 | );\r | |
666 | if (EFI_ERROR (Status)) {\r | |
667 | FreePool (Ip6String);\r | |
668 | return Status;\r | |
669 | }\r | |
670 | \r | |
671 | Ip6String[ResultLength] = '\0';\r | |
672 | Status = NetLibAsciiStrToIp6 (Ip6String, Ip6Address);\r | |
673 | FreePool (Ip6String);\r | |
674 | \r | |
675 | return Status;\r | |
676 | }\r | |
677 | \r | |
678 | /**\r | |
679 | Get the port number from a HTTP URL.\r | |
680 | \r | |
681 | This function will return the port number according to the Url and previous parse result.\r | |
682 | \r | |
683 | @param[in] Url The pointer to a HTTP URL string.\r | |
684 | @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().\r | |
685 | @param[out] Port Pointer to a buffer to store the port number.\r | |
686 | \r | |
687 | @retval EFI_SUCCESS Successfully get the required component.\r | |
688 | @retval EFI_INVALID_PARAMETER Uri is NULL or Port is NULL or UrlParser is invalid.\r | |
689 | @retval EFI_NOT_FOUND No port number in the URL.\r | |
690 | @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.\r | |
691 | \r | |
692 | **/\r | |
693 | EFI_STATUS\r | |
694 | EFIAPI\r | |
695 | HttpUrlGetPort (\r | |
696 | IN CHAR8 *Url,\r | |
697 | IN VOID *UrlParser,\r | |
698 | OUT UINT16 *Port\r | |
699 | )\r | |
700 | {\r | |
701 | CHAR8 *PortString;\r | |
702 | EFI_STATUS Status;\r | |
703 | UINTN Index;\r | |
704 | UINTN Data;\r | |
705 | UINT32 ResultLength;\r | |
706 | HTTP_URL_PARSER *Parser;\r | |
707 | \r | |
708 | if (Url == NULL || UrlParser == NULL || Port == NULL) {\r | |
709 | return EFI_INVALID_PARAMETER;\r | |
710 | }\r | |
711 | \r | |
712 | *Port = 0;\r | |
713 | Index = 0;\r | |
714 | \r | |
715 | Parser = (HTTP_URL_PARSER *) UrlParser;\r | |
716 | \r | |
717 | if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PORT)) == 0) {\r | |
718 | return EFI_NOT_FOUND;\r | |
719 | }\r | |
720 | \r | |
721 | PortString = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PORT].Length + 1);\r | |
722 | if (PortString == NULL) {\r | |
723 | return EFI_OUT_OF_RESOURCES;\r | |
724 | }\r | |
725 | \r | |
726 | Status = UriPercentDecode (\r | |
727 | Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset,\r | |
728 | Parser->FieldData[HTTP_URI_FIELD_PORT].Length,\r | |
729 | PortString,\r | |
730 | &ResultLength\r | |
731 | );\r | |
732 | if (EFI_ERROR (Status)) {\r | |
733 | goto ON_EXIT;\r | |
734 | }\r | |
735 | \r | |
736 | PortString[ResultLength] = '\0';\r | |
737 | \r | |
738 | while (Index < ResultLength) {\r | |
739 | if (!NET_IS_DIGIT (PortString[Index])) {\r | |
740 | Status = EFI_INVALID_PARAMETER;\r | |
741 | goto ON_EXIT;\r | |
742 | }\r | |
743 | Index ++;\r | |
744 | }\r | |
745 | \r | |
746 | Status = AsciiStrDecimalToUintnS (Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset, (CHAR8 **) NULL, &Data);\r | |
747 | \r | |
748 | if (Data > HTTP_URI_PORT_MAX_NUM) {\r | |
749 | Status = EFI_INVALID_PARAMETER;\r | |
750 | goto ON_EXIT;\r | |
751 | }\r | |
752 | \r | |
753 | *Port = (UINT16) Data;\r | |
754 | \r | |
755 | ON_EXIT:\r | |
756 | FreePool (PortString);\r | |
757 | return Status;\r | |
758 | }\r | |
759 | \r | |
760 | /**\r | |
761 | Get the Path from a HTTP URL.\r | |
762 | \r | |
763 | This function will return the Path according to the Url and previous parse result,and\r | |
764 | it is the caller's responsibility to free the buffer returned in *Path.\r | |
765 | \r | |
766 | @param[in] Url The pointer to a HTTP URL string.\r | |
767 | @param[in] UrlParser URL Parse result returned by NetHttpParseUrl().\r | |
768 | @param[out] Path Pointer to a buffer to store the Path.\r | |
769 | \r | |
770 | @retval EFI_SUCCESS Successfully get the required component.\r | |
771 | @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid.\r | |
772 | @retval EFI_NOT_FOUND No hostName component in the URL.\r | |
773 | @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.\r | |
774 | \r | |
775 | **/\r | |
776 | EFI_STATUS\r | |
777 | EFIAPI\r | |
778 | HttpUrlGetPath (\r | |
779 | IN CHAR8 *Url,\r | |
780 | IN VOID *UrlParser,\r | |
781 | OUT CHAR8 **Path\r | |
782 | )\r | |
783 | {\r | |
784 | CHAR8 *PathStr;\r | |
785 | EFI_STATUS Status;\r | |
786 | UINT32 ResultLength;\r | |
787 | HTTP_URL_PARSER *Parser;\r | |
788 | \r | |
789 | if (Url == NULL || UrlParser == NULL || Path == NULL) {\r | |
790 | return EFI_INVALID_PARAMETER;\r | |
791 | }\r | |
792 | \r | |
793 | Parser = (HTTP_URL_PARSER *) UrlParser;\r | |
794 | \r | |
795 | if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PATH)) == 0) {\r | |
796 | return EFI_NOT_FOUND;\r | |
797 | }\r | |
798 | \r | |
799 | PathStr = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PATH].Length + 1);\r | |
800 | if (PathStr == NULL) {\r | |
801 | return EFI_OUT_OF_RESOURCES;\r | |
802 | }\r | |
803 | \r | |
804 | Status = UriPercentDecode (\r | |
805 | Url + Parser->FieldData[HTTP_URI_FIELD_PATH].Offset,\r | |
806 | Parser->FieldData[HTTP_URI_FIELD_PATH].Length,\r | |
807 | PathStr,\r | |
808 | &ResultLength\r | |
809 | );\r | |
810 | if (EFI_ERROR (Status)) {\r | |
811 | FreePool (PathStr);\r | |
812 | return Status;\r | |
813 | }\r | |
814 | \r | |
815 | PathStr[ResultLength] = '\0';\r | |
816 | *Path = PathStr;\r | |
817 | return EFI_SUCCESS;\r | |
818 | }\r | |
819 | \r | |
820 | /**\r | |
821 | Release the resource of the URL parser.\r | |
822 | \r | |
823 | @param[in] UrlParser Pointer to the parser.\r | |
824 | \r | |
825 | **/\r | |
826 | VOID\r | |
827 | EFIAPI\r | |
828 | HttpUrlFreeParser (\r | |
829 | IN VOID *UrlParser\r | |
830 | )\r | |
831 | {\r | |
832 | FreePool (UrlParser);\r | |
833 | }\r | |
834 | \r | |
835 | /**\r | |
836 | Find a specified header field according to the field name.\r | |
837 | \r | |
838 | @param[in] HeaderCount Number of HTTP header structures in Headers list.\r | |
839 | @param[in] Headers Array containing list of HTTP headers.\r | |
840 | @param[in] FieldName Null terminated string which describes a field name.\r | |
841 | \r | |
842 | @return Pointer to the found header or NULL.\r | |
843 | \r | |
844 | **/\r | |
845 | EFI_HTTP_HEADER *\r | |
846 | EFIAPI\r | |
847 | HttpFindHeader (\r | |
848 | IN UINTN HeaderCount,\r | |
849 | IN EFI_HTTP_HEADER *Headers,\r | |
850 | IN CHAR8 *FieldName\r | |
851 | )\r | |
852 | {\r | |
853 | UINTN Index;\r | |
854 | \r | |
855 | if (HeaderCount == 0 || Headers == NULL || FieldName == NULL) {\r | |
856 | return NULL;\r | |
857 | }\r | |
858 | \r | |
859 | for (Index = 0; Index < HeaderCount; Index++){\r | |
860 | //\r | |
861 | // Field names are case-insensitive (RFC 2616).\r | |
862 | //\r | |
863 | if (AsciiStriCmp (Headers[Index].FieldName, FieldName) == 0) {\r | |
864 | return &Headers[Index];\r | |
865 | }\r | |
866 | }\r | |
867 | return NULL;\r | |
868 | }\r | |
869 | \r | |
870 | typedef enum {\r | |
871 | BodyParserBodyStart,\r | |
872 | BodyParserBodyIdentity,\r | |
873 | BodyParserChunkSizeStart,\r | |
874 | BodyParserChunkSize,\r | |
875 | BodyParserChunkSizeEndCR,\r | |
876 | BodyParserChunkExtStart,\r | |
877 | BodyParserChunkDataStart,\r | |
878 | BodyParserChunkDataEnd,\r | |
879 | BodyParserChunkDataEndCR,\r | |
880 | BodyParserTrailer,\r | |
881 | BodyParserLastCRLF,\r | |
882 | BodyParserLastCRLFEnd,\r | |
883 | BodyParserComplete,\r | |
884 | BodyParserStateMax\r | |
885 | } HTTP_BODY_PARSE_STATE;\r | |
886 | \r | |
887 | typedef struct {\r | |
888 | BOOLEAN IgnoreBody; // "MUST NOT" include a message-body\r | |
889 | BOOLEAN IsChunked; // "chunked" transfer-coding.\r | |
890 | BOOLEAN ContentLengthIsValid;\r | |
891 | UINTN ContentLength; // Entity length (not the message-body length), invalid until ContentLengthIsValid is TRUE\r | |
892 | \r | |
893 | HTTP_BODY_PARSER_CALLBACK Callback;\r | |
894 | VOID *Context;\r | |
895 | UINTN ParsedBodyLength;\r | |
896 | HTTP_BODY_PARSE_STATE State;\r | |
897 | UINTN CurrentChunkSize;\r | |
898 | UINTN CurrentChunkParsedSize;\r | |
899 | } HTTP_BODY_PARSER;\r | |
900 | \r | |
901 | /**\r | |
902 | Convert an hexadecimal char to a value of type UINTN.\r | |
903 | \r | |
904 | @param[in] Char Ascii character.\r | |
905 | \r | |
906 | @return Value translated from Char.\r | |
907 | \r | |
908 | **/\r | |
909 | UINTN\r | |
910 | HttpIoHexCharToUintn (\r | |
911 | IN CHAR8 Char\r | |
912 | )\r | |
913 | {\r | |
914 | if (Char >= '0' && Char <= '9') {\r | |
915 | return Char - '0';\r | |
916 | }\r | |
917 | \r | |
918 | return (10 + AsciiCharToUpper (Char) - 'A');\r | |
919 | }\r | |
920 | \r | |
921 | /**\r | |
922 | Get the value of the content length if there is a "Content-Length" header.\r | |
923 | \r | |
924 | @param[in] HeaderCount Number of HTTP header structures in Headers.\r | |
925 | @param[in] Headers Array containing list of HTTP headers.\r | |
926 | @param[out] ContentLength Pointer to save the value of the content length.\r | |
927 | \r | |
928 | @retval EFI_SUCCESS Successfully get the content length.\r | |
929 | @retval EFI_NOT_FOUND No "Content-Length" header in the Headers.\r | |
930 | \r | |
931 | **/\r | |
932 | EFI_STATUS\r | |
933 | HttpIoParseContentLengthHeader (\r | |
934 | IN UINTN HeaderCount,\r | |
935 | IN EFI_HTTP_HEADER *Headers,\r | |
936 | OUT UINTN *ContentLength\r | |
937 | )\r | |
938 | {\r | |
939 | EFI_HTTP_HEADER *Header;\r | |
940 | \r | |
941 | Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_CONTENT_LENGTH);\r | |
942 | if (Header == NULL) {\r | |
943 | return EFI_NOT_FOUND;\r | |
944 | }\r | |
945 | \r | |
946 | return AsciiStrDecimalToUintnS (Header->FieldValue, (CHAR8 **) NULL, ContentLength);\r | |
947 | }\r | |
948 | \r | |
949 | /**\r | |
950 | \r | |
951 | Check whether the HTTP message is using the "chunked" transfer-coding.\r | |
952 | \r | |
953 | @param[in] HeaderCount Number of HTTP header structures in Headers.\r | |
954 | @param[in] Headers Array containing list of HTTP headers.\r | |
955 | \r | |
956 | @return The message is "chunked" transfer-coding (TRUE) or not (FALSE).\r | |
957 | \r | |
958 | **/\r | |
959 | BOOLEAN\r | |
960 | HttpIoIsChunked (\r | |
961 | IN UINTN HeaderCount,\r | |
962 | IN EFI_HTTP_HEADER *Headers\r | |
963 | )\r | |
964 | {\r | |
965 | EFI_HTTP_HEADER *Header;\r | |
966 | \r | |
967 | \r | |
968 | Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_TRANSFER_ENCODING);\r | |
969 | if (Header == NULL) {\r | |
970 | return FALSE;\r | |
971 | }\r | |
972 | \r | |
973 | if (AsciiStriCmp (Header->FieldValue, "identity") != 0) {\r | |
974 | return TRUE;\r | |
975 | }\r | |
976 | \r | |
977 | return FALSE;\r | |
978 | }\r | |
979 | \r | |
980 | /**\r | |
981 | Check whether the HTTP message should have a message-body.\r | |
982 | \r | |
983 | @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message.\r | |
984 | @param[in] StatusCode Response status code returned by the remote host.\r | |
985 | \r | |
986 | @return The message should have a message-body (FALSE) or not (TRUE).\r | |
987 | \r | |
988 | **/\r | |
989 | BOOLEAN\r | |
990 | HttpIoNoMessageBody (\r | |
991 | IN EFI_HTTP_METHOD Method,\r | |
992 | IN EFI_HTTP_STATUS_CODE StatusCode\r | |
993 | )\r | |
994 | {\r | |
995 | //\r | |
996 | // RFC 2616:\r | |
997 | // All responses to the HEAD request method\r | |
998 | // MUST NOT include a message-body, even though the presence of entity-\r | |
999 | // header fields might lead one to believe they do. All 1xx\r | |
1000 | // (informational), 204 (no content), and 304 (not modified) responses\r | |
1001 | // MUST NOT include a message-body. All other responses do include a\r | |
1002 | // message-body, although it MAY be of zero length.\r | |
1003 | //\r | |
1004 | if (Method == HttpMethodHead) {\r | |
1005 | return TRUE;\r | |
1006 | }\r | |
1007 | \r | |
1008 | if ((StatusCode == HTTP_STATUS_100_CONTINUE) ||\r | |
1009 | (StatusCode == HTTP_STATUS_101_SWITCHING_PROTOCOLS) ||\r | |
1010 | (StatusCode == HTTP_STATUS_204_NO_CONTENT) ||\r | |
1011 | (StatusCode == HTTP_STATUS_304_NOT_MODIFIED))\r | |
1012 | {\r | |
1013 | return TRUE;\r | |
1014 | }\r | |
1015 | \r | |
1016 | return FALSE;\r | |
1017 | }\r | |
1018 | \r | |
1019 | /**\r | |
1020 | Initialize a HTTP message-body parser.\r | |
1021 | \r | |
1022 | This function will create and initialize a HTTP message parser according to caller provided HTTP message\r | |
1023 | header information. It is the caller's responsibility to free the buffer returned in *UrlParser by HttpFreeMsgParser().\r | |
1024 | \r | |
1025 | @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message.\r | |
1026 | @param[in] StatusCode Response status code returned by the remote host.\r | |
1027 | @param[in] HeaderCount Number of HTTP header structures in Headers.\r | |
1028 | @param[in] Headers Array containing list of HTTP headers.\r | |
1029 | @param[in] Callback Callback function that is invoked when parsing the HTTP message-body,\r | |
1030 | set to NULL to ignore all events.\r | |
1031 | @param[in] Context Pointer to the context that will be passed to Callback.\r | |
1032 | @param[out] MsgParser Pointer to the returned buffer to store the message parser.\r | |
1033 | \r | |
1034 | @retval EFI_SUCCESS Successfully initialized the parser.\r | |
1035 | @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.\r | |
1036 | @retval EFI_INVALID_PARAMETER MsgParser is NULL or HeaderCount is not NULL but Headers is NULL.\r | |
1037 | @retval Others Failed to initialize the parser.\r | |
1038 | \r | |
1039 | **/\r | |
1040 | EFI_STATUS\r | |
1041 | EFIAPI\r | |
1042 | HttpInitMsgParser (\r | |
1043 | IN EFI_HTTP_METHOD Method,\r | |
1044 | IN EFI_HTTP_STATUS_CODE StatusCode,\r | |
1045 | IN UINTN HeaderCount,\r | |
1046 | IN EFI_HTTP_HEADER *Headers,\r | |
1047 | IN HTTP_BODY_PARSER_CALLBACK Callback,\r | |
1048 | IN VOID *Context,\r | |
1049 | OUT VOID **MsgParser\r | |
1050 | )\r | |
1051 | {\r | |
1052 | EFI_STATUS Status;\r | |
1053 | HTTP_BODY_PARSER *Parser;\r | |
1054 | \r | |
1055 | if (HeaderCount != 0 && Headers == NULL) {\r | |
1056 | return EFI_INVALID_PARAMETER;\r | |
1057 | }\r | |
1058 | \r | |
1059 | if (MsgParser == NULL) {\r | |
1060 | return EFI_INVALID_PARAMETER;\r | |
1061 | }\r | |
1062 | \r | |
1063 | Parser = AllocateZeroPool (sizeof (HTTP_BODY_PARSER));\r | |
1064 | if (Parser == NULL) {\r | |
1065 | return EFI_OUT_OF_RESOURCES;\r | |
1066 | }\r | |
1067 | \r | |
1068 | Parser->State = BodyParserBodyStart;\r | |
1069 | \r | |
1070 | //\r | |
1071 | // Determine the message length according to RFC 2616.\r | |
1072 | // 1. Check whether the message "MUST NOT" have a message-body.\r | |
1073 | //\r | |
1074 | Parser->IgnoreBody = HttpIoNoMessageBody (Method, StatusCode);\r | |
1075 | //\r | |
1076 | // 2. Check whether the message using "chunked" transfer-coding.\r | |
1077 | //\r | |
1078 | Parser->IsChunked = HttpIoIsChunked (HeaderCount, Headers);\r | |
1079 | //\r | |
1080 | // 3. Check whether the message has a Content-Length header field.\r | |
1081 | //\r | |
1082 | Status = HttpIoParseContentLengthHeader (HeaderCount, Headers, &Parser->ContentLength);\r | |
1083 | if (!EFI_ERROR (Status)) {\r | |
1084 | Parser->ContentLengthIsValid = TRUE;\r | |
1085 | }\r | |
1086 | //\r | |
1087 | // 4. Range header is not supported now, so we won't meet media type "multipart/byteranges".\r | |
1088 | // 5. By server closing the connection\r | |
1089 | //\r | |
1090 | \r | |
1091 | //\r | |
1092 | // Set state to skip body parser if the message shouldn't have a message body.\r | |
1093 | //\r | |
1094 | if (Parser->IgnoreBody) {\r | |
1095 | Parser->State = BodyParserComplete;\r | |
1096 | } else {\r | |
1097 | Parser->Callback = Callback;\r | |
1098 | Parser->Context = Context;\r | |
1099 | }\r | |
1100 | \r | |
1101 | *MsgParser = Parser;\r | |
1102 | return EFI_SUCCESS;\r | |
1103 | }\r | |
1104 | \r | |
1105 | /**\r | |
1106 | Parse message body.\r | |
1107 | \r | |
1108 | Parse BodyLength of message-body. This function can be called repeatedly to parse the message-body partially.\r | |
1109 | \r | |
1110 | @param[in, out] MsgParser Pointer to the message parser.\r | |
1111 | @param[in] BodyLength Length in bytes of the Body.\r | |
1112 | @param[in] Body Pointer to the buffer of the message-body to be parsed.\r | |
1113 | \r | |
1114 | @retval EFI_SUCCESS Successfully parse the message-body.\r | |
1115 | @retval EFI_INVALID_PARAMETER MsgParser is NULL or Body is NULL or BodyLength is 0.\r | |
1116 | @retval EFI_ABORTED Operation aborted.\r | |
1117 | @retval Other Error happened while parsing message body.\r | |
1118 | \r | |
1119 | **/\r | |
1120 | EFI_STATUS\r | |
1121 | EFIAPI\r | |
1122 | HttpParseMessageBody (\r | |
1123 | IN OUT VOID *MsgParser,\r | |
1124 | IN UINTN BodyLength,\r | |
1125 | IN CHAR8 *Body\r | |
1126 | )\r | |
1127 | {\r | |
1128 | CHAR8 *Char;\r | |
1129 | UINTN RemainderLengthInThis;\r | |
1130 | UINTN LengthForCallback;\r | |
1131 | EFI_STATUS Status;\r | |
1132 | HTTP_BODY_PARSER *Parser;\r | |
1133 | \r | |
1134 | if (BodyLength == 0 || Body == NULL) {\r | |
1135 | return EFI_INVALID_PARAMETER;\r | |
1136 | }\r | |
1137 | \r | |
1138 | if (MsgParser == NULL) {\r | |
1139 | return EFI_INVALID_PARAMETER;\r | |
1140 | }\r | |
1141 | \r | |
1142 | Parser = (HTTP_BODY_PARSER *) MsgParser;\r | |
1143 | \r | |
1144 | if (Parser->IgnoreBody) {\r | |
1145 | Parser->State = BodyParserComplete;\r | |
1146 | if (Parser->Callback != NULL) {\r | |
1147 | Status = Parser->Callback (\r | |
1148 | BodyParseEventOnComplete,\r | |
1149 | Body,\r | |
1150 | 0,\r | |
1151 | Parser->Context\r | |
1152 | );\r | |
1153 | if (EFI_ERROR (Status)) {\r | |
1154 | return Status;\r | |
1155 | }\r | |
1156 | }\r | |
1157 | return EFI_SUCCESS;\r | |
1158 | }\r | |
1159 | \r | |
1160 | if (Parser->State == BodyParserBodyStart) {\r | |
1161 | Parser->ParsedBodyLength = 0;\r | |
1162 | if (Parser->IsChunked) {\r | |
1163 | Parser->State = BodyParserChunkSizeStart;\r | |
1164 | } else {\r | |
1165 | Parser->State = BodyParserBodyIdentity;\r | |
1166 | }\r | |
1167 | }\r | |
1168 | \r | |
1169 | //\r | |
1170 | // The message body might be truncated in anywhere, so we need to parse is byte-by-byte.\r | |
1171 | //\r | |
1172 | for (Char = Body; Char < Body + BodyLength; ) {\r | |
1173 | \r | |
1174 | switch (Parser->State) {\r | |
1175 | case BodyParserStateMax:\r | |
1176 | return EFI_ABORTED;\r | |
1177 | \r | |
1178 | case BodyParserBodyIdentity:\r | |
1179 | //\r | |
1180 | // Identity transfer-coding, just notify user to save the body data.\r | |
1181 | //\r | |
1182 | if (Parser->Callback != NULL) {\r | |
1183 | Status = Parser->Callback (\r | |
1184 | BodyParseEventOnData,\r | |
1185 | Char,\r | |
1186 | MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength),\r | |
1187 | Parser->Context\r | |
1188 | );\r | |
1189 | if (EFI_ERROR (Status)) {\r | |
1190 | return Status;\r | |
1191 | }\r | |
1192 | }\r | |
1193 | Char += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength);\r | |
1194 | Parser->ParsedBodyLength += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength);\r | |
1195 | if (Parser->ParsedBodyLength == Parser->ContentLength) {\r | |
1196 | Parser->State = BodyParserComplete;\r | |
1197 | if (Parser->Callback != NULL) {\r | |
1198 | Status = Parser->Callback (\r | |
1199 | BodyParseEventOnComplete,\r | |
1200 | Char,\r | |
1201 | 0,\r | |
1202 | Parser->Context\r | |
1203 | );\r | |
1204 | if (EFI_ERROR (Status)) {\r | |
1205 | return Status;\r | |
1206 | }\r | |
1207 | }\r | |
1208 | }\r | |
1209 | break;\r | |
1210 | \r | |
1211 | case BodyParserChunkSizeStart:\r | |
1212 | //\r | |
1213 | // First byte of chunk-size, the chunk-size might be truncated.\r | |
1214 | //\r | |
1215 | Parser->CurrentChunkSize = 0;\r | |
1216 | Parser->State = BodyParserChunkSize;\r | |
1217 | case BodyParserChunkSize:\r | |
1218 | if (!NET_IS_HEX_CHAR (*Char)) {\r | |
1219 | if (*Char == ';') {\r | |
1220 | Parser->State = BodyParserChunkExtStart;\r | |
1221 | Char++;\r | |
1222 | } else if (*Char == '\r') {\r | |
1223 | Parser->State = BodyParserChunkSizeEndCR;\r | |
1224 | Char++;\r | |
1225 | } else {\r | |
1226 | Parser->State = BodyParserStateMax;\r | |
1227 | }\r | |
1228 | break;\r | |
1229 | }\r | |
1230 | \r | |
1231 | if (Parser->CurrentChunkSize > (((~((UINTN) 0)) - 16) / 16)) {\r | |
1232 | return EFI_INVALID_PARAMETER;\r | |
1233 | }\r | |
1234 | Parser->CurrentChunkSize = Parser->CurrentChunkSize * 16 + HttpIoHexCharToUintn (*Char);\r | |
1235 | Char++;\r | |
1236 | break;\r | |
1237 | \r | |
1238 | case BodyParserChunkExtStart:\r | |
1239 | //\r | |
1240 | // Ignore all the chunk extensions.\r | |
1241 | //\r | |
1242 | if (*Char == '\r') {\r | |
1243 | Parser->State = BodyParserChunkSizeEndCR;\r | |
1244 | }\r | |
1245 | Char++;\r | |
1246 | break;\r | |
1247 | \r | |
1248 | case BodyParserChunkSizeEndCR:\r | |
1249 | if (*Char != '\n') {\r | |
1250 | Parser->State = BodyParserStateMax;\r | |
1251 | break;\r | |
1252 | }\r | |
1253 | Char++;\r | |
1254 | if (Parser->CurrentChunkSize == 0) {\r | |
1255 | //\r | |
1256 | // The last chunk has been parsed and now assumed the state\r | |
1257 | // of HttpBodyParse is ParserLastCRLF. So it need to decide\r | |
1258 | // whether the rest message is trailer or last CRLF in the next round.\r | |
1259 | //\r | |
1260 | Parser->ContentLengthIsValid = TRUE;\r | |
1261 | Parser->State = BodyParserLastCRLF;\r | |
1262 | break;\r | |
1263 | }\r | |
1264 | Parser->State = BodyParserChunkDataStart;\r | |
1265 | Parser->CurrentChunkParsedSize = 0;\r | |
1266 | break;\r | |
1267 | \r | |
1268 | case BodyParserLastCRLF:\r | |
1269 | //\r | |
1270 | // Judge the byte is belong to the Last CRLF or trailer, and then\r | |
1271 | // configure the state of HttpBodyParse to corresponding state.\r | |
1272 | //\r | |
1273 | if (*Char == '\r') {\r | |
1274 | Char++;\r | |
1275 | Parser->State = BodyParserLastCRLFEnd;\r | |
1276 | break;\r | |
1277 | } else {\r | |
1278 | Parser->State = BodyParserTrailer;\r | |
1279 | break;\r | |
1280 | }\r | |
1281 | \r | |
1282 | case BodyParserLastCRLFEnd:\r | |
1283 | if (*Char == '\n') {\r | |
1284 | Parser->State = BodyParserComplete;\r | |
1285 | Char++;\r | |
1286 | if (Parser->Callback != NULL) {\r | |
1287 | Status = Parser->Callback (\r | |
1288 | BodyParseEventOnComplete,\r | |
1289 | Char,\r | |
1290 | 0,\r | |
1291 | Parser->Context\r | |
1292 | );\r | |
1293 | if (EFI_ERROR (Status)) {\r | |
1294 | return Status;\r | |
1295 | }\r | |
1296 | }\r | |
1297 | break;\r | |
1298 | } else {\r | |
1299 | Parser->State = BodyParserStateMax;\r | |
1300 | break;\r | |
1301 | }\r | |
1302 | \r | |
1303 | case BodyParserTrailer:\r | |
1304 | if (*Char == '\r') {\r | |
1305 | Parser->State = BodyParserChunkSizeEndCR;\r | |
1306 | }\r | |
1307 | Char++;\r | |
1308 | break;\r | |
1309 | \r | |
1310 | case BodyParserChunkDataStart:\r | |
1311 | //\r | |
1312 | // First byte of chunk-data, the chunk data also might be truncated.\r | |
1313 | //\r | |
1314 | RemainderLengthInThis = BodyLength - (Char - Body);\r | |
1315 | LengthForCallback = MIN (Parser->CurrentChunkSize - Parser->CurrentChunkParsedSize, RemainderLengthInThis);\r | |
1316 | if (Parser->Callback != NULL) {\r | |
1317 | Status = Parser->Callback (\r | |
1318 | BodyParseEventOnData,\r | |
1319 | Char,\r | |
1320 | LengthForCallback,\r | |
1321 | Parser->Context\r | |
1322 | );\r | |
1323 | if (EFI_ERROR (Status)) {\r | |
1324 | return Status;\r | |
1325 | }\r | |
1326 | }\r | |
1327 | Char += LengthForCallback;\r | |
1328 | Parser->ContentLength += LengthForCallback;\r | |
1329 | Parser->CurrentChunkParsedSize += LengthForCallback;\r | |
1330 | if (Parser->CurrentChunkParsedSize == Parser->CurrentChunkSize) {\r | |
1331 | Parser->State = BodyParserChunkDataEnd;\r | |
1332 | }\r | |
1333 | break;\r | |
1334 | \r | |
1335 | case BodyParserChunkDataEnd:\r | |
1336 | if (*Char == '\r') {\r | |
1337 | Parser->State = BodyParserChunkDataEndCR;\r | |
1338 | } else {\r | |
1339 | Parser->State = BodyParserStateMax;\r | |
1340 | }\r | |
1341 | Char++;\r | |
1342 | break;\r | |
1343 | \r | |
1344 | case BodyParserChunkDataEndCR:\r | |
1345 | if (*Char != '\n') {\r | |
1346 | Parser->State = BodyParserStateMax;\r | |
1347 | break;\r | |
1348 | }\r | |
1349 | Char++;\r | |
1350 | Parser->State = BodyParserChunkSizeStart;\r | |
1351 | break;\r | |
1352 | \r | |
1353 | default:\r | |
1354 | break;\r | |
1355 | }\r | |
1356 | \r | |
1357 | }\r | |
1358 | \r | |
1359 | if (Parser->State == BodyParserStateMax) {\r | |
1360 | return EFI_ABORTED;\r | |
1361 | }\r | |
1362 | \r | |
1363 | return EFI_SUCCESS;\r | |
1364 | }\r | |
1365 | \r | |
1366 | /**\r | |
1367 | Check whether the message-body is complete or not.\r | |
1368 | \r | |
1369 | @param[in] MsgParser Pointer to the message parser.\r | |
1370 | \r | |
1371 | @retval TRUE Message-body is complete.\r | |
1372 | @retval FALSE Message-body is not complete.\r | |
1373 | \r | |
1374 | **/\r | |
1375 | BOOLEAN\r | |
1376 | EFIAPI\r | |
1377 | HttpIsMessageComplete (\r | |
1378 | IN VOID *MsgParser\r | |
1379 | )\r | |
1380 | {\r | |
1381 | HTTP_BODY_PARSER *Parser;\r | |
1382 | \r | |
1383 | if (MsgParser == NULL) {\r | |
1384 | return FALSE;\r | |
1385 | }\r | |
1386 | \r | |
1387 | Parser = (HTTP_BODY_PARSER *) MsgParser;\r | |
1388 | \r | |
1389 | if (Parser->State == BodyParserComplete) {\r | |
1390 | return TRUE;\r | |
1391 | }\r | |
1392 | return FALSE;\r | |
1393 | }\r | |
1394 | \r | |
1395 | /**\r | |
1396 | Get the content length of the entity.\r | |
1397 | \r | |
1398 | Note that in trunk transfer, the entity length is not valid until the whole message body is received.\r | |
1399 | \r | |
1400 | @param[in] MsgParser Pointer to the message parser.\r | |
1401 | @param[out] ContentLength Pointer to store the length of the entity.\r | |
1402 | \r | |
1403 | @retval EFI_SUCCESS Successfully to get the entity length.\r | |
1404 | @retval EFI_NOT_READY Entity length is not valid yet.\r | |
1405 | @retval EFI_INVALID_PARAMETER MsgParser is NULL or ContentLength is NULL.\r | |
1406 | \r | |
1407 | **/\r | |
1408 | EFI_STATUS\r | |
1409 | EFIAPI\r | |
1410 | HttpGetEntityLength (\r | |
1411 | IN VOID *MsgParser,\r | |
1412 | OUT UINTN *ContentLength\r | |
1413 | )\r | |
1414 | {\r | |
1415 | HTTP_BODY_PARSER *Parser;\r | |
1416 | \r | |
1417 | if (MsgParser == NULL || ContentLength == NULL) {\r | |
1418 | return EFI_INVALID_PARAMETER;\r | |
1419 | }\r | |
1420 | \r | |
1421 | Parser = (HTTP_BODY_PARSER *) MsgParser;\r | |
1422 | \r | |
1423 | if (!Parser->ContentLengthIsValid) {\r | |
1424 | return EFI_NOT_READY;\r | |
1425 | }\r | |
1426 | \r | |
1427 | *ContentLength = Parser->ContentLength;\r | |
1428 | return EFI_SUCCESS;\r | |
1429 | }\r | |
1430 | \r | |
1431 | /**\r | |
1432 | Release the resource of the message parser.\r | |
1433 | \r | |
1434 | @param[in] MsgParser Pointer to the message parser.\r | |
1435 | \r | |
1436 | **/\r | |
1437 | VOID\r | |
1438 | EFIAPI\r | |
1439 | HttpFreeMsgParser (\r | |
1440 | IN VOID *MsgParser\r | |
1441 | )\r | |
1442 | {\r | |
1443 | FreePool (MsgParser);\r | |
1444 | }\r | |
1445 | \r | |
1446 | \r | |
1447 | /**\r | |
1448 | Get the next string, which is distinguished by specified separator.\r | |
1449 | \r | |
1450 | @param[in] String Pointer to the string.\r | |
1451 | @param[in] Separator Specified separator used to distinguish where is the beginning\r | |
1452 | of next string.\r | |
1453 | \r | |
1454 | @return Pointer to the next string.\r | |
1455 | @return NULL if not find or String is NULL.\r | |
1456 | \r | |
1457 | **/\r | |
1458 | CHAR8 *\r | |
1459 | AsciiStrGetNextToken (\r | |
1460 | IN CONST CHAR8 *String,\r | |
1461 | IN CHAR8 Separator\r | |
1462 | )\r | |
1463 | {\r | |
1464 | CONST CHAR8 *Token;\r | |
1465 | \r | |
1466 | Token = String;\r | |
1467 | while (TRUE) {\r | |
1468 | if (*Token == 0) {\r | |
1469 | return NULL;\r | |
1470 | }\r | |
1471 | if (*Token == Separator) {\r | |
1472 | return (CHAR8 *)(Token + 1);\r | |
1473 | }\r | |
1474 | Token++;\r | |
1475 | }\r | |
1476 | }\r | |
1477 | \r | |
1478 | /**\r | |
1479 | Set FieldName and FieldValue into specified HttpHeader.\r | |
1480 | \r | |
1481 | @param[in,out] HttpHeader Specified HttpHeader.\r | |
1482 | @param[in] FieldName FieldName of this HttpHeader, a NULL terminated ASCII string.\r | |
1483 | @param[in] FieldValue FieldValue of this HttpHeader, a NULL terminated ASCII string.\r | |
1484 | \r | |
1485 | \r | |
1486 | @retval EFI_SUCCESS The FieldName and FieldValue are set into HttpHeader successfully.\r | |
1487 | @retval EFI_INVALID_PARAMETER The parameter is invalid.\r | |
1488 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r | |
1489 | \r | |
1490 | **/\r | |
1491 | EFI_STATUS\r | |
1492 | EFIAPI\r | |
1493 | HttpSetFieldNameAndValue (\r | |
1494 | IN OUT EFI_HTTP_HEADER *HttpHeader,\r | |
1495 | IN CONST CHAR8 *FieldName,\r | |
1496 | IN CONST CHAR8 *FieldValue\r | |
1497 | )\r | |
1498 | {\r | |
1499 | UINTN FieldNameSize;\r | |
1500 | UINTN FieldValueSize;\r | |
1501 | \r | |
1502 | if (HttpHeader == NULL || FieldName == NULL || FieldValue == NULL) {\r | |
1503 | return EFI_INVALID_PARAMETER;\r | |
1504 | }\r | |
1505 | \r | |
1506 | if (HttpHeader->FieldName != NULL) {\r | |
1507 | FreePool (HttpHeader->FieldName);\r | |
1508 | }\r | |
1509 | if (HttpHeader->FieldValue != NULL) {\r | |
1510 | FreePool (HttpHeader->FieldValue);\r | |
1511 | }\r | |
1512 | \r | |
1513 | FieldNameSize = AsciiStrSize (FieldName);\r | |
1514 | HttpHeader->FieldName = AllocateZeroPool (FieldNameSize);\r | |
1515 | if (HttpHeader->FieldName == NULL) {\r | |
1516 | return EFI_OUT_OF_RESOURCES;\r | |
1517 | }\r | |
1518 | CopyMem (HttpHeader->FieldName, FieldName, FieldNameSize);\r | |
1519 | HttpHeader->FieldName[FieldNameSize - 1] = 0;\r | |
1520 | \r | |
1521 | FieldValueSize = AsciiStrSize (FieldValue);\r | |
1522 | HttpHeader->FieldValue = AllocateZeroPool (FieldValueSize);\r | |
1523 | if (HttpHeader->FieldValue == NULL) {\r | |
1524 | FreePool (HttpHeader->FieldName);\r | |
1525 | return EFI_OUT_OF_RESOURCES;\r | |
1526 | }\r | |
1527 | CopyMem (HttpHeader->FieldValue, FieldValue, FieldValueSize);\r | |
1528 | HttpHeader->FieldValue[FieldValueSize - 1] = 0;\r | |
1529 | \r | |
1530 | return EFI_SUCCESS;\r | |
1531 | }\r | |
1532 | \r | |
1533 | /**\r | |
1534 | Get one key/value header pair from the raw string.\r | |
1535 | \r | |
1536 | @param[in] String Pointer to the raw string.\r | |
1537 | @param[out] FieldName Points directly to field name within 'HttpHeader'.\r | |
1538 | @param[out] FieldValue Points directly to field value within 'HttpHeader'.\r | |
1539 | \r | |
1540 | @return Pointer to the next raw string.\r | |
1541 | @return NULL if no key/value header pair from this raw string.\r | |
1542 | \r | |
1543 | **/\r | |
1544 | CHAR8 *\r | |
1545 | EFIAPI\r | |
1546 | HttpGetFieldNameAndValue (\r | |
1547 | IN CHAR8 *String,\r | |
1548 | OUT CHAR8 **FieldName,\r | |
1549 | OUT CHAR8 **FieldValue\r | |
1550 | )\r | |
1551 | {\r | |
1552 | CHAR8 *FieldNameStr;\r | |
1553 | CHAR8 *FieldValueStr;\r | |
1554 | CHAR8 *StrPtr;\r | |
1555 | CHAR8 *EndofHeader;\r | |
1556 | \r | |
1557 | if (String == NULL || FieldName == NULL || FieldValue == NULL) {\r | |
1558 | return NULL;\r | |
1559 | }\r | |
1560 | \r | |
1561 | *FieldName = NULL;\r | |
1562 | *FieldValue = NULL;\r | |
1563 | FieldNameStr = NULL;\r | |
1564 | FieldValueStr = NULL;\r | |
1565 | StrPtr = NULL;\r | |
1566 | EndofHeader = NULL;\r | |
1567 | \r | |
1568 | \r | |
1569 | //\r | |
1570 | // Check whether the raw HTTP header string is valid or not.\r | |
1571 | //\r | |
1572 | EndofHeader = AsciiStrStr (String, "\r\n\r\n");\r | |
1573 | if (EndofHeader == NULL) {\r | |
1574 | return NULL;\r | |
1575 | }\r | |
1576 | \r | |
1577 | //\r | |
1578 | // Each header field consists of a name followed by a colon (":") and the field value.\r | |
1579 | // The field value MAY be preceded by any amount of LWS, though a single SP is preferred.\r | |
1580 | //\r | |
1581 | // message-header = field-name ":" [ field-value ]\r | |
1582 | // field-name = token\r | |
1583 | // field-value = *( field-content | LWS )\r | |
1584 | //\r | |
1585 | // Note: "*(element)" allows any number element, including zero; "1*(element)" requires at least one element.\r | |
1586 | // [element] means element is optional.\r | |
1587 | // LWS = [CRLF] 1*(SP|HT), it can be ' ' or '\t' or '\r\n ' or '\r\n\t'.\r | |
1588 | // CRLF = '\r\n'.\r | |
1589 | // SP = ' '.\r | |
1590 | // HT = '\t' (Tab).\r | |
1591 | //\r | |
1592 | FieldNameStr = String;\r | |
1593 | FieldValueStr = AsciiStrGetNextToken (FieldNameStr, ':');\r | |
1594 | if (FieldValueStr == NULL) {\r | |
1595 | return NULL;\r | |
1596 | }\r | |
1597 | \r | |
1598 | //\r | |
1599 | // Replace ':' with 0, then FieldName has been retrived from String.\r | |
1600 | //\r | |
1601 | *(FieldValueStr - 1) = 0;\r | |
1602 | \r | |
1603 | //\r | |
1604 | // Handle FieldValueStr, skip all the preceded LWS.\r | |
1605 | //\r | |
1606 | while (TRUE) {\r | |
1607 | if (*FieldValueStr == ' ' || *FieldValueStr == '\t') {\r | |
1608 | //\r | |
1609 | // Boundary condition check.\r | |
1610 | //\r | |
1611 | if ((UINTN) EndofHeader - (UINTN) FieldValueStr < 1) {\r | |
1612 | //\r | |
1613 | // Wrong String format!\r | |
1614 | //\r | |
1615 | return NULL;\r | |
1616 | }\r | |
1617 | \r | |
1618 | FieldValueStr ++;\r | |
1619 | } else if (*FieldValueStr == '\r') {\r | |
1620 | //\r | |
1621 | // Boundary condition check.\r | |
1622 | //\r | |
1623 | if ((UINTN) EndofHeader - (UINTN) FieldValueStr < 3) {\r | |
1624 | //\r | |
1625 | // No more preceded LWS, so break here.\r | |
1626 | //\r | |
1627 | break;\r | |
1628 | }\r | |
1629 | \r | |
1630 | if (*(FieldValueStr + 1) == '\n' ) {\r | |
1631 | if (*(FieldValueStr + 2) == ' ' || *(FieldValueStr + 2) == '\t') {\r | |
1632 | FieldValueStr = FieldValueStr + 3;\r | |
1633 | } else {\r | |
1634 | //\r | |
1635 | // No more preceded LWS, so break here.\r | |
1636 | //\r | |
1637 | break;\r | |
1638 | }\r | |
1639 | } else {\r | |
1640 | //\r | |
1641 | // Wrong String format!\r | |
1642 | //\r | |
1643 | return NULL;\r | |
1644 | }\r | |
1645 | } else {\r | |
1646 | //\r | |
1647 | // No more preceded LWS, so break here.\r | |
1648 | //\r | |
1649 | break;\r | |
1650 | }\r | |
1651 | }\r | |
1652 | \r | |
1653 | StrPtr = FieldValueStr;\r | |
1654 | do {\r | |
1655 | //\r | |
1656 | // Handle the LWS within the field value.\r | |
1657 | //\r | |
1658 | StrPtr = AsciiStrGetNextToken (StrPtr, '\r');\r | |
1659 | if (StrPtr == NULL || *StrPtr != '\n') {\r | |
1660 | //\r | |
1661 | // Wrong String format!\r | |
1662 | //\r | |
1663 | return NULL;\r | |
1664 | }\r | |
1665 | \r | |
1666 | StrPtr++;\r | |
1667 | } while (*StrPtr == ' ' || *StrPtr == '\t');\r | |
1668 | \r | |
1669 | //\r | |
1670 | // Replace '\r' with 0\r | |
1671 | //\r | |
1672 | *(StrPtr - 2) = 0;\r | |
1673 | \r | |
1674 | //\r | |
1675 | // Get FieldName and FieldValue.\r | |
1676 | //\r | |
1677 | *FieldName = FieldNameStr;\r | |
1678 | *FieldValue = FieldValueStr;\r | |
1679 | \r | |
1680 | return StrPtr;\r | |
1681 | }\r | |
1682 | \r | |
1683 | /**\r | |
1684 | Free existing HeaderFields.\r | |
1685 | \r | |
1686 | @param[in] HeaderFields Pointer to array of key/value header pairs waitting for free.\r | |
1687 | @param[in] FieldCount The number of header pairs in HeaderFields.\r | |
1688 | \r | |
1689 | **/\r | |
1690 | VOID\r | |
1691 | EFIAPI\r | |
1692 | HttpFreeHeaderFields (\r | |
1693 | IN EFI_HTTP_HEADER *HeaderFields,\r | |
1694 | IN UINTN FieldCount\r | |
1695 | )\r | |
1696 | {\r | |
1697 | UINTN Index;\r | |
1698 | \r | |
1699 | if (HeaderFields != NULL) {\r | |
1700 | for (Index = 0; Index < FieldCount; Index++) {\r | |
1701 | if (HeaderFields[Index].FieldName != NULL) {\r | |
1702 | FreePool (HeaderFields[Index].FieldName);\r | |
1703 | }\r | |
1704 | if (HeaderFields[Index].FieldValue != NULL) {\r | |
1705 | FreePool (HeaderFields[Index].FieldValue);\r | |
1706 | }\r | |
1707 | }\r | |
1708 | \r | |
1709 | FreePool (HeaderFields);\r | |
1710 | }\r | |
1711 | }\r | |
1712 | \r | |
1713 | /**\r | |
1714 | Generate HTTP request message.\r | |
1715 | \r | |
1716 | This function will allocate memory for the whole HTTP message and generate a\r | |
1717 | well formatted HTTP Request message in it, include the Request-Line, header\r | |
1718 | fields and also the message body. It is the caller's responsibility to free\r | |
1719 | the buffer returned in *RequestMsg.\r | |
1720 | \r | |
1721 | @param[in] Message Pointer to the EFI_HTTP_MESSAGE structure which\r | |
1722 | contains the required information to generate\r | |
1723 | the HTTP request message.\r | |
1724 | @param[in] Url The URL of a remote host.\r | |
1725 | @param[out] RequestMsg Pointer to the created HTTP request message.\r | |
1726 | NULL if any error occured.\r | |
1727 | @param[out] RequestMsgSize Size of the RequestMsg (in bytes).\r | |
1728 | \r | |
1729 | @retval EFI_SUCCESS If HTTP request string was created successfully.\r | |
1730 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r | |
1731 | @retval EFI_INVALID_PARAMETER The input arguments are invalid.\r | |
1732 | \r | |
1733 | **/\r | |
1734 | EFI_STATUS\r | |
1735 | EFIAPI\r | |
1736 | HttpGenRequestMessage (\r | |
1737 | IN CONST EFI_HTTP_MESSAGE *Message,\r | |
1738 | IN CONST CHAR8 *Url,\r | |
1739 | OUT CHAR8 **RequestMsg,\r | |
1740 | OUT UINTN *RequestMsgSize\r | |
1741 | )\r | |
1742 | {\r | |
1743 | EFI_STATUS Status;\r | |
1744 | UINTN StrLength;\r | |
1745 | CHAR8 *RequestPtr;\r | |
1746 | UINTN HttpHdrSize;\r | |
1747 | UINTN MsgSize;\r | |
1748 | BOOLEAN Success;\r | |
1749 | VOID *HttpHdr;\r | |
1750 | EFI_HTTP_HEADER **AppendList;\r | |
1751 | UINTN Index;\r | |
1752 | EFI_HTTP_UTILITIES_PROTOCOL *HttpUtilitiesProtocol;\r | |
1753 | \r | |
1754 | Status = EFI_SUCCESS;\r | |
1755 | HttpHdrSize = 0;\r | |
1756 | MsgSize = 0;\r | |
1757 | Success = FALSE;\r | |
1758 | HttpHdr = NULL;\r | |
1759 | AppendList = NULL;\r | |
1760 | HttpUtilitiesProtocol = NULL;\r | |
1761 | \r | |
1762 | //\r | |
1763 | // 1. If we have a Request, we cannot have a NULL Url\r | |
1764 | // 2. If we have a Request, HeaderCount can not be non-zero\r | |
1765 | // 3. If we do not have a Request, HeaderCount should be zero\r | |
1766 | // 4. If we do not have Request and Headers, we need at least a message-body\r | |
1767 | //\r | |
1768 | if ((Message == NULL || RequestMsg == NULL || RequestMsgSize == NULL) ||\r | |
1769 | (Message->Data.Request != NULL && Url == NULL) ||\r | |
1770 | (Message->Data.Request != NULL && Message->HeaderCount == 0) ||\r | |
1771 | (Message->Data.Request == NULL && Message->HeaderCount != 0) ||\r | |
1772 | (Message->Data.Request == NULL && Message->HeaderCount == 0 && Message->BodyLength == 0)) {\r | |
1773 | return EFI_INVALID_PARAMETER;\r | |
1774 | }\r | |
1775 | \r | |
1776 | if (Message->HeaderCount != 0) {\r | |
1777 | //\r | |
1778 | // Locate the HTTP_UTILITIES protocol.\r | |
1779 | //\r | |
1780 | Status = gBS->LocateProtocol (\r | |
1781 | &gEfiHttpUtilitiesProtocolGuid,\r | |
1782 | NULL,\r | |
1783 | (VOID **) &HttpUtilitiesProtocol\r | |
1784 | );\r | |
1785 | \r | |
1786 | if (EFI_ERROR (Status)) {\r | |
1787 | DEBUG ((DEBUG_ERROR,"Failed to locate Http Utilities protocol. Status = %r.\n", Status));\r | |
1788 | return Status;\r | |
1789 | }\r | |
1790 | \r | |
1791 | //\r | |
1792 | // Build AppendList to send into HttpUtilitiesBuild\r | |
1793 | //\r | |
1794 | AppendList = AllocateZeroPool (sizeof (EFI_HTTP_HEADER *) * (Message->HeaderCount));\r | |
1795 | if (AppendList == NULL) {\r | |
1796 | return EFI_OUT_OF_RESOURCES;\r | |
1797 | }\r | |
1798 | \r | |
1799 | for(Index = 0; Index < Message->HeaderCount; Index++){\r | |
1800 | AppendList[Index] = &Message->Headers[Index];\r | |
1801 | }\r | |
1802 | \r | |
1803 | //\r | |
1804 | // Build raw HTTP Headers\r | |
1805 | //\r | |
1806 | Status = HttpUtilitiesProtocol->Build (\r | |
1807 | HttpUtilitiesProtocol,\r | |
1808 | 0,\r | |
1809 | NULL,\r | |
1810 | 0,\r | |
1811 | NULL,\r | |
1812 | Message->HeaderCount,\r | |
1813 | AppendList,\r | |
1814 | &HttpHdrSize,\r | |
1815 | &HttpHdr\r | |
1816 | );\r | |
1817 | \r | |
1818 | FreePool (AppendList);\r | |
1819 | \r | |
1820 | if (EFI_ERROR (Status) || HttpHdr == NULL){\r | |
1821 | return Status;\r | |
1822 | }\r | |
1823 | }\r | |
1824 | \r | |
1825 | //\r | |
1826 | // If we have headers to be sent, account for it.\r | |
1827 | //\r | |
1828 | if (Message->HeaderCount != 0) {\r | |
1829 | MsgSize = HttpHdrSize;\r | |
1830 | }\r | |
1831 | \r | |
1832 | //\r | |
1833 | // If we have a request line, account for the fields.\r | |
1834 | //\r | |
1835 | if (Message->Data.Request != NULL) {\r | |
1836 | MsgSize += HTTP_METHOD_MAXIMUM_LEN + AsciiStrLen (HTTP_VERSION_CRLF_STR) + AsciiStrLen (Url);\r | |
1837 | }\r | |
1838 | \r | |
1839 | \r | |
1840 | //\r | |
1841 | // If we have a message body to be sent, account for it.\r | |
1842 | //\r | |
1843 | MsgSize += Message->BodyLength;\r | |
1844 | \r | |
1845 | //\r | |
1846 | // memory for the string that needs to be sent to TCP\r | |
1847 | //\r | |
1848 | *RequestMsg = NULL;\r | |
1849 | *RequestMsg = AllocateZeroPool (MsgSize);\r | |
1850 | if (*RequestMsg == NULL) {\r | |
1851 | Status = EFI_OUT_OF_RESOURCES;\r | |
1852 | goto Exit;\r | |
1853 | }\r | |
1854 | \r | |
1855 | RequestPtr = *RequestMsg;\r | |
1856 | //\r | |
1857 | // Construct header request\r | |
1858 | //\r | |
1859 | if (Message->Data.Request != NULL) {\r | |
1860 | switch (Message->Data.Request->Method) {\r | |
1861 | case HttpMethodGet:\r | |
1862 | StrLength = sizeof (HTTP_METHOD_GET) - 1;\r | |
1863 | CopyMem (RequestPtr, HTTP_METHOD_GET, StrLength);\r | |
1864 | RequestPtr += StrLength;\r | |
1865 | break;\r | |
1866 | case HttpMethodPut:\r | |
1867 | StrLength = sizeof (HTTP_METHOD_PUT) - 1;\r | |
1868 | CopyMem (RequestPtr, HTTP_METHOD_PUT, StrLength);\r | |
1869 | RequestPtr += StrLength;\r | |
1870 | break;\r | |
1871 | case HttpMethodPatch:\r | |
1872 | StrLength = sizeof (HTTP_METHOD_PATCH) - 1;\r | |
1873 | CopyMem (RequestPtr, HTTP_METHOD_PATCH, StrLength);\r | |
1874 | RequestPtr += StrLength;\r | |
1875 | break;\r | |
1876 | case HttpMethodPost:\r | |
1877 | StrLength = sizeof (HTTP_METHOD_POST) - 1;\r | |
1878 | CopyMem (RequestPtr, HTTP_METHOD_POST, StrLength);\r | |
1879 | RequestPtr += StrLength;\r | |
1880 | break;\r | |
1881 | case HttpMethodHead:\r | |
1882 | StrLength = sizeof (HTTP_METHOD_HEAD) - 1;\r | |
1883 | CopyMem (RequestPtr, HTTP_METHOD_HEAD, StrLength);\r | |
1884 | RequestPtr += StrLength;\r | |
1885 | break;\r | |
1886 | case HttpMethodDelete:\r | |
1887 | StrLength = sizeof (HTTP_METHOD_DELETE) - 1;\r | |
1888 | CopyMem (RequestPtr, HTTP_METHOD_DELETE, StrLength);\r | |
1889 | RequestPtr += StrLength;\r | |
1890 | break;\r | |
1891 | default:\r | |
1892 | ASSERT (FALSE);\r | |
1893 | Status = EFI_INVALID_PARAMETER;\r | |
1894 | goto Exit;\r | |
1895 | }\r | |
1896 | \r | |
1897 | StrLength = AsciiStrLen(EMPTY_SPACE);\r | |
1898 | CopyMem (RequestPtr, EMPTY_SPACE, StrLength);\r | |
1899 | RequestPtr += StrLength;\r | |
1900 | \r | |
1901 | StrLength = AsciiStrLen (Url);\r | |
1902 | CopyMem (RequestPtr, Url, StrLength);\r | |
1903 | RequestPtr += StrLength;\r | |
1904 | \r | |
1905 | StrLength = sizeof (HTTP_VERSION_CRLF_STR) - 1;\r | |
1906 | CopyMem (RequestPtr, HTTP_VERSION_CRLF_STR, StrLength);\r | |
1907 | RequestPtr += StrLength;\r | |
1908 | \r | |
1909 | if (HttpHdr != NULL) {\r | |
1910 | //\r | |
1911 | // Construct header\r | |
1912 | //\r | |
1913 | CopyMem (RequestPtr, HttpHdr, HttpHdrSize);\r | |
1914 | RequestPtr += HttpHdrSize;\r | |
1915 | }\r | |
1916 | }\r | |
1917 | \r | |
1918 | //\r | |
1919 | // Construct body\r | |
1920 | //\r | |
1921 | if (Message->Body != NULL) {\r | |
1922 | CopyMem (RequestPtr, Message->Body, Message->BodyLength);\r | |
1923 | RequestPtr += Message->BodyLength;\r | |
1924 | }\r | |
1925 | \r | |
1926 | //\r | |
1927 | // Done\r | |
1928 | //\r | |
1929 | (*RequestMsgSize) = (UINTN)(RequestPtr) - (UINTN)(*RequestMsg);\r | |
1930 | Success = TRUE;\r | |
1931 | \r | |
1932 | Exit:\r | |
1933 | \r | |
1934 | if (!Success) {\r | |
1935 | if (*RequestMsg != NULL) {\r | |
1936 | FreePool (*RequestMsg);\r | |
1937 | }\r | |
1938 | *RequestMsg = NULL;\r | |
1939 | return Status;\r | |
1940 | }\r | |
1941 | \r | |
1942 | if (HttpHdr != NULL) {\r | |
1943 | FreePool (HttpHdr);\r | |
1944 | }\r | |
1945 | \r | |
1946 | return EFI_SUCCESS;\r | |
1947 | }\r | |
1948 | \r | |
1949 | /**\r | |
1950 | Translate the status code in HTTP message to EFI_HTTP_STATUS_CODE defined\r | |
1951 | in UEFI 2.5 specification.\r | |
1952 | \r | |
1953 | @param[in] StatusCode The status code value in HTTP message.\r | |
1954 | \r | |
1955 | @return Value defined in EFI_HTTP_STATUS_CODE .\r | |
1956 | \r | |
1957 | **/\r | |
1958 | EFI_HTTP_STATUS_CODE\r | |
1959 | EFIAPI\r | |
1960 | HttpMappingToStatusCode (\r | |
1961 | IN UINTN StatusCode\r | |
1962 | )\r | |
1963 | {\r | |
1964 | switch (StatusCode) {\r | |
1965 | case 100:\r | |
1966 | return HTTP_STATUS_100_CONTINUE;\r | |
1967 | case 101:\r | |
1968 | return HTTP_STATUS_101_SWITCHING_PROTOCOLS;\r | |
1969 | case 200:\r | |
1970 | return HTTP_STATUS_200_OK;\r | |
1971 | case 201:\r | |
1972 | return HTTP_STATUS_201_CREATED;\r | |
1973 | case 202:\r | |
1974 | return HTTP_STATUS_202_ACCEPTED;\r | |
1975 | case 203:\r | |
1976 | return HTTP_STATUS_203_NON_AUTHORITATIVE_INFORMATION;\r | |
1977 | case 204:\r | |
1978 | return HTTP_STATUS_204_NO_CONTENT;\r | |
1979 | case 205:\r | |
1980 | return HTTP_STATUS_205_RESET_CONTENT;\r | |
1981 | case 206:\r | |
1982 | return HTTP_STATUS_206_PARTIAL_CONTENT;\r | |
1983 | case 300:\r | |
1984 | return HTTP_STATUS_300_MULTIPLE_CHOICES;\r | |
1985 | case 301:\r | |
1986 | return HTTP_STATUS_301_MOVED_PERMANENTLY;\r | |
1987 | case 302:\r | |
1988 | return HTTP_STATUS_302_FOUND;\r | |
1989 | case 303:\r | |
1990 | return HTTP_STATUS_303_SEE_OTHER;\r | |
1991 | case 304:\r | |
1992 | return HTTP_STATUS_304_NOT_MODIFIED;\r | |
1993 | case 305:\r | |
1994 | return HTTP_STATUS_305_USE_PROXY;\r | |
1995 | case 307:\r | |
1996 | return HTTP_STATUS_307_TEMPORARY_REDIRECT;\r | |
1997 | case 308:\r | |
1998 | return HTTP_STATUS_308_PERMANENT_REDIRECT;\r | |
1999 | case 400:\r | |
2000 | return HTTP_STATUS_400_BAD_REQUEST;\r | |
2001 | case 401:\r | |
2002 | return HTTP_STATUS_401_UNAUTHORIZED;\r | |
2003 | case 402:\r | |
2004 | return HTTP_STATUS_402_PAYMENT_REQUIRED;\r | |
2005 | case 403:\r | |
2006 | return HTTP_STATUS_403_FORBIDDEN;\r | |
2007 | case 404:\r | |
2008 | return HTTP_STATUS_404_NOT_FOUND;\r | |
2009 | case 405:\r | |
2010 | return HTTP_STATUS_405_METHOD_NOT_ALLOWED;\r | |
2011 | case 406:\r | |
2012 | return HTTP_STATUS_406_NOT_ACCEPTABLE;\r | |
2013 | case 407:\r | |
2014 | return HTTP_STATUS_407_PROXY_AUTHENTICATION_REQUIRED;\r | |
2015 | case 408:\r | |
2016 | return HTTP_STATUS_408_REQUEST_TIME_OUT;\r | |
2017 | case 409:\r | |
2018 | return HTTP_STATUS_409_CONFLICT;\r | |
2019 | case 410:\r | |
2020 | return HTTP_STATUS_410_GONE;\r | |
2021 | case 411:\r | |
2022 | return HTTP_STATUS_411_LENGTH_REQUIRED;\r | |
2023 | case 412:\r | |
2024 | return HTTP_STATUS_412_PRECONDITION_FAILED;\r | |
2025 | case 413:\r | |
2026 | return HTTP_STATUS_413_REQUEST_ENTITY_TOO_LARGE;\r | |
2027 | case 414:\r | |
2028 | return HTTP_STATUS_414_REQUEST_URI_TOO_LARGE;\r | |
2029 | case 415:\r | |
2030 | return HTTP_STATUS_415_UNSUPPORTED_MEDIA_TYPE;\r | |
2031 | case 416:\r | |
2032 | return HTTP_STATUS_416_REQUESTED_RANGE_NOT_SATISFIED;\r | |
2033 | case 417:\r | |
2034 | return HTTP_STATUS_417_EXPECTATION_FAILED;\r | |
2035 | case 500:\r | |
2036 | return HTTP_STATUS_500_INTERNAL_SERVER_ERROR;\r | |
2037 | case 501:\r | |
2038 | return HTTP_STATUS_501_NOT_IMPLEMENTED;\r | |
2039 | case 502:\r | |
2040 | return HTTP_STATUS_502_BAD_GATEWAY;\r | |
2041 | case 503:\r | |
2042 | return HTTP_STATUS_503_SERVICE_UNAVAILABLE;\r | |
2043 | case 504:\r | |
2044 | return HTTP_STATUS_504_GATEWAY_TIME_OUT;\r | |
2045 | case 505:\r | |
2046 | return HTTP_STATUS_505_HTTP_VERSION_NOT_SUPPORTED;\r | |
2047 | \r | |
2048 | default:\r | |
2049 | return HTTP_STATUS_UNSUPPORTED_STATUS;\r | |
2050 | }\r | |
2051 | }\r | |
2052 | \r | |
2053 | /**\r | |
2054 | Check whether header field called FieldName is in DeleteList.\r | |
2055 | \r | |
2056 | @param[in] DeleteList Pointer to array of key/value header pairs.\r | |
2057 | @param[in] DeleteCount The number of header pairs.\r | |
2058 | @param[in] FieldName Pointer to header field's name.\r | |
2059 | \r | |
2060 | @return TRUE if FieldName is not in DeleteList, that means this header field is valid.\r | |
2061 | @return FALSE if FieldName is in DeleteList, that means this header field is invalid.\r | |
2062 | \r | |
2063 | **/\r | |
2064 | BOOLEAN\r | |
2065 | EFIAPI\r | |
2066 | HttpIsValidHttpHeader (\r | |
2067 | IN CHAR8 *DeleteList[],\r | |
2068 | IN UINTN DeleteCount,\r | |
2069 | IN CHAR8 *FieldName\r | |
2070 | )\r | |
2071 | {\r | |
2072 | UINTN Index;\r | |
2073 | \r | |
2074 | if (FieldName == NULL) {\r | |
2075 | return FALSE;\r | |
2076 | }\r | |
2077 | \r | |
2078 | for (Index = 0; Index < DeleteCount; Index++) {\r | |
2079 | if (DeleteList[Index] == NULL) {\r | |
2080 | continue;\r | |
2081 | }\r | |
2082 | \r | |
2083 | if (AsciiStrCmp (FieldName, DeleteList[Index]) == 0) {\r | |
2084 | return FALSE;\r | |
2085 | }\r | |
2086 | }\r | |
2087 | \r | |
2088 | return TRUE;\r | |
2089 | }\r | |
2090 | \r |