gosec: github.com/securego/gosec Index | Files | Directories

package gosec

import "github.com/securego/gosec"

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

Index

Package Files

analyzer.go call_list.go config.go errors.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"
)
❖
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

Variables

❖
var IssueToCWE = map[string]Cwe{
    "G101": GetCwe("798"),
    "G102": GetCwe("200"),
    "G103": GetCwe("242"),
    "G104": GetCwe("703"),
    "G106": GetCwe("322"),
    "G107": GetCwe("88"),
    "G201": GetCwe("89"),
    "G202": GetCwe("89"),
    "G203": GetCwe("79"),
    "G204": GetCwe("78"),
    "G301": GetCwe("276"),
    "G302": GetCwe("276"),
    "G303": GetCwe("377"),
    "G304": GetCwe("22"),
    "G305": GetCwe("22"),
    "G401": GetCwe("326"),
    "G402": GetCwe("295"),
    "G403": GetCwe("310"),
    "G404": GetCwe("338"),
    "G501": GetCwe("327"),
    "G502": GetCwe("327"),
    "G503": GetCwe("327"),
    "G504": GetCwe("327"),
    "G505": GetCwe("327"),
}

IssueToCWE maps gosec rules to CWEs

func ConcatString Uses

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

ConcatString recursively concatenates strings from a binary expression

func ExcludedDirsRegExp Uses

❖
func ExcludedDirsRegExp(excludedDirs []string) []*regexp.Regexp

ExcludedDirsRegExp builds the regexps for a list of excluded dirs provided as strings

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

❖
func PackagePaths(root string, excludes []*regexp.Regexp) ([]string, error)

PackagePaths returns a slice with all packages path at given root directory

func RootPath Uses

❖
func RootPath(root string) (string, error)

RootPath returns the absolute root path of a scan

func TryResolve Uses

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

TryResolve will attempt, given a subtree starting at some AST 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, tests bool, logger *log.Logger) *Analyzer

NewAnalyzer builds a new analyzer.

func (*Analyzer) AppendError Uses

❖
func (gosec *Analyzer) AppendError(file string, err error)

AppendError appends an error to the file errors

func (*Analyzer) Check Uses

❖
func (gosec *Analyzer) Check(pkg *packages.Package)

Check runs analysis on the given package

func (*Analyzer) Config Uses

❖
func (gosec *Analyzer) Config() Config

Config returns the current configuration

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) ParseErrors Uses

❖
func (gosec *Analyzer) ParseErrors(pkg *packages.Package) error

ParseErrors parses the errors from given package

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, map[string][]Error)

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) SetConfig Uses

❖
func (gosec *Analyzer) SetConfig(conf Config)

SetConfig upates the analyzer configuration

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

❖
type Cwe struct {
    ID  string
    URL string
}

Cwe id and url

func GetCwe Uses

❖
func GetCwe(id string) Cwe

GetCwe creates a cwe object for a given RuleID

type Error Uses

❖
type Error struct {
    Line   int    `json:"line"`
    Column int    `json:"column"`
    Err    string `json:"error"`
}

Error is used when there are golang errors while parsing the AST

func NewError Uses

❖
func NewError(line, column int, err string) *Error

NewError creates Error object

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"
    // NoSecAlternative global option alternative for #nosec directive
    NoSecAlternative GlobalOption = "#nosec"
)

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) TrackFile Uses

❖
func (t *ImportTracker) TrackFile(file *ast.File)

TrackFile track all the imports used by the supplied file

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

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

PathSynopsis
cmd/gosec
cmd/gosecutil
cmd/tlsconfig
output
rules
testutils

Package gosec imports 22 packages (graph) and is imported by 15 packages. Updated 2019-11-19. Refresh now. Tools for package owners.