main.go

package main

import (
	"bufio"
	"context"
	"flag"
	"fmt"
	"os"
	"path/filepath"
	"strconv"
	"strings"
	"text/tabwriter"

	"github.com/spf13/pflag"

	"github.com/cheggaaa/pb/v3"

	appsv1 "k8s.io/api/apps/v1"
	batchv1 "k8s.io/api/batch/v1"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	utilerrors "k8s.io/apimachinery/pkg/util/errors"
	"k8s.io/cli-runtime/pkg/genericclioptions"
	"k8s.io/client-go/kubernetes"
	"k8s.io/klog/v2"

	_ "k8s.io/client-go/plugin/pkg/client/auth"
)

var (
	version = "development"
)

func main() {

	klog.InitFlags(nil)

	var sockFound bool
	var err error
	// flags
	requestedNamespace := pflag.StringP("namespace", "n", "ALL", "Namespace to search for pods")
	requestedPath := pflag.StringP("filename", "f", "", "File or directory to scan")
	progressBar := pflag.BoolP("progress", "p", false, "Show a progress bar when scanning")
	help := pflag.BoolP("help", "h", false, "Print usage")
	exitErr := pflag.BoolP("exit-with-error", "e", false, "Exit with error code if docker.sock found")
	verbose := pflag.IntP("verbose", "v", 2, "Logging level")
	printVersion := pflag.Bool("version", false, "Print plugin version and exit")

	pflag.Parse()

	flag.Set("v", strconv.Itoa(*verbose))
	if *help {
		pflag.PrintDefaults()
		os.Exit(0)
	}

	if *printVersion {
		fmt.Println(version)
		os.Exit(0)
	}

	// initialize tabwriter
	w := new(tabwriter.Writer)

	// minwidth, tabwidth, padding, padchar, flags
	w.Init(os.Stdout, 8, 8, 1, '\t', 0)

	defer w.Flush()

	// only scan local files if -f is provided
	if len(*requestedPath) > 0 {
		sockFound, err = runFiles(*requestedPath, w, *verbose, *progressBar)
	} else {
		// run against a live cluster
		sockFound, err = runCluster(*requestedNamespace, w, *verbose, *progressBar)
	}
	if err != nil {
		fmt.Fprintf(os.Stderr, "error: %v\n", err)
		fmt.Fprintln(os.Stderr, "Warning: The following table may be incomplete due to errors detected during the run")
		w.Flush()
		os.Exit(1)
	}
	if *exitErr && sockFound {
		w.Flush()
		os.Exit(1)
	}
}

func runFiles(requestedPath string, w *tabwriter.Writer, verbose int, progressBar bool) (bool, error) {
	// run against local files

	var files []string
	fmt.Fprintf(w, "%s\t%s\t%s\t\n", "FILE", "LINE", "STATUS")

	fileInfo, err := os.Stat(requestedPath)
	if err != nil {
		return false, fmt.Errorf("unable to open file: %v\n", requestedPath)
	}

	if fileInfo.IsDir() {
		err = filepath.Walk(requestedPath, func(path string, info os.FileInfo, err error) error {
			pathInfo, err := os.Stat(path)
			if !pathInfo.IsDir() {
				files = append(files, path)
			}
			return nil
		})
		if err != nil {
			fmt.Printf("something went wrong")
			return false, err
		}

	} else {
		// filePath is a regular file
		files = append(files, requestedPath)
	}

	sockFound, err := printFiles(w, files, verbose, progressBar)

	return sockFound, err
}

func runCluster(requestedNamespace string, w *tabwriter.Writer, verbose int, progressBar bool) (bool, error) {

	var sockFound bool
	// append true or false for each namespace to report accurate value if docker.sock is found
	sockFoundNamespaces := make([]bool, 0)
	// setup kubeconfig client
	configFlags := genericclioptions.NewConfigFlags(true).WithDiscoveryBurst(300).WithDiscoveryQPS(50.0)
	kubeConfig, err := configFlags.ToRESTConfig()
	if err != nil {
		return sockFound, fmt.Errorf("error loading kubeconfig: %v", err)
	}
	clientset := kubernetes.NewForConfigOrDie(kubeConfig)

	// Column headers for live cluster scan
	fmt.Fprintf(w, "%s\t%s\t%s\t%s\t\n", "NAMESPACE", "TYPE", "NAME", "STATUS")

	if requestedNamespace != "ALL" {
		if verbose > 3 {
			fmt.Printf("user specified namespace: %s\n", requestedNamespace)
		}
		namespace, err := clientset.CoreV1().Namespaces().Get(context.Background(), requestedNamespace, metav1.GetOptions{})
		if err != nil {
			return sockFound, fmt.Errorf("unable to fetch namespace %q: %v", requestedNamespace, err)
		}
		return printResources(*namespace, clientset, w, verbose)
	} else {
		namespaceList, err := clientset.CoreV1().Namespaces().List(context.Background(), metav1.ListOptions{})
		if err != nil {
			return sockFound, fmt.Errorf("unable to list namespaces: %v", err)
		}

		namespaceErrors := make([]error, 0)
		numberNamespaces := len(namespaceList.Items)
		pbar := pb.New(numberNamespaces)
		// loop through each namespace
		if progressBar {
			fmt.Printf("scanning %d namespaces: \n", numberNamespaces)
			pbar.Start()
		}
		for _, namespace := range namespaceList.Items {
			sockFound, err := printResources(namespace, clientset, w, verbose)
			if err != nil {
				namespaceErrors = append(namespaceErrors, err)
			}
			sockFoundNamespaces = append(sockFoundNamespaces, sockFound)
			if progressBar {
				pbar.Increment()
			}
		}
		if progressBar {
			pbar.Finish()
		}
		if len(namespaceErrors) > 0 {
			return sockFound, utilerrors.NewAggregate(namespaceErrors)
		}
	}
	return containsTrue(sockFoundNamespaces), nil
}

func printResources(namespace corev1.Namespace, clientset *kubernetes.Clientset, w *tabwriter.Writer, verbose int) (bool, error) {

	sockFound := false

	namespaceName := namespace.ObjectMeta.Name

	nsReplicasets := make(map[string]*appsv1.ReplicaSet)
	nsDeployments := make(map[string]*appsv1.Deployment)
	nsDaemonsets := make(map[string]*appsv1.DaemonSet)
	nsStatefulsets := make(map[string]*appsv1.StatefulSet)
	nsJobs := make(map[string]*batchv1.Job)
	nsCronJobs := make(map[string]*batchv1.CronJob)

	// Get a list of all pods in the namespace
	podList, err := clientset.CoreV1().Pods(namespaceName).List(context.Background(), metav1.ListOptions{})
	if err != nil {
		return false, fmt.Errorf("unable to fetch pods: %v", err)
	}

	errorList := make([]error, 0)
	// loop through each pod
	for _, p := range podList.Items {
		// print object
		// fmt.Printf("%+v\n", p.ObjectMeta.OwnerReferences)

		// only look at pods that have volumes
		if len(p.Spec.Volumes) != 0 {
			// fmt.Printf("%T\n", p.ObjectMeta.OwnerReferences)

			// true if pod has an owner (eg deployment, daemonset, job)
			if len(p.ObjectMeta.OwnerReferences) != 0 {
				podOwner := p.OwnerReferences[0].Name

				// Supported owner types are
				// ReplicaSet (looks up deployment)
				// DaemonSet
				// StatefulSet
				// ...
				switch p.ObjectMeta.OwnerReferences[0].Kind {
				case "ReplicaSet":
					replica, rsErr := clientset.AppsV1().ReplicaSets(namespace.Name).Get(context.TODO(), podOwner, metav1.GetOptions{})
					if rsErr != nil {
						errorList = append(errorList, rsErr)
						continue
					}

					if len(replica.OwnerReferences) == 0 {
						nsReplicasets[replica.Name] = replica
						continue
					}

					deployment, deployErr := clientset.AppsV1().Deployments(namespace.Name).Get(context.TODO(), replica.OwnerReferences[0].Name, metav1.GetOptions{})
					if deployErr != nil {
						errorList = append(errorList, deployErr)
						continue
					}

					// append the current deployment to look up later
					// only append if it's not already in the list
					if _, ok := nsDeployments[deployment.Name]; !ok {
						nsDeployments[deployment.Name] = deployment
					}
				case "DaemonSet":
					daemonset, dsErr := clientset.AppsV1().DaemonSets(namespace.Name).Get(context.TODO(), podOwner, metav1.GetOptions{})
					if dsErr != nil {
						errorList = append(errorList, dsErr)
						continue
					}

					// append the current daemonset to look up later
					if _, ok := nsDaemonsets[daemonset.Name]; !ok {
						nsDaemonsets[daemonset.Name] = daemonset
					}
				case "StatefulSet":
					statefulset, ssErr := clientset.AppsV1().StatefulSets(namespace.Name).Get(context.TODO(), podOwner, metav1.GetOptions{})
					if ssErr != nil {
						errorList = append(errorList, ssErr)
						continue
					}

					// append the current StatefulSet to look up later
					if _, ok := nsStatefulsets[statefulset.Name]; !ok {
						nsStatefulsets[statefulset.Name] = statefulset
					}
				case "Node":
					// skip pods with owner type node because they're static pods
					continue
				case "Job":
					job, jobErr := clientset.BatchV1().Jobs(namespace.Name).Get(context.TODO(), podOwner, metav1.GetOptions{})
					if jobErr != nil {
						errorList = append(errorList, jobErr)
						continue
					}

					// check if the job has an owner, and that it is of kind `CronJob`
					if len(job.ObjectMeta.OwnerReferences) == 0 || job.ObjectMeta.OwnerReferences[0].Kind != "CronJob" {
						if _, ok := nsJobs[job.Name]; !ok {
							nsJobs[job.Name] = job
						}
					} else {
						// append to cronjob
						cron, cronErr := clientset.BatchV1().CronJobs(namespace.Name).Get(context.TODO(), job.OwnerReferences[0].Name, metav1.GetOptions{})
						if cronErr != nil {
							errorList = append(errorList, cronErr)
							continue
						}

						if _, ok := nsCronJobs[cron.Name]; !ok {
							nsCronJobs[cron.Name] = cron
						}
					}

				default:
					// this prints for pods that say they have an owner but the owner doesn't exist
					// happens with vcluster clusters and maybe other situations.
					fmt.Printf("could not find resource manager for type %s for pod %s\n", p.OwnerReferences[0].Kind, p.Name)
					found := printVolumes(w, p.Spec.Volumes, namespaceName, "pod", p.Name, verbose)
					if found {
						sockFound = true
					}
					continue
				}
			} else {
				// Look up raw pods for volumes here
				found := printVolumes(w, p.Spec.Volumes, namespaceName, "pod", p.Name, verbose)
				if found {
					sockFound = true
				}
			}
		}
	}

	// loop through all the unique ReplicaSets in the namespace
	for _, replica := range nsReplicasets {
		found := printVolumes(w, replica.Spec.Template.Spec.Volumes, namespaceName, "replicaset", replica.Name, verbose)
		if found {
			sockFound = true
		}
	}

	// loop through all the unique deployments we found for volumes
	for _, deploy := range nsDeployments {
		found := printVolumes(w, deploy.Spec.Template.Spec.Volumes, namespaceName, "deployment", deploy.Name, verbose)
		if found {
			sockFound = true
		}
	}

	// loop through all the unique DaemonSets in the namespace
	for _, daemonset := range nsDaemonsets {
		volumeCounter := 0
		for _, v := range daemonset.Spec.Template.Spec.Volumes {
			if v.VolumeSource.HostPath != nil {
				// fmt.Printf("testing %s\n", v.VolumeSource.HostPath.Path)
				if containsDockerSock(v.VolumeSource.HostPath.Path) {
					fmt.Fprintf(w, "%s\t%s\t%s\t%s\t\n", namespaceName, "daemonset", daemonset.Name, "mounted")
					sockFound = true
					break
				}
			}
			volumeCounter++
			if volumeCounter == len(daemonset.Spec.Template.Spec.Volumes) && verbose > 3 {
				fmt.Fprintf(w, "%s\t%s\t%s\t%s\t\n", namespaceName, "daemonset", daemonset.Name, "not-mounted")
			}
		}
	}

	// loop through all the unique StatefulSets in the namespace
	for _, statefulset := range nsStatefulsets {
		found := printVolumes(w, statefulset.Spec.Template.Spec.Volumes, namespaceName, "statefulset", statefulset.Name, verbose)
		if found {
			sockFound = true
		}
	}

	// loop through all the unique Jobs in the namespace
	for _, job := range nsJobs {
		found := printVolumes(w, job.Spec.Template.Spec.Volumes, namespaceName, "job", job.Name, verbose)
		if found {
			sockFound = true
		}
	}

	// loop through all the unique CronJobs in the namespace
	for _, cron := range nsCronJobs {
		found := printVolumes(w, cron.Spec.JobTemplate.Spec.Template.Spec.Volumes, namespaceName, "cron", cron.Name, verbose)
		if found {
			sockFound = true
		}
	}

	if len(errorList) > 0 {
		return false, utilerrors.NewAggregate(errorList)
	}
	return sockFound, nil
}

func containsDockerSock(s string) bool {
	if strings.Contains(s, "docker.sock") || strings.Contains(s, "dockershim.sock") {
		return true
	} else {
		return false
	}
}

func printVolumes(w *tabwriter.Writer, volumes []corev1.Volume, namespace, resType, resName string, verbose int) bool {
	// initialize sockFound to use for exit code
	sockFound := false
	for _, v := range volumes {
		if v.VolumeSource.HostPath != nil {
			mounted := "not-mounted"
			if containsDockerSock(v.VolumeSource.HostPath.Path) {
				mounted = "mounted"
				sockFound = true
			}
			if mounted == "mounted" || verbose > 3 {
				fmt.Fprintf(w, "%s\t%s\t%s\t%s\t\n", namespace, resType, resName, mounted)
			}
		}
	}
	return sockFound
}

func printFiles(w *tabwriter.Writer, filePaths []string, verbose int, progressBar bool) (bool, error) {
	// initialize sockFound to use for exit code
	sockFound := false
	// print output for scanning local manifest files
	numberFilePaths := len(filePaths)
	pbar := pb.New(numberFilePaths)
	if progressBar {
		fmt.Printf("Scanning %d files for docker.sock mounts", numberFilePaths)
		pbar.Start()
	}
	for _, file := range filePaths {
		mounted := "not-mounted"
		line, err := searchFile(file)
		if err != nil {
			return sockFound, err
		}
		if line > 0 {
			mounted = "mounted"
			sockFound = true
		}
		if mounted == "mounted" || verbose > 3 {
			fmt.Fprintf(w, "%s\t%v\t%s\t\n", file, line, mounted)
		}
		if progressBar {
			pbar.Increment()
		}
	}
	if progressBar {
		pbar.Finish()
	}
	return sockFound, nil
}

func searchFile(path string) (int, error) {
	// search each file line by line for docker.sock
	// return line first number matching and potenial error
	f, err := os.Open(path)
	if err != nil {
		return 0, err
	}
	defer f.Close()

	// Splits on newlines by default.
	scanner := bufio.NewScanner(f)

	line := 1
	for scanner.Scan() {
		if containsDockerSock(scanner.Text()) {
			return line, nil
		}

		line++
	}
	return 0, nil
}

// utility function to find if a slice contains a true bool
func containsTrue(elems []bool) bool {
	for _, s := range elems {
		if s {
			return true
		}
	}
	return false
}