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.

Sign up for GitHub

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

listener: add support for multiple protocol sniffers. #3260

Merged
merged 1 commit into from
May 2, 2018
Merged

listener: add support for multiple protocol sniffers. #3260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions source/extensions/filters/listener/tls_inspector/tls_inspector.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,6 @@ void Filter::parseClientHello(const void* data, size_t len) {
cb_->socket().setDetectedTransportProtocol(TransportSockets::TransportSocketNames::get().SSL);
} else {
config_->stats().tls_not_found_.inc();
cb_->socket().setDetectedTransportProtocol(
TransportSockets::TransportSocketNames::get().RAW_BUFFER);
}
done(true);
break;
Expand Down
1 change: 1 addition & 0 deletions source/server/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ envoy_cc_library(
"//source/common/common:linked_object",
"//source/common/common:non_copyable",
"//source/common/network:connection_lib",
"//source/extensions/transport_sockets:well_known_names",
],
)

Expand Down
7 changes: 7 additions & 0 deletions source/server/connection_handler_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
#include "common/network/connection_impl.h"
#include "common/network/utility.h"

#include "extensions/transport_sockets/well_known_names.h"

namespace Envoy {
namespace Server {

Expand Down Expand Up @@ -148,6 +150,11 @@ void ConnectionHandlerImpl::ActiveSocket::continueFilterChain(bool success) {
// prevent further redirection.
new_listener->onAccept(std::move(socket_), false);
} else {
// Set default transport protocol if none of the listener filters did it.
if (socket_->detectedTransportProtocol().empty()) {
socket_->setDetectedTransportProtocol(
Copy link
Member

Choose a reason for hiding this comment

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

Should we at least add an ASSERT inside the implementation of setDetectedTransportProtocol that it's not set multiple times?

Copy link
Contributor

Choose a reason for hiding this comment

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

Depending on what filters are installed and what they're trying to sniff, I could see it being possible for two heuristics to both return true. I'd say allow it, and maybe have a stat for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've been going back and forth on this, really.

I expect that sooner or later we'll have multiple transport sockets implementing the same transport protocol (e.g. we could have builtin BoringSSL implementation and another implementation with HSM integration, both using "tls" transport protocol). In theory, single TLS Inspector is all that's needed, but I expect we're going to see "sniffer + transport socket" combos, once the ecosystem of custom extensions starts growing up.

Copy link
Member

Choose a reason for hiding this comment

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

That makes sense, I just wonder if we should add the ASSERT for now for sanity. We can always remove it later. I don't have a strong opinion either way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's skip it -ASSERT() on 2nd setDetectedTransportProtocol() might result in hard to debug crashes, is going to be removed at some point anyway, and it might prevent people from deploying custom and/or private sniffers.

Extensions::TransportSockets::TransportSocketNames::get().RAW_BUFFER);
}
// Create a new connection on this listener.
listener_.newConnection(std::move(socket_));
}
Expand Down
9 changes: 8 additions & 1 deletion test/extensions/filters/listener/tls_inspector/tls_inspector_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ TEST_F(TlsInspectorTest, SniRegistered) {
EXPECT_CALL(socket_, setDetectedTransportProtocol(absl::string_view("ssl")));
EXPECT_CALL(cb_, continueFilterChain(true));
file_event_callback_(Event::FileReadyType::Read);
EXPECT_EQ(1, cfg_->stats().tls_found_.value());
EXPECT_EQ(1, cfg_->stats().sni_found_.value());
}

// Test with the ClientHello spread over multiple socket reads.
Expand Down Expand Up @@ -138,6 +140,8 @@ TEST_F(TlsInspectorTest, MultipleReads) {
while (!got_continue) {
file_event_callback_(Event::FileReadyType::Read);
}
EXPECT_EQ(1, cfg_->stats().tls_found_.value());
EXPECT_EQ(1, cfg_->stats().sni_found_.value());
}

// Test that the filter correctly handles a ClientHello with no SNI present
Expand All @@ -154,6 +158,8 @@ TEST_F(TlsInspectorTest, NoSni) {
EXPECT_CALL(socket_, setDetectedTransportProtocol(absl::string_view("ssl")));
EXPECT_CALL(cb_, continueFilterChain(true));
file_event_callback_(Event::FileReadyType::Read);
EXPECT_EQ(1, cfg_->stats().tls_found_.value());
EXPECT_EQ(1, cfg_->stats().sni_not_found_.value());
}

// Test that the filter fails if the ClientHello is larger than the
Expand All @@ -172,6 +178,7 @@ TEST_F(TlsInspectorTest, ClientHelloTooBig) {
}));
EXPECT_CALL(cb_, continueFilterChain(false));
file_event_callback_(Event::FileReadyType::Read);
EXPECT_EQ(1, cfg_->stats().client_hello_too_large_.value());
}

// Test that the filter fails on non-SSL data
Expand All @@ -188,9 +195,9 @@ TEST_F(TlsInspectorTest, NotSsl) {
memcpy(buffer, data.data(), data.size());
return data.size();
}));
EXPECT_CALL(socket_, setDetectedTransportProtocol(absl::string_view("raw_buffer")));
EXPECT_CALL(cb_, continueFilterChain(true));
file_event_callback_(Event::FileReadyType::Read);
EXPECT_EQ(1, cfg_->stats().tls_not_found_.value());
}

} // namespace TlsInspector
Expand Down
61 changes: 61 additions & 0 deletions test/server/connection_handler_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,5 +445,66 @@ TEST_F(ConnectionHandlerTest, WildcardListenerWithNoOriginalDst) {
EXPECT_CALL(*listener1, onDestroy());
}

TEST_F(ConnectionHandlerTest, TransportProtocolDefault) {
TestListener* test_listener = addListener(1, true, false, "test_listener");
Network::MockListener* listener = new Network::MockListener();
Network::ListenerCallbacks* listener_callbacks;
EXPECT_CALL(dispatcher_, createListener_(_, _, _, false))
.WillOnce(Invoke(
[&](Network::Socket&, Network::ListenerCallbacks& cb, bool, bool) -> Network::Listener* {
listener_callbacks = &cb;
return listener;
}));
EXPECT_CALL(test_listener->socket_, localAddress());
handler_->addListener(*test_listener);

Network::MockConnectionSocket* accepted_socket = new NiceMock<Network::MockConnectionSocket>();
EXPECT_CALL(*accepted_socket, detectedTransportProtocol())
.WillOnce(Return(absl::string_view("")));
EXPECT_CALL(*accepted_socket, setDetectedTransportProtocol(absl::string_view("raw_buffer")));
EXPECT_CALL(factory_, createNetworkFilterChain(_)).WillOnce(Return(true));
Network::MockConnection* connection = new NiceMock<Network::MockConnection>();
EXPECT_CALL(dispatcher_, createServerConnection_(_, _)).WillOnce(Return(connection));
listener_callbacks->onAccept(Network::ConnectionSocketPtr{accepted_socket}, true);

EXPECT_CALL(*listener, onDestroy());
}

TEST_F(ConnectionHandlerTest, TransportProtocolCustom) {
TestListener* test_listener = addListener(1, true, false, "test_listener");
Network::MockListener* listener = new Network::MockListener();
Network::ListenerCallbacks* listener_callbacks;
EXPECT_CALL(dispatcher_, createListener_(_, _, _, false))
.WillOnce(Invoke(
[&](Network::Socket&, Network::ListenerCallbacks& cb, bool, bool) -> Network::Listener* {
listener_callbacks = &cb;
return listener;
}));
EXPECT_CALL(test_listener->socket_, localAddress());
handler_->addListener(*test_listener);

Network::MockListenerFilter* test_filter = new Network::MockListenerFilter();
EXPECT_CALL(factory_, createListenerFilterChain(_))
.WillRepeatedly(Invoke([&](Network::ListenerFilterManager& manager) -> bool {
manager.addAcceptFilter(Network::ListenerFilterPtr{test_filter});
return true;
}));
absl::string_view dummy = "dummy";
EXPECT_CALL(*test_filter, onAccept(_))
.WillOnce(Invoke([&](Network::ListenerFilterCallbacks& cb) -> Network::FilterStatus {
cb.socket().setDetectedTransportProtocol(dummy);
return Network::FilterStatus::Continue;
}));
Network::MockConnectionSocket* accepted_socket = new NiceMock<Network::MockConnectionSocket>();
EXPECT_CALL(*accepted_socket, setDetectedTransportProtocol(dummy));
EXPECT_CALL(*accepted_socket, detectedTransportProtocol()).WillOnce(Return(dummy));
EXPECT_CALL(factory_, createNetworkFilterChain(_)).WillOnce(Return(true));
Network::MockConnection* connection = new NiceMock<Network::MockConnection>();
EXPECT_CALL(dispatcher_, createServerConnection_(_, _)).WillOnce(Return(connection));
listener_callbacks->onAccept(Network::ConnectionSocketPtr{accepted_socket}, true);

EXPECT_CALL(*listener, onDestroy());
}

} // namespace Server
} // namespace Envoy