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