Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proxy protocol: set downstreamRemoteAddress on StreamInfo #14131

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/root/version_history/current.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Bug Fixes
* http: reject requests with missing required headers after filter chain processing.
* http: sending CONNECT_ERROR for HTTP/2 where appropriate during CONNECT requests.
* proxy_proto: fixed a bug where the wrong downstream address got sent to upstream connections.
* proxy_proto: fixed a bug where network filters would not have the correct downstreamRemoteAddress() when accessed from the StreamInfo. This could result in incorrect enforcement of RBAC rules in the RBAC network filter (but not in the RBAC HTTP filter), or incorrect access log addresses from tcp_proxy.
* tls: fix detection of the upstream connection close event.
* tls: fix read resumption after triggering buffer high-watermark and all remaining request/response bytes are stored in the SSL connection's internal buffers.
* watchdog: touch the watchdog before most event loop operations to avoid misses when handling bursts of callbacks.
Expand Down
5 changes: 3 additions & 2 deletions source/server/connection_handler_impl.cc
Original file line number Diff line number Diff line change
Expand Up @@ -460,9 +460,10 @@ void ConnectionHandlerImpl::ActiveTcpListener::resumeListening() {

void ConnectionHandlerImpl::ActiveTcpListener::newConnection(
Network::ConnectionSocketPtr&& socket, std::unique_ptr<StreamInfo::StreamInfo> stream_info) {
// Refresh local address in case it was restored by a listener filter like the original_dst
// filter.
// Refresh addresses in case they are modified by listener filters, such as proxy protocol or
// original_dst.
stream_info->setDownstreamLocalAddress(socket->localAddress());
stream_info->setDownstreamRemoteAddress(socket->remoteAddress());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you cut a follow up ticket about auditing this code elsewhere? It think there may be code in the HCM we don't or shouldn't need assuming stream info chaining is working correctly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


// Find matching filter chain.
const auto filter_chain = config_->filterChainManager().findFilterChain(*socket);
Expand Down
4 changes: 4 additions & 0 deletions test/integration/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -1069,10 +1069,14 @@ envoy_cc_test(
":http_integration_lib",
"//source/common/buffer:buffer_lib",
"//source/common/http:codec_client_lib",
"//source/extensions/access_loggers/file:config",
"//source/extensions/filters/listener/proxy_protocol:config",
"//source/extensions/filters/network/tcp_proxy:config",
"//test/test_common:utility_lib",
"@envoy_api//envoy/config/bootstrap/v3:pkg_cc_proto",
"@envoy_api//envoy/config/cluster/v3:pkg_cc_proto",
"@envoy_api//envoy/extensions/access_loggers/file/v3:pkg_cc_proto",
"@envoy_api//envoy/extensions/filters/network/tcp_proxy/v3:pkg_cc_proto",
],
)

Expand Down
75 changes: 75 additions & 0 deletions test/integration/proxy_proto_integration_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

#include "envoy/config/bootstrap/v3/bootstrap.pb.h"
#include "envoy/config/cluster/v3/cluster.pb.h"
#include "envoy/extensions/access_loggers/file/v3/file.pb.h"
#include "envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.pb.h"

#include "common/buffer/buffer_impl.h"

Expand All @@ -14,6 +16,24 @@

namespace Envoy {

static void
insertProxyProtocolFilterConfigModifier(envoy::config::bootstrap::v3::Bootstrap& bootstrap) {
::envoy::extensions::filters::listener::proxy_protocol::v3::ProxyProtocol proxy_protocol;
auto rule = proxy_protocol.add_rules();
rule->set_tlv_type(0x02);
rule->mutable_on_tlv_present()->set_key("PP2TypeAuthority");

auto* listener = bootstrap.mutable_static_resources()->mutable_listeners(0);
auto* ppv_filter = listener->add_listener_filters();
ppv_filter->set_name("envoy.listener.proxy_protocol");
ppv_filter->mutable_typed_config()->PackFrom(proxy_protocol);
}

ProxyProtoIntegrationTest::ProxyProtoIntegrationTest()
: HttpIntegrationTest(Http::CodecClient::Type::HTTP1, GetParam()) {
config_helper_.addConfigModifier(insertProxyProtocolFilterConfigModifier);
}

INSTANTIATE_TEST_SUITE_P(IpVersions, ProxyProtoIntegrationTest,
testing::ValuesIn(TestEnvironment::getIpVersionsForTest()),
TestUtility::ipTestParamsToString);
Expand Down Expand Up @@ -201,4 +221,59 @@ TEST_P(ProxyProtoIntegrationTest, ClusterProvided) {
testRouterRequestAndResponseWithBody(1024, 512, false, false, &creator);
}

ProxyProtoTcpIntegrationTest::ProxyProtoTcpIntegrationTest()
: BaseIntegrationTest(GetParam(), ConfigHelper::tcpProxyConfig()) {
config_helper_.addConfigModifier(insertProxyProtocolFilterConfigModifier);
config_helper_.renameListener("tcp_proxy");
}

INSTANTIATE_TEST_SUITE_P(IpVersions, ProxyProtoTcpIntegrationTest,
testing::ValuesIn(TestEnvironment::getIpVersionsForTest()),
TestUtility::ipTestParamsToString);

// This tests that the StreamInfo contains the correct addresses.
TEST_P(ProxyProtoTcpIntegrationTest, AccessLog) {
std::string access_log_path = TestEnvironment::temporaryPath(
fmt::format("access_log{}.txt", version_ == Network::Address::IpVersion::v4 ? "v4" : "v6"));
config_helper_.addConfigModifier([&](envoy::config::bootstrap::v3::Bootstrap& bootstrap) -> void {
auto* listener = bootstrap.mutable_static_resources()->mutable_listeners(0);
auto* filter_chain = listener->mutable_filter_chains(0);
auto* config_blob = filter_chain->mutable_filters(0)->mutable_typed_config();

ASSERT_TRUE(
config_blob
->Is<API_NO_BOOST(envoy::extensions::filters::network::tcp_proxy::v3::TcpProxy)>());
auto tcp_proxy_config = MessageUtil::anyConvert<API_NO_BOOST(
envoy::extensions::filters::network::tcp_proxy::v3::TcpProxy)>(*config_blob);

auto* access_log = tcp_proxy_config.add_access_log();
access_log->set_name("accesslog");
envoy::extensions::access_loggers::file::v3::FileAccessLog access_log_config;
access_log_config.set_path(access_log_path);
access_log_config.mutable_log_format()->set_text_format(
"remote=%DOWNSTREAM_REMOTE_ADDRESS% local=%DOWNSTREAM_LOCAL_ADDRESS%");
access_log->mutable_typed_config()->PackFrom(access_log_config);
config_blob->PackFrom(tcp_proxy_config);
});
initialize();

IntegrationTcpClientPtr tcp_client = makeTcpConnection(lookupPort("tcp_proxy"));
ASSERT_TRUE(tcp_client->write("PROXY TCP4 1.2.3.4 254.254.254.254 12345 1234\r\nhello", false));

FakeRawConnectionPtr fake_upstream_connection;
ASSERT_TRUE(fake_upstreams_[0]->waitForRawConnection(fake_upstream_connection));
ASSERT_TRUE(fake_upstream_connection->waitForData(5));
ASSERT_TRUE(fake_upstream_connection->close());
tcp_client->close();
ASSERT_TRUE(fake_upstream_connection->waitForDisconnect());

std::string log_result;
// Access logs only get flushed to disk periodically, so poll until the log is non-empty
do {
log_result = api_->fileSystem().fileReadToEnd(access_log_path);
} while (log_result.empty());
Comment on lines +271 to +274
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably have some type of sleep but I guess we have similar issues in other tests where you copied this from? We can fix that some other time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that part is copy/paste. Although I think I added that originally.


EXPECT_EQ(log_result, "remote=1.2.3.4:12345 local=254.254.254.254:1234");
}

} // namespace Envoy
22 changes: 8 additions & 14 deletions test/integration/proxy_proto_integration_test.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,13 @@ namespace Envoy {
class ProxyProtoIntegrationTest : public testing::TestWithParam<Network::Address::IpVersion>,
public HttpIntegrationTest {
public:
ProxyProtoIntegrationTest() : HttpIntegrationTest(Http::CodecClient::Type::HTTP1, GetParam()) {
config_helper_.addConfigModifier(
[&](envoy::config::bootstrap::v3::Bootstrap& bootstrap) -> void {
::envoy::extensions::filters::listener::proxy_protocol::v3::ProxyProtocol proxy_protocol;
auto rule = proxy_protocol.add_rules();
rule->set_tlv_type(0x02);
rule->mutable_on_tlv_present()->set_key("PP2TypeAuthority");

auto* listener = bootstrap.mutable_static_resources()->mutable_listeners(0);
auto* ppv_filter = listener->add_listener_filters();
ppv_filter->set_name("envoy.listener.proxy_protocol");
ppv_filter->mutable_typed_config()->PackFrom(proxy_protocol);
});
}
ProxyProtoIntegrationTest();
};

class ProxyProtoTcpIntegrationTest : public testing::TestWithParam<Network::Address::IpVersion>,
public BaseIntegrationTest {
public:
ProxyProtoTcpIntegrationTest();
};

} // namespace Envoy