From c020c5a8ad160a33808ecbea8fc06ec4d1e9a33b Mon Sep 17 00:00:00 2001 From: Andrea Fioraldi Date: Tue, 29 Aug 2023 11:44:38 +0200 Subject: [PATCH 1/2] Add readmes --- README.md | 2 +- libafl/README.md | 7 ++++++- libafl_cc/Cargo.toml | 2 +- libafl_cc/README.md | 8 ++++++++ 4 files changed, 16 insertions(+), 3 deletions(-) mode change 120000 => 100644 libafl/README.md create mode 100644 libafl_cc/README.md diff --git a/README.md b/README.md index b47dd2ad4d..35ac1976c0 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ We highly recommend *not* to use e.g. your Linux distribition package as this is Rust directly, instructions can be found [here](https://www.rust-lang.org/tools/install). - LLVM tools -The LLVM tools (including clang, clang++) are needed (newer than LLVM 11.0.0 but older than LLVM 15.0.0) +The LLVM tools (including clang, clang++) are needed (newer than LLVM 11.0.0 up to LLVM 17.0.0) - Cargo-make We use cargo-make to build the fuzzers in `fuzzers/` directory. You can install it with diff --git a/libafl/README.md b/libafl/README.md deleted file mode 120000 index 32d46ee883..0000000000 --- a/libafl/README.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/libafl/README.md b/libafl/README.md new file mode 100644 index 0000000000..0c27ae0bb4 --- /dev/null +++ b/libafl/README.md @@ -0,0 +1,6 @@ +# LibAFL Core + +LibAFL Core is the main library and contains the fuzzing components and their implementations. +A large part of this library depends only on Rust core+alloc and, thus, can run without any standard library. + +The online documentation for this crate is available [here](https://docs.rs/crate/libafl/latest). diff --git a/libafl_cc/Cargo.toml b/libafl_cc/Cargo.toml index a1be312c26..fcc638f96d 100644 --- a/libafl_cc/Cargo.toml +++ b/libafl_cc/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Andrea Fioraldi "] description = "Commodity library to wrap compilers and link LibAFL" documentation = "https://docs.rs/libafl_cc" repository = "https://github.com/AFLplusplus/LibAFL/" -readme = "../README.md" +readme = "README.md" license = "MIT OR Apache-2.0" keywords = ["fuzzing", "testing", "compiler"] edition = "2021" diff --git a/libafl_cc/README.md b/libafl_cc/README.md new file mode 100644 index 0000000000..aaa50ea7a4 --- /dev/null +++ b/libafl_cc/README.md @@ -0,0 +1,8 @@ +# LibAFL CC + +LibAFL CC provides the functionalities to write compiler wrappers for LibAFL, by providing to the user a set of compiler extensions useful for instrumentation. + +The online documentation for this crate is available [here](https://docs.rs/crate/libafl_cc/latest). + +Currently, we support LLVM version 11 up to 18, but other versions may work. +To install LLVM, use the official [download page](https://releases.llvm.org/download.html). From 3ceb44e6cb9d8a22ee9e1d323d2b607c5b00bc65 Mon Sep 17 00:00:00 2001 From: Andrea Fioraldi Date: Tue, 29 Aug 2023 13:36:02 +0200 Subject: [PATCH 2/2] fix docker --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 9c0dcc9c31..1024644377 100644 --- a/Dockerfile +++ b/Dockerfile @@ -28,7 +28,7 @@ COPY Cargo.toml README.md ./ COPY libafl_derive/Cargo.toml libafl_derive/Cargo.toml COPY scripts/dummy.rs libafl_derive/src/lib.rs -COPY libafl/Cargo.toml libafl/build.rs libafl/ +COPY libafl/Cargo.toml libafl/build.rs libafl/README.md libafl/ COPY scripts/dummy.rs libafl/src/lib.rs COPY libafl_bolts/Cargo.toml libafl_bolts/build.rs libafl_bolts/README.md libafl_bolts/