Skip to content

listener: add support for multiple protocol sniffers.#3260

Merged
mattklein123 merged 1 commit intoenvoyproxy:masterfrom
PiotrSikora:multiple_protocol_sniffers
May 2, 2018
Merged

listener: add support for multiple protocol sniffers.#3260
mattklein123 merged 1 commit intoenvoyproxy:masterfrom
PiotrSikora:multiple_protocol_sniffers

Conversation

@PiotrSikora
Copy link
Copy Markdown
Contributor

Previously, TLS Inspector set detected transport protocol to either "tls"
or "raw_buffer", however, such approach didn't allow multiple sniffers to
be installed at the same time, since they would overwrite results from
each other.

After this change, protocol sniffers will set detected transport protocol
only when they find the one they know about it, and listener will set the
default one ("raw_buffer") in case no known transport protocol was found.

Previously, TLS Inspector set detected transport protocol to either "tls"
or "raw_buffer", however, such approach didn't allow multiple sniffers to
be installed at the same time, since they would overwrite results from
each other.

After this change, protocol sniffers will set detected transport protocol
only when they find the one they know about it, and listener will set the
default one ("raw_buffer") in case no known transport protocol was found.

Signed-off-by: Piotr Sikora <piotrsikora@google.com>
@PiotrSikora
Copy link
Copy Markdown
Contributor Author

cc @ggreenway @lizan

Copy link
Copy Markdown
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

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

LGTM, small comment.

} else {
// Set default transport protocol if none of the listener filters did it.
if (socket_->detectedTransportProtocol().empty()) {
socket_->setDetectedTransportProtocol(
Copy link
Copy Markdown
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
Copy Markdown
Member

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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.

@mattklein123 mattklein123 merged commit eaff271 into envoyproxy:master May 2, 2018
ramaraochavali pushed a commit to ramaraochavali/envoy that referenced this pull request May 3, 2018
Previously, TLS Inspector set detected transport protocol to either "tls"
or "raw_buffer", however, such approach didn't allow multiple sniffers to
be installed at the same time, since they would overwrite results from
each other.

After this change, protocol sniffers will set detected transport protocol
only when they find the one they know about it, and listener will set the
default one ("raw_buffer") in case no known transport protocol was found.

Signed-off-by: Piotr Sikora <piotrsikora@google.com>
Signed-off-by: Rama <rama.rao@salesforce.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants