mirror of
https://github.com/securego/gosec.git
synced 2024-11-05 19:45:51 +00:00
102 lines
3.8 KiB
Markdown
102 lines
3.8 KiB
Markdown
|
|
|
|
## GAS - Go AST Scanner
|
|
|
|
Inspects source code for security problems by scanning the Go AST.
|
|
|
|
### Project status
|
|
|
|
[](https://travis-ci.org/HewlettPackard/gas)
|
|
|
|
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](https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility) standards recommended by Mozilla.
|
|
- __tls_ok__ - Checks to ensure ciphers and protocol versions are
|
|
explicitly enabled to meet the [intermediate compatibility]( https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29) standards recommended by Mozilla.
|
|
- __tls_old__ - Checks to ensure ciphers and protocol versions are
|
|
explicitly enabled to meet the [older compatibility](https://wiki.mozilla.org/Security/Server_Side_TLS#Old_compatibility_.28default.29) 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](https://httpoxy.org/) 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](https://golang.org/pkg/path/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.
|
|
|
|
```go
|
|
|
|
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
|
|
```
|