mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-08 14:21:14 +00:00
f7f034a8be
This PR is related to #3107 and a continuation of #3351
It is important to emphasise that in the privval original design, client/server and listening/dialing roles are inverted and do not follow a conventional interaction.
Given two hosts A and B:
Host A is listener/client
Host B is dialer/server (contains the secret key)
When A requires a signature, it needs to wait for B to dial in before it can issue a request.
A only accepts a single connection and any failure leads to dropping the connection and waiting for B to reconnect.
The original rationale behind this design was based on security.
Host B only allows outbound connections to a list of whitelisted hosts.
It is not possible to reach B unless B dials in. There are no listening/open ports in B.
This PR results in the following changes:
Refactors ping/heartbeat to avoid previously existing race conditions.
Separates transport (dialer/listener) from signing (client/server) concerns to simplify workflow.
Unifies and abstracts away the differences between unix and tcp sockets.
A single signer endpoint implementation unifies connection handling code (read/write/close/connection obj)
The signer request handler (server side) is customizable to increase testability.
Updates and extends unit tests
A high level overview of the classes is as follows:
Transport (endpoints): The following classes take care of establishing a connection
SignerDialerEndpoint
SignerListeningEndpoint
SignerEndpoint groups common functionality (read/write/timeouts/etc.)
Signing (client/server): The following classes take care of exchanging request/responses
SignerClient
SignerServer
This PR also closes #3601
Commits:
* refactoring - work in progress
* reworking unit tests
* Encapsulating and fixing unit tests
* Improve tests
* Clean up
* Fix/improve unit tests
* clean up tests
* Improving service endpoint
* fixing unit test
* fix linter issues
* avoid invalid cache values (improve later?)
* complete implementation
* wip
* improved connection loop
* Improve reconnections + fixing unit tests
* addressing comments
* small formatting changes
* clean up
* Update node/node.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_client.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_client_test.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* check during initialization
* dropping connecting when writing fails
* removing break
* use t.log instead
* unifying and using cmn.GetFreePort()
* review fixes
* reordering and unifying drop connection
* closing instead of signalling
* refactored service loop
* removed superfluous brackets
* GetPubKey can return errors
* Revert "GetPubKey can return errors"
This reverts commit 68c06f19b4.
* adding entry to changelog
* Update CHANGELOG_PENDING.md
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_client.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_dialer_endpoint.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_dialer_endpoint.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_dialer_endpoint.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_dialer_endpoint.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* Update privval/signer_listener_endpoint_test.go
Co-Authored-By: jleni <juan.leni@zondax.ch>
* updating node.go
* review fixes
* fixes linter
* fixing unit test
* small fixes in comments
* addressing review comments
* addressing review comments 2
* reverting suggestion
* Update privval/signer_client_test.go
Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com>
* Update privval/signer_client_test.go
Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com>
* Update privval/signer_listener_endpoint_test.go
Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com>
* do not expose brokenSignerDialerEndpoint
* clean up logging
* unifying methods
shorten test time
signer also drops
* reenabling pings
* improving testability + unit test
* fixing go fmt + unit test
* remove unused code
* Addressing review comments
* simplifying connection workflow
* fix linter/go import issue
* using base service quit
* updating comment
* Simplifying design + adjusting names
* fixing linter issues
* refactoring test harness + fixes
* Addressing review comments
* cleaning up
* adding additional error check
78 lines
2.7 KiB
Go
78 lines
2.7 KiB
Go
package privval_test
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/tendermint/tendermint/privval"
|
|
)
|
|
|
|
const oldPrivvalContent = `{
|
|
"address": "1D8089FAFDFAE4A637F3D616E17B92905FA2D91D",
|
|
"pub_key": {
|
|
"type": "tendermint/PubKeyEd25519",
|
|
"value": "r3Yg2AhDZ745CNTpavsGU+mRZ8WpRXqoJuyqjN8mJq0="
|
|
},
|
|
"last_height": "5",
|
|
"last_round": "0",
|
|
"last_step": 3,
|
|
"last_signature": "CTr7b9ZQlrJJf+12rPl5t/YSCUc/KqV7jQogCfFJA24e7hof69X6OMT7eFLVQHyodPjD/QTA298XHV5ejxInDQ==",
|
|
"last_signbytes": "750802110500000000000000220B08B398F3E00510F48DA6402A480A20FC258973076512999C3E6839A22E9FBDB1B77CF993E8A9955412A41A59D4CAD312240A20C971B286ACB8AAA6FCA0365EB0A660B189EDC08B46B5AF2995DEFA51A28D215B10013211746573742D636861696E2D533245415533",
|
|
"priv_key": {
|
|
"type": "tendermint/PrivKeyEd25519",
|
|
"value": "7MwvTGEWWjsYwjn2IpRb+GYsWi9nnFsw8jPLLY1UtP6vdiDYCENnvjkI1Olq+wZT6ZFnxalFeqgm7KqM3yYmrQ=="
|
|
}
|
|
}`
|
|
|
|
func TestLoadAndUpgrade(t *testing.T) {
|
|
|
|
oldFilePath := initTmpOldFile(t)
|
|
defer os.Remove(oldFilePath)
|
|
newStateFile, err := ioutil.TempFile("", "priv_validator_state*.json")
|
|
defer os.Remove(newStateFile.Name())
|
|
require.NoError(t, err)
|
|
newKeyFile, err := ioutil.TempFile("", "priv_validator_key*.json")
|
|
defer os.Remove(newKeyFile.Name())
|
|
require.NoError(t, err)
|
|
|
|
oldPV, err := privval.LoadOldFilePV(oldFilePath)
|
|
assert.NoError(t, err)
|
|
newPV := oldPV.Upgrade(newKeyFile.Name(), newStateFile.Name())
|
|
|
|
assertEqualPV(t, oldPV, newPV)
|
|
assert.NoError(t, err)
|
|
upgradedPV := privval.LoadFilePV(newKeyFile.Name(), newStateFile.Name())
|
|
assertEqualPV(t, oldPV, upgradedPV)
|
|
oldPV, err = privval.LoadOldFilePV(oldFilePath + ".bak")
|
|
require.NoError(t, err)
|
|
assertEqualPV(t, oldPV, upgradedPV)
|
|
}
|
|
|
|
func assertEqualPV(t *testing.T, oldPV *privval.OldFilePV, newPV *privval.FilePV) {
|
|
assert.Equal(t, oldPV.Address, newPV.Key.Address)
|
|
assert.Equal(t, oldPV.Address, newPV.GetAddress())
|
|
assert.Equal(t, oldPV.PubKey, newPV.Key.PubKey)
|
|
assert.Equal(t, oldPV.PubKey, newPV.GetPubKey())
|
|
assert.Equal(t, oldPV.PrivKey, newPV.Key.PrivKey)
|
|
|
|
assert.Equal(t, oldPV.LastHeight, newPV.LastSignState.Height)
|
|
assert.Equal(t, oldPV.LastRound, newPV.LastSignState.Round)
|
|
assert.Equal(t, oldPV.LastSignature, newPV.LastSignState.Signature)
|
|
assert.Equal(t, oldPV.LastSignBytes, newPV.LastSignState.SignBytes)
|
|
assert.Equal(t, oldPV.LastStep, newPV.LastSignState.Step)
|
|
}
|
|
|
|
func initTmpOldFile(t *testing.T) string {
|
|
tmpFile, err := ioutil.TempFile("", "priv_validator_*.json")
|
|
require.NoError(t, err)
|
|
t.Logf("created test file %s", tmpFile.Name())
|
|
_, err = tmpFile.WriteString(oldPrivvalContent)
|
|
require.NoError(t, err)
|
|
|
|
return tmpFile.Name()
|
|
}
|