Skip to content

Commit ae22eb4

Browse files
authored
CONTRIBUTING: mention soundness issues (#314)
1 parent 5049594 commit ae22eb4

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ this repository containing the new advisory:
1313
3. Open a [Pull Request]. After being reviewed your advisory will be assigned
1414
a `RUSTSEC-*` advisory identifier and be published to the database.
1515

16-
### Optional Steps
16+
### Optional Steps
1717

1818
Feel free to do either or both of these as you see fit (we recommend you do both):
1919

@@ -35,6 +35,12 @@ examples of qualifying vulnerabilities:
3535
* Covert Channels (e.g. Spectre, Meltdown)
3636
* Panics in code advertised as "panic-free" (particularly if useful for network DoS attacks)
3737

38+
Moreover, RustSec also tracks [soundness] issues as informational advisories, independent of whether they are vulnerabilities or not.
39+
A soundness issue arises when using a crate from safe code can cause [Undefined Behavior].
40+
41+
[soundness]: https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#soundness-of-code--of-a-library
42+
[Undefined Behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
43+
3844
When in doubt, please open a PR.
3945

4046
## FAQ

0 commit comments

Comments
 (0)