-
Notifications
You must be signed in to change notification settings - Fork 4.8k
/
utility.cc
796 lines (690 loc) · 29.9 KB
/
utility.cc
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
#include "common/http/utility.h"
#include <http_parser.h>
#include <cstdint>
#include <string>
#include <vector>
#include "envoy/config/core/v3/http_uri.pb.h"
#include "envoy/config/core/v3/protocol.pb.h"
#include "envoy/http/header_map.h"
#include "common/buffer/buffer_impl.h"
#include "common/common/assert.h"
#include "common/common/empty_string.h"
#include "common/common/enum_to_int.h"
#include "common/common/fmt.h"
#include "common/common/utility.h"
#include "common/grpc/status.h"
#include "common/http/exception.h"
#include "common/http/header_map_impl.h"
#include "common/http/headers.h"
#include "common/http/message_impl.h"
#include "common/network/utility.h"
#include "common/protobuf/utility.h"
#include "absl/strings/match.h"
#include "absl/strings/numbers.h"
#include "absl/strings/str_cat.h"
#include "absl/strings/str_split.h"
#include "absl/strings/string_view.h"
namespace Envoy {
namespace Http {
static const char kDefaultPath[] = "/";
bool Utility::Url::initialize(absl::string_view absolute_url) {
struct http_parser_url u;
const bool is_connect = false;
http_parser_url_init(&u);
const int result =
http_parser_parse_url(absolute_url.data(), absolute_url.length(), is_connect, &u);
if (result != 0) {
return false;
}
if ((u.field_set & (1 << UF_HOST)) != (1 << UF_HOST) &&
(u.field_set & (1 << UF_SCHEMA)) != (1 << UF_SCHEMA)) {
return false;
}
scheme_ = absl::string_view(absolute_url.data() + u.field_data[UF_SCHEMA].off,
u.field_data[UF_SCHEMA].len);
uint16_t authority_len = u.field_data[UF_HOST].len;
if ((u.field_set & (1 << UF_PORT)) == (1 << UF_PORT)) {
authority_len = authority_len + u.field_data[UF_PORT].len + 1;
}
host_and_port_ =
absl::string_view(absolute_url.data() + u.field_data[UF_HOST].off, authority_len);
// RFC allows the absolute-uri to not end in /, but the absolute path form
// must start with
uint64_t path_len =
absolute_url.length() - (u.field_data[UF_HOST].off + host_and_port().length());
if (path_len > 0) {
uint64_t path_beginning = u.field_data[UF_HOST].off + host_and_port().length();
path_and_query_params_ = absl::string_view(absolute_url.data() + path_beginning, path_len);
} else {
path_and_query_params_ = absl::string_view(kDefaultPath, 1);
}
return true;
}
void Utility::appendXff(HeaderMap& headers, const Network::Address::Instance& remote_address) {
if (remote_address.type() != Network::Address::Type::Ip) {
return;
}
headers.appendForwardedFor(remote_address.ip()->addressAsString(), ",");
}
void Utility::appendVia(HeaderMap& headers, const std::string& via) {
// TODO(asraa): Investigate whether it is necessary to append with whitespace here by:
// (a) Validating we do not expect whitespace in via headers
// (b) Add runtime guarding in case users have upstreams which expect it.
headers.appendVia(via, ", ");
}
std::string Utility::createSslRedirectPath(const HeaderMap& headers) {
ASSERT(headers.Host());
ASSERT(headers.Path());
return fmt::format("https://{}{}", headers.Host()->value().getStringView(),
headers.Path()->value().getStringView());
}
Utility::QueryParams Utility::parseQueryString(absl::string_view url) {
size_t start = url.find('?');
if (start == std::string::npos) {
QueryParams params;
return params;
}
start++;
return parseParameters(url, start);
}
Utility::QueryParams Utility::parseFromBody(absl::string_view body) {
return parseParameters(body, 0);
}
Utility::QueryParams Utility::parseParameters(absl::string_view data, size_t start) {
QueryParams params;
while (start < data.size()) {
size_t end = data.find('&', start);
if (end == std::string::npos) {
end = data.size();
}
absl::string_view param(data.data() + start, end - start);
const size_t equal = param.find('=');
if (equal != std::string::npos) {
params.emplace(StringUtil::subspan(data, start, start + equal),
StringUtil::subspan(data, start + equal + 1, end));
} else {
params.emplace(StringUtil::subspan(data, start, end), "");
}
start = end + 1;
}
return params;
}
absl::string_view Utility::findQueryStringStart(const HeaderString& path) {
absl::string_view path_str = path.getStringView();
size_t query_offset = path_str.find('?');
if (query_offset == absl::string_view::npos) {
query_offset = path_str.length();
}
path_str.remove_prefix(query_offset);
return path_str;
}
std::string Utility::parseCookieValue(const HeaderMap& headers, const std::string& key) {
struct State {
std::string key_;
std::string ret_;
};
State state;
state.key_ = key;
headers.iterateReverse(
[](const HeaderEntry& header, void* context) -> HeaderMap::Iterate {
// Find the cookie headers in the request (typically, there's only one).
if (header.key() == Http::Headers::get().Cookie.get()) {
// Split the cookie header into individual cookies.
for (const auto s : StringUtil::splitToken(header.value().getStringView(), ";")) {
// Find the key part of the cookie (i.e. the name of the cookie).
size_t first_non_space = s.find_first_not_of(" ");
size_t equals_index = s.find('=');
if (equals_index == absl::string_view::npos) {
// The cookie is malformed if it does not have an `=`. Continue
// checking other cookies in this header.
continue;
}
const absl::string_view k = s.substr(first_non_space, equals_index - first_non_space);
State* state = static_cast<State*>(context);
// If the key matches, parse the value from the rest of the cookie string.
if (k == state->key_) {
absl::string_view v = s.substr(equals_index + 1, s.size() - 1);
// Cookie values may be wrapped in double quotes.
// https://tools.ietf.org/html/rfc6265#section-4.1.1
if (v.size() >= 2 && v.back() == '"' && v[0] == '"') {
v = v.substr(1, v.size() - 2);
}
state->ret_ = std::string{v};
return HeaderMap::Iterate::Break;
}
}
}
return HeaderMap::Iterate::Continue;
},
&state);
return state.ret_;
}
std::string Utility::makeSetCookieValue(const std::string& key, const std::string& value,
const std::string& path, const std::chrono::seconds max_age,
bool httponly) {
std::string cookie_value;
// Best effort attempt to avoid numerous string copies.
cookie_value.reserve(value.size() + path.size() + 30);
cookie_value = absl::StrCat(key, "=\"", value, "\"");
if (max_age != std::chrono::seconds::zero()) {
absl::StrAppend(&cookie_value, "; Max-Age=", max_age.count());
}
if (!path.empty()) {
absl::StrAppend(&cookie_value, "; Path=", path);
}
if (httponly) {
absl::StrAppend(&cookie_value, "; HttpOnly");
}
return cookie_value;
}
uint64_t Utility::getResponseStatus(const HeaderMap& headers) {
const HeaderEntry* header = headers.Status();
uint64_t response_code;
if (!header || !absl::SimpleAtoi(headers.Status()->value().getStringView(), &response_code)) {
throw CodecClientException(":status must be specified and a valid unsigned long");
}
return response_code;
}
bool Utility::isUpgrade(const HeaderMap& headers) {
// In firefox the "Connection" request header value is "keep-alive, Upgrade",
// we should check if it contains the "Upgrade" token.
return (headers.Connection() && headers.Upgrade() &&
Envoy::StringUtil::caseFindToken(headers.Connection()->value().getStringView(), ",",
Http::Headers::get().ConnectionValues.Upgrade.c_str()));
}
bool Utility::isH2UpgradeRequest(const HeaderMap& headers) {
return headers.Method() &&
headers.Method()->value().getStringView() == Http::Headers::get().MethodValues.Connect &&
headers.Protocol() && !headers.Protocol()->value().empty();
}
bool Utility::isWebSocketUpgradeRequest(const HeaderMap& headers) {
return (isUpgrade(headers) &&
absl::EqualsIgnoreCase(headers.Upgrade()->value().getStringView(),
Http::Headers::get().UpgradeValues.WebSocket));
}
Http2Settings
Utility::parseHttp2Settings(const envoy::config::core::v3::Http2ProtocolOptions& config) {
Http2Settings ret;
ret.hpack_table_size_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
config, hpack_table_size, Http::Http2Settings::DEFAULT_HPACK_TABLE_SIZE);
ret.max_concurrent_streams_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
config, max_concurrent_streams, Http::Http2Settings::DEFAULT_MAX_CONCURRENT_STREAMS);
ret.initial_stream_window_size_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
config, initial_stream_window_size, Http::Http2Settings::DEFAULT_INITIAL_STREAM_WINDOW_SIZE);
ret.initial_connection_window_size_ =
PROTOBUF_GET_WRAPPED_OR_DEFAULT(config, initial_connection_window_size,
Http::Http2Settings::DEFAULT_INITIAL_CONNECTION_WINDOW_SIZE);
ret.max_outbound_frames_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
config, max_outbound_frames, Http::Http2Settings::DEFAULT_MAX_OUTBOUND_FRAMES);
ret.max_outbound_control_frames_ =
PROTOBUF_GET_WRAPPED_OR_DEFAULT(config, max_outbound_control_frames,
Http::Http2Settings::DEFAULT_MAX_OUTBOUND_CONTROL_FRAMES);
ret.max_consecutive_inbound_frames_with_empty_payload_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
config, max_consecutive_inbound_frames_with_empty_payload,
Http::Http2Settings::DEFAULT_MAX_CONSECUTIVE_INBOUND_FRAMES_WITH_EMPTY_PAYLOAD);
ret.max_inbound_priority_frames_per_stream_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
config, max_inbound_priority_frames_per_stream,
Http::Http2Settings::DEFAULT_MAX_INBOUND_PRIORITY_FRAMES_PER_STREAM);
ret.max_inbound_window_update_frames_per_data_frame_sent_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
config, max_inbound_window_update_frames_per_data_frame_sent,
Http::Http2Settings::DEFAULT_MAX_INBOUND_WINDOW_UPDATE_FRAMES_PER_DATA_FRAME_SENT);
ret.allow_connect_ = config.allow_connect();
ret.allow_metadata_ = config.allow_metadata();
ret.stream_error_on_invalid_http_messaging_ = config.stream_error_on_invalid_http_messaging();
return ret;
}
Http1Settings
Utility::parseHttp1Settings(const envoy::config::core::v3::Http1ProtocolOptions& config) {
Http1Settings ret;
ret.allow_absolute_url_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(config, allow_absolute_url, true);
ret.accept_http_10_ = config.accept_http_10();
ret.default_host_for_http_10_ = config.default_host_for_http_10();
ret.enable_trailers_ = config.enable_trailers();
if (config.header_key_format().has_proper_case_words()) {
ret.header_key_format_ = Http1Settings::HeaderKeyFormat::ProperCase;
} else {
ret.header_key_format_ = Http1Settings::HeaderKeyFormat::Default;
}
return ret;
}
void Utility::sendLocalReply(bool is_grpc, StreamDecoderFilterCallbacks& callbacks,
const bool& is_reset, Code response_code, absl::string_view body_text,
const absl::optional<Grpc::Status::GrpcStatus> grpc_status,
bool is_head_request) {
sendLocalReply(
is_grpc,
[&](HeaderMapPtr&& headers, bool end_stream) -> void {
callbacks.encodeHeaders(std::move(headers), end_stream);
},
[&](Buffer::Instance& data, bool end_stream) -> void {
callbacks.encodeData(data, end_stream);
},
is_reset, response_code, body_text, grpc_status, is_head_request);
}
void Utility::sendLocalReply(
bool is_grpc, std::function<void(HeaderMapPtr&& headers, bool end_stream)> encode_headers,
std::function<void(Buffer::Instance& data, bool end_stream)> encode_data, const bool& is_reset,
Code response_code, absl::string_view body_text,
const absl::optional<Grpc::Status::GrpcStatus> grpc_status, bool is_head_request) {
// encode_headers() may reset the stream, so the stream must not be reset before calling it.
ASSERT(!is_reset);
// Respond with a gRPC trailers-only response if the request is gRPC
if (is_grpc) {
HeaderMapPtr response_headers{new HeaderMapImpl{
{Headers::get().Status, std::to_string(enumToInt(Code::OK))},
{Headers::get().ContentType, Headers::get().ContentTypeValues.Grpc},
{Headers::get().GrpcStatus,
std::to_string(
enumToInt(grpc_status ? grpc_status.value()
: Grpc::Utility::httpToGrpcStatus(enumToInt(response_code))))}}};
if (!body_text.empty() && !is_head_request) {
// TODO(dio): Probably it is worth to consider caching the encoded message based on gRPC
// status.
response_headers->setGrpcMessage(PercentEncoding::encode(body_text));
}
encode_headers(std::move(response_headers), true); // Trailers only response
return;
}
HeaderMapPtr response_headers{
new HeaderMapImpl{{Headers::get().Status, std::to_string(enumToInt(response_code))}}};
if (!body_text.empty()) {
response_headers->setContentLength(body_text.size());
response_headers->setReferenceContentType(Headers::get().ContentTypeValues.Text);
}
if (is_head_request) {
encode_headers(std::move(response_headers), true);
return;
}
encode_headers(std::move(response_headers), body_text.empty());
// encode_headers()) may have changed the referenced is_reset so we need to test it
if (!body_text.empty() && !is_reset) {
Buffer::OwnedImpl buffer(body_text);
encode_data(buffer, true);
}
}
Utility::GetLastAddressFromXffInfo
Utility::getLastAddressFromXFF(const Http::HeaderMap& request_headers, uint32_t num_to_skip) {
const auto xff_header = request_headers.ForwardedFor();
if (xff_header == nullptr) {
return {nullptr, false};
}
absl::string_view xff_string(xff_header->value().getStringView());
static const std::string separator(",");
// Ignore the last num_to_skip addresses at the end of XFF.
for (uint32_t i = 0; i < num_to_skip; i++) {
const std::string::size_type last_comma = xff_string.rfind(separator);
if (last_comma == std::string::npos) {
return {nullptr, false};
}
xff_string = xff_string.substr(0, last_comma);
}
// The text after the last remaining comma, or the entirety of the string if there
// is no comma, is the requested IP address.
const std::string::size_type last_comma = xff_string.rfind(separator);
if (last_comma != std::string::npos && last_comma + separator.size() < xff_string.size()) {
xff_string = xff_string.substr(last_comma + separator.size());
}
// Ignore the whitespace, since they are allowed in HTTP lists (see RFC7239#section-7.1).
xff_string = StringUtil::ltrim(xff_string);
xff_string = StringUtil::rtrim(xff_string);
try {
// This technically requires a copy because inet_pton takes a null terminated string. In
// practice, we are working with a view at the end of the owning string, and could pass the
// raw pointer.
// TODO(mattklein123) PERF: Avoid the copy here.
return {
Network::Utility::parseInternetAddress(std::string(xff_string.data(), xff_string.size())),
last_comma == std::string::npos && num_to_skip == 0};
} catch (const EnvoyException&) {
return {nullptr, false};
}
}
bool Utility::sanitizeConnectionHeader(Http::HeaderMap& headers) {
static const size_t MAX_ALLOWED_NOMINATED_HEADERS = 10;
static const size_t MAX_ALLOWED_TE_VALUE_SIZE = 256;
// Remove any headers nominated by the Connection header. The TE header
// is sanitized and removed only if it's empty after removing unsupported values
// See https://github.com/envoyproxy/envoy/issues/8623
const auto& cv = Http::Headers::get().ConnectionValues;
const auto& connection_header_value = headers.Connection()->value();
StringUtil::CaseUnorderedSet headers_to_remove{};
std::vector<absl::string_view> connection_header_tokens =
StringUtil::splitToken(connection_header_value.getStringView(), ",", false);
// If we have 10 or more nominated headers, fail this request
if (connection_header_tokens.size() >= MAX_ALLOWED_NOMINATED_HEADERS) {
ENVOY_LOG_MISC(trace, "Too many nominated headers in request");
return false;
}
// Split the connection header and evaluate each nominated header
for (const auto& token : connection_header_tokens) {
const auto token_sv = StringUtil::trim(token);
// Build the LowerCaseString for header lookup
const LowerCaseString lcs_header_to_remove{std::string(token_sv)};
// If the Connection token value is not a nominated header, ignore it here since
// the connection header is removed elsewhere when the H1 request is upgraded to H2
if ((lcs_header_to_remove.get() == cv.Close) ||
(lcs_header_to_remove.get() == cv.Http2Settings) ||
(lcs_header_to_remove.get() == cv.KeepAlive) ||
(lcs_header_to_remove.get() == cv.Upgrade)) {
continue;
}
// By default we will remove any nominated headers
bool keep_header = false;
// Determine whether the nominated header contains invalid values
const HeaderEntry* nominated_header = NULL;
if (lcs_header_to_remove == Http::Headers::get().Connection) {
// Remove the connection header from the nominated tokens if it's self nominated
// The connection header itself is *not removed*
ENVOY_LOG_MISC(trace, "Skipping self nominated header [{}]", token_sv);
keep_header = true;
headers_to_remove.emplace(token_sv);
} else if ((lcs_header_to_remove == Http::Headers::get().ForwardedFor) ||
(lcs_header_to_remove == Http::Headers::get().ForwardedHost) ||
(lcs_header_to_remove == Http::Headers::get().ForwardedProto) ||
!token_sv.find(':')) {
// An attacker could nominate an X-Forwarded* header, and its removal may mask
// the origin of the incoming request and potentially alter its handling.
// Additionally, pseudo headers should never be nominated. In both cases, we
// should fail the request.
// See: https://nathandavison.com/blog/abusing-http-hop-by-hop-request-headers
ENVOY_LOG_MISC(trace, "Invalid nomination of {} header", token_sv);
return false;
} else {
// Examine the value of all other nominated headers
nominated_header = headers.get(lcs_header_to_remove);
}
if (nominated_header) {
auto nominated_header_value_sv = nominated_header->value().getStringView();
const bool is_te_header = (lcs_header_to_remove == Http::Headers::get().TE);
// reject the request if the TE header is too large
if (is_te_header && (nominated_header_value_sv.size() >= MAX_ALLOWED_TE_VALUE_SIZE)) {
ENVOY_LOG_MISC(trace, "TE header contains a value that exceeds the allowable length");
return false;
}
if (is_te_header) {
for (const auto& header_value :
StringUtil::splitToken(nominated_header_value_sv, ",", false)) {
const absl::string_view header_sv = StringUtil::trim(header_value);
// If trailers exist in the TE value tokens, keep the header, removing any other values
// that may exist
if (StringUtil::CaseInsensitiveCompare()(header_sv,
Http::Headers::get().TEValues.Trailers)) {
keep_header = true;
break;
}
}
if (keep_header) {
headers.setTE(Http::Headers::get().TEValues.Trailers);
}
}
}
if (!keep_header) {
ENVOY_LOG_MISC(trace, "Removing nominated header [{}]", token_sv);
headers.remove(lcs_header_to_remove);
headers_to_remove.emplace(token_sv);
}
}
// Lastly remove extra nominated headers from the Connection header
if (!headers_to_remove.empty()) {
const std::string new_value = StringUtil::removeTokens(connection_header_value.getStringView(),
",", headers_to_remove, ",");
if (new_value.empty()) {
headers.removeConnection();
} else {
headers.setConnection(new_value);
}
}
return true;
}
const std::string& Utility::getProtocolString(const Protocol protocol) {
switch (protocol) {
case Protocol::Http10:
return Headers::get().ProtocolStrings.Http10String;
case Protocol::Http11:
return Headers::get().ProtocolStrings.Http11String;
case Protocol::Http2:
return Headers::get().ProtocolStrings.Http2String;
case Protocol::Http3:
return Headers::get().ProtocolStrings.Http3String;
}
NOT_REACHED_GCOVR_EXCL_LINE;
}
void Utility::extractHostPathFromUri(const absl::string_view& uri, absl::string_view& host,
absl::string_view& path) {
/**
* URI RFC: https://www.ietf.org/rfc/rfc2396.txt
*
* Example:
* uri = "https://example.com:8443/certs"
* pos: ^
* host_pos: ^
* path_pos: ^
* host = "example.com:8443"
* path = "/certs"
*/
const auto pos = uri.find("://");
// Start position of the host
const auto host_pos = (pos == std::string::npos) ? 0 : pos + 3;
// Start position of the path
const auto path_pos = uri.find("/", host_pos);
if (path_pos == std::string::npos) {
// If uri doesn't have "/", the whole string is treated as host.
host = uri.substr(host_pos);
path = "/";
} else {
host = uri.substr(host_pos, path_pos - host_pos);
path = uri.substr(path_pos);
}
}
MessagePtr Utility::prepareHeaders(const envoy::config::core::v3::HttpUri& http_uri) {
absl::string_view host, path;
extractHostPathFromUri(http_uri.uri(), host, path);
MessagePtr message(new RequestMessageImpl());
message->headers().setPath(path);
message->headers().setHost(host);
return message;
}
// TODO(jmarantz): make QueryParams a real class and put this serializer there,
// along with proper URL escaping of the name and value.
std::string Utility::queryParamsToString(const QueryParams& params) {
std::string out;
std::string delim = "?";
for (const auto& p : params) {
absl::StrAppend(&out, delim, p.first, "=", p.second);
delim = "&";
}
return out;
}
const std::string Utility::resetReasonToString(const Http::StreamResetReason reset_reason) {
switch (reset_reason) {
case Http::StreamResetReason::ConnectionFailure:
return "connection failure";
case Http::StreamResetReason::ConnectionTermination:
return "connection termination";
case Http::StreamResetReason::LocalReset:
return "local reset";
case Http::StreamResetReason::LocalRefusedStreamReset:
return "local refused stream reset";
case Http::StreamResetReason::Overflow:
return "overflow";
case Http::StreamResetReason::RemoteReset:
return "remote reset";
case Http::StreamResetReason::RemoteRefusedStreamReset:
return "remote refused stream reset";
}
NOT_REACHED_GCOVR_EXCL_LINE;
}
void Utility::transformUpgradeRequestFromH1toH2(HeaderMap& headers) {
ASSERT(Utility::isUpgrade(headers));
const HeaderString& upgrade = headers.Upgrade()->value();
headers.setReferenceMethod(Http::Headers::get().MethodValues.Connect);
headers.setProtocol(upgrade.getStringView());
headers.removeUpgrade();
headers.removeConnection();
// nghttp2 rejects upgrade requests/responses with content length, so strip
// any unnecessary content length header.
if (headers.ContentLength() != nullptr &&
headers.ContentLength()->value().getStringView() == "0") {
headers.removeContentLength();
}
}
void Utility::transformUpgradeResponseFromH1toH2(HeaderMap& headers) {
if (getResponseStatus(headers) == 101) {
headers.setStatus(200);
}
headers.removeUpgrade();
headers.removeConnection();
if (headers.ContentLength() != nullptr &&
headers.ContentLength()->value().getStringView() == "0") {
headers.removeContentLength();
}
}
void Utility::transformUpgradeRequestFromH2toH1(HeaderMap& headers) {
ASSERT(Utility::isH2UpgradeRequest(headers));
const HeaderString& protocol = headers.Protocol()->value();
headers.setReferenceMethod(Http::Headers::get().MethodValues.Get);
headers.setUpgrade(protocol.getStringView());
headers.setReferenceConnection(Http::Headers::get().ConnectionValues.Upgrade);
headers.removeProtocol();
}
void Utility::transformUpgradeResponseFromH2toH1(HeaderMap& headers, absl::string_view upgrade) {
if (getResponseStatus(headers) == 200) {
headers.setUpgrade(upgrade);
headers.setReferenceConnection(Http::Headers::get().ConnectionValues.Upgrade);
headers.setStatus(101);
}
}
const Router::RouteSpecificFilterConfig*
Utility::resolveMostSpecificPerFilterConfigGeneric(const std::string& filter_name,
const Router::RouteConstSharedPtr& route) {
const Router::RouteSpecificFilterConfig* maybe_filter_config{};
traversePerFilterConfigGeneric(
filter_name, route, [&maybe_filter_config](const Router::RouteSpecificFilterConfig& cfg) {
maybe_filter_config = &cfg;
});
return maybe_filter_config;
}
void Utility::traversePerFilterConfigGeneric(
const std::string& filter_name, const Router::RouteConstSharedPtr& route,
std::function<void(const Router::RouteSpecificFilterConfig&)> cb) {
if (!route) {
return;
}
const Router::RouteEntry* routeEntry = route->routeEntry();
if (routeEntry != nullptr) {
auto maybe_vhost_config = routeEntry->virtualHost().perFilterConfig(filter_name);
if (maybe_vhost_config != nullptr) {
cb(*maybe_vhost_config);
}
}
auto maybe_route_config = route->perFilterConfig(filter_name);
if (maybe_route_config != nullptr) {
cb(*maybe_route_config);
}
if (routeEntry != nullptr) {
auto maybe_weighted_cluster_config = routeEntry->perFilterConfig(filter_name);
if (maybe_weighted_cluster_config != nullptr) {
cb(*maybe_weighted_cluster_config);
}
}
}
std::string Utility::PercentEncoding::encode(absl::string_view value) {
for (size_t i = 0; i < value.size(); ++i) {
const char& ch = value[i];
// The escaping characters are defined in
// https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#responses.
//
// We do checking for each char in the string. If the current char is included in the defined
// escaping characters, we jump to "the slow path" (append the char [encoded or not encoded]
// to the returned string one by one) started from the current index.
if (ch < ' ' || ch >= '~' || ch == '%') {
return PercentEncoding::encode(value, i);
}
}
return std::string(value);
}
std::string Utility::PercentEncoding::encode(absl::string_view value, const size_t index) {
std::string encoded;
if (index > 0) {
absl::StrAppend(&encoded, value.substr(0, index - 1));
}
for (size_t i = index; i < value.size(); ++i) {
const char& ch = value[i];
if (ch < ' ' || ch >= '~' || ch == '%') {
// For consistency, URI producers should use uppercase hexadecimal digits for all
// percent-encodings. https://tools.ietf.org/html/rfc3986#section-2.1.
absl::StrAppend(&encoded, fmt::format("%{:02X}", ch));
} else {
encoded.push_back(ch);
}
}
return encoded;
}
std::string Utility::PercentEncoding::decode(absl::string_view encoded) {
std::string decoded;
decoded.reserve(encoded.size());
for (size_t i = 0; i < encoded.size(); ++i) {
char ch = encoded[i];
if (ch == '%' && i + 2 < encoded.size()) {
const char& hi = encoded[i + 1];
const char& lo = encoded[i + 2];
if (absl::ascii_isdigit(hi)) {
ch = hi - '0';
} else {
ch = absl::ascii_toupper(hi) - 'A' + 10;
}
ch *= 16;
if (absl::ascii_isdigit(lo)) {
ch += lo - '0';
} else {
ch += absl::ascii_toupper(lo) - 'A' + 10;
}
i += 2;
}
decoded.push_back(ch);
}
return decoded;
}
Utility::AuthorityAttributes Utility::parseAuthority(absl::string_view host) {
// First try to see if there is a port included. This also checks to see that there is not a ']'
// as the last character which is indicative of an IPv6 address without a port. This is a best
// effort attempt.
const auto colon_pos = host.rfind(':');
absl::string_view host_to_resolve = host;
absl::optional<uint16_t> port;
if (colon_pos != absl::string_view::npos && host_to_resolve.back() != ']') {
const absl::string_view string_view_host = host;
host_to_resolve = string_view_host.substr(0, colon_pos);
const auto port_str = string_view_host.substr(colon_pos + 1);
uint64_t port64;
if (port_str.empty() || !absl::SimpleAtoi(port_str, &port64) || port64 > 65535) {
// Just attempt to resolve whatever we were given. This will very likely fail.
host_to_resolve = host;
} else {
port = static_cast<uint16_t>(port64);
}
}
// Now see if this is an IP address. We need to know this because some things (such as setting
// SNI) are special cased if this is an IP address. Either way, we still go through the normal
// resolver flow. We could short-circuit the DNS resolver in this case, but the extra code to do
// so is not worth it since the DNS resolver should handle it for us.
bool is_ip_address = false;
try {
absl::string_view potential_ip_address = host_to_resolve;
// TODO(mattklein123): Optimally we would support bracket parsing in parseInternetAddress(),
// but we still need to trim the brackets to send the IPv6 address into the DNS resolver. For
// now, just do all the trimming here, but in the future we should consider whether we can
// have unified [] handling as low as possible in the stack.
if (potential_ip_address.front() == '[' && potential_ip_address.back() == ']') {
potential_ip_address.remove_prefix(1);
potential_ip_address.remove_suffix(1);
}
Network::Utility::parseInternetAddress(std::string(potential_ip_address));
is_ip_address = true;
host_to_resolve = potential_ip_address;
} catch (const EnvoyException&) {
}
return {is_ip_address, host_to_resolve, port};
}
} // namespace Http
} // namespace Envoy