prysm-pulse/validator/rpc/wallet_test.go
Raul Jordan dc897a2007
Optionally Save Wallet Password on Web Onboarding (#7930)
* persist wallet password to wallet dir if onboarded via web

* add flag

* gaz

* add test

* fmt

Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com>
2020-11-23 22:11:42 +00:00

311 lines
9.7 KiB
Go

package rpc
import (
"context"
"encoding/json"
"fmt"
"os"
"path/filepath"
"testing"
ptypes "github.com/gogo/protobuf/types"
"github.com/google/uuid"
keystorev4 "github.com/wealdtech/go-eth2-wallet-encryptor-keystorev4"
pb "github.com/prysmaticlabs/prysm/proto/validator/accounts/v2"
"github.com/prysmaticlabs/prysm/shared/bls"
"github.com/prysmaticlabs/prysm/shared/event"
"github.com/prysmaticlabs/prysm/shared/featureconfig"
"github.com/prysmaticlabs/prysm/shared/fileutil"
"github.com/prysmaticlabs/prysm/shared/testutil/assert"
"github.com/prysmaticlabs/prysm/shared/testutil/require"
"github.com/prysmaticlabs/prysm/validator/accounts"
"github.com/prysmaticlabs/prysm/validator/accounts/wallet"
"github.com/prysmaticlabs/prysm/validator/keymanager"
"github.com/prysmaticlabs/prysm/validator/keymanager/imported"
)
func TestServer_CreateWallet_Imported(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
strongPass := "29384283xasjasd32%%&*@*#*"
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: defaultWalletPath,
}
_, err := s.Signup(ctx, &pb.AuthRequest{
Password: strongPass,
PasswordConfirmation: strongPass,
})
require.NoError(t, err)
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.ImportKeystoresRequest{
KeystoresPassword: strongPass,
KeystoresImported: []string{"badjson"},
}
_, err = s.ImportKeystores(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.ImportKeystores(ctx, importReq)
require.NoError(t, err)
}
func TestServer_CreateWallet_Derived(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
strongPass := "29384283xasjasd32%%&*@*#*"
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: localWalletDir,
}
req := &pb.CreateWalletRequest{
Keymanager: pb.KeymanagerKind_DERIVED,
WalletPassword: strongPass,
NumAccounts: 0,
}
// 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, "Must create at least 1 validator account", err)
req.NumAccounts = 2
_, err = s.CreateWallet(ctx, req)
require.ErrorContains(t, "Must include mnemonic", err)
mnemonicResp, err := s.GenerateMnemonic(ctx, &ptypes.Empty{})
require.NoError(t, err)
req.Mnemonic = mnemonicResp.Mnemonic
_, err = s.CreateWallet(ctx, req)
require.NoError(t, err)
}
func TestServer_WalletConfig_NoWalletFound(t *testing.T) {
s := &Server{}
resp, err := s.WalletConfig(context.Background(), &ptypes.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()
strongPass := "29384283xasjasd32%%&*@*#*"
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.Imported,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx)
require.NoError(t, err)
s.wallet = w
s.keymanager = km
resp, err := s.WalletConfig(ctx, &ptypes.Empty{})
require.NoError(t, err)
assert.DeepEqual(t, resp, &pb.WalletResponse{
WalletPath: localWalletDir,
KeymanagerKind: pb.KeymanagerKind_IMPORTED,
})
}
func TestServer_ImportKeystores_FailedPreconditions_WrongKeymanagerKind(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
strongPass := "29384283xasjasd32%%&*@*#*"
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)
require.NoError(t, err)
ss := &Server{
wallet: w,
keymanager: km,
}
_, err = ss.ImportKeystores(ctx, &pb.ImportKeystoresRequest{})
assert.ErrorContains(t, "Only imported wallets can import more", err)
}
func TestServer_ImportKeystores_FailedPreconditions(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
strongPass := "29384283xasjasd32%%&*@*#*"
w, err := accounts.CreateWalletWithKeymanager(ctx, &accounts.CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: defaultWalletPath,
KeymanagerKind: keymanager.Imported,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx)
require.NoError(t, err)
ss := &Server{
keymanager: km,
}
_, err = ss.ImportKeystores(ctx, &pb.ImportKeystoresRequest{})
assert.ErrorContains(t, "No wallet initialized", err)
ss.wallet = w
_, err = ss.ImportKeystores(ctx, &pb.ImportKeystoresRequest{})
assert.ErrorContains(t, "Password required for keystores", err)
_, err = ss.ImportKeystores(ctx, &pb.ImportKeystoresRequest{
KeystoresPassword: strongPass,
})
assert.ErrorContains(t, "No keystores included for import", err)
_, err = ss.ImportKeystores(ctx, &pb.ImportKeystoresRequest{
KeystoresPassword: strongPass,
KeystoresImported: []string{"badjson"},
})
assert.ErrorContains(t, "Not a valid EIP-2335 keystore", err)
}
func TestServer_ImportKeystores_OK(t *testing.T) {
imported.ResetCaches()
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := context.Background()
strongPass := "29384283xasjasd32%%&*@*#*"
w, err := accounts.CreateWalletWithKeymanager(ctx, &accounts.CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: defaultWalletPath,
KeymanagerKind: keymanager.Imported,
WalletPassword: strongPass,
},
SkipMnemonicConfirm: true,
})
require.NoError(t, err)
km, err := w.InitializeKeymanager(ctx)
require.NoError(t, err)
ss := &Server{
keymanager: km,
wallet: w,
walletInitializedFeed: new(event.Feed),
}
// 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.ImportKeystores(ctx, &pb.ImportKeystoresRequest{
KeystoresPassword: strongPass,
KeystoresImported: keystores,
})
require.NoError(t, err)
assert.DeepEqual(t, &pb.ImportKeystoresResponse{
ImportedPublicKeys: pubKeys,
}, res)
km, err = w.InitializeKeymanager(ctx)
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 := featureconfig.InitWithReset(&featureconfig.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, fileutil.FileExists(passwordFilePath))
resetCfg = featureconfig.InitWithReset(&featureconfig.Flags{
WriteWalletPasswordOnWebOnboarding: true,
})
defer resetCfg()
err = writeWalletPasswordToDisk(walletDir, "somepassword")
require.NoError(t, err)
// File should have been written.
assert.Equal(t, true, fileutil.FileExists(passwordFilePath))
// Attempting to write again should trigger an error.
err = writeWalletPasswordToDisk(walletDir, "somepassword")
require.NotNil(t, err)
}