forked from ethereum/go-ethereum
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tests/fuzzers/abi: add fuzzer for fuzzing package accounts/abi (ether…
…eum#21217) * tests/fuzzers/abi: added abi fuzzer * accounts/abi: fixed issues found by fuzzing * tests/fuzzers/abi: update fuzzers, added repro test * tests/fuzzers/abi: renamed abi_fuzzer to abifuzzer * tests/fuzzers/abi: updated abi fuzzer * tests/fuzzers/abi: updated abi fuzzer * accounts/abi: minor style fix * go.mod: added go-fuzz dependency * tests/fuzzers/abi: updated abi fuzzer * tests/fuzzers/abi: make linter happy * tests/fuzzers/abi: make linter happy * tests/fuzzers/abi: comment out false positives
- Loading branch information
1 parent
93f0470
commit 89884dc
Showing
9 changed files
with
266 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,186 @@ | ||
// Copyright 2020 The go-ethereum Authors | ||
// This file is part of the go-ethereum library. | ||
// | ||
// The go-ethereum library is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU Lesser General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// The go-ethereum library is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU Lesser General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU Lesser General Public License | ||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
package abi | ||
|
||
import ( | ||
"bytes" | ||
"fmt" | ||
"math/rand" | ||
"reflect" | ||
"strings" | ||
|
||
"github.com/ethereum/go-ethereum/accounts/abi" | ||
"github.com/ethereum/go-ethereum/crypto" | ||
fuzz "github.com/google/gofuzz" | ||
) | ||
|
||
func unpackPack(abi abi.ABI, method string, inputType []interface{}, input []byte) bool { | ||
outptr := reflect.New(reflect.TypeOf(inputType)) | ||
if err := abi.Unpack(outptr.Interface(), method, input); err == nil { | ||
output, err := abi.Pack(method, input) | ||
if err != nil { | ||
// We have some false positives as we can unpack these type successfully, but not pack them | ||
if err.Error() == "abi: cannot use []uint8 as type [0]int8 as argument" || | ||
err.Error() == "abi: cannot use uint8 as type int8 as argument" { | ||
return false | ||
} | ||
panic(err) | ||
} | ||
if !bytes.Equal(input, output[4:]) { | ||
panic(fmt.Sprintf("unpackPack is not equal, \ninput : %x\noutput: %x", input, output[4:])) | ||
} | ||
return true | ||
} | ||
return false | ||
} | ||
|
||
func packUnpack(abi abi.ABI, method string, input []interface{}) bool { | ||
if packed, err := abi.Pack(method, input); err == nil { | ||
outptr := reflect.New(reflect.TypeOf(input)) | ||
err := abi.Unpack(outptr.Interface(), method, packed) | ||
if err != nil { | ||
panic(err) | ||
} | ||
out := outptr.Elem().Interface() | ||
if !reflect.DeepEqual(input, out) { | ||
panic(fmt.Sprintf("unpackPack is not equal, \ninput : %x\noutput: %x", input, out)) | ||
} | ||
return true | ||
} | ||
return false | ||
} | ||
|
||
type args struct { | ||
name string | ||
typ string | ||
} | ||
|
||
func createABI(name string, stateMutability, payable *string, inputs []args) (abi.ABI, error) { | ||
sig := fmt.Sprintf(`[{ "type" : "function", "name" : "%v" `, name) | ||
if stateMutability != nil { | ||
sig += fmt.Sprintf(`, "stateMutability": "%v" `, *stateMutability) | ||
} | ||
if payable != nil { | ||
sig += fmt.Sprintf(`, "payable": %v `, *payable) | ||
} | ||
if len(inputs) > 0 { | ||
sig += `, "inputs" : [ {` | ||
for i, inp := range inputs { | ||
sig += fmt.Sprintf(`"name" : "%v", "type" : "%v" `, inp.name, inp.typ) | ||
if i+1 < len(inputs) { | ||
sig += "," | ||
} | ||
} | ||
sig += "} ]" | ||
sig += `, "outputs" : [ {` | ||
for i, inp := range inputs { | ||
sig += fmt.Sprintf(`"name" : "%v", "type" : "%v" `, inp.name, inp.typ) | ||
if i+1 < len(inputs) { | ||
sig += "," | ||
} | ||
} | ||
sig += "} ]" | ||
} | ||
sig += `}]` | ||
|
||
return abi.JSON(strings.NewReader(sig)) | ||
} | ||
|
||
func fillStruct(structs []interface{}, data []byte) { | ||
if structs != nil && len(data) != 0 { | ||
fuzz.NewFromGoFuzz(data).Fuzz(&structs) | ||
} | ||
} | ||
|
||
func createStructs(args []args) []interface{} { | ||
structs := make([]interface{}, len(args)) | ||
for i, arg := range args { | ||
t, err := abi.NewType(arg.typ, "", nil) | ||
if err != nil { | ||
panic(err) | ||
} | ||
structs[i] = reflect.New(t.GetType()).Elem() | ||
} | ||
return structs | ||
} | ||
|
||
func runFuzzer(input []byte) int { | ||
good := false | ||
|
||
names := []string{"_name", "name", "NAME", "name_", "__", "_name_", "n"} | ||
stateMut := []string{"", "pure", "view", "payable"} | ||
stateMutabilites := []*string{nil, &stateMut[0], &stateMut[1], &stateMut[2], &stateMut[3]} | ||
pays := []string{"true", "false"} | ||
payables := []*string{nil, &pays[0], &pays[1]} | ||
varNames := []string{"a", "b", "c", "d", "e", "f", "g"} | ||
varNames = append(varNames, names...) | ||
varTypes := []string{"bool", "address", "bytes", "string", | ||
"uint8", "int8", "uint8", "int8", "uint16", "int16", | ||
"uint24", "int24", "uint32", "int32", "uint40", "int40", "uint48", "int48", "uint56", "int56", | ||
"uint64", "int64", "uint72", "int72", "uint80", "int80", "uint88", "int88", "uint96", "int96", | ||
"uint104", "int104", "uint112", "int112", "uint120", "int120", "uint128", "int128", "uint136", "int136", | ||
"uint144", "int144", "uint152", "int152", "uint160", "int160", "uint168", "int168", "uint176", "int176", | ||
"uint184", "int184", "uint192", "int192", "uint200", "int200", "uint208", "int208", "uint216", "int216", | ||
"uint224", "int224", "uint232", "int232", "uint240", "int240", "uint248", "int248", "uint256", "int256", | ||
"bytes1", "bytes2", "bytes3", "bytes4", "bytes5", "bytes6", "bytes7", "bytes8", "bytes9", "bytes10", "bytes11", | ||
"bytes12", "bytes13", "bytes14", "bytes15", "bytes16", "bytes17", "bytes18", "bytes19", "bytes20", "bytes21", | ||
"bytes22", "bytes23", "bytes24", "bytes25", "bytes26", "bytes27", "bytes28", "bytes29", "bytes30", "bytes31", | ||
"bytes32", "bytes"} | ||
rnd := rand.New(rand.NewSource(123456)) | ||
if len(input) > 0 { | ||
kec := crypto.Keccak256(input) | ||
rnd = rand.New(rand.NewSource(int64(kec[0]))) | ||
} | ||
name := names[rnd.Intn(len(names))] | ||
stateM := stateMutabilites[rnd.Intn(len(stateMutabilites))] | ||
payable := payables[rnd.Intn(len(payables))] | ||
maxLen := 5 | ||
for k := 1; k < maxLen; k++ { | ||
var arg []args | ||
for i := k; i > 0; i-- { | ||
argName := varNames[i] | ||
argTyp := varTypes[rnd.Int31n(int32(len(varTypes)))] | ||
if rnd.Int31n(10) == 0 { | ||
argTyp += "[]" | ||
} else if rnd.Int31n(10) == 0 { | ||
arrayArgs := rnd.Int31n(30) + 1 | ||
argTyp += fmt.Sprintf("[%d]", arrayArgs) | ||
} | ||
arg = append(arg, args{ | ||
name: argName, | ||
typ: argTyp, | ||
}) | ||
} | ||
abi, err := createABI(name, stateM, payable, arg) | ||
if err != nil { | ||
continue | ||
} | ||
structs := createStructs(arg) | ||
b := unpackPack(abi, name, structs, input) | ||
fillStruct(structs, input) | ||
c := packUnpack(abi, name, structs) | ||
good = good || b || c | ||
} | ||
if good { | ||
return 1 | ||
} | ||
return 0 | ||
} | ||
|
||
func Fuzz(input []byte) int { | ||
return runFuzzer(input) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
// Copyright 2020 The go-ethereum Authors | ||
// This file is part of the go-ethereum library. | ||
// | ||
// The go-ethereum library is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU Lesser General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// The go-ethereum library is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU Lesser General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU Lesser General Public License | ||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
package abi | ||
|
||
import ( | ||
"testing" | ||
) | ||
|
||
// TestReplicate can be used to replicate crashers from the fuzzing tests. | ||
// Just replace testString with the data in .quoted | ||
func TestReplicate(t *testing.T) { | ||
testString := "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" + | ||
"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00 \x00\x00\x00\x00\x00\x00\x00\x00" + | ||
"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" + | ||
"\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00000000000" + | ||
"00000000000000000000" + | ||
"00000000000000000000" + | ||
"00000001" | ||
|
||
data := []byte(testString) | ||
runFuzzer(data) | ||
} | ||
|
||
// TestGenerateCorpus can be used to add corpus for the fuzzer. | ||
// Just replace corpusHex with the hexEncoded output you want to add to the fuzzer. | ||
func TestGenerateCorpus(t *testing.T) { | ||
/* | ||
corpusHex := "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" | ||
data := common.FromHex(corpusHex) | ||
checksum := sha1.Sum(data) | ||
outf := fmt.Sprintf("corpus/%x", checksum) | ||
if err := ioutil.WriteFile(outf, data, 0777); err != nil { | ||
panic(err) | ||
} | ||
*/ | ||
} |