mirror of
https://github.com/OMGeeky/advisory-db.git
synced 2026-01-01 01:00:23 +01:00
As proposed in #240 and tracked in #414, this PR translates all advisories into the new "V3" advisory format, which is based on Markdown with leading TOML front matter. This format makes it easier to see rendered Markdown syntax descriptions, whether rendered by an IDE or GitHub. This should help with both crafting advisories initially as well as review, and ideally encourages more lengthy descriptions. Support for this format shipped in `cargo-audit` v0.12.0 on May 6th, 2020.
30 lines
990 B
Markdown
30 lines
990 B
Markdown
```toml
|
|
[advisory]
|
|
id = "RUSTSEC-2019-0024"
|
|
package = "rustsec-example-crate"
|
|
date = "2019-10-08"
|
|
url = "https://github.com/RustSec/advisory-db/issues/158"
|
|
|
|
[versions]
|
|
patched = [">= 1.0.0"]
|
|
```
|
|
|
|
# Test advisory with associated example crate
|
|
|
|
This is a test advisory useful for verifying RustSec tooling and vulnerability
|
|
detection pipelines are working correctly. Aside from the fact that it is filed
|
|
against an example crate, it is otherwise considered by the Advisory Database
|
|
itself to be a normal security advisory.
|
|
|
|
It's filed against `rustsec-example-crate`, an otherwise completely empty crate
|
|
with no functionality or code, which has two releases:
|
|
|
|
- [v0.0.1] - *vulnerable* according to this advisory
|
|
- [v1.0.0] - *patched* by this advisory
|
|
|
|
(Technically there is a third release, v0.0.0, which is yanked, but otherwise
|
|
identical to the v0.0.1 release)
|
|
|
|
[v0.0.1]: https://crates.io/crates/rustsec-example-crate/0.0.1
|
|
[v1.0.0]: https://crates.io/crates/rustsec-example-crate/1.0.0
|