This repository has been archived by the owner on Jan 30, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from nearform/add-version-check
Add version check
- Loading branch information
Showing
14 changed files
with
3,543 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,28 @@ | ||
all: install build | ||
|
||
formatter: | ||
pigeon -o versionformatter/versionformatter.go versionformatter/versionformatter.peg | ||
|
||
build: formatter | ||
go build -v -race | ||
|
||
install: | ||
go get github.com/golang/dep | ||
dep ensure | ||
|
||
dev-install: install | ||
go get -u github.com/mgechev/revive | ||
go get -u github.com/mna/pigeon | ||
|
||
ci-install: dev-install | ||
go get -u github.com/mattn/goveralls | ||
|
||
test: | ||
go test -v -race ./... | ||
go vet ./... | ||
|
||
ci-test: test | ||
goveralls | ||
|
||
lint: | ||
revive -formatter stylish pathrunner/... vulnfetcher/... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,51 @@ | ||
# Gamma Ray | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/dgonzalez/gammaray)](https://goreportcard.com/report/github.com/dgonzalez/gammaray) | ||
![Travis](https://travis-ci.org/dgonzalez/gammaray.svg?branch=master) | ||
[![Coverage Status](https://coveralls.io/repos/github/dgonzalez/gammaray/badge.svg?branch=travis)](https://coveralls.io/github/dgonzalez/gammaray?branch=travis) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/nearform/gammaray)](https://goreportcard.com/report/github.com/nearform/gammaray) | ||
![Travis](https://travis-ci.org/nearform/gammaray.svg?branch=master) | ||
[![Coverage Status](https://coveralls.io/repos/github/nearform/gammaray/badge.svg?branch=master)](https://coveralls.io/github/nearform/gammaray?branch=master) | ||
|
||
Gamm Ray is a software that helps developers to look for vulnerabilities on their Node.js | ||
Gammaray is a software that helps developers to look for vulnerabilities on their Node.js | ||
applications. Its pluggable infrastructure makes very easy to write an integration with | ||
several vulnerabilities databases. | ||
|
||
## Get It | ||
|
||
In order to get it just run: | ||
|
||
``` | ||
go get github.com/dgonzalez/gammaray | ||
```console | ||
$> go get github.com/nearform/gammaray | ||
``` | ||
Once it is finished, you should have the `gammaray` binary in your `GOPATH/bin` folder. | ||
|
||
## Build it | ||
|
||
We use `dep` to manage the dependencies for `gammaray`. In order to build it, run: | ||
|
||
``` | ||
dep ensure | ||
go build | ||
```console | ||
$> make | ||
``` | ||
|
||
## Usage | ||
|
||
Gammaray comes as a single binary so you only need to run it passing your project as argument: | ||
|
||
``` | ||
gammaray <path-to-your-node-app> | ||
```console | ||
$> gammaray <path-to-your-node-app> | ||
``` | ||
|
||
And that is all, all the vulnerabilities that affect your packages will be displayed. | ||
|
||
## Contributing | ||
|
||
Are you a developer and want to contribute? Please be my guest. | ||
### As a developer | ||
|
||
Clone the repository, then start hacking, PRs are welcome ! | ||
|
||
```console | ||
$> mkdir -p $GOPATH/src/github.com/nearform/ | ||
$> cd $GOPATH/src/github.com/nearform/ | ||
$> git clone https://github.com/nearform/gammaray.git | ||
$> cd gammaray | ||
$> make dev-install | ||
``` | ||
|
||
### As security provider | ||
|
||
Are you a security provider who wants to be integrated? Contact me [here](https://www.linkedin.com/in/david-gonzalez-microservices/) | ||
You want to be integrated? Contact me [here](https://www.linkedin.com/in/david-gonzalez-microservices/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.