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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// The rules for parsing content-types were borrowed from Firefox:
// http://lxr.mozilla.org/mozilla/source/netwerk/base/src/nsURLHelper.cpp#834
#include "net/http/http_util.h"
#include <algorithm>
#include <array>
#include <optional>
#include <string>
#include <string_view>
#include "base/check_op.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_split.h"
#include "base/strings/string_tokenizer.h"
#include "base/strings/string_util.h"
#include "base/strings/string_view_util.h"
#include "base/strings/stringprintf.h"
#include "base/time/time.h"
#include "net/base/features.h"
#include "net/base/mime_util.h"
#include "net/base/parse_number.h"
#include "net/base/url_util.h"
#include "net/http/http_response_headers.h"
namespace net {
namespace {
template <typename ConstIterator>
void TrimLWSImplementation(ConstIterator* begin, ConstIterator* end) {
// leading whitespace
while (*begin < *end && HttpUtil::IsLWS((*begin)[0]))
++(*begin);
// trailing whitespace
while (*begin < *end && HttpUtil::IsLWS((*end)[-1]))
--(*end);
}
// Helper class that builds the list of languages for the Accept-Language
// headers.
// The output is a comma-separated list of languages as string.
// Duplicates are removed.
class AcceptLanguageBuilder {
public:
// Adds a language to the string.
// Duplicates are ignored.
void AddLanguageCode(const std::string& language) {
// No Q score supported, only supports ASCII.
DCHECK_EQ(std::string::npos, language.find_first_of("; "));
DCHECK(base::IsStringASCII(language));
if (seen_.find(language) == seen_.end()) {
if (str_.empty()) {
base::StringAppendF(&str_, "%s", language.c_str());
} else {
base::StringAppendF(&str_, ",%s", language.c_str());
}
seen_.insert(language);
}
}
// Returns the string constructed up to this point.
std::string GetString() const { return str_; }
private:
// The string that contains the list of languages, comma-separated.
std::string str_;
// Set the remove duplicates.
std::unordered_set<std::string> seen_;
};
// Extract the base language code from a language code.
// If there is no '-' in the code, the original code is returned.
std::string GetBaseLanguageCode(const std::string& language_code) {
std::vector<std::string> tokens = base::SplitString(
language_code, "-", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
return tokens.empty() ? "" : std::move(tokens[0]);
}
} // namespace
// HttpUtil -------------------------------------------------------------------
std::string HttpUtil::GenerateRequestLine(std::string_view method,
const GURL& url,
bool is_for_get_to_http_proxy) {
static constexpr char kSuffix[] = " HTTP/1.1\r\n";
const std::string path = is_for_get_to_http_proxy
? HttpUtil::SpecForRequest(url)
: url.PathForRequest();
return base::StrCat({method, " ", path, kSuffix});
}
// static
std::string HttpUtil::SpecForRequest(const GURL& url) {
DCHECK(url.is_valid() &&
(url.SchemeIsHTTPOrHTTPS() || url.SchemeIsWSOrWSS()));
return SimplifyUrlForRequest(url).spec();
}
// static
void HttpUtil::ParseContentType(std::string_view content_type_str,
std::string* mime_type,
std::string* charset,
bool* had_charset,
std::string* boundary) {
std::string mime_type_value;
base::StringPairs params;
bool result = ParseMimeType(content_type_str, &mime_type_value, ¶ms);
// If the server sent "*/*", it is meaningless, so do not store it.
// Also, reject a mime-type if it does not include a slash.
// Some servers give junk after the charset parameter, which may
// include a comma, so this check makes us a bit more tolerant.
if (!result || content_type_str == "*/*")
return;
std::string charset_value;
bool type_has_charset = false;
bool type_has_boundary = false;
for (const auto& param : params) {
// Trim LWS from param value, ParseMimeType() leaves WS for quoted-string.
// TODO(mmenke): Check that name has only valid characters.
if (!type_has_charset &&
base::EqualsCaseInsensitiveASCII(param.first, "charset")) {
type_has_charset = true;
charset_value = std::string(HttpUtil::TrimLWS(param.second));
continue;
}
if (boundary && !type_has_boundary &&
base::EqualsCaseInsensitiveASCII(param.first, "boundary")) {
type_has_boundary = true;
*boundary = std::string(HttpUtil::TrimLWS(param.second));
continue;
}
}
// If `mime_type_value` is the same as `mime_type`, then just update
// `charset`. However, if `charset` is empty and `mime_type` hasn't changed,
// then don't wipe-out an existing `charset`.
bool eq = base::EqualsCaseInsensitiveASCII(mime_type_value, *mime_type);
if (!eq) {
*mime_type = base::ToLowerASCII(mime_type_value);
}
if ((!eq && *had_charset) || type_has_charset) {
*had_charset = true;
*charset = base::ToLowerASCII(charset_value);
}
}
// static
bool HttpUtil::ParseRangeHeader(const std::string& ranges_specifier,
std::vector<HttpByteRange>* ranges) {
size_t equal_char_offset = ranges_specifier.find('=');
if (equal_char_offset == std::string::npos)
return false;
// Try to extract bytes-unit part.
std::string_view bytes_unit =
std::string_view(ranges_specifier).substr(0, equal_char_offset);
// "bytes" unit identifier is not found.
bytes_unit = TrimLWS(bytes_unit);
if (!base::EqualsCaseInsensitiveASCII(bytes_unit, "bytes")) {
return false;
}
std::string::const_iterator byte_range_set_begin =
ranges_specifier.begin() + equal_char_offset + 1;
std::string::const_iterator byte_range_set_end = ranges_specifier.end();
ValuesIterator byte_range_set_iterator(
std::string_view(byte_range_set_begin, byte_range_set_end),
/*delimiter=*/',');
while (byte_range_set_iterator.GetNext()) {
std::string_view value = byte_range_set_iterator.value();
size_t minus_char_offset = value.find('-');
// If '-' character is not found, reports failure.
if (minus_char_offset == std::string::npos)
return false;
std::string_view first_byte_pos = value.substr(0, minus_char_offset);
first_byte_pos = TrimLWS(first_byte_pos);
HttpByteRange range;
// Try to obtain first-byte-pos.
if (!first_byte_pos.empty()) {
int64_t first_byte_position = -1;
if (!base::StringToInt64(first_byte_pos, &first_byte_position))
return false;
range.set_first_byte_position(first_byte_position);
}
std::string_view last_byte_pos = value.substr(minus_char_offset + 1);
last_byte_pos = TrimLWS(last_byte_pos);
// We have last-byte-pos or suffix-byte-range-spec in this case.
if (!last_byte_pos.empty()) {
int64_t last_byte_position;
if (!base::StringToInt64(last_byte_pos, &last_byte_position))
return false;
if (range.HasFirstBytePosition())
range.set_last_byte_position(last_byte_position);
else
range.set_suffix_length(last_byte_position);
} else if (!range.HasFirstBytePosition()) {
return false;
}
// Do a final check on the HttpByteRange object.
if (!range.IsValid())
return false;
ranges->push_back(range);
}
return !ranges->empty();
}
// static
// From RFC 2616 14.16:
// content-range-spec =
// bytes-unit SP byte-range-resp-spec "/" ( instance-length | "*" )
// byte-range-resp-spec = (first-byte-pos "-" last-byte-pos) | "*"
// instance-length = 1*DIGIT
// bytes-unit = "bytes"
bool HttpUtil::ParseContentRangeHeaderFor206(
std::string_view content_range_spec,
int64_t* first_byte_position,
int64_t* last_byte_position,
int64_t* instance_length) {
*first_byte_position = *last_byte_position = *instance_length = -1;
content_range_spec = TrimLWS(content_range_spec);
size_t space_position = content_range_spec.find(' ');
if (space_position == std::string_view::npos) {
return false;
}
// Invalid header if it doesn't contain "bytes-unit".
if (!base::EqualsCaseInsensitiveASCII(
TrimLWS(content_range_spec.substr(0, space_position)), "bytes")) {
return false;
}
size_t minus_position = content_range_spec.find('-', space_position + 1);
if (minus_position == std::string_view::npos) {
return false;
}
size_t slash_position = content_range_spec.find('/', minus_position + 1);
if (slash_position == std::string_view::npos) {
return false;
}
if (base::StringToInt64(
TrimLWS(content_range_spec.substr(
space_position + 1, minus_position - (space_position + 1))),
first_byte_position) &&
*first_byte_position >= 0 &&
base::StringToInt64(
TrimLWS(content_range_spec.substr(
minus_position + 1, slash_position - (minus_position + 1))),
last_byte_position) &&
*last_byte_position >= *first_byte_position &&
base::StringToInt64(
TrimLWS(content_range_spec.substr(slash_position + 1)),
instance_length) &&
*instance_length > *last_byte_position) {
return true;
}
*first_byte_position = *last_byte_position = *instance_length = -1;
return false;
}
// static
bool HttpUtil::ParseRetryAfterHeader(const std::string& retry_after_string,
base::Time now,
base::TimeDelta* retry_after) {
uint32_t seconds;
base::Time time;
base::TimeDelta interval;
if (ParseUint32(retry_after_string, ParseIntFormat::NON_NEGATIVE, &seconds)) {
interval = base::Seconds(seconds);
} else if (base::Time::FromUTCString(retry_after_string.c_str(), &time)) {
interval = time - now;
} else {
return false;
}
if (interval < base::Seconds(0))
return false;
*retry_after = interval;
return true;
}
// static
std::string HttpUtil::TimeFormatHTTP(base::Time time) {
static constexpr std::array<char[4], 7> kWeekdayName = {
"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
static constexpr std::array<char[4], 12> kMonthName = {
"Jan", "Feb", "Mar", "Apr", "May", "Jun",
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
base::Time::Exploded exploded;
time.UTCExplode(&exploded);
return base::StringPrintf(
"%s, %02d %s %04d %02d:%02d:%02d GMT", kWeekdayName[exploded.day_of_week],
exploded.day_of_month, kMonthName[exploded.month - 1], exploded.year,
exploded.hour, exploded.minute, exploded.second);
}
namespace {
// A header string containing any of the following fields will cause
// an error. The list comes from the fetch standard.
const char* const kForbiddenHeaderFields[] = {
"accept-charset",
"accept-encoding",
"access-control-request-headers",
"access-control-request-method",
"access-control-request-private-network",
"connection",
"content-length",
"cookie",
"cookie2",
"date",
"dnt",
"expect",
"host",
"keep-alive",
"origin",
"referer",
"set-cookie",
"te",
"trailer",
"transfer-encoding",
"upgrade",
// TODO(mmenke): This is no longer banned, but still here due to issues
// mentioned in https://crbug.com/571722.
"user-agent",
"via",
};
// A header string containing any of the following fields with a forbidden
// method name in the value will cause an error. The list comes from the fetch
// standard.
const char* const kForbiddenHeaderFieldsWithForbiddenMethod[] = {
"x-http-method",
"x-http-method-override",
"x-method-override",
};
// The forbidden method names that is defined in the fetch standard, and used
// to check the kForbiddenHeaderFileWithForbiddenMethod above.
const char* const kForbiddenMethods[] = {
"connect",
"trace",
"track",
};
} // namespace
// static
bool HttpUtil::IsMethodSafe(std::string_view method) {
return method == "GET" || method == "HEAD" || method == "OPTIONS" ||
method == "TRACE";
}
// static
bool HttpUtil::IsMethodIdempotent(std::string_view method) {
return IsMethodSafe(method) || method == "PUT" || method == "DELETE";
}
// static
bool HttpUtil::IsSafeHeader(std::string_view name, std::string_view value) {
if (base::StartsWith(name, "proxy-", base::CompareCase::INSENSITIVE_ASCII) ||
base::StartsWith(name, "sec-", base::CompareCase::INSENSITIVE_ASCII))
return false;
for (const char* field : kForbiddenHeaderFields) {
if (base::EqualsCaseInsensitiveASCII(name, field))
return false;
}
bool is_forbidden_header_fields_with_forbidden_method = false;
for (const char* field : kForbiddenHeaderFieldsWithForbiddenMethod) {
if (base::EqualsCaseInsensitiveASCII(name, field)) {
is_forbidden_header_fields_with_forbidden_method = true;
break;
}
}
if (is_forbidden_header_fields_with_forbidden_method) {
ValuesIterator method_iterator(value, ',');
while (method_iterator.GetNext()) {
std::string_view method = method_iterator.value();
for (const char* forbidden_method : kForbiddenMethods) {
if (base::EqualsCaseInsensitiveASCII(method, forbidden_method))
return false;
}
}
}
return true;
}
// static
bool HttpUtil::IsValidHeaderName(std::string_view name) {
// Check whether the header name is RFC 2616-compliant.
return HttpUtil::IsToken(name);
}
// static
bool HttpUtil::IsValidHeaderValue(std::string_view value) {
// Just a sanity check: disallow NUL, CR and LF.
for (char c : value) {
if (c == '\0' || c == '\r' || c == '\n')
return false;
}
return true;
}
// static
bool HttpUtil::IsNonCoalescingHeader(std::string_view name) {
// NOTE: "set-cookie2" headers do not support expires attributes, so we don't
// have to list them here.
// As of 2023, using FlatSet here actually makes the lookup slower, and
// unordered_set is even slower than that.
static constexpr std::string_view kNonCoalescingHeaders[] = {
"date", "expires", "last-modified",
"location", // See bug 1050541 for details
"retry-after", "set-cookie",
// The format of auth-challenges mixes both space separated tokens and
// comma separated properties, so coalescing on comma won't work.
"www-authenticate", "proxy-authenticate",
// STS specifies that UAs must not process any STS headers after the first
// one.
"strict-transport-security"};
for (std::string_view header : kNonCoalescingHeaders) {
if (base::EqualsCaseInsensitiveASCII(name, header)) {
return true;
}
}
return false;
}
// static
void HttpUtil::TrimLWS(std::string::const_iterator* begin,
std::string::const_iterator* end) {
TrimLWSImplementation(begin, end);
}
// static
std::string_view HttpUtil::TrimLWS(std::string_view string) {
size_t begin_offset = 0;
size_t end_offset = string.size();
TrimLWS(string, begin_offset, end_offset);
return string.substr(begin_offset, end_offset - begin_offset);
}
// static
void HttpUtil::TrimLWS(std::string_view string,
size_t& begin_offset,
size_t& end_offset) {
// Leading whitespace
while (begin_offset < end_offset && HttpUtil::IsLWS(string[begin_offset])) {
++begin_offset;
}
// Trailing whitespace
while (begin_offset < end_offset && HttpUtil::IsLWS(string[end_offset - 1])) {
--end_offset;
}
}
bool HttpUtil::IsTokenChar(char c) {
return !(c >= 0x7F || c <= 0x20 || c == '(' || c == ')' || c == '<' ||
c == '>' || c == '@' || c == ',' || c == ';' || c == ':' ||
c == '\\' || c == '"' || c == '/' || c == '[' || c == ']' ||
c == '?' || c == '=' || c == '{' || c == '}');
}
// See RFC 7230 Sec 3.2.6 for the definition of |token|.
bool HttpUtil::IsToken(std::string_view string) {
if (string.empty())
return false;
for (char c : string) {
if (!IsTokenChar(c))
return false;
}
return true;
}
// See RFC 5987 Sec 3.2.1 for the definition of |parmname|.
bool HttpUtil::IsParmName(std::string_view str) {
if (str.empty())
return false;
for (char c : str) {
if (!IsTokenChar(c) || c == '*' || c == '\'' || c == '%')
return false;
}
return true;
}
namespace {
bool IsQuote(char c) {
return c == '"';
}
bool UnquoteImpl(std::string_view str, bool strict_quotes, std::string* out) {
if (str.empty())
return false;
// Nothing to unquote.
if (!IsQuote(str[0]))
return false;
// No terminal quote mark.
if (str.size() < 2 || str.front() != str.back())
return false;
// Strip quotemarks
str.remove_prefix(1);
str.remove_suffix(1);
// Unescape quoted-pair (defined in RFC 2616 section 2.2)
bool prev_escape = false;
std::string unescaped;
for (char c : str) {
if (c == '\\' && !prev_escape) {
prev_escape = true;
continue;
}
if (strict_quotes && !prev_escape && IsQuote(c))
return false;
prev_escape = false;
unescaped.push_back(c);
}
// Terminal quote is escaped.
if (strict_quotes && prev_escape)
return false;
*out = std::move(unescaped);
return true;
}
} // anonymous namespace
// static
std::string HttpUtil::Unquote(std::string_view str) {
std::string result;
if (!UnquoteImpl(str, false, &result))
return std::string(str);
return result;
}
// static
bool HttpUtil::StrictUnquote(std::string_view str, std::string* out) {
return UnquoteImpl(str, true, out);
}
// static
std::string HttpUtil::Quote(std::string_view str) {
std::string escaped;
escaped.reserve(2 + str.size());
// Esape any backslashes or quotemarks within the string, and
// then surround with quotes.
escaped.push_back('"');
for (char c : str) {
if (c == '"' || c == '\\')
escaped.push_back('\\');
escaped.push_back(c);
}
escaped.push_back('"');
return escaped;
}
// Find the "http" substring in a status line. This allows for
// some slop at the start. If the "http" string could not be found
// then returns std::string::npos.
// static
size_t HttpUtil::LocateStartOfStatusLine(base::span<const uint8_t> buf) {
const size_t slop = 4;
const size_t http_len = 4;
if (buf.size() >= http_len) {
size_t i_max = std::min(buf.size() - http_len, slop);
for (size_t i = 0; i <= i_max; ++i) {
if (base::EqualsCaseInsensitiveASCII(
base::as_string_view(buf.subspan(i, http_len)), "http")) {
return i;
}
}
}
return std::string::npos; // Not found
}
static size_t LocateEndOfHeadersHelper(base::span<const uint8_t> buf,
size_t i,
bool accept_empty_header_list) {
char last_c = '\0';
bool was_lf = false;
if (accept_empty_header_list) {
// Normally two line breaks signal the end of a header list. An empty header
// list ends with a single line break at the start of the buffer.
last_c = '\n';
was_lf = true;
}
for (; i < buf.size(); ++i) {
char c = buf[i];
if (c == '\n') {
if (was_lf)
return i + 1;
was_lf = true;
} else if (c != '\r' || last_c != '\n') {
was_lf = false;
}
last_c = c;
}
return std::string::npos;
}
size_t HttpUtil::LocateEndOfAdditionalHeaders(base::span<const uint8_t> buf,
size_t i) {
return LocateEndOfHeadersHelper(buf, i, true);
}
size_t HttpUtil::LocateEndOfHeaders(base::span<const uint8_t> buf, size_t i) {
return LocateEndOfHeadersHelper(buf, i, false);
}
// In order for a line to be continuable, it must specify a
// non-blank header-name. Line continuations are specifically for
// header values -- do not allow headers names to span lines.
static bool IsLineSegmentContinuable(std::string_view line) {
if (line.empty())
return false;
size_t colon = line.find(':');
if (colon == std::string_view::npos) {
return false;
}
std::string_view name = line.substr(0, colon);
// Name can't be empty.
if (name.empty())
return false;
// Can't start with LWS (this would imply the segment is a continuation)
if (HttpUtil::IsLWS(name[0]))
return false;
return true;
}
// Helper used by AssembleRawHeaders, to find the end of the status line.
static size_t FindStatusLineEnd(std::string_view str) {
size_t i = str.find_first_of("\r\n");
if (i == std::string_view::npos) {
return str.size();
}
return i;
}
// Helper used by AssembleRawHeaders, to skip past leading LWS.
static std::string_view RemoveLeadingNonLWS(std::string_view str) {
for (size_t i = 0; i < str.size(); i++) {
if (!HttpUtil::IsLWS(str[i]))
return str.substr(i);
}
return std::string_view(); // Remove everything.
}
std::string HttpUtil::AssembleRawHeaders(std::string_view input) {
std::string raw_headers;
raw_headers.reserve(input.size());
// Skip any leading slop, since the consumers of this output
// (HttpResponseHeaders) don't deal with it.
size_t status_begin_offset =
LocateStartOfStatusLine(base::as_byte_span(input));
if (status_begin_offset != std::string::npos)
input.remove_prefix(status_begin_offset);
// Copy the status line.
size_t status_line_end = FindStatusLineEnd(input);
raw_headers.append(input.data(), status_line_end);
input.remove_prefix(status_line_end);
// After the status line, every subsequent line is a header line segment.
// Should a segment start with LWS, it is a continuation of the previous
// line's field-value.
// TODO(ericroman): is this too permissive? (delimits on [\r\n]+)
base::StringViewTokenizer lines(input, "\r\n");
// This variable is true when the previous line was continuable.
bool prev_line_continuable = false;
while (lines.GetNext()) {
std::string_view line = lines.token();
if (prev_line_continuable && IsLWS(line[0])) {
// Join continuation; reduce the leading LWS to a single SP.
base::StrAppend(&raw_headers, {" ", RemoveLeadingNonLWS(line)});
} else {
// Terminate the previous line and copy the raw data to output.
base::StrAppend(&raw_headers, {"\n", line});
// Check if the current line can be continued.
prev_line_continuable = IsLineSegmentContinuable(line);
}
}
raw_headers.append("\n\n", 2);
// Use '\0' as the canonical line terminator. If the input already contained
// any embeded '\0' characters we will strip them first to avoid interpreting
// them as line breaks.
std::erase(raw_headers, '\0');
std::replace(raw_headers.begin(), raw_headers.end(), '\n', '\0');
return raw_headers;
}
std::string HttpUtil::ConvertHeadersBackToHTTPResponse(const std::string& str) {
std::string disassembled_headers;
base::StringTokenizer tokenizer(str, std::string(1, '\0'));
while (tokenizer.GetNext()) {
base::StrAppend(&disassembled_headers, {tokenizer.token_piece(), "\r\n"});
}
disassembled_headers.append("\r\n");
return disassembled_headers;
}
std::string HttpUtil::ExpandLanguageList(const std::string& language_prefs) {
const std::vector<std::string> languages = base::SplitString(
language_prefs, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
if (languages.empty())
return "";
AcceptLanguageBuilder builder;
const size_t size = languages.size();
for (size_t i = 0; i < size; ++i) {
const std::string& language = languages[i];
builder.AddLanguageCode(language);
// Extract the primary language subtag.
const std::string& base_language = GetBaseLanguageCode(language);
// Skip 'x' and 'i' as a primary language subtag per RFC 5646 section 2.1.1.
if (base_language == "x" || base_language == "i")
continue;
// Look ahead and add the primary language subtag as a language if the next
// language is not part of the same family. This may not be perfect because
// an input of "en-US,fr,en" will yield "en-US,en,fr,en" and later make "en"
// a higher priority than "fr" despite the original preference.
const size_t j = i + 1;
if (j >= size || GetBaseLanguageCode(languages[j]) != base_language) {
builder.AddLanguageCode(base_language);
}
}
return builder.GetString();
}
// TODO(jungshik): This function assumes that the input is a comma separated
// list without any whitespace. As long as it comes from the preference and
// a user does not manually edit the preference file, it's the case. Still,
// we may have to make it more robust.
std::string HttpUtil::GenerateAcceptLanguageHeader(
const std::string& raw_language_list) {
// We use integers for qvalue and qvalue decrement that are 10 times
// larger than actual values to avoid a problem with comparing
// two floating point numbers.
const unsigned int kQvalueDecrement10 = 1;
unsigned int qvalue10 = 10;
base::StringTokenizer t(raw_language_list, ",");
std::string lang_list_with_q;
while (t.GetNext()) {
std::string language = t.token();
if (qvalue10 == 10) {
// q=1.0 is implicit.
lang_list_with_q = language;
} else {
DCHECK_LT(qvalue10, 10U);
base::StringAppendF(&lang_list_with_q, ",%s;q=0.%d", language.c_str(),
qvalue10);
}
// It does not make sense to have 'q=0'.
if (qvalue10 > kQvalueDecrement10)
qvalue10 -= kQvalueDecrement10;
}
return lang_list_with_q;
}
bool HttpUtil::HasStrongValidators(
HttpVersion version,
std::optional<std::string_view> etag_header,
std::optional<std::string_view> last_modified_header,
std::optional<std::string_view> date_header) {
if (version < HttpVersion(1, 1))
return false;
if (etag_header && !etag_header->empty()) {
size_t slash = etag_header->find('/');
if (slash == std::string_view::npos || slash == 0) {
return true;
}
std::string_view trimmed_etag = TrimLWS(etag_header->substr(0, slash));
if (!base::EqualsCaseInsensitiveASCII(trimmed_etag, "w")) {
return true;
}
}
base::Time last_modified;
if (!last_modified_header ||
!base::Time::FromString(std::string(*last_modified_header).c_str(),
&last_modified)) {
return false;
}
base::Time date;
if (!date_header ||
!base::Time::FromString(std::string(*date_header).c_str(), &date)) {
return false;
}
// Last-Modified is implicitly weak unless it is at least 60 seconds before
// the Date value.
return ((date - last_modified).InSeconds() >= 60);
}
bool HttpUtil::HasValidators(
HttpVersion version,
std::optional<std::string_view> etag_header,
std::optional<std::string_view> last_modified_header) {
if (version < HttpVersion(1, 0))
return false;
base::Time last_modified;
// Have to construct a C-style string here, since that's what
// base::Time::FromString requires.
if (last_modified_header &&
base::Time::FromString(std::string(*last_modified_header).c_str(),
&last_modified)) {
return true;
}
// It is OK to consider an empty string in etag_header to be a missing header
// since valid ETags are always quoted-strings (see RFC 2616 3.11) and thus
// empty ETags aren't empty strings (i.e., an empty ETag might be "\"\"").
return version >= HttpVersion(1, 1) && etag_header && !etag_header->empty();
}
// Functions for histogram initialization. The code 0 is put in the map to
// track status codes that are invalid.
// TODO(gavinp): Greatly prune the collected codes once we learn which
// ones are not sent in practice, to reduce upload size & memory use.
enum {
HISTOGRAM_MIN_HTTP_STATUS_CODE = 100,
HISTOGRAM_MAX_HTTP_STATUS_CODE = 599,
};
// static
std::vector<int> HttpUtil::GetStatusCodesForHistogram() {
std::vector<int> codes;
codes.reserve(
HISTOGRAM_MAX_HTTP_STATUS_CODE - HISTOGRAM_MIN_HTTP_STATUS_CODE + 2);
codes.push_back(0);
for (int i = HISTOGRAM_MIN_HTTP_STATUS_CODE;
i <= HISTOGRAM_MAX_HTTP_STATUS_CODE; ++i)
codes.push_back(i);
return codes;
}
// static
int HttpUtil::MapStatusCodeForHistogram(int code) {
if (HISTOGRAM_MIN_HTTP_STATUS_CODE <= code &&
code <= HISTOGRAM_MAX_HTTP_STATUS_CODE)
return code;
return 0;
}
// BNF from section 4.2 of RFC 2616:
//
// message-header = field-name ":" [ field-value ]
// field-name = token
// field-value = *( field-content | LWS )
// field-content = <the OCTETs making up the field-value
// and consisting of either *TEXT or combinations
// of token, separators, and quoted-string>
//
HttpUtil::HeadersIterator::HeadersIterator(std::string_view headers,
const std::string& line_delimiter)
: headers_(headers),
// It's important to use `headers_` here rather than `headers`, since
// subtracting two string_view::iterators from each other is not
// guaranteed to work, if they're from different string_views, even if one
// is a copy of the other. Note that StringViewTokenizer uses iterators to
// the passed in string_view, rather than a copying it.
lines_(headers_, line_delimiter) {}
HttpUtil::HeadersIterator::~HeadersIterator() = default;
bool HttpUtil::HeadersIterator::GetNext() {
while (lines_.GetNext()) {
// Since `tokenizer_` was constructed using `headers_`, this is subtracting
// iterators for the exact same string_view, rather than to two copies of
// the same string_view, so is safe.
name_begin_ = lines_.token_begin() - headers_.begin();
values_end_ = lines_.token_end() - headers_.begin();
// Colon index, relative to start of line.
size_t colon = lines_.token().find(':');
if (colon == std::string_view::npos) {
continue; // skip malformed header
}
// Adjust colon to be relative to start of headers.
colon += name_begin_;
name_end_ = colon;
// If the name starts with LWS, it is an invalid line.
// Leading LWS implies a line continuation, and these should have
// already been joined by AssembleRawHeaders().
if (name_begin_ == name_end_ || IsLWS(headers_[name_begin_])) {
continue;
}
TrimLWS(headers_, name_begin_, name_end_);
CHECK_LT(name_begin_, name_end_);
if (!IsToken(headers_.substr(name_begin_, name_end_ - name_begin_))) {
continue; // skip malformed header
}
values_begin_ = colon + 1;
TrimLWS(headers_, values_begin_, values_end_);
// if we got a header name, then we are done.
return true;
}
return false;
}
HttpUtil::ValuesIterator::ValuesIterator(std::string_view values,
char delimiter,
bool ignore_empty_values)
: values_(values),
ignore_empty_values_(ignore_empty_values),
// It's important to use `values_` here rather than `value`, since
// subtracting two string_view::iterators from each other is not
// guaranteed to work, if they're from different string_views, even if one
// is a copy of the other. Note that StringViewTokenizer uses iterators to
// the passed in string_view, rather than a copying it.
tokenizer_(values_, std::string(1, delimiter)) {
tokenizer_.set_quote_chars("\"");
// Could set this unconditionally, since code below has to check for empty
// values after trimming, anyways, but may provide a minor performance
// improvement.
if (!ignore_empty_values_) {
tokenizer_.set_options(base::StringTokenizer::RETURN_EMPTY_TOKENS);
}
}
HttpUtil::ValuesIterator::ValuesIterator(const ValuesIterator& other) = default;
HttpUtil::ValuesIterator::~ValuesIterator() = default;
bool HttpUtil::ValuesIterator::GetNext() {
while (tokenizer_.GetNext()) {
// Since `tokenizer_` was constructed using `values_`, this is subtracting
// iterators for the exact same string_view, rather than to two copies of
// the same string_view, so is safe.
value_begin_ = tokenizer_.token_begin() - values_.begin();
value_end_ = tokenizer_.token_end() - values_.begin();
TrimLWS(values_, value_begin_, value_end_);
if (!ignore_empty_values_ || value_begin_ != value_end_) {
return true;
}
}
return false;
}
HttpUtil::NameValuePairsIterator::NameValuePairsIterator(std::string_view value,
char delimiter,
Values optional_values,
Quotes strict_quotes)
: props_(value, delimiter),
values_optional_(optional_values == Values::NOT_REQUIRED),
strict_quotes_(strict_quotes == Quotes::STRICT_QUOTES) {}
HttpUtil::NameValuePairsIterator::NameValuePairsIterator(
const NameValuePairsIterator& other) = default;
HttpUtil::NameValuePairsIterator::~NameValuePairsIterator() = default;
// We expect properties to be formatted as one of:
// name="value"
// name='value'
// name='\'value\''
// name=value
// name = value
// name (if values_optional_ is true)
// Due to buggy implementations found in some embedded devices, we also
// accept values with missing close quotemark (http://crbug.com/39836):
// name="value
bool HttpUtil::NameValuePairsIterator::GetNext() {
CHECK(valid_);
// Not an error, but nothing left to do.
if (props_.GetNext()) {
// State only becomes invalid if there's another element, but parsing it
// fails.
valid_ = ParseNameValuePair(props_.value());
if (valid_) {
return true;
}
}
// Clear all fields when returning false, regardless of whether `valid` is
// true or not, since any populated data is no longer valid.
name_ = std::string_view();
value_ = std::string_view();
unquoted_value_.clear();
value_is_quoted_ = false;
return false;
}
bool HttpUtil::NameValuePairsIterator::ParseNameValuePair(
std::string_view name_value_pair) {
// Scan for the equals sign.
const size_t equals = name_value_pair.find('=');
if (equals == 0) {
return false; // Malformed, no name
}
const bool has_value = (equals != std::string_view::npos);
if (!has_value && !values_optional_) {
return false; // Malformed, no equals sign and values are required
}
// Make `name_` everything up until the equals sign.
name_ = TrimLWS(name_value_pair.substr(0, equals));
// Clear rest of state.
value_ = std::string_view();
value_is_quoted_ = false;
unquoted_value_.clear();
// If there is a value, do additional checking and calculate the value.
if (has_value) {
// Check that no quote appears before the equals sign.
if (std::ranges::any_of(name_, IsQuote)) {
return false;
}
// Value consists of everything after the equals sign, with whitespace
// trimmed.
value_ = TrimLWS(name_value_pair.substr(equals + 1));
if (value_.empty()) {
// Malformed; value is empty
return false;
}
}
if (has_value && IsQuote(value_.front())) {
value_is_quoted_ = true;
if (strict_quotes_) {
return HttpUtil::StrictUnquote(value_, &unquoted_value_);
}
// Trim surrounding quotemarks off the value
if (value_.front() != value_.back() || value_.size() == 1) {
// NOTE: This is not as graceful as it sounds:
// * quoted-pairs will no longer be unquoted
// (["\"hello] should give ["hello]).
// * Does not detect when the final quote is escaped
// (["value\"] should give [value"])
value_is_quoted_ = false;
value_ = value_.substr(1); // Gracefully recover from mismatching quotes.
} else {
// Do not store iterators into this. See declaration of `unquoted_value_`.
unquoted_value_ = HttpUtil::Unquote(value_);
}
}
return true;
}
bool HttpUtil::ParseAcceptEncoding(const std::string& accept_encoding,
std::set<std::string>* allowed_encodings) {
DCHECK(allowed_encodings);
if (accept_encoding.find_first_of("\"") != std::string::npos)
return false;
allowed_encodings->clear();
base::StringTokenizer tokenizer(accept_encoding.begin(),
accept_encoding.end(), ",");
while (tokenizer.GetNext()) {
std::string_view entry = tokenizer.token_piece();
entry = TrimLWS(entry);
size_t semicolon_pos = entry.find(';');
if (semicolon_pos == std::string_view::npos) {
if (entry.find_first_of(HTTP_LWS) != std::string_view::npos) {
return false;
}
allowed_encodings->insert(base::ToLowerASCII(entry));
continue;
}
std::string_view encoding = entry.substr(0, semicolon_pos);
encoding = TrimLWS(encoding);
if (encoding.find_first_of(HTTP_LWS) != std::string_view::npos) {
return false;
}
std::string_view params = entry.substr(semicolon_pos + 1);
params = TrimLWS(params);
size_t equals_pos = params.find('=');
if (equals_pos == std::string_view::npos) {
return false;
}
std::string_view param_name = params.substr(0, equals_pos);
param_name = TrimLWS(param_name);
if (!base::EqualsCaseInsensitiveASCII(param_name, "q"))
return false;
std::string_view qvalue = params.substr(equals_pos + 1);
qvalue = TrimLWS(qvalue);
if (qvalue.empty())
return false;
if (qvalue[0] == '1') {
if (std::string_view("1.000").starts_with(qvalue)) {
allowed_encodings->insert(base::ToLowerASCII(encoding));
continue;
}
return false;
}
if (qvalue[0] != '0')
return false;
if (qvalue.length() == 1)
continue;
if (qvalue.length() <= 2 || qvalue.length() > 5)
return false;
if (qvalue[1] != '.')
return false;
bool nonzero_number = false;
for (size_t i = 2; i < qvalue.length(); ++i) {
if (!base::IsAsciiDigit(qvalue[i]))
return false;
if (qvalue[i] != '0')
nonzero_number = true;
}
if (nonzero_number)
allowed_encodings->insert(base::ToLowerASCII(encoding));
}
// RFC 7231 5.3.4 "A request without an Accept-Encoding header field implies
// that the user agent has no preferences regarding content-codings."
if (allowed_encodings->empty()) {
allowed_encodings->insert("*");
return true;
}
// Any browser must support "identity".
allowed_encodings->insert("identity");
// RFC says gzip == x-gzip; mirror it here for easier matching.
if (allowed_encodings->find("gzip") != allowed_encodings->end())
allowed_encodings->insert("x-gzip");
if (allowed_encodings->find("x-gzip") != allowed_encodings->end())
allowed_encodings->insert("gzip");
// RFC says compress == x-compress; mirror it here for easier matching.
if (allowed_encodings->find("compress") != allowed_encodings->end())
allowed_encodings->insert("x-compress");
if (allowed_encodings->find("x-compress") != allowed_encodings->end())
allowed_encodings->insert("compress");
return true;
}
bool HttpUtil::ParseContentEncoding(const std::string& content_encoding,
std::set<std::string>* used_encodings) {
DCHECK(used_encodings);
if (content_encoding.find_first_of("\"=;*") != std::string::npos)
return false;
used_encodings->clear();
base::StringTokenizer encoding_tokenizer(content_encoding.begin(),
content_encoding.end(), ",");
while (encoding_tokenizer.GetNext()) {
std::string_view encoding = TrimLWS(encoding_tokenizer.token_piece());
if (encoding.find_first_of(HTTP_LWS) != std::string_view::npos) {
return false;
}
used_encodings->insert(base::ToLowerASCII(encoding));
}
return true;
}
bool HttpUtil::HeadersContainMultipleCopiesOfField(
const HttpResponseHeaders& headers,
const std::string& field_name) {
size_t it = 0;
std::optional<std::string_view> field_value =
headers.EnumerateHeader(&it, field_name);
if (!field_value) {
return false;
}
// There's at least one `field_name` header. Check if there are any more
// such headers, and if so, return true if they have different values.
std::optional<std::string_view> field_value2;
while ((field_value2 = headers.EnumerateHeader(&it, field_name))) {
if (field_value != field_value2)
return true;
}
return false;
}
} // namespace net
|