kubeaudit

Documentation

Overview

Package kubeaudit wraps the kubeaudit library to provide a scanner.KubeScanner implementation for auditing Kubernetes resources against common security concerns.

Index

• Constants
• func AuditResult2Issue(auditResult *kubeauditpkg.AuditResult) *scanner.Issue
• func ConvertSeverity(level kubeauditpkg.SeverityLevel) scanner.IssueSeverityLevel
• func Default() (scanner.KubeScanner, error)
• func New(attentionLevel scanner.IssueSeverityLevel) (scanner.KubeScanner, error)
• func NewScanResult() scanner.ScanResult

Constants

const ScannerName = "KubeAudit"

ScannerName is the name of the scanner.

Functions

func AuditResult2Issue

func AuditResult2Issue(auditResult *kubeauditpkg.AuditResult) *scanner.Issue

AuditResult2Issue converts a kubeaudit.AuditResult to a scanner.Issue, which can be used to report security findings in a standardized format.

func ConvertSeverity

func ConvertSeverity(level kubeauditpkg.SeverityLevel) scanner.IssueSeverityLevel

ConvertSeverity translates a kubeaudit.SeverityLevel into a scanner.IssueSeverityLevel, which standardizes severity levels across different scanners.

func Default

func Default() (scanner.KubeScanner, error)

Default creates a default instance of a kubeaudit-based scanner with the default attention level.

func New

func New(attentionLevel scanner.IssueSeverityLevel) (scanner.KubeScanner, error)

New creates a new instance of a kubeaudit-based scanner with the specified attention level. The attentionLevel sets a threshold, and only issues that meet or exceed this threshold are included in the audit results. For example, if the attentionLevel is set to "Medium", then only issues classified at the "Medium" level or higher ("Medium", "High", "Critical") will be returned to the caller.

func NewScanResult

func NewScanResult() scanner.ScanResult

NewScanResult creates a new instance of scanResult.