Skip to content

Commit

Permalink
Fixing formatting issues on markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
andream16 committed Sep 17, 2024
1 parent 78cfc67 commit b259191
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 15 deletions.
20 changes: 11 additions & 9 deletions components/enrichers/reachability/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Reachability

This enricher performs reachability analysis
This enricher performs reachability analysis
using [atom](https://github.com/AppThreat/atom).

It enriches the raw results in input, for example
Expand All @@ -11,16 +11,18 @@ to be set as the mechanism to generate the
reports are different based on programming language.

## Environment variables
- `READ_PATH`: specifies the location from where to look for raw reports.
- `WRITE_PATH`: specifies the location where to write enriched results.
- `ATOM_FILE_PATH`: specifies the location where to find
the atom file with a reachability report.

* `READ_PATH`: specifies the location from where to look for raw reports.
* `WRITE_PATH`: specifies the location where to write enriched results.
* `ATOM_FILE_PATH`: specifies the location where to find
the atom file with a reachability report.

## Limitations
- Right now the enricher requires a file called `bom.json`
to be produced by [cdxgen](https://github.com/CycloneDX/cdxgen)
to be present in the directory where the cloned repository
is located.

* Right now the enricher requires a file called `bom.json`
to be produced by [cdxgen](https://github.com/CycloneDX/cdxgen)
to be present in the directory where the cloned repository
is located.

## Examples

Expand Down
12 changes: 6 additions & 6 deletions components/enrichers/reachability/test/testdata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ for example [fportantier/vulpy](https://github.com/fportantier/vulpy).

1. Checkout [bandit](https://github.com/PyCQA/bandit).
2. Get a bandit report in json format:
`bandit -r $directory --format json --output out.json`.
`$directory` is where you cloned the repository with vulnerabilities.
3. Get `/producer/python-bandit` to read in input `out.json`
and in output `out.tagged.pb`.
`bandit -r $directory --format json --output out.json`.
`$directory` is where you cloned the repository with vulnerabilities.
3. Get `/producer/python-bandit` to read in input `out.json`
and in output `out.tagged.pb`.

### pip-safety.tagged.pb

1. Checkout [safety](https://pypi.org/project/safety/)
2. Get a safety report in json format:
`safety check -r requirements.txt --save-json out.json`
`safety check -r requirements.txt --save-json out.json`
3. Get `producer/python-pip-safety` to read in input `out.json`
and in output `pip-safety.tagged.pb`
and in output `pip-safety.tagged.pb`

### reachables.json

Expand Down

0 comments on commit b259191

Please sign in to comment.