docker_check.go

// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016-present Datadog, Inc.

package checks

import (
	"context"
	"fmt"
	"strings"

	"github.com/StackVista/stackstate-agent/pkg/compliance"
	"github.com/StackVista/stackstate-agent/pkg/compliance/checks/env"
	"github.com/StackVista/stackstate-agent/pkg/compliance/eval"
	"github.com/StackVista/stackstate-agent/pkg/util/log"
	"github.com/docker/docker/api/types"
)

var (
	dockerReportedFields = []string{
		compliance.DockerImageFieldID,
		compliance.DockerImageFieldTags,
		compliance.DockerContainerFieldID,
		compliance.DockerContainerFieldName,
		compliance.DockerContainerFieldImage,
		compliance.DockerNetworkFieldName,
		compliance.DockerVersionFieldVersion,
	}
)

type dockerImage struct {
	eval.Instance
	summary *types.ImageSummary
}

func (im *dockerImage) ID() string {
	return strings.TrimPrefix(im.summary.ID, "sha256:")
}

func (im *dockerImage) Type() string {
	return "docker_image"
}

type dockerContainer struct {
	eval.Instance
	container *types.Container
}

func (c *dockerContainer) ID() string {
	return c.container.ID
}

func (c *dockerContainer) Type() string {
	return "docker_container"
}

type dockerNetwork struct {
	eval.Instance
	network *types.NetworkResource
}

func (n *dockerNetwork) ID() string {
	return n.network.ID
}

func (n *dockerNetwork) Type() string {
	return "docker_network"
}

func dockerKindNotSupported(kind string) error {
	return fmt.Errorf("unsupported docker object kind '%s'", kind)
}

func resolveDocker(ctx context.Context, e env.Env, ruleID string, res compliance.ResourceCommon, rego bool) (resolved, error) {
	if res.Docker == nil {
		return nil, fmt.Errorf("expecting docker resource in docker check")
	}

	client := e.DockerClient()
	if client == nil {
		return nil, fmt.Errorf("docker client not configured")
	}

	var (
		iterator eval.Iterator
		instance eval.Instance
		err      error
	)

	switch res.Docker.Kind {
	case "image":
		if iterator, err = newDockerImageIterator(ctx, client); err == nil {
			return newResolvedIterator(iterator), nil
		}
	case "container":
		if iterator, err = newDockerContainerIterator(ctx, client); err == nil {
			return newResolvedIterator(iterator), nil
		}
	case "network":
		if iterator, err = newDockerNetworkIterator(ctx, client); err == nil {
			return newResolvedIterator(iterator), nil
		}
	case "info":
		if instance, err = newDockerInfoInstance(ctx, client); err == nil {
			return newResolvedInstance(instance, "daemon", "docker_daemon"), nil
		}
	case "version":
		if instance, err = newDockerVersionInstance(ctx, client); err == nil {
			return newResolvedInstance(instance, "daemon", "docker_daemon"), nil
		}
	default:
		return nil, dockerKindNotSupported(res.Docker.Kind)
	}

	return nil, err
}

func newDockerInfoInstance(ctx context.Context, client env.DockerClient) (eval.Instance, error) {
	info, err := client.Info(ctx)
	if err != nil {
		return nil, err
	}

	return eval.NewInstance(
		eval.VarMap{
			compliance.DockerInfoInspect: info,
		},
		eval.FunctionMap{
			compliance.DockerFuncTemplate: dockerTemplateQuery(compliance.DockerFuncTemplate, info),
		},
		eval.RegoInputMap{
			"inspect": info,
		},
	), nil
}

func newDockerVersionInstance(ctx context.Context, client env.DockerClient) (eval.Instance, error) {
	version, err := client.ServerVersion(ctx)
	if err != nil {
		return nil, err
	}

	return eval.NewInstance(
		eval.VarMap{
			compliance.DockerVersionFieldVersion:       version.Version,
			compliance.DockerVersionFieldAPIVersion:    version.APIVersion,
			compliance.DockerVersionFieldPlatform:      version.Platform.Name,
			compliance.DockerVersionFieldExperimental:  version.Experimental,
			compliance.DockerVersionFieldOS:            version.Os,
			compliance.DockerVersionFieldArch:          version.Arch,
			compliance.DokcerVersionFieldKernelVersion: version.KernelVersion,
		},
		eval.FunctionMap{
			compliance.DockerFuncTemplate: dockerTemplateQuery(compliance.DockerFuncTemplate, version),
		},
		eval.RegoInputMap{
			"version":       version.Version,
			"apiVersion":    version.APIVersion,
			"platform":      version.Platform.Name,
			"experimental":  version.Experimental,
			"os":            version.Os,
			"arch":          version.Arch,
			"kernelVersion": version.KernelVersion,
		},
	), nil
}

func dockerTemplateQuery(funcName, obj interface{}) eval.Function {
	return func(_ eval.Instance, args ...interface{}) (interface{}, error) {
		if len(args) != 1 {
			return nil, fmt.Errorf(`invalid number of arguments in "%s()", expecting 1 got %d`, funcName, len(args))
		}

		query, ok := args[0].(string)
		if !ok {
			return nil, fmt.Errorf(`expecting string value for query argument in "%s()"`, funcName)
		}

		v := evalGoTemplate(query, obj)
		log.Tracef(`template query in "%s(%q)" evaluated as %q`, funcName, query, v)
		return v, nil
	}
}

type dockerImageIterator struct {
	ctx    context.Context
	client env.DockerClient
	images []types.ImageSummary
	index  int
}

func newDockerImageIterator(ctx context.Context, client env.DockerClient) (eval.Iterator, error) {
	images, err := client.ImageList(ctx, types.ImageListOptions{All: true})
	if err != nil {
		return nil, err
	}

	return &dockerImageIterator{
		ctx:    ctx,
		client: client,
		images: images,
	}, nil
}

func (it *dockerImageIterator) Next() (eval.Instance, error) {
	if it.Done() {
		return nil, ErrInvalidIteration
	}

	image := it.images[it.index]

	imageInspect, _, err := it.client.ImageInspectWithRaw(it.ctx, image.ID)
	if err != nil {
		return nil, log.Errorf("failed to inspect image %s", image.ID)
	}

	it.index++

	return &dockerImage{
		Instance: eval.NewInstance(
			eval.VarMap{
				compliance.DockerImageFieldID:   image.ID,
				compliance.DockerImageFieldTags: imageInspect.RepoTags,
				compliance.DockerImageInspect:   imageInspect,
			},
			eval.FunctionMap{
				compliance.DockerFuncTemplate: dockerTemplateQuery(compliance.DockerFuncTemplate, imageInspect),
			},
			eval.RegoInputMap{
				"id":      image.ID,
				"tags":    imageInspect.RepoTags,
				"inspect": imageInspect,
			},
		),
		summary: &image,
	}, nil
}

func (it *dockerImageIterator) Done() bool {
	return it.index >= len(it.images)
}

type dockerContainerIterator struct {
	ctx        context.Context
	client     env.DockerClient
	containers []types.Container
	index      int
}

func newDockerContainerIterator(ctx context.Context, client env.DockerClient) (eval.Iterator, error) {
	containers, err := client.ContainerList(ctx, types.ContainerListOptions{All: true})
	if err != nil {
		return nil, err
	}

	return &dockerContainerIterator{
		ctx:        ctx,
		client:     client,
		containers: containers,
	}, nil
}

func (it *dockerContainerIterator) Next() (eval.Instance, error) {
	if it.Done() {
		return nil, ErrInvalidIteration
	}

	container := it.containers[it.index]

	containerInspect, err := it.client.ContainerInspect(it.ctx, container.ID)
	if err != nil {
		return nil, log.Errorf("failed to inspect container %s", container.ID)
	}

	it.index++

	return &dockerContainer{
		Instance: eval.NewInstance(
			eval.VarMap{
				compliance.DockerContainerFieldID:    container.ID,
				compliance.DockerContainerFieldName:  containerInspect.Name,
				compliance.DockerContainerFieldImage: containerInspect.Image,
				compliance.DockerContainerInspect:    containerInspect,
			},
			eval.FunctionMap{
				compliance.DockerFuncTemplate: dockerTemplateQuery(compliance.DockerFuncTemplate, containerInspect),
			},
			eval.RegoInputMap{
				"id":      container.ID,
				"name":    containerInspect.Name,
				"image":   containerInspect.Image,
				"inspect": containerInspect,
			},
		),
		container: &container,
	}, nil
}

func (it *dockerContainerIterator) Done() bool {
	return it.index >= len(it.containers)
}

type dockerNetworkIterator struct {
	ctx      context.Context
	client   env.DockerClient
	networks []types.NetworkResource
	index    int
}

func newDockerNetworkIterator(ctx context.Context, client env.DockerClient) (eval.Iterator, error) {
	networks, err := client.NetworkList(ctx, types.NetworkListOptions{})
	if err != nil {
		return nil, err
	}

	return &dockerNetworkIterator{
		ctx:      ctx,
		client:   client,
		networks: networks,
	}, nil
}

func (it *dockerNetworkIterator) Next() (eval.Instance, error) {
	if it.Done() {
		return nil, ErrInvalidIteration
	}

	network := it.networks[it.index]

	it.index++

	return &dockerNetwork{
		Instance: eval.NewInstance(
			eval.VarMap{
				compliance.DockerNetworkFieldID:      network.ID,
				compliance.DockerNetworkFieldName:    network.Name,
				compliance.DockerNetworkFieldInspect: network,
			},
			eval.FunctionMap{
				compliance.DockerFuncTemplate: dockerTemplateQuery(compliance.DockerFuncTemplate, network),
			},
			eval.RegoInputMap{
				"id":      network.ID,
				"name":    network.Name,
				"inspect": network,
			},
		),
		network: &network,
	}, nil
}

func (it *dockerNetworkIterator) Done() bool {
	return it.index >= len(it.networks)
}