kv/memberlist: fix incorrect TCP transport host parsing #396
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
kevinburkesegment
force-pushed
the
tests-0000
branch
2 times, most recently
from
8c6da91
to
e324871
Compare
| for { | ||
| select { | ||
| case <-start: | ||
| start = nil | ||
|
|
||
| // let's join the first member | ||
| if portToConnect > 0 { | ||
| _, err := kv.kv.JoinMembers([]string{fmt.Sprintf("127.0.0.1:%d", portToConnect)}) | ||
| _, err := kv.kv.JoinMembers([]string{localhostIP.String() + fmt.Sprintf(":%d", portToConnect)}) |
There was a problem hiding this comment.
Likely going to be a conflict between this and the "join host port" PR, I will resolve once that is merged.
kevinburkesegment
force-pushed
the
tests-0000
branch
from
e324871
to
75e44ac
Compare
charleskorn
reviewed
Oct 10, 2023
Previously, if you passed "localhost" as the bind address for a TCPTransport, we would attempt to parse this as an IP address, fail, and then begin listening on 0.0.0.0. This is a security issue since 0.0.0.0 binds to all interfaces, including public ones, while "localhost" is a shortcut for an IP address that is typically is only accessible from the local machine, not the wider Internet. Fix this by returning an error if you attempt to pass a BindAddr to TCPTransport that is not actually an IP address. Also, fix the tests to resolve "localhost" to an IP address before proceeding - typically, but not always, this is 127.0.0.1, which is why we try to parse the loopback address instead of hardcoding it. I can confirm that on a Mac, with this patch applied I no longer get dialog boxes warning me that the tests are attempting to listen on 0.0.0.0. Updates grafana#381.
kevinburkesegment
force-pushed
the
tests-0000
branch
from
75e44ac
to
a684960
Compare
Co-authored-by: Charles Korn <charleskorn@users.noreply.github.com>
charleskorn
reviewed
Oct 10, 2023
kv/memberlist/tcp_transport_test.go
Outdated
Comment on lines
102
to
108
| if err == nil { | ||
| t.Fatal("expected non-nil err, got nil") | ||
| } | ||
| want := `could not parse bind addr "localhost" as IP address` | ||
| if err.Error() != want { | ||
| t.Fatalf("NewTCPTransport with non-IP address BindAddr: got %v, want %v", err, want) | ||
| } |
There was a problem hiding this comment.
We use the require package in other tests to make assertions like these.
charleskorn
reviewed
Oct 10, 2023
kv/memberlist/tcp_transport_test.go
Outdated
Comment on lines
102
to
103
| require.Error(t, err) | ||
| require.Equal(t, err.Error(), `could not parse bind addr "localhost" as IP address`) |
There was a problem hiding this comment.
You should be able to simplify this even further:
Suggested change
| require.Error(t, err) | |
| require.Equal(t, err.Error(), `could not parse bind addr "localhost" as IP address`) | |
| require.EqualError(t, err, `could not parse bind addr "localhost" as IP address`) |
charleskorn
reviewed
Oct 11, 2023
charleskorn
approved these changes
Oct 12, 2023
|
Thanks @kevinburkesegment! |
7 tasks
ying-jeanne
pushed a commit
that referenced
this pull request
Nov 2, 2023
* kv/memberlist: fix incorrect TCP transport host parsing Previously, if you passed "localhost" as the bind address for a TCPTransport, we would attempt to parse this as an IP address, fail, and then begin listening on 0.0.0.0. This is a security issue since 0.0.0.0 binds to all interfaces, including public ones, while "localhost" is a shortcut for an IP address that is typically is only accessible from the local machine, not the wider Internet. Fix this by returning an error if you attempt to pass a BindAddr to TCPTransport that is not actually an IP address. Also, fix the tests to resolve "localhost" to an IP address before proceeding - typically, but not always, this is 127.0.0.1, which is why we try to parse the loopback address instead of hardcoding it. I can confirm that on a Mac, with this patch applied I no longer get dialog boxes warning me that the tests are attempting to listen on 0.0.0.0. Updates #381. * kv/memberlist: add test for IP address rejection * Update CHANGELOG.md Co-authored-by: Charles Korn <charleskorn@users.noreply.github.com> * fix more tests * rework sync.Once usage * use require instead of manual tests * require.EqualError * require.Error no longer necessary --------- Co-authored-by: Charles Korn <charleskorn@users.noreply.github.com>
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.
Previously, if you passed "localhost" as the bind address for a TCPTransport, we would attempt to parse this as an IP address, fail, and then begin listening on 0.0.0.0.
This is a security issue since 0.0.0.0 binds to all interfaces, including public ones, while "localhost" is a shortcut for an IP address that is typically is only accessible from the local machine, not the wider Internet. A user who intended to bind only to the loopback interface might inadvertently expose a server to the public Internet.
Fix this by returning an error if you attempt to pass a BindAddr to TCPTransport that is not actually an IP address. Also, fix the tests to resolve "localhost" to an IP address before proceeding - typically, but not always, this is 127.0.0.1, which is why we try to parse the loopback address instead of hardcoding it.
I can confirm that on a Mac, with this patch applied I no longer get dialog boxes warning me that the tests are attempting to listen on 0.0.0.0.
Updates #381.