Skip to content
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
12 changes: 10 additions & 2 deletions management/internals/modules/mcpapi/broker.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"golang.org/x/oauth2"

"github.com/netbirdio/netbird/management/server/activity"
nbcontext "github.com/netbirdio/netbird/management/server/context"
"github.com/netbirdio/netbird/management/server/http/middleware/bypass"
"github.com/netbirdio/netbird/management/server/types"
"github.com/netbirdio/netbird/shared/auth"
Expand Down Expand Up @@ -123,6 +124,7 @@ type Broker struct {
accounts Accounts
limiter Limiter
callbacks *ratelimit.APIRateLimiter
proxies *trustedproxy.List
http *http.Client
now func() time.Time
closeOnce sync.Once
Expand Down Expand Up @@ -156,6 +158,7 @@ func NewBroker(cfg BrokerConfig) (*Broker, error) {
if err != nil {
return nil, err
}
proxies := trustedproxy.FromPrefixes(cfg.TrustedProxies)
return &Broker{
flow: cfg.Flow,
upstream: upstreamConfig(cfg.Flow, cfg.ClientSecret),
Expand All @@ -168,12 +171,13 @@ func NewBroker(cfg BrokerConfig) (*Broker, error) {
limiter: cfg.Limiter,
http: &http.Client{Timeout: 15 * time.Second},
now: time.Now,
proxies: proxies,
callbacks: ratelimit.NewAPIRateLimiter(&ratelimit.RateLimiterConfig{
RequestsPerMinute: callbacksPerMinute,
Burst: callbackBurst,
CleanupInterval: 5 * time.Minute,
LimiterTTL: 10 * time.Minute,
TrustedProxies: trustedproxy.FromPrefixes(cfg.TrustedProxies),
TrustedProxies: proxies,
}),
}, nil
}
Expand Down Expand Up @@ -609,7 +613,11 @@ func (b *Broker) callback(w http.ResponseWriter, r *http.Request) {
return
}

identity, err := b.loginIdentity(r.Context(), q.Get("code"), login)
loginCtx := r.Context()
if clientIP := b.proxies.ResolveClientIP(r.RemoteAddr, r.Header.Get("X-Forwarded-For")); clientIP.IsValid() {
loginCtx = nbcontext.SetClientIP(loginCtx, clientIP)
}
identity, err := b.loginIdentity(loginCtx, q.Get("code"), login)
if err != nil {
log.WithContext(r.Context()).Debugf("MCP login failed: %v", err)
b.redirectError(w, r, req.RedirectURI, req.State, "access_denied", "the login could not be verified")
Expand Down
22 changes: 22 additions & 0 deletions management/internals/modules/mcpapi/broker_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"net/http"
"net/http/cookiejar"
"net/http/httptest"
"net/netip"
"net/url"
"regexp"
"strings"
Expand Down Expand Up @@ -133,6 +134,8 @@ type stubAccounts struct {
users map[string]*types.User
storeDown bool
events []storedEvent
// loginIPs are the client IPs GetUserFromUserAuth saw on its context.
loginIPs []netip.Addr
}

// storedEvent is one activity event the broker stored.
Expand All @@ -151,6 +154,11 @@ func (a *stubAccounts) GetAccountIDFromUserAuth(context.Context, auth.UserAuth)
func (a *stubAccounts) SyncUserJWTGroups(context.Context, auth.UserAuth) error { return nil }

func (a *stubAccounts) GetUserFromUserAuth(ctx context.Context, userAuth auth.UserAuth) (*types.User, error) {
if ip, ok := nbcontext.GetClientIP(ctx); ok {
a.mu.Lock()
a.loginIPs = append(a.loginIPs, ip)
a.mu.Unlock()
}
return a.GetUserByID(ctx, userAuth.UserId)
}

Expand Down Expand Up @@ -1021,3 +1029,17 @@ func TestBrokerLimitsCallbacksPerClient(t *testing.T) {
"the burst is spent, and an untrusted peer's X-Forwarded-For does not open a new budget")
assert.NotEmpty(t, env.register(clientCallback), "registration is not limited with the callback")
}

// The login goes through GetUserFromUserAuth, whose dashboard.login event records the client
// address, so the broker has to put the resolved one on the context like the API middleware.
func TestBrokerLoginCarriesClientIP(t *testing.T) {
env := newBrokerEnv(t)
clientID := env.register(clientCallback)
back := env.login(env.newRequest(clientID), false)
require.NotEmpty(t, back.Query().Get("code"))

env.accounts.mu.Lock()
defer env.accounts.mu.Unlock()
assert.Equal(t, []netip.Addr{netip.MustParseAddr("127.0.0.1")}, env.accounts.loginIPs,
"the callback's client address reaches the user lookup")
}
4 changes: 3 additions & 1 deletion management/internals/server/boot.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ import (
"github.com/netbirdio/netbird/management/server/types"
mgmtProto "github.com/netbirdio/netbird/shared/management/proto"
"github.com/netbirdio/netbird/shared/ratelimit"
"github.com/netbirdio/netbird/trustedproxy"
"github.com/netbirdio/netbird/util/crypt"
)

Expand Down Expand Up @@ -241,7 +242,8 @@ func (s *BaseServer) IDPHandler() http.Handler {
func (s *BaseServer) Router() *mux.Router {
return Create(s, func() *mux.Router {
router := mux.NewRouter()
chain := middleware.BuildMiddleware(s.RateLimiter(), s.AuthManager(), s.AccountManager(), s.Metrics())
chain := middleware.BuildMiddleware(s.RateLimiter(), s.AuthManager(), s.AccountManager(), s.Metrics(),
trustedproxy.FromPrefixes(s.Config.ReverseProxy.TrustedHTTPProxies))
if broker := s.MCPBroker(); broker != nil {
router.Use(broker.ChallengeMiddleware())
// BuildMiddleware ends with the auth middleware. The MCP server tests fail if that
Expand Down
3 changes: 3 additions & 0 deletions management/internals/server/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,9 @@ func (s *BaseServer) Stop() error {
_ = s.certListener.Close()
}
s.ManagementGRPCServer().StartDraining()
if drainer, ok := s.AccountManager().(interface{ StartDraining() }); ok {
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
Resolved
drainer.StartDraining()
}
s.stopGRPCServer()
deadline, _ := ctx.Deadline()
releaseCtx, cancelRelease := context.WithDeadline(ctx, deadline.Add(-shutdownCloseReserve))
Expand Down
7 changes: 7 additions & 0 deletions management/server/account.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"slices"
"strings"
"sync"
"sync/atomic"
"time"

cacheStore "github.com/eko/gocache/lib/v4/store"
Expand Down Expand Up @@ -117,6 +118,11 @@ type DefaultAccountManager struct {

deletionHooksMu sync.RWMutex
deletionHooks []account.DeletionHook

// sessionEventsFrom is when peer session events start being recorded, set once at
// construction and read-only afterwards. draining is set when shutdown begins.
sessionEventsFrom time.Time
draining atomic.Bool
}

var _ account.Manager = (*DefaultAccountManager)(nil)
Expand Down Expand Up @@ -258,6 +264,7 @@ func BuildManager(
permissionsManager: permissionsManager,
disableDefaultPolicy: disableDefaultPolicy,
peerLiveness: peerLiveness,
sessionEventsFrom: start.Add(peerSessionEventsStartupGrace()),
}

am.certChallenges = newCertChallengeRefresher(am.refreshCertificateChallenges)
Expand Down
7 changes: 7 additions & 0 deletions management/server/activity/codes.go
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,11 @@ const (
// MCPSessionRevokedOnTokenReuse indicates that an MCP session was revoked because a refresh token or an authorization code was used twice
MCPSessionRevokedOnTokenReuse Activity = 148

// PeerConnected indicates that a peer opened its sync stream and is now connected
PeerConnected Activity = 149
// PeerDisconnected indicates that a peer's sync stream ended and the peer is now disconnected
PeerDisconnected Activity = 150

AccountDeleted Activity = 99999
)

Expand Down Expand Up @@ -489,6 +494,8 @@ var activityMap = map[Activity]Code{
MCPClientSignedIn: {"MCP client signed in", "mcp.session.start"},
MCPClientSignedOut: {"MCP client signed out", "mcp.session.revoke"},
MCPSessionRevokedOnTokenReuse: {"MCP session revoked after token reuse", "mcp.session.replay"},
PeerConnected: {"Peer connected", "peer.connect"},
PeerDisconnected: {"Peer disconnected", "peer.disconnect"},
}

// StringCode returns a string code of the activity
Expand Down
14 changes: 14 additions & 0 deletions management/server/context/keys.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package context

import (
"context"
"net/netip"

nbcontext "github.com/netbirdio/netbird/shared/context"
)
Expand All @@ -26,3 +27,16 @@ func WithRole(ctx context.Context, role string) context.Context {
//nolint
return context.WithValue(ctx, RoleKey, role)
}

type clientIPKey struct{}

// SetClientIP returns a new context carrying the resolved client IP of the request.
func SetClientIP(ctx context.Context, ip netip.Addr) context.Context {
return context.WithValue(ctx, clientIPKey{}, ip)
}

// GetClientIP returns the client IP stored in ctx, or false if none is set or it is invalid.
func GetClientIP(ctx context.Context) (netip.Addr, bool) {
ip, ok := ctx.Value(clientIPKey{}).(netip.Addr)
return ip, ok && ip.IsValid()
}
7 changes: 7 additions & 0 deletions management/server/http/middleware/auth_middleware.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"github.com/netbirdio/netbird/shared/management/http/util"
"github.com/netbirdio/netbird/shared/management/status"
"github.com/netbirdio/netbird/shared/ratelimit"
"github.com/netbirdio/netbird/trustedproxy"
)

type EnsureAccountFunc func(ctx context.Context, userAuth auth.UserAuth) (string, string, error)
Expand All @@ -34,6 +35,7 @@ type AuthMiddleware struct {
syncUserJWTGroups SyncUserJWTGroupsFunc
rateLimiter *ratelimit.APIRateLimiter
patUsageTracker *PATUsageTracker
trustedProxies *trustedproxy.List
}

// NewAuthMiddleware instance constructor
Expand All @@ -44,6 +46,7 @@ func NewAuthMiddleware(
getUserFromUserAuth GetUserFromUserAuthFunc,
rateLimiter *ratelimit.APIRateLimiter,
meter metric.Meter,
trustedProxies *trustedproxy.List,
) *AuthMiddleware {
var patUsageTracker *PATUsageTracker
if meter != nil {
Expand All @@ -61,6 +64,7 @@ func NewAuthMiddleware(
getUserFromUserAuth: getUserFromUserAuth,
rateLimiter: rateLimiter,
patUsageTracker: patUsageTracker,
trustedProxies: trustedProxies,
}
}

Expand Down Expand Up @@ -116,6 +120,9 @@ func (m *AuthMiddleware) checkJWTFromRequest(r *http.Request, authHeaderParts []
}

ctx := r.Context()
if clientIP := m.trustedProxies.ResolveClientIP(r.RemoteAddr, r.Header.Get("X-Forwarded-For")); clientIP.IsValid() {
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
Resolved
ctx = nbcontext.SetClientIP(ctx, clientIP)
}

userAuth, validatedToken, err := m.authManager.ValidateAndParseToken(ctx, token)
if err != nil {
Expand Down
80 changes: 80 additions & 0 deletions management/server/http/middleware/auth_middleware_clientip_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package middleware

import (
"context"
"net/http"
"net/http/httptest"
"net/netip"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/netbirdio/netbird/management/server/auth"
nbcontext "github.com/netbirdio/netbird/management/server/context"
"github.com/netbirdio/netbird/management/server/types"
nbauth "github.com/netbirdio/netbird/shared/auth"
"github.com/netbirdio/netbird/shared/ratelimit"
"github.com/netbirdio/netbird/trustedproxy"
)

func TestAuthMiddleware_ClientIPOnContext(t *testing.T) {
trusted := trustedproxy.FromPrefixes([]netip.Prefix{netip.MustParsePrefix("10.0.0.0/8")})

tests := []struct {
name string
proxies *trustedproxy.List
remoteAddr string
xff string
want string
}{
{name: "direct connection", remoteAddr: "198.51.100.7:4242", want: "198.51.100.7"},
{name: "forwarded header ignored without trusted proxies", remoteAddr: "198.51.100.7:4242", xff: "203.0.113.9", want: "198.51.100.7"},
{name: "forwarded header ignored from untrusted peer", proxies: trusted, remoteAddr: "198.51.100.7:4242", xff: "203.0.113.9", want: "198.51.100.7"},
{name: "forwarded header honoured from trusted proxy", proxies: trusted, remoteAddr: "10.1.2.3:4242", xff: "203.0.113.9, 10.9.9.9", want: "203.0.113.9"},
{name: "v4-mapped remote address is unmapped", remoteAddr: "[::ffff:198.51.100.7]:4242", want: "198.51.100.7"},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
var seen netip.Addr
var found bool

mockAuth := &auth.MockManager{
ValidateAndParseTokenFunc: mockValidateAndParseToken,
EnsureUserAccessByJWTGroupsFunc: mockEnsureUserAccessByJWTGroups,
}
limiter := ratelimit.NewAPIRateLimiter(nil)
limiter.SetEnabled(false)

authMiddleware := NewAuthMiddleware(
mockAuth,
func(ctx context.Context, userAuth nbauth.UserAuth) (string, string, error) {
return userAuth.AccountId, userAuth.UserId, nil
},
func(ctx context.Context, userAuth nbauth.UserAuth) error { return nil },
func(ctx context.Context, userAuth nbauth.UserAuth) (*types.User, error) {
seen, found = nbcontext.GetClientIP(ctx)
return &types.User{}, nil
},
limiter,
nil,
tc.proxies,
)

req := httptest.NewRequest("GET", "http://testing/test", nil)
req.RemoteAddr = tc.remoteAddr
if tc.xff != "" {
req.Header.Set("X-Forwarded-For", tc.xff)
}
req.Header.Set("Authorization", "Bearer "+JWT)
rec := httptest.NewRecorder()

authMiddleware.Handler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})).ServeHTTP(rec, req)

require.Equal(t, http.StatusOK, rec.Code)
require.True(t, found, "client IP should be on the context passed to getUserFromUserAuth")
assert.Equal(t, tc.want, seen.String())
})
}
}
Loading
Loading