plugin

Documentation

Overview

Package plugin collects the common code used by extractor and detector plugins.

Index

• type Plugin
• type ScanStatus
  • func (s *ScanStatus) String() string
• type ScanStatusEnum
• type Status
  • func StatusFromErr(p Plugin, partial bool, err error) *Status

Types

type Plugin

type Plugin interface {
	// A unique name used to identify this plugin.
	Name() string
	// Plugin version, should get bumped whenever major changes are made.
	Version() int
}

Plugin is the part of the plugin interface that's shared between extractors and detectors.

type ScanStatus

type ScanStatus struct {
	Status        ScanStatusEnum
	FailureReason string
}

ScanStatus is the status of a scan run. In case the scan fails, FailureReason contains details.

func (*ScanStatus) String

func (s *ScanStatus) String() string

String returns a string representation of the scan status.

type ScanStatusEnum

type ScanStatusEnum int

ScanStatusEnum is the enum for the scan status.

const (
	ScanStatusUnspecified ScanStatusEnum = iota
	ScanStatusSucceeded
	ScanStatusPartiallySucceeded
	ScanStatusFailed
)

ScanStatusEnum values.

type Status

type Status struct {
	Name    string
	Version int
	Status  *ScanStatus
}

Status contains the status and version of the inventory+vuln plugins that ran.

func StatusFromErr

func StatusFromErr(p Plugin, partial bool, err error) *Status

StatusFromErr returns a successful or failed plugin scan status for a given plugin based on an error.