Kitxuuu commited on
Commit
eefcb67
·
verified ·
1 Parent(s): 2d1207c

Add files using upload-large-folder tool

Browse files
Files changed (20) hide show
  1. local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/bazel.md +97 -0
  2. local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/go_lang.md +125 -0
  3. local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/javascript_lang.md +140 -0
  4. local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/jvm_lang.md +185 -0
  5. local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/python_lang.md +137 -0
  6. local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/rust_lang.md +148 -0
  7. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.editorconfig +8 -0
  8. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.eslintignore +1 -0
  9. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.gitignore +6 -0
  10. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.prettierrc.js +18 -0
  11. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/LICENSE +201 -0
  12. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/cifuzz.ts +70 -0
  13. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/commands/cmdListFuzzers.ts +42 -0
  14. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/commands/cmdRedo.ts +35 -0
  15. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/commands/cmdTestFuzzer.ts +90 -0
  16. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/config.ts +37 -0
  17. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/logger.ts +31 -0
  18. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/ossfuzzWrappers.ts +385 -0
  19. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/projectIntegrationHelper.ts +761 -0
  20. local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/utils.ts +306 -0
local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/bazel.md ADDED
@@ -0,0 +1,97 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ layout: default
3
+ title: Integrating a Bazel project
4
+ parent: Setting up a new project
5
+ grand_parent: Getting started
6
+ nav_order: 5
7
+ permalink: /getting-started/new-project-guide/bazel/
8
+ ---
9
+
10
+ # Integrating a Bazel project
11
+ {: .no_toc}
12
+
13
+ - TOC
14
+ {:toc}
15
+ ---
16
+
17
+ ## Bazel projects
18
+
19
+ The process of integrating a project using the [Bazel](https://bazel.build/)
20
+ build system with OSS-Fuzz is very similar to the general
21
+ [Setting up a new project]({{ site.baseurl }}/getting-started/new-project-guide/)
22
+ process. The key specifics of integrating a Bazel project are outlined below.
23
+
24
+ ## Fuzzing support in Bazel
25
+
26
+ For Bazel-based projects, we recommend using the
27
+ [`rules_fuzzing`](https://github.com/bazelbuild/rules_fuzzing) extension library
28
+ for defining fuzz tests. `rules_fuzzing` provides support for building and running
29
+ fuzz tests under
30
+ [multiple sanitizer and fuzzing engine configurations][rules-fuzzing-usage].
31
+ It also supports specifying corpora and dictionaries as part of the fuzz test
32
+ definition.
33
+
34
+ The fuzzing rules provide out-of-the-box support for building and packaging fuzz
35
+ test artifacts in the OSS-Fuzz format. Each `//path/to:fuzz_test` fuzz test
36
+ target automatically has a `//path/to:fuzz_test_oss_fuzz` packaging target that
37
+ (a) builds the fuzz test using the instrumentation and engine library specified
38
+ in the OSS-Fuzz environment variables, and (b) generates an archive containing
39
+ the binary and its associated artifacts (corpus, dictionary, etc.). Moreover,
40
+ OSS-Fuzz provides a standard tool to automatically process these targets,
41
+ substantially simplifying the `build.sh` script (see below).
42
+
43
+ [rules-fuzzing-usage]: https://github.com/bazelbuild/rules_fuzzing#using-the-rules-in-your-project
44
+
45
+ ## Project files
46
+
47
+ This section explains how to integrate the fuzz tests written using the
48
+ `rules_fuzzing` library with OSS-Fuzz. You can also see a complete example in the
49
+ [`bazel-rules-fuzzing-test`](https://github.com/google/oss-fuzz/tree/master/projects/bazel-rules-fuzzing-test)
50
+ project.
51
+
52
+ The structure of the project directory in the OSS-Fuzz repository does not
53
+ differ for Bazel-based projects. The project files have the following specific
54
+ aspects.
55
+
56
+ ### project.yaml
57
+
58
+ Only C++ projects are currently supported.
59
+
60
+ Since the OSS-Fuzz target builds the fuzz test using the instrumentation and
61
+ engine specified in the OSS-Fuzz environment variables, all the engine and
62
+ sanitizer configurations supported in the `project.yaml` file are automatically
63
+ supported by the fuzzing rules.
64
+
65
+ ### Dockerfile
66
+
67
+ There is no need to install Bazel in your Docker image. The OSS-Fuzz builder
68
+ image provides the `bazel` executable through the
69
+ [Bazelisk](https://github.com/bazelbuild/bazelisk) launcher, which will fetch
70
+ and use the latest Bazel release. If your project requires a particular Bazel
71
+ version, create a
72
+ [`.bazelversion`](https://docs.bazel.build/versions/master/updating-bazel.html)
73
+ file in your repository root with the desired version string.
74
+
75
+ ### build.sh
76
+
77
+ Your `build.sh` script essentially needs to perform three steps: (1) selecting
78
+ which fuzz tests to build, (2) building their OSS-Fuzz package targets in the
79
+ right configuration, and (3) copying the build artifacts to the `${OUT}/`
80
+ destination.
81
+
82
+ OSS-Fuzz provides a
83
+ [`bazel_build_fuzz_tests`](https://github.com/google/oss-fuzz/blob/master/infra/base-images/base-builder/bazel_build_fuzz_tests)
84
+ tool that implements these steps in a standard way, so in most cases your
85
+ build script only needs to invoke this command with no arguments.
86
+
87
+ If necessary, the behavior of the tool can be customized through a set of
88
+ environment variables. The most common are:
89
+
90
+ * `BAZEL_EXTRA_BUILD_FLAGS` are extra build flags passed on the Bazel command
91
+ line.
92
+ * `BAZEL_FUZZ_TEST_TAG` and `BAZEL_FUZZ_TEST_EXCLUDE_TAG` can be overridden to
93
+ specify which target tags to use when determining what fuzz tests to include.
94
+ By default, the tool selects all the fuzz tests except for those tagged as
95
+ `"no-oss-fuzz"`.
96
+ * `BAZEL_FUZZ_TEST_QUERY` overrides the Bazel query the tool uses to identify
97
+ the fuzz tests to build, if the tag-based approach is not sufficient.
local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/go_lang.md ADDED
@@ -0,0 +1,125 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ layout: default
3
+ title: Integrating a Go project
4
+ parent: Setting up a new project
5
+ grand_parent: Getting started
6
+ nav_order: 1
7
+ permalink: /getting-started/new-project-guide/go-lang/
8
+ ---
9
+
10
+ # Integrating a Go project
11
+ {: .no_toc}
12
+
13
+ - TOC
14
+ {:toc}
15
+ ---
16
+
17
+ The process of integrating a project written in Go with OSS-Fuzz is very similar
18
+ to the general
19
+ [Setting up a new project]({{ site.baseurl }}/getting-started/new-project-guide/)
20
+ process. The key specifics of integrating a Go project are outlined below.
21
+
22
+ ## Go-fuzz support
23
+
24
+ OSS-Fuzz supports **go-fuzz** in the
25
+ [libFuzzer compatible mode](https://github.com/mdempsky/go114-fuzz-build)
26
+ only. In that mode, fuzz targets for Go use the libFuzzer engine with native Go
27
+ coverage instrumentation. Binaries compiled in this mode provide the same
28
+ libFuzzer command line interface as non-Go fuzz targets.
29
+
30
+ ## Native Go Fuzzing support
31
+
32
+ OSS-fuzz supports [fuzzers written for the native Go 1.18 engine](https://go.dev/doc/fuzz/). These fuzzers are built as libFuzzer binaries in a similar fashion as fuzzers written for the go-fuzz engine. Because of that, dictionaries and seed corpora should be handled in accordance with [the OSS-fuzz documentation](https://google.github.io/oss-fuzz/getting-started/new-project-guide/#seed-corpus).
33
+ Unlike libFuzzer/go-fuzz targets which must accept one data buffer, fuzz targets written for the Native Go engine can accept any number of arguments of any type. Here is an example of a valid fuzzer with multiple arguments:
34
+
35
+ ```go
36
+ package demofuzzing
37
+
38
+ import (
39
+ "fmt"
40
+ "testing"
41
+ )
42
+
43
+ func FuzzDemo(f *testing.F) {
44
+ f.Fuzz(func(t *testing.T, data1 string, data2 uint32, data3 float64) {
45
+ fmt.Println(data1)
46
+ fmt.Println(data2)
47
+ fmt.Println(data3)
48
+ })
49
+ }
50
+ ```
51
+
52
+ Some requirements for native Go 1.18 fuzzers are:
53
+ * The only `testing.F` method supported is currently `F.Fuzz()`.
54
+ * `F.Add()` will not add seeds when fuzzing. To provide OSS-fuzz with a seed corpus, follow the documentation [here](https://google.github.io/oss-fuzz/getting-started/new-project-guide/#seed-corpus).
55
+
56
+ ## Project files
57
+
58
+ First, you need to write a Go fuzz target. This fuzz target should reside in your project
59
+ repository
60
+ ([example](https://github.com/golang/go/blob/4ad13555184eb0697c2e92c64c1b0bdb287ccc10/src/html/fuzz.go#L13)).
61
+
62
+ The structure of the project directory in OSS-Fuzz repository doesn't differ for
63
+ projects written in Go. The project files have the following Go specific
64
+ aspects.
65
+
66
+ ### project.yaml
67
+
68
+ The `language` attribute must be specified.
69
+
70
+ ```yaml
71
+ language: go
72
+ ```
73
+
74
+ The only supported fuzzing engine and sanitizer are `libfuzzer` and `address`,
75
+ respectively.
76
+ [Example](https://github.com/google/oss-fuzz/blob/356f2b947670b7eb33a1f535c71bc5c87a60b0d1/projects/syzkaller/project.yaml#L7):
77
+
78
+ ```yaml
79
+ fuzzing_engines:
80
+ - libfuzzer
81
+ sanitizers:
82
+ - address
83
+ ```
84
+
85
+ ### Dockerfile
86
+
87
+ The Dockerfile should start by `FROM gcr.io/oss-fuzz-base/base-builder-go`
88
+
89
+ The OSS-Fuzz builder image has the latest stable release of Golang installed. In
90
+ order to install dependencies of your project, add `RUN git clone ...` command to
91
+ your Dockerfile.
92
+ [Example](https://github.com/google/oss-fuzz/blob/356f2b947670b7eb33a1f535c71bc5c87a60b0d1/projects/syzkaller/Dockerfile#L23):
93
+
94
+ ```dockerfile
95
+ # Dependency for one of the fuzz targets.
96
+ RUN git clone --depth 1 https://github.com/ianlancetaylor/demangle
97
+ ```
98
+
99
+ go-fuzz will then automatically download the dependencies based on the go.mod file
100
+
101
+ ### build.sh
102
+
103
+ In order to build a Go fuzz target, you need to call `go-fuzz`
104
+ command first, and then link the resulting `.a` file against
105
+ `$LIB_FUZZING_ENGINE` using the `$CXX $CXXFLAGS ...` command.
106
+
107
+ For go-fuzz fuzzers, the best way to do this is by using the [`compile_go_fuzzer` script](https://github.com/google/oss-fuzz/blob/master/infra/base-images/base-builder/compile_go_fuzzer), and for native Go 1.18 fuzzers it is recommended to use the [`compile_native_go_fuzzer` script](https://github.com/google/oss-fuzz/blob/master/infra/base-images/base-builder/compile_native_go_fuzzer). Both of these also support coverage builds.
108
+
109
+ `compile_native_go_fuzzer` requires two dependencies which can be installed with:
110
+ ```bash
111
+ go install github.com/AdamKorcz/go-118-fuzz-build@latest
112
+ go get github.com/AdamKorcz/go-118-fuzz-build/testing
113
+ ```
114
+
115
+ A usage example from go-dns project is
116
+
117
+ ```sh
118
+ compile_go_fuzzer github.com/miekg/dns FuzzNewRR fuzz_newrr fuzz
119
+ ```
120
+
121
+ Arguments are :
122
+ * path of the package with the fuzz target
123
+ * name of the fuzz function
124
+ * name of the fuzzer to be built
125
+ * optional tag to be used by `go build` and such
local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/javascript_lang.md ADDED
@@ -0,0 +1,140 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ layout: default
3
+ title: Integrating a JavaScript project
4
+ parent: Setting up a new project
5
+ grand_parent: Getting started
6
+ nav_order: 4
7
+ permalink: /getting-started/new-project-guide/javascript-lang/
8
+ ---
9
+
10
+ # Integrating a JavaScript project
11
+ {: .no_toc}
12
+
13
+ - TOC
14
+ {:toc}
15
+ ---
16
+
17
+ The process of integrating a project written in JavaScript for Node.js
18
+ with OSS-Fuzz is very similar to the general
19
+ [Setting up a new project]({{ site.baseurl }}/getting-started/new-project-guide/)
20
+ process. The key specifics of integrating a JavaScript project are outlined below.
21
+
22
+ ## Jazzer.js
23
+
24
+ JavaScript fuzzing in OSS-Fuzz is powered by
25
+ [Jazzer.js](https://github.com/CodeIntelligenceTesting/jazzer.js), which is
26
+ installed during the build step. As Jazzer.js operates directly on the JavaScript
27
+ source code level, it can be applied to any project written in a language that
28
+ can be transpiled into JavaScript such as TypeScript. More information on how Jazzer.js
29
+ fuzz targets look like can be found in its
30
+ [README's Usage section](https://github.com/CodeIntelligenceTesting/jazzer.js#usage).
31
+
32
+ ## Project files
33
+
34
+ ### Example project
35
+
36
+ We recommend viewing
37
+ [javascript-example](https://github.com/google/oss-fuzz/tree/master/projects/javascript-example)
38
+ as an example of a simple JavaScript fuzzing project. We also recommend having a look at
39
+ [typescript-example](https://github.com/google/oss-fuzz/tree/master/projects/typescript-example)
40
+ as an example of how to fuzz TypeScript projects. This example also demonstrates how to use
41
+ Jazzer.js fuzzed data provider.
42
+
43
+ ### project.yaml
44
+
45
+ The `language` attribute must be specified as follows:
46
+
47
+ ```yaml
48
+ language: javascript
49
+ ```
50
+
51
+ The only supported fuzzing engine is libFuzzer (`libfuzzer`). So far, native sanitizers such as
52
+ AddressSanitizer (`address`) and UndefinedBehaviorSanitizer (`undefined`) are not supported.
53
+ They would only be needed for projects that have native addons, which is a rather infrequent
54
+ use case for JavaScript projects. If you have a project where you need ASan or UBSan, please
55
+ create open an issue on [Jazzer.js GitHub repo](https://github.com/CodeIntelligenceTesting/jazzer.js). None (`none`) is the default sanitizer for
56
+ JavaScript projects, so setting it up in `project.yaml` is optional.
57
+
58
+ ```yaml
59
+ fuzzing_engines:
60
+ - libfuzzer
61
+ sanitizers:
62
+ - none
63
+ ```
64
+
65
+ ### Dockerfile
66
+
67
+ The Dockerfile should start by `FROM gcr.io/oss-fuzz-base/base-builder-javascript`
68
+
69
+ The OSS-Fuzz base Docker images already come with Node.js 19 and `npm` pre-installed.
70
+ Apart from that, you should usually not need to do more than to clone the
71
+ project, set a `WORKDIR`, and copy any necessary files, or install any
72
+ project-specific dependencies here as you normally would.
73
+
74
+ ### Fuzzers
75
+
76
+ In the simplest case, every fuzzer consists of a single JavaScript file that exports
77
+ a function named `fuzz` taking a single argument of type [Buffer](https://nodejs.org/api/buffer.html).
78
+ An example fuzz target could thus be a file `fuzz_string_compare.js` with contents:
79
+
80
+ ```javascript
81
+ /**
82
+ * @param { Buffer } data
83
+ */
84
+ module.exports.fuzz = function (data) {
85
+ const s = data.toString();
86
+ if (s.length !== 16) {
87
+ return;
88
+ }
89
+ if (
90
+ s.slice(0, 8) === "Awesome " &&
91
+ s.slice(8, 15) === "Fuzzing" &&
92
+ s[15] === "!"
93
+ ) {
94
+ throw Error("Welcome to Awesome Fuzzing!");
95
+ }
96
+ };
97
+ ```
98
+
99
+ ### build.sh
100
+
101
+ The OSS-Fuzz base docker image for JavaScript comes with the [`compile_javascript_fuzzer` script](https://github.com/google/oss-fuzz/blob/master/infra/base-images/base-builder/compile_javascript_fuzzer) preinstalled. In `build.sh`, you should install dependencies for your project, and if necessary compile the code into JavaScript. Then, you can use the script to build the fuzzers. The script ensures that [@Jazzer.js/core](https://www.npmjs.com/package/@jazzer.js/core) is installed so that its CLI can be used to execute your fuzz tests. It also generates a wrapper script that can be used as a drop-in replacement for libFuzzer. This means that the generated script accepts the same command line flags for libFuzzer. Under the hood these flags are simply forwarded to the libFuzzer native addon used by Jazzer.js.
102
+
103
+ A usage example from the javascript-example project is
104
+
105
+ ```shell
106
+ compile_javascript_fuzzer example fuzz_string_compare.js --sync
107
+ ```
108
+
109
+ Arguments are:
110
+ * relative path of the project in the $SRC directory
111
+ * relative path to the fuzz test inside the project
112
+ * remaining arguments are forwarded to the [Jazzer.js CLI](https://github.com/CodeIntelligenceTesting/jazzer.js/blob/main/docs/fuzz-targets.md#running-the-fuzz-target)
113
+
114
+ The [javascript-example](https://github.com/google/oss-fuzz/blob/master/projects/javascript-example/build.sh)
115
+ project contains an example of a `build.sh` for JavaScript projects.
116
+
117
+ ## FuzzedDataProvider
118
+
119
+ Jazzer.js provides a `FuzzedDataProvider` that can simplify the task of creating a
120
+ fuzz target by translating the raw input bytes received from the fuzzer into
121
+ useful primitive JavaScript types. Its functionality is similar to
122
+ `FuzzedDataProviders` available in other languages, such as
123
+ [Java](https://codeintelligencetesting.github.io/jazzer-docs/jazzer-api/com/code_intelligence/jazzer/api/FuzzedDataProvider.html) and
124
+ [C++](https://github.com/google/fuzzing/blob/master/docs/split-inputs.md).
125
+
126
+ A fuzz target using the `FuzzedDataProvider` would look as follows:
127
+
128
+ ```javascript
129
+ const { FuzzedDataProvider } = require("@jazzer.js/core");
130
+
131
+ /**
132
+ * @param { Buffer } fuzzerInputData
133
+ */
134
+ module.exports.fuzz = function (fuzzerInputData) {
135
+ const data = new FuzzedDataProvider(fuzzerInputData);
136
+ const i = data.consumeIntegral(4);
137
+ const s = data.consumeRemainingAsString();
138
+ exploreMe(i, s);
139
+ };
140
+ ```
local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/jvm_lang.md ADDED
@@ -0,0 +1,185 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ layout: default
3
+ title: Integrating a Java/JVM project
4
+ parent: Setting up a new project
5
+ grand_parent: Getting started
6
+ nav_order: 4
7
+ permalink: /getting-started/new-project-guide/jvm-lang/
8
+ ---
9
+
10
+ # Integrating a Java/JVM project
11
+ {: .no_toc}
12
+
13
+ - TOC
14
+ {:toc}
15
+ ---
16
+
17
+ The process of integrating a project written in Java or any other language
18
+ running on the Java Virtual Machine (JVM) with OSS-Fuzz is very similar to the
19
+ general
20
+ [Setting up a new project]({{ site.baseurl }}/getting-started/new-project-guide/)
21
+ process. The key specifics of integrating a JVM project are outlined below.
22
+
23
+ ## Jazzer
24
+
25
+ Java fuzzing in OSS-Fuzz depends on
26
+ [Jazzer](https://github.com/CodeIntelligenceTesting/jazzer), which is
27
+ pre-installed on the OSS-Fuzz base docker images. As Jazzer operates directly
28
+ on the bytecode level, it can be applied to any project written in a JVM-based
29
+ language. More information on how Jazzer fuzz targets look like can be found in
30
+ its
31
+ [README's Usage section](https://github.com/CodeIntelligenceTesting/jazzer#usage).
32
+
33
+ ## Project files
34
+
35
+ ### Example project
36
+
37
+ We recommend viewing
38
+ [json-sanitizer](https://github.com/google/oss-fuzz/tree/master/projects/json-sanitizer)
39
+ as an example of a simple Java-only fuzzing project. Additional examples,
40
+ including one for a Java project with native dependencies, are part of the
41
+ [java-example](https://github.com/google/oss-fuzz/tree/master/projects/java-example)
42
+ project.
43
+
44
+ ### project.yaml
45
+
46
+ The `language` attribute must be specified as follows:
47
+
48
+ ```yaml
49
+ language: jvm
50
+ ```
51
+
52
+ The only supported fuzzing engine is libFuzzer (`libfuzzer`). So far the only
53
+ supported sanitizers are AddressSanitizer (`address`) and
54
+ UndefinedBehaviorSanitizer (`undefined`). For pure Java projects, specify
55
+ just `address`:
56
+
57
+ ```yaml
58
+ fuzzing_engines:
59
+ - libfuzzer
60
+ sanitizers:
61
+ - address
62
+ ```
63
+
64
+ ### Dockerfile
65
+
66
+ The Dockerfile should start by `FROM gcr.io/oss-fuzz-base/base-builder-jvm`
67
+
68
+ The OSS-Fuzz base Docker images already come with OpenJDK 15 pre-installed. If
69
+ you need Maven to build your project, you can install it by adding the following
70
+ line to your Dockerfile:
71
+
72
+ ```docker
73
+ RUN apt-get update && apt-get install -y maven
74
+ ```
75
+
76
+ Apart from this, you should usually not need to do more than to clone the
77
+ project, set a `WORKDIR`, and copy any necessary files, or install any
78
+ project-specific dependencies here as you normally would.
79
+
80
+ ### Fuzzers
81
+
82
+ In the simplest case, every fuzzer consists of a single Java file with a
83
+ filename matching `*Fuzzer.java` and no `package` directive. An example fuzz
84
+ target could thus be a file `ExampleFuzzer.java` with contents:
85
+
86
+ ```java
87
+ public class ExampleFuzzer {
88
+ public static void fuzzerTestOneInput(byte[] input) {
89
+ ...
90
+ // Call a function of the project under test with arguments derived from
91
+ // input and throw an exception if something unwanted happens.
92
+ ...
93
+ }
94
+ }
95
+ ```
96
+
97
+ ### build.sh
98
+
99
+ For JVM projects, `build.sh` does need some more significant modifications
100
+ over C/C++ projects. Below is an annotated example build script for a
101
+ Java-only project with single-file fuzz targets as described above:
102
+
103
+ ```sh
104
+ # Step 1: Build the project
105
+
106
+ # Build the project .jar as usual, e.g. using Maven.
107
+ mvn package
108
+ # In this example, the project is built with Maven, which typically includes the
109
+ # project version into the name of the packaged .jar file. The version can be
110
+ # obtained as follows:
111
+ CURRENT_VERSION=$(mvn org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate \
112
+ -Dexpression=project.version -q -DforceStdout)
113
+ # Copy the project .jar into $OUT under a fixed name.
114
+ cp "target/sample-project-$CURRENT_VERSION.jar" $OUT/sample-project.jar
115
+
116
+ # Specify the projects .jar file(s), separated by spaces if there are multiple.
117
+ PROJECT_JARS="sample-project.jar"
118
+
119
+ # Step 2: Build the fuzzers (should not require any changes)
120
+
121
+ # The classpath at build-time includes the project jars in $OUT as well as the
122
+ # Jazzer API.
123
+ BUILD_CLASSPATH=$(echo $PROJECT_JARS | xargs printf -- "$OUT/%s:"):$JAZZER_API_PATH
124
+
125
+ # All .jar and .class files lie in the same directory as the fuzzer at runtime.
126
+ RUNTIME_CLASSPATH=$(echo $PROJECT_JARS | xargs printf -- "\$this_dir/%s:"):\$this_dir
127
+
128
+ for fuzzer in $(find $SRC -name '*Fuzzer.java'); do
129
+ fuzzer_basename=$(basename -s .java $fuzzer)
130
+ javac -cp $BUILD_CLASSPATH $fuzzer
131
+ cp $SRC/$fuzzer_basename.class $OUT/
132
+
133
+ # Create an execution wrapper that executes Jazzer with the correct arguments.
134
+ echo "#!/bin/bash
135
+ # LLVMFuzzerTestOneInput for fuzzer detection.
136
+ this_dir=\$(dirname \"\$0\")
137
+ if [[ \"\$@\" =~ (^| )-runs=[0-9]+($| ) ]]; then
138
+ mem_settings='-Xmx1900m:-Xss900k'
139
+ else
140
+ mem_settings='-Xmx2048m:-Xss1024k'
141
+ fi
142
+ LD_LIBRARY_PATH=\"$JVM_LD_LIBRARY_PATH\":\$this_dir \
143
+ \$this_dir/jazzer_driver --agent_path=\$this_dir/jazzer_agent_deploy.jar \
144
+ --cp=$RUNTIME_CLASSPATH \
145
+ --target_class=$fuzzer_basename \
146
+ --jvm_args=\"\$mem_settings:-Djava.awt.headless=true\" \
147
+ \$@" > $OUT/$fuzzer_basename
148
+ chmod +x $OUT/$fuzzer_basename
149
+ done
150
+ ```
151
+
152
+ The [java-example](https://github.com/google/oss-fuzz/blob/master/projects/java-example/build.sh)
153
+ project contains an example of a `build.sh` for Java projects with native
154
+ libraries.
155
+
156
+ ## FuzzedDataProvider
157
+
158
+ Jazzer provides a `FuzzedDataProvider` that can simplify the task of creating a
159
+ fuzz target by translating the raw input bytes received from the fuzzer into
160
+ useful primitive Java types. Its functionality is similar to
161
+ `FuzzedDataProviders` available in other languages, such as
162
+ [Python](https://github.com/google/atheris#fuzzeddataprovider) and
163
+ [C++](https://github.com/google/fuzzing/blob/master/docs/split-inputs.md).
164
+
165
+ On OSS-Fuzz, the required library is available in the base docker images under
166
+ the path `$JAZZER_API_PATH`, which is added to the classpath by the example
167
+ build script shown above. Locally, the library can be obtained from
168
+ [Maven Central](https://search.maven.org/search?q=g:com.code-intelligence%20a:jazzer-api).
169
+
170
+ A fuzz target using the `FuzzedDataProvider` would look as follows:
171
+
172
+ ```java
173
+ import com.code_intelligence.jazzer.api.FuzzedDataProvider;
174
+
175
+ public class ExampleFuzzer {
176
+ public static void fuzzerTestOneInput(FuzzedDataProvider data) {
177
+ int number = data.consumeInt();
178
+ String string = data.consumeRemainingAsString();
179
+ // ...
180
+ }
181
+ }
182
+ ```
183
+
184
+ For a list of convenience methods offered by `FuzzedDataProvider`, consult its
185
+ [javadocs](https://codeintelligencetesting.github.io/jazzer-docs/jazzer-api/com/code_intelligence/jazzer/api/FuzzedDataProvider.html).
local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/python_lang.md ADDED
@@ -0,0 +1,137 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ layout: default
3
+ title: Integrating a Python project
4
+ parent: Setting up a new project
5
+ grand_parent: Getting started
6
+ nav_order: 3
7
+ permalink: /getting-started/new-project-guide/python-lang/
8
+ ---
9
+
10
+ # Integrating a Python project
11
+ {: .no_toc}
12
+
13
+ - TOC
14
+ {:toc}
15
+ ---
16
+
17
+
18
+ The process of integrating a project written in Python with OSS-Fuzz is very
19
+ similar to the general
20
+ [Setting up a new project]({{ site.baseurl }}/getting-started/new-project-guide/)
21
+ process. The key specifics of integrating a Python project are outlined below.
22
+
23
+ ## Atheris
24
+
25
+ Python fuzzing in OSS-Fuzz depends on
26
+ [Atheris](https://github.com/google/atheris). Fuzzers will depend on the
27
+ `atheris` package, and dependencies are pre-installed on the OSS-Fuzz base
28
+ docker images.
29
+
30
+ ## Project files
31
+
32
+ ### Example project
33
+
34
+ We recommend viewing [ujson](https://github.com/google/oss-fuzz/tree/master/projects/ujson) as an
35
+ example of a simple Python fuzzing project, with both plain-Atheris and
36
+ Atheris + Hypothesis harnesses.
37
+
38
+ ### project.yaml
39
+
40
+ The `language` attribute must be specified.
41
+
42
+ ```yaml
43
+ language: python
44
+ ```
45
+
46
+ The only supported fuzzing engine is libFuzzer (`libfuzzer`). The supported
47
+ sanitizers are AddressSanitizer (`address`) and
48
+ UndefinedBehaviorSanitizer (`undefined`). These must be explicitly specified.
49
+
50
+ ```yaml
51
+ fuzzing_engines:
52
+ - libfuzzer
53
+ sanitizers:
54
+ - address
55
+ - undefined
56
+ ```
57
+
58
+ ### Dockerfile
59
+
60
+ The Dockerfile should start by `FROM gcr.io/oss-fuzz-base/base-builder-python`
61
+
62
+ Because most dependencies are already pre-installed on the images, no
63
+ significant changes are needed in the Dockerfile for Python fuzzing projects.
64
+ You should simply clone the project, set a `WORKDIR`, and copy any necessary
65
+ files, or install any project-specific dependencies here as you normally would.
66
+
67
+ ### build.sh
68
+
69
+ For Python projects, `build.sh` does need some more significant modifications
70
+ over normal projects. The following is an annotated example build script,
71
+ explaining why each step is necessary and when they can be omitted.
72
+
73
+ ```sh
74
+ # Build and install project (using current CFLAGS, CXXFLAGS). This is required
75
+ # for projects with C extensions so that they're built with the proper flags.
76
+ pip3 install .
77
+
78
+ # Build fuzzers into $OUT. These could be detected in other ways.
79
+ for fuzzer in $(find $SRC -name '*_fuzzer.py'); do
80
+ fuzzer_basename=$(basename -s .py $fuzzer)
81
+ fuzzer_package=${fuzzer_basename}.pkg
82
+
83
+ # To avoid issues with Python version conflicts, or changes in environment
84
+ # over time on the OSS-Fuzz bots, we use pyinstaller to create a standalone
85
+ # package. Though not necessarily required for reproducing issues, this is
86
+ # required to keep fuzzers working properly in OSS-Fuzz.
87
+ pyinstaller --distpath $OUT --onefile --name $fuzzer_package $fuzzer
88
+
89
+ # Create execution wrapper. Atheris requires that certain libraries are
90
+ # preloaded, so this is also done here to ensure compatibility and simplify
91
+ # test case reproduction. Since this helper script is what OSS-Fuzz will
92
+ # actually execute, it is also always required.
93
+ # NOTE: If you are fuzzing python-only code and do not have native C/C++
94
+ # extensions, then remove the LD_PRELOAD line below as preloading sanitizer
95
+ # library is not required and can lead to unexpected startup crashes.
96
+ echo "#!/bin/sh
97
+ # LLVMFuzzerTestOneInput for fuzzer detection.
98
+ this_dir=\$(dirname \"\$0\")
99
+ LD_PRELOAD=\$this_dir/sanitizer_with_fuzzer.so \
100
+ ASAN_OPTIONS=\$ASAN_OPTIONS:symbolize=1:external_symbolizer_path=\$this_dir/llvm-symbolizer:detect_leaks=0 \
101
+ \$this_dir/$fuzzer_package \$@" > $OUT/$fuzzer_basename
102
+ chmod +x $OUT/$fuzzer_basename
103
+ done
104
+ ```
105
+
106
+ ## Hypothesis
107
+
108
+ Using [Hypothesis](https://hypothesis.readthedocs.io/), the Python library for
109
+ [property-based testing](https://hypothesis.works/articles/what-is-property-based-testing/),
110
+ makes it really easy to generate complex inputs - whether in traditional test suites
111
+ or [by using test functions as fuzz harnesses](https://hypothesis.readthedocs.io/en/latest/details.html#use-with-external-fuzzers).
112
+
113
+ > Property based testing is the construction of tests such that, when these tests are fuzzed,
114
+ failures in the test reveal problems with the system under test that could not have been
115
+ revealed by direct fuzzing of that system.
116
+
117
+ We recommend using the [`hypothesis write`](https://hypothesis.readthedocs.io/en/latest/ghostwriter.html)
118
+ command to generate a starter fuzz harness. This "ghostwritten" code may be usable as-is,
119
+ or provide a useful template for writing more specific tests.
120
+
121
+ See [here for the core "strategies"](https://hypothesis.readthedocs.io/en/latest/data.html),
122
+ for arbitrary data, [here for Numpy + Pandas support](https://hypothesis.readthedocs.io/en/latest/numpy.html),
123
+ or [here for a variety of third-party extensions](https://hypothesis.readthedocs.io/en/latest/strategies.html)
124
+ supporting everything from protobufs, to jsonschemas, to networkx graphs or geojson
125
+ or valid Python source code.
126
+ Hypothesis' integrated test-case reduction also makes it trivial to report a canonical minimal
127
+ example for each distinct failure discovered while fuzzing - just run the test function!
128
+
129
+ To use Hypothesis in OSS-Fuzz, install it in your Dockerfile with
130
+
131
+ ```shell
132
+ RUN pip3 install hypothesis
133
+ ```
134
+
135
+ See [the `ujson` structured fuzzer](https://github.com/google/oss-fuzz/blob/master/projects/ujson/hypothesis_structured_fuzzer.py)
136
+ for an example "polyglot" which can either be run with `pytest` as a standard test function,
137
+ or run with OSS-Fuzz as a fuzz harness.
local-test-commons-compress-delta-03/fuzz-tooling/docs/getting-started/new-project-guide/rust_lang.md ADDED
@@ -0,0 +1,148 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ layout: default
3
+ title: Integrating a Rust project
4
+ parent: Setting up a new project
5
+ grand_parent: Getting started
6
+ nav_order: 2
7
+ permalink: /getting-started/new-project-guide/rust-lang/
8
+ ---
9
+
10
+ # Integrating a Rust project
11
+ {: .no_toc}
12
+
13
+ - TOC
14
+ {:toc}
15
+ ---
16
+
17
+ The process of integrating a project written in Rust with OSS-Fuzz is very
18
+ similar to the general [Setting up a new project]({{ site.baseurl
19
+ }}/getting-started/new-project-guide/) process. The key specifics of integrating
20
+ a Rust project are outlined below.
21
+
22
+ ## cargo-fuzz support
23
+
24
+ Rust integration with OSS-Fuzz is expected to use [`cargo
25
+ fuzz`](https://github.com/rust-fuzz/cargo-fuzz) to build fuzzers. The `cargo
26
+ fuzz` tool will build code with required compiler flags as well as link to the
27
+ correct libFuzzer on OSS-Fuzz itself. Note that using `cargo fuzz` also makes it
28
+ quite easy to run the fuzzers locally yourself if you get a failing test case!
29
+
30
+ ## Project files
31
+
32
+ First you'll want to follow the [setup instructions for `cargo fuzz`
33
+ itself](https://rust-fuzz.github.io/book/). Afterwards your project should have:
34
+
35
+ * A top-level `fuzz` directory.
36
+ * A `fuzz/Cargo.toml` manifest which pulls in necessary dependencies to fuzz.
37
+ * Some `fuzz/fuzz_targets/*.rs` files which are the fuzz targets that will be
38
+ compiled and run on OSS-Fuzz.
39
+
40
+ Note that you can customize this layout as well, but you'll need to edit some
41
+ the scripts below to integrate into OSS-Fuzz.
42
+
43
+ ### project.yaml
44
+
45
+ The `language` attribute must be specified.
46
+
47
+ ```yaml
48
+ language: rust
49
+ ```
50
+
51
+ The only supported fuzzing engine and sanitizer are `libfuzzer` and `address`,
52
+ respectively.
53
+ [Example](https://github.com/google/oss-fuzz/blob/12ef3654b3e9adfd20b5a6afdde54819ba71493d/projects/serde_json/project.yaml#L3-L6)
54
+
55
+ ```yaml
56
+ sanitizers:
57
+ - address
58
+ fuzzing_engines:
59
+ - libfuzzer
60
+ ```
61
+
62
+ ### Dockerfile
63
+
64
+ The Dockerfile should start by `FROM gcr.io/oss-fuzz-base/base-builder-rust`
65
+
66
+ The OSS-Fuzz builder image has the latest nightly release of Rust as well as
67
+ `cargo fuzz` pre-installed and in `PATH`. In the `Dockerfile` for your project
68
+ all you'll need to do is fetch the latest copy of your code and install any
69
+ system dependencies necessary to build your project.
70
+ [Example](https://github.com/google/oss-fuzz/blob/12ef3654b3e9adfd20b5a6afdde54819ba71493d/projects/serde_json/Dockerfile#L18-L20)
71
+
72
+ ```dockerfile
73
+ RUN git clone --depth 1 https://github.com/serde-rs/json json
74
+ ```
75
+
76
+ ### build.sh
77
+
78
+ Here it's expected that you'll build the fuzz targets for your project and then
79
+ copy the final binaries into the output directory.
80
+ [Example](https://github.com/google/oss-fuzz/blob/12ef3654b3e9adfd20b5a6afdde54819ba71493d/projects/serde_json/build.sh#L20):
81
+
82
+ ```sh
83
+ cd $SRC/json
84
+ cargo fuzz build -O
85
+ cp fuzz/target/x86_64-unknown-linux-gnu/release/from_slice $OUT/
86
+ ```
87
+
88
+ Note that you likely want to pass the `-O` flag to `cargo fuzz build` which
89
+ builds fuzzers in release mode. You may also want to pass the
90
+ `--debug-assertions` flag to enable more checks while fuzzing. In this example
91
+ the `from_slice` binary is the fuzz target.
92
+
93
+ With some bash-fu you can also automatically copy over all fuzz targets into
94
+ the output directory so when you add a fuzz target to your project it's
95
+ automatically integrated into OSS-Fuzz:
96
+
97
+ ```sh
98
+ FUZZ_TARGET_OUTPUT_DIR=target/x86_64-unknown-linux-gnu/release
99
+ for f in fuzz/fuzz_targets/*.rs
100
+ do
101
+ FUZZ_TARGET_NAME=$(basename ${f%.*})
102
+ cp $FUZZ_TARGET_OUTPUT_DIR/$FUZZ_TARGET_NAME $OUT/
103
+ done
104
+ ```
105
+
106
+ ## Writing fuzzers using a test-style strategy
107
+
108
+ In Rust you will often have tests written in a way so they are only
109
+ compiled into the final binary when build in test-mode. This is, achieved by
110
+ wrapping your test code in `cfg(test)`, e.g.
111
+ ```rust
112
+ #[cfg(test)]
113
+ mod tests {
114
+ use super::*;
115
+
116
+ ...
117
+ ```
118
+
119
+ Cargo-fuzz automatically enables the `fuzzing` feature, which means you can
120
+ follow a similar strategy to writing fuzzers as you do when writing tests.
121
+ Specifically, you can create modules wrapped in the `fuzzing` feature:
122
+ ```rust
123
+ #[cfg(fuzzing)]
124
+ pub mod fuzz_logic {
125
+ use super::*;
126
+
127
+ ...
128
+ ```
129
+ and then call the logic within `fuzz_logic` from your fuzzer.
130
+
131
+ Furthermore, within your `.toml` files, you can then specify fuzzing-specific
132
+ dependencies by wrapping them as follows:
133
+ ```
134
+ [target.'cfg(fuzzing)'.dependencies]
135
+ ```
136
+ similar to how you wrap test-dependencies as follows:
137
+ ```
138
+ [dev-dependencies]
139
+ ```
140
+
141
+ Finally, you can also combine the testing logic you have and the fuzz logic. This
142
+ can be achieved simply by using
143
+ ```rust
144
+ #[cfg(any(test, fuzzing))]
145
+ ```
146
+
147
+ A project that follows this structure is Linkerd2-proxy and the project files can be
148
+ seen [here](https://github.com/google/oss-fuzz/tree/master/projects/linkerd2-proxy).
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.editorconfig ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ root = true
2
+
3
+ [*]
4
+ indent_style = space
5
+ indent_size = 2
6
+ end_of_line = lf
7
+ charset = utf-8
8
+ insert_final_newline = true
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.eslintignore ADDED
@@ -0,0 +1 @@
 
 
1
+ build/
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.gitignore ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ out
2
+ build
3
+ dist
4
+ node_modules
5
+ .vscode-test/
6
+ *.vsix
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/.prettierrc.js ADDED
@@ -0,0 +1,18 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+ module.exports = {
17
+ ...require('gts/.prettierrc.json')
18
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/LICENSE ADDED
@@ -0,0 +1,201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/cifuzz.ts ADDED
@@ -0,0 +1,70 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import {println} from './logger';
18
+
19
+ /**
20
+ * Creates a CIFuzz template
21
+ * @param language
22
+ * @param projectName
23
+ * @param secondToRun
24
+ * @returns
25
+ */
26
+ export function cifuzzGenerator(
27
+ language: string,
28
+ projectName: string,
29
+ secondToRun: Number
30
+ ) {
31
+ println('Exporting cifuzz logic ' + language);
32
+
33
+ const cifuzzTemplate = `name: CIFuzz
34
+ on: [pull_request]
35
+ permissions: {}
36
+ jobs:
37
+ Fuzzing:
38
+ runs-on: ubuntu-latest
39
+ permissions:
40
+ security-events: write
41
+ steps:
42
+ - name: Build Fuzzers
43
+ id: build
44
+ uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master
45
+ with:
46
+ oss-fuzz-project-name: '${projectName}'
47
+ language: ${language}
48
+ - name: Run Fuzzers
49
+ uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master
50
+ with:
51
+ oss-fuzz-project-name: '${projectName}'
52
+ language: ${language}
53
+ fuzz-seconds: ${secondToRun}
54
+ output-sarif: true
55
+ - name: Upload Crash
56
+ uses: actions/upload-artifact@v3
57
+ if: failure() && steps.build.outcome == 'success'
58
+ with:
59
+ name: artifacts
60
+ path: ./out/artifacts
61
+ - name: Upload Sarif
62
+ if: always() && steps.build.outcome == 'success'
63
+ uses: github/codeql-action/upload-sarif@v2
64
+ with:
65
+ # Path to SARIF file relative to the root of the repository
66
+ sarif_file: cifuzz-sarif/results.sarif
67
+ checkout_path: cifuzz-sarif`;
68
+
69
+ return cifuzzTemplate;
70
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/commands/cmdListFuzzers.ts ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import * as vscode from 'vscode';
18
+
19
+ import {listFuzzersForProject} from '../utils';
20
+ import {println} from '../logger';
21
+ import {extensionConfig} from '../config';
22
+
23
+ /**
24
+ * Lists all the fuzzers for a project.
25
+ */
26
+ export async function listFuzzersHandler() {
27
+ // Lists all of the fuzzers from a project.
28
+ const projectName = await vscode.window.showInputBox({
29
+ value: '',
30
+ placeHolder: 'Type a project name',
31
+ });
32
+ if (!projectName) {
33
+ console.log('Failed to get project name');
34
+ return;
35
+ }
36
+ println('Listing fuzzers for project ' + projectName);
37
+
38
+ await listFuzzersForProject(
39
+ projectName?.toString(),
40
+ extensionConfig.ossFuzzPepositoryWorkPath
41
+ );
42
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/commands/cmdRedo.ts ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import {commandHistory} from '../commandUtils';
18
+
19
+ /**
20
+ * Rerun the latest command
21
+ */
22
+ export async function cmdDispatcherRe() {
23
+ if (commandHistory.length === 0) {
24
+ console.log('command history is empty');
25
+ return false;
26
+ }
27
+
28
+ const commandObj: any = commandHistory[commandHistory.length - 1];
29
+
30
+ console.log('Redoing');
31
+ console.log(commandObj.commandType);
32
+ await commandObj.dispatcherFunc(commandObj.Arguments);
33
+ //await commandObj.dispatcherFunc(commandObj.args);
34
+ return true;
35
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/commands/cmdTestFuzzer.ts ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import * as vscode from 'vscode';
18
+ import {println} from '../logger';
19
+ import {runFuzzerHandler, buildFuzzersFromWorkspace} from '../ossfuzzWrappers';
20
+ import {setStatusText} from '../utils';
21
+ import {commandHistory} from '../commandUtils';
22
+ import {extensionConfig} from '../config';
23
+
24
+ /**
25
+ * Does an end-to-end test of a project/fuzzer. This is done by
26
+ * first building the project and then running the fuzzer.
27
+ * @param context
28
+ * @returns
29
+ */
30
+
31
+ export async function cmdInputCollectorTestFuzzer() {
32
+ setStatusText('Testing specific fuzzer: getting input');
33
+ // Get the project name and fuzzer name to test.
34
+ const ossFuzzProjectNameInput = await vscode.window.showInputBox({
35
+ value: '',
36
+ placeHolder: 'The OSS-Fuzz project name',
37
+ });
38
+ if (!ossFuzzProjectNameInput) {
39
+ println('Did not get a ossFuzzTargetProject');
40
+ return;
41
+ }
42
+ println('Project name: ' + ossFuzzProjectNameInput);
43
+
44
+ // Get the fuzzer to run
45
+ const fuzzerNameInput = await vscode.window.showInputBox({
46
+ value: '',
47
+ placeHolder: 'Type a fuzzer name',
48
+ });
49
+ if (!fuzzerNameInput) {
50
+ println('Failed to get fuzzer name');
51
+ return;
52
+ }
53
+
54
+ // Create the args object for the dispatcher
55
+ const args = new Object({
56
+ projectName: ossFuzzProjectNameInput.toString(),
57
+ fuzzerName: fuzzerNameInput.toString(),
58
+ });
59
+
60
+ // Create a dispatcher object.
61
+ const commandObject = new Object({
62
+ commandType: 'oss-fuzz.TestFuzzer',
63
+ Arguments: args,
64
+ dispatcherFunc: cmdDispatchTestFuzzerHandler,
65
+ });
66
+ commandHistory.push(commandObject);
67
+
68
+ await cmdDispatchTestFuzzerHandler(args);
69
+ }
70
+
71
+ async function cmdDispatchTestFuzzerHandler(args: any) {
72
+ // Build the project
73
+ setStatusText('Test specific fuzzer: building fuzzers in workspace');
74
+ if (!(await buildFuzzersFromWorkspace(args.projectName, '', false))) {
75
+ println('Build projects');
76
+ return;
77
+ }
78
+
79
+ // Run the fuzzer for 10 seconds
80
+ println('Running fuzzer');
81
+ setStatusText('Test specific fuzzer: running fuzzer ' + args.fuzzerName);
82
+ await runFuzzerHandler(
83
+ args.projectName,
84
+ args.fuzzerName,
85
+ extensionConfig.numberOfSecondsForTestRuns.toString(),
86
+ ''
87
+ );
88
+ setStatusText('Test specific fuzzer: test completed of ' + args.fuzzerName);
89
+ return;
90
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/config.ts ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import {println} from './logger';
18
+
19
+ export class ExtensionConfig {
20
+ /** Path to the repository that will be used. */
21
+ ossFuzzPepositoryWorkPath: string = '/tmp/oss-fuzz';
22
+
23
+ /** The directory where crash info is stored. */
24
+ crashesDirectory = process.env.HOME + '/oss-fuzz-crashes';
25
+
26
+ /** Number of seconds used for running quick test fuzzers */
27
+ numberOfSecondsForTestRuns = 20;
28
+
29
+ async printConfig() {
30
+ println('Config:');
31
+ println('- OSS-Fuzz repository path: ' + this.ossFuzzPepositoryWorkPath);
32
+ println('- Crashes directory: ' + this.crashesDirectory);
33
+ println('- numberOfSecondsForTestRuns: ' + this.numberOfSecondsForTestRuns);
34
+ }
35
+ }
36
+
37
+ export const extensionConfig = new ExtensionConfig();
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/logger.ts ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import * as vscode from 'vscode';
18
+ export const vscodeOutputChannel =
19
+ vscode.window.createOutputChannel('oss-fuzz');
20
+
21
+ export function println(line: string) {
22
+ vscodeOutputChannel.appendLine(line);
23
+ }
24
+
25
+ export function printRaw(line: string) {
26
+ vscodeOutputChannel.append(line);
27
+ }
28
+
29
+ export function debugPrintln(line: string) {
30
+ console.log(line);
31
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/ossfuzzWrappers.ts ADDED
@@ -0,0 +1,385 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ const fs = require('fs');
18
+ import * as vscode from 'vscode';
19
+ import {
20
+ hasOssFuzzInWorkspace,
21
+ getOssFuzzWorkspaceProjectName,
22
+ listFuzzersForProject,
23
+ systemSyncLogIfFailure,
24
+ } from './utils';
25
+ import {println} from './logger';
26
+ import {extensionConfig} from './config';
27
+
28
+ export async function buildFuzzersFromWorkspaceClusterfuzzLite() {
29
+ const workspaceFolder = vscode.workspace.workspaceFolders;
30
+ if (!workspaceFolder) {
31
+ println('No workspace folder, exiting');
32
+ return false;
33
+ }
34
+
35
+ // Build the fuzzers using OSS-Fuzz infrastructure.
36
+ const cmdToExec = 'python3';
37
+ const args = [
38
+ extensionConfig.ossFuzzPepositoryWorkPath + '/infra/helper.py',
39
+ 'build_fuzzers',
40
+ ];
41
+
42
+ args.push('--external');
43
+ args.push(workspaceFolder[0].uri.path);
44
+ println('Building fuzzers');
45
+ if (!(await systemSyncLogIfFailure(cmdToExec, args))) {
46
+ println('Failed to build fuzzers');
47
+ return false;
48
+ }
49
+ return true;
50
+ }
51
+
52
+ /**
53
+ * Builds the fuzzers for a given workspace.
54
+ *
55
+ * There are two options:
56
+ * 1) The fuzzers are build using the OSS-Fuzz set up in the folder
57
+ * 2) The fuzzers are build using the workspace and then copies that over.
58
+ */
59
+ export async function buildFuzzersFromWorkspace(
60
+ projectNameArg: string,
61
+ sanitizer: string,
62
+ toClean: boolean
63
+ ) {
64
+ // println('Building fuzzers locally');
65
+
66
+ // Check if there is an OSS-Fuzz set up, and exit if not.
67
+ if (
68
+ (await isPathValidOssFuzzPath(
69
+ extensionConfig.ossFuzzPepositoryWorkPath
70
+ )) === false
71
+ ) {
72
+ println('No valid oss-fuzz path');
73
+ return false;
74
+ }
75
+
76
+ const workspaceFolder = vscode.workspace.workspaceFolders;
77
+ if (!workspaceFolder) {
78
+ println('No workspace folder, exiting');
79
+ return false;
80
+ }
81
+
82
+ let ossFuzzProjectName = '';
83
+ if (await hasOssFuzzInWorkspace()) {
84
+ /**
85
+ * The fuzzers are in the workspace, as opposed to e.g. the oss-fuzz dirctory.
86
+ */
87
+ ossFuzzProjectName = await getOssFuzzWorkspaceProjectName();
88
+
89
+ /**
90
+ * The workspace has an OSS-Fuzz directory. We use this for the build.
91
+ * This is done by copying over the relevant files to the oss-fuzz repository
92
+ * folder. Notice that we will do a forceful copy overwriting the existing
93
+ * project foler if it exists.
94
+ */
95
+ println('Found project folder: ' + ossFuzzProjectName);
96
+
97
+ // Copy over the workspace oss-fuzz set up to the oss-fuzz folder.
98
+ let cmdToExec = 'cp';
99
+ let args: Array<string> = [
100
+ '-rfT',
101
+ workspaceFolder[0].uri.path + '/OSS-Fuzz/' + ossFuzzProjectName,
102
+ extensionConfig.ossFuzzPepositoryWorkPath +
103
+ '/projects/' +
104
+ ossFuzzProjectName +
105
+ '/',
106
+ ];
107
+
108
+ if (!(await systemSyncLogIfFailure(cmdToExec, args))) {
109
+ println('Failed to copy project');
110
+ return false;
111
+ }
112
+
113
+ // Build the fuzzers using OSS-Fuzz infrastructure.
114
+ cmdToExec = 'python3';
115
+ args = [
116
+ extensionConfig.ossFuzzPepositoryWorkPath + '/infra/helper.py',
117
+ 'build_fuzzers',
118
+ ];
119
+ println('DECIDING ABOUT SANITIZER');
120
+ if (sanitizer !== '') {
121
+ println('ADDING CODE COVERAGE SANITIZER');
122
+ args.push('--sanitizer=' + sanitizer);
123
+ }
124
+
125
+ if (toClean) {
126
+ args.push('--clean');
127
+ }
128
+
129
+ args.push(ossFuzzProjectName);
130
+ println('Building fuzzers');
131
+ if (!(await systemSyncLogIfFailure(cmdToExec, args))) {
132
+ println('Failed to build fuzzers');
133
+ return false;
134
+ }
135
+ } else {
136
+ ossFuzzProjectName = projectNameArg;
137
+
138
+ const targetOssFuzzProject = vscode.Uri.file(
139
+ extensionConfig.ossFuzzPepositoryWorkPath +
140
+ '/projects/' +
141
+ ossFuzzProjectName
142
+ );
143
+ // Check if the folder exists.
144
+ let projectHasOssFuzzFolder = false;
145
+ try {
146
+ await vscode.workspace.fs.readDirectory(targetOssFuzzProject);
147
+ projectHasOssFuzzFolder = true;
148
+ } catch {
149
+ projectHasOssFuzzFolder = false;
150
+ }
151
+
152
+ /**
153
+ * The workspace does not have a OSS-Fuzz specific folder but has
154
+ * a folder in the OSS-Fuzz/projects/* directory. As such, we build
155
+ * the project using that build.sh set up, but, instead of cloning
156
+ * the repository we mount the workspace root onto what would normally
157
+ * be cloned.
158
+ */
159
+ if (projectHasOssFuzzFolder) {
160
+ // println('Found a target directory');
161
+
162
+ // Build the fuzzers using OSS-Fuzz infrastructure.
163
+ // First, Set up a temporary workpath that will be cleanup after
164
+ const wsPath = workspaceFolder[0].uri.fsPath; // gets the path of the first workspace folder
165
+ const cmdToExec2 = 'cp';
166
+ const temporaryProjectPath =
167
+ extensionConfig.ossFuzzPepositoryWorkPath +
168
+ '/projects/' +
169
+ ossFuzzProjectName +
170
+ '/temporary-project';
171
+
172
+ const args2: Array<string> = [
173
+ '-rfT',
174
+ wsPath.toString(),
175
+ temporaryProjectPath,
176
+ ];
177
+
178
+ if (!(await systemSyncLogIfFailure(cmdToExec2, args2))) {
179
+ println('Failed to build fuzzers');
180
+ return false;
181
+ }
182
+
183
+ //const wsPath = workspaceFolder[0].uri.fsPath; // gets the path of the first workspace folder
184
+ const temporaryDockerPath =
185
+ extensionConfig.ossFuzzPepositoryWorkPath +
186
+ '/projects/' +
187
+ ossFuzzProjectName +
188
+ '/Dockerfile';
189
+ const temporaryDockerPath2 =
190
+ extensionConfig.ossFuzzPepositoryWorkPath +
191
+ '/projects/' +
192
+ ossFuzzProjectName +
193
+ '/Dockerfile2';
194
+
195
+ const args3: Array<string> = [temporaryDockerPath, temporaryDockerPath2];
196
+ if (!(await systemSyncLogIfFailure('cp', args3))) {
197
+ println('Failed to copy Dockerfile');
198
+ return false;
199
+ }
200
+
201
+ // Append COPY command to Dockerfile
202
+ fs.appendFileSync(
203
+ temporaryDockerPath,
204
+ 'COPY temporary-project /src/' + ossFuzzProjectName
205
+ );
206
+
207
+ // Second, build the actual fuzzers using the temporarily created project path for mount.
208
+ const cmdToExec = 'python3';
209
+ const args = [
210
+ extensionConfig.ossFuzzPepositoryWorkPath + '/infra/helper.py',
211
+ 'build_fuzzers', // command
212
+ ];
213
+
214
+ // Add sanitizer if needed.
215
+ if (sanitizer !== '') {
216
+ args.push('--sanitizer=' + sanitizer);
217
+ }
218
+
219
+ // Add clean flag if needed.
220
+ if (toClean) {
221
+ args.push('--clean');
222
+ }
223
+
224
+ args.push(ossFuzzProjectName);
225
+ /*
226
+ Previously we used OSS-Fuzz logic that supports mounting paths for getting
227
+ the workspace into the Dockerfile.
228
+ This approach, however, has limitations in that most builds will modify
229
+ the contents of the folder they're working in. This can cause issues and also
230
+ make it not possible to build several versions of the project with changing
231
+ sanitizers in a sequence. As such, we disbanded.
232
+ */
233
+ println('Building fuzzers');
234
+ if (!(await systemSyncLogIfFailure(cmdToExec, args))) {
235
+ println('Failed to copy Dockerfile');
236
+ // Move back the modified Dockerfile
237
+ const args5: Array<string> = [
238
+ temporaryDockerPath2,
239
+ temporaryDockerPath,
240
+ ];
241
+ if (!(await systemSyncLogIfFailure('mv', args5))) {
242
+ println('Failed to copy back Dockerfile');
243
+ return false;
244
+ }
245
+ return false;
246
+ }
247
+
248
+ // Move back the modified Dockerfile
249
+ const args5: Array<string> = [temporaryDockerPath2, temporaryDockerPath];
250
+ if (!(await systemSyncLogIfFailure('mv', args5))) {
251
+ println('Failed to copy back Dockerfile');
252
+ return false;
253
+ }
254
+ } else {
255
+ println('OSS-Fuzz does not have the relevant project folder');
256
+ return false;
257
+ }
258
+ }
259
+
260
+ // If we go to here we successfully build the project. Give information.
261
+ vscode.window.showInformationMessage('Successfully build project');
262
+
263
+ // List the fuzzers build
264
+ await listFuzzersForProject(
265
+ ossFuzzProjectName,
266
+ extensionConfig.ossFuzzPepositoryWorkPath
267
+ );
268
+ return true;
269
+ }
270
+
271
+ /**
272
+ * Runs the fuzzer for a given CFLite project
273
+ */
274
+ export async function runFuzzerHandlerCFLite(
275
+ projectNameArg: string,
276
+ fuzzerNameArg: string,
277
+ secondsToRunArg: string
278
+ ) {
279
+ // The fuzzer is run by way of OSS-Fuzz's helper.py so we use python3 to launch
280
+ // this script.
281
+ const cmdToExec = 'python3';
282
+
283
+ // Set the arguments correctly. The ordering here is important for compatibility
284
+ // with the underlying argparse used by OSS-Fuzz helper.py.
285
+ const args: Array<string> = [
286
+ extensionConfig.ossFuzzPepositoryWorkPath + '/infra/helper.py',
287
+ 'run_fuzzer',
288
+ ];
289
+
290
+ args.push('--external');
291
+ args.push(projectNameArg);
292
+ args.push(fuzzerNameArg);
293
+ args.push('--');
294
+ args.push('-max_total_time=' + secondsToRunArg);
295
+
296
+ println(
297
+ 'Running fuzzer' +
298
+ fuzzerNameArg +
299
+ ' from project ' +
300
+ projectNameArg +
301
+ ' for ' +
302
+ secondsToRunArg +
303
+ ' seconds.'
304
+ );
305
+
306
+ // Run the actual command
307
+ if (!(await systemSyncLogIfFailure(cmdToExec, args))) {
308
+ println('Failed to run fuzzer');
309
+ return false;
310
+ }
311
+ return true;
312
+ }
313
+
314
+ /**
315
+ * Runs the fuzzer for a given project.
316
+ */
317
+ export async function runFuzzerHandler(
318
+ projectNameArg: string,
319
+ fuzzerNameArg: string,
320
+ secondsToRunArg: string,
321
+ fuzzerCorpusPath: string
322
+ ) {
323
+ // Check there is a valid OSS-Fuzz path. If not, bail out.
324
+ if (
325
+ (await isPathValidOssFuzzPath(
326
+ extensionConfig.ossFuzzPepositoryWorkPath
327
+ )) === false
328
+ ) {
329
+ println('Missing valid OSS-Fuzz path.');
330
+ return;
331
+ }
332
+ // The fuzzer is run by way of OSS-Fuzz's helper.py so we use python3 to launch
333
+ // this script.
334
+ const cmdToExec = 'python3';
335
+
336
+ // Set the arguments correctly. The ordering here is important for compatibility
337
+ // with the underlying argparse used by OSS-Fuzz helper.py.
338
+ const args: Array<string> = [
339
+ extensionConfig.ossFuzzPepositoryWorkPath + '/infra/helper.py',
340
+ 'run_fuzzer',
341
+ ];
342
+ if (fuzzerCorpusPath !== '') {
343
+ args.push('--corpus-dir');
344
+ args.push(fuzzerCorpusPath);
345
+ }
346
+ args.push(projectNameArg);
347
+ args.push(fuzzerNameArg);
348
+ args.push('--');
349
+ args.push('-max_total_time=' + secondsToRunArg);
350
+
351
+ println(
352
+ 'Running fuzzer' +
353
+ fuzzerNameArg +
354
+ ' from project ' +
355
+ projectNameArg +
356
+ ' for ' +
357
+ secondsToRunArg +
358
+ ' seconds.'
359
+ );
360
+
361
+ // Run the actual command
362
+ if (!(await systemSyncLogIfFailure(cmdToExec, args))) {
363
+ println('Failed to run fuzzer');
364
+ return false;
365
+ }
366
+ return true;
367
+ }
368
+
369
+ // Validates if a directory is a valid oss-fuzz path.
370
+ export async function isPathValidOssFuzzPath(path: string) {
371
+ try {
372
+ if (await vscode.workspace.fs.readDirectory(vscode.Uri.file(path))) {
373
+ // println('Is a directory');
374
+ // const helperPath = vscode.Uri.file(path + '/infra/helper.py');
375
+ const helperPath = path + '/infra/helper.py';
376
+ //console.log('Checking ' + helperPath.toString());
377
+ if (fs.existsSync(helperPath.toString())) {
378
+ return true;
379
+ }
380
+ }
381
+ } catch {
382
+ /* empty */
383
+ }
384
+ return false;
385
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/projectIntegrationHelper.ts ADDED
@@ -0,0 +1,761 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import * as vscode from 'vscode';
18
+ const fs = require('fs');
19
+ import path = require('path');
20
+ import {println} from './logger';
21
+ import * as fuzzTemplate from './commands/cmdTemplate';
22
+
23
+ export async function setupProjectInitialFiles(isClusterfuzzLite: boolean) {
24
+ const wsedit = new vscode.WorkspaceEdit();
25
+ const workspaceFolder = vscode.workspace.workspaceFolders;
26
+ let projectGithubRepository = '';
27
+
28
+ const isOssFuzz = isClusterfuzzLite === false;
29
+
30
+ // Get the repository if this is not ClusterfuzzLite
31
+ if (isOssFuzz) {
32
+ const tmpProjectGithubRepository = await vscode.window.showInputBox({
33
+ value: '',
34
+ placeHolder: 'Github repository for the project.',
35
+ });
36
+ if (!tmpProjectGithubRepository) {
37
+ return false;
38
+ }
39
+ projectGithubRepository = tmpProjectGithubRepository;
40
+ }
41
+
42
+ const projectNameFromRepo = path
43
+ .parse(projectGithubRepository)
44
+ .base.toLocaleLowerCase();
45
+
46
+ let pathOfLocal = '';
47
+ if (workspaceFolder) {
48
+ pathOfLocal = path
49
+ .parse(workspaceFolder[0].uri.fsPath)
50
+ .base.toLocaleLowerCase();
51
+ println('path of local: ' + pathOfLocal);
52
+ }
53
+ if (isOssFuzz) {
54
+ println('Derived project name: ' + projectNameFromRepo);
55
+ }
56
+
57
+ const pythonFiles = await vscode.workspace.findFiles('**/*.py');
58
+ const cppFiles = await vscode.workspace.findFiles('**/*.c++');
59
+ const cppFiles2 = await vscode.workspace.findFiles('**/*.cpp');
60
+ const cppFiles3 = await vscode.workspace.findFiles('**/*.cc');
61
+ const cfiles = await vscode.workspace.findFiles('**/*.c');
62
+ const hfiles = await vscode.workspace.findFiles('**/*.h');
63
+ const rustFiles = await vscode.workspace.findFiles('**/*.rust');
64
+ const golangFiles = await vscode.workspace.findFiles('**/*.go');
65
+ const javaFiles = await vscode.workspace.findFiles('**/*.java');
66
+
67
+ println('Number of python files: ' + pythonFiles.length);
68
+ println('Number of C++ files: ' + cppFiles.length + cppFiles2.length);
69
+ println('Number of C files: ' + cfiles.length);
70
+ println('Number of rustFiles files: ' + rustFiles.length);
71
+ println('Number of golangFiles files: ' + golangFiles.length);
72
+ println('Number of H files: ' + hfiles.length);
73
+
74
+ const cppFilesCount = cppFiles.length + cppFiles2.length + cppFiles3.length;
75
+
76
+ const maxCount = Math.max(
77
+ pythonFiles.length,
78
+ cppFilesCount,
79
+ cfiles.length,
80
+ rustFiles.length,
81
+ golangFiles.length,
82
+ javaFiles.length
83
+ );
84
+ let target = '';
85
+ if (maxCount > 0) {
86
+ if (maxCount === pythonFiles.length) {
87
+ target = 'python';
88
+ } else if (maxCount === cppFilesCount) {
89
+ target = 'cpp';
90
+ } else if (maxCount === cfiles.length) {
91
+ target = 'c';
92
+ } else if (maxCount === javaFiles.length) {
93
+ target = 'java';
94
+ } else {
95
+ println('Target is not implemented');
96
+ return true;
97
+ }
98
+ } else {
99
+ if (hfiles.length > 0) {
100
+ target = 'cpp';
101
+ } else {
102
+ return true;
103
+ }
104
+ }
105
+
106
+ println('Target language: ' + target);
107
+
108
+ let baseFolder = '.clusterfuzzlite';
109
+ if (isOssFuzz) {
110
+ baseFolder = 'OSS-Fuzz';
111
+ }
112
+
113
+ if (workspaceFolder) {
114
+ const wsPath = workspaceFolder[0].uri.fsPath; // gets the path of the first workspace folder
115
+
116
+ // Create workflow file for ClusterFuzzLite
117
+ if (isOssFuzz === false) {
118
+ println('Creating the workflow file');
119
+ const clusterfuzzWorkflowFile = vscode.Uri.file(
120
+ wsPath + '/' + '.github' + '/' + 'workflows/cflite_pr.yml'
121
+ );
122
+
123
+ let tmp_target = target;
124
+ if (tmp_target === 'cpp') {
125
+ tmp_target = 'c++';
126
+ }
127
+
128
+ //println('Workflow pth: ' + clusterfuzzWorkflowFile);
129
+
130
+ const cflite_workflow_yaml = `name: ClusterFuzzLite PR fuzzing
131
+ on:
132
+ workflow_dispatch:
133
+ pull_request:
134
+ branches: [ main ]
135
+ permissions: read-all
136
+ jobs:
137
+ PR:
138
+ runs-on: ubuntu-latest
139
+ strategy:
140
+ fail-fast: false
141
+ matrix:
142
+ sanitizer: [address]
143
+ steps:
144
+ - name: Build Fuzzers (\${{ matrix.sanitizer }})
145
+ id: build
146
+ uses: google/clusterfuzzlite/actions/build_fuzzers@v1
147
+ with:
148
+ sanitizer: \${{ matrix.sanitizer }}
149
+ language: ${tmp_target}
150
+ bad-build-check: false
151
+ - name: Run Fuzzers (\${{ matrix.sanitizer }})
152
+ id: run
153
+ uses: google/clusterfuzzlite/actions/run_fuzzers@v1
154
+ with:
155
+ github-token: \${{ secrets.GITHUB_TOKEN }}
156
+ fuzz-seconds: 100
157
+ mode: 'code-change'
158
+ report-unreproducible-crashes: false
159
+ sanitizer: \${{ matrix.sanitizer }}
160
+ `;
161
+
162
+ // Create the file and add the contents
163
+ if (fs.existsSync(clusterfuzzWorkflowFile.path) === false) {
164
+ wsedit.createFile(clusterfuzzWorkflowFile, {ignoreIfExists: true});
165
+ wsedit.insert(
166
+ clusterfuzzWorkflowFile,
167
+ new vscode.Position(0, 0),
168
+ cflite_workflow_yaml
169
+ );
170
+ }
171
+ }
172
+
173
+ const ossfuzzDockerFilepath = vscode.Uri.file(
174
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/Dockerfile'
175
+ );
176
+
177
+ vscode.window.showInformationMessage(ossfuzzDockerFilepath.toString());
178
+ //wsedit.createFile(ossfuzzDockerFilepath, {ignoreIfExists: true});
179
+
180
+ if (target === 'python') {
181
+ await setupPythonProjectInitialFiles(
182
+ projectGithubRepository,
183
+ projectNameFromRepo,
184
+ ossfuzzDockerFilepath,
185
+ wsedit,
186
+ wsPath,
187
+ baseFolder,
188
+ pathOfLocal,
189
+ isOssFuzz
190
+ );
191
+ }
192
+ if (target === 'cpp') {
193
+ await setupCPPProjectInitialFiles(
194
+ projectGithubRepository,
195
+ projectNameFromRepo,
196
+ ossfuzzDockerFilepath,
197
+ wsedit,
198
+ wsPath,
199
+ baseFolder,
200
+ pathOfLocal,
201
+ isOssFuzz
202
+ );
203
+ }
204
+ if (target === 'c') {
205
+ await setupCProjectInitialFiles(
206
+ projectGithubRepository,
207
+ projectNameFromRepo,
208
+ ossfuzzDockerFilepath,
209
+ wsedit,
210
+ wsPath,
211
+ baseFolder,
212
+ pathOfLocal,
213
+ isOssFuzz
214
+ );
215
+ }
216
+ if (target === 'java') {
217
+ await setupJavaProjectInitialFiles(
218
+ projectGithubRepository,
219
+ projectNameFromRepo,
220
+ ossfuzzDockerFilepath,
221
+ wsedit,
222
+ wsPath,
223
+ baseFolder,
224
+ isOssFuzz
225
+ );
226
+ }
227
+ vscode.workspace.applyEdit(wsedit);
228
+ vscode.window.showInformationMessage('Created a new file: hello/world.md');
229
+ }
230
+ return true;
231
+ }
232
+
233
+ function createProjectYamlContent(
234
+ wsedit: vscode.WorkspaceEdit,
235
+ wsPath: string,
236
+ baseFolder: string,
237
+ isOssFuzz: boolean,
238
+ projectGithubRepository: string,
239
+ projectNameFromRepo: string,
240
+ language: string
241
+ ) {
242
+ const projectYamlFilepath = vscode.Uri.file(
243
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/project.yaml'
244
+ );
245
+ if (fs.existsSync(projectYamlFilepath.path) === false) {
246
+ vscode.window.showInformationMessage(projectYamlFilepath.toString());
247
+ wsedit.createFile(projectYamlFilepath, {ignoreIfExists: true});
248
+ const projectYamlTemplate = `homepage: "${projectGithubRepository}"
249
+ language: ${language}
250
+ primary_contact: "<primary_contact_email>"
251
+ main_repo: "${projectGithubRepository}"
252
+ file_github_issue: true
253
+ `;
254
+
255
+ const projectYamlTemplateCFLite = `language: ${language}`;
256
+
257
+ const yamlContentToWrite = isOssFuzz
258
+ ? projectYamlTemplate
259
+ : projectYamlTemplateCFLite;
260
+
261
+ wsedit.insert(
262
+ projectYamlFilepath,
263
+ new vscode.Position(0, 0),
264
+ yamlContentToWrite
265
+ );
266
+ }
267
+ }
268
+
269
+ function getLicenseHeader() {
270
+ const todaysDate = new Date();
271
+ const currentYear = todaysDate.getFullYear();
272
+
273
+ const licenseHeader = `# Copyright ${currentYear} Google LLC
274
+ #
275
+ # Licensed under the Apache License, Version 2.0 (the "License");
276
+ # you may not use this file except in compliance with the License.
277
+ # You may obtain a copy of the License at
278
+ #
279
+ # http://www.apache.org/licenses/LICENSE-2.0
280
+ #
281
+ # Unless required by applicable law or agreed to in writing, software
282
+ # distributed under the License is distributed on an "AS IS" BASIS,
283
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
284
+ # See the License for the specific language governing permissions and
285
+ # limitations under the License.
286
+ #
287
+ ################################################################################
288
+ `;
289
+
290
+ return licenseHeader;
291
+ }
292
+
293
+ function getBaseDockerFile(language: string) {
294
+ const languageToBasebuilder: {[id: string]: string} = {
295
+ java: 'ghcr.io/aixcc-finals/base-builder-jvm',
296
+ cpp: 'ghcr.io/aixcc-finals/base-builder',
297
+ c: 'ghcr.io/aixcc-finals/base-builder',
298
+ python: 'ghcr.io/aixcc-finals/base-builder-python',
299
+ };
300
+ let dockerFileContent = getLicenseHeader();
301
+ dockerFileContent += '\n' + 'FROM ' + languageToBasebuilder[language] + '\n';
302
+
303
+ return dockerFileContent;
304
+ }
305
+
306
+ function createReadmeFile(
307
+ wsedit: vscode.WorkspaceEdit,
308
+ wsPath: string,
309
+ baseFolder: string,
310
+ isOssFuzz: boolean
311
+ ) {
312
+ const readmeFile = vscode.Uri.file(
313
+ wsPath + '/' + baseFolder + '/' + '/README.md'
314
+ );
315
+ //vscode.window.showInformationMessage(readmeFile.toString());
316
+ if (fs.existsSync(readmeFile.path) === false) {
317
+ const readmeContents = `# OSS-Fuzz set up
318
+ This folder is the OSS-Fuzz set up.
319
+ `;
320
+
321
+ const readmeContentsCFLite = `# ClusterFuzzLite set up
322
+ This folder contains a fuzzing set for [ClusterFuzzLite](https://google.github.io/clusterfuzzlite).
323
+ `;
324
+
325
+ const readmeContentsToWrite = isOssFuzz
326
+ ? readmeContents
327
+ : readmeContentsCFLite;
328
+
329
+ wsedit.createFile(readmeFile, {ignoreIfExists: true});
330
+
331
+ wsedit.insert(readmeFile, new vscode.Position(0, 0), readmeContentsToWrite);
332
+ }
333
+ }
334
+
335
+ async function setupJavaProjectInitialFiles(
336
+ projectGithubRepository: string,
337
+ projectNameFromRepo: string,
338
+ ossfuzzDockerFilepath: vscode.Uri,
339
+ wsedit: vscode.WorkspaceEdit,
340
+ wsPath: string,
341
+ baseFolder: string,
342
+ isOssFuzz: boolean
343
+ ) {
344
+ // Dockerfile
345
+ const dockerfileTemplate =
346
+ getBaseDockerFile('java') +
347
+ `
348
+ RUN curl -L https://archive.apache.org/dist/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip -o maven.zip && \\
349
+ unzip maven.zip -d $SRC/maven && \\
350
+ rm -rf maven.zip
351
+
352
+ ENV MVN $SRC/maven/apache-maven-3.6.3/bin/mvn
353
+ RUN git clone --depth 1 ${projectGithubRepository} ${projectNameFromRepo}
354
+ WORKDIR ${projectNameFromRepo}
355
+ COPY build.sh *.java $SRC/`;
356
+ wsedit.insert(
357
+ ossfuzzDockerFilepath,
358
+ new vscode.Position(0, 0),
359
+ dockerfileTemplate
360
+ );
361
+
362
+ // build.sh
363
+ const ossfuzzBuildFilepath = vscode.Uri.file(
364
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/build.sh'
365
+ );
366
+ vscode.window.showInformationMessage(ossfuzzBuildFilepath.toString());
367
+ wsedit.createFile(ossfuzzBuildFilepath, {ignoreIfExists: true});
368
+ const buildTemplate =
369
+ `#!/bin/bash -eu
370
+ ` +
371
+ getLicenseHeader() +
372
+ `
373
+ # Supply build instructions
374
+ # Copy all fuzzer executables to $OUT/
375
+ `;
376
+ wsedit.insert(ossfuzzBuildFilepath, new vscode.Position(0, 0), buildTemplate);
377
+
378
+ // project.yaml
379
+ createProjectYamlContent(
380
+ wsedit,
381
+ wsPath,
382
+ baseFolder,
383
+ isOssFuzz,
384
+ projectGithubRepository,
385
+ projectNameFromRepo,
386
+ 'jvm'
387
+ );
388
+
389
+ /* Sample template fuzzer */
390
+ const sampleFuzzFile = vscode.Uri.file(
391
+ wsPath +
392
+ '/' +
393
+ baseFolder +
394
+ '/' +
395
+ projectNameFromRepo +
396
+ '/fuzzer_example.java'
397
+ );
398
+
399
+ wsedit.createFile(sampleFuzzFile, {ignoreIfExists: true});
400
+ const sampleFuzzFileContents = fuzzTemplate.javaLangBareTemplate;
401
+
402
+ wsedit.insert(
403
+ sampleFuzzFile,
404
+ new vscode.Position(0, 0),
405
+ sampleFuzzFileContents
406
+ );
407
+
408
+ createReadmeFile(wsedit, wsPath, baseFolder, isOssFuzz);
409
+ }
410
+
411
+ async function setupCProjectInitialFiles(
412
+ projectGithubRepository: string,
413
+ projectNameFromRepo: string,
414
+ ossfuzzDockerFilepath: vscode.Uri,
415
+ wsedit: vscode.WorkspaceEdit,
416
+ wsPath: string,
417
+ baseFolder: string,
418
+ baseName: string,
419
+ isOssFuzz: boolean
420
+ ) {
421
+ // Dockerfile
422
+ if (fs.existsSync(ossfuzzDockerFilepath.path) === false) {
423
+ const dockerfileTemplate =
424
+ getBaseDockerFile('cpp') +
425
+ `
426
+ RUN apt-get update && apt-get install -y make autoconf automake libtool
427
+ RUN git clone --depth 1 ${projectGithubRepository} ${projectNameFromRepo}
428
+ WORKDIR ${projectNameFromRepo}
429
+ COPY build.sh *.cpp $SRC/`;
430
+
431
+ const dockerfileTemplateClusterfuzzLite = `FROM ghcr.io/aixcc-finals/base-builder
432
+ RUN apt-get update && apt-get install -y make autoconf automake libtool
433
+
434
+ COPY . $SRC/${baseName}
435
+ COPY .clusterfuzzlite/build.sh $SRC/build.sh
436
+ WORKDIR $SRC/${baseName}`;
437
+
438
+ const contentToWrite = isOssFuzz
439
+ ? dockerfileTemplate
440
+ : dockerfileTemplateClusterfuzzLite;
441
+
442
+ // Create the file and add the contents
443
+ wsedit.createFile(ossfuzzDockerFilepath, {ignoreIfExists: true});
444
+ wsedit.insert(
445
+ ossfuzzDockerFilepath,
446
+ new vscode.Position(0, 0),
447
+ contentToWrite
448
+ );
449
+ }
450
+
451
+ // build.sh
452
+ const ossfuzzBuildFilepath = vscode.Uri.file(
453
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/build.sh'
454
+ );
455
+ // Only create the build file if it doesn't exist
456
+ if (fs.existsSync(ossfuzzBuildFilepath.path) === false) {
457
+ vscode.window.showInformationMessage(ossfuzzBuildFilepath.toString());
458
+ wsedit.createFile(ossfuzzBuildFilepath, {ignoreIfExists: true});
459
+ const buildTemplate =
460
+ `#!/bin/bash -eu
461
+ ` +
462
+ getLicenseHeader() +
463
+ `
464
+ # Supply build instructions
465
+ # Use the following environment variables to build the code
466
+ # $CXX: c++ compiler
467
+ # $CC: c compiler
468
+ # CFLAGS: compiler flags for C files
469
+ # CXXFLAGS: compiler flags for CPP files
470
+ # LIB_FUZZING_ENGINE: linker flag for fuzzing harnesses
471
+
472
+ # Copy all fuzzer executables to $OUT/
473
+ $CXX $CFLAGS $LIB_FUZZING_ENGINE $SRC/fuzzer_example.c -o $OUT/fuzzer_example
474
+ `;
475
+
476
+ const buildTemplateClusterfuzzLite = `#!/bin/bash -eu
477
+ # Supply build instructions
478
+ # Use the following environment variables to build the code
479
+ # $CXX: c++ compiler
480
+ # $CC: c compiler
481
+ # CFLAGS: compiler flags for C files
482
+ # CXXFLAGS: compiler flags for CPP files
483
+ # LIB_FUZZING_ENGINE: linker flag for fuzzing harnesses
484
+
485
+ # Copy all fuzzer executables to $OUT/
486
+ $CC $CFLAGS $LIB_FUZZING_ENGINE \\
487
+ $SRC/${baseName}/.clusterfuzzlite/fuzzer_example.c \\
488
+ -o $OUT/fuzzer_example
489
+ `;
490
+
491
+ const buildContent = isOssFuzz
492
+ ? buildTemplate
493
+ : buildTemplateClusterfuzzLite;
494
+ wsedit.insert(
495
+ ossfuzzBuildFilepath,
496
+ new vscode.Position(0, 0),
497
+ buildContent
498
+ );
499
+ }
500
+
501
+ // project.yaml
502
+ createProjectYamlContent(
503
+ wsedit,
504
+ wsPath,
505
+ baseFolder,
506
+ isOssFuzz,
507
+ projectGithubRepository,
508
+ projectNameFromRepo,
509
+ 'c'
510
+ );
511
+
512
+ /* Sample template fuzzer */
513
+ const sampleFuzzFile = vscode.Uri.file(
514
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/fuzzer_example.c'
515
+ );
516
+ if (fs.existsSync(sampleFuzzFile.path) === false) {
517
+ wsedit.createFile(sampleFuzzFile, {ignoreIfExists: true});
518
+ const sampleFuzzFileContents = fuzzTemplate.cLangSimpleStringFuzzer;
519
+
520
+ wsedit.insert(
521
+ sampleFuzzFile,
522
+ new vscode.Position(0, 0),
523
+ sampleFuzzFileContents
524
+ );
525
+ }
526
+
527
+ createReadmeFile(wsedit, wsPath, baseFolder, isOssFuzz);
528
+ }
529
+
530
+ async function setupCPPProjectInitialFiles(
531
+ projectGithubRepository: string,
532
+ projectNameFromRepo: string,
533
+ ossfuzzDockerFilepath: vscode.Uri,
534
+ wsedit: vscode.WorkspaceEdit,
535
+ wsPath: string,
536
+ baseFolder: string,
537
+ baseName: string,
538
+ isOssFuzz: boolean
539
+ ) {
540
+ // Dockerfile
541
+ // Only create a new Dockerfile if it doesn't already exist
542
+ if (fs.existsSync(ossfuzzDockerFilepath.path) === false) {
543
+ const dockerfileTemplate =
544
+ getBaseDockerFile('cpp') +
545
+ `
546
+ RUN apt-get update && apt-get install -y make autoconf automake libtool
547
+ RUN git clone --depth 1 ${projectGithubRepository} ${projectNameFromRepo}
548
+ WORKDIR ${projectNameFromRepo}
549
+ COPY build.sh *.cpp $SRC/`;
550
+
551
+ const dockerfileTemplateClusterfuzzLite = `FROM ghcr.io/aixcc-finals/base-builder
552
+ RUN apt-get update && apt-get install -y make autoconf automake libtool
553
+
554
+ COPY . $SRC/${baseName}
555
+ COPY .clusterfuzzlite/build.sh $SRC/build.sh
556
+ WORKDIR $SRC/${baseName}`;
557
+
558
+ const contentToWrite = isOssFuzz
559
+ ? dockerfileTemplate
560
+ : dockerfileTemplateClusterfuzzLite;
561
+
562
+ // Create the file and add the contents
563
+ wsedit.createFile(ossfuzzDockerFilepath, {ignoreIfExists: true});
564
+ wsedit.insert(
565
+ ossfuzzDockerFilepath,
566
+ new vscode.Position(0, 0),
567
+ contentToWrite
568
+ );
569
+ }
570
+
571
+ // build.sh
572
+ const ossfuzzBuildFilepath = vscode.Uri.file(
573
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/build.sh'
574
+ );
575
+ // Only create the build file if it doesn't exist
576
+ if (fs.existsSync(ossfuzzBuildFilepath.path) === false) {
577
+ vscode.window.showInformationMessage(ossfuzzBuildFilepath.toString());
578
+ wsedit.createFile(ossfuzzBuildFilepath, {ignoreIfExists: true});
579
+ const buildTemplate =
580
+ `#!/bin/bash -eu
581
+ ` +
582
+ getLicenseHeader() +
583
+ `
584
+ # Supply build instructions
585
+ # Use the following environment variables to build the code
586
+ # $CXX: c++ compiler
587
+ # $CC: c compiler
588
+ # CFLAGS: compiler flags for C files
589
+ # CXXFLAGS: compiler flags for CPP files
590
+ # LIB_FUZZING_ENGINE: linker flag for fuzzing harnesses
591
+
592
+ # Copy all fuzzer executables to $OUT/
593
+ $CXX $CXXFLAGS $LIB_FUZZING_ENGINE $SRC/fuzzer_example.cpp -o $OUT/fuzzer_example
594
+ `;
595
+ const buildTemplateClusterfuzzLite = `#!/bin/bash -eu
596
+ # Supply build instructions
597
+ # Use the following environment variables to build the code
598
+ # $CXX: c++ compiler
599
+ # $CC: c compiler
600
+ # CFLAGS: compiler flags for C files
601
+ # CXXFLAGS: compiler flags for CPP files
602
+ # LIB_FUZZING_ENGINE: linker flag for fuzzing harnesses
603
+
604
+ # Copy all fuzzer executables to $OUT/
605
+ $CXX $CXXFLAGS $LIB_FUZZING_ENGINE \\
606
+ $SRC/${baseName}/.clusterfuzzlite/fuzzer_example.cpp \\
607
+ -o $OUT/fuzzer_example
608
+ `;
609
+
610
+ const buildContent = isOssFuzz
611
+ ? buildTemplate
612
+ : buildTemplateClusterfuzzLite;
613
+ wsedit.insert(
614
+ ossfuzzBuildFilepath,
615
+ new vscode.Position(0, 0),
616
+ buildContent
617
+ );
618
+ }
619
+
620
+ // project.yaml
621
+ createProjectYamlContent(
622
+ wsedit,
623
+ wsPath,
624
+ baseFolder,
625
+ isOssFuzz,
626
+ projectGithubRepository,
627
+ projectNameFromRepo,
628
+ 'c++'
629
+ );
630
+
631
+ /* Sample template fuzzer */
632
+ const sampleFuzzFile = vscode.Uri.file(
633
+ wsPath +
634
+ '/' +
635
+ baseFolder +
636
+ '/' +
637
+ projectNameFromRepo +
638
+ '/fuzzer_example.cpp'
639
+ );
640
+ if (fs.existsSync(sampleFuzzFile.path) === false) {
641
+ wsedit.createFile(sampleFuzzFile, {ignoreIfExists: true});
642
+ const sampleFuzzFileContents = fuzzTemplate.cppLangFDPTemplateFuzzer;
643
+
644
+ wsedit.insert(
645
+ sampleFuzzFile,
646
+ new vscode.Position(0, 0),
647
+ sampleFuzzFileContents
648
+ );
649
+ }
650
+
651
+ createReadmeFile(wsedit, wsPath, baseFolder, isOssFuzz);
652
+ }
653
+
654
+ async function setupPythonProjectInitialFiles(
655
+ projectGithubRepository: string,
656
+ projectNameFromRepo: string,
657
+ ossfuzzDockerFilepath: vscode.Uri,
658
+ wsedit: vscode.WorkspaceEdit,
659
+ wsPath: string,
660
+ baseFolder: string,
661
+ baseName: string,
662
+ isOssFuzz: boolean
663
+ ) {
664
+ // Only write to Dockerfile if it doesn't already exist
665
+ // Dockerfile
666
+ if (fs.existsSync(ossfuzzDockerFilepath.path) === false) {
667
+ const dockerfileTemplate =
668
+ getBaseDockerFile('python') +
669
+ `
670
+ RUN python3 -m pip install --upgrade pip
671
+ RUN git clone --depth 1 ${projectGithubRepository} ${projectNameFromRepo}
672
+ WORKDIR ${projectNameFromRepo}
673
+ COPY build.sh *.py $SRC/`;
674
+
675
+ const dockerfileTemplateClusterfuzzLite =
676
+ getBaseDockerFile('python') +
677
+ `
678
+ RUN apt-get update && apt-get install -y make autoconf automake libtool
679
+
680
+ COPY . $SRC/${baseName}
681
+ COPY .clusterfuzzlite/build.sh $SRC/build.sh
682
+ WORKDIR $SRC/${baseName}`;
683
+
684
+ const contentToWrite = isOssFuzz
685
+ ? dockerfileTemplate
686
+ : dockerfileTemplateClusterfuzzLite;
687
+
688
+ wsedit.insert(
689
+ ossfuzzDockerFilepath,
690
+ new vscode.Position(0, 0),
691
+ contentToWrite
692
+ );
693
+ }
694
+
695
+ // build.sh
696
+ const ossfuzzBuildFilepath = vscode.Uri.file(
697
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/build.sh'
698
+ );
699
+ // Only create the build file if it doesn't exist
700
+ if (fs.existsSync(ossfuzzBuildFilepath.path) === false) {
701
+ vscode.window.showInformationMessage(ossfuzzBuildFilepath.toString());
702
+ wsedit.createFile(ossfuzzBuildFilepath, {ignoreIfExists: true});
703
+ const buildTemplate =
704
+ `#!/bin/bash -eu
705
+ ` +
706
+ getLicenseHeader() +
707
+ `
708
+ python3 -m pip install .
709
+
710
+ # Build fuzzers (files prefixed with fuzz_) to $OUT
711
+ for fuzzer in $(find $SRC -name 'fuzz_*.py'); do
712
+ compile_python_fuzzer $fuzzer
713
+ done`;
714
+
715
+ const buildTemplateClusterfuzzLite = `#!/bin/bash -eu
716
+ python3 -m pip install .
717
+
718
+ # Build fuzzers (files prefixed with fuzz_) to $OUT
719
+ for fuzzer in $(find $SRC -name 'fuzz_*.py'); do
720
+ compile_python_fuzzer $fuzzer
721
+ done`;
722
+
723
+ const buildContent = isOssFuzz
724
+ ? buildTemplate
725
+ : buildTemplateClusterfuzzLite;
726
+ wsedit.insert(
727
+ ossfuzzBuildFilepath,
728
+ new vscode.Position(0, 0),
729
+ buildContent
730
+ );
731
+ }
732
+
733
+ // project.yaml
734
+ createProjectYamlContent(
735
+ wsedit,
736
+ wsPath,
737
+ baseFolder,
738
+ isOssFuzz,
739
+ projectGithubRepository,
740
+ projectNameFromRepo,
741
+ 'python'
742
+ );
743
+
744
+ // Sample template fuzzer
745
+ const sampleFuzzFile = vscode.Uri.file(
746
+ wsPath + '/' + baseFolder + '/' + projectNameFromRepo + '/fuzz_ex1.py'
747
+ );
748
+ if (fs.existsSync(sampleFuzzFile.path) === false) {
749
+ wsedit.createFile(sampleFuzzFile, {ignoreIfExists: true});
750
+ const sampleFuzzFileContents = fuzzTemplate.pythonLangFileInputFuzzer;
751
+
752
+ wsedit.insert(
753
+ sampleFuzzFile,
754
+ new vscode.Position(0, 0),
755
+ sampleFuzzFileContents
756
+ );
757
+ }
758
+
759
+ // README.md
760
+ createReadmeFile(wsedit, wsPath, baseFolder, isOssFuzz);
761
+ }
local-test-commons-compress-delta-03/fuzz-tooling/tools/vscode-extension/src/utils.ts ADDED
@@ -0,0 +1,306 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Copyright 2023 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+ //
15
+ ////////////////////////////////////////////////////////////////////////////////
16
+
17
+ import * as vscode from 'vscode';
18
+ import {extensionConfig} from './config';
19
+ import {getApi, FileDownloader} from '@microsoft/vscode-file-downloader-api';
20
+
21
+ const fs = require('fs');
22
+ const {spawn} = require('node:child_process');
23
+ const statusBarComp = vscode.window.createStatusBarItem(
24
+ vscode.StatusBarAlignment.Right,
25
+ 100
26
+ );
27
+
28
+ import {println, printRaw, debugPrintln} from './logger';
29
+
30
+ export async function setStatusText(statusText: string) {
31
+ //let myStatusBarItem: vscode.StatusBarItem;
32
+ statusBarComp.text = '$(megaphone) OSS-Fuzz: ' + statusText;
33
+ statusBarComp.show();
34
+ }
35
+
36
+ export async function downloadRemoteURL(
37
+ urlString: string,
38
+ targetFile: string,
39
+ context: vscode.ExtensionContext
40
+ ) {
41
+ const fileDownloader: FileDownloader = await getApi();
42
+ println('URL: ' + urlString);
43
+ let codeCoverageFile: vscode.Uri;
44
+ try {
45
+ codeCoverageFile = await fileDownloader.downloadFile(
46
+ vscode.Uri.parse(urlString),
47
+ targetFile,
48
+ context
49
+ );
50
+ } catch (err) {
51
+ println('Could not get the coverage summary file');
52
+ return false;
53
+ }
54
+ return codeCoverageFile;
55
+ }
56
+
57
+ export async function getLocalOutBuildDir(projectName: string) {
58
+ const summaryCovPath =
59
+ extensionConfig.ossFuzzPepositoryWorkPath + '/build/out/' + projectName;
60
+ return summaryCovPath;
61
+ }
62
+
63
+ export async function getOSSFuzzCloudURL(projectName: string) {
64
+ const currentDate = new Date();
65
+ const yesterday = new Date(currentDate);
66
+ yesterday.setDate(yesterday.getDate() - 1);
67
+
68
+ const day = yesterday.getDate();
69
+ const month = yesterday.getMonth();
70
+ const year = yesterday.getFullYear();
71
+
72
+ let urlString =
73
+ 'https://storage.googleapis.com/oss-fuzz-coverage/' +
74
+ projectName +
75
+ '/reports/' +
76
+ year.toString();
77
+
78
+ if (month < 10) {
79
+ urlString += '0';
80
+ }
81
+ urlString += month.toString();
82
+ if (day < 10) {
83
+ urlString += '0';
84
+ }
85
+ urlString += day.toString();
86
+
87
+ return urlString;
88
+ }
89
+
90
+ /**
91
+ * Checks if the current workspace has a generated OSS-Fuzz folder. This is the
92
+ * generated folder from our auto-generation capabilities.
93
+ *
94
+ * @returns boolean
95
+ */
96
+ export async function hasOssFuzzInWorkspace() {
97
+ const workspaceFolder = vscode.workspace.workspaceFolders;
98
+
99
+ if (!workspaceFolder) {
100
+ return false;
101
+ }
102
+
103
+ // Identify if the workspace folder has a OSS-Fuzz set up.
104
+ const wsPath = workspaceFolder[0].uri.fsPath; // gets the path of the first workspace folder
105
+ const ossfuzzDockerFilepath = vscode.Uri.file(wsPath + '/OSS-Fuzz/');
106
+ try {
107
+ if (await vscode.workspace.fs.readDirectory(ossfuzzDockerFilepath)) {
108
+ for (const [name, type] of await vscode.workspace.fs.readDirectory(
109
+ ossfuzzDockerFilepath
110
+ )) {
111
+ // If it's a directory then we know we have the project set up in there.
112
+ if (type === 2) {
113
+ // We assume this is the project folder for now.
114
+ println('Found the relevant directory: ' + name);
115
+ return true;
116
+ }
117
+ }
118
+ }
119
+ } catch {
120
+ /* empty */
121
+ }
122
+ return false;
123
+ }
124
+
125
+ /**
126
+ * Gets the project name of the integrated OSS-Fuzz project.
127
+ * @returns string
128
+ */
129
+ export async function getOssFuzzWorkspaceProjectName() {
130
+ const workspaceFolder = vscode.workspace.workspaceFolders;
131
+ if (!workspaceFolder) {
132
+ return 'N/A';
133
+ }
134
+
135
+ // Identify if the workspace folder has a OSS-Fuzz set up.
136
+ const wsPath = workspaceFolder[0].uri.fsPath; // gets the path of the first workspace folder
137
+ const ossfuzzDockerFilepath = vscode.Uri.file(wsPath + '/OSS-Fuzz/');
138
+ try {
139
+ if (await vscode.workspace.fs.readDirectory(ossfuzzDockerFilepath)) {
140
+ for (const [name, type] of await vscode.workspace.fs.readDirectory(
141
+ ossfuzzDockerFilepath
142
+ )) {
143
+ if (type === 2) {
144
+ // println('Is a directory');
145
+ // We assume this is the project folder for now.
146
+ return name;
147
+ }
148
+ }
149
+ }
150
+ } catch {
151
+ /* empty */
152
+ }
153
+
154
+ return 'N/A';
155
+ }
156
+
157
+ /**
158
+ * Lists the fuzzers available in the OSS-Fuzz build project.
159
+ *
160
+ * @param projectName
161
+ * @param ossFuzzRepositoryPath
162
+ * @returns
163
+ */
164
+ export async function listFuzzersForProject(
165
+ projectName: string,
166
+ ossFuzzRepositoryPath: string
167
+ ) {
168
+ const projectOssFuzzBuildPath = vscode.Uri.file(
169
+ ossFuzzRepositoryPath + '/build/out/' + projectName
170
+ );
171
+ const fuzzersInProject: Array<string> = [];
172
+ for (const [name, type] of await vscode.workspace.fs.readDirectory(
173
+ projectOssFuzzBuildPath
174
+ )) {
175
+ // Is it a file?
176
+ if (type === 1) {
177
+ const filepath =
178
+ ossFuzzRepositoryPath + '/build/out/' + projectName + '/' + name;
179
+ const binary = fs.readFileSync(filepath);
180
+
181
+ // Check if fuzzer entrypoint exists in file. This is similar to how OSS-Fuzz
182
+ // checks whether a file is fuzzer or not.
183
+ if (binary.lastIndexOf('LLVMFuzzerTestOneInput') !== -1) {
184
+ fuzzersInProject.push(name);
185
+ }
186
+ }
187
+ }
188
+ println('Successfully build the project.');
189
+ println('The fuzzers in project');
190
+ for (const fuzzName of fuzzersInProject) {
191
+ println(fuzzName);
192
+ }
193
+ return fuzzersInProject;
194
+ }
195
+
196
+ /**
197
+ * Helper functions for identifying the primary programming language of the workspace.
198
+ *
199
+ * This is achieved by identifying the suffix of files and then sorting
200
+ * based on those with most of a given language supported by OSS-Fuzz.
201
+ *
202
+ * @returns
203
+ */
204
+ export async function determineWorkspaceLanguage() {
205
+ const pythonFiles = await vscode.workspace.findFiles('**/*.py');
206
+ const cppFiles = await vscode.workspace.findFiles('**/*.c++');
207
+ const cfiles = await vscode.workspace.findFiles('**/*.c');
208
+ const rustFiles = await vscode.workspace.findFiles('**/*.rust');
209
+ const golangFiles = await vscode.workspace.findFiles('**/*.go');
210
+
211
+ println('Number of python files: ' + pythonFiles.length);
212
+ println('Number of C++ files: ' + cppFiles.length);
213
+ println('Number of C files: ' + cfiles.length);
214
+ println('Number of rustFiles files: ' + rustFiles.length);
215
+ println('Number of golangFiles files: ' + golangFiles.length);
216
+
217
+ const maxCount = Math.max(
218
+ pythonFiles.length,
219
+ cppFiles.length,
220
+ cfiles.length,
221
+ rustFiles.length,
222
+ golangFiles.length
223
+ );
224
+ let target = '';
225
+ if (maxCount === pythonFiles.length) {
226
+ target = 'python';
227
+ } else if (maxCount === cppFiles.length) {
228
+ target = 'c++';
229
+ } else if (maxCount === cfiles.length) {
230
+ target = 'c';
231
+ } else if (maxCount === rustFiles.length) {
232
+ target = 'rust';
233
+ } else if (maxCount === golangFiles.length) {
234
+ target = 'golang';
235
+ } else {
236
+ target = 'not implemented';
237
+ }
238
+
239
+ println('Target language: ' + target);
240
+ return target;
241
+ }
242
+
243
+ /**
244
+ * Helper method to execute commands on the system.
245
+ */
246
+ export async function systemSync(cmd: string, args: Array<string | undefined>) {
247
+ debugPrintln('Running command');
248
+ debugPrintln(cmd);
249
+ debugPrintln(args.toString());
250
+ debugPrintln('<<<<<<<<<<<<');
251
+
252
+ // Launch the command
253
+ const command = spawn(cmd, args);
254
+
255
+ // Callbacks for output events, to capture stdout and stderr live.
256
+ command.stdout.on('data', (x: {toString: () => string}) => {
257
+ printRaw(x.toString());
258
+ });
259
+ command.stderr.on('data', (x: {toString: () => string}) => {
260
+ printRaw(x.toString());
261
+ });
262
+
263
+ // Monitor for child exit.
264
+ let hasChildExited = 0;
265
+ let childExitCode = 0;
266
+ command.on('exit', (code: any, signal: any) => {
267
+ // println('child process exited with ' + `code ${code} and signal ${signal}`);
268
+ childExitCode = code;
269
+ hasChildExited = 1;
270
+ });
271
+
272
+ // Block until the child process has exited.
273
+ const snooze = (ms: number) =>
274
+ new Promise(resolve => setTimeout(resolve, ms));
275
+
276
+ let idx = 0;
277
+ const maxSeconds = 1800;
278
+ debugPrintln('Child exited: ' + hasChildExited);
279
+
280
+ // I think we can convert the following loop to a Promise wrapping the command
281
+ // exeuction. TODO(David).
282
+ while (hasChildExited === 0 && idx < maxSeconds) {
283
+ idx += 1;
284
+ await snooze(1000);
285
+ }
286
+
287
+ // Command execution is done, return appropriately if success/error.
288
+ if (childExitCode !== 0) {
289
+ println('Command execution errored');
290
+ return [false, command.toString()];
291
+ }
292
+ // println('Succes');
293
+ return [true, command.toString()];
294
+ }
295
+
296
+ export async function systemSyncLogIfFailure(
297
+ cmd: string,
298
+ args: Array<string | undefined>
299
+ ): Promise<boolean> {
300
+ const [res, cmdMsg] = await systemSync(cmd, args);
301
+ if (res === false) {
302
+ println(cmdMsg);
303
+ return false;
304
+ }
305
+ return true;
306
+ }