Skip to content

Commit

Permalink
Move OSV scanner directory, and update README. (#377)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverchang committed Apr 6, 2022
1 parent 42c14d9 commit a6ff9ea
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 15 deletions.
41 changes: 41 additions & 0 deletions tools/osv-scanner/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Vulnerability scanner (preview).

This contains a vulnerability scanner written in Go.

This tool is currently under development and is subject
to change.

## Scanning an SBOM

[SPDX] and [CycloneDX] SBOMs using [Package URLs] are
supported. The format is auto-detected based on the
input file contents.

[SPDX]: https://spdx.dev/
[CycloneDX]: https://cyclonedx.org/
[Package URLs]: https://github.com/package-url/purl-spec

```bash
$ go run cmd/scanner.go /path/to/your/sbom.json
```

### Example

```bash
$ go run cmd/scanner.go /path/to/your/repo
```

## Scanning a directory

Given a list of directories, this tool will recursively
search for git repositories and make requests to OSV to
determine affected vulnerabilities.

This is intended to work with projects that use git submodules or a similar
mechanism where dependencies are checked out as real git repositories.

### Example

```bash
$ go run cmd/scanner.go /path/to/your/repo
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 0 additions & 15 deletions tools/scanner/README.md

This file was deleted.

0 comments on commit a6ff9ea

Please sign in to comment.