From 2b7f1ea986be34435bfc8f6eb3b8b5290ae9457e Mon Sep 17 00:00:00 2001 From: Paulo Gomes Date: Mon, 22 Aug 2022 16:38:46 +0100 Subject: [PATCH] fuzz: Temporary fix to oss-fuzz func Signed-off-by: Paulo Gomes --- tests/fuzz/Dockerfile.builder | 5 ++ tests/fuzz/compile_native_go_fuzzer.sh | 102 +++++++++++++++++++++++++ 2 files changed, 107 insertions(+) create mode 100755 tests/fuzz/compile_native_go_fuzzer.sh diff --git a/tests/fuzz/Dockerfile.builder b/tests/fuzz/Dockerfile.builder index 617c6cfd..10296a5c 100644 --- a/tests/fuzz/Dockerfile.builder +++ b/tests/fuzz/Dockerfile.builder @@ -8,4 +8,9 @@ COPY --from=go /usr/local/go /usr/local/ COPY ./ $GOPATH/src/github.com/fluxcd/helm-controller/ COPY ./tests/fuzz/oss_fuzz_build.sh $SRC/build.sh +# Temporarily overrides compile_native_go_fuzzer. +# Pending upstream merge: https://github.com/google/oss-fuzz/pull/8285 +COPY tests/fuzz/compile_native_go_fuzzer.sh /usr/local/bin/compile_native_go_fuzzer +RUN go install golang.org/x/tools/cmd/goimports@latest + WORKDIR $SRC diff --git a/tests/fuzz/compile_native_go_fuzzer.sh b/tests/fuzz/compile_native_go_fuzzer.sh new file mode 100755 index 00000000..8983d9df --- /dev/null +++ b/tests/fuzz/compile_native_go_fuzzer.sh @@ -0,0 +1,102 @@ +#!/bin/bash -eu +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +################################################################################ + +# Rewrites a copy of the fuzzer to allow for +# libFuzzer instrumentation. +function rewrite_go_fuzz_harness() { + fuzzer_filename=$1 + fuzz_function=$2 + + # Create a copy of the fuzzer to not modify the existing fuzzer. + cp $fuzzer_filename "${fuzzer_filename}"_fuzz_.go + mv $fuzzer_filename /tmp/ + fuzzer_fn="${fuzzer_filename}"_fuzz_.go + + # Remove the body of go testing funcs that may be co-located. + echo "removing *testing.T" + sed -i -e '/testing.T) {$/ {:r;/\n}/!{N;br}; s/\n.*\n/\n/}' "${fuzzer_fn}" + # After removing the body of the go testing funcs, consolidate the imports. + if command -v goimports; then + goimports -w "${fuzzer_fn}" + fi + + # Replace *testing.F with *go118fuzzbuildutils.F. + echo "replacing *testing.F" + sed -i "s/func $fuzz_function(\([a-zA-Z0-9]*\) \*testing\.F)/func $fuzz_function(\1 \*go118fuzzbuildutils\.F)/g" "${fuzzer_fn}" + + # Import https://github.com/AdamKorcz/go-118-fuzz-build. + # This changes the line numbers from the original fuzzer. + addimport -path "${fuzzer_fn}" +} + +function build_native_go_fuzzer() { + fuzzer=$1 + function=$2 + path=$3 + tags="-tags gofuzz" + + if [[ $SANITIZER = *coverage* ]]; then + echo "here we perform coverage build" + fuzzed_package=`go list $tags -f '{{.Name}}' $path` + abspath=`go list $tags -f {{.Dir}} $path` + cd $abspath + cp $GOPATH/native_ossfuzz_coverage_runner.go ./"${function,,}"_test.go + sed -i -e 's/FuzzFunction/'$function'/' ./"${function,,}"_test.go + sed -i -e 's/mypackagebeingfuzzed/'$fuzzed_package'/' ./"${function,,}"_test.go + sed -i -e 's/TestFuzzCorpus/Test'$function'Corpus/' ./"${function,,}"_test.go + + # The repo is the module path/name, which is already created above + # in case it doesn't exist, but not always the same as the module + # path. This is necessary to handle SIV properly. + fuzzed_repo=$(go list $tags -f {{.Module}} "$path") + abspath_repo=`go list -m $tags -f {{.Dir}} $fuzzed_repo || go list $tags -f {{.Dir}} $fuzzed_repo` + # give equivalence to absolute paths in another file, as go test -cover uses golangish pkg.Dir + echo "s=$fuzzed_repo"="$abspath_repo"= > $OUT/$fuzzer.gocovpath + gotip test -run Test${function}Corpus -v $tags -coverpkg $fuzzed_repo/... -c -o $OUT/$fuzzer $path + + rm ./"${function,,}"_test.go + else + go-118-fuzz-build -o $fuzzer.a -func $function $abs_file_dir + $CXX $CXXFLAGS $LIB_FUZZING_ENGINE $fuzzer.a -o $OUT/$fuzzer + fi +} + + +path=$1 +function=$2 +fuzzer=$3 +tags="-tags gofuzz" + +# Get absolute path. +abs_file_dir=$(go list $tags -f {{.Dir}} $path) + +# TODO(adamkorcz): Get rid of "-r" flag here. +fuzzer_filename=$(grep -r -l --include='**.go' -s "$function" "${abs_file_dir}") + +# Test if file contains a line with "func $function" and "testing.F". +if [ $(grep -r "func $function" $fuzzer_filename | grep "testing.F" | wc -l) -eq 1 ] +then + + rewrite_go_fuzz_harness $fuzzer_filename $function + build_native_go_fuzzer $fuzzer $function $abs_file_dir + + # Clean up. + rm "${fuzzer_filename}_fuzz_.go" + mv /tmp/$(basename $fuzzer_filename) $fuzzer_filename +else + echo "Could not find the function: func ${function}(f *testing.F)" +fi