Skip to content

Commit e6641c6

Browse files
committed
Replace gas with gosec in the README file
1 parent 893b87b commit e6641c6

File tree

1 file changed

+23
-26
lines changed

1 file changed

+23
-26
lines changed

README.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22

3-
## GAS - Go Application Security
3+
## gosec -Golang Security Checker
44

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

@@ -12,26 +12,23 @@ You may obtain a copy of the License [here](http://www.apache.org/licenses/LICEN
1212

1313
### Project status
1414

15-
[![Build Status](https://travis-ci.org/securego/gas.svg?branch=master)](https://travis-ci.org/securego/gas)
16-
[![GoDoc](https://godoc.org/github.com/securego/gas?status.svg)](https://godoc.org/github.com/securego/gas)
17-
18-
Gas is still in alpha and accepting feedback from early adopters. We do
19-
not consider it production ready at this time.
15+
[![Build Status](https://travis-ci.org/securego/gosec.svg?branch=master)](https://travis-ci.org/securego/gosec)
16+
[![GoDoc](https://godoc.org/github.com/securego/gosec?status.svg)](https://godoc.org/github.com/securego/gosec)
2017

2118
### Install
2219

23-
`$ go get github.com/securego/gas/cmd/gas/...`
20+
`$ go get github.com/securego/gosec/cmd/gosec/...`
2421

2522
### Usage
2623

27-
Gas can be configured to only run a subset of rules, to exclude certain file
24+
Gosec can be configured to only run a subset of rules, to exclude certain file
2825
paths, and produce reports in different formats. By default all rules will be
2926
run against the supplied input files. To recursively scan from the current
3027
directory you can supply './...' as the input argument.
3128

3229
#### Selecting rules
3330

34-
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 '-include=' flag,
31+
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,
3532
or to specify a set of rules to explicitly exclude using the '-exclude=' flag.
3633

3734
##### Available rules
@@ -63,22 +60,22 @@ or to specify a set of rules to explicitly exclude using the '-exclude=' flag.
6360

6461
```
6562
# Run a specific set of rules
66-
$ gas -include=G101,G203,G401 ./...
63+
$ gosec -include=G101,G203,G401 ./...
6764
6865
# Run everything except for rule G303
69-
$ gas -exclude=G303 ./...
66+
$ gosec -exclude=G303 ./...
7067
```
7168

7269
#### Excluding files:
7370

74-
Gas will ignore dependencies in your vendor directory any files
71+
gosec will ignore dependencies in your vendor directory any files
7572
that are not considered build artifacts by the compiler (so test files).
7673

7774
#### Annotating code
7875

79-
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.
76+
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.
8077

81-
The annotation causes Gas to stop processing any further nodes within the
78+
The annotation causes gosec to stop processing any further nodes within the
8279
AST so can apply to a whole block or more granularly to a single expression.
8380

8481
```go
@@ -102,26 +99,26 @@ have been used. To run the scanner and ignore any #nosec annotations you
10299
can do the following:
103100

104101
```
105-
$ gas -nosec=true ./...
102+
$ gosec -nosec=true ./...
106103
```
107104
#### Build tags
108105

109-
Gas is able to pass your [Go build tags](https://golang.org/pkg/go/build/) to the analyzer.
106+
gosec is able to pass your [Go build tags](https://golang.org/pkg/go/build/) to the analyzer.
110107
They can be provided as a comma separated list as follows:
111108

112109
```
113-
$ gas -tag debug,ignore ./...
110+
$ gosec -tag debug,ignore ./...
114111
```
115112

116113
### Output formats
117114

118-
Gas currently supports text, json, yaml, csv and JUnit XML output formats. By default
115+
gosec currently supports text, json, yaml, csv and JUnit XML output formats. By default
119116
results will be reported to stdout, but can also be written to an output
120117
file. The output format is controlled by the '-fmt' flag, and the output file is controlled by the '-out' flag as follows:
121118

122119
```
123120
# Write output in json format to results.json
124-
$ gas -fmt=json -out=results.json *.go
121+
$ gosec -fmt=json -out=results.json *.go
125122
```
126123
### Development
127124

@@ -144,7 +141,7 @@ make test
144141

145142
#### Release Build
146143

147-
Gas can be released as follows:
144+
gosec can be released as follows:
148145

149146
```bash
150147
make release VERSION=2.0.0
@@ -153,11 +150,11 @@ make release VERSION=2.0.0
153150
The released version of the tool is available in the `build` folder. The build information should be displayed in the usage text.
154151

155152
```
156-
./build/gas-2.0.0-linux-amd64 -h
153+
./build/gosec-2.0.0-linux-amd64 -h
157154
158-
GAS - Go AST Scanner
155+
gosec - Golang security checker
159156
160-
Gas analyzes Go source code to look for common programming mistakes that
157+
gosec analyzes Go source code to look for common programming mistakes that
161158
can lead to security problems.
162159
163160
VERSION: 2.0.0
@@ -174,10 +171,10 @@ You can execute a release and build the docker image as follows:
174171
make image VERSION=2.0.0
175172
```
176173

177-
Now you can run the gas tool in a container against your local workspace:
174+
Now you can run the gosec tool in a container against your local workspace:
178175

179176
```
180-
docker run -it -v <YOUR LOCAL WORKSPACE>:/workspace gas /workspace
177+
docker run -it -v <YOUR LOCAL WORKSPACE>:/workspace gosec /workspace
181178
```
182179

183180
#### Generate TLS rule
@@ -188,7 +185,7 @@ The configuration of TLS rule can be generated from [Mozilla's TLS ciphers recom
188185
First you need to install the generator tool:
189186

190187
```
191-
go get github.com/securego/gas/cmd/tlsconfig/...
188+
go get github.com/securego/gosec/cmd/tlsconfig/...
192189
```
193190

194191
You can invoke now the `go generate` in the root of the project:

0 commit comments

Comments
 (0)