scan

package
v0.55.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 9, 2022 License: MIT Imports: 13 Imported by: 219

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckFunc 

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

type Code added in v0.51.0 

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

func (*Code) IsCauseMultiline added in v0.51.0 

func (c *Code) IsCauseMultiline() bool

func (*Code) Lines added in v0.51.0 

func (c *Code) Lines() []Line

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 added in v0.51.0 

type Line struct {
	Number      int
	Content     string
	IsCause     bool
	Annotation  string
	Truncated   bool
	Highlighted string
	FirstCause  bool
	LastCause   bool
}

type MetadataProvider 

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

type Result 

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

func (*Result) AbsolutePath added in v0.52.0 

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 added in v0.51.0 

func (r *Result) GetCode(enableHighlighting bool) (*Code, error)

nolint

func (*Result) IsWarning added in v0.38.0 

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 added in v0.52.0 

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 added in v0.39.0 

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 added in v0.47.1 

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)

type Rule 

type Rule struct {
	AVDID          string             `json:"avd_id"`
	LegacyID       string             `json:"id"`
	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:"-"`
}

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
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.