fuzzprep 0.1.0__tar.gz

fuzzprep-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2026 Trail of Bits <opensource@trailofbits.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fuzzprep-0.1.0/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: fuzzprep
+Version: 0.1.0
+Summary: Prepare software libraries for reproducible OSS-Fuzz project generation.
+Author: Trail of Bits
+Author-email: Trail of Bits <opensource@trailofbits.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Requires-Dist: pyyaml>=6.0
+Requires-Python: >=3.13
+Project-URL: Homepage, https://pypi.org/project/fuzzprep/
+Project-URL: Source, https://github.com/trailofbits/fuzzprep
+Project-URL: Issues, https://github.com/trailofbits/fuzzprep/issues
+Description-Content-Type: text/markdown
+
+# FuzzPrep
+
+FuzzPrep is a CLI that takes the manual effort out of building C/C++ libraries for fuzzing
+while aiming to minimize LLM token cost. It detects the build system, builds the library,
+probes harness compilation to find linker dependencies, and writes artifacts that build and
+link the library against a harness.
+
+## Prerequisites
+
+### What FuzzPrep needs
+
+- Python 3.13 and [`uv`](https://docs.astral.sh/uv/).
+- `git`, to clone the target repository.
+- `clang` and `clang++`, the default compilers. `--cc` and `--cxx` select others.
+- libFuzzer's runtime, which `clang` links for the default `-fsanitize=fuzzer` harness flags.
+  It is a separate package: `libclang-rt-dev` on Debian and Ubuntu, `compiler-rt` elsewhere.
+  A plain `apt install clang` pulls it in as a recommended package, but an install that uses
+  `--no-install-recommends` does not, so name it.
+
+```bash
+sudo apt update
+sudo apt install -y git clang libclang-rt-dev
+```
+
+### Common library build dependencies
+
+A target brings its own build dependencies: the build system it uses, and the `-dev` packages
+it links against. FuzzPrep reports the packages a failed run is missing. The below script also installs a set that covers many targets — the four supported build systems, the usual codegen and
+archive utilities, and the libraries FuzzPrep knows how to identify from error traces:
+
+```bash
+./scripts/install_common_deps.sh
+```
+
+The list is not exhaustive. When a build fails on a dependency the script does not cover,
+install that dependency and run again.
+
+### Optional
+
+- Docker, for `--environment oss-fuzz`.
+- The `claude` or `codex` CLI, for agent repair. It is on by default; `--no-agents` turns it
+  off and no CLI is then needed.
+- [`bear`](https://github.com/rizsotto/Bear), for Make and Autotools targets built with
+  `--environment local`. It captures `compile_commands.json`, which `extract-features` and
+  `generate-yaml` read.
+- `cmake`, `llvm-dev`, `libclang-20`, and `libclang-dev`, which `extract-features` builds its Clang
+  LibTooling parser against. With more than one LLVM installed, point `CMAKE_PREFIX_PATH` at
+  the tree the `clang` on `PATH` belongs to.
+
+The apt packages among these:
+
+```bash
+sudo apt install -y bear cmake llvm-dev libclang-dev libclang-20
+```
+
+## Install
+
+```bash
+uv sync
+```
+
+## Quickstart
+
+>**Best practice:** Run FuzzPrep in a container or disposable VM. FuzzPrep compiles and executes
+> arbitrary build-system logic from the target library. Its agentic workflow may also write and
+> execute build scripts, so it should be run in an isolated environment.
+
+From a local checkout after `uv sync`:
+
+```bash
+# Clones the repository, builds it, verifies it, and writes `output/zlib/`.
+uv run fuzzprep generate https://github.com/madler/zlib.git
+```
+
+To run FuzzPrep without cloning this repository:
+
+```bash
+uvx fuzzprep generate https://github.com/madler/zlib.git
+```
+
+Other useful flags include:
+
+```bash
+# Verify in the OSS-Fuzz Docker environment instead of on the host
+uv run fuzzprep generate <REPO_URL> --environment oss-fuzz
+
+# Turn off agent repair: a failed build then simply fails the run
+uv run fuzzprep generate <REPO_URL> --no-agents
+
+# Pass build-system configure options (repeat for more than one)
+uv run fuzzprep generate <REPO_URL> --library-configure-arg=-DCARES_STATIC=ON
+
+# Skip the from-scratch rebuild that validates an agent's repair, for a faster run
+uv run fuzzprep generate <REPO_URL> --bypass-scratch-validation
+
+# Use distinct library and final-harness instrumentation defaults
+uv run fuzzprep generate <REPO_URL> --environment local \
+  --cc clang --cxx clang++ \
+  --library-cflags='-fsanitize=fuzzer-no-link,address' \
+  --library-cxxflags='-fsanitize=fuzzer-no-link,address' \
+  --harness-cflags='-fsanitize=fuzzer,address' \
+  --harness-cxxflags='-fsanitize=fuzzer,address'
+```
+
+Agent repair is on by default and calls a paid network service. `--agent claude` (the
+default) or `--agent codex` selects the backend; `--no-agents` turns it off.
+
+See `uv run fuzzprep generate --help` for the full set of options (custom output
+location, pinning a branch/tag/commit, a different base image, etc).
+
+### Adaptable builds
+
+The generated build scripts let you supply your own toolchain and flags:
+
+```bash
+CC=afl-clang-fast CXX=afl-clang-fast++ \
+CFLAGS=-fsanitize=address CXXFLAGS=-fsanitize=address \
+  ./build_library.sh
+```
+
+### When a run fails
+
+FuzzPrep keeps its working state in `.fuzzprep/<project>/`: the workspace it built in,
+`logs/` with the raw output of each phase, and `stats.json`. A failed run writes no output
+directory, but the library build artifacts stay in `.fuzzprep/<project>/install/` if you want
+to debug the link line there. Add `--log-level debug` for more detail, or `--quiet` to hide
+the raw subprocess output while a phase runs.
+
+## What it does
+
+1. Detects the build system: CMake, Meson, Autotools, or Makefile.
+2. Builds the library with a deterministic script. If that build fails, an agent repairs it.
+3. Probes harness compilation to find transitive linker dependencies. If the probe fails,
+   an agent repairs it.
+4. Writes the output directory `<output>/<project>/`.
+
+## Output
+
+The output directory provides a reproducible OSS-Fuzz project and a standalone host build
+tree. `docker build .` works, and so does `./setup.sh && ./build_library.sh`.
+
+```
+output/<project>/
+├── Dockerfile             # OSS-Fuzz project files
+├── project.yaml           # OSS-Fuzz project metadata
+├── .dockerignore
+├── setup.sh               # Script for repo clone + apt dependencies
+├── build.sh               # Builds the library and compiles the provided harness
+├── build_library.sh       # build and install the library into install/
+├── compile_harness.sh     # compile and link one harness source
+├── compile_harnesses.sh   # compile every source in harness_source/ into out/
+├── harness_source/        # source code of all harnesses
+├── install/               # the library this run built
+├── compile_commands.json  # captured compile commands
+├── stats.json             # what this run did: durations, agent use, status
+└── README.md              # what this run verified, and how to run it
+```
+
+`harness_source/` starts with a stub — an `LLVMFuzzerTestOneInput` with a
+`// TODO: Add fuzzing logic` body. FuzzPrep proves the harness *compiles and links* against
+the library; writing the fuzzing logic is yours.
+
+## Environments
+
+`--environment` selects where this run builds and verifies. It does not change what is
+generated: the output directory always holds both setups. The generated `README.md` records
+which of the two this run exercised.
+
+- `local` — build and verify on the host.
+- `oss-fuzz` — build and verify in an OSS-Fuzz compatible Docker container, then prove the
+  generated Dockerfile builds from scratch.
+
+Neither environment isolates the target's build from your machine well enough to trust it.
+Run both inside a VM or an isolated machine.
+
+## Other commands
+
+`generate` produces a `compile_commands.json` file that two follow-on commands consume, to
+extract the library's API surface (`extract-features`) and to produce an OSS-Fuzz-Gen
+compatible YAML input (`generate-yaml`).
+
+```bash
+uv run fuzzprep extract-features <BUILD_PATH>   # -> features.json (run this first)
+uv run fuzzprep generate-yaml <BUILD_PATH>      # -> <project>.yaml
+```
+
+`extract-features` runs a Clang LibTooling-based parser over every header and source file in
+`compile_commands.json`. It writes `<BUILD_PATH>/features.json`, a structured inventory of
+the library's C/C++ declarations:
+
+- `functions` — name, return type, parameters, full signature, declaring header, and
+  whether it is public API (declared in a header, not `static`)
+- `typedefs` — name, underlying type, declaring header
+- `macros` — name, object- or function-like, parameters (if function-like), value,
+  declaring header
+- `enums` — name (if any), enumerators with their values, declaring header
+- `records` — structs and unions: name (if any), `kind`, fields, declaring header
+- `warnings` — non-fatal problems found during the parse
+
+`generate-yaml` reads `features.json` and keeps only the public functions. To get
+finer-grained output, name one or more headers and it keeps only the functions those headers
+declare:
+
+```bash
+uv run fuzzprep generate-yaml <BUILD_PATH> zlib.h zconf.h
+```
+
+Run `uv run fuzzprep --help` for details.
+
+## Security
+
+FuzzPrep clones and builds arbitrary third-party repositories, which runs their build systems
+on your machine, and it hands a repair agent write access to the run's workspace.
+
+Run it in a VM or on a dedicated machine you can wipe, whatever `--environment` you pick. A
+container shares the host kernel and is not a boundary that holds against code written to
+break out of one, so `--environment oss-fuzz` reduces the blast radius of an ordinary build
+but does not contain a hostile one. `--no-agents` turns agent repair off.
+
+[SECURITY.md](SECURITY.md) has the full threat model and tells you how to report a
+vulnerability.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the local setup, the checks a pull request must
+pass, and what each pytest marker needs. Participation is governed by the
+[Code of Conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+FuzzPrep is licensed under [Apache-2.0](LICENSE).
+
+The `feature_extractor` tool that `extract-features` builds links cJSON and the LLVM/Clang
+libraries. [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) records their licenses and the
+notices that apply if you redistribute that binary.
+
+Some files under `tests/real_harnesses/` come from upstream projects and keep their own
+licenses; [that directory's README](tests/real_harnesses/README.md) records the provenance of
+each one.