123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550 |
- // 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 ethtest
- import (
- "fmt"
- "net"
- "strings"
- "time"
- "github.com/davecgh/go-spew/spew"
- "github.com/ethereum/go-ethereum/core/types"
- "github.com/ethereum/go-ethereum/crypto"
- "github.com/ethereum/go-ethereum/eth/protocols/eth"
- "github.com/ethereum/go-ethereum/internal/utesting"
- "github.com/ethereum/go-ethereum/p2p"
- "github.com/ethereum/go-ethereum/p2p/enode"
- "github.com/ethereum/go-ethereum/p2p/rlpx"
- "github.com/stretchr/testify/assert"
- )
- var pretty = spew.ConfigState{
- Indent: " ",
- DisableCapacities: true,
- DisablePointerAddresses: true,
- SortKeys: true,
- }
- var timeout = 20 * time.Second
- // Suite represents a structure used to test the eth
- // protocol of a node(s).
- type Suite struct {
- Dest *enode.Node
- chain *Chain
- fullChain *Chain
- }
- // NewSuite creates and returns a new eth-test suite that can
- // be used to test the given node against the given blockchain
- // data.
- func NewSuite(dest *enode.Node, chainfile string, genesisfile string) (*Suite, error) {
- chain, err := loadChain(chainfile, genesisfile)
- if err != nil {
- return nil, err
- }
- return &Suite{
- Dest: dest,
- chain: chain.Shorten(1000),
- fullChain: chain,
- }, nil
- }
- func (s *Suite) AllEthTests() []utesting.Test {
- return []utesting.Test{
- // status
- {Name: "TestStatus", Fn: s.TestStatus},
- {Name: "TestStatus_66", Fn: s.TestStatus_66},
- // get block headers
- {Name: "TestGetBlockHeaders", Fn: s.TestGetBlockHeaders},
- {Name: "TestGetBlockHeaders_66", Fn: s.TestGetBlockHeaders_66},
- {Name: "TestSimultaneousRequests_66", Fn: s.TestSimultaneousRequests_66},
- {Name: "TestSameRequestID_66", Fn: s.TestSameRequestID_66},
- {Name: "TestZeroRequestID_66", Fn: s.TestZeroRequestID_66},
- // get block bodies
- {Name: "TestGetBlockBodies", Fn: s.TestGetBlockBodies},
- {Name: "TestGetBlockBodies_66", Fn: s.TestGetBlockBodies_66},
- // broadcast
- {Name: "TestBroadcast", Fn: s.TestBroadcast},
- {Name: "TestBroadcast_66", Fn: s.TestBroadcast_66},
- {Name: "TestLargeAnnounce", Fn: s.TestLargeAnnounce},
- {Name: "TestLargeAnnounce_66", Fn: s.TestLargeAnnounce_66},
- {Name: "TestOldAnnounce", Fn: s.TestOldAnnounce},
- {Name: "TestOldAnnounce_66", Fn: s.TestOldAnnounce_66},
- // malicious handshakes + status
- {Name: "TestMaliciousHandshake", Fn: s.TestMaliciousHandshake},
- {Name: "TestMaliciousStatus", Fn: s.TestMaliciousStatus},
- {Name: "TestMaliciousHandshake_66", Fn: s.TestMaliciousHandshake_66},
- {Name: "TestMaliciousStatus_66", Fn: s.TestMaliciousStatus_66},
- // test transactions
- {Name: "TestTransaction", Fn: s.TestTransaction},
- {Name: "TestTransaction_66", Fn: s.TestTransaction_66},
- {Name: "TestMaliciousTx", Fn: s.TestMaliciousTx},
- {Name: "TestMaliciousTx_66", Fn: s.TestMaliciousTx_66},
- {Name: "TestLargeTxRequest_66", Fn: s.TestLargeTxRequest_66},
- {Name: "TestNewPooledTxs_66", Fn: s.TestNewPooledTxs_66},
- }
- }
- func (s *Suite) EthTests() []utesting.Test {
- return []utesting.Test{
- {Name: "TestStatus", Fn: s.TestStatus},
- {Name: "TestGetBlockHeaders", Fn: s.TestGetBlockHeaders},
- {Name: "TestGetBlockBodies", Fn: s.TestGetBlockBodies},
- {Name: "TestBroadcast", Fn: s.TestBroadcast},
- {Name: "TestLargeAnnounce", Fn: s.TestLargeAnnounce},
- {Name: "TestMaliciousHandshake", Fn: s.TestMaliciousHandshake},
- {Name: "TestMaliciousStatus", Fn: s.TestMaliciousStatus},
- {Name: "TestTransaction", Fn: s.TestTransaction},
- {Name: "TestMaliciousTx", Fn: s.TestMaliciousTx},
- }
- }
- func (s *Suite) Eth66Tests() []utesting.Test {
- return []utesting.Test{
- // only proceed with eth66 test suite if node supports eth 66 protocol
- {Name: "TestStatus_66", Fn: s.TestStatus_66},
- {Name: "TestGetBlockHeaders_66", Fn: s.TestGetBlockHeaders_66},
- {Name: "TestSimultaneousRequests_66", Fn: s.TestSimultaneousRequests_66},
- {Name: "TestSameRequestID_66", Fn: s.TestSameRequestID_66},
- {Name: "TestZeroRequestID_66", Fn: s.TestZeroRequestID_66},
- {Name: "TestGetBlockBodies_66", Fn: s.TestGetBlockBodies_66},
- {Name: "TestBroadcast_66", Fn: s.TestBroadcast_66},
- {Name: "TestLargeAnnounce_66", Fn: s.TestLargeAnnounce_66},
- {Name: "TestMaliciousHandshake_66", Fn: s.TestMaliciousHandshake_66},
- {Name: "TestMaliciousStatus_66", Fn: s.TestMaliciousStatus_66},
- {Name: "TestTransaction_66", Fn: s.TestTransaction_66},
- {Name: "TestMaliciousTx_66", Fn: s.TestMaliciousTx_66},
- {Name: "TestLargeTxRequest_66", Fn: s.TestLargeTxRequest_66},
- {Name: "TestNewPooledTxs_66", Fn: s.TestNewPooledTxs_66},
- }
- }
- // TestStatus attempts to connect to the given node and exchange
- // a status message with it, and then check to make sure
- // the chain head is correct.
- func (s *Suite) TestStatus(t *utesting.T) {
- conn, err := s.dial()
- if err != nil {
- t.Fatalf("could not dial: %v", err)
- }
- defer conn.Close()
- // get protoHandshake
- conn.handshake(t)
- // get status
- switch msg := conn.statusExchange(t, s.chain, nil).(type) {
- case *Status:
- t.Logf("got status message: %s", pretty.Sdump(msg))
- default:
- t.Fatalf("unexpected: %s", pretty.Sdump(msg))
- }
- }
- // TestMaliciousStatus sends a status package with a large total difficulty.
- func (s *Suite) TestMaliciousStatus(t *utesting.T) {
- conn, err := s.dial()
- if err != nil {
- t.Fatalf("could not dial: %v", err)
- }
- defer conn.Close()
- // get protoHandshake
- conn.handshake(t)
- status := &Status{
- ProtocolVersion: uint32(conn.negotiatedProtoVersion),
- NetworkID: s.chain.chainConfig.ChainID.Uint64(),
- TD: largeNumber(2),
- Head: s.chain.blocks[s.chain.Len()-1].Hash(),
- Genesis: s.chain.blocks[0].Hash(),
- ForkID: s.chain.ForkID(),
- }
- // get status
- switch msg := conn.statusExchange(t, s.chain, status).(type) {
- case *Status:
- t.Logf("%+v\n", msg)
- default:
- t.Fatalf("expected status, got: %#v ", msg)
- }
- // wait for disconnect
- switch msg := conn.ReadAndServe(s.chain, timeout).(type) {
- case *Disconnect:
- case *Error:
- return
- default:
- t.Fatalf("expected disconnect, got: %s", pretty.Sdump(msg))
- }
- }
- // TestGetBlockHeaders tests whether the given node can respond to
- // a `GetBlockHeaders` request and that the response is accurate.
- func (s *Suite) TestGetBlockHeaders(t *utesting.T) {
- conn, err := s.dial()
- if err != nil {
- t.Fatalf("could not dial: %v", err)
- }
- defer conn.Close()
- conn.handshake(t)
- conn.statusExchange(t, s.chain, nil)
- // get block headers
- req := &GetBlockHeaders{
- Origin: eth.HashOrNumber{
- Hash: s.chain.blocks[1].Hash(),
- },
- Amount: 2,
- Skip: 1,
- Reverse: false,
- }
- if err := conn.Write(req); err != nil {
- t.Fatalf("could not write to connection: %v", err)
- }
- switch msg := conn.ReadAndServe(s.chain, timeout).(type) {
- case *BlockHeaders:
- headers := *msg
- for _, header := range headers {
- num := header.Number.Uint64()
- t.Logf("received header (%d): %s", num, pretty.Sdump(header.Hash()))
- assert.Equal(t, s.chain.blocks[int(num)].Header(), header)
- }
- default:
- t.Fatalf("unexpected: %s", pretty.Sdump(msg))
- }
- }
- // TestGetBlockBodies tests whether the given node can respond to
- // a `GetBlockBodies` request and that the response is accurate.
- func (s *Suite) TestGetBlockBodies(t *utesting.T) {
- conn, err := s.dial()
- if err != nil {
- t.Fatalf("could not dial: %v", err)
- }
- defer conn.Close()
- conn.handshake(t)
- conn.statusExchange(t, s.chain, nil)
- // create block bodies request
- req := &GetBlockBodies{
- s.chain.blocks[54].Hash(),
- s.chain.blocks[75].Hash(),
- }
- if err := conn.Write(req); err != nil {
- t.Fatalf("could not write to connection: %v", err)
- }
- switch msg := conn.ReadAndServe(s.chain, timeout).(type) {
- case *BlockBodies:
- t.Logf("received %d block bodies", len(*msg))
- default:
- t.Fatalf("unexpected: %s", pretty.Sdump(msg))
- }
- }
- // TestBroadcast tests whether a block announcement is correctly
- // propagated to the given node's peer(s).
- func (s *Suite) TestBroadcast(t *utesting.T) {
- s.sendNextBlock(t)
- }
- func (s *Suite) sendNextBlock(t *utesting.T) {
- sendConn, receiveConn := s.setupConnection(t), s.setupConnection(t)
- defer sendConn.Close()
- defer receiveConn.Close()
- // create new block announcement
- nextBlock := len(s.chain.blocks)
- blockAnnouncement := &NewBlock{
- Block: s.fullChain.blocks[nextBlock],
- TD: s.fullChain.TD(nextBlock + 1),
- }
- // send announcement and wait for node to request the header
- s.testAnnounce(t, sendConn, receiveConn, blockAnnouncement)
- // wait for client to update its chain
- if err := receiveConn.waitForBlock(s.fullChain.blocks[nextBlock]); err != nil {
- t.Fatal(err)
- }
- // update test suite chain
- s.chain.blocks = append(s.chain.blocks, s.fullChain.blocks[nextBlock])
- }
- // TestMaliciousHandshake tries to send malicious data during the handshake.
- func (s *Suite) TestMaliciousHandshake(t *utesting.T) {
- conn, err := s.dial()
- if err != nil {
- t.Fatalf("could not dial: %v", err)
- }
- defer conn.Close()
- // write hello to client
- pub0 := crypto.FromECDSAPub(&conn.ourKey.PublicKey)[1:]
- handshakes := []*Hello{
- {
- Version: 5,
- Caps: []p2p.Cap{
- {Name: largeString(2), Version: 64},
- },
- ID: pub0,
- },
- {
- Version: 5,
- Caps: []p2p.Cap{
- {Name: "eth", Version: 64},
- {Name: "eth", Version: 65},
- },
- ID: append(pub0, byte(0)),
- },
- {
- Version: 5,
- Caps: []p2p.Cap{
- {Name: "eth", Version: 64},
- {Name: "eth", Version: 65},
- },
- ID: append(pub0, pub0...),
- },
- {
- Version: 5,
- Caps: []p2p.Cap{
- {Name: "eth", Version: 64},
- {Name: "eth", Version: 65},
- },
- ID: largeBuffer(2),
- },
- {
- Version: 5,
- Caps: []p2p.Cap{
- {Name: largeString(2), Version: 64},
- },
- ID: largeBuffer(2),
- },
- }
- for i, handshake := range handshakes {
- t.Logf("Testing malicious handshake %v\n", i)
- // Init the handshake
- if err := conn.Write(handshake); err != nil {
- t.Fatalf("could not write to connection: %v", err)
- }
- // check that the peer disconnected
- timeout := 20 * time.Second
- // Discard one hello
- for i := 0; i < 2; i++ {
- switch msg := conn.ReadAndServe(s.chain, timeout).(type) {
- case *Disconnect:
- case *Error:
- case *Hello:
- // Hello's are send concurrently, so ignore them
- continue
- default:
- t.Fatalf("unexpected: %s", pretty.Sdump(msg))
- }
- }
- // Dial for the next round
- conn, err = s.dial()
- if err != nil {
- t.Fatalf("could not dial: %v", err)
- }
- }
- }
- // TestLargeAnnounce tests the announcement mechanism with a large block.
- func (s *Suite) TestLargeAnnounce(t *utesting.T) {
- nextBlock := len(s.chain.blocks)
- blocks := []*NewBlock{
- {
- Block: largeBlock(),
- TD: s.fullChain.TD(nextBlock + 1),
- },
- {
- Block: s.fullChain.blocks[nextBlock],
- TD: largeNumber(2),
- },
- {
- Block: largeBlock(),
- TD: largeNumber(2),
- },
- {
- Block: s.fullChain.blocks[nextBlock],
- TD: s.fullChain.TD(nextBlock + 1),
- },
- }
- for i, blockAnnouncement := range blocks[0:3] {
- t.Logf("Testing malicious announcement: %v\n", i)
- sendConn := s.setupConnection(t)
- if err := sendConn.Write(blockAnnouncement); err != nil {
- t.Fatalf("could not write to connection: %v", err)
- }
- // Invalid announcement, check that peer disconnected
- switch msg := sendConn.ReadAndServe(s.chain, time.Second*8).(type) {
- case *Disconnect:
- case *Error:
- break
- default:
- t.Fatalf("unexpected: %s wanted disconnect", pretty.Sdump(msg))
- }
- sendConn.Close()
- }
- // Test the last block as a valid block
- s.sendNextBlock(t)
- }
- func (s *Suite) TestOldAnnounce(t *utesting.T) {
- sendConn, recvConn := s.setupConnection(t), s.setupConnection(t)
- defer sendConn.Close()
- defer recvConn.Close()
- s.oldAnnounce(t, sendConn, recvConn)
- }
- func (s *Suite) oldAnnounce(t *utesting.T, sendConn, receiveConn *Conn) {
- oldBlockAnnounce := &NewBlock{
- Block: s.chain.blocks[len(s.chain.blocks)/2],
- TD: s.chain.blocks[len(s.chain.blocks)/2].Difficulty(),
- }
- if err := sendConn.Write(oldBlockAnnounce); err != nil {
- t.Fatalf("could not write to connection: %v", err)
- }
- switch msg := receiveConn.ReadAndServe(s.chain, time.Second*8).(type) {
- case *NewBlock:
- block := *msg
- if block.Block.Hash() == oldBlockAnnounce.Block.Hash() {
- t.Fatalf("unexpected: block propagated: %s", pretty.Sdump(msg))
- }
- case *NewBlockHashes:
- hashes := *msg
- for _, hash := range hashes {
- if hash.Hash == oldBlockAnnounce.Block.Hash() {
- t.Fatalf("unexpected: block announced: %s", pretty.Sdump(msg))
- }
- }
- case *Error:
- errMsg := *msg
- // check to make sure error is timeout (propagation didn't come through == test successful)
- if !strings.Contains(errMsg.String(), "timeout") {
- t.Fatalf("unexpected error: %v", pretty.Sdump(msg))
- }
- default:
- t.Fatalf("unexpected: %s", pretty.Sdump(msg))
- }
- }
- func (s *Suite) testAnnounce(t *utesting.T, sendConn, receiveConn *Conn, blockAnnouncement *NewBlock) {
- // Announce the block.
- if err := sendConn.Write(blockAnnouncement); err != nil {
- t.Fatalf("could not write to connection: %v", err)
- }
- s.waitAnnounce(t, receiveConn, blockAnnouncement)
- }
- func (s *Suite) waitAnnounce(t *utesting.T, conn *Conn, blockAnnouncement *NewBlock) {
- switch msg := conn.ReadAndServe(s.chain, timeout).(type) {
- case *NewBlock:
- t.Logf("received NewBlock message: %s", pretty.Sdump(msg.Block))
- assert.Equal(t,
- blockAnnouncement.Block.Header(), msg.Block.Header(),
- "wrong block header in announcement",
- )
- assert.Equal(t,
- blockAnnouncement.TD, msg.TD,
- "wrong TD in announcement",
- )
- case *NewBlockHashes:
- message := *msg
- t.Logf("received NewBlockHashes message: %s", pretty.Sdump(message))
- assert.Equal(t, blockAnnouncement.Block.Hash(), message[0].Hash,
- "wrong block hash in announcement",
- )
- default:
- t.Fatalf("unexpected: %s", pretty.Sdump(msg))
- }
- }
- func (s *Suite) setupConnection(t *utesting.T) *Conn {
- // create conn
- sendConn, err := s.dial()
- if err != nil {
- t.Fatalf("could not dial: %v", err)
- }
- sendConn.handshake(t)
- sendConn.statusExchange(t, s.chain, nil)
- return sendConn
- }
- // dial attempts to dial the given node and perform a handshake,
- // returning the created Conn if successful.
- func (s *Suite) dial() (*Conn, error) {
- var conn Conn
- // dial
- fd, err := net.Dial("tcp", fmt.Sprintf("%v:%d", s.Dest.IP(), s.Dest.TCP()))
- if err != nil {
- return nil, err
- }
- conn.Conn = rlpx.NewConn(fd, s.Dest.Pubkey())
- // do encHandshake
- conn.ourKey, _ = crypto.GenerateKey()
- _, err = conn.Handshake(conn.ourKey)
- if err != nil {
- return nil, err
- }
- // set default p2p capabilities
- conn.caps = []p2p.Cap{
- {Name: "eth", Version: 64},
- {Name: "eth", Version: 65},
- }
- conn.ourHighestProtoVersion = 65
- return &conn, nil
- }
- func (s *Suite) TestTransaction(t *utesting.T) {
- tests := []*types.Transaction{
- getNextTxFromChain(t, s),
- unknownTx(t, s),
- }
- for i, tx := range tests {
- t.Logf("Testing tx propagation: %v\n", i)
- sendSuccessfulTx(t, s, tx)
- }
- }
- func (s *Suite) TestMaliciousTx(t *utesting.T) {
- badTxs := []*types.Transaction{
- getOldTxFromChain(t, s),
- invalidNonceTx(t, s),
- hugeAmount(t, s),
- hugeGasPrice(t, s),
- hugeData(t, s),
- }
- sendConn := s.setupConnection(t)
- defer sendConn.Close()
- // set up receiving connection before sending txs to make sure
- // no announcements are missed
- recvConn := s.setupConnection(t)
- defer recvConn.Close()
- for i, tx := range badTxs {
- t.Logf("Testing malicious tx propagation: %v\n", i)
- if err := sendConn.Write(&Transactions{tx}); err != nil {
- t.Fatalf("could not write to connection: %v", err)
- }
- }
- // check to make sure bad txs aren't propagated
- waitForTxPropagation(t, s, badTxs, recvConn)
- }
|