randombit/botan

Fuzzers and fuzzer documentation could use some love

Open

#4,061 opened on May 17, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (654 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (3,283 stars)
PR merge metrics
 (PR metrics pending)

Description

  • The docs are out of date, eg referencing LLVM's subversion repo which no longer even exists.
  • libFuzzer is not explicitly required anymore, instead we should use -fsanitize=fuzzer for linking
  • AFL support hasn't been tested in years
  • Fuzzers could use a little work like std::span argument to fuzz and better assertion predicates
  • Don't require ChaChaRng if it's not used by the fuzzer Replace ChaChaRng with something really fast/stupid that the fuzzer will be able to reason about

Contributor guide

Research direction
Update the fuzzer documentation to remove references to LLVM's subversion repo and replace ` fsanitize coverage` with ` fsanitize=fuzzer`. Test AFL support and refactor fuzzer code to use `std::span` and better assertion predicates. Replace ChaChaRng with a faster, simpler RNG.
Tech stack
cpp
Domain
security
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C++Fuzzing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55