gas

README

GAS - Go AST Scanner

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

Project status

Gas is still in alpha and accepting feedback from early adopters. We do not consider it production ready at this time.

Usage

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

Selecting rules

By default Gas will run all rules against the supplied file paths. It is however possible to select a subset of rules to run via the '-rule=' flag.

Available rules

• crypto - Detects use of weak cryptography primitives.
• tls - Detects if TLS certificate verification is disabled.
• sql - SQL injection vectors.
• hardcoded - Potential hardcoded credentials.
• perms - Insecure file permissions.
• tempfile - Insecure creation of temporary files
• unsafe- Detects use of the unsafe pointer functions.
• bind- Listening on all network interfaces.
• rsa- Warns for RSA keys that are less than 2048 bits.
• tls_good - Checks to ensure ciphers and protocol versions are explicitly enabled to meet the modern compatibility standards recommended by Mozilla.
• tls_ok - Checks to ensure ciphers and protocol versions are explicitly enabled to meet the intermediate compatibility standards recommended by Mozilla.
• tls_old - Checks to ensure ciphers and protocol versions are explicitly enabled to meet the older compatibility standards recommended by Mozilla.
• templates - Detect cases where input is not escaped when entered into Go HTML templates.
• exec - Report cases where the application is executing an external process.
• errors - Report error return values that are ignored.
• httpoxy - Report on CGI usage as it may indicate vulnerability to the httpoxy vulnerability.

$ gas -rule=rsa -rule=tls -rule=crypto ./...

Excluding files:

Gas can be told to \ignore paths that match a supplied pattern using the 'skip' command line option. This accomplished via filepath.Match. Multiple patterns can be specified as follows:

$ gas -skip=tests* -skip=*_example.go ./...

Annotating code

As with all automated detection tools there will be cases of false positives. In cases where Gas 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 Gas 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
    }

}

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:

$ gas -nosec=true ./...

Output formats

Gas currently supports text, json and csv 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
$ gas -fmt=json -out=results.json *.go