Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Commit aead8d5

Browse files
author
Michel Casabianca
committed
Fixed documentation
1 parent 3130fd2 commit aead8d5

1 file changed

Lines changed: 2 additions & 10 deletions

File tree

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Gobinsec
22

3-
This tool parses Go binary dependencies and calls [NVD database](https://nvd.nist.gov/) to produce a vulnerability report.
3+
This tool parses Go binary dependencies and calls [NVD database](https://nvd.nist.gov/) to produce a vulnerability report. Binaries must have been built with module support to be analyzed with Gobinsec.
44

55
## Table of Contents
66

@@ -220,15 +220,7 @@ Here is a list of sites where you can find information about vulnerabilities:
220220

221221
## How Gobinsec works
222222

223-
This tool first lists dependencies embedded in binary with `go version -m binary` command:
224-
225-
```
226-
$ go version -m test/binary
227-
test/binary: go1.17.3
228-
path nancy-test
229-
mod nancy-test (devel)
230-
dep golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
231-
```
223+
This tool first lists dependencies embedded in binary using [buildinfo package](https://pkg.go.dev/debug/buildinfo).
232224

233225
Then, it calls [National Vulnerability Database](https://nvd.nist.gov/) to lists known vulnerabilities for embedded dependencies. You can find documentation on its API at <https://nvd.nist.gov/developers/vulnerabilities> and get an API key here: <https://nvd.nist.gov/developers/request-an-api-key>.
234226

0 commit comments

Comments
 (0)