Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add trophy case to README #20

Closed
Shnatsel opened this issue Aug 31, 2019 · 8 comments
Closed

Add trophy case to README #20

Shnatsel opened this issue Aug 31, 2019 · 8 comments

Comments

@Shnatsel
Copy link
Member

It's important for collaborative projects to show progress, as it motivates further participation. To that end we should surface the crates already audited and/or cleansed in the README.

@Lokathor
Copy link
Contributor

yes plz add the randomize-3.0 crate <3

@Shnatsel
Copy link
Member Author

Here's what I think it could look like:


libflate

Discovered and fixed a security issue plus 3 non-expoitable safety issues. Reduced number of unsafe blocks in the crate from 16 to 1, two of which were replaced with shared dependency crates. More info


Or we could go for a more structured format, such as:

Crate Unsafe blocks before Unsafe blocks after Security issues found Comments Tracking issue
libflate 16 1 RUSTSEC-2019-0010 Also fixed 3 non-exploitable memory safety issues #1

Thoughts?

@Shnatsel
Copy link
Member Author

@oyvindln would you be OK with your recent work on miniz_oxide being showcased on this repository?

@Lokathor
Copy link
Contributor

that table format looks crazy bad on mobile display. Let's stick to paragraphs which will reflow to smaller screens easily.

@Shnatsel
Copy link
Member Author

On the other hand I really like the structured presentation that provides an overview at a glance. https://github.com/rust-fuzz/trophy-case just goes down that route and doesn't care about mobile.

Perhaps we could strike a middle ground with bullet points? How about this:


libflate

Also discovered and fixed 3 non-expoitable safety issues.

@Shnatsel
Copy link
Member Author

We should probably also credit the people who performed the audit. Attribution is important and also helps motivate contributors.

@oyvindln
Copy link

@Shnatsel sure

@Shnatsel
Copy link
Member Author

Added initial version in #23. Please add your contributions!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants