Skip to content

Commit

Permalink
Update advisory diagnostics
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake-Shadle committed Oct 7, 2022
1 parent 3be35d4 commit 7ecb6bb
Show file tree
Hide file tree
Showing 12 changed files with 807 additions and 30 deletions.
20 changes: 10 additions & 10 deletions docs/src/checks/advisories/diags.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
# Advisories Diagnostics

### `A001` - security vulnerability detected
### `vulnerability` - security vulnerability detected

A [`vulnerability`](cfg.md#the-vulnerability-field-optional) advisory was detected for a crate.

### `A002` - notice advisory detected
### `notice` - notice advisory detected

A [`notice`](cfg.md#the-notice-field-optional) advisory was detected for a crate.

### `A003` - unmaintained advisory detected
### `unmaintained` - unmaintained advisory detected

An [`unmaintained`](cfg.md#the-unmaintained-field-optional) advisory was detected for a crate.

### `A004` - unsound advisory detected
### `unsound` - unsound advisory detected

An [`unsound`](cfg.md#the-unsound-field-optional) advisory was detected for a crate.

### `A005` - detected yanked crate
### `yanked` - detected yanked crate

A crate using a version that has been [yanked](cfg.md#the-yanked-field-optional) from the registry index was detected.

### `A006` - unable to check for yanked crates
### `index_failure` - unable to check for yanked crates

An error occurred trying to read or update the registry index (typically crates.io) so cargo-deny was unable to check the current yanked status for any crate.

### `A007` - advisory was not encountered
### `advisory_not_detected` - advisory was not detected

An advisory in [`advisories.ignore`](cfg.md#the-ignore-field-optional) didn't apply to any crate.
An advisory in [`advisories.ignore`](cfg.md#the-ignore-field-optional) didn't apply to any crate. This could happen if the advisory was [withdrawn](https://docs.rs/rustsec/latest/rustsec/advisory/struct.Metadata.html#structfield.withdrawn), or the version of the crate no longer falls within the range of affected versions the advisory applies to.

### `A008` - advisory not found in any advisory database
### `unknown_advisory` - advisory not found in any advisory database

An advisory in [`advisories.ignore`](cfg.md#the-ignore-field-optional) wasn't found in any of the configured advisory databases.
An advisory in [`advisories.ignore`](cfg.md#the-ignore-field-optional) wasn't found in any of the configured advisory databases, usually indicating a typo, as advisories, at the moment, are never deleted from the database, at least the canonical [advisory-db](https://github.com/rustsec/advisory-db).
Loading

0 comments on commit 7ecb6bb

Please sign in to comment.