nancy is a tool to check for vulnerabilities in your Golang dependencies, powered by Sonatype OSS Index.
To use nancy, assuming you have a built version of it:
./nancy /path/to/your/Gopkg.lock./nancy /path/to/your/go.sum
nancy currently works for projects that use dep or go mod for dependencies.
You can run nancy in a quiet manner, only getting back a list of vulnerable components by running:
./nancy -quiet /path/to/your/Gopkg.lock./nancy -quiet /path/to/your/go.sum
Sometimes you'll run into a dependency that after taking a look at, you either aren't affected by, or cannot resolve for some reason. Nancy understands, and will let you exclude these vulnerabilities so you can get back to a passing build:
./nancy -exclude-vulnerability CVE-789,bcb0c38d-0d35-44ee-b7a7-8f77183d1ae2 /path/to/your/Gopkg.lock./nancy -exclude-vulnerability CVE-789,bcb0c38d-0d35-44ee-b7a7-8f77183d1ae2 /path/to/your/go.sum
Vulnerabiliites excluded will then be silenced and not show up in the output or fail your build.
We support exclusion of vulnerability either by CVE-ID (ex: CVE-2018-20303) or via the OSS Index ID (ex: a8c20c84-1f6a-472a-ba1b-3eaedb2a2a14) as not all vulnerabilities have a CVE-ID.
You can see an example of using nancy in Travis-CI at this intentionally vulnerable repo we made.
A portion of the golang ecosystem doesn't use proper versions, and instead uses a commit hash to resolve your dependency. Dependencies like this will not work with
nancy quite yet, as we don't have a mechanism on OSS Index to lookup vulnerabilities in that manner.
Nancy Drew was the first female detective used extensively in literature, and gave women across the world a new hero.
This project is called nancy as like the great detective herself, it looks for problems you might not be aware of, and gives you the information to help put them to an end!
At current time you have a few options:
- Build from source
- Download release binary from here on GitHub
- Run
go get github.com/sonatype-nexus-community/nancy - Nancy should now be available wherever your GOPATH is set
- Run
dep ensurein the root of the project - In the root of the project
go test ./... - If tests checkout go ahead and run
go build. - Use that binary where ever your heart so desires!
For the adventurous, we have go.mod files that enable you to build using go modules.
$ export GO111MODULE=on
$ go test ./...
$ go buildEach commit to master creates a new release binary, and if you'd like to skip building from source, you can download a binary similar to:
$ curl -O /path/where/you/want/nancy \
https://github.com/sonatype-nexus-community/nancy/releases/download/0.0.4/nancy-linux.amd64-0.0.4nancy is written using Golang 1.13, so it is best you start there.
This project also uses dep for dependencies, so you will need to download dep.
Tests can be run like go test ./... -v
We care a lot about making the world a safer place, and that's why we created nancy. If you as well want to
speed up the pace of software development by working on this project, jump on in! Before you start work, create
a new issue, or comment on an existing issue, to let others know you are!
The nancy logo was created using a combo of Gopherize.me and good ole Photoshop. Thanks to the creators of
Gopherize for an easy way to make a fun Gopher :)
Original Gopher designed by Renee French.
It is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to the open source community (read: you!)
Remember:
- Use this contribution at the risk tolerance that you have
- Do NOT file Sonatype support tickets related to
nancysupport in regard to this project - DO file issues here on GitHub, so that the community can pitch in
Phew, that was easier than I thought. Last but not least of all:
Have fun creating and using nancy and the Sonatype OSS Index, we are glad to have you here!
Looking to contribute to our code but need some help? There's a few ways to get information:
- Chat with us on Gitter