mirror of
https://github.com/netbirdio/netbird.git
synced 2026-04-18 08:16:39 +00:00
CLI: new expose command to publish a local port with flags for PIN, password, user groups, custom domain, name prefix and protocol (HTTP default). Management/API: create/renew/stop expose sessions (streamed status), automatic naming/domain, TTL renewals, background expiration, new management RPCs and client methods. UI/API: account settings now include peer_expose_enabled and peer_expose_groups; new activity codes for peer expose events.
302 lines
9.2 KiB
Go
302 lines
9.2 KiB
Go
package grpc
|
|
|
|
import (
|
|
"context"
|
|
"regexp"
|
|
"sync"
|
|
"time"
|
|
|
|
pb "github.com/golang/protobuf/proto" // nolint
|
|
log "github.com/sirupsen/logrus"
|
|
"golang.zx2c4.com/wireguard/wgctrl/wgtypes"
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/status"
|
|
|
|
"github.com/netbirdio/netbird/encryption"
|
|
"github.com/netbirdio/netbird/management/internals/modules/reverseproxy"
|
|
nbContext "github.com/netbirdio/netbird/management/server/context"
|
|
nbpeer "github.com/netbirdio/netbird/management/server/peer"
|
|
"github.com/netbirdio/netbird/management/server/store"
|
|
"github.com/netbirdio/netbird/shared/management/proto"
|
|
internalStatus "github.com/netbirdio/netbird/shared/management/status"
|
|
)
|
|
|
|
var pinRegexp = regexp.MustCompile(`^\d{6}$`)
|
|
|
|
const (
|
|
exposeTTL = 90 * time.Second
|
|
exposeReapInterval = 30 * time.Second
|
|
maxExposesPerPeer = 10
|
|
)
|
|
|
|
type activeExpose struct {
|
|
mu sync.Mutex
|
|
serviceID string
|
|
domain string
|
|
accountID string
|
|
peerID string
|
|
lastRenewed time.Time
|
|
}
|
|
|
|
func exposeKey(peerID, domain string) string {
|
|
return peerID + ":" + domain
|
|
}
|
|
|
|
// CreateExpose handles a peer request to create a new expose service.
|
|
func (s *Server) CreateExpose(ctx context.Context, req *proto.EncryptedMessage) (*proto.EncryptedMessage, error) {
|
|
exposeReq := &proto.ExposeServiceRequest{}
|
|
peerKey, err := s.parseRequest(ctx, req, exposeReq)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
accountID, peer, err := s.authenticateExposePeer(ctx, peerKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// nolint:staticcheck
|
|
ctx = context.WithValue(ctx, nbContext.AccountIDKey, accountID)
|
|
|
|
if exposeReq.Protocol != proto.ExposeProtocol_EXPOSE_HTTP && exposeReq.Protocol != proto.ExposeProtocol_EXPOSE_HTTPS {
|
|
return nil, status.Errorf(codes.InvalidArgument, "only HTTP or HTTPS protocol are supported")
|
|
}
|
|
|
|
if exposeReq.Pin != "" && !pinRegexp.MatchString(exposeReq.Pin) {
|
|
return nil, status.Errorf(codes.InvalidArgument, "invalid pin: must be exactly 6 digits")
|
|
}
|
|
|
|
for _, g := range exposeReq.UserGroups {
|
|
if g == "" {
|
|
return nil, status.Errorf(codes.InvalidArgument, "user group name cannot be empty")
|
|
}
|
|
}
|
|
|
|
reverseProxyMgr := s.getReverseProxyManager()
|
|
if reverseProxyMgr == nil {
|
|
return nil, status.Errorf(codes.Internal, "reverse proxy manager not available")
|
|
}
|
|
|
|
if err := reverseProxyMgr.ValidateExposePermission(ctx, accountID, peer.ID); err != nil {
|
|
log.WithContext(ctx).Debugf("expose permission denied for peer %s: %v", peer.ID, err)
|
|
return nil, status.Errorf(codes.PermissionDenied, "permission denied")
|
|
}
|
|
|
|
serviceName, err := reverseproxy.GenerateExposeName(exposeReq.NamePrefix)
|
|
if err != nil {
|
|
return nil, status.Errorf(codes.InvalidArgument, "generate service name: %v", err)
|
|
}
|
|
|
|
service := reverseproxy.FromExposeRequest(exposeReq, accountID, peer.ID, serviceName)
|
|
|
|
// Serialize the count check to prevent concurrent CreateExpose calls from
|
|
// exceeding maxExposesPerPeer. The lock is held only for the check; the
|
|
// actual service creation happens outside the lock.
|
|
s.exposeCreateMu.Lock()
|
|
if s.countPeerExposes(peer.ID) >= maxExposesPerPeer {
|
|
s.exposeCreateMu.Unlock()
|
|
return nil, status.Errorf(codes.ResourceExhausted, "peer has reached the maximum number of active expose sessions (%d)", maxExposesPerPeer)
|
|
}
|
|
s.exposeCreateMu.Unlock()
|
|
|
|
created, err := reverseProxyMgr.CreateServiceFromPeer(ctx, accountID, peer.ID, service)
|
|
if err != nil {
|
|
log.WithContext(ctx).Errorf("failed to create service from peer: %v", err)
|
|
return nil, status.Errorf(codes.Internal, "create service: %v", err)
|
|
}
|
|
|
|
key := exposeKey(peer.ID, created.Domain)
|
|
if _, loaded := s.activeExposes.LoadOrStore(key, &activeExpose{
|
|
serviceID: created.ID,
|
|
domain: created.Domain,
|
|
accountID: accountID,
|
|
peerID: peer.ID,
|
|
lastRenewed: time.Now(),
|
|
}); loaded {
|
|
s.deleteExposeService(ctx, accountID, peer.ID, created)
|
|
return nil, status.Errorf(codes.AlreadyExists, "peer already has an active expose session for this domain")
|
|
}
|
|
|
|
resp := &proto.ExposeServiceResponse{
|
|
ServiceName: created.Name,
|
|
ServiceUrl: "https://" + created.Domain,
|
|
Domain: created.Domain,
|
|
}
|
|
|
|
return s.encryptResponse(peerKey, resp)
|
|
}
|
|
|
|
// RenewExpose extends the TTL of an active expose session.
|
|
func (s *Server) RenewExpose(ctx context.Context, req *proto.EncryptedMessage) (*proto.EncryptedMessage, error) {
|
|
renewReq := &proto.RenewExposeRequest{}
|
|
peerKey, err := s.parseRequest(ctx, req, renewReq)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
_, peer, err := s.authenticateExposePeer(ctx, peerKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
key := exposeKey(peer.ID, renewReq.Domain)
|
|
val, ok := s.activeExposes.Load(key)
|
|
if !ok {
|
|
return nil, status.Errorf(codes.NotFound, "no active expose session for domain %s", renewReq.Domain)
|
|
}
|
|
|
|
expose := val.(*activeExpose)
|
|
expose.mu.Lock()
|
|
expose.lastRenewed = time.Now()
|
|
expose.mu.Unlock()
|
|
|
|
return s.encryptResponse(peerKey, &proto.RenewExposeResponse{})
|
|
}
|
|
|
|
// StopExpose terminates an active expose session.
|
|
func (s *Server) StopExpose(ctx context.Context, req *proto.EncryptedMessage) (*proto.EncryptedMessage, error) {
|
|
stopReq := &proto.StopExposeRequest{}
|
|
peerKey, err := s.parseRequest(ctx, req, stopReq)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
_, peer, err := s.authenticateExposePeer(ctx, peerKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
key := exposeKey(peer.ID, stopReq.Domain)
|
|
val, ok := s.activeExposes.LoadAndDelete(key)
|
|
if !ok {
|
|
return nil, status.Errorf(codes.NotFound, "no active expose session for domain %s", stopReq.Domain)
|
|
}
|
|
|
|
expose := val.(*activeExpose)
|
|
s.cleanupExpose(expose, false)
|
|
|
|
return s.encryptResponse(peerKey, &proto.StopExposeResponse{})
|
|
}
|
|
|
|
// StartExposeReaper starts a background goroutine that reaps expired expose sessions.
|
|
func (s *Server) StartExposeReaper(ctx context.Context) {
|
|
go func() {
|
|
ticker := time.NewTicker(exposeReapInterval)
|
|
defer ticker.Stop()
|
|
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case <-ticker.C:
|
|
s.reapExpiredExposes()
|
|
}
|
|
}
|
|
}()
|
|
}
|
|
|
|
func (s *Server) reapExpiredExposes() {
|
|
s.activeExposes.Range(func(key, val any) bool {
|
|
expose := val.(*activeExpose)
|
|
expose.mu.Lock()
|
|
expired := time.Since(expose.lastRenewed) > exposeTTL
|
|
expose.mu.Unlock()
|
|
|
|
if expired {
|
|
if _, deleted := s.activeExposes.LoadAndDelete(key); deleted {
|
|
log.Infof("reaping expired expose session for peer %s, domain %s", expose.peerID, expose.domain)
|
|
s.cleanupExpose(expose, true)
|
|
}
|
|
}
|
|
return true
|
|
})
|
|
}
|
|
|
|
func (s *Server) encryptResponse(peerKey wgtypes.Key, msg pb.Message) (*proto.EncryptedMessage, error) {
|
|
wgKey, err := s.secretsManager.GetWGKey()
|
|
if err != nil {
|
|
return nil, status.Errorf(codes.Internal, "internal error")
|
|
}
|
|
|
|
encryptedResp, err := encryption.EncryptMessage(peerKey, wgKey, msg)
|
|
if err != nil {
|
|
return nil, status.Errorf(codes.Internal, "encrypt response")
|
|
}
|
|
|
|
return &proto.EncryptedMessage{
|
|
WgPubKey: wgKey.PublicKey().String(),
|
|
Body: encryptedResp,
|
|
}, nil
|
|
}
|
|
|
|
func (s *Server) authenticateExposePeer(ctx context.Context, peerKey wgtypes.Key) (string, *nbpeer.Peer, error) {
|
|
accountID, err := s.accountManager.GetAccountIDForPeerKey(ctx, peerKey.String())
|
|
if err != nil {
|
|
if errStatus, ok := internalStatus.FromError(err); ok && errStatus.Type() == internalStatus.NotFound {
|
|
return "", nil, status.Errorf(codes.PermissionDenied, "peer is not registered")
|
|
}
|
|
return "", nil, status.Errorf(codes.Internal, "lookup account for peer")
|
|
}
|
|
|
|
peer, err := s.accountManager.GetStore().GetPeerByPeerPubKey(ctx, store.LockingStrengthNone, peerKey.String())
|
|
if err != nil {
|
|
return "", nil, status.Errorf(codes.PermissionDenied, "peer is not registered")
|
|
}
|
|
|
|
return accountID, peer, nil
|
|
}
|
|
|
|
func (s *Server) deleteExposeService(ctx context.Context, accountID, peerID string, service *reverseproxy.Service) {
|
|
reverseProxyMgr := s.getReverseProxyManager()
|
|
if reverseProxyMgr == nil {
|
|
return
|
|
}
|
|
if err := reverseProxyMgr.DeleteServiceFromPeer(ctx, accountID, peerID, service.ID); err != nil {
|
|
log.WithContext(ctx).Debugf("failed to delete expose service %s: %v", service.ID, err)
|
|
}
|
|
}
|
|
|
|
func (s *Server) cleanupExpose(expose *activeExpose, expired bool) {
|
|
bgCtx := context.Background()
|
|
|
|
reverseProxyMgr := s.getReverseProxyManager()
|
|
if reverseProxyMgr == nil {
|
|
log.Errorf("cannot cleanup exposed service %s: reverse proxy manager not available", expose.serviceID)
|
|
return
|
|
}
|
|
|
|
var err error
|
|
if expired {
|
|
err = reverseProxyMgr.ExpireServiceFromPeer(bgCtx, expose.accountID, expose.peerID, expose.serviceID)
|
|
} else {
|
|
err = reverseProxyMgr.DeleteServiceFromPeer(bgCtx, expose.accountID, expose.peerID, expose.serviceID)
|
|
}
|
|
if err != nil {
|
|
log.Errorf("failed to delete peer-exposed service %s: %v", expose.serviceID, err)
|
|
}
|
|
}
|
|
|
|
func (s *Server) countPeerExposes(peerID string) int {
|
|
count := 0
|
|
s.activeExposes.Range(func(_, val any) bool {
|
|
if expose := val.(*activeExpose); expose.peerID == peerID {
|
|
count++
|
|
}
|
|
return true
|
|
})
|
|
return count
|
|
}
|
|
|
|
func (s *Server) getReverseProxyManager() reverseproxy.Manager {
|
|
s.reverseProxyMu.RLock()
|
|
defer s.reverseProxyMu.RUnlock()
|
|
return s.reverseProxyManager
|
|
}
|
|
|
|
// SetReverseProxyManager sets the reverse proxy manager on the server.
|
|
func (s *Server) SetReverseProxyManager(mgr reverseproxy.Manager) {
|
|
s.reverseProxyMu.Lock()
|
|
defer s.reverseProxyMu.Unlock()
|
|
s.reverseProxyManager = mgr
|
|
}
|