cmd

Documentation

Index

• Constants
• type ImageInspectorOptions
  • func NewDefaultImageInspectorOptions() *ImageInspectorOptions
  • func (i *ImageInspectorOptions) Validate() error
• type MultiStringVar
  • func (sv *MultiStringVar) Set(s string) error
  • func (sv *MultiStringVar) String() string

Constants

const DefaultDockerSocketLocation = "unix:///var/run/docker.sock"

Types

type ImageInspectorOptions

type ImageInspectorOptions struct {
	// URI contains the location of the docker daemon socket to connect to.
	URI string
	// Image contains the docker image to inspect.
	Image string
	// Container contains the docker container to inspect.
	Container string
	// ScanContainerChanges controls whether or not whole rootfs will be scanned.
	ScanContainerChanges bool
	// DstPath is the destination path for image files.
	DstPath string
	// Serve holds the host and port for where to serve the image with webdav.
	Serve string
	// Chroot controls whether or not a chroot is excuted when serving the image with webdav.
	Chroot bool
	// DockerCfg is the location of the docker config file.
	DockerCfg MultiStringVar
	// Username is the username for authenticating to the docker registry.
	Username string
	// PasswordFile is the location of the file containing the password for authentication to the
	// docker registry.
	PasswordFile string
	// ScanType is the type of the scan to be done on the inspected image
	ScanType string
	// ScanResultsDir is the directory that will contain the results of the scan
	ScanResultsDir string
	// OpenScapHTML controls whether or not to generate an HTML report
	// TODO: Move this into openscap plugin options.
	OpenScapHTML bool
	// CVEUrlPath An alternative source for the cve files
	// TODO: Move this into openscap plugin options.
	CVEUrlPath string
	// ClamSocket is the location of clamav socket file
	ClamSocket string
	// PostResultURL represents an URL where the image-inspector should post the results of
	// the scan.
	PostResultURL string
	// PostResultTokenFile if specified the content of the file will be added as a token to
	// the result POST URL (eg. http://foo/?token=CONTENT.
	PostResultTokenFile string
	// AuthToken is a Shared Secret used to validate HTTP Requests.
	// AuthToken can be set through AuthTokenFile or ENV
	AuthToken string
	// AuthTokenFile is the path to a file containing the AuthToken
	// If it is not provided, the AuthToken will be read from the ENV
	AuthTokenFile string
	// PullPolicy controls whether we try to pull the inspected image
	PullPolicy string
}

ImageInspectorOptions is the main inspector implementation and holds the configuration for an image inspector.

func NewDefaultImageInspectorOptions

func NewDefaultImageInspectorOptions() *ImageInspectorOptions

NewDefaultImageInspectorOptions provides a new ImageInspectorOptions with default values.

func (*ImageInspectorOptions) Validate

func (i *ImageInspectorOptions) Validate() error

Validate performs validation on the field settings.

type MultiStringVar

type MultiStringVar struct {
	Values []string
}

MultiStringVar is implementing flag.Value

func (*MultiStringVar) Set

func (sv *MultiStringVar) Set(s string) error

func (*MultiStringVar) String

func (sv *MultiStringVar) String() string