Inspects source code for security problems by scanning the Go AST.
Install
CI Installation
# binary will be $GOPATH/bin/gosec
curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s -- -b $GOPATH/bin vX.Y.Z
# or install it into ./bin/
curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s vX.Y.Z
# In alpine linux (as it does not come with curl by default)
wget -O - -q https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s vX.Y.Z
# If you want to use the checksums provided on the "Releases" page
# then you will have to download a tar.gz file for your operating system instead of a binary file
wget https://github.com/securego/gosec/releases/download/vX.Y.Z/gosec_vX.Y.Z_OS.tar.gz
# The file will be in the current folder where you run the command
# and you can check the checksum like this
echo "<check sum from the check sum file> gosec_vX.Y.Z_OS.tar.gz" | sha256sum -c -
gosec --helpLocal Installation
go get github.com/securego/gosec/cmd/gosecUsage
Gosec can be configured to only run a subset of rules, to exclude certain file paths, and produce reports in different formats. By default all rules will be run against the supplied input files. To recursively scan from the current directory you can supply './...' as the input argument.
Available rules
- G101: Look for hard coded credentials
- G102: Bind to all interfaces
- G103: Audit the use of unsafe block
- G104: Audit errors not checked
- G106: Audit the use of ssh.InsecureIgnoreHostKey
- G107: Url provided to HTTP request as taint input
- G108: Profiling endpoint automatically exposed on /debug/pprof
- G201: SQL query construction using format string
- G202: SQL query construction using string concatenation
- G203: Use of unescaped data in HTML templates
- G204: Audit use of command execution
- G301: Poor file permissions used when creating a directory
- G302: Poor file permissions used with chmod
- G303: Creating tempfile using a predictable path
- G304: File path provided as taint input
- G305: File traversal when extracting zip archive
- G401: Detect the usage of DES, RC4, MD5 or SHA1
- G402: Look for bad TLS connection settings
- G403: Ensure minimum RSA key length of 2048 bits
- G404: Insecure random number source (rand)
- G501: Import blacklist: crypto/md5
- G502: Import blacklist: crypto/des
- G503: Import blacklist: crypto/rc4
- G504: Import blacklist: net/http/cgi
- G505: Import blacklist: crypto/sha1
Retired rules
- G105: Audit the use of math/big.Int.Exp - CVE is fixed
Selecting rules
By default gosec will run all rules against the supplied file paths. It is however possible to select a subset of rules to run via the '-include=' flag, or to specify a set of rules to explicitly exclude using the '-exclude=' flag.
# Run a specific set of rules
$ gosec -include=G101,G203,G401 ./...
# Run everything except for rule G303
$ gosec -exclude=G303 ./...Configuration
A number of global settings can be provided in a configuration file as follows:
{
"global": {
"nosec": "enabled",
"audit": "enabled"
}
}nosec: this setting will overwrite all#nosecdirectives defined throughout the code baseaudit: runs in audit mode which enables addition checks that for normal code analysis might be too nosy
# Run with a global configuration file
$ gosec -conf config.json .G104, it is possible to define packages along with a list of functions which will be skipped when auditing the not checked errors:{
"G104": {
"io/ioutil": ["WriteFile"]
}
}Dependencies
gosec will fetch automatically the dependencies of the code which is being analyzed when go modules are turned on (e.g.
GO111MODULE=on). If this is not the case, the dependencies need to be explicitly downloaded by running the go get -d command before the scan.Excluding test files and folders
gosec will ignore test files across all packages and any dependencies in your vendor directory.
The scanning of test files can be enabled with the following flag:
gosec -tests ./... gosec -exclude-dir=rules -exclude-dir=cmd ./...Annotating code
As with all automated detection tools there will be cases of false positives. In cases where gosec reports a failure that has been manually verified as being safe it is possible to annotate the code with a '#nosec' comment.
The annotation causes gosec to stop processing any further nodes within the AST so can apply to a whole block or more granularly to a single expression.
import "md5" // #nosec
func main(){
/* #nosec */
if x > y {
h := md5.New() // this will also be ignored
}
}#nosec annotation, e.g: /* #nosec G401 */ or // #nosec G201 G202 G203 In some cases you may also want to revisit places where #nosec annotations have been used. To run the scanner and ignore any #nosec annotations you can do the following:
gosec -nosec=true ./...Build tags
gosec is able to pass your Go build tags to the analyzer. They can be provided as a comma separated list as follows:
gosec -tag debug,ignore ./...Output formats
gosec currently supports text, json, yaml, csv, sonarqube and JUnit XML output formats. By default results will be reported to stdout, but can also be written to an output file. The output format is controlled by the '-fmt' flag, and the output file is controlled by the '-out' flag as follows:
# Write output in json format to results.json
$ gosec -fmt=json -out=results.json *.goDevelopment
Build
makeTests
make testRelease Build
Make sure you have installed the goreleaser tool and then you can release gosec as follows:
git tag v1.0.0
export GITHUB_TOKEN=<YOUR GITHUB TOKEN>
make releasedist folder. The build information should be displayed in the usage text../dist/darwin_amd64/gosec -h
gosec - Golang security checker
gosec analyzes Go source code to look for common programming mistakes that
can lead to security problems.
VERSION: 1.0.0
GIT TAG: v1.0.0
BUILD DATE: 2018-04-27T12:41:38ZDocker image
You can build the docker image as follows:
make imagegosec tool in a container against your local Go project. You just have to mount the project into a volume as follow:docker run -it -v <YOUR PROJECT PATH>/<PROJECT>:/<PROJECT> securego/gosec /<PROJECT>/...Generate TLS rule
The configuration of TLS rule can be generated from Mozilla's TLS ciphers recommendation.
First you need to install the generator tool:
go get github.com/securego/gosec/cmd/tlsconfig/...go generate in the root of the project:go generate ./...rules/tls_config.go file with will contain the current ciphers recommendation from Mozilla.