Convert network restrictions to new cache mechanism

rosstimothy · rosstimothy · commit 2ea940c9c657 · 2025-05-03T17:19:07.000-04:00
Moves networking restrictins to the new cache collection scheme that was introduced in #52210. No additional functionality changes have been made here. This should be a purely mechanical translation to the new internal caching machinery.
diff --git a/api/types/restrictions.go b/api/types/restrictions.go
@@ -20,6 +20,8 @@ import (
 	"time"
 
 	"github.com/gravitational/trace"
+
+	"github.com/gravitational/teleport/api/utils"
 )
 
 // NetworkRestrictions defines network restrictions applied to SSH session.
@@ -33,6 +35,8 @@ type NetworkRestrictions interface {
 	GetDeny() []AddressCondition
 	// SetDeny sets a list of denied network addresses (overrides Allow list)
 	SetDeny(deny []AddressCondition)
+	// Clone returns a copy of the network restrictions.
+	Clone() NetworkRestrictions
 }
 
 // NewNetworkRestrictions creates a new NetworkRestrictions with the given name.
@@ -46,6 +50,11 @@ func NewNetworkRestrictions() NetworkRestrictions {
 	}
 }
 
+// Clone returns a copy of the network restrictions.
+func (r *NetworkRestrictionsV4) Clone() NetworkRestrictions {
+	return utils.CloneProtoMsg(r)
+}
+
 func (r *NetworkRestrictionsV4) setStaticFields() {
 	if r.Version == "" {
 		r.Version = V4
diff --git a/lib/cache/cache.go b/lib/cache/cache.go
@@ -509,7 +509,6 @@ type Cache struct {
 	accessCache                  services.Access
 	dynamicAccessCache           services.DynamicAccessExt
 	presenceCache                services.Presence
-	restrictionsCache            services.Restrictions
 	crownJewelsCache             services.CrownJewels
 	databaseObjectsCache         *local.DatabaseObjectService
 	webTokenCache                types.WebTokenInterface
@@ -1042,7 +1041,6 @@ func New(config Config) (*Cache, error) {
 		accessCache:                  local.NewAccessService(config.Backend),
 		dynamicAccessCache:           local.NewDynamicAccessService(config.Backend),
 		presenceCache:                local.NewPresenceService(config.Backend),
-		restrictionsCache:            local.NewRestrictionsService(config.Backend),
 		crownJewelsCache:             crownJewelCache,
 		webTokenCache:                identityService.WebTokens(),
 		dynamicWindowsDesktopsCache:  dynamicDesktopsService,
@@ -1926,20 +1924,6 @@ func (c *Cache) GetWebToken(ctx context.Context, req types.GetWebTokenRequest) (
 	return rg.reader.Get(ctx, req)
 }
 
-// GetNetworkRestrictions gets the network restrictions.
-func (c *Cache) GetNetworkRestrictions(ctx context.Context) (types.NetworkRestrictions, error) {
-	ctx, span := c.Tracer.Start(ctx, "cache/GetNetworkRestrictions")
-	defer span.End()
-
-	rg, err := readLegacyCollectionCache(c, c.legacyCacheCollections.networkRestrictions)
-	if err != nil {
-		return nil, trace.Wrap(err)
-	}
-	defer rg.Release()
-
-	return rg.reader.GetNetworkRestrictions(ctx)
-}
-
 // GetDynamicWindowsDesktop returns registered dynamic Windows desktop by name.
 func (c *Cache) GetDynamicWindowsDesktop(ctx context.Context, name string) (types.DynamicWindowsDesktop, error) {
 	ctx, span := c.Tracer.Start(ctx, "cache/GetDynamicWindowsDesktop")
diff --git a/lib/cache/cert_authority_test.go b/lib/cache/cert_authority_test.go
@@ -93,7 +93,6 @@ func TestNodeCAFiltering(t *testing.T) {
 		Access:                  p.cache.accessCache,
 		DynamicAccess:           p.cache.dynamicAccessCache,
 		Presence:                p.cache.presenceCache,
-		Restrictions:            p.cache.restrictionsCache,
 		WebToken:                p.cache.webTokenCache,
 		DynamicWindowsDesktops:  p.cache.dynamicWindowsDesktopsCache,
 		SAMLIdPServiceProviders: p.samlIDPServiceProviders,
diff --git a/lib/cache/collections.go b/lib/cache/collections.go
@@ -100,6 +100,7 @@ type collections struct {
 	tunnelConnections                *collection[types.TunnelConnection, tunnelConnectionIndex]
 	remoteClusters                   *collection[types.RemoteCluster, remoteClusterIndex]
 	staticHostUsers                  *collection[*userprovisioningv2.StaticHostUser, staticHostUserIndex]
+	networkRestrictions              *collection[types.NetworkRestrictions, networkingRestrictionIndex]
 }
 
 // setupCollections ensures that the appropriate [collection] is
@@ -477,6 +478,14 @@ func setupCollections(c Config) (*collections, error) {
 
 			out.staticHostUsers = collect
 			out.byKind[resourceKind] = out.staticHostUsers
+		case types.KindNetworkRestrictions:
+			collect, err := newNetworkingRestrictionCollection(c.Restrictions, watch)
+			if err != nil {
+				return nil, trace.Wrap(err)
+			}
+
+			out.networkRestrictions = collect
+			out.byKind[resourceKind] = out.networkRestrictions
 		}
 	}
 
diff --git a/lib/cache/legacy_collections.go b/lib/cache/legacy_collections.go
@@ -117,7 +117,6 @@ type legacyCollections struct {
 	userTasks                          collectionReader[userTasksGetter]
 	crownJewels                        collectionReader[crownjewelsGetter]
 	kubeWaitingContainers              collectionReader[kubernetesWaitingContainerGetter]
-	networkRestrictions                collectionReader[networkRestrictionGetter]
 	proxies                            collectionReader[services.ProxyGetter]
 	uiConfigs                          collectionReader[uiConfigGetter]
 	userLoginStates                    collectionReader[services.UserLoginStatesGetter]
@@ -190,15 +189,6 @@ func setupLegacyCollections(c *Cache, watches []types.WatchKind) (*legacyCollect
 				watch: watch,
 			}
 			collections.byKind[resourceKind] = collections.crownJewels
-		case types.KindNetworkRestrictions:
-			if c.Restrictions == nil {
-				return nil, trace.BadParameter("missing parameter Restrictions")
-			}
-			collections.networkRestrictions = &genericCollection[types.NetworkRestrictions, networkRestrictionGetter, networkRestrictionsExecutor]{
-				cache: c,
-				watch: watch,
-			}
-			collections.byKind[resourceKind] = collections.networkRestrictions
 		case types.KindDynamicWindowsDesktop:
 			if c.WindowsDesktops == nil {
 				return nil, trace.BadParameter("missing parameter DynamicWindowsDesktops")
@@ -615,43 +605,6 @@ type installerGetter interface {
 
 var _ executor[types.Installer, installerGetter] = installerConfigExecutor{}
 
-type networkRestrictionsExecutor struct{}
-
-func (networkRestrictionsExecutor) getAll(ctx context.Context, cache *Cache, loadSecrets bool) ([]types.NetworkRestrictions, error) {
-	restrictions, err := cache.Restrictions.GetNetworkRestrictions(ctx)
-	if err != nil {
-		return nil, trace.Wrap(err)
-	}
-	return []types.NetworkRestrictions{restrictions}, nil
-}
-
-func (networkRestrictionsExecutor) upsert(ctx context.Context, cache *Cache, resource types.NetworkRestrictions) error {
-	return cache.restrictionsCache.SetNetworkRestrictions(ctx, resource)
-}
-
-func (networkRestrictionsExecutor) deleteAll(ctx context.Context, cache *Cache) error {
-	return cache.restrictionsCache.DeleteNetworkRestrictions(ctx)
-}
-
-func (networkRestrictionsExecutor) delete(ctx context.Context, cache *Cache, resource types.Resource) error {
-	return cache.restrictionsCache.DeleteNetworkRestrictions(ctx)
-}
-
-func (networkRestrictionsExecutor) isSingleton() bool { return true }
-
-func (networkRestrictionsExecutor) getReader(cache *Cache, cacheOK bool) networkRestrictionGetter {
-	if cacheOK {
-		return cache.restrictionsCache
-	}
-	return cache.Config.Restrictions
-}
-
-type networkRestrictionGetter interface {
-	GetNetworkRestrictions(context.Context) (types.NetworkRestrictions, error)
-}
-
-var _ executor[types.NetworkRestrictions, networkRestrictionGetter] = networkRestrictionsExecutor{}
-
 type dynamicWindowsDesktopsExecutor struct{}
 
 func (dynamicWindowsDesktopsExecutor) getAll(ctx context.Context, cache *Cache, loadSecrets bool) ([]types.DynamicWindowsDesktop, error) {
diff --git a/lib/cache/network_restrictions.go b/lib/cache/network_restrictions.go
@@ -0,0 +1,78 @@
+// Teleport
+// Copyright (C) 2025 Gravitational, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package cache
+
+import (
+	"context"
+
+	"github.com/gravitational/trace"
+
+	"github.com/gravitational/teleport/api/types"
+	"github.com/gravitational/teleport/lib/services"
+)
+
+type networkingRestrictionIndex string
+
+const networkingRestrictionNameIndex networkingRestrictionIndex = "name"
+
+func newNetworkingRestrictionCollection(upstream services.Restrictions, w types.WatchKind) (*collection[types.NetworkRestrictions, networkingRestrictionIndex], error) {
+	if upstream == nil {
+		return nil, trace.BadParameter("missing parameter Restrictions")
+	}
+
+	return &collection[types.NetworkRestrictions, networkingRestrictionIndex]{
+		store: newStore(map[networkingRestrictionIndex]func(types.NetworkRestrictions) string{
+			networkingRestrictionNameIndex: types.NetworkRestrictions.GetName,
+		}),
+		fetcher: func(ctx context.Context, loadSecrets bool) ([]types.NetworkRestrictions, error) {
+			restrictions, err := upstream.GetNetworkRestrictions(ctx)
+			if err != nil {
+				return nil, trace.Wrap(err)
+			}
+			return []types.NetworkRestrictions{restrictions}, nil
+		},
+		headerTransform: func(hdr *types.ResourceHeader) types.NetworkRestrictions {
+			return &types.NetworkRestrictionsV4{
+				Kind:    hdr.Kind,
+				Version: hdr.Version,
+				Metadata: types.Metadata{
+					Name: hdr.Metadata.Name,
+				},
+			}
+		},
+		watch: w,
+	}, nil
+}
+
+// GetNetworkRestrictions gets the network restrictions.
+func (c *Cache) GetNetworkRestrictions(ctx context.Context) (types.NetworkRestrictions, error) {
+	ctx, span := c.Tracer.Start(ctx, "cache/GetNetworkRestrictions")
+	defer span.End()
+
+	getter := genericGetter[types.NetworkRestrictions, networkingRestrictionIndex]{
+		cache:      c,
+		collection: c.collections.networkRestrictions,
+		index:      networkingRestrictionNameIndex,
+		upstreamGet: func(ctx context.Context, s string) (types.NetworkRestrictions, error) {
+			restriction, err := c.Config.Restrictions.GetNetworkRestrictions(ctx)
+			return restriction, trace.Wrap(err)
+		},
+		clone: types.NetworkRestrictions.Clone,
+	}
+	out, err := getter.get(ctx, types.MetaNameNetworkRestrictions)
+	return out, trace.Wrap(err)
+}
diff --git a/lib/cache/networking_restrictions_test.go b/lib/cache/networking_restrictions_test.go
@@ -0,0 +1,52 @@
+// Teleport
+// Copyright (C) 2025 Gravitational, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package cache
+
+import (
+	"context"
+	"testing"
+
+	"github.com/gravitational/trace"
+
+	"github.com/gravitational/teleport/api/types"
+)
+
+func TestNetworkRestrictions(t *testing.T) {
+	t.Parallel()
+
+	p := newTestPack(t, ForAuth)
+	t.Cleanup(p.Close)
+
+	testResources(t, p, testFuncs[types.NetworkRestrictions]{
+		newResource: func(name string) (types.NetworkRestrictions, error) {
+			return types.NewNetworkRestrictions(), nil
+		},
+		create: p.restrictions.SetNetworkRestrictions,
+		list: func(ctx context.Context) ([]types.NetworkRestrictions, error) {
+			restrictions, err := p.restrictions.GetNetworkRestrictions(ctx)
+			return []types.NetworkRestrictions{restrictions}, trace.Wrap(err)
+		},
+		cacheList: func(ctx context.Context) ([]types.NetworkRestrictions, error) {
+			restrictions, err := p.cache.GetNetworkRestrictions(ctx)
+			if trace.IsNotFound(err) {
+				return nil, nil
+			}
+			return []types.NetworkRestrictions{restrictions}, trace.Wrap(err)
+		},
+		deleteAll: p.restrictions.DeleteNetworkRestrictions,
+	})
+}
diff --git a/lib/services/local/events.go b/lib/services/local/events.go
@@ -1842,16 +1842,11 @@ func (p *networkRestrictionsParser) match(key backend.Key) bool {
 func (p *networkRestrictionsParser) parse(event backend.Event) (types.Resource, error) {
 	switch event.Type {
 	case types.OpDelete:
-		name := event.Item.Key.TrimPrefix(backend.NewKey(restrictionsPrefix, network)).String()
-		if name == "" {
-			return nil, trace.NotFound("failed parsing %v", event.Item.Key.String())
-		}
-
 		return &types.ResourceHeader{
 			Kind:    types.KindNetworkRestrictions,
 			Version: types.V1,
 			Metadata: types.Metadata{
-				Name:      strings.TrimPrefix(name, backend.SeparatorString),
+				Name:      types.MetaNameNetworkRestrictions,
 				Namespace: apidefaults.Namespace,
 			},
 		}, nil

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@ import (`
`20`	`20`	`"time"`
`21`	`21`
`22`	`22`	`"github.com/gravitational/trace"`
	`23`	`+`
	`24`	`+ "github.com/gravitational/teleport/api/utils"`
`23`	`25`	`)`
`24`	`26`
`25`	`27`	`// NetworkRestrictions defines network restrictions applied to SSH session.`
`@@ -33,6 +35,8 @@ type NetworkRestrictions interface {`
`33`	`35`	`GetDeny() []AddressCondition`
`34`	`36`	`// SetDeny sets a list of denied network addresses (overrides Allow list)`
`35`	`37`	`SetDeny(deny []AddressCondition)`
	`38`	`+ // Clone returns a copy of the network restrictions.`
	`39`	`+ Clone() NetworkRestrictions`
`36`	`40`	`}`
`37`	`41`
`38`	`42`	`// NewNetworkRestrictions creates a new NetworkRestrictions with the given name.`
`@@ -46,6 +50,11 @@ func NewNetworkRestrictions() NetworkRestrictions {`
`46`	`50`	`}`
`47`	`51`	`}`
`48`	`52`
	`53`	`+// Clone returns a copy of the network restrictions.`
	`54`	`+func (r *NetworkRestrictionsV4) Clone() NetworkRestrictions {`
	`55`	`+ return utils.CloneProtoMsg(r)`
	`56`	`+}`
	`57`	`+`
`49`	`58`	`func (r *NetworkRestrictionsV4) setStaticFields() {`
`50`	`59`	`if r.Version == "" {`
`51`	`60`	`r.Version = V4`
Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,7 @@ type collections struct {`
`100`	`100`	`tunnelConnections *collection[types.TunnelConnection, tunnelConnectionIndex]`
`101`	`101`	`remoteClusters *collection[types.RemoteCluster, remoteClusterIndex]`
`102`	`102`	`staticHostUsers collection[userprovisioningv2.StaticHostUser, staticHostUserIndex]`
	`103`	`+ networkRestrictions *collection[types.NetworkRestrictions, networkingRestrictionIndex]`
`103`	`104`	`}`
`104`	`105`
`105`	`106`	`// setupCollections ensures that the appropriate [collection] is`
`@@ -477,6 +478,14 @@ func setupCollections(c Config) (*collections, error) {`
`477`	`478`
`478`	`479`	`out.staticHostUsers = collect`
`479`	`480`	`out.byKind[resourceKind] = out.staticHostUsers`
	`481`	`+ case types.KindNetworkRestrictions:`
	`482`	`+ collect, err := newNetworkingRestrictionCollection(c.Restrictions, watch)`
	`483`	`+ if err != nil {`
	`484`	`+ return nil, trace.Wrap(err)`
	`485`	`+ }`
	`486`	`+`
	`487`	`+ out.networkRestrictions = collect`
	`488`	`+ out.byKind[resourceKind] = out.networkRestrictions`
`480`	`489`	`}`
`481`	`490`	`}`
`482`	`491`