scan

Documentation

Index

• type CheckFunc
• type Code
  • func (c *Code) IsCauseMultiline() bool
• type CodeOption
  • func OptionCodeWithDarkTheme() CodeOption
  • func OptionCodeWithHighlighted(include bool) CodeOption
  • func OptionCodeWithLightTheme() CodeOption
  • func OptionCodeWithMaxLines(lines int) CodeOption
  • func OptionCodeWithTheme(theme string) CodeOption
  • func OptionCodeWithTruncation(truncate bool) CodeOption
• type CustomChecks
• type EngineMetadata
• type FlatRange
• type FlatResult
• type Line
• type MetadataProvider
• type Result
  • func (r *Result) AbsolutePath(fsRoot string) string
  • func (r Result) Annotation() string
  • func (r Result) Description() string
  • func (r *Result) Flatten() FlatResult
  • func (r *Result) GetCode(opts ...CodeOption) (*Code, error)
  • func (r *Result) IsWarning() bool
  • func (r Result) Metadata() types.Metadata
  • func (r *Result) OverrideAnnotation(annotation string)
  • func (r *Result) OverrideDescription(description string)
  • func (r *Result) OverrideMetadata(metadata types.Metadata)
  • func (r *Result) OverrideSeverity(s severity.Severity)
  • func (r *Result) OverrideStatus(status Status)
  • func (r Result) Range() types.Range
  • func (r Result) RegoNamespace() string
  • func (r Result) RegoRule() string
  • func (r *Result) RelativePathTo(fsRoot string, to string) string
  • func (r Result) Rule() Rule
  • func (r *Result) SetRule(ru Rule)
  • func (r Result) Severity() severity.Severity
  • func (r Result) Status() Status
  • func (r Result) Traces() []string
• type Results
  • func (r *Results) Add(description string, source MetadataProvider)
  • func (r *Results) AddIgnored(source MetadataProvider, descriptions ...string)
  • func (r *Results) AddPassed(source MetadataProvider, descriptions ...string)
  • func (r *Results) AddPassedRego(namespace string, rule string, traces []string, source MetadataProvider)
  • func (r *Results) AddRego(description string, namespace string, rule string, traces []string, ...)
  • func (r Results) Flatten() []FlatResult
  • func (r *Results) GetFailed() Results
  • func (r *Results) GetIgnored() Results
  • func (r *Results) GetPassed() Results
  • func (r *Results) SetRule(rule Rule)
  • func (r *Results) SetSourceAndFilesystem(source string, f fs.FS, logicalSource bool)
• type Rule
  • func (r Rule) HasID(id string) bool
  • func (r Rule) LongID() string
  • func (r Rule) ServiceDisplayName() string
  • func (r Rule) ShortCodeDisplayName() string
• type Status
• type TerraformCustomCheck

Types

type CheckFunc

type CheckFunc func(s *state.State) (results Results)

type Code

type Code struct {
	Lines []Line
}

func (*Code) IsCauseMultiline

func (c *Code) IsCauseMultiline() bool

type CodeOption

type CodeOption func(*codeSettings)

func OptionCodeWithDarkTheme

func OptionCodeWithDarkTheme() CodeOption

func OptionCodeWithHighlighted

func OptionCodeWithHighlighted(include bool) CodeOption

func OptionCodeWithLightTheme

func OptionCodeWithLightTheme() CodeOption

func OptionCodeWithMaxLines

func OptionCodeWithMaxLines(lines int) CodeOption

func OptionCodeWithTheme

func OptionCodeWithTheme(theme string) CodeOption

func OptionCodeWithTruncation

func OptionCodeWithTruncation(truncate bool) CodeOption

type CustomChecks

type CustomChecks struct {
	Terraform *TerraformCustomCheck
}

type EngineMetadata

type EngineMetadata struct {
	GoodExamples        []string `json:"good_examples,omitempty"`
	BadExamples         []string `json:"bad_examples,omitempty"`
	RemediationMarkdown string   `json:"remediation_markdown,omitempty"`
	Links               []string `json:"links,omitempty"`
}

type FlatRange

type FlatRange struct {
	Filename  string `json:"filename"`
	StartLine int    `json:"start_line"`
	EndLine   int    `json:"end_line"`
}

type FlatResult

type FlatResult struct {
	RuleID          string             `json:"rule_id"`
	LongID          string             `json:"long_id"`
	RuleSummary     string             `json:"rule_description"`
	RuleProvider    providers.Provider `json:"rule_provider"`
	RuleService     string             `json:"rule_service"`
	Impact          string             `json:"impact"`
	Resolution      string             `json:"resolution"`
	Links           []string           `json:"links"`
	Description     string             `json:"description"`
	RangeAnnotation string             `json:"-"`
	Severity        severity.Severity  `json:"severity"`
	Warning         bool               `json:"warning"`
	Status          Status             `json:"status"`
	Resource        string             `json:"resource"`
	Location        FlatRange          `json:"location"`
}

type Line

type Line struct {
	Number      int    `json:"Number"`
	Content     string `json:"Content"`
	IsCause     bool   `json:"IsCause"`
	Annotation  string `json:"Annotation"`
	Truncated   bool   `json:"Truncated"`
	Highlighted string `json:"Highlighted,omitempty"`
	FirstCause  bool   `json:"FirstCause"`
	LastCause   bool   `json:"LastCause"`
}

type MetadataProvider

type MetadataProvider interface {
	GetMetadata() types.Metadata
	GetRawValue() interface{}
}

type Result

type Result struct {
	// contains filtered or unexported fields
}

func (*Result) AbsolutePath

func (r *Result) AbsolutePath(fsRoot string) string

func (Result) Annotation

func (r Result) Annotation() string

func (Result) Description

func (r Result) Description() string

func (*Result) Flatten

func (r *Result) Flatten() FlatResult

func (*Result) GetCode

func (r *Result) GetCode(opts ...CodeOption) (*Code, error)

nolint

func (*Result) IsWarning

func (r *Result) IsWarning() bool

func (Result) Metadata

func (r Result) Metadata() types.Metadata

func (*Result) OverrideAnnotation

func (r *Result) OverrideAnnotation(annotation string)

func (*Result) OverrideDescription

func (r *Result) OverrideDescription(description string)

func (*Result) OverrideMetadata

func (r *Result) OverrideMetadata(metadata types.Metadata)

func (*Result) OverrideSeverity

func (r *Result) OverrideSeverity(s severity.Severity)

func (*Result) OverrideStatus

func (r *Result) OverrideStatus(status Status)

func (Result) Range

func (r Result) Range() types.Range

func (Result) RegoNamespace

func (r Result) RegoNamespace() string

func (Result) RegoRule

func (r Result) RegoRule() string

func (*Result) RelativePathTo

func (r *Result) RelativePathTo(fsRoot string, to string) string

func (Result) Rule

func (r Result) Rule() Rule

func (*Result) SetRule

func (r *Result) SetRule(ru Rule)

func (Result) Severity

func (r Result) Severity() severity.Severity

func (Result) Status

func (r Result) Status() Status

func (Result) Traces

func (r Result) Traces() []string

type Results

type Results []Result

func (*Results) Add

func (r *Results) Add(description string, source MetadataProvider)

func (*Results) AddIgnored

func (r *Results) AddIgnored(source MetadataProvider, descriptions ...string)

func (*Results) AddPassed

func (r *Results) AddPassed(source MetadataProvider, descriptions ...string)

func (*Results) AddPassedRego

func (r *Results) AddPassedRego(namespace string, rule string, traces []string, source MetadataProvider)

func (*Results) AddRego

func (r *Results) AddRego(description string, namespace string, rule string, traces []string, source MetadataProvider)

func (Results) Flatten

func (r Results) Flatten() []FlatResult

func (*Results) GetFailed

func (r *Results) GetFailed() Results

func (*Results) GetIgnored

func (r *Results) GetIgnored() Results

func (*Results) GetPassed

func (r *Results) GetPassed() Results

func (*Results) SetRule

func (r *Results) SetRule(rule Rule)

func (*Results) SetSourceAndFilesystem

func (r *Results) SetSourceAndFilesystem(source string, f fs.FS, logicalSource bool)

type Rule

type Rule struct {
	AVDID          string                           `json:"avd_id"`
	Aliases        []string                         `json:"aliases"`
	ShortCode      string                           `json:"short_code"`
	Summary        string                           `json:"summary"`
	Explanation    string                           `json:"explanation"`
	Impact         string                           `json:"impact"`
	Resolution     string                           `json:"resolution"`
	Provider       providers.Provider               `json:"provider"`
	Service        string                           `json:"service"`
	Links          []string                         `json:"links"`
	Severity       severity.Severity                `json:"severity"`
	Terraform      *EngineMetadata                  `json:"terraform,omitempty"`
	CloudFormation *EngineMetadata                  `json:"cloud_formation,omitempty"`
	CustomChecks   CustomChecks                     `json:"-"`
	RegoPackage    string                           `json:"-"`
	Frameworks     map[framework.Framework][]string `json:"frameworks"`
}

func (Rule) HasID

func (r Rule) HasID(id string) bool

func (Rule) LongID

func (r Rule) LongID() string

func (Rule) ServiceDisplayName

func (r Rule) ServiceDisplayName() string

func (Rule) ShortCodeDisplayName

func (r Rule) ShortCodeDisplayName() string

type Status

type Status uint8

const (
	StatusFailed Status = iota
	StatusPassed
	StatusIgnored
)

type TerraformCustomCheck

type TerraformCustomCheck struct {
	RequiredTypes   []string
	RequiredLabels  []string
	RequiredSources []string
	Check           func(*terraform.Block, *terraform.Module) Results
}