cloudformation

Documentation

Index

• func OptionIncludeIgnored() func(s *Scanner)
• func OptionIncludePassed() func(s *Scanner)
• func OptionWithDataDirs(dirs ...string) func(s *Scanner)
• func OptionWithDebug(debugWriter io.Writer) func(s *Scanner)
• func OptionWithExcludedIDs(exludedIDs []string) func(s *Scanner)
• func OptionWithPolicyDirs(dirs ...string) func(s *Scanner)
• func OptionWithPolicyNamespaces(namespaces ...string) func(s *Scanner)
• type Ignore
• type Option
  • func OptionWithParser(parser *parser.Parser) Option
  • func OptionWithTrace(w io.Writer) Option
• type Scanner
  • func New(options ...Option) *Scanner
  • func (s *Scanner) ScanFS(ctx context.Context, fs fs.FS, dir string) (results scan.Results, err error)
  • func (s *Scanner) ScanFile(ctx context.Context, fs fs.FS, path string) (scan.Results, error)

Functions

func OptionIncludeIgnored

func OptionIncludeIgnored() func(s *Scanner)

OptionIncludeIgnored - tell the scanner to include results that would otherwise be ignored

func OptionIncludePassed

func OptionIncludePassed() func(s *Scanner)

OptionIncludePassed - tell the scanner to include results for passes checks

func OptionWithDataDirs

func OptionWithDataDirs(dirs ...string) func(s *Scanner)

OptionWithDataDirs - location of rego data directories

func OptionWithDebug

func OptionWithDebug(debugWriter io.Writer) func(s *Scanner)

OptionWithDebug - pass the scanner an io.Writer to log debug messages to

func OptionWithExcludedIDs

func OptionWithExcludedIDs(exludedIDs []string) func(s *Scanner)

OptionWithExcludedIDs - tell the scanner to exclude the provided IDs

func OptionWithPolicyDirs

func OptionWithPolicyDirs(dirs ...string) func(s *Scanner)

OptionWithPolicyDirs - location of rego policy directories - policies are loaded recursively

func OptionWithPolicyNamespaces

func OptionWithPolicyNamespaces(namespaces ...string) func(s *Scanner)

OptionWithPolicyNamespaces - namespaces which indicate rego policies containing enforced rules

Types

type Ignore

type Ignore struct {
	RuleID string
	Expiry *time.Time
}

type Option

type Option func(s *Scanner)

Option - scanner options for passing arguments into the scanner

func OptionWithParser

func OptionWithParser(parser *parser.Parser) Option

func OptionWithTrace

func OptionWithTrace(w io.Writer) Option

type Scanner

type Scanner struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func New

func New(options ...Option) *Scanner

New creates a new Scanner

func (*Scanner) ScanFS

func (s *Scanner) ScanFS(ctx context.Context, fs fs.FS, dir string) (results scan.Results, err error)

func (*Scanner) ScanFile

func (s *Scanner) ScanFile(ctx context.Context, fs fs.FS, path string) (scan.Results, error)