mirror of
https://github.com/netbirdio/netbird.git
synced 2026-07-22 00:11:29 +02:00
The WS listener unconditionally trusted X-Real-Ip/X-Real-Port headers, letting any client forge the source address the relay logs. Gate header trust behind a trusted-proxy allowlist; ignore the headers unless the immediate peer matches a configured prefix. Defaults to never trusting the headers when the allowlist is empty. ## Describe your changes ## Issue ticket number and link ## Stack <!-- branch-stack --> ### Checklist - [x] Is it a bug fix - [ ] Is a typo/documentation fix - [ ] Is a feature enhancement - [ ] It is a refactor - [ ] Created tests that fail without the change (if possible) - [ ] This change does **not** modify the public API, gRPC protocols, functionality behavior, CLI / service flags, or introduce a new feature — **OR** I have discussed it with the NetBird team beforehand (link the issue / Slack thread in the description). See [CONTRIBUTING.md](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTING.md#discuss-changes-with-the-netbird-team-first). > By submitting this pull request, you confirm that you have read and agree to the terms of the [Contributor License Agreement](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT.md). ## Documentation Select exactly one: - [ ] I added/updated documentation for this change - [x] Documentation is **not needed** for this change (explain why) ### Docs PR URL (required if "docs added" is checked) Paste the PR link from https://github.com/netbirdio/docs here: https://github.com/netbirdio/docs/pull/__ <!-- codesmith:footer --> --- <a href="https://app.blacksmith.sh/netbirdio/codesmith/netbird/pr/6833"><picture><source media="(prefers-color-scheme: dark)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v2.svg"><source media="(prefers-color-scheme: light)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-light-v2.svg"><img alt="View with Codesmith" src="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v2.svg"></picture></a> <a href="https://backend.blacksmith.sh/track/enable-autofix?expires=1787141580&installation_id=146802194&pr_number=6833&repository=netbirdio%2Fnetbird&return_to=https%3A%2F%2Fgithub.com%2Fnetbirdio%2Fnetbird%2Fpull%2F6833&signature=9cf182cc7be248e457dfdb56e8a047401276d8cc567ed8ae715ec1cc809f1b6a"><picture><source media="(prefers-color-scheme: dark)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-light.svg"><img alt="Autofix with Codesmith" src="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark.svg"></picture></a> <sup>Need help on this PR? Tag <code>/codesmith</code> with what you need. Autofix is disabled.</sup> <!-- codesmith:autofix:disabled --> <!-- /codesmith:footer --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added `--trusted-proxies` to configure a comma-separated allowlist of trusted upstream proxy IPs/CIDRs. * **Behavior Changes** * Relay WebSocket now uses `X-Real-Ip` / `X-Real-Port` only when the immediate peer is from the configured trusted set; otherwise it falls back to the direct remote address. * Proxy client IP resolution is now consistent and honors `X-Forwarded-For` only through trusted hops. * **Operational** * Invalid `--trusted-proxies` values fail fast on startup. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
217 lines
5.4 KiB
Go
217 lines
5.4 KiB
Go
package trustedproxy
|
|
|
|
import (
|
|
"net/netip"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestParse(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
raw string
|
|
want []netip.Prefix
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "empty string returns empty list",
|
|
raw: "",
|
|
want: nil,
|
|
},
|
|
{
|
|
name: "single CIDR",
|
|
raw: "10.0.0.0/8",
|
|
want: []netip.Prefix{netip.MustParsePrefix("10.0.0.0/8")},
|
|
},
|
|
{
|
|
name: "single bare IPv4",
|
|
raw: "1.2.3.4",
|
|
want: []netip.Prefix{netip.MustParsePrefix("1.2.3.4/32")},
|
|
},
|
|
{
|
|
name: "single bare IPv6",
|
|
raw: "::1",
|
|
want: []netip.Prefix{netip.MustParsePrefix("::1/128")},
|
|
},
|
|
{
|
|
name: "comma-separated CIDRs",
|
|
raw: "10.0.0.0/8, 192.168.1.0/24",
|
|
want: []netip.Prefix{
|
|
netip.MustParsePrefix("10.0.0.0/8"),
|
|
netip.MustParsePrefix("192.168.1.0/24"),
|
|
},
|
|
},
|
|
{
|
|
name: "mixed CIDRs and bare IPs",
|
|
raw: "10.0.0.0/8, 1.2.3.4, fd00::/8",
|
|
want: []netip.Prefix{
|
|
netip.MustParsePrefix("10.0.0.0/8"),
|
|
netip.MustParsePrefix("1.2.3.4/32"),
|
|
netip.MustParsePrefix("fd00::/8"),
|
|
},
|
|
},
|
|
{
|
|
name: "whitespace around entries",
|
|
raw: " 10.0.0.0/8 , 192.168.0.0/16 ",
|
|
want: []netip.Prefix{
|
|
netip.MustParsePrefix("10.0.0.0/8"),
|
|
netip.MustParsePrefix("192.168.0.0/16"),
|
|
},
|
|
},
|
|
{
|
|
name: "trailing comma produces no extra entry",
|
|
raw: "10.0.0.0/8,",
|
|
want: []netip.Prefix{netip.MustParsePrefix("10.0.0.0/8")},
|
|
},
|
|
{
|
|
name: "invalid entry",
|
|
raw: "not-an-ip",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "partially invalid",
|
|
raw: "10.0.0.0/8, garbage",
|
|
wantErr: true,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := Parse(tt.raw)
|
|
if tt.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
assert.Equal(t, tt.want, got.prefixes)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestListIsTrusted(t *testing.T) {
|
|
list, err := Parse("10.0.0.0/8, 192.168.1.0/24, fd00::/8")
|
|
require.NoError(t, err)
|
|
|
|
tests := []struct {
|
|
name string
|
|
addr string
|
|
list *List
|
|
want bool
|
|
}{
|
|
{"nil list", "10.0.0.1", nil, false},
|
|
{"empty list", "10.0.0.1", &List{}, false},
|
|
{"IP within /8 prefix", "10.1.2.3", list, true},
|
|
{"IP within /24 prefix", "192.168.1.100", list, true},
|
|
{"IP outside all prefixes", "203.0.113.50", list, false},
|
|
{"boundary IP just outside prefix", "192.168.2.1", list, false},
|
|
{"unparsable IP", "not-an-ip", list, false},
|
|
{"IPv6 in trusted range", "fd00::1", list, true},
|
|
{"IPv6 outside range", "2001:db8::1", list, false},
|
|
{"empty string", "", list, false},
|
|
{"host:port within prefix", "10.1.2.3:9999", list, true},
|
|
{"host:port outside prefix", "203.0.113.50:9999", list, false},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assert.Equal(t, tt.want, tt.list.IsTrusted(tt.addr))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestListResolveClientIP(t *testing.T) {
|
|
trusted, err := Parse("10.0.0.0/8, 172.16.0.0/12")
|
|
require.NoError(t, err)
|
|
|
|
tests := []struct {
|
|
name string
|
|
remoteAddr string
|
|
xff string
|
|
list *List
|
|
want netip.Addr
|
|
}{
|
|
{
|
|
name: "empty list returns RemoteAddr",
|
|
remoteAddr: "203.0.113.50:9999",
|
|
xff: "1.2.3.4",
|
|
list: &List{},
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "nil list returns RemoteAddr",
|
|
remoteAddr: "203.0.113.50:9999",
|
|
xff: "1.2.3.4",
|
|
list: nil,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "untrusted RemoteAddr ignores XFF",
|
|
remoteAddr: "203.0.113.50:9999",
|
|
xff: "1.2.3.4, 10.0.0.1",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "trusted RemoteAddr with single client in XFF",
|
|
remoteAddr: "10.0.0.1:5000",
|
|
xff: "203.0.113.50",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "trusted RemoteAddr walks past trusted entries in XFF",
|
|
remoteAddr: "10.0.0.1:5000",
|
|
xff: "203.0.113.50, 10.0.0.2, 172.16.0.5",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "trusted RemoteAddr with empty XFF falls back to RemoteAddr",
|
|
remoteAddr: "10.0.0.1:5000",
|
|
xff: "",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("10.0.0.1"),
|
|
},
|
|
{
|
|
name: "all XFF IPs trusted returns leftmost",
|
|
remoteAddr: "10.0.0.1:5000",
|
|
xff: "10.0.0.2, 172.16.0.1, 10.0.0.3",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("10.0.0.2"),
|
|
},
|
|
{
|
|
name: "XFF with whitespace",
|
|
remoteAddr: "10.0.0.1:5000",
|
|
xff: " 203.0.113.50 , 10.0.0.2 ",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "XFF with empty segments",
|
|
remoteAddr: "10.0.0.1:5000",
|
|
xff: "203.0.113.50,,10.0.0.2",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "multi-hop with mixed trust",
|
|
remoteAddr: "10.0.0.1:5000",
|
|
xff: "8.8.8.8, 203.0.113.50, 172.16.0.1",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
{
|
|
name: "RemoteAddr without port",
|
|
remoteAddr: "10.0.0.1",
|
|
xff: "203.0.113.50",
|
|
list: trusted,
|
|
want: netip.MustParseAddr("203.0.113.50"),
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assert.Equal(t, tt.want, tt.list.ResolveClientIP(tt.remoteAddr, tt.xff))
|
|
})
|
|
}
|
|
}
|