1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
|
/** @file
This library is used to share code between UEFI network stack modules.
It provides the helper routines to parse the HTTP message byte stream.
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at<BR>
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include <Uefi.h>
#include <Library/NetLib.h>
#include <Library/HttpLib.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#define BIT(x) (1 << x)
#define NET_IS_HEX_CHAR(Ch) \
((('0' <= (Ch)) && ((Ch) <= '9')) || \
(('A' <= (Ch)) && ((Ch) <= 'F')) || \
(('a' <= (Ch)) && ((Ch) <= 'f')))
//
// Field index of the HTTP URL parse result.
//
#define HTTP_URI_FIELD_SCHEME 0
#define HTTP_URI_FIELD_AUTHORITY 1
#define HTTP_URI_FIELD_PATH 2
#define HTTP_URI_FIELD_QUERY 3
#define HTTP_URI_FIELD_FRAGMENT 4
#define HTTP_URI_FIELD_USERINFO 5
#define HTTP_URI_FIELD_HOST 6
#define HTTP_URI_FIELD_PORT 7
#define HTTP_URI_FIELD_MAX 8
//
// Structure to store the parse result of a HTTP URL.
//
typedef struct {
UINT32 Offset;
UINT32 Length;
} HTTP_URL_FILED_DATA;
typedef struct {
UINT16 FieldBitMap;
HTTP_URL_FILED_DATA FieldData[HTTP_URI_FIELD_MAX];
} HTTP_URL_PARSER;
typedef enum {
UrlParserUrlStart,
UrlParserScheme,
UrlParserSchemeColon, // ":"
UrlParserSchemeColonSlash, // ":/"
UrlParserSchemeColonSlashSlash, // "://"
UrlParserAuthority,
UrlParserAtInAuthority,
UrlParserPath,
UrlParserQueryStart, // "?"
UrlParserQuery,
UrlParserFragmentStart, // "#"
UrlParserFragment,
UrlParserUserInfo,
UrlParserHostStart, // "@"
UrlParserHost,
UrlParserPortStart, // ":"
UrlParserPort,
UrlParserStateMax
} HTTP_URL_PARSE_STATE;
/**
Decode a percent-encoded URI component to the ASCII character.
Decode the input component in Buffer according to RFC 3986. The caller is responsible to make
sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer))
in bytes.
@param[in] Buffer The pointer to a percent-encoded URI component.
@param[in] BufferLength Length of Buffer in bytes.
@param[out] ResultBuffer Point to the buffer to store the decode result.
@param[out] ResultLength Length of decoded string in ResultBuffer in bytes.
@retval EFI_SUCCESS Successfully decoded the URI.
@retval EFI_INVALID_PARAMETER Buffer is not a valid percent-encoded string.
**/
EFI_STATUS
EFIAPI
UriPercentDecode (
IN CHAR8 *Buffer,
IN UINT32 BufferLength,
OUT CHAR8 *ResultBuffer,
OUT UINT32 *ResultLength
)
{
UINTN Index;
UINTN Offset;
CHAR8 HexStr[3];
if (Buffer == NULL || BufferLength == 0 || ResultBuffer == NULL) {
return EFI_INVALID_PARAMETER;
}
Index = 0;
Offset = 0;
HexStr[2] = '\0';
while (Index < BufferLength) {
if (Buffer[Index] == '%') {
if (!NET_IS_HEX_CHAR (Buffer[Index+1]) || !NET_IS_HEX_CHAR (Buffer[Index+2])) {
return EFI_INVALID_PARAMETER;
}
HexStr[0] = Buffer[Index+1];
HexStr[1] = Buffer[Index+2];
ResultBuffer[Offset] = (CHAR8) AsciiStrHexToUintn (HexStr);
Index += 3;
} else {
ResultBuffer[Offset] = Buffer[Index];
Index++;
}
Offset++;
}
*ResultLength = (UINT32) Offset;
return EFI_SUCCESS;
}
/**
This function return the updated state accroding to the input state and next character of
the authority.
@param[in] Char Next character.
@param[in] State Current value of the parser state machine.
@return Updated state value.
**/
HTTP_URL_PARSE_STATE
NetHttpParseAuthorityChar (
IN CHAR8 Char,
IN HTTP_URL_PARSE_STATE State
)
{
//
// RFC 3986:
// The authority component is preceded by a double slash ("//") and is
// terminated by the next slash ("/"), question mark ("?"), or number
// sign ("#") character, or by the end of the URI.
//
if (Char == ' ' || Char == '\r' || Char == '\n') {
return UrlParserStateMax;
}
//
// authority = [ userinfo "@" ] host [ ":" port ]
//
switch (State) {
case UrlParserUserInfo:
if (Char == '@') {
return UrlParserHostStart;
}
break;
case UrlParserHost:
case UrlParserHostStart:
if (Char == ':') {
return UrlParserPortStart;
}
return UrlParserHost;
case UrlParserPort:
case UrlParserPortStart:
return UrlParserPort;
default:
break;
}
return State;
}
/**
This function parse the authority component of the input URL and update the parser.
@param[in] Url The pointer to a HTTP URL string.
@param[in] FoundAt TRUE if there is an at sign ('@') in the authority component.
@param[in, out] UrlParser Pointer to the buffer of the parse result.
@retval EFI_SUCCESS Successfully parse the authority.
@retval Other Error happened.
**/
EFI_STATUS
NetHttpParseAuthority (
IN CHAR8 *Url,
IN BOOLEAN FoundAt,
IN OUT HTTP_URL_PARSER *UrlParser
)
{
CHAR8 *Char;
CHAR8 *Authority;
UINT32 Length;
HTTP_URL_PARSE_STATE State;
UINT32 Field;
UINT32 OldField;
ASSERT ((UrlParser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0);
//
// authority = [ userinfo "@" ] host [ ":" port ]
//
if (FoundAt) {
State = UrlParserUserInfo;
} else {
State = UrlParserHost;
}
Field = HTTP_URI_FIELD_MAX;
OldField = Field;
Authority = Url + UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Offset;
Length = UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Length;
for (Char = Authority; Char < Authority + Length; Char++) {
State = NetHttpParseAuthorityChar (*Char, State);
switch (State) {
case UrlParserStateMax:
return EFI_INVALID_PARAMETER;
case UrlParserHostStart:
case UrlParserPortStart:
continue;
case UrlParserUserInfo:
Field = HTTP_URI_FIELD_USERINFO;
break;
case UrlParserHost:
Field = HTTP_URI_FIELD_HOST;
break;
case UrlParserPort:
Field = HTTP_URI_FIELD_PORT;
break;
default:
ASSERT (FALSE);
}
//
// Field not changed, count the length.
//
ASSERT (Field < HTTP_URI_FIELD_MAX);
if (Field == OldField) {
UrlParser->FieldData[Field].Length++;
continue;
}
//
// New field start
//
UrlParser->FieldBitMap |= BIT (Field);
UrlParser->FieldData[Field].Offset = (UINT32) (Char - Url);
UrlParser->FieldData[Field].Length = 1;
OldField = Field;
}
return EFI_SUCCESS;
}
/**
This function return the updated state accroding to the input state and next character of a URL.
@param[in] Char Next character.
@param[in] State Current value of the parser state machine.
@return Updated state value.
**/
HTTP_URL_PARSE_STATE
NetHttpParseUrlChar (
IN CHAR8 Char,
IN HTTP_URL_PARSE_STATE State
)
{
if (Char == ' ' || Char == '\r' || Char == '\n') {
return UrlParserStateMax;
}
//
// http_URL = "http:" "//" host [ ":" port ] [ abs_path [ "?" query ]]
//
// Request-URI = "*" | absolute-URI | path-absolute | authority
//
// absolute-URI = scheme ":" hier-part [ "?" query ]
// path-absolute = "/" [ segment-nz *( "/" segment ) ]
// authority = [ userinfo "@" ] host [ ":" port ]
//
switch (State) {
case UrlParserUrlStart:
if (Char == '*' || Char == '/') {
return UrlParserPath;
}
return UrlParserScheme;
case UrlParserScheme:
if (Char == ':') {
return UrlParserSchemeColon;
}
break;
case UrlParserSchemeColon:
if (Char == '/') {
return UrlParserSchemeColonSlash;
}
break;
case UrlParserSchemeColonSlash:
if (Char == '/') {
return UrlParserSchemeColonSlashSlash;
}
break;
case UrlParserAtInAuthority:
if (Char == '@') {
return UrlParserStateMax;
}
case UrlParserAuthority:
case UrlParserSchemeColonSlashSlash:
if (Char == '@') {
return UrlParserAtInAuthority;
}
if (Char == '/') {
return UrlParserPath;
}
if (Char == '?') {
return UrlParserQueryStart;
}
if (Char == '#') {
return UrlParserFragmentStart;
}
return UrlParserAuthority;
case UrlParserPath:
if (Char == '?') {
return UrlParserQueryStart;
}
if (Char == '#') {
return UrlParserFragmentStart;
}
break;
case UrlParserQuery:
case UrlParserQueryStart:
if (Char == '#') {
return UrlParserFragmentStart;
}
return UrlParserQuery;
case UrlParserFragmentStart:
return UrlParserFragment;
default:
break;
}
return State;
}
/**
Create a URL parser for the input URL string.
This function will parse and dereference the input HTTP URL into it components. The original
content of the URL won't be modified and the result will be returned in UrlParser, which can
be used in other functions like NetHttpUrlGetHostName().
@param[in] Url The pointer to a HTTP URL string.
@param[in] Length Length of Url in bytes.
@param[in] IsConnectMethod Whether the Url is used in HTTP CONNECT method or not.
@param[out] UrlParser Pointer to the returned buffer to store the parse result.
@retval EFI_SUCCESS Successfully dereferenced the HTTP URL.
@retval EFI_INVALID_PARAMETER UrlParser is NULL or Url is not a valid HTTP URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
HttpParseUrl (
IN CHAR8 *Url,
IN UINT32 Length,
IN BOOLEAN IsConnectMethod,
OUT VOID **UrlParser
)
{
HTTP_URL_PARSE_STATE State;
CHAR8 *Char;
UINT32 Field;
UINT32 OldField;
BOOLEAN FoundAt;
EFI_STATUS Status;
HTTP_URL_PARSER *Parser;
if (Url == NULL || Length == 0 || UrlParser == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = AllocateZeroPool (sizeof (HTTP_URL_PARSER));
if (Parser == NULL) {
return EFI_OUT_OF_RESOURCES;
}
if (IsConnectMethod) {
//
// According to RFC 2616, the authority form is only used by the CONNECT method.
//
State = UrlParserAuthority;
} else {
State = UrlParserUrlStart;
}
Field = HTTP_URI_FIELD_MAX;
OldField = Field;
FoundAt = FALSE;
for (Char = Url; Char < Url + Length; Char++) {
//
// Update state machine accoring to next char.
//
State = NetHttpParseUrlChar (*Char, State);
switch (State) {
case UrlParserStateMax:
return EFI_INVALID_PARAMETER;
case UrlParserSchemeColon:
case UrlParserSchemeColonSlash:
case UrlParserSchemeColonSlashSlash:
case UrlParserQueryStart:
case UrlParserFragmentStart:
//
// Skip all the delimiting char: "://" "?" "@"
//
continue;
case UrlParserScheme:
Field = HTTP_URI_FIELD_SCHEME;
break;
case UrlParserAtInAuthority:
FoundAt = TRUE;
case UrlParserAuthority:
Field = HTTP_URI_FIELD_AUTHORITY;
break;
case UrlParserPath:
Field = HTTP_URI_FIELD_PATH;
break;
case UrlParserQuery:
Field = HTTP_URI_FIELD_QUERY;
break;
case UrlParserFragment:
Field = HTTP_URI_FIELD_FRAGMENT;
break;
default:
ASSERT (FALSE);
}
//
// Field not changed, count the length.
//
ASSERT (Field < HTTP_URI_FIELD_MAX);
if (Field == OldField) {
Parser->FieldData[Field].Length++;
continue;
}
//
// New field start
//
Parser->FieldBitMap |= BIT (Field);
Parser->FieldData[Field].Offset = (UINT32) (Char - Url);
Parser->FieldData[Field].Length = 1;
OldField = Field;
}
//
// If has authority component, continue to parse the username, host and port.
//
if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0) {
Status = NetHttpParseAuthority (Url, FoundAt, Parser);
if (EFI_ERROR (Status)) {
return Status;
}
}
*UrlParser = Parser;
return EFI_SUCCESS;
}
/**
Get the Hostname from a HTTP URL.
This function will return the HostName according to the Url and previous parse result ,and
it is the caller's responsibility to free the buffer returned in *HostName.
@param[in] Url The pointer to a HTTP URL string.
@param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
@param[out] HostName Pointer to a buffer to store the HostName.
@retval EFI_SUCCESS Successfully get the required component.
@retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No hostName component in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
HttpUrlGetHostName (
IN CHAR8 *Url,
IN VOID *UrlParser,
OUT CHAR8 **HostName
)
{
CHAR8 *Name;
EFI_STATUS Status;
UINT32 ResultLength;
HTTP_URL_PARSER *Parser;
if (Url == NULL || UrlParser == NULL || HostName == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = (HTTP_URL_PARSER*) UrlParser;
if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {
return EFI_NOT_FOUND;
}
Name = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1);
if (Name == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Status = UriPercentDecode (
Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset,
Parser->FieldData[HTTP_URI_FIELD_HOST].Length,
Name,
&ResultLength
);
if (EFI_ERROR (Status)) {
return Status;
}
Name[ResultLength] = '\0';
*HostName = Name;
return EFI_SUCCESS;
}
/**
Get the IPv4 address from a HTTP URL.
This function will return the IPv4 address according to the Url and previous parse result.
@param[in] Url The pointer to a HTTP URL string.
@param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
@param[out] Ip4Address Pointer to a buffer to store the IP address.
@retval EFI_SUCCESS Successfully get the required component.
@retval EFI_INVALID_PARAMETER Uri is NULL or Ip4Address is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No IPv4 address component in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
HttpUrlGetIp4 (
IN CHAR8 *Url,
IN VOID *UrlParser,
OUT EFI_IPv4_ADDRESS *Ip4Address
)
{
CHAR8 *Ip4String;
EFI_STATUS Status;
UINT32 ResultLength;
HTTP_URL_PARSER *Parser;
if (Url == NULL || UrlParser == NULL || Ip4Address == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = (HTTP_URL_PARSER*) UrlParser;
if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {
return EFI_INVALID_PARAMETER;
}
Ip4String = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1);
if (Ip4String == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Status = UriPercentDecode (
Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset,
Parser->FieldData[HTTP_URI_FIELD_HOST].Length,
Ip4String,
&ResultLength
);
if (EFI_ERROR (Status)) {
return Status;
}
Ip4String[ResultLength] = '\0';
Status = NetLibAsciiStrToIp4 (Ip4String, Ip4Address);
FreePool (Ip4String);
return Status;
}
/**
Get the IPv6 address from a HTTP URL.
This function will return the IPv6 address according to the Url and previous parse result.
@param[in] Url The pointer to a HTTP URL string.
@param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
@param[out] Ip6Address Pointer to a buffer to store the IP address.
@retval EFI_SUCCESS Successfully get the required component.
@retval EFI_INVALID_PARAMETER Uri is NULL or Ip6Address is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No IPv6 address component in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
HttpUrlGetIp6 (
IN CHAR8 *Url,
IN VOID *UrlParser,
OUT EFI_IPv6_ADDRESS *Ip6Address
)
{
CHAR8 *Ip6String;
CHAR8 *Ptr;
UINT32 Length;
EFI_STATUS Status;
UINT32 ResultLength;
HTTP_URL_PARSER *Parser;
if (Url == NULL || UrlParser == NULL || Ip6Address == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = (HTTP_URL_PARSER*) UrlParser;
if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) {
return EFI_INVALID_PARAMETER;
}
//
// IP-literal = "[" ( IPv6address / IPvFuture ) "]"
//
Length = Parser->FieldData[HTTP_URI_FIELD_HOST].Length;
if (Length < 2) {
return EFI_INVALID_PARAMETER;
}
Ptr = Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset;
if ((Ptr[0] != '[') || (Ptr[Length - 1] != ']')) {
return EFI_INVALID_PARAMETER;
}
Ip6String = AllocatePool (Length);
if (Ip6String == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Status = UriPercentDecode (
Ptr + 1,
Length - 2,
Ip6String,
&ResultLength
);
if (EFI_ERROR (Status)) {
return Status;
}
Ip6String[ResultLength] = '\0';
Status = NetLibAsciiStrToIp6 (Ip6String, Ip6Address);
FreePool (Ip6String);
return Status;
}
/**
Get the port number from a HTTP URL.
This function will return the port number according to the Url and previous parse result.
@param[in] Url The pointer to a HTTP URL string.
@param[in] UrlParser URL Parse result returned by NetHttpParseUrl().
@param[out] Port Pointer to a buffer to store the port number.
@retval EFI_SUCCESS Successfully get the required component.
@retval EFI_INVALID_PARAMETER Uri is NULL or Port is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No port number in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
HttpUrlGetPort (
IN CHAR8 *Url,
IN VOID *UrlParser,
OUT UINT16 *Port
)
{
CHAR8 *PortString;
EFI_STATUS Status;
UINT32 ResultLength;
HTTP_URL_PARSER *Parser;
if (Url == NULL || UrlParser == NULL || Port == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = (HTTP_URL_PARSER*) UrlParser;
if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PORT)) == 0) {
return EFI_INVALID_PARAMETER;
}
PortString = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PORT].Length + 1);
if (PortString == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Status = UriPercentDecode (
Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset,
Parser->FieldData[HTTP_URI_FIELD_PORT].Length,
PortString,
&ResultLength
);
if (EFI_ERROR (Status)) {
return Status;
}
PortString[ResultLength] = '\0';
*Port = (UINT16) AsciiStrDecimalToUintn (Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset);
return EFI_SUCCESS;
}
/**
Release the resource of the URL parser.
@param[in] UrlParser Pointer to the parser.
**/
VOID
EFIAPI
HttpUrlFreeParser (
IN VOID *UrlParser
)
{
FreePool (UrlParser);
}
/**
Find a specified header field according to the field name.
@param[in] HeaderCount Number of HTTP header structures in Headers list.
@param[in] Headers Array containing list of HTTP headers.
@param[in] FieldName Null terminated string which describes a field name.
@return Pointer to the found header or NULL.
**/
EFI_HTTP_HEADER *
HttpIoFindHeader (
IN UINTN HeaderCount,
IN EFI_HTTP_HEADER *Headers,
IN CHAR8 *FieldName
)
{
UINTN Index;
if (HeaderCount == 0 || Headers == NULL || FieldName == NULL) {
return NULL;
}
for (Index = 0; Index < HeaderCount; Index++){
//
// Field names are case-insensitive (RFC 2616).
//
if (AsciiStriCmp (Headers[Index].FieldName, FieldName) == 0) {
return &Headers[Index];
}
}
return NULL;
}
typedef enum {
BodyParserBodyStart,
BodyParserBodyIdentity,
BodyParserChunkSizeStart,
BodyParserChunkSize,
BodyParserChunkSizeEndCR,
BodyParserChunkExtStart,
BodyParserChunkDataStart,
BodyParserChunkDataEnd,
BodyParserChunkDataEndCR,
BodyParserComplete,
BodyParserStateMax
} HTTP_BODY_PARSE_STATE;
typedef struct {
BOOLEAN IgnoreBody; // "MUST NOT" include a message-body
BOOLEAN IsChunked; // "chunked" transfer-coding.
BOOLEAN ContentLengthIsValid;
UINTN ContentLength; // Entity length (not the message-body length), invalid until ContentLengthIsValid is TRUE
HTTP_BODY_PARSER_CALLBACK Callback;
VOID *Context;
UINTN ParsedBodyLength;
HTTP_BODY_PARSE_STATE State;
UINTN CurrentChunkSize;
UINTN CurrentChunkParsedSize;
} HTTP_BODY_PARSER;
/**
Convert an Ascii char to its uppercase.
@param[in] Char Ascii character.
@return Uppercase value of the input Char.
**/
CHAR8
HttpIoCharToUpper (
IN CHAR8 Char
)
{
if (Char >= 'a' && Char <= 'z') {
return Char - ('a' - 'A');
}
return Char;
}
/**
Convert an hexadecimal char to a value of type UINTN.
@param[in] Char Ascii character.
@return Value translated from Char.
**/
UINTN
HttpIoHexCharToUintn (
IN CHAR8 Char
)
{
if (Char >= '0' && Char <= '9') {
return Char - '0';
}
return (10 + HttpIoCharToUpper (Char) - 'A');
}
/**
Get the value of the content length if there is a "Content-Length" header.
@param[in] HeaderCount Number of HTTP header structures in Headers.
@param[in] Headers Array containing list of HTTP headers.
@param[out] ContentLength Pointer to save the value of the content length.
@retval EFI_SUCCESS Successfully get the content length.
@retval EFI_NOT_FOUND No "Content-Length" header in the Headers.
**/
EFI_STATUS
HttpIoParseContentLengthHeader (
IN UINTN HeaderCount,
IN EFI_HTTP_HEADER *Headers,
OUT UINTN *ContentLength
)
{
EFI_HTTP_HEADER *Header;
Header = HttpIoFindHeader (HeaderCount, Headers, "Content-Length");
if (Header == NULL) {
return EFI_NOT_FOUND;
}
*ContentLength = AsciiStrDecimalToUintn (Header->FieldValue);
return EFI_SUCCESS;
}
/**
Check whether the HTTP message is using the "chunked" transfer-coding.
@param[in] HeaderCount Number of HTTP header structures in Headers.
@param[in] Headers Array containing list of HTTP headers.
@return The message is "chunked" transfer-coding (TRUE) or not (FALSE).
**/
BOOLEAN
HttpIoIsChunked (
IN UINTN HeaderCount,
IN EFI_HTTP_HEADER *Headers
)
{
EFI_HTTP_HEADER *Header;
Header = HttpIoFindHeader (HeaderCount, Headers, "Transfer-Encoding");
if (Header == NULL) {
return FALSE;
}
if (AsciiStriCmp (Header->FieldValue, "identity") != 0) {
return TRUE;
}
return FALSE;
}
/**
Check whether the HTTP message should have a message-body.
@param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message.
@param[in] StatusCode Response status code returned by the remote host.
@return The message should have a message-body (FALSE) or not (TRUE).
**/
BOOLEAN
HttpIoNoMessageBody (
IN EFI_HTTP_METHOD Method,
IN EFI_HTTP_STATUS_CODE StatusCode
)
{
//
// RFC 2616:
// All responses to the HEAD request method
// MUST NOT include a message-body, even though the presence of entity-
// header fields might lead one to believe they do. All 1xx
// (informational), 204 (no content), and 304 (not modified) responses
// MUST NOT include a message-body. All other responses do include a
// message-body, although it MAY be of zero length.
//
if (Method == HttpMethodHead) {
return TRUE;
}
if ((StatusCode == HTTP_STATUS_100_CONTINUE) ||
(StatusCode == HTTP_STATUS_101_SWITCHING_PROTOCOLS) ||
(StatusCode == HTTP_STATUS_204_NO_CONTENT) ||
(StatusCode == HTTP_STATUS_304_NOT_MODIFIED))
{
return TRUE;
}
return FALSE;
}
/**
Initialize a HTTP message-body parser.
This function will create and initialize a HTTP message parser according to caller provided HTTP message
header information. It is the caller's responsibility to free the buffer returned in *UrlParser by HttpFreeMsgParser().
@param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message.
@param[in] StatusCode Response status code returned by the remote host.
@param[in] HeaderCount Number of HTTP header structures in Headers.
@param[in] Headers Array containing list of HTTP headers.
@param[in] Callback Callback function that is invoked when parsing the HTTP message-body,
set to NULL to ignore all events.
@param[in] Context Pointer to the context that will be passed to Callback.
@param[out] MsgParser Pointer to the returned buffer to store the message parser.
@retval EFI_SUCCESS Successfully initialized the parser.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
@retval EFI_INVALID_PARAMETER MsgParser is NULL or HeaderCount is not NULL but Headers is NULL.
@retval Others Failed to initialize the parser.
**/
EFI_STATUS
EFIAPI
HttpInitMsgParser (
IN EFI_HTTP_METHOD Method,
IN EFI_HTTP_STATUS_CODE StatusCode,
IN UINTN HeaderCount,
IN EFI_HTTP_HEADER *Headers,
IN HTTP_BODY_PARSER_CALLBACK Callback,
IN VOID *Context,
OUT VOID **MsgParser
)
{
EFI_STATUS Status;
HTTP_BODY_PARSER *Parser;
if (HeaderCount != 0 && Headers == NULL) {
return EFI_INVALID_PARAMETER;
}
if (MsgParser == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = AllocateZeroPool (sizeof (HTTP_BODY_PARSER));
if (Parser == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Parser->State = BodyParserBodyStart;
//
// Determine the message length accroding to RFC 2616.
// 1. Check whether the message "MUST NOT" have a message-body.
//
Parser->IgnoreBody = HttpIoNoMessageBody (Method, StatusCode);
//
// 2. Check whether the message using "chunked" transfer-coding.
//
Parser->IsChunked = HttpIoIsChunked (HeaderCount, Headers);
//
// 3. Check whether the message has a Content-Length header field.
//
Status = HttpIoParseContentLengthHeader (HeaderCount, Headers, &Parser->ContentLength);
if (!EFI_ERROR (Status)) {
Parser->ContentLengthIsValid = TRUE;
}
//
// 4. Range header is not supported now, so we won't meet media type "multipart/byteranges".
// 5. By server closing the connection
//
//
// Set state to skip body parser if the message shouldn't have a message body.
//
if (Parser->IgnoreBody) {
Parser->State = BodyParserComplete;
} else {
Parser->Callback = Callback;
Parser->Context = Context;
}
*MsgParser = Parser;
return EFI_SUCCESS;
}
/**
Parse message body.
Parse BodyLength of message-body. This function can be called repeatedly to parse the message-body partially.
@param[in, out] MsgParser Pointer to the message parser.
@param[in] BodyLength Length in bytes of the Body.
@param[in] Body Pointer to the buffer of the message-body to be parsed.
@retval EFI_SUCCESS Successfully parse the message-body.
@retval EFI_INVALID_PARAMETER MsgParser is NULL or Body is NULL or BodyLength is 0.
@retval Others Operation aborted.
**/
EFI_STATUS
EFIAPI
HttpParseMessageBody (
IN OUT VOID *MsgParser,
IN UINTN BodyLength,
IN CHAR8 *Body
)
{
CHAR8 *Char;
UINTN RemainderLengthInThis;
UINTN LengthForCallback;
EFI_STATUS Status;
HTTP_BODY_PARSER *Parser;
if (BodyLength == 0 || Body == NULL) {
return EFI_INVALID_PARAMETER;
}
if (MsgParser == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = (HTTP_BODY_PARSER*) MsgParser;
if (Parser->IgnoreBody) {
Parser->State = BodyParserComplete;
if (Parser->Callback != NULL) {
Status = Parser->Callback (
BodyParseEventOnComplete,
Body,
0,
Parser->Context
);
if (EFI_ERROR (Status)) {
return Status;
}
}
return EFI_SUCCESS;
}
if (Parser->State == BodyParserBodyStart) {
Parser->ParsedBodyLength = 0;
if (Parser->IsChunked) {
Parser->State = BodyParserChunkSizeStart;
} else {
Parser->State = BodyParserBodyIdentity;
}
}
//
// The message body might be truncated in anywhere, so we need to parse is byte-by-byte.
//
for (Char = Body; Char < Body + BodyLength; ) {
switch (Parser->State) {
case BodyParserStateMax:
return EFI_ABORTED;
case BodyParserComplete:
if (Parser->Callback != NULL) {
Status = Parser->Callback (
BodyParseEventOnComplete,
Char,
0,
Parser->Context
);
if (EFI_ERROR (Status)) {
return Status;
}
}
return EFI_SUCCESS;
case BodyParserBodyIdentity:
//
// Identity transfer-coding, just notify user to save the body data.
//
if (Parser->Callback != NULL) {
Status = Parser->Callback (
BodyParseEventOnData,
Char,
MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength),
Parser->Context
);
if (EFI_ERROR (Status)) {
return Status;
}
}
Char += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength);
Parser->ParsedBodyLength += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength);
if (Parser->ParsedBodyLength == Parser->ContentLength) {
Parser->State = BodyParserComplete;
}
break;
case BodyParserChunkSizeStart:
//
// First byte of chunk-size, the chunk-size might be truncated.
//
Parser->CurrentChunkSize = 0;
Parser->State = BodyParserChunkSize;
case BodyParserChunkSize:
if (!NET_IS_HEX_CHAR (*Char)) {
if (*Char == ';') {
Parser->State = BodyParserChunkExtStart;
Char++;
} else if (*Char == '\r') {
Parser->State = BodyParserChunkSizeEndCR;
Char++;
} else {
Parser->State = BodyParserStateMax;
}
break;
}
if (Parser->CurrentChunkSize > (((~((UINTN) 0)) - 16) / 16)) {
return EFI_INVALID_PARAMETER;
}
Parser->CurrentChunkSize = Parser->CurrentChunkSize * 16 + HttpIoHexCharToUintn (*Char);
Char++;
break;
case BodyParserChunkExtStart:
//
// Ignore all the chunk extensions.
//
if (*Char == '\r') {
Parser->State = BodyParserChunkSizeEndCR;
}
Char++;
break;
case BodyParserChunkSizeEndCR:
if (*Char != '\n') {
Parser->State = BodyParserStateMax;
break;
}
Parser->State = BodyParserChunkDataStart;
Parser->CurrentChunkParsedSize = 0;
Char++;
break;
case BodyParserChunkDataStart:
if (Parser->CurrentChunkSize == 0) {
//
// This is the last chunk, the trailer header is unsupported.
//
Parser->ContentLengthIsValid = TRUE;
Parser->State = BodyParserComplete;
break;
}
//
// First byte of chunk-data, the chunk data also might be truncated.
//
RemainderLengthInThis = BodyLength - (Char - Body);
LengthForCallback = MIN (Parser->CurrentChunkSize - Parser->CurrentChunkParsedSize, RemainderLengthInThis);
if (Parser->Callback != NULL) {
Status = Parser->Callback (
BodyParseEventOnData,
Char,
LengthForCallback,
Parser->Context
);
if (EFI_ERROR (Status)) {
return Status;
}
}
Char += LengthForCallback;
Parser->ContentLength += LengthForCallback;
Parser->CurrentChunkParsedSize += LengthForCallback;
if (Parser->CurrentChunkParsedSize == Parser->CurrentChunkSize) {
Parser->State = BodyParserChunkDataEnd;
}
break;
case BodyParserChunkDataEnd:
if (*Char == '\r') {
Parser->State = BodyParserChunkDataEndCR;
} else {
Parser->State = BodyParserStateMax;
}
Char++;
break;
case BodyParserChunkDataEndCR:
if (*Char != '\n') {
Parser->State = BodyParserStateMax;
break;
}
Char++;
Parser->State = BodyParserChunkSizeStart;
break;
default:
break;
}
}
if (Parser->State == BodyParserStateMax) {
return EFI_ABORTED;
}
return EFI_SUCCESS;
}
/**
Check whether the message-body is complete or not.
@param[in] MsgParser Pointer to the message parser.
@retval TRUE Message-body is complete.
@retval FALSE Message-body is not complete.
**/
BOOLEAN
EFIAPI
HttpIsMessageComplete (
IN VOID *MsgParser
)
{
HTTP_BODY_PARSER *Parser;
Parser = (HTTP_BODY_PARSER*) MsgParser;
if (Parser->State == BodyParserComplete) {
return TRUE;
}
return FALSE;
}
/**
Get the content length of the entity.
Note that in trunk transfer, the entity length is not valid until the whole message body is received.
@param[in] MsgParser Pointer to the message parser.
@param[out] ContentLength Pointer to store the length of the entity.
@retval EFI_SUCCESS Successfully to get the entity length.
@retval EFI_NOT_READY Entity length is not valid yet.
@retval EFI_INVALID_PARAMETER MsgParser is NULL or ContentLength is NULL.
**/
EFI_STATUS
EFIAPI
HttpGetEntityLength (
IN VOID *MsgParser,
OUT UINTN *ContentLength
)
{
HTTP_BODY_PARSER *Parser;
if (MsgParser == NULL || ContentLength == NULL) {
return EFI_INVALID_PARAMETER;
}
Parser = (HTTP_BODY_PARSER*) MsgParser;
if (!Parser->ContentLengthIsValid) {
return EFI_NOT_READY;
}
*ContentLength = Parser->ContentLength;
return EFI_SUCCESS;
}
/**
Release the resource of the message parser.
@param[in] MsgParser Pointer to the message parser.
**/
VOID
EFIAPI
HttpFreeMsgParser (
IN VOID *MsgParser
)
{
FreePool (MsgParser);
}
|