prysm-pulse/validator/rpc/wallet_test.go
Michael Neuder 8b2b109939
Rename imported keymanager to local. (#10155)
* imported -> local

* reverting to the state of the PR at eb1e3c3d1

* use changes from develop

* del

* rem patch

* patch

* rename to local

* gazelle

* add back build

* imported rename

* gaz

* local

* merge fix + remove proto changes

* comment revert

* build

* gofmt and one new reference

* gofmt pt2

* Update validator/accounts/wallet_edit.go

Co-authored-by: Preston Van Loon <preston@prysmaticlabs.com>

* Update validator/rpc/accounts.go

* rename

* gaz

Co-authored-by: Raul Jordan <raul@prysmaticlabs.com>
Co-authored-by: Preston Van Loon <preston@prysmaticlabs.com>
Co-authored-by: james-prysm <90280386+james-prysm@users.noreply.github.com>
2022-02-01 19:54:19 +00:00

558 lines
18 KiB
Go

package rpc
import (
"context"
"encoding/json"
"fmt"
"os"
"path/filepath"
"testing"
"github.com/golang/protobuf/ptypes/empty"
"github.com/google/uuid"
"github.com/prysmaticlabs/prysm/async/event"
"github.com/prysmaticlabs/prysm/config/features"
"github.com/prysmaticlabs/prysm/crypto/bls"
"github.com/prysmaticlabs/prysm/crypto/rand"
"github.com/prysmaticlabs/prysm/io/file"
pb "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1/validator-client"
"github.com/prysmaticlabs/prysm/testing/assert"
"github.com/prysmaticlabs/prysm/testing/require"
"github.com/prysmaticlabs/prysm/validator/accounts"
"github.com/prysmaticlabs/prysm/validator/accounts/iface"
mock "github.com/prysmaticlabs/prysm/validator/accounts/testing"
"github.com/prysmaticlabs/prysm/validator/accounts/wallet"
"github.com/prysmaticlabs/prysm/validator/client"
"github.com/prysmaticlabs/prysm/validator/keymanager"
"github.com/prysmaticlabs/prysm/validator/keymanager/local"
"github.com/tyler-smith/go-bip39"
keystorev4 "github.com/wealdtech/go-eth2-wallet-encryptor-keystorev4"
)
const strongPass = "29384283xasjasd32%%&*@*#*"
func TestServer_CreateWallet_Local(t *testing.T) {
ctx := context.Background()
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
w, err := accounts.CreateWalletWithKeymanager(ctx, &accounts.CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: defaultWalletPath,
KeymanagerKind: keymanager.Derived,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx, iface.InitKeymanagerConfig{ListenForChanges: false})
require.NoError(t, err)
vs, err := client.NewValidatorService(ctx, &client.Config{
Wallet: w,
Validator: &mock.MockValidator{
Km: km,
},
})
require.NoError(t, err)
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: defaultWalletPath,
validatorService: vs,
}
req := &pb.CreateWalletRequest{
Keymanager: pb.KeymanagerKind_IMPORTED,
WalletPassword: strongPass,
}
// We delete the directory at defaultWalletPath as CreateWallet will return an error if it tries to create a wallet
// where a directory already exists
require.NoError(t, os.RemoveAll(defaultWalletPath))
_, err = s.CreateWallet(ctx, req)
require.NoError(t, err)
importReq := &pb.ImportAccountsRequest{
KeystoresPassword: strongPass,
KeystoresImported: []string{"badjson"},
}
_, err = s.ImportAccounts(ctx, importReq)
require.ErrorContains(t, "Not a valid EIP-2335 keystore", err)
encryptor := keystorev4.New()
keystores := make([]string, 3)
for i := 0; i < len(keystores); i++ {
privKey, err := bls.RandKey()
require.NoError(t, err)
pubKey := fmt.Sprintf("%x", privKey.PublicKey().Marshal())
id, err := uuid.NewRandom()
require.NoError(t, err)
cryptoFields, err := encryptor.Encrypt(privKey.Marshal(), strongPass)
require.NoError(t, err)
item := &keymanager.Keystore{
Crypto: cryptoFields,
ID: id.String(),
Version: encryptor.Version(),
Pubkey: pubKey,
Name: encryptor.Name(),
}
encodedFile, err := json.MarshalIndent(item, "", "\t")
require.NoError(t, err)
keystores[i] = string(encodedFile)
}
importReq.KeystoresImported = keystores
_, err = s.ImportAccounts(ctx, importReq)
require.NoError(t, err)
}
func TestServer_CreateWallet_Local_PasswordTooWeak(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: defaultWalletPath,
}
req := &pb.CreateWalletRequest{
Keymanager: pb.KeymanagerKind_IMPORTED,
WalletPassword: "", // Weak password, empty string
}
// We delete the directory at defaultWalletPath as CreateWallet will return an error if it tries to create a wallet
// where a directory already exists
require.NoError(t, os.RemoveAll(defaultWalletPath))
_, err := s.CreateWallet(ctx, req)
require.ErrorContains(t, "Password too weak", err)
req = &pb.CreateWalletRequest{
Keymanager: pb.KeymanagerKind_IMPORTED,
WalletPassword: "a", // Weak password, too short
}
_, err = s.CreateWallet(ctx, req)
require.ErrorContains(t, "Password too weak", err)
}
func TestServer_RecoverWallet_Derived(t *testing.T) {
localWalletDir := setupWalletDir(t)
ctx := context.Background()
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: localWalletDir,
}
req := &pb.RecoverWalletRequest{
WalletPassword: strongPass,
NumAccounts: 0,
}
// We delete the directory at defaultWalletPath as RecoverWallet will return an error if it tries to create a wallet
// where a directory already exists
require.NoError(t, os.RemoveAll(localWalletDir))
_, err := s.RecoverWallet(ctx, req)
require.ErrorContains(t, "Must create at least 1 validator account", err)
req.NumAccounts = 2
req.Language = "Swahili"
_, err = s.RecoverWallet(ctx, req)
require.ErrorContains(t, "input not in the list of supported languages", err)
req.Language = "ENglish"
_, err = s.RecoverWallet(ctx, req)
require.ErrorContains(t, "invalid mnemonic in request", err)
mnemonicRandomness := make([]byte, 32)
_, err = rand.NewGenerator().Read(mnemonicRandomness)
require.NoError(t, err)
mnemonic, err := bip39.NewMnemonic(mnemonicRandomness)
require.NoError(t, err)
req.Mnemonic = mnemonic
req.Mnemonic25ThWord = " "
_, err = s.RecoverWallet(ctx, req)
require.ErrorContains(t, "mnemonic 25th word cannot be empty", err)
req.Mnemonic25ThWord = "outer"
// Test weak password.
req.WalletPassword = "123qwe"
_, err = s.RecoverWallet(ctx, req)
require.ErrorContains(t, "password did not pass validation", err)
req.WalletPassword = strongPass
// Create(derived) should fail then test recover.
reqCreate := &pb.CreateWalletRequest{
Keymanager: pb.KeymanagerKind_DERIVED,
WalletPassword: strongPass,
NumAccounts: 2,
Mnemonic: mnemonic,
}
_, err = s.CreateWallet(ctx, reqCreate)
require.ErrorContains(t, "create wallet not supported through web", err, "Create wallet for DERIVED or REMOTE types not supported through web, either import keystore or recover")
// This defer will be the last to execute in this func.
resetCfgFalse := features.InitWithReset(&features.Flags{
WriteWalletPasswordOnWebOnboarding: false,
})
defer resetCfgFalse()
resetCfgTrue := features.InitWithReset(&features.Flags{
WriteWalletPasswordOnWebOnboarding: true,
})
defer resetCfgTrue()
// Finally test recover.
_, err = s.RecoverWallet(ctx, req)
require.NoError(t, err)
// Password File should have been written.
passwordFilePath := filepath.Join(localWalletDir, wallet.DefaultWalletPasswordFile)
assert.Equal(t, true, file.FileExists(passwordFilePath))
// Attempting to write again should trigger an error.
err = writeWalletPasswordToDisk(localWalletDir, "somepassword")
require.ErrorContains(t, "cannot write wallet password file as it already exists", err)
}
func TestServer_ValidateKeystores_FailedPreconditions(t *testing.T) {
ctx := context.Background()
strongPass := "29384283xasjasd32%%&*@*#*"
ss := &Server{}
_, err := ss.ValidateKeystores(ctx, &pb.ValidateKeystoresRequest{})
assert.ErrorContains(t, "Password required for keystores", err)
_, err = ss.ValidateKeystores(ctx, &pb.ValidateKeystoresRequest{
KeystoresPassword: strongPass,
})
assert.ErrorContains(t, "No keystores included in request", err)
_, err = ss.ValidateKeystores(ctx, &pb.ValidateKeystoresRequest{
KeystoresPassword: strongPass,
Keystores: []string{"badjson"},
})
assert.ErrorContains(t, "Not a valid EIP-2335 keystore", err)
}
func TestServer_ValidateKeystores_OK(t *testing.T) {
ctx := context.Background()
strongPass := "29384283xasjasd32%%&*@*#*"
ss := &Server{}
// Create 3 keystores with the strong password.
encryptor := keystorev4.New()
keystores := make([]string, 3)
pubKeys := make([][]byte, 3)
for i := 0; i < len(keystores); i++ {
privKey, err := bls.RandKey()
require.NoError(t, err)
pubKey := fmt.Sprintf("%x", privKey.PublicKey().Marshal())
id, err := uuid.NewRandom()
require.NoError(t, err)
cryptoFields, err := encryptor.Encrypt(privKey.Marshal(), strongPass)
require.NoError(t, err)
item := &keymanager.Keystore{
Crypto: cryptoFields,
ID: id.String(),
Version: encryptor.Version(),
Pubkey: pubKey,
Name: encryptor.Name(),
}
encodedFile, err := json.MarshalIndent(item, "", "\t")
require.NoError(t, err)
keystores[i] = string(encodedFile)
pubKeys[i] = privKey.PublicKey().Marshal()
}
// Validate the keystores and ensure no error.
_, err := ss.ValidateKeystores(ctx, &pb.ValidateKeystoresRequest{
KeystoresPassword: strongPass,
Keystores: keystores,
})
require.NoError(t, err)
// Check that using a different password will return an error.
_, err = ss.ValidateKeystores(ctx, &pb.ValidateKeystoresRequest{
KeystoresPassword: "badpassword",
Keystores: keystores,
})
require.ErrorContains(t, "is incorrect", err)
// Add a new keystore that was encrypted with a different password and expect
// a failure from the function.
differentPassword := "differentkeystorepass"
privKey, err := bls.RandKey()
require.NoError(t, err)
pubKey := "somepubkey"
id, err := uuid.NewRandom()
require.NoError(t, err)
cryptoFields, err := encryptor.Encrypt(privKey.Marshal(), differentPassword)
require.NoError(t, err)
item := &keymanager.Keystore{
Crypto: cryptoFields,
ID: id.String(),
Version: encryptor.Version(),
Pubkey: pubKey,
Name: encryptor.Name(),
}
encodedFile, err := json.MarshalIndent(item, "", "\t")
keystores = append(keystores, string(encodedFile))
require.NoError(t, err)
_, err = ss.ValidateKeystores(ctx, &pb.ValidateKeystoresRequest{
KeystoresPassword: strongPass,
Keystores: keystores,
})
require.ErrorContains(t, "Password for keystore with public key somepubkey is incorrect", err)
}
func TestServer_WalletConfig_NoWalletFound(t *testing.T) {
s := &Server{}
resp, err := s.WalletConfig(context.Background(), &empty.Empty{})
require.NoError(t, err)
assert.DeepEqual(t, resp, &pb.WalletResponse{})
}
func TestServer_WalletConfig(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: defaultWalletPath,
}
// We attempt to create the wallet.
w, err := accounts.CreateWalletWithKeymanager(ctx, &accounts.CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: defaultWalletPath,
KeymanagerKind: keymanager.Local,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx, iface.InitKeymanagerConfig{ListenForChanges: false})
require.NoError(t, err)
s.wallet = w
vs, err := client.NewValidatorService(ctx, &client.Config{
Wallet: w,
Validator: &mock.MockValidator{
Km: km,
},
})
require.NoError(t, err)
s.validatorService = vs
resp, err := s.WalletConfig(ctx, &empty.Empty{})
require.NoError(t, err)
assert.DeepEqual(t, resp, &pb.WalletResponse{
WalletPath: localWalletDir,
KeymanagerKind: pb.KeymanagerKind_IMPORTED,
})
}
func TestServer_ImportAccounts_FailedPreconditions(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
w, err := accounts.CreateWalletWithKeymanager(ctx, &accounts.CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: defaultWalletPath,
KeymanagerKind: keymanager.Local,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx, iface.InitKeymanagerConfig{ListenForChanges: false})
require.NoError(t, err)
vs, err := client.NewValidatorService(ctx, &client.Config{
Wallet: w,
Validator: &mock.MockValidator{
Km: km,
},
})
require.NoError(t, err)
ss := &Server{
validatorService: vs,
}
_, err = ss.ImportAccounts(ctx, &pb.ImportAccountsRequest{})
assert.ErrorContains(t, "No wallet initialized", err)
ss.wallet = w
_, err = ss.ImportAccounts(ctx, &pb.ImportAccountsRequest{})
assert.ErrorContains(t, "Password required for keystores", err)
_, err = ss.ImportAccounts(ctx, &pb.ImportAccountsRequest{
KeystoresPassword: strongPass,
})
assert.ErrorContains(t, "No keystores included for import", err)
_, err = ss.ImportAccounts(ctx, &pb.ImportAccountsRequest{
KeystoresPassword: strongPass,
KeystoresImported: []string{"badjson"},
})
assert.ErrorContains(t, "Not a valid EIP-2335 keystore", err)
}
func TestServer_ImportAccounts_OK(t *testing.T) {
local.ResetCaches()
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
w, err := accounts.CreateWalletWithKeymanager(ctx, &accounts.CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: defaultWalletPath,
KeymanagerKind: keymanager.Local,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx, iface.InitKeymanagerConfig{ListenForChanges: false})
require.NoError(t, err)
vs, err := client.NewValidatorService(ctx, &client.Config{
Wallet: w,
Validator: &mock.MockValidator{
Km: km,
},
})
require.NoError(t, err)
ss := &Server{
wallet: w,
walletInitializedFeed: new(event.Feed),
validatorService: vs,
}
// Create 3 keystores.
encryptor := keystorev4.New()
keystores := make([]string, 3)
pubKeys := make([][]byte, 3)
for i := 0; i < len(keystores); i++ {
privKey, err := bls.RandKey()
require.NoError(t, err)
pubKey := fmt.Sprintf("%x", privKey.PublicKey().Marshal())
id, err := uuid.NewRandom()
require.NoError(t, err)
cryptoFields, err := encryptor.Encrypt(privKey.Marshal(), strongPass)
require.NoError(t, err)
item := &keymanager.Keystore{
Crypto: cryptoFields,
ID: id.String(),
Version: encryptor.Version(),
Pubkey: pubKey,
Name: encryptor.Name(),
}
encodedFile, err := json.MarshalIndent(item, "", "\t")
require.NoError(t, err)
keystores[i] = string(encodedFile)
pubKeys[i] = privKey.PublicKey().Marshal()
}
// Check the wallet has no accounts to start with.
keys, err := km.FetchValidatingPublicKeys(ctx)
require.NoError(t, err)
assert.Equal(t, 0, len(keys))
// Import the 3 keystores and verify the wallet has 3 new accounts.
res, err := ss.ImportAccounts(ctx, &pb.ImportAccountsRequest{
KeystoresPassword: strongPass,
KeystoresImported: keystores,
})
require.NoError(t, err)
assert.DeepEqual(t, &pb.ImportAccountsResponse{
ImportedPublicKeys: pubKeys,
}, res)
km, err = w.InitializeKeymanager(ctx, iface.InitKeymanagerConfig{ListenForChanges: false})
require.NoError(t, err)
keys, err = km.FetchValidatingPublicKeys(ctx)
require.NoError(t, err)
assert.Equal(t, 3, len(keys))
}
func Test_writeWalletPasswordToDisk(t *testing.T) {
walletDir := setupWalletDir(t)
resetCfg := features.InitWithReset(&features.Flags{
WriteWalletPasswordOnWebOnboarding: false,
})
defer resetCfg()
err := writeWalletPasswordToDisk(walletDir, "somepassword")
require.NoError(t, err)
// Expected a silent failure if the feature flag is not enabled.
passwordFilePath := filepath.Join(walletDir, wallet.DefaultWalletPasswordFile)
assert.Equal(t, false, file.FileExists(passwordFilePath))
resetCfg = features.InitWithReset(&features.Flags{
WriteWalletPasswordOnWebOnboarding: true,
})
defer resetCfg()
err = writeWalletPasswordToDisk(walletDir, "somepassword")
require.NoError(t, err)
// File should have been written.
assert.Equal(t, true, file.FileExists(passwordFilePath))
// Attempting to write again should trigger an error.
err = writeWalletPasswordToDisk(walletDir, "somepassword")
require.NotNil(t, err)
}
func createImportedWalletWithAccounts(t testing.TB, numAccounts int) (*Server, [][]byte) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
w, err := accounts.CreateWalletWithKeymanager(ctx, &accounts.CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: defaultWalletPath,
KeymanagerKind: keymanager.Local,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx, iface.InitKeymanagerConfig{ListenForChanges: false})
require.NoError(t, err)
vs, err := client.NewValidatorService(ctx, &client.Config{
Wallet: w,
Validator: &mock.MockValidator{
Km: km,
},
})
require.NoError(t, err)
s := &Server{
wallet: w,
walletDir: defaultWalletPath,
walletInitializedFeed: new(event.Feed),
validatorService: vs,
}
// First we import accounts into the wallet.
encryptor := keystorev4.New()
keystores := make([]string, numAccounts)
pubKeys := make([][]byte, len(keystores))
for i := 0; i < len(keystores); i++ {
privKey, err := bls.RandKey()
require.NoError(t, err)
pubKey := fmt.Sprintf("%x", privKey.PublicKey().Marshal())
id, err := uuid.NewRandom()
require.NoError(t, err)
cryptoFields, err := encryptor.Encrypt(privKey.Marshal(), strongPass)
require.NoError(t, err)
item := &keymanager.Keystore{
Crypto: cryptoFields,
ID: id.String(),
Version: encryptor.Version(),
Pubkey: pubKey,
Name: encryptor.Name(),
}
encodedFile, err := json.MarshalIndent(item, "", "\t")
require.NoError(t, err)
keystores[i] = string(encodedFile)
pubKeys[i] = privKey.PublicKey().Marshal()
}
_, err = s.ImportAccounts(ctx, &pb.ImportAccountsRequest{
KeystoresImported: keystores,
KeystoresPassword: strongPass,
})
require.NoError(t, err)
ikm, err := s.wallet.InitializeKeymanager(ctx, iface.InitKeymanagerConfig{ListenForChanges: false})
require.NoError(t, err)
newVS, err := client.NewValidatorService(ctx, &client.Config{
Wallet: s.wallet,
Validator: &mock.MockValidator{
Km: ikm,
},
})
require.NoError(t, err)
s.validatorService = newVS
require.NoError(t, err)
return s, pubKeys
}