mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-07-22 04:36:42 +00:00
chore: document and format oss-fuzz build script
Made the OSS-Fuzz script more readable and added explanations of how it is used
This commit is contained in:
LumenSolutions
GitHub
parent
66134b35df
commit
87cf119285
1 changed files with 85 additions and 79 deletions
128
oss-fuzz.sh
128
oss-fuzz.sh
|
|
@ -13,6 +13,9 @@
|
|||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
# Helper script used by OSS-Fuzz to build fuzzers and coverage wrappers
|
||||
# for various go-ethereum packages.
|
||||
#
|
||||
################################################################################
|
||||
|
||||
# This sets the -coverpgk for the coverage report when the corpus is executed through go test
|
||||
|
|
@ -27,24 +30,25 @@ function coverbuild {
|
|||
if [[ $# -eq 4 ]]; then
|
||||
tags="-tags $4"
|
||||
fi
|
||||
cd $path
|
||||
fuzzed_package=`pwd | rev | cut -d'/' -f 1 | rev`
|
||||
cp $GOPATH/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
|
||||
|
||||
cat << DOG > $OUT/$fuzzer
|
||||
cd "$path"
|
||||
fuzzed_package=$(pwd | rev | cut -d'/' -f 1 | rev)
|
||||
|
||||
cp "$GOPATH/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"
|
||||
|
||||
cat << DOG > "$OUT/$fuzzer"
|
||||
#/bin/sh
|
||||
|
||||
cd $OUT/$path
|
||||
cd "$OUT/$path"
|
||||
go test -run Test${function}Corpus -v $tags -coverprofile \$1 -coverpkg $coverpkg
|
||||
|
||||
DOG
|
||||
|
||||
chmod +x $OUT/$fuzzer
|
||||
chmod +x "$OUT/$fuzzer"
|
||||
# echo "Built script $OUT/$fuzzer"
|
||||
#cat $OUT/$fuzzer
|
||||
# cat "$OUT/$fuzzer"
|
||||
|
||||
cd -
|
||||
}
|
||||
|
||||
|
|
@ -54,178 +58,180 @@ function compile_fuzzer() {
|
|||
fuzzer=$3
|
||||
file=$4
|
||||
|
||||
path=$GOPATH/src/$package
|
||||
|
||||
path="$GOPATH/src/$package"
|
||||
echo "Building $fuzzer"
|
||||
cd $path
|
||||
|
||||
cd "$path"
|
||||
|
||||
# Install build dependencies
|
||||
go mod tidy
|
||||
go get github.com/holiman/gofuzz-shim/testing
|
||||
|
||||
if [[ $SANITIZER == *coverage* ]]; then
|
||||
coverbuild $path $function $fuzzer $coverpkg
|
||||
coverbuild "$path" "$function" "$fuzzer" "$coverpkg"
|
||||
else
|
||||
gofuzz-shim --func $function --package $package -f $file -o $fuzzer.a
|
||||
$CXX $CXXFLAGS $LIB_FUZZING_ENGINE $fuzzer.a -o $OUT/$fuzzer
|
||||
gofuzz-shim --func "$function" --package "$package" -f "$file" -o "$fuzzer.a"
|
||||
$CXX $CXXFLAGS $LIB_FUZZING_ENGINE "$fuzzer.a" -o "$OUT/$fuzzer"
|
||||
fi
|
||||
|
||||
## Check if there exists a seed corpus file
|
||||
corpusfile="${path}/testdata/${fuzzer}_seed_corpus.zip"
|
||||
if [ -f $corpusfile ]
|
||||
then
|
||||
cp $corpusfile $OUT/
|
||||
if [ -f "$corpusfile" ]; then
|
||||
cp "$corpusfile" "$OUT/"
|
||||
echo "Found seed corpus: $corpusfile"
|
||||
fi
|
||||
|
||||
cd -
|
||||
}
|
||||
|
||||
go install github.com/holiman/gofuzz-shim@latest
|
||||
repo=$GOPATH/src/github.com/ethereum/go-ethereum
|
||||
|
||||
repo="$GOPATH/src/github.com/ethereum/go-ethereum"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/accounts/abi \
|
||||
FuzzABI fuzzAbi \
|
||||
$repo/accounts/abi/abifuzzer_test.go
|
||||
"$repo/accounts/abi/abifuzzer_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/common/bitutil \
|
||||
FuzzEncoder fuzzBitutilEncoder \
|
||||
$repo/common/bitutil/compress_test.go
|
||||
"$repo/common/bitutil/compress_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/common/bitutil \
|
||||
FuzzDecoder fuzzBitutilDecoder \
|
||||
$repo/common/bitutil/compress_test.go
|
||||
"$repo/common/bitutil/compress_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/core/vm/runtime \
|
||||
FuzzVmRuntime fuzzVmRuntime \
|
||||
$repo/core/vm/runtime/runtime_fuzz_test.go
|
||||
"$repo/core/vm/runtime/runtime_fuzz_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/core/vm \
|
||||
FuzzPrecompiledContracts fuzzPrecompiledContracts \
|
||||
$repo/core/vm/contracts_fuzz_test.go,$repo/core/vm/contracts_test.go
|
||||
"$repo/core/vm/contracts_fuzz_test.go,$repo/core/vm/contracts_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/core/types \
|
||||
FuzzRLP fuzzRlp \
|
||||
$repo/core/types/rlp_fuzzer_test.go
|
||||
"$repo/core/types/rlp_fuzzer_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/crypto/blake2b \
|
||||
Fuzz fuzzBlake2b \
|
||||
$repo/crypto/blake2b/blake2b_f_fuzz_test.go
|
||||
"$repo/crypto/blake2b/blake2b_f_fuzz_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/accounts/keystore \
|
||||
FuzzPassword fuzzKeystore \
|
||||
$repo/accounts/keystore/keystore_fuzzing_test.go
|
||||
"$repo/accounts/keystore/keystore_fuzzing_test.go"
|
||||
|
||||
pkg="$repo/trie/"
|
||||
|
||||
pkg=$repo/trie/
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/trie \
|
||||
FuzzTrie fuzzTrie \
|
||||
$pkg/trie_test.go,$pkg/database_test.go,$pkg/tracer_test.go,$pkg/proof_test.go,$pkg/iterator_test.go,$pkg/sync_test.go
|
||||
"$pkg/trie_test.go,$pkg/database_test.go,$pkg/tracer_test.go,$pkg/proof_test.go,$pkg/iterator_test.go,$pkg/sync_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/trie \
|
||||
FuzzStackTrie fuzzStackTrie \
|
||||
$pkg/stacktrie_fuzzer_test.go,$pkg/iterator_test.go,$pkg/trie_test.go,$pkg/database_test.go,$pkg/tracer_test.go,$pkg/proof_test.go,$pkg/sync_test.go
|
||||
"$pkg/stacktrie_fuzzer_test.go,$pkg/iterator_test.go,$pkg/trie_test.go,$pkg/database_test.go,$pkg/tracer_test.go,$pkg/proof_test.go,$pkg/sync_test.go"
|
||||
|
||||
# compile_fuzzer tests/fuzzers/snap FuzzARange fuzz_account_range
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/eth/protocols/snap \
|
||||
FuzzARange fuzz_account_range \
|
||||
$repo/eth/protocols/snap/handler_fuzzing_test.go
|
||||
"$repo/eth/protocols/snap/handler_fuzzing_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/eth/protocols/snap \
|
||||
FuzzSRange fuzz_storage_range \
|
||||
$repo/eth/protocols/snap/handler_fuzzing_test.go
|
||||
"$repo/eth/protocols/snap/handler_fuzzing_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/eth/protocols/snap \
|
||||
FuzzByteCodes fuzz_byte_codes \
|
||||
$repo/eth/protocols/snap/handler_fuzzing_test.go
|
||||
"$repo/eth/protocols/snap/handler_fuzzing_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/eth/protocols/snap \
|
||||
FuzzTrieNodes fuzz_trie_nodes \
|
||||
$repo/eth/protocols/snap/handler_fuzzing_test.go
|
||||
"$repo/eth/protocols/snap/handler_fuzzing_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bn256 \
|
||||
FuzzAdd fuzzBn256Add \
|
||||
$repo/tests/fuzzers/bn256/bn256_test.go
|
||||
"$repo/tests/fuzzers/bn256/bn256_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bn256 \
|
||||
FuzzMul fuzzBn256Mul \
|
||||
$repo/tests/fuzzers/bn256/bn256_test.go
|
||||
"$repo/tests/fuzzers/bn256/bn256_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bn256 \
|
||||
FuzzPair fuzzBn256Pair \
|
||||
$repo/tests/fuzzers/bn256/bn256_test.go
|
||||
"$repo/tests/fuzzers/bn256/bn256_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bn256 \
|
||||
FuzzUnmarshalG1 fuzzBn256UnmarshalG1 \
|
||||
$repo/tests/fuzzers/bn256/bn256_test.go
|
||||
"$repo/tests/fuzzers/bn256/bn256_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bn256 \
|
||||
FuzzUnmarshalG2 fuzzBn256UnmarshalG2 \
|
||||
$repo/tests/fuzzers/bn256/bn256_test.go
|
||||
"$repo/tests/fuzzers/bn256/bn256_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/txfetcher \
|
||||
Fuzz fuzzTxfetcher \
|
||||
$repo/tests/fuzzers/txfetcher/txfetcher_test.go
|
||||
"$repo/tests/fuzzers/txfetcher/txfetcher_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzG1Add fuzz_g1_add \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzG1MultiExp fuzz_g1_multiexp \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzG2Add fuzz_g2_add \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzG2MultiExp fuzz_g2_multiexp \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzPairing fuzz_pairing \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzMapG1 fuzz_map_g1 \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzMapG2 fuzz_map_g2 \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzCrossG1Add fuzz_cross_g1_add \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzCrossG1MultiExp fuzz_cross_g1_multiexp \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzCrossG2Add fuzz_cross_g2_add \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzCrossG2MultiExp fuzz_cross_g2_multiexp \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzCrossPairing fuzz_cross_pairing \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzG1SubgroupChecks fuzz_g1_subgroup_checks \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/bls12381 \
|
||||
FuzzG2SubgroupChecks fuzz_g2_subgroup_checks \
|
||||
$repo/tests/fuzzers/bls12381/bls12381_test.go
|
||||
"$repo/tests/fuzzers/bls12381/bls12381_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/tests/fuzzers/secp256k1 \
|
||||
Fuzz fuzzSecp256k1 \
|
||||
$repo/tests/fuzzers/secp256k1/secp_test.go
|
||||
"$repo/tests/fuzzers/secp256k1/secp_test.go"
|
||||
|
||||
compile_fuzzer github.com/ethereum/go-ethereum/eth/protocols/eth \
|
||||
FuzzEthProtocolHandlers fuzz_eth_protocol_handlers \
|
||||
$repo/eth/protocols/eth/handler_test.go,$repo/eth/protocols/eth/peer_test.go
|
||||
|
||||
|
||||
"$repo/eth/protocols/eth/handler_test.go,$repo/eth/protocols/eth/peer_test.go"
|
||||
|
|
|
|||
Loading…
Reference in a new issue