mirror of
https://github.com/fluencelabs/tendermint
synced 2025-04-25 06:42:16 +00:00
a6011c007d
* Close and recreate a RemoteSigner on err * Update changelog * Address Anton's comments / suggestions: - update changelog - restart TCPVal - shut down on `ErrUnexpectedResponse` * re-init remote signer client with fresh connection if Ping fails - add/update TODOs in secret connection - rename tcp.go -> tcp_client.go, same with ipc to clarify their purpose * account for `conn returned by waitConnection can be `nil` - also add TODO about RemoteSigner conn field * Tests for retrying: IPC / TCP - shorter info log on success - set conn and use it in tests to close conn * Tests for retrying: IPC / TCP - shorter info log on success - set conn and use it in tests to close conn - add rwmutex for conn field in IPC * comments and doc.go * fix ipc tests. fixes #2677 * use constants for tests * cleanup some error statements * fixes #2784, race in tests * remove print statement * minor fixes from review * update comment on sts spec * cosmetics * p2p/conn: add failing tests * p2p/conn: make SecretConnection thread safe * changelog * IPCVal signer refactor - use a .reset() method - don't use embedded RemoteSignerClient - guard RemoteSignerClient with mutex - drop the .conn - expose Close() on RemoteSignerClient * apply IPCVal refactor to TCPVal * remove mtx from RemoteSignerClient * consolidate IPCVal and TCPVal, fixes #3104 - done in tcp_client.go - now called SocketVal - takes a listener in the constructor - make tcpListener and unixListener contain all the differences * delete ipc files * introduce unix and tcp dialer for RemoteSigner * rename files - drop tcp_ prefix - rename priv_validator.go to file.go * bring back listener options * fix node * fix priv_val_server * fix node test * minor cleanup and comments
322 lines
10 KiB
Go
322 lines
10 KiB
Go
package privval
|
|
|
|
import (
|
|
"encoding/base64"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/tendermint/tendermint/crypto/ed25519"
|
|
"github.com/tendermint/tendermint/types"
|
|
tmtime "github.com/tendermint/tendermint/types/time"
|
|
)
|
|
|
|
func TestGenLoadValidator(t *testing.T) {
|
|
assert := assert.New(t)
|
|
|
|
tempKeyFile, err := ioutil.TempFile("", "priv_validator_key_")
|
|
require.Nil(t, err)
|
|
tempStateFile, err := ioutil.TempFile("", "priv_validator_state_")
|
|
require.Nil(t, err)
|
|
|
|
privVal := GenFilePV(tempKeyFile.Name(), tempStateFile.Name())
|
|
|
|
height := int64(100)
|
|
privVal.LastSignState.Height = height
|
|
privVal.Save()
|
|
addr := privVal.GetAddress()
|
|
|
|
privVal = LoadFilePV(tempKeyFile.Name(), tempStateFile.Name())
|
|
assert.Equal(addr, privVal.GetAddress(), "expected privval addr to be the same")
|
|
assert.Equal(height, privVal.LastSignState.Height, "expected privval.LastHeight to have been saved")
|
|
}
|
|
|
|
func TestResetValidator(t *testing.T) {
|
|
tempKeyFile, err := ioutil.TempFile("", "priv_validator_key_")
|
|
require.Nil(t, err)
|
|
tempStateFile, err := ioutil.TempFile("", "priv_validator_state_")
|
|
require.Nil(t, err)
|
|
|
|
privVal := GenFilePV(tempKeyFile.Name(), tempStateFile.Name())
|
|
emptyState := FilePVLastSignState{filePath: tempStateFile.Name()}
|
|
|
|
// new priv val has empty state
|
|
assert.Equal(t, privVal.LastSignState, emptyState)
|
|
|
|
// test vote
|
|
height, round := int64(10), 1
|
|
voteType := byte(types.PrevoteType)
|
|
blockID := types.BlockID{[]byte{1, 2, 3}, types.PartSetHeader{}}
|
|
vote := newVote(privVal.Key.Address, 0, height, round, voteType, blockID)
|
|
err = privVal.SignVote("mychainid", vote)
|
|
assert.NoError(t, err, "expected no error signing vote")
|
|
|
|
// priv val after signing is not same as empty
|
|
assert.NotEqual(t, privVal.LastSignState, emptyState)
|
|
|
|
// priv val after reset is same as empty
|
|
privVal.Reset()
|
|
assert.Equal(t, privVal.LastSignState, emptyState)
|
|
}
|
|
|
|
func TestLoadOrGenValidator(t *testing.T) {
|
|
assert := assert.New(t)
|
|
|
|
tempKeyFile, err := ioutil.TempFile("", "priv_validator_key_")
|
|
require.Nil(t, err)
|
|
tempStateFile, err := ioutil.TempFile("", "priv_validator_state_")
|
|
require.Nil(t, err)
|
|
|
|
tempKeyFilePath := tempKeyFile.Name()
|
|
if err := os.Remove(tempKeyFilePath); err != nil {
|
|
t.Error(err)
|
|
}
|
|
tempStateFilePath := tempStateFile.Name()
|
|
if err := os.Remove(tempStateFilePath); err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
privVal := LoadOrGenFilePV(tempKeyFilePath, tempStateFilePath)
|
|
addr := privVal.GetAddress()
|
|
privVal = LoadOrGenFilePV(tempKeyFilePath, tempStateFilePath)
|
|
assert.Equal(addr, privVal.GetAddress(), "expected privval addr to be the same")
|
|
}
|
|
|
|
func TestUnmarshalValidatorState(t *testing.T) {
|
|
assert, require := assert.New(t), require.New(t)
|
|
|
|
// create some fixed values
|
|
serialized := `{
|
|
"height": "1",
|
|
"round": "1",
|
|
"step": 1
|
|
}`
|
|
|
|
val := FilePVLastSignState{}
|
|
err := cdc.UnmarshalJSON([]byte(serialized), &val)
|
|
require.Nil(err, "%+v", err)
|
|
|
|
// make sure the values match
|
|
assert.EqualValues(val.Height, 1)
|
|
assert.EqualValues(val.Round, 1)
|
|
assert.EqualValues(val.Step, 1)
|
|
|
|
// export it and make sure it is the same
|
|
out, err := cdc.MarshalJSON(val)
|
|
require.Nil(err, "%+v", err)
|
|
assert.JSONEq(serialized, string(out))
|
|
}
|
|
|
|
func TestUnmarshalValidatorKey(t *testing.T) {
|
|
assert, require := assert.New(t), require.New(t)
|
|
|
|
// create some fixed values
|
|
privKey := ed25519.GenPrivKey()
|
|
pubKey := privKey.PubKey()
|
|
addr := pubKey.Address()
|
|
pubArray := [32]byte(pubKey.(ed25519.PubKeyEd25519))
|
|
pubBytes := pubArray[:]
|
|
privArray := [64]byte(privKey)
|
|
privBytes := privArray[:]
|
|
pubB64 := base64.StdEncoding.EncodeToString(pubBytes)
|
|
privB64 := base64.StdEncoding.EncodeToString(privBytes)
|
|
|
|
serialized := fmt.Sprintf(`{
|
|
"address": "%s",
|
|
"pub_key": {
|
|
"type": "tendermint/PubKeyEd25519",
|
|
"value": "%s"
|
|
},
|
|
"priv_key": {
|
|
"type": "tendermint/PrivKeyEd25519",
|
|
"value": "%s"
|
|
}
|
|
}`, addr, pubB64, privB64)
|
|
|
|
val := FilePVKey{}
|
|
err := cdc.UnmarshalJSON([]byte(serialized), &val)
|
|
require.Nil(err, "%+v", err)
|
|
|
|
// make sure the values match
|
|
assert.EqualValues(addr, val.Address)
|
|
assert.EqualValues(pubKey, val.PubKey)
|
|
assert.EqualValues(privKey, val.PrivKey)
|
|
|
|
// export it and make sure it is the same
|
|
out, err := cdc.MarshalJSON(val)
|
|
require.Nil(err, "%+v", err)
|
|
assert.JSONEq(serialized, string(out))
|
|
}
|
|
|
|
func TestSignVote(t *testing.T) {
|
|
assert := assert.New(t)
|
|
|
|
tempKeyFile, err := ioutil.TempFile("", "priv_validator_key_")
|
|
require.Nil(t, err)
|
|
tempStateFile, err := ioutil.TempFile("", "priv_validator_state_")
|
|
require.Nil(t, err)
|
|
|
|
privVal := GenFilePV(tempKeyFile.Name(), tempStateFile.Name())
|
|
|
|
block1 := types.BlockID{[]byte{1, 2, 3}, types.PartSetHeader{}}
|
|
block2 := types.BlockID{[]byte{3, 2, 1}, types.PartSetHeader{}}
|
|
height, round := int64(10), 1
|
|
voteType := byte(types.PrevoteType)
|
|
|
|
// sign a vote for first time
|
|
vote := newVote(privVal.Key.Address, 0, height, round, voteType, block1)
|
|
err = privVal.SignVote("mychainid", vote)
|
|
assert.NoError(err, "expected no error signing vote")
|
|
|
|
// try to sign the same vote again; should be fine
|
|
err = privVal.SignVote("mychainid", vote)
|
|
assert.NoError(err, "expected no error on signing same vote")
|
|
|
|
// now try some bad votes
|
|
cases := []*types.Vote{
|
|
newVote(privVal.Key.Address, 0, height, round-1, voteType, block1), // round regression
|
|
newVote(privVal.Key.Address, 0, height-1, round, voteType, block1), // height regression
|
|
newVote(privVal.Key.Address, 0, height-2, round+4, voteType, block1), // height regression and different round
|
|
newVote(privVal.Key.Address, 0, height, round, voteType, block2), // different block
|
|
}
|
|
|
|
for _, c := range cases {
|
|
err = privVal.SignVote("mychainid", c)
|
|
assert.Error(err, "expected error on signing conflicting vote")
|
|
}
|
|
|
|
// try signing a vote with a different time stamp
|
|
sig := vote.Signature
|
|
vote.Timestamp = vote.Timestamp.Add(time.Duration(1000))
|
|
err = privVal.SignVote("mychainid", vote)
|
|
assert.NoError(err)
|
|
assert.Equal(sig, vote.Signature)
|
|
}
|
|
|
|
func TestSignProposal(t *testing.T) {
|
|
assert := assert.New(t)
|
|
|
|
tempKeyFile, err := ioutil.TempFile("", "priv_validator_key_")
|
|
require.Nil(t, err)
|
|
tempStateFile, err := ioutil.TempFile("", "priv_validator_state_")
|
|
require.Nil(t, err)
|
|
|
|
privVal := GenFilePV(tempKeyFile.Name(), tempStateFile.Name())
|
|
|
|
block1 := types.BlockID{[]byte{1, 2, 3}, types.PartSetHeader{5, []byte{1, 2, 3}}}
|
|
block2 := types.BlockID{[]byte{3, 2, 1}, types.PartSetHeader{10, []byte{3, 2, 1}}}
|
|
height, round := int64(10), 1
|
|
|
|
// sign a proposal for first time
|
|
proposal := newProposal(height, round, block1)
|
|
err = privVal.SignProposal("mychainid", proposal)
|
|
assert.NoError(err, "expected no error signing proposal")
|
|
|
|
// try to sign the same proposal again; should be fine
|
|
err = privVal.SignProposal("mychainid", proposal)
|
|
assert.NoError(err, "expected no error on signing same proposal")
|
|
|
|
// now try some bad Proposals
|
|
cases := []*types.Proposal{
|
|
newProposal(height, round-1, block1), // round regression
|
|
newProposal(height-1, round, block1), // height regression
|
|
newProposal(height-2, round+4, block1), // height regression and different round
|
|
newProposal(height, round, block2), // different block
|
|
}
|
|
|
|
for _, c := range cases {
|
|
err = privVal.SignProposal("mychainid", c)
|
|
assert.Error(err, "expected error on signing conflicting proposal")
|
|
}
|
|
|
|
// try signing a proposal with a different time stamp
|
|
sig := proposal.Signature
|
|
proposal.Timestamp = proposal.Timestamp.Add(time.Duration(1000))
|
|
err = privVal.SignProposal("mychainid", proposal)
|
|
assert.NoError(err)
|
|
assert.Equal(sig, proposal.Signature)
|
|
}
|
|
|
|
func TestDifferByTimestamp(t *testing.T) {
|
|
tempKeyFile, err := ioutil.TempFile("", "priv_validator_key_")
|
|
require.Nil(t, err)
|
|
tempStateFile, err := ioutil.TempFile("", "priv_validator_state_")
|
|
require.Nil(t, err)
|
|
|
|
privVal := GenFilePV(tempKeyFile.Name(), tempStateFile.Name())
|
|
|
|
block1 := types.BlockID{[]byte{1, 2, 3}, types.PartSetHeader{5, []byte{1, 2, 3}}}
|
|
height, round := int64(10), 1
|
|
chainID := "mychainid"
|
|
|
|
// test proposal
|
|
{
|
|
proposal := newProposal(height, round, block1)
|
|
err := privVal.SignProposal(chainID, proposal)
|
|
assert.NoError(t, err, "expected no error signing proposal")
|
|
signBytes := proposal.SignBytes(chainID)
|
|
sig := proposal.Signature
|
|
timeStamp := proposal.Timestamp
|
|
|
|
// manipulate the timestamp. should get changed back
|
|
proposal.Timestamp = proposal.Timestamp.Add(time.Millisecond)
|
|
var emptySig []byte
|
|
proposal.Signature = emptySig
|
|
err = privVal.SignProposal("mychainid", proposal)
|
|
assert.NoError(t, err, "expected no error on signing same proposal")
|
|
|
|
assert.Equal(t, timeStamp, proposal.Timestamp)
|
|
assert.Equal(t, signBytes, proposal.SignBytes(chainID))
|
|
assert.Equal(t, sig, proposal.Signature)
|
|
}
|
|
|
|
// test vote
|
|
{
|
|
voteType := byte(types.PrevoteType)
|
|
blockID := types.BlockID{[]byte{1, 2, 3}, types.PartSetHeader{}}
|
|
vote := newVote(privVal.Key.Address, 0, height, round, voteType, blockID)
|
|
err := privVal.SignVote("mychainid", vote)
|
|
assert.NoError(t, err, "expected no error signing vote")
|
|
|
|
signBytes := vote.SignBytes(chainID)
|
|
sig := vote.Signature
|
|
timeStamp := vote.Timestamp
|
|
|
|
// manipulate the timestamp. should get changed back
|
|
vote.Timestamp = vote.Timestamp.Add(time.Millisecond)
|
|
var emptySig []byte
|
|
vote.Signature = emptySig
|
|
err = privVal.SignVote("mychainid", vote)
|
|
assert.NoError(t, err, "expected no error on signing same vote")
|
|
|
|
assert.Equal(t, timeStamp, vote.Timestamp)
|
|
assert.Equal(t, signBytes, vote.SignBytes(chainID))
|
|
assert.Equal(t, sig, vote.Signature)
|
|
}
|
|
}
|
|
|
|
func newVote(addr types.Address, idx int, height int64, round int, typ byte, blockID types.BlockID) *types.Vote {
|
|
return &types.Vote{
|
|
ValidatorAddress: addr,
|
|
ValidatorIndex: idx,
|
|
Height: height,
|
|
Round: round,
|
|
Type: types.SignedMsgType(typ),
|
|
Timestamp: tmtime.Now(),
|
|
BlockID: blockID,
|
|
}
|
|
}
|
|
|
|
func newProposal(height int64, round int, blockID types.BlockID) *types.Proposal {
|
|
return &types.Proposal{
|
|
Height: height,
|
|
Round: round,
|
|
BlockID: blockID,
|
|
Timestamp: tmtime.Now(),
|
|
}
|
|
}
|