[config{grpc,http}] Add warning when using unspecified address #6267
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportBase: 92.06% // Head: 91.76% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #6267 +/- ##
==========================================
- Coverage 92.06% 91.76% -0.30%
==========================================
Files 219 236 +17
Lines 13242 13476 +234
==========================================
+ Hits 12191 12366 +175
- Misses 828 880 +52
- Partials 223 230 +7
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
codeboten
reviewed
Oct 17, 2022
Co-authored-by: Alex Boten <[email protected]>
codeboten
reviewed
Oct 19, 2022
codeboten
approved these changes
Oct 20, 2022
bogdandrutu
reviewed
Oct 22, 2022
codeboten
approved these changes
Oct 24, 2022
bogdandrutu
approved these changes
Oct 24, 2022
config/configgrpc/configgrpc.go
Outdated
Comment on lines
279
to
291
| case "tcp", "tcp4", "tcp6", "udp", "udp4", "udp6": | ||
| host, _, err := net.SplitHostPort(gss.NetAddr.Endpoint) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse endpoint: %w", err) | ||
| } | ||
|
|
||
| if ip := net.ParseIP(host); ip != nil && ip.IsUnspecified() { | ||
| settings.Logger.Warn( | ||
| "Using the 0.0.0.0 address exposes this server to every network interface, which may facilitate Denial of Service attacks", | ||
| zap.String( | ||
| "documentation", | ||
| "https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md#safeguards-against-denial-of-service-attacks", | ||
| ), |
There was a problem hiding this comment.
Last comment, I promise :))
Can we actually have a Validate() error on confignet.NetAddr and confignet.TCPAddr. That way you can share this code.
There was a problem hiding this comment.
Hard probably to have the warning about "0.0.0.0" (since the Validate will not have access to the logger) but that can be duplicate or a standalone helper in the confignet package.
Even better the helper can be in config/internal
There was a problem hiding this comment.
I created a WarnOnUnspecifiedHost helper on config/internal. Does that look good?
bogdandrutu
approved these changes
Oct 25, 2022
codeboten
pushed a commit
to codeboten/opentelemetry-collector
that referenced
this pull request
Oct 25, 2022
mx-psi
added a commit
to mx-psi/opentelemetry-collector
that referenced
this pull request
Oct 27, 2022
…telemetry#6267) * [config/config{grpc,http}] Add warning when using a 0.0.0.0 endpoint * Add warning when using unspecified address * Add changelog entry * Fix tests * Fix HTTP tests * Apply suggestions from code review Co-authored-by: Alex Boten <[email protected]> * Use IsUnspecified method * no else after return * Move shared code to internal Co-authored-by: Alex Boten <[email protected]> (cherry picked from commit 396964d)
codeboten
added a commit
that referenced
this pull request
Nov 3, 2022
…ess (#6421) Unrevert #6267 and make it so that we never error out. Co-authored-by: Alex Boten <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Add warning when using
0.0.0.0address on an HTTP or gRPC server.Link to tracking Issue: Fixes #6151