gosec

package module
v0.0.0-...-d055baf Latest Latest
Warning

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

 Go to latest Published: Jun 29, 2021 License: Apache-2.0 Imports: 24 Imported by: 0

README

gosec-m - gosec规则动态化

背景

在gosec与流水线集成的过程中，时常遇到因为解决漏报或者误报而去添加或修改gosec规则，又因为gosec规则以代码形式编译进二进制文件中，只要改动了规则，就要重新编译整个gosec并更新流水线中的二进制执行文件。

为了方便规则的改动，就产生了对gosec进行修改的想法，于是就有了这个项目——用js编写gosec规则并动态加载。

编译

本项目使用Go 1.16+ (with Go module)

cd cmd/gosec && go generate && go build

使用说明

只对gosec加载规则做了修改，使用方法基本与gosec原版一致。

特别说明：因为是加载js，所以要明确js文件所在的文件夹。

例如:

gosec -rule=/tmp/dynamicRule/ {gosec参数} {需要扫描的路径}

如果需要输出js加载时后的输出，则需要添加-debug参数。

gosec -rule=/tmp/dynamicRule/ -debug=true {gosec参数} {需要扫描的路径}

docker

docker build -t gosec-m .

docker run --rm -it -w /<PROJECT>/ -v <YOUR PROJECT PATH>/<PROJECT>:/<PROJECT> gosec-m /<PROJECT>/...
规则

对于原有规则中用到的gosec包中的函数，基本都做了转换，例如原有规则调用了gosec.NewCallList()，js中沿用这种写法就行。

对于if a, ok := b.(type); ok {...}语法，增加utils包用于替代。

let a = utils.transformTo(a, "type")
if (a !== null) {
    ...
}

utils包中方法有:

utils.getGoType(v) string // 获取在go中类型的字符串
utils.isType(v, "type") bool // 是否可以类型转换
utils.transformTo(v, "type") variable or null // 强制类型转换，如果转换失败则返回null
样例

template

// 创建metadata
let metaData = gosec.NewMetaData()
metaData.ID = "string"
metaData.Severity = gosec.Medium // 漏洞等级
metaData.Confidence = gosec.High // 漏洞可信度
metaData.What = "string"

let rule = { // 一定得是rule变量
    "metaData": metaData,
    "for": ["*ast.CallExpr"], // 规则绑定于哪种ast节点上
    "cwe": { // cwe信息
        "id": "118",
        "desc": "The software does not restrict or incorrectly restricts operations within the boundaries of a" +
                " resource that is accessed using an index or pointer, such as memory or files.",
        "name": "Incorrect Access of Indexable Resource ('Range Error')"
    }
}

// 匹配函数，一定得是match，并有两个参数
function match(n, c) {
    if (true) { // 如果存在漏洞
        return {"Issue": gosec.NewIssue(c, n, rule.metaData.ID, rule.metaData.What, rule.metaData.Severity, rule.metaData
            .Confidence), "Error": null}
    }
    
    // 不存在
    return {"Issue": null, "Error": null}
}

风险提示

该项目只是实验性质项目，因我研发水平有限且未经正规测试流程。运行过程中难免存在崩溃等问题，请谅解。Orz

参考项目

  • gosec — Golang security checker

  • goja — ECMAScript/JavaScript engine in pure Go

维护者

@LuckyC4t

使用许可

Apache License Version 2.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"
)
View Source 
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

View Source 
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 

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

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

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 GetBinaryExprOperands 

func GetBinaryExprOperands(be *ast.BinaryExpr) []ast.Node

GetBinaryExprOperands returns all operands of a binary expression by traversing the expression tree

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 GetCallStringArgsValues 

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

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

func GetChar 

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

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

func GetCweByRule 

func GetCweByRule(id string) *cwe.Weakness

func GetFloat 

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

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

func GetIdentStringValues 

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

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

func GetImportPath 

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 

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 

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 IsGosecID 

func IsGosecID(id string) bool

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 MatchCompLit 

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

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

func PackagePaths 

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

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

func RootPath 

func RootPath(root string) (string, error)

RootPath returns the absolute root path of a scan

func TryResolve 

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.

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

NewAnalyzer builds a new analyzer.

func (*Analyzer) AppendError 

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

AppendError appends an error to the file errors

func (*Analyzer) Check 

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

Check runs analysis on the given package

func (*Analyzer) Config 

func (gosec *Analyzer) Config() Config

Config returns the current configuration

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

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

ParseErrors parses the errors from given package

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

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

func (gosec *Analyzer) SetConfig(conf Config)

SetConfig upates the analyzer configuration

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, and then determines if the call exists with the call list

func (CallList) ContainsPkgCallExpr 

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

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 

func (c CallList) ContainsPointer(selector, indent string) bool

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

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 GlobalOption, value string)

SetGlobal associates a value with a global configuration option

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
	PkgFiles     []*ast.File
	Root         *ast.File
	Config       Config
	Imports      *ImportTracker
	Ignores      []map[string]bool
	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 Error 

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 

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

NewError creates Error object

type GlobalOption 

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 

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
}

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 

func (i Issue) FileLocation() string

FileLocation point out the file path and line number in file

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

type ReportInfo struct {
	Errors       map[string][]Error `json:"Golang errors"`
	Issues       []*Issue
	Stats        *Metrics
	GosecVersion string
}

ReportInfo this is report information

func NewReportInfo 

func NewReportInfo(issues []*Issue, metrics *Metrics, errors map[string][]Error) *ReportInfo

NewReportInfo instantiate a ReportInfo

func (*ReportInfo) WithVersion 

func (r *ReportInfo) WithVersion(version string) *ReportInfo

WithVersion defines the version of gosec used to generate the report

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 analyzer 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
gosec/gen
gosecutil
tlsconfig
main
 main
internal
conf
js2gosec
js2gosec/errors
js2gosec/runner
js2gosec/xfmr
js2gosec/xfmr/gosec
js2gosec/xfmr/util
js2gosec/xfmr/zxcvbn
csv
golint
html
json
junit
sarif
sonar
text
yaml

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.