search

trailofbits / siderophile

Find the ideal fuzz targets in a Rust codebase
https://blog.trailofbits.com/2019/07/01/siderophile-expose-your-crates-unsafety/
MIT License
201 stars 13 forks source link

Detailed installation instructions for Ubuntu #275

Open bbresearcher opened 3 months ago

bbresearcher commented 3 months ago

I installed siderophile to test some rust code, but I ran into a few errors that I needed to find a workaround for. I decided to document the process for both the crates.io and the github build process. For each method's installation a fresh Ubuntu VM was set up. Please feel free to decline to PR should it not be something you feel is needed.

CLAassistant commented 3 months ago

CLA assistant check
All committers have signed the CLA.

woodruffw commented 3 months ago

Thanks @bbresearcher! I've left a few style nitpicks, but this LGTM overall in terms of content. Some thoughts:

  1. I'm so-so on including high-level steps like "install cURL" and "install Rust" -- IMO these could just be links or omitted entirely, since a user who wants to scan a Rust crate with siderophile probably already has Rust installed or knows enough about Rust to install it.
  2. I'm okay with this being a separate documentation file, but IMO it could also just go on the wiki instead.
bbresearcher commented 3 months ago

Thank you I have made the suggested changes. I am more than happy for the instructions to be moved to a wiki (apologies I tried to follow the link in your comment, but I can't find the wiki folder). I am also more than happy if you prefer to not include these instructions in the github repository.