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

Document fuzzer usage #3478

Merged
merged 2 commits into from
May 9, 2022
Merged

Document fuzzer usage #3478

merged 2 commits into from
May 9, 2022

Conversation

nlohmann
Copy link
Owner

@nlohmann nlohmann commented May 8, 2022

This PR adds documentation how to use LibFuzzer or afl++.

@nlohmann nlohmann added documentation review needed It would be great if someone could review the proposed changes. labels May 8, 2022
@nlohmann nlohmann added this to the Release 3.11.0 milestone May 8, 2022
@nlohmann nlohmann self-assigned this May 8, 2022
@coveralls
Copy link

coveralls commented May 8, 2022

Coverage Status

Coverage remained the same at 100.0% when pulling f92e6d0 on fuzzer_doc into b205361 on develop.

Copy link
Contributor

@falbrechtskirchinger falbrechtskirchinger left a comment

Choose a reason for hiding this comment

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

In addition to my review comments, you should also mention the working directory for the commands.

tests/fuzzing.md Outdated Show resolved Hide resolved
tests/fuzzing.md Show resolved Hide resolved
tests/fuzzing.md Outdated Show resolved Hide resolved
@nlohmann
Copy link
Owner Author

nlohmann commented May 9, 2022

@falbrechtskirchinger Can I merge this? Or should we update the AFL wrapper with the one you used with AFL++?

@falbrechtskirchinger
Copy link
Contributor

@falbrechtskirchinger Can I merge this? Or should we update the AFL wrapper with the one you used with AFL++?

Let me give it another read, then you can merge it. We can update the AFL wrapper some other time.

I'd like to understand how the make targets are used by OSS-fuzz (haven't looked at build.sh which I've seen linked in comments) and maybe move the fuzz testing into the CMake code since the more advanced AFL++ use requires building two fuzzer binaries and then running the fuzzer requires a different command as well. All of that would be easier to do in CMake (we're also already downloading the test date which could simplify and automate corpus generation).

Copy link
Contributor

@falbrechtskirchinger falbrechtskirchinger left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@nlohmann
Copy link
Owner Author

nlohmann commented May 9, 2022

Alright. I would like to avoid requiring OSS-Fuzz to use CMake. But the targets in the root Makefile can be removed/replaced.

@nlohmann nlohmann added release item: 🔨 further change and removed review needed It would be great if someone could review the proposed changes. labels May 9, 2022
@nlohmann nlohmann merged commit d6efe67 into develop May 9, 2022
@nlohmann nlohmann deleted the fuzzer_doc branch May 9, 2022 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants