Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

libafl_libfuzzer: documentation and build script #1596

Merged
merged 2 commits into from
Oct 3, 2023
Merged

Conversation

addisoncrump
Copy link
Collaborator

This adds additional usage documentation for libafl_libfuzzer for both using with Rust and C targets. Additionally, it provides a build script which assembles the required libFuzzer.a for use with C-like targets.

@addisoncrump addisoncrump added the libafl_libfuzzer Bugs or features relating to libafl_libfuzzer label Oct 2, 2023
@addisoncrump addisoncrump requested a review from s1341 October 2, 2023 12:59
Copy link
Collaborator

@s1341 s1341 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from the two nitpicks, looks good to me...

libafl_libfuzzer/README.md Outdated Show resolved Hide resolved
libafl_libfuzzer/README.md Outdated Show resolved Hide resolved
@s1341
Copy link
Collaborator

s1341 commented Oct 2, 2023

Oh. One last thing. Can we maybe make the build script a cargo make toml or a build.rs?

@addisoncrump
Copy link
Collaborator Author

Oh. One last thing. Can we maybe make the build script a cargo make toml or a build.rs?

Potentially yes on the cargo-make, but definitely no on build.rs. For now, the .sh is just easier 🙂

@s1341
Copy link
Collaborator

s1341 commented Oct 2, 2023

yeah. it's just inconsistent.

Copy link
Collaborator

@s1341 s1341 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@domenukk
Copy link
Member

domenukk commented Oct 3, 2023

cargo make should be trivial, right? Just paste the script in there, basically

@domenukk domenukk merged commit 20f1119 into main Oct 3, 2023
17 checks passed
@domenukk domenukk deleted the libfuzzer-docs branch October 3, 2023 07:56
@addisoncrump
Copy link
Collaborator Author

addisoncrump commented Oct 4, 2023

Ah, yeah, but it wouldn't be windows/macOS compat. I think we already have a strategy for this, I'll make a follow-up PR in the oncoming days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
libafl_libfuzzer Bugs or features relating to libafl_libfuzzer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants