gosec

package
v3.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 29, 2019 License: MIT, Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

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

Index

Constants

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

Variables

This section is empty.

Functions

func ConcatString 

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

ConcatString recusively concatenates strings from a binary expression

func FindVarIdentities 

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

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

func GetCallInfo 

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 

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 GetChar 

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

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

func GetFloat 

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

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

func GetImportPath 

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

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

func GetImportedName 

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 initalization only imports.

func GetInt 

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

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

func GetLocation 

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

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

func GetPkgAbsPath 

func GetPkgAbsPath(pkgPath string) (string, error)

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

func GetPkgRelativePath 

func GetPkgRelativePath(path string) (string, error)

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

func GetString 

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

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

func Getenv 

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 

func Gopath() []string

Gopath returns all GOPATHs

func MatchCallByPackage 

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 

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 

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

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

func TryResolve 

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 unkown values in compound expressions.

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, logger *log.Logger) *Analyzer

NewAnalyzer builds a new anaylzer.

func (*Analyzer) LoadRules 

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

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

func (*Analyzer) Process 

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

Process kicks off the analysis process for a given package

func (*Analyzer) Report 

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

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

func (*Analyzer) Visit 

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 

type CallList map[string]set

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

func NewCallList 

func NewCallList() CallList

NewCallList creates a new empty CallList

func (CallList) Add 

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

Add a selector and call to the call list

func (CallList) AddAll 

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

AddAll will add several calls to the call list at once

func (CallList) Contains 

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 

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

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

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

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

Get returns the configuration section for the supplied key

func (Config) GetGlobal 

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

GetGlobal returns value associated with global configuration option

func (Config) ReadFrom 

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 

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

Set section in the configuration to specified value

func (Config) SetGlobal 

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

SetGlobal associates a value with a global configuration ooption

func (Config) WriteTo 

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 

type Context struct {
	FileSet  *token.FileSet
	Comments ast.CommentMap
	Info     *types.Info
	Pkg      *types.Package
	Root     *ast.File
	Config   map[string]interface{}
	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 encoutered AST node.

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

type MetaData 

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 tbhrough 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 Rule 

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

The Rule interface used by all rules supported by gosec.

type RuleBuilder 

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

RuleBuilder is used to register a rule definition with the analyzer

type RuleSet 

type RuleSet map[reflect.Type][]Rule

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

func NewRuleSet 

func NewRuleSet() RuleSet

NewRuleSet constructs a new RuleSet

func (RuleSet) Register 

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 

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

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

type Score 

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 

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

MarshalJSON is used convert a Score object into a JSON representation

func (Score) String 

func (c Score) String() string

String converts a Score into a string

Source Files

View all Source files

Directories

Path Synopsis
cmd
gosec
gosecutil
tlsconfig

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.