Documentation ¶
Overview ¶
Package gosec holds the central scanning logic used by gosec security scanner
Index ¶
- Constants
- func ConcatString(n *ast.BinaryExpr) (string, bool)
- func ExcludedDirsRegExp(excludedDirs []string) []*regexp.Regexp
- func FindVarIdentities(n *ast.BinaryExpr, c *Context) ([]*ast.Ident, bool)
- func GetBinaryExprOperands(be *ast.BinaryExpr) []ast.Node
- func GetCallInfo(n ast.Node, ctx *Context) (string, string, error)
- func GetCallObject(n ast.Node, ctx *Context) (*ast.CallExpr, types.Object)
- func GetCallStringArgsValues(n ast.Node, ctx *Context) []string
- func GetChar(n ast.Node) (byte, error)
- func GetCweByRule(id string) *cwe.Weakness
- func GetFloat(n ast.Node) (float64, error)
- func GetIdentStringValues(ident *ast.Ident) []string
- func GetImportPath(name string, ctx *Context) (string, bool)
- func GetImportedName(path string, ctx *Context) (string, bool)
- func GetInt(n ast.Node) (int64, error)
- func GetLocation(n ast.Node, ctx *Context) (string, int)
- func GetPkgAbsPath(pkgPath string) (string, error)
- func GetPkgRelativePath(path string) (string, error)
- func GetString(n ast.Node) (string, error)
- func Getenv(key, userDefault string) string
- func Gopath() []string
- func MatchCallByPackage(n ast.Node, c *Context, pkg string, names ...string) (*ast.CallExpr, bool)
- func MatchCompLit(n ast.Node, ctx *Context, required string) *ast.CompositeLit
- func PackagePaths(root string, excludes []*regexp.Regexp) ([]string, error)
- func RootPath(root string) (string, error)
- func TryResolve(n ast.Node, c *Context) bool
- type Analyzer
- func (gosec *Analyzer) AppendError(file string, err error)
- func (gosec *Analyzer) Check(pkg *packages.Package)
- func (gosec *Analyzer) Config() Config
- func (gosec *Analyzer) LoadRules(ruleDefinitions map[string]RuleBuilder, ruleSuppressed map[string]bool)
- func (gosec *Analyzer) ParseErrors(pkg *packages.Package) error
- func (gosec *Analyzer) Process(buildTags []string, packagePaths ...string) error
- func (gosec *Analyzer) Report() ([]*Issue, *Metrics, map[string][]Error)
- func (gosec *Analyzer) Reset()
- func (gosec *Analyzer) SetConfig(conf Config)
- func (gosec *Analyzer) Visit(n ast.Node) ast.Visitor
- type CallList
- func (c CallList) Add(selector, ident string)
- func (c CallList) AddAll(selector string, idents ...string)
- func (c CallList) Contains(selector, ident string) bool
- func (c CallList) ContainsCallExpr(n ast.Node, ctx *Context) *ast.CallExpr
- func (c CallList) ContainsPkgCallExpr(n ast.Node, ctx *Context, stripVendor bool) *ast.CallExpr
- func (c CallList) ContainsPointer(selector, indent string) bool
- type Config
- func (c Config) Get(section string) (interface{}, error)
- func (c Config) GetGlobal(option GlobalOption) (string, error)
- func (c Config) IsGlobalEnabled(option GlobalOption) (bool, error)
- func (c Config) ReadFrom(r io.Reader) (int64, error)
- func (c Config) Set(section string, value interface{})
- func (c Config) SetGlobal(option GlobalOption, value string)
- func (c Config) WriteTo(w io.Writer) (int64, error)
- type Context
- type Error
- type GlobalOption
- type ImportTracker
- type Issue
- type MetaData
- type Metrics
- type ReportInfo
- type Rule
- type RuleBuilder
- type RuleSet
- type Score
- type SuppressionInfo
Constants ¶
const ( // Globals are applicable to all rules and used for general // configuration settings for gosec. Globals = "global" )
const LoadMode = packages.NeedName | packages.NeedFiles | packages.NeedCompiledGoFiles | packages.NeedImports | packages.NeedTypes | packages.NeedTypesSizes | packages.NeedTypesInfo | packages.NeedSyntax
LoadMode controls the amount of details to return when loading the packages
const SnippetOffset = 1
SnippetOffset defines the number of lines captured before the beginning and after the end of a code snippet
Variables ¶
This section is empty.
Functions ¶
func ConcatString ¶
func ConcatString(n *ast.BinaryExpr) (string, bool)
ConcatString recursively concatenates strings from a binary expression
func ExcludedDirsRegExp ¶
ExcludedDirsRegExp builds the regexps for a list of excluded dirs provided as strings
func FindVarIdentities ¶
FindVarIdentities returns array of all variable identities in a given binary expression
func GetBinaryExprOperands ¶ added in v2.4.0
func GetBinaryExprOperands(be *ast.BinaryExpr) []ast.Node
GetBinaryExprOperands returns all operands of a binary expression by traversing the expression tree
func GetCallInfo ¶
GetCallInfo returns the package or type and name associated with a call expression.
func GetCallObject ¶
GetCallObject returns the object and call expression and associated object for a given AST node. nil, nil will be returned if the object cannot be resolved.
func GetCallStringArgsValues ¶
GetCallStringArgsValues returns the values of strings arguments if they can be resolved
func GetCweByRule ¶ added in v2.8.0
GetCweByRule retrieves a cwe weakness for a given RuleID
func GetIdentStringValues ¶
GetIdentStringValues return the string values of an Ident if they can be resolved
func GetImportPath ¶
GetImportPath resolves the full import path of an identifier based on the imports in the current context.
func GetImportedName ¶
GetImportedName returns the name used for the package within the code. It will resolve aliases and ignores initialization only imports.
func GetLocation ¶
GetLocation returns the filename and line number of an ast.Node
func GetPkgAbsPath ¶
GetPkgAbsPath returns the Go package absolute path derived from the given path
func GetPkgRelativePath ¶
GetPkgRelativePath returns the Go relative relative path derived form the given path
func Getenv ¶
Getenv returns the values of the environment variable, otherwise returns the default if variable is not set
func MatchCallByPackage ¶
MatchCallByPackage ensures that the specified package is imported, adjusts the name for any aliases and ignores cases that are initialization only imports.
Usage:
node, matched := MatchCallByPackage(n, ctx, "math/rand", "Read")
func MatchCompLit ¶
MatchCompLit will match an ast.CompositeLit based on the supplied type
func PackagePaths ¶
PackagePaths returns a slice with all packages path at given root directory
Types ¶
type Analyzer ¶
type Analyzer struct {
// contains filtered or unexported fields
}
Analyzer object is the main object of gosec. It has methods traverse an AST and invoke the correct checking rules as on each node as required.
func NewAnalyzer ¶
func NewAnalyzer(conf Config, tests bool, excludeGenerated bool, trackSuppressions bool, concurrency int, logger *log.Logger) *Analyzer
NewAnalyzer builds a new analyzer.
func (*Analyzer) AppendError ¶
AppendError appends an error to the file errors
func (*Analyzer) LoadRules ¶
func (gosec *Analyzer) LoadRules(ruleDefinitions map[string]RuleBuilder, ruleSuppressed map[string]bool)
LoadRules instantiates all the rules to be used when analyzing source packages
func (*Analyzer) ParseErrors ¶
ParseErrors parses the errors from given package
func (*Analyzer) Report ¶
Report returns the current issues discovered and the metrics about the scan
func (*Analyzer) Reset ¶
func (gosec *Analyzer) Reset()
Reset clears state such as context, issues and metrics from the configured analyzer
type CallList ¶
type CallList map[string]set
CallList is used to check for usage of specific packages and functions.
func (CallList) Contains ¶
Contains returns true if the package and function are / members of this call list.
func (CallList) ContainsCallExpr ¶
ContainsCallExpr resolves the call expression name and type, and then determines if the call exists with the call list
func (CallList) ContainsPkgCallExpr ¶
ContainsPkgCallExpr resolves the call expression name and type, and then further looks up the package path for that type. Finally, it determines if the call exists within the call list
func (CallList) ContainsPointer ¶
ContainsPointer returns true if a pointer to the selector type or the type itself is a members of this call list.
type Config ¶
type Config map[string]interface{}
Config is used to provide configuration and customization to each of the rules.
func NewConfig ¶
func NewConfig() Config
NewConfig initializes a new configuration instance. The configuration data then needs to be loaded via c.ReadFrom(strings.NewReader("config data")) or from a *os.File.
func (Config) GetGlobal ¶
func (c Config) GetGlobal(option GlobalOption) (string, error)
GetGlobal returns value associated with global configuration option
func (Config) IsGlobalEnabled ¶
func (c Config) IsGlobalEnabled(option GlobalOption) (bool, error)
IsGlobalEnabled checks if a global option is enabled
func (Config) ReadFrom ¶
ReadFrom implements the io.ReaderFrom interface. This should be used with io.Reader to load configuration from file or from string etc.
func (Config) SetGlobal ¶
func (c Config) SetGlobal(option GlobalOption, value string)
SetGlobal associates a value with a global configuration option
type Context ¶
type Context struct { FileSet *token.FileSet Comments ast.CommentMap Info *types.Info Pkg *types.Package PkgFiles []*ast.File Root *ast.File Config Config Imports *ImportTracker Ignores []map[string][]SuppressionInfo PassedValues map[string]interface{} }
The Context is populated with data parsed from the source code as it is scanned. It is passed through to all rule functions as they are called. Rules may use this data in conjunction withe the encountered AST node.
type GlobalOption ¶
type GlobalOption string
GlobalOption defines the name of the global options
const ( // Nosec global option for #nosec directive Nosec GlobalOption = "nosec" // ShowIgnored defines whether nosec issues are counted as finding or not ShowIgnored GlobalOption = "show-ignored" // Audit global option which indicates that gosec runs in audit mode Audit GlobalOption = "audit" // NoSecAlternative global option alternative for #nosec directive NoSecAlternative GlobalOption = "#nosec" // ExcludeRules global option for some rules should not be load ExcludeRules GlobalOption = "exclude" // IncludeRules global option for should be load IncludeRules GlobalOption = "include" )
type ImportTracker ¶
type ImportTracker struct { Imported map[string]string Aliased map[string]string InitOnly map[string]bool }
ImportTracker is used to normalize the packages that have been imported by a source file. It is able to differentiate between plain imports, aliased imports and init only imports.
func NewImportTracker ¶
func NewImportTracker() *ImportTracker
NewImportTracker creates an empty Import tracker instance
func (*ImportTracker) TrackFile ¶
func (t *ImportTracker) TrackFile(file *ast.File)
TrackFile track all the imports used by the supplied file
func (*ImportTracker) TrackImport ¶
func (t *ImportTracker) TrackImport(n ast.Node)
TrackImport tracks imports and handles the 'unsafe' import
func (*ImportTracker) TrackPackages ¶
func (t *ImportTracker) TrackPackages(pkgs ...*types.Package)
TrackPackages tracks all the imports used by the supplied packages
type Issue ¶
type Issue struct { Severity Score `json:"severity"` // issue severity (how problematic it is) Confidence Score `json:"confidence"` // issue confidence (how sure we are we found it) Cwe *cwe.Weakness `json:"cwe"` // Cwe associated with RuleID RuleID string `json:"rule_id"` // Human readable explanation What string `json:"details"` // Human readable explanation File string `json:"file"` // File name we found it in Code string `json:"code"` // Impacted code line Line string `json:"line"` // Line number in file Col string `json:"column"` // Column number in line NoSec bool `json:"nosec"` // true if the issue is nosec Suppressions []SuppressionInfo `json:"suppressions"` // Suppression info of the issue }
Issue is returned by a gosec rule if it discovers an issue with the scanned code.
func NewIssue ¶
func NewIssue(ctx *Context, node ast.Node, ruleID, desc string, severity Score, confidence Score) *Issue
NewIssue creates a new Issue
func (Issue) FileLocation ¶
FileLocation point out the file path and line number in file
func (*Issue) WithSuppressions ¶ added in v2.9.4
func (i *Issue) WithSuppressions(suppressions []SuppressionInfo) *Issue
WithSuppressions set the suppressions of the issue
type MetaData ¶
MetaData is embedded in all gosec rules. The Severity, Confidence and What message will be passed through to reported issues.
type Metrics ¶
type Metrics struct { NumFiles int `json:"files"` NumLines int `json:"lines"` NumNosec int `json:"nosec"` NumFound int `json:"found"` }
Metrics used when reporting information about a scanning run.
type ReportInfo ¶ added in v2.8.0
type ReportInfo struct { Errors map[string][]Error `json:"Golang errors"` Issues []*Issue Stats *Metrics GosecVersion string }
ReportInfo this is report information
func NewReportInfo ¶ added in v2.8.0
func NewReportInfo(issues []*Issue, metrics *Metrics, errors map[string][]Error) *ReportInfo
NewReportInfo instantiate a ReportInfo
func (*ReportInfo) WithVersion ¶ added in v2.8.0
func (r *ReportInfo) WithVersion(version string) *ReportInfo
WithVersion defines the version of gosec used to generate the report
type RuleBuilder ¶
RuleBuilder is used to register a rule definition with the analyzer
type RuleSet ¶
A RuleSet contains a mapping of lists of rules to the type of AST node they should be run on and a mapping of rule ID's to whether the rule are suppressed. The analyzer will only invoke rules contained in the list associated with the type of AST node it is currently visiting.
func (RuleSet) IsRuleSuppressed ¶ added in v2.9.4
IsRuleSuppressed will return whether the rule is suppressed.
type Score ¶
type Score int
Score type used by severity and confidence values
func (Score) MarshalJSON ¶
MarshalJSON is used convert a Score object into a JSON representation
type SuppressionInfo ¶ added in v2.9.4
type SuppressionInfo struct { Kind string `json:"kind"` Justification string `json:"justification"` }
SuppressionInfo object is to record the kind and the justification that used to suppress violations.