Callum Waters
4 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 337 additions and 275 deletions
Split View
Diff Options
-
+0 -1.gitignore
-
+0 -9CONTRIBUTING.md
-
+1 -6test/e2e/Makefile
-
+0 -41test/e2e/app/main.go
-
+0 -2test/e2e/docker/Dockerfile
-
+0 -10test/e2e/docker/entrypoint-maverick
-
+3 -33test/e2e/generator/generate.go
-
+0 -22test/e2e/generator/random.go
-
+4 -10test/e2e/networks/ci.toml
-
+6 -12test/e2e/pkg/manifest.go
-
+10 -47test/e2e/pkg/testnet.go
-
+274 -0test/e2e/runner/evidence.go
-
+27 -8test/e2e/runner/main.go
-
+4 -31test/e2e/runner/setup.go
-
+8 -43test/e2e/tests/evidence_test.go
+ 0
- 1
.gitignore
View File
+ 0
- 9
CONTRIBUTING.md
View File
+ 1
- 6
test/e2e/Makefile
View File
+ 0
- 41
test/e2e/app/main.go
View File
+ 0
- 2
test/e2e/docker/Dockerfile
View File
+ 0
- 10
test/e2e/docker/entrypoint-maverick
View File
| @ -1,10 +0,0 @@ | |||
| #!/usr/bin/env bash | |||
| # Forcibly remove any stray UNIX sockets left behind from previous runs | |||
| rm -rf /var/run/privval.sock /var/run/app.sock | |||
| /usr/bin/app /tendermint/config/app.toml & | |||
| sleep 1 | |||
| /usr/bin/maverick "$@" | |||
+ 3
- 33
test/e2e/generator/generate.go
View File
+ 0
- 22
test/e2e/generator/random.go
View File
+ 4
- 10
test/e2e/networks/ci.toml
View File
+ 6
- 12
test/e2e/pkg/manifest.go
View File
+ 10
- 47
test/e2e/pkg/testnet.go
View File
+ 274
- 0
test/e2e/runner/evidence.go
View File
| @ -0,0 +1,274 @@ | |||
| package main | |||
| import ( | |||
| "bytes" | |||
| "context" | |||
| "fmt" | |||
| "io/ioutil" | |||
| "math/rand" | |||
| "path/filepath" | |||
| "time" | |||
| "github.com/tendermint/tendermint/crypto" | |||
| "github.com/tendermint/tendermint/crypto/tmhash" | |||
| tmjson "github.com/tendermint/tendermint/libs/json" | |||
| "github.com/tendermint/tendermint/privval" | |||
| tmproto "github.com/tendermint/tendermint/proto/tendermint/types" | |||
| e2e "github.com/tendermint/tendermint/test/e2e/pkg" | |||
| "github.com/tendermint/tendermint/types" | |||
| "github.com/tendermint/tendermint/version" | |||
| ) | |||
| // 1 in 11 evidence is light client evidence, the rest is duplicate vote | |||
| // FIXME: Setting to 11 disables light client attack evidence since nodes | |||
| // don't follow a minimum retention height invariant. When we fix this we | |||
| // should use a ratio of 4. | |||
| const lightClientEvidenceRatio = 11 | |||
| // InjectEvidence takes a running testnet and generates an amount of valid | |||
| // evidence and broadcasts it to a random node through the rpc endpoint `/broadcast_evidence`. | |||
| // Evidence is random and can be a mixture of LightClientAttackEvidence and | |||
| // DuplicateVoteEvidence. | |||
| func InjectEvidence(testnet *e2e.Testnet, amount int) error { | |||
| // select a random node | |||
| targetNode := testnet.RandomNode() | |||
| logger.Info(fmt.Sprintf("Injecting evidence through %v (amount: %d)...", targetNode.Name, amount)) | |||
| client, err := targetNode.Client() | |||
| if err != nil { | |||
| return err | |||
| } | |||
| // request the latest block and validator set from the node | |||
| blockRes, err := client.Block(context.Background(), nil) | |||
| if err != nil { | |||
| return err | |||
| } | |||
| lightEvidenceCommonHeight := blockRes.Block.Height | |||
| waitHeight := blockRes.Block.Height + 3 | |||
| duplicateVoteHeight := waitHeight | |||
| nValidators := 100 | |||
| valRes, err := client.Validators(context.Background(), &lightEvidenceCommonHeight, nil, &nValidators) | |||
| if err != nil { | |||
| return err | |||
| } | |||
| valSet, err := types.ValidatorSetFromExistingValidators(valRes.Validators) | |||
| if err != nil { | |||
| return err | |||
| } | |||
| // get the private keys of all the validators in the network | |||
| privVals, err := getPrivateValidatorKeys(testnet) | |||
| if err != nil { | |||
| return err | |||
| } | |||
| // wait for the node to reach the height above the forged height so that | |||
| // it is able to validate the evidence | |||
| status, err := waitForNode(targetNode, waitHeight, 10*time.Second) | |||
| if err != nil { | |||
| return err | |||
| } | |||
| duplicateVoteTime := status.SyncInfo.LatestBlockTime | |||
| var ev types.Evidence | |||
| for i := 0; i < amount; i++ { | |||
| if i%lightClientEvidenceRatio == 0 { | |||
| ev, err = generateLightClientAttackEvidence( | |||
| privVals, lightEvidenceCommonHeight, valSet, testnet.Name, blockRes.Block.Time, | |||
| ) | |||
| } else { | |||
| ev, err = generateDuplicateVoteEvidence( | |||
| privVals, duplicateVoteHeight, valSet, testnet.Name, duplicateVoteTime, | |||
| ) | |||
| } | |||
| if err != nil { | |||
| return err | |||
| } | |||
| _, err := client.BroadcastEvidence(context.Background(), ev) | |||
| if err != nil { | |||
| return err | |||
| } | |||
| } | |||
| logger.Info(fmt.Sprintf("Finished sending evidence (height %d)", blockRes.Block.Height+2)) | |||
| return nil | |||
| } | |||
| func getPrivateValidatorKeys(testnet *e2e.Testnet) ([]types.MockPV, error) { | |||
| privVals := []types.MockPV{} | |||
| for _, node := range testnet.Nodes { | |||
| if node.Mode == e2e.ModeValidator { | |||
| privKeyPath := filepath.Join(testnet.Dir, node.Name, PrivvalKeyFile) | |||
| privKey, err := readPrivKey(privKeyPath) | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| // Create mock private validators from the validators private key. MockPV is | |||
| // stateless which means we can double vote and do other funky stuff | |||
| privVals = append(privVals, types.NewMockPVWithParams(privKey, false, false)) | |||
| } | |||
| } | |||
| return privVals, nil | |||
| } | |||
| // creates evidence of a lunatic attack. The height provided is the common height. | |||
| // The forged height happens 2 blocks later. | |||
| func generateLightClientAttackEvidence( | |||
| privVals []types.MockPV, | |||
| height int64, | |||
| vals *types.ValidatorSet, | |||
| chainID string, | |||
| evTime time.Time, | |||
| ) (*types.LightClientAttackEvidence, error) { | |||
| // forge a random header | |||
| forgedHeight := height + 2 | |||
| forgedTime := evTime.Add(1 * time.Second) | |||
| header := makeHeaderRandom(chainID, forgedHeight) | |||
| header.Time = forgedTime | |||
| // add a new bogus validator and remove an existing one to | |||
| // vary the validator set slightly | |||
| pv, conflictingVals, err := mutateValidatorSet(privVals, vals) | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| header.ValidatorsHash = conflictingVals.Hash() | |||
| // create a commit for the forged header | |||
| blockID := makeBlockID(header.Hash(), 1000, []byte("partshash")) | |||
| voteSet := types.NewVoteSet(chainID, forgedHeight, 0, tmproto.SignedMsgType(2), conflictingVals) | |||
| commit, err := types.MakeCommit(blockID, forgedHeight, 0, voteSet, pv, forgedTime) | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| ev := &types.LightClientAttackEvidence{ | |||
| ConflictingBlock: &types.LightBlock{ | |||
| SignedHeader: &types.SignedHeader{ | |||
| Header: header, | |||
| Commit: commit, | |||
| }, | |||
| ValidatorSet: conflictingVals, | |||
| }, | |||
| CommonHeight: height, | |||
| TotalVotingPower: vals.TotalVotingPower(), | |||
| Timestamp: evTime, | |||
| } | |||
| ev.ByzantineValidators = ev.GetByzantineValidators(vals, &types.SignedHeader{ | |||
| Header: makeHeaderRandom(chainID, forgedHeight), | |||
| }) | |||
| return ev, nil | |||
| } | |||
| // generateDuplicateVoteEvidence picks a random validator from the val set and | |||
| // returns duplicate vote evidence against the validator | |||
| func generateDuplicateVoteEvidence( | |||
| privVals []types.MockPV, | |||
| height int64, | |||
| vals *types.ValidatorSet, | |||
| chainID string, | |||
| time time.Time, | |||
| ) (*types.DuplicateVoteEvidence, error) { | |||
| // nolint:gosec // G404: Use of weak random number generator | |||
| privVal := privVals[rand.Intn(len(privVals))] | |||
| voteA, err := types.MakeVote(height, makeRandomBlockID(), vals, privVal, chainID, time) | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| voteB, err := types.MakeVote(height, makeRandomBlockID(), vals, privVal, chainID, time) | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| return types.NewDuplicateVoteEvidence(voteA, voteB, time, vals), nil | |||
| } | |||
| func readPrivKey(keyFilePath string) (crypto.PrivKey, error) { | |||
| keyJSONBytes, err := ioutil.ReadFile(keyFilePath) | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| pvKey := privval.FilePVKey{} | |||
| err = tmjson.Unmarshal(keyJSONBytes, &pvKey) | |||
| if err != nil { | |||
| return nil, fmt.Errorf("error reading PrivValidator key from %v: %w", keyFilePath, err) | |||
| } | |||
| return pvKey.PrivKey, nil | |||
| } | |||
| func makeHeaderRandom(chainID string, height int64) *types.Header { | |||
| return &types.Header{ | |||
| Version: version.Consensus{Block: version.BlockProtocol, App: 1}, | |||
| ChainID: chainID, | |||
| Height: height, | |||
| Time: time.Now(), | |||
| LastBlockID: makeBlockID([]byte("headerhash"), 1000, []byte("partshash")), | |||
| LastCommitHash: crypto.CRandBytes(tmhash.Size), | |||
| DataHash: crypto.CRandBytes(tmhash.Size), | |||
| ValidatorsHash: crypto.CRandBytes(tmhash.Size), | |||
| NextValidatorsHash: crypto.CRandBytes(tmhash.Size), | |||
| ConsensusHash: crypto.CRandBytes(tmhash.Size), | |||
| AppHash: crypto.CRandBytes(tmhash.Size), | |||
| LastResultsHash: crypto.CRandBytes(tmhash.Size), | |||
| EvidenceHash: crypto.CRandBytes(tmhash.Size), | |||
| ProposerAddress: crypto.CRandBytes(crypto.AddressSize), | |||
| } | |||
| } | |||
| func makeRandomBlockID() types.BlockID { | |||
| return makeBlockID(crypto.CRandBytes(tmhash.Size), 100, crypto.CRandBytes(tmhash.Size)) | |||
| } | |||
| func makeBlockID(hash []byte, partSetSize uint32, partSetHash []byte) types.BlockID { | |||
| var ( | |||
| h = make([]byte, tmhash.Size) | |||
| psH = make([]byte, tmhash.Size) | |||
| ) | |||
| copy(h, hash) | |||
| copy(psH, partSetHash) | |||
| return types.BlockID{ | |||
| Hash: h, | |||
| PartSetHeader: types.PartSetHeader{ | |||
| Total: partSetSize, | |||
| Hash: psH, | |||
| }, | |||
| } | |||
| } | |||
| func mutateValidatorSet(privVals []types.MockPV, vals *types.ValidatorSet, | |||
| ) ([]types.PrivValidator, *types.ValidatorSet, error) { | |||
| newVal, newPrivVal := types.RandValidator(false, 10) | |||
| var newVals *types.ValidatorSet | |||
| if vals.Size() > 2 { | |||
| newVals = types.NewValidatorSet(append(vals.Copy().Validators[:vals.Size()-1], newVal)) | |||
| } else { | |||
| newVals = types.NewValidatorSet(append(vals.Copy().Validators, newVal)) | |||
| } | |||
| // we need to sort the priv validators with the same index as the validator set | |||
| pv := make([]types.PrivValidator, newVals.Size()) | |||
| for idx, val := range newVals.Validators { | |||
| found := false | |||
| for _, p := range append(privVals, newPrivVal.(types.MockPV)) { | |||
| if bytes.Equal(p.PrivKey.PubKey().Address(), val.Address) { | |||
| pv[idx] = p | |||
| found = true | |||
| break | |||
| } | |||
| } | |||
| if !found { | |||
| return nil, nil, fmt.Errorf("missing priv validator for %v", val.Address) | |||
| } | |||
| } | |||
| return pv, newVals, nil | |||
| } | |||
+ 27
- 8
test/e2e/runner/main.go
View File
+ 4
- 31
test/e2e/runner/setup.go
View File
+ 8
- 43
test/e2e/tests/evidence_test.go
View File
| @ -1,57 +1,22 @@ | |||
| package e2e_test | |||
| import ( | |||
| "bytes" | |||
| "testing" | |||
| "github.com/stretchr/testify/require" | |||
| e2e "github.com/tendermint/tendermint/test/e2e/pkg" | |||
| "github.com/tendermint/tendermint/types" | |||
| ) | |||
| // assert that all nodes that have blocks at the height of a misbehavior has evidence | |||
| // for that misbehavior | |||
| func TestEvidence_Misbehavior(t *testing.T) { | |||
| blocks := fetchBlockChain(t) | |||
| testNode(t, func(t *testing.T, node e2e.Node) { | |||
| seenEvidence := make(map[int64]struct{}) | |||
| for _, block := range blocks { | |||
| // Find any evidence blaming this node in this block | |||
| var nodeEvidence types.Evidence | |||
| for _, evidence := range block.Evidence.Evidence { | |||
| switch evidence := evidence.(type) { | |||
| case *types.DuplicateVoteEvidence: | |||
| if bytes.Equal(evidence.VoteA.ValidatorAddress, node.PrivvalKey.PubKey().Address()) { | |||
| nodeEvidence = evidence | |||
| } | |||
| default: | |||
| t.Fatalf("unexpected evidence type %T", evidence) | |||
| } | |||
| } | |||
| if nodeEvidence == nil { | |||
| continue // no evidence for the node at this height | |||
| } | |||
| // Check that evidence was as expected | |||
| misbehavior, ok := node.Misbehaviors[nodeEvidence.Height()] | |||
| require.True(t, ok, "found unexpected evidence %v in height %v", | |||
| nodeEvidence, block.Height) | |||
| switch misbehavior { | |||
| case "double-prevote": | |||
| require.IsType(t, &types.DuplicateVoteEvidence{}, nodeEvidence, "unexpected evidence type") | |||
| default: | |||
| t.Fatalf("unknown misbehavior %v", misbehavior) | |||
| } | |||
| seenEvidence[nodeEvidence.Height()] = struct{}{} | |||
| } | |||
| // see if there is any evidence that we were expecting but didn't see | |||
| for height, misbehavior := range node.Misbehaviors { | |||
| _, ok := seenEvidence[height] | |||
| require.True(t, ok, "expected evidence for %v misbehavior at height %v by node but was never found", | |||
| misbehavior, height) | |||
| testnet := loadTestnet(t) | |||
| seenEvidence := 0 | |||
| for _, block := range blocks { | |||
| if len(block.Evidence.Evidence) != 0 { | |||
| seenEvidence += len(block.Evidence.Evidence) | |||
| } | |||
| }) | |||
| } | |||
| require.Equal(t, testnet.Evidence, seenEvidence, | |||
| "difference between the amount of evidence produced and committed") | |||
| } | |||