User-specified connections

Signed-off-by: Ziv Nevo <[email protected]>

Author: zivnevo

pkg/analyzer/connections.go

@@ -7,21 +7,34 @@ SPDX-License-Identifier: Apache-2.0
 package analyzer
 
 import (
+	"bufio"
 	"fmt"
+	"os"
+	"slices"
+	"strings"
+
+	core "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
+type connectionExtractor struct {
+	workloads []*Resource
+	services  []*Service
+	logger    Logger
+}
+
 // This function is at the core of the topology analysis
 // For each resource, it finds other resources that may use it and compiles a list of connections holding these dependencies
-func discoverConnections(resources []*Resource, links []*Service, logger Logger) []*Connections {
+func (ce *connectionExtractor) discoverConnections() []*Connections {
 	connections := []*Connections{}
-	for _, destRes := range resources {
-		deploymentServices := findServices(destRes, links)
-		logger.Debugf("services matched to %v: %v", destRes.Resource.Name, deploymentServices)
+	for _, destRes := range ce.workloads {
+		deploymentServices := ce.findServices(destRes)
+		ce.logger.Debugf("services matched to %v: %v", destRes.Resource.Name, deploymentServices)
 		for _, svc := range deploymentServices {
-			srcRes := findSource(resources, svc)
+			srcRes := ce.findSource(svc)
 			for _, r := range srcRes {
 				if !r.equals(destRes) {
-					logger.Debugf("source: %s target: %s link: %s", r.Resource.Name, destRes.Resource.Name, svc.Resource.Name)
+					ce.logger.Debugf("source: %s target: %s link: %s", r.Resource.Name, destRes.Resource.Name, svc.Resource.Name)
 					connections = append(connections, &Connections{Source: r, Target: destRes, Link: svc})
 				}
 			}
@@ -62,9 +75,9 @@ func areSelectorsContained(selectors1 map[string]string, selectors2 []string) bo
 }
 
 // findServices returns a list of services that may be in front of a given workload resource
-func findServices(resource *Resource, links []*Service) []*Service {
+func (ce *connectionExtractor) findServices(resource *Resource) []*Service {
 	var matchedSvc []*Service
-	for _, link := range links {
+	for _, link := range ce.services {
 		if link.Resource.Namespace != resource.Resource.Namespace {
 			continue
 		}
@@ -79,9 +92,9 @@ func findServices(resource *Resource, links []*Service) []*Service {
 }
 
 // findSource returns a list of resources that are likely trying to connect to the given service
-func findSource(resources []*Resource, service *Service) []*Resource {
+func (ce *connectionExtractor) findSource(service *Service) []*Resource {
 	tRes := []*Resource{}
-	for _, resource := range resources {
+	for _, resource := range ce.workloads {
 		serviceAddresses := getPossibleServiceAddresses(service, resource)
 		foundSrc := *resource // We copy the resource so we can specify the ports used by the source found
 		matched := false
@@ -133,3 +146,226 @@ func envValueMatchesService(envVal string, service *Service, serviceAddresses []
 	}
 	return false, SvcNetworkAttr{}
 }
+
+const (
+	srcDstDelim         = "=>"
+	endpointsPortDelim  = ":"
+	commentToken        = "#"
+	wildcardToken       = "_"
+	strongWildcardToken = "*"
+	endpointParts       = 3
+)
+
+func (ce *connectionExtractor) connectionsFromFile(filename string) ([]*Connections, error) {
+	file, err := os.Open(filename)
+	if err != nil {
+		return nil, err
+	}
+	defer file.Close()
+
+	conns := []*Connections{}
+
+	scanner := bufio.NewScanner(file)
+	lineNum := 0
+	for scanner.Scan() {
+		line := strings.TrimSpace(scanner.Text())
+		lineNum += 1
+		if line == "" || strings.HasPrefix(line, commentToken) {
+			continue
+		}
+		lineConns, err := ce.parseConnectionLine(line, lineNum)
+		if err != nil {
+			return nil, err
+		}
+		conns = slices.Concat(conns, lineConns)
+	}
+
+	if err := scanner.Err(); err != nil {
+		return nil, err
+	}
+
+	return conns, nil
+}
+
+func (ce *connectionExtractor) parseConnectionLine(line string, lineNum int) ([]*Connections, error) {
+	// Take only the part before # starts a comment
+	parts := strings.Split(line, commentToken)
+	if len(parts) == 0 {
+		return nil, syntaxError("unexpected comment", lineNum)
+	}
+
+	line = parts[0]
+
+	parts = strings.Split(line, srcDstDelim)
+	if len(parts) != 2 {
+		return nil, syntaxError("connection line must have exactly one => separator", lineNum)
+	}
+
+	src := strings.TrimSpace(parts[0])
+	srcWorkloads, err := ce.parseEndpoints(src, lineNum)
+	if err != nil {
+		return nil, err
+	}
+
+	parts = strings.Split(parts[1], endpointsPortDelim)
+	if len(parts) == 0 {
+		return nil, syntaxError("missing destination", lineNum)
+	}
+	if len(parts) > 2 {
+		return nil, syntaxError("connection line must have at most one | separator", lineNum)
+	}
+	dst := strings.TrimSpace(parts[0])
+	dstWorkloads, err := ce.parseEndpoints(dst, lineNum)
+	if err != nil {
+		return nil, err
+	}
+
+	protAndPort := &SvcNetworkAttr{Protocol: core.ProtocolTCP}
+	if len(parts) == 2 {
+		protAndPort, err = parsePort(parts[1], lineNum)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	svc := Service{}
+	svc.Resource.Network = []SvcNetworkAttr{*protAndPort}
+
+	conns := []*Connections{}
+	for _, srcWl := range srcWorkloads {
+		for _, dstWl := range dstWorkloads {
+			if srcWl.equals(dstWl) {
+				continue
+			}
+			conns = append(conns, &Connections{
+				Source: srcWl,
+				Target: dstWl,
+				Link:   &svc,
+			})
+			ce.logger.Infof("Added connection: src: %v, dst: %v, link: %v", srcWl.Resource.Name, dstWl.Resource.Name, svc)
+		}
+	}
+	return conns, nil
+}
+
+func (ce *connectionExtractor) parseEndpoints(endpoint string, lineNum int) ([]*Resource, error) {
+	parts := strings.Split(endpoint, "/")
+	if len(parts) != endpointParts {
+		return nil, syntaxError("source and destination must be of the form namespace/kind/name", lineNum)
+	}
+	ns, kind, name := parts[0], parts[1], parts[2]
+	kind = strings.ToUpper(kind[:1]) + kind[1:] // Capitalize kind's first letter
+
+	if ns == strongWildcardToken || kind == strongWildcardToken || name == strongWildcardToken {
+		return ce.parseEndpointWithStrongWildcard(ns, kind, name)
+	}
+
+	var res []*Resource
+	switch kind {
+	case service:
+		res = ce.getWorkloadsBehindMatchingServices(ns, name)
+	case wildcardToken:
+		res = slices.Concat(ce.getWorkloadsBehindMatchingServices(ns, name), ce.getMatchingWorkloads(ns, kind, name))
+	default:
+		res = ce.getMatchingWorkloads(ns, kind, name)
+	}
+	if len(res) == 0 {
+		return nil, fmt.Errorf("no matching endpoints for %s in the provided manifests", endpoint)
+	}
+	return res, nil
+}
+
+func (ce *connectionExtractor) parseEndpointWithStrongWildcard(ns, kind, name string) ([]*Resource, error) {
+	if kind != strongWildcardToken || name != strongWildcardToken {
+		return nil, fmt.Errorf("bad endpoint pattern %s/%s/%s. Patterns with '*' should either equal '*/*/*' "+
+			"or have the form '<namespace>/*/*'", ns, kind, name)
+	}
+
+	return nil, fmt.Errorf("endpoints containing '*' are not yet supported")
+
+	/*res := Resource{}
+	if ns != strongWildcardToken {
+		if len(validation.IsDNS1123Subdomain(ns)) != 0 {
+			return nil, fmt.Errorf("%s is not a proper namespace name", ns)
+		}
+		res.Resource.Namespace = ns
+	}
+	return []*Resource{&res}, nil*/
+}
+
+func (ce *connectionExtractor) getWorkloadsBehindMatchingServices(ns, svcName string) []*Resource {
+	workloads := []*Resource{}
+	for _, svc := range ce.services {
+		if strMatch(svc.Resource.Namespace, ns) && strMatch(svc.Resource.Name, svcName) {
+			workloads = slices.Concat(workloads, ce.workloadsOfSvc(svc))
+		}
+	}
+	return workloads
+}
+
+func (ce *connectionExtractor) workloadsOfSvc(svc *Service) []*Resource {
+	svcWorkloads := []*Resource{}
+	for _, workload := range ce.workloads {
+		if workload.Resource.Namespace == svc.Resource.Namespace &&
+			areSelectorsContained(workload.Resource.Labels, svc.Resource.Selectors) {
+			svcWorkloads = append(svcWorkloads, workload)
+		}
+	}
+	return svcWorkloads
+}
+
+func (ce *connectionExtractor) getMatchingWorkloads(ns, kind, name string) []*Resource {
+	workloads := []*Resource{}
+	for _, workload := range ce.workloads {
+		if strMatch(workload.Resource.Namespace, ns) && strMatch(workload.Resource.Kind, kind) &&
+			strMatch(workload.Resource.Name, name) {
+			workloads = append(workloads, workload)
+		}
+	}
+	return workloads
+}
+
+func parsePort(spec string, lineNum int) (*SvcNetworkAttr, error) {
+	protocol := core.ProtocolTCP
+	var port *intstr.IntOrString
+
+	parts := strings.Fields(spec)
+	switch len(parts) {
+	case 0:
+	case 2:
+		parsedPort := intstr.Parse(parts[1])
+		port = &parsedPort
+		fallthrough
+	case 1:
+		var err error
+		protocol, err = parseProtocol(parts[0], lineNum)
+		if err != nil {
+			return nil, err
+		}
+	default:
+		return nil, syntaxError("port definition should have the form \"<protocol> [<port>]\"", lineNum)
+	}
+
+	ret := &SvcNetworkAttr{Protocol: protocol}
+	if port != nil {
+		ret.TargetPort = *port
+	}
+
+	return ret, nil
+}
+
+func parseProtocol(protocol string, lineNum int) (core.Protocol, error) {
+	protocols := []string{string(core.ProtocolTCP), string(core.ProtocolUDP), string(core.ProtocolSCTP)}
+	if !slices.Contains(protocols, protocol) {
+		return "", syntaxError("protocol must be one of TCP, UDP, SCTP", lineNum)
+	}
+	return core.Protocol(protocol), nil
+}
+
+func strMatch(str, pattern string) bool {
+	return pattern == wildcardToken || str == pattern
+}
+
+func syntaxError(errorStr string, lineNum int) error {
+	return fmt.Errorf("syntax error in line %d: %s", lineNum, errorStr)
+}

pkg/analyzer/connections_test.go

@@ -0,0 +1,49 @@
+package analyzer
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"k8s.io/apimachinery/pkg/labels"
+	"k8s.io/apimachinery/pkg/selection"
+)
+
+func TestSelector(t *testing.T) {
+	testStr := "key1=val1, key2=val2"
+	reqs, err := labels.ParseToRequirements(testStr)
+	if err != nil {
+		t.Fatalf("Conversion error: %v", err)
+	}
+
+	res := map[string]string{}
+	for _, req := range reqs {
+		if req.Operator() != selection.Equals {
+			t.Fatalf("Wrong operator: %s", req.Operator())
+		}
+		res[req.Key()] = req.Values().List()[0]
+	}
+
+	t.Logf("labels: %v", res)
+}
+
+func TestConnectionsFile(t *testing.T) {
+	logger := NewDefaultLogger()
+	sockshopDir := filepath.Join(getTestsDir(), "sockshop")
+	manifestsDir := filepath.Join(sockshopDir, "manifests")
+	mf := manifestFinder{logger, false, filepath.WalkDir}
+	manifestFiles, fileErrors := mf.searchForManifestsInDirs([]string{manifestsDir})
+	require.Empty(t, fileErrors)
+
+	resAcc := newResourceAccumulator(logger, false)
+	parseErrors := resAcc.parseK8sYamls(manifestFiles)
+	require.Empty(t, parseErrors)
+
+	ce := connectionExtractor{workloads: resAcc.workloads, services: resAcc.services, logger: logger}
+	connections := ce.discoverConnections()
+	require.NotEmpty(t, connections)
+	connFilePath := filepath.Join(sockshopDir, "connections.txt")
+	fileConns, err := ce.connectionsFromFile(connFilePath)
+	require.Nil(t, err)
+	require.Len(t, fileConns, 15)
+}

pkg/analyzer/policies_synthesizer.go

@@ -13,6 +13,7 @@ package analyzer
 import (
 	"io/fs"
 	"path/filepath"
+	"slices"
 
 	networking "k8s.io/api/networking/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
@@ -242,7 +243,18 @@ func (ps *PoliciesSynthesizer) extractConnections(resAcc *resourceAccumulator) (
 	resAcc.exposeServices()
 
 	// Discover all connections between resources
-	connections := discoverConnections(resAcc.workloads, resAcc.services, ps.logger)
+	ce := connectionExtractor{workloads: resAcc.workloads, services: resAcc.services, logger: ps.logger}
+	connections := ce.discoverConnections()
+
+	// If user specified a file with extra connections, add them too
+	if ps.connectionsFile != "" {
+		fileConns, err := ce.connectionsFromFile(ps.connectionsFile)
+		if err != nil {
+			fpErr := failedReadingFile(ps.connectionsFile, err)
+			return nil, nil, appendAndLogNewError(fileErrors, fpErr, ps.logger)
+		}
+		connections = slices.Concat(connections, fileConns)
+	}
 	return resAcc.workloads, connections, fileErrors
 }