metadata

Documentation

Index

• Constants
• Variables

Constants

const (
	// AnalyzerVendor is the vendor/maintainer of the analyzer
	AnalyzerVendor = "GitLab"

	// AnalyzerID identifies the analyzer
	AnalyzerID = AnalyzerName

	// AnalyzerName is the name of the analyzer
	AnalyzerName = "secrets"

	// Type returns the type of the scan
	Type report.Category = report.CategorySecretDetection
)

Variables

var (
	// AnalyzerVersion is a placeholder value which the Dockerfile will dynamically
	// overwrite at build time with the most recent version from the CHANGELOG.md file
	AnalyzerVersion = "not-configured"

	// ScannerVersion is the semantic version of the scanner and is defined in the Dockerfile
	ScannerVersion = os.Getenv("SCANNER_VERSION")

	// AnalyzerDetails provides information about the analyzer itself.
	// It corresponds with the `analyzer` field on the security report.
	AnalyzerDetails = report.ScannerDetails{
		ID:   AnalyzerID,
		Name: AnalyzerName,
		URL:  analyzerURL,
		Vendor: report.Vendor{
			Name: AnalyzerVendor,
		},
		Version: AnalyzerVersion,
	}

	// IssueScanner describes the scanner used to find a vulnerability
	IssueScanner = report.Scanner{
		ID:   scannerID,
		Name: scannerName,
	}

	// ReportScanner returns identifying information about a security scanner
	ReportScanner = report.ScannerDetails{
		ID:      scannerID,
		Name:    scannerName,
		Version: ScannerVersion,
		Vendor: report.Vendor{
			Name: scannerVendor,
		},
		URL: scannerURL,
	}

	// AnalyzerUsage provides a one line usage string for the analyzer
	AnalyzerUsage = fmt.Sprintf("%s %s analyzer v%s", AnalyzerVendor, AnalyzerName, AnalyzerVersion)
)