adapter

Documentation

Index

• Constants
• Variables
• type ScannerAdapter

Constants

const (
	HarborVulnReportv1MimeType    = "application/vnd.scanner.adapter.vuln.report.harbor+json; version=1.0"
	RawVulnReportMimeType         = "application/vnd.scanner.adapter.vuln.report.raw+json"
	DockerImageMimeType           = "application/vnd.docker.distribution.manifest.v2+json"
	OciImageMimeType              = "application/vnd.oci.image.manifest.v1+json"
	HarborMetadataVulnDBUpdateKey = "harbor.scanner-adapter/vulnerability-database-updated-at"
	HarborMetadataScannerTypeKey  = "harbor.scanner-adapter/scanner-type"
	AdapterType                   = "os-package-vulnerability" // #nosec G101
	AdapterVendor                 = "Anchore Inc."
	AdapterName                   = "Anchore"
)

Variables

var (
	AdapterVersion  = "dev"
	AdapterMetadata = harbor.ScannerAdapterMetadata{
		Scanner: harbor.Scanner{
			Name:    AdapterName,
			Version: AdapterVersion,
			Vendor:  AdapterVendor,
		},
		Capabilities: []harbor.Capability{
			{
				ConsumesMIMETypes: []string{
					DockerImageMimeType,
					OciImageMimeType,
				},
				ProducesMIMETypes: []string{
					HarborVulnReportv1MimeType,
					RawVulnReportMimeType,
				},
			},
		},
		Properties: map[string]string{
			HarborMetadataVulnDBUpdateKey: "",
			HarborMetadataScannerTypeKey:  AdapterType,
		},
	}
)

Types

type ScannerAdapter

type ScannerAdapter interface {
	GetMetadata() (harbor.ScannerAdapterMetadata, error)
	Scan(req harbor.ScanRequest) (harbor.ScanResponse, error)
	GetHarborVulnerabilityReport(scanID string, includeDescriptions bool) (*harbor.VulnerabilityReport, error)
	GetRawVulnerabilityReport(scanID string) (harbor.RawReport, error)
}

ScannerAdapter defines methods for scanning container images.