Inspects source code for security problems by scanning the Go AST and SSA code representation.

Licensed under the Apache License, Version 2.0 (the "License").You may not use this file except in compliance with the License.You may obtain a copy of the Licensehere.

# binary will be $(go env GOPATH)/bin/goseccurl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh| sh -s -- -b$(go env 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 filewget 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 thisecho"<check sum from the check sum file>  gosec_vX.Y.Z_OS.tar.gz"| sha256sum -c -gosec --help

You can rungosec as a GitHub action as follows:

name:Run Gosecon:push:branches:      -masterpull_request:branches:      -masterjobs:tests:runs-on:ubuntu-latestenv:GO111MODULE:onsteps:      -name:Checkout Sourceuses:actions/checkout@v3      -name:Run Gosec Security Scanneruses:securego/gosec@masterwith:args:./...

You canintegrate third-party code analysis tools with GitHub code scanning by uploading data as SARIF files.

The workflow shows an example of running thegosec as a step in a GitHub action workflow which outputs theresults.sarif file. The workflow then uploads theresults.sarif file to GitHub using theupload-sarif action.

name:"Security Scan"# Run workflow each time code is pushed to your repository and on a schedule.# The scheduled workflow runs every at 00:00 on Sunday UTC time.on:push:schedule:  -cron:'0 0 * * 0'jobs:tests:runs-on:ubuntu-latestenv:GO111MODULE:onsteps:      -name:Checkout Sourceuses:actions/checkout@v3      -name:Run Gosec Security Scanneruses:securego/gosec@masterwith:# we let the report trigger content trigger a failure using the GitHub Security features.args:'-no-fail -fmt sarif -out results.sarif ./...'      -name:Upload SARIF fileuses:github/codeql-action/upload-sarif@v2with:# Path to SARIF file relative to the root of the repositorysarif_file:results.sarif

go install github.com/securego/gosec/v2/cmd/gosec@latest

Gosec can be configured to only run a subset of rules, to exclude certain filepaths, and produce reports in different formats. By default all rules will berun against the supplied input files. To recursively scan from the currentdirectory you can supply./... as the input argument.

• 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
• G109: Potential Integer overflow made by strconv.Atoi result conversion to int16/32
• G110: Potential DoS vulnerability via decompression bomb
• G111: Potential directory traversal
• G112: Potential slowloris attack
• G114: Use of net/http serve function that has no support for setting timeouts
• G115: Potential integer overflow when converting between integer types
• 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/tar archive
• G306: Poor file permissions used when writing to a new file
• G307: Poor file permissions used when creating a file with os.Create
• G401: Detect the usage of 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)
• G405: Detect the usage of DES or RC4
• G406: Detect the usage of MD4 or RIPEMD160
• G407: Detect the usage of hardcoded Initialization Vector(IV)/Nonce
• G501: Import blocklist: crypto/md5
• G502: Import blocklist: crypto/des
• G503: Import blocklist: crypto/rc4
• G504: Import blocklist: net/http/cgi
• G505: Import blocklist: crypto/sha1
• G506: Import blocklist: golang.org/x/crypto/md4
• G507: Import blocklist: golang.org/x/crypto/ripemd160
• G601: Implicit memory aliasing of items from a range statement (only for Go 1.21 or lower)
• G602: Slice access out of bounds

• G105: Audit the use of math/big.Int.Exp -CVE is fixed
• G113: Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772). This affected Go <1.16.14 and Go <1.17.7, which are no longer supported by gosec.
• G307: Deferring a method which returns an error - causing more inconvenience than fixing a security issue, despite the details from thisblog post

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

Every issue detected bygosec is mapped to aCWE (Common Weakness Enumeration) which describes in more generic terms the vulnerability. The exact mapping can be foundhere.

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#nosec directives defined throughout the code base
• audit: 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.

Some rules accept configuration flags as well; these flags are documented inRULES.md.

Some rules require a specific Go version which is retrieved from the Go module file present in the project. If this version cannot be found, it will fallback to Go runtime version.

The Go module version is parsed using thego list command which in some cases might lead to performance degradation. In this situation, the go module version can be easily provided by setting the environment variableGOSECGOVERSION=go1.21.1.

gosec will fetch automatically the dependencies of the code which is being analyzed when go module is turned on (e.g.GO111MODULE=on). If this is not the case,the dependencies need to be explicitly downloaded by running thego get -d command before the scan.

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

Also additional folders can be excluded as follows:

 gosec -exclude-dir=rules -exclude-dir=cmd ./...

gosec can ignore generated go files with default generated code comment.

// Code generated by some generator DO NOT EDIT.

gosec -exclude-generated ./...

gosec can suggest fixes based on AI recommendation. It will call an AI API to receive a suggestion for a security finding.

You can enable this feature by providing the following command line arguments:

• ai-api-provider: the name of the AI API provider, currently onlygeminiis supported.
• ai-api-key or set the environment variableGOSEC_AI_API_KEY: the key to access the AI API,For gemini, you can create an API key followingthese instructions.
• ai-endpoint: the endpoint of the AI provider, this is optional argument.

gosec -ai-api-provider="gemini" -ai-api-key="your_key" ./...

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 comment that starts with#nosec.

The#nosec comment should have the format#nosec [RuleList] [-- Justification].

The#nosec comment needs to be placed on the line where the warning is reported.

funcmain() {tr:=&http.Transport{TLSClientConfig:&tls.Config{InsecureSkipVerify:true,// #nosec G402},}client:=&http.Client{Transport:tr}_,err:=client.Get("https://go.dev/")iferr!=nil {fmt.Println(err)}}

When a specific false positive has been identified and verified as safe, you maywish to suppress only that single rule (or a specific set of rules) within a section of code,while continuing to scan for other problems. To do this, you can list the rule(s) to be suppressed withinthe#nosec annotation, e.g:/* #nosec G401 */ or//#nosec G201 G202 G203

You could put the description or justification text for the annotation. Thejustification should be after the rule(s) to suppress and start with two ormore dashes, e.g://#nosec G101 G102 -- This is a false positive

Alternatively, gosec also supports the//gosec:disable directive, which functions similar to#nosec:

//gosec:disable G101 -- This is a false positive

In some cases you may also want to revisit places where#nosec or//gosec:disable annotationshave been used. To run the scanner and ignore any#nosec annotations youcan do the following:

gosec -nosec=true ./...

As described above, we could suppress violations externally (using-include/-exclude) or inline (using#nosec annotations) in gosec. This suppressioninflammation can be used to generate corresponding signals for auditingpurposes.

We could track suppressions by the-track-suppressions flag as follows:

gosec -track-suppressions -exclude=G101 -fmt=sarif -out=results.sarif ./...

• For external suppressions, gosec records suppression info wherekind isexternal andjustification is a certain sentence "Globally suppressed".
• For inline suppressions, gosec records suppression info wherekind isinSource andjustification is the text after two or more dashes in thecomment.

Note: Only SARIF and JSON formats support tracking suppressions.

gosec is able to pass yourGo build tags to the analyzer.They can be provided as a comma separated list as follows:

gosec -tags debug,ignore ./...

gosec currently supportstext,json,yaml,csv,sonarqube,JUnit XML,html andgolint output formats. By defaultresults will be reported to stdout, but can also be written to an outputfile. 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*.go

Results will be reported to stdout as well as to the provided output file by-stdout flag. The-verbose flag overrides theoutput format when stdout the results while saving them in the output file

# Write output in json format to results.json as well as stdout$ gosec -fmt=json -out=results.json -stdout*.go# Overrides the output format to 'text' when stdout the results, while writing it to results.json$ gosec -fmt=json -out=results.json -stdout -verbose=text*.go

Note: gosec generates thegeneric issue import format for SonarQube, and a report has to be imported into SonarQube usingsonar.externalIssuesReportPaths=path/to/gosec-report.json.

CONTRIBUTING.md contains detailed information about adding new rules to gosec.

You can build the binary with:

make

Install the tool with :

go get -u github.com/a-h/generate/cmd/schema-generate

Then generate the types with :

schema-generate -i sarif-schema-2.1.0.json -o mypath/types.go

Most of the MarshallJSON/UnmarshalJSON are removed except the one for PropertyBag which is handy to inline the additional properties. The rest can be removed.The URI,ID, UUID, GUID were renamed so it fits the Go convention definedhere

You can run all unit tests using:

maketest

You can create a release by tagging the version as follows:

git tag v1.0.0 -m"Release version v1.0.0"git push origin v1.0.0

The GitHubrelease workflow triggers immediately after the tag is pushed upstream. This flow willrelease the binaries using thegoreleaser action and then it will build and publish the docker image into Docker Hub.

The released artifacts are signed usingcosign. You can use the public key fromcosign.pubfile to verify the signature of docker image and binaries files.

The docker image signature can be verified with the following command:

cosign verify --key cosign.pub securego/gosec:<TAG>

The binary files signature can be verified with the following command:

cosign verify-blob --key cosign.pub --signature gosec_<VERSION>_darwin_amd64.tar.gz.sig  gosec_<VERSION>_darwin_amd64.tar.gz

You can also build locally the docker image by using the command:

make image

You can run thegosec tool in a container against your local Go project. You only have to mount the projectinto a volume as follows:

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

Note: the current working directory needs to be set with-w option in order to get successfully resolved the dependencies from go module file

The configuration of TLS rule can be generated fromMozilla's TLS ciphers recommendation.

First you need to install the generator tool:

go get github.com/securego/gosec/v2/cmd/tlsconfig/...

You can invoke now thego generate in the root of the project:

go generate ./...

This will generate therules/tls_config.go file which will contain the current ciphers recommendation from Mozilla.

This is alist with some of the gosec's users.

Support this project by becoming a sponsor. Your logo will show up here with a link to your website

Contributors153 (153)

• Open an issue11 (11)
• Pull requests0 (0)
• View source code
• Report abuse

Gosec Security Checker is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Resources