1# Fuzzing Linkerd
2
3The scripting setup for fuzzing is used by [google/oss-fuzz] which
4performs continuous fuzzing for the Linkerd project.
5
6The fuzzing configuration for Linkerd is located in the [linkerd2
7project directory][of-l2] which handles the docker build and execution of the
8fuzzers.
9
10## Running locally
11
12Instructions for running the fuzzers locally can be found in the oss-fuzz
13[docs].
14
15This will require cloning the [google/oss-fuzz] repository locally and running
16the commands outlined in the instructions.
17
18### oss-fuzz File Setup
19
20- [Dockerfile] provides the necessary environment for running the
21 fuzzer; the main thing being the `oss-fuzz-base` image which provides the
22 `compile_go_fuzzer` funtions seen in this directory's `build.sh`.
23- [build.sh] is responsible for calling the fuzzing functions for each
24 fuzzer in the linkerd2 project.
25
26<!-- refs -->
27[google/oss-fuzz]: https://github.com/google/oss-fuzz
28[of-l2]: https://github.com/google/oss-fuzz/tree/master/projects/linkerd2
29[docs]: https://google.github.io/oss-fuzz/getting-started/new-project-guide/#testing-locally
30[Dockerfile]: https://github.com/google/oss-fuzz/blob/master/projects/linkerd2/Dockerfile
31[build.sh]: https://github.com/google/oss-fuzz/blob/master/projects/linkerd2/build.sh
View as plain text