package gosec

import "github.com/securego/gosec"

Package gosec holds the central scanning logic used by gosec security scanner

Index ¶

• Constants
• func ConcatString(n *ast.BinaryExpr) (string, bool)
• func FindVarIdentities(n *ast.BinaryExpr, c *Context) ([]*ast.Ident, bool)
• 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 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 MatchCallByType(n ast.Node, ctx *Context, requiredType string, calls ...string) (*ast.CallExpr, bool)
• func MatchCompLit(n ast.Node, ctx *Context, required string) *ast.CompositeLit
• func TryResolve(n ast.Node, c *Context) bool
• type Analyzer
• func NewAnalyzer(conf Config, logger *log.Logger) *Analyzer
• func (gosec *Analyzer) LoadRules(ruleDefinitions map[string]RuleBuilder)
• func (gosec *Analyzer) Process(buildTags []string, packagePaths ...string) error
• func (gosec *Analyzer) Report() ([]*Issue, *Metrics)
• func (gosec *Analyzer) Reset()
• func (gosec *Analyzer) Visit(n ast.Node) ast.Visitor
• type CallList
• func NewCallList() 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, stripVendor bool) *ast.CallExpr
• type Config
• func NewConfig() 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 GlobalOption
• type ImportTracker
• func NewImportTracker() *ImportTracker
• func (t *ImportTracker) TrackImport(n ast.Node)
• func (t *ImportTracker) TrackPackages(pkgs ...*types.Package)
• type Issue
• func NewIssue(ctx *Context, node ast.Node, ruleID, desc string, severity Score, confidence Score) *Issue
• type MetaData
• type Metrics
• type Rule
• type RuleBuilder
• type RuleSet
• func NewRuleSet() RuleSet
• func (r RuleSet) Register(rule Rule, nodes ...ast.Node)
• func (r RuleSet) RegisteredFor(n ast.Node) []Rule
• type Score
• func (c Score) MarshalJSON() ([]byte, error)
• func (c Score) String() string

Package Files ¶

analyzer.go call_list.go config.go helpers.go import_tracker.go issue.go resolve.go rule.go

Constants ¶

const (
    // Globals are applicable to all rules and used for general
    // configuration settings for gosec.
    Globals = "global"
)

func ConcatString ¶ Uses

func ConcatString(n *ast.BinaryExpr) (string, bool)

ConcatString recursively concatenates strings from a binary expression

func FindVarIdentities ¶ Uses

func FindVarIdentities(n *ast.BinaryExpr, c *Context) ([]*ast.Ident, bool)

FindVarIdentities returns array of all variable identities in a given binary expression

func GetCallInfo ¶ Uses

func GetCallInfo(n ast.Node, ctx *Context) (string, string, error)

GetCallInfo returns the package or type and name associated with a call expression.

func GetCallObject ¶ Uses

func GetCallObject(n ast.Node, ctx *Context) (*ast.CallExpr, types.Object)

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 ¶ Uses

func GetCallStringArgsValues(n ast.Node, ctx *Context) []string

GetCallStringArgsValues returns the values of strings arguments if they can be resolved

func GetChar ¶ Uses

func GetChar(n ast.Node) (byte, error)

GetChar will read and return a char value from an ast.BasicLit

func GetFloat ¶ Uses

func GetFloat(n ast.Node) (float64, error)

GetFloat will read and return a float value from an ast.BasicLit

func GetIdentStringValues ¶ Uses

func GetIdentStringValues(ident *ast.Ident) []string

GetIdentStringValues return the string values of an Ident if they can be resolved

func GetImportPath ¶ Uses

func GetImportPath(name string, ctx *Context) (string, bool)

GetImportPath resolves the full import path of an identifier based on the imports in the current context.

func GetImportedName ¶ Uses

func GetImportedName(path string, ctx *Context) (string, bool)

GetImportedName returns the name used for the package within the code. It will resolve aliases and ignores initialization only imports.

func GetInt ¶ Uses

func GetInt(n ast.Node) (int64, error)

GetInt will read and return an integer value from an ast.BasicLit

func GetLocation ¶ Uses

func GetLocation(n ast.Node, ctx *Context) (string, int)

GetLocation returns the filename and line number of an ast.Node

func GetPkgAbsPath ¶ Uses

func GetPkgAbsPath(pkgPath string) (string, error)

GetPkgAbsPath returns the Go package absolute path derived from the given path

func GetPkgRelativePath ¶ Uses

func GetPkgRelativePath(path string) (string, error)

GetPkgRelativePath returns the Go relative relative path derived form the given path

func GetString ¶ Uses

func GetString(n ast.Node) (string, error)

GetString will read and return a string value from an ast.BasicLit

func Getenv ¶ Uses

func Getenv(key, userDefault string) string

Getenv returns the values of the environment variable, otherwise returns the default if variable is not set

func Gopath ¶ Uses

func Gopath() []string

Gopath returns all GOPATHs

func MatchCallByPackage ¶ Uses

func MatchCallByPackage(n ast.Node, c *Context, pkg string, names ...string) (*ast.CallExpr, bool)

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 MatchCallByType ¶ Uses

func MatchCallByType(n ast.Node, ctx *Context, requiredType string, calls ...string) (*ast.CallExpr, bool)

MatchCallByType ensures that the node is a call expression to a specific object type.

Usage:

node, matched := MatchCallByType(n, ctx, "bytes.Buffer", "WriteTo", "Write")

func MatchCompLit ¶ Uses

func MatchCompLit(n ast.Node, ctx *Context, required string) *ast.CompositeLit

MatchCompLit will match an ast.CompositeLit based on the supplied type

func TryResolve ¶ Uses

func TryResolve(n ast.Node, c *Context) bool

TryResolve will attempt, given a subtree starting at some ATS node, to resolve all values contained within to a known constant. It is used to check for any unknown values in compound expressions.

type Analyzer ¶ Uses

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 ¶ Uses

func NewAnalyzer(conf Config, logger *log.Logger) *Analyzer

NewAnalyzer builds a new analyzer.

func (*Analyzer) LoadRules ¶ Uses

func (gosec *Analyzer) LoadRules(ruleDefinitions map[string]RuleBuilder)

LoadRules instantiates all the rules to be used when analyzing source packages

func (*Analyzer) Process ¶ Uses

func (gosec *Analyzer) Process(buildTags []string, packagePaths ...string) error

Process kicks off the analysis process for a given package

func (*Analyzer) Report ¶ Uses

func (gosec *Analyzer) Report() ([]*Issue, *Metrics)

Report returns the current issues discovered and the metrics about the scan

func (*Analyzer) Reset ¶ Uses

func (gosec *Analyzer) Reset()

Reset clears state such as context, issues and metrics from the configured analyzer

func (*Analyzer) Visit ¶ Uses

func (gosec *Analyzer) Visit(n ast.Node) ast.Visitor

Visit runs the gosec visitor logic over an AST created by parsing go code. Rule methods added with AddRule will be invoked as necessary.

type CallList ¶ Uses

type CallList map[string]set

CallList is used to check for usage of specific packages and functions.

func NewCallList ¶ Uses

func NewCallList() CallList

NewCallList creates a new empty CallList

func (CallList) Add ¶ Uses

func (c CallList) Add(selector, ident string)

Add a selector and call to the call list

func (CallList) AddAll ¶ Uses

func (c CallList) AddAll(selector string, idents ...string)

AddAll will add several calls to the call list at once

func (CallList) Contains ¶ Uses

func (c CallList) Contains(selector, ident string) bool

Contains returns true if the package and function are / members of this call list.

func (CallList) ContainsCallExpr ¶ Uses

func (c CallList) ContainsCallExpr(n ast.Node, ctx *Context, stripVendor bool) *ast.CallExpr

ContainsCallExpr resolves the call expression name and type / or package and determines if it exists within the CallList

type Config ¶ Uses

type Config map[string]interface{}

Config is used to provide configuration and customization to each of the rules.

func NewConfig ¶ Uses

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) Get ¶ Uses

func (c Config) Get(section string) (interface{}, error)

Get returns the configuration section for the supplied key

func (Config) GetGlobal ¶ Uses

func (c Config) GetGlobal(option GlobalOption) (string, error)

GetGlobal returns value associated with global configuration option

func (Config) IsGlobalEnabled ¶ Uses

func (c Config) IsGlobalEnabled(option GlobalOption) (bool, error)

IsGlobalEnabled checks if a global option is enabled

func (Config) ReadFrom ¶ Uses

func (c Config) ReadFrom(r io.Reader) (int64, error)

ReadFrom implements the io.ReaderFrom interface. This should be used with io.Reader to load configuration from file or from string etc.

func (Config) Set ¶ Uses

func (c Config) Set(section string, value interface{})

Set section in the configuration to specified value

func (Config) SetGlobal ¶ Uses

func (c Config) SetGlobal(option GlobalOption, value string)

SetGlobal associates a value with a global configuration option

func (Config) WriteTo ¶ Uses

func (c Config) WriteTo(w io.Writer) (int64, error)

WriteTo implements the io.WriteTo interface. This should be used to save or print out the configuration information.

type Context ¶ Uses

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]bool
}

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 ¶ Uses

type GlobalOption string

GlobalOption defines the name of the global options

const (
    // Nosec global option for #nosec directive
    Nosec GlobalOption = "nosec"
    // Audit global option which indicates that gosec runs in audit mode
    Audit GlobalOption = "audit"
)

type ImportTracker ¶ Uses

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 ¶ Uses

func NewImportTracker() *ImportTracker

NewImportTracker creates an empty Import tracker instance

func (*ImportTracker) TrackImport ¶ Uses

func (t *ImportTracker) TrackImport(n ast.Node)

TrackImport tracks imports and handles the 'unsafe' import

func (*ImportTracker) TrackPackages ¶ Uses

func (t *ImportTracker) TrackPackages(pkgs ...*types.Package)

TrackPackages tracks all the imports used by the supplied packages

type Issue ¶ Uses

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)
    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
}

Issue is returned by a gosec rule if it discovers an issue with the scanned code.

func NewIssue ¶ Uses

func NewIssue(ctx *Context, node ast.Node, ruleID, desc string, severity Score, confidence Score) *Issue

NewIssue creates a new Issue

type MetaData ¶ Uses

type MetaData struct {
    ID         string
    Severity   Score
    Confidence Score
    What       string
}

MetaData is embedded in all gosec rules. The Severity, Confidence and What message will be passed through to reported issues.

type Metrics ¶ Uses

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 Rule ¶ Uses

type Rule interface {
    ID() string
    Match(ast.Node, *Context) (*Issue, error)
}

The Rule interface used by all rules supported by gosec.

type RuleBuilder ¶ Uses

type RuleBuilder func(id string, c Config) (Rule, []ast.Node)

RuleBuilder is used to register a rule definition with the analyzer

type RuleSet ¶ Uses

type RuleSet map[reflect.Type][]Rule

A RuleSet maps lists of rules to the type of AST node they should be run on. The analyzer will only invoke rules contained in the list associated with the type of AST node it is currently visiting.

func NewRuleSet ¶ Uses

func NewRuleSet() RuleSet

NewRuleSet constructs a new RuleSet

func (RuleSet) Register ¶ Uses

func (r RuleSet) Register(rule Rule, nodes ...ast.Node)

Register adds a trigger for the supplied rule for the the specified ast nodes.

func (RuleSet) RegisteredFor ¶ Uses

func (r RuleSet) RegisteredFor(n ast.Node) []Rule

RegisteredFor will return all rules that are registered for a specified ast node.

type Score ¶ Uses

type Score int

Score type used by severity and confidence values

const (
    // Low severity or confidence
    Low Score = iota
    // Medium severity or confidence
    Medium
    // High severity or confidence
    High
)

func (Score) MarshalJSON ¶ Uses

func (c Score) MarshalJSON() ([]byte, error)

MarshalJSON is used convert a Score object into a JSON representation

func (Score) String ¶ Uses

func (c Score) String() string

String converts a Score into a string

Directories ¶