Skip to content

Commit

Permalink
Added --aliases flag to documentation and included examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
pboulos committed Jan 7, 2024
1 parent 9c30eb7 commit 577471b
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,12 @@ optional arguments:
defaults to `on` for the `json` format. This flag has
no effect on the `cyclonedx-json` or `cyclonedx-xml`
formats. (default: auto)
--aliases [{on,off,auto}]
includes alias IDs for each vulnerability; `auto`
defaults to `off` for the `column` and `markdown`
formats. This flag has no effect on the
`cyclonedx-json`, `cyclonedx-xml`, and `json`
formats. (default: auto)
--cache-dir CACHE_DIR
the directory to use as an HTTP cache for PyPI; uses
the `pip` HTTP cache by default (default: None)
Expand Down Expand Up @@ -274,6 +280,16 @@ Flask 0.5 PYSEC-2019-179 1.0
Flask 0.5 PYSEC-2018-66 0.12.3
```
Audit dependencies including aliases:
```
$ pip-audit --aliases
Found 2 known vulnerabilities in 1 package
Name Version ID Fix Versions Aliases
---- ------- -------------- ------------ ------------------------------------
Flask 0.5 PYSEC-2019-179 1.0 CVE-2019-1010083,GHSA-5wv5-4vpf-pj6m
Flask 0.5 PYSEC-2018-66 0.12.3 CVE-2018-1000656,GHSA-562c-5r94-xh97
```
Audit dependencies including descriptions:
```
$ pip-audit --desc
Expand All @@ -295,13 +311,21 @@ Found 2 known vulnerabilities in 1 package
"vulns": [
{
"id": "PYSEC-2019-179",
"aliases": [
"CVE-2019-1010083",
"GHSA-5wv5-4vpf-pj6m"
],
"fix_versions": [
"1.0"
],
"description": "The Pallets Project Flask before 1.0 is affected by: unexpected memory usage. The impact is: denial of service. The attack vector is: crafted encoded JSON data. The fixed version is: 1. NOTE: this may overlap CVE-2018-1000656."
},
{
"id": "PYSEC-2018-66",
"aliases": [
"CVE-2018-1000656",
"GHSA-562c-5r94-xh97"
],
"fix_versions": [
"0.12.3"
],
Expand Down

0 comments on commit 577471b

Please sign in to comment.