Files
prysm/validator/rpc/handler_wallet_test.go
Preston Van Loon 2fd6bd8150 Add golang.org/x/tools modernize static analyzer and fix violations (#15946)
* Ran gopls modernize to fix everything

go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -fix -test ./...

* Override rules_go provided dependency for golang.org/x/tools to v0.38.0.

To update this, checked out rules_go, then ran `bazel run //go/tools/releaser -- upgrade-dep -mirror=false org_golang_x_tools` and copied the patches.

* Fix buildtag violations and ignore buildtag violations in external

* Introduce modernize analyzer package.

* Add modernize "any" analyzer.

* Fix violations of any analyzer

* Add modernize "appendclipped" analyzer.

* Fix violations of appendclipped

* Add modernize "bloop" analyzer.

* Add modernize "fmtappendf" analyzer.

* Add modernize "forvar" analyzer.

* Add modernize "mapsloop" analyzer.

* Add modernize "minmax" analyzer.

* Fix violations of minmax analyzer

* Add modernize "omitzero" analyzer.

* Add modernize "rangeint" analyzer.

* Fix violations of rangeint.

* Add modernize "reflecttypefor" analyzer.

* Fix violations of reflecttypefor analyzer.

* Add modernize "slicescontains" analyzer.

* Add modernize "slicessort" analyzer.

* Add modernize "slicesdelete" analyzer. This is disabled by default for now. See https://go.dev/issue/73686.

* Add modernize "stringscutprefix" analyzer.

* Add modernize "stringsbuilder" analyzer.

* Fix violations of stringsbuilder analyzer.

* Add modernize "stringsseq" analyzer.

* Add modernize "testingcontext" analyzer.

* Add modernize "waitgroup" analyzer.

* Changelog fragment

* gofmt

* gazelle

* Add modernize "newexpr" analyzer.

* Disable newexpr until go1.26

* Add more details in WORKSPACE on how to update the override

* @nalepae feedback on min()

* gofmt

* Fix violations of forvar
2025-11-14 01:27:22 +00:00

515 lines
17 KiB
Go

package rpc
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"path/filepath"
"testing"
"github.com/OffchainLabs/prysm/v7/async/event"
"github.com/OffchainLabs/prysm/v7/config/features"
"github.com/OffchainLabs/prysm/v7/crypto/bls"
"github.com/OffchainLabs/prysm/v7/crypto/rand"
"github.com/OffchainLabs/prysm/v7/io/file"
"github.com/OffchainLabs/prysm/v7/testing/assert"
"github.com/OffchainLabs/prysm/v7/testing/require"
"github.com/OffchainLabs/prysm/v7/validator/accounts"
"github.com/OffchainLabs/prysm/v7/validator/accounts/iface"
"github.com/OffchainLabs/prysm/v7/validator/accounts/wallet"
"github.com/OffchainLabs/prysm/v7/validator/client"
"github.com/OffchainLabs/prysm/v7/validator/client/testutil"
"github.com/OffchainLabs/prysm/v7/validator/keymanager"
"github.com/google/uuid"
"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 := t.Context()
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
opts := []accounts.Option{
accounts.WithWalletDir(defaultWalletPath),
accounts.WithKeymanagerType(keymanager.Derived),
accounts.WithWalletPassword(strongPass),
accounts.WithSkipMnemonicConfirm(true),
}
acc, err := accounts.NewCLIManager(opts...)
require.NoError(t, err)
w, err := acc.WalletCreate(ctx)
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: &testutil.FakeValidator{
Km: km,
},
})
require.NoError(t, err)
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: defaultWalletPath,
validatorService: vs,
}
request := &CreateWalletRequest{
Keymanager: importedKeymanagerKind,
WalletPassword: strongPass,
}
var buf bytes.Buffer
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req := httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/create", &buf)
wr := httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.CreateWallet(wr, req)
require.Equal(t, http.StatusOK, wr.Code)
encryptor := keystorev4.New()
keystores := make([]string, 3)
passwords := make([]string, 3)
for i := range keystores {
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,
Description: encryptor.Name(),
}
encodedFile, err := json.MarshalIndent(item, "", "\t")
require.NoError(t, err)
keystores[i] = string(encodedFile)
if i < len(passwords) {
passwords[i] = strongPass
}
}
importReq := &ImportKeystoresRequest{
Keystores: keystores,
Passwords: passwords,
}
err = json.NewEncoder(&buf).Encode(importReq)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("/eth/v1/keystores"), &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.ImportKeystores(wr, req)
require.Equal(t, http.StatusOK, wr.Code)
resp := &ImportKeystoresResponse{}
require.NoError(t, json.Unmarshal(wr.Body.Bytes(), resp))
for _, status := range resp.Data {
require.Equal(t, keymanager.StatusImported, status.Status)
}
keys, err := km.FetchValidatingPublicKeys(ctx)
require.NoError(t, err)
require.Equal(t, len(keys), len(keystores))
}
func TestServer_CreateWallet_Local_PasswordTooWeak(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: defaultWalletPath,
}
request := &CreateWalletRequest{
Keymanager: importedKeymanagerKind,
WalletPassword: "", // Weak password, empty string
}
var buf bytes.Buffer
err := json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req := httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/create", &buf)
wr := httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.CreateWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "Password too weak", wr.Body.String())
request = &CreateWalletRequest{
Keymanager: importedKeymanagerKind,
WalletPassword: "a", // Weak password, too short
}
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/create", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.CreateWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "Password too weak", wr.Body.String())
}
func TestServer_RecoverWallet_Derived(t *testing.T) {
localWalletDir := setupWalletDir(t)
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: localWalletDir,
}
request := &RecoverWalletRequest{
WalletPassword: strongPass,
NumAccounts: 0,
}
var buf bytes.Buffer
err := json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req := httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr := httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.RecoverWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "Must create at least 1 validator account", wr.Body.String())
request.NumAccounts = 2
request.Language = "Swahili"
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.RecoverWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "input not in the list of supported languages", wr.Body.String())
request.Language = "ENglish"
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.RecoverWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "invalid mnemonic in request", wr.Body.String())
mnemonicRandomness := make([]byte, 32)
_, err = rand.NewGenerator().Read(mnemonicRandomness)
require.NoError(t, err)
mnemonic, err := bip39.NewMnemonic(mnemonicRandomness)
require.NoError(t, err)
request.Mnemonic = mnemonic
request.Mnemonic25ThWord = " "
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.RecoverWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "mnemonic 25th word cannot be empty", wr.Body.String())
request.Mnemonic25ThWord = "outer"
// Test weak password.
request.WalletPassword = "123qwe"
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.RecoverWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "password did not pass validation", wr.Body.String())
request.WalletPassword = strongPass
// Create(derived) should fail then test recover.
reqCreate := &CreateWalletRequest{
Keymanager: derivedKeymanagerKind,
WalletPassword: strongPass,
NumAccounts: 2,
Mnemonic: mnemonic,
}
var buff bytes.Buffer
err = json.NewEncoder(&buff).Encode(reqCreate)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/create", &buff)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.CreateWallet(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "create wallet not supported through web", wr.Body.String())
// 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 = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.RecoverWallet(wr, req)
// Password File should have been written.
passwordFilePath := filepath.Join(localWalletDir, wallet.DefaultWalletPasswordFile)
exists, err := file.Exists(passwordFilePath, file.Regular)
require.NoError(t, err, "could not check if password file exists")
assert.Equal(t, true, exists)
// 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) {
strongPass := "29384283xasjasd32%%&*@*#*"
ss := &Server{}
request := &ValidateKeystoresRequest{}
var buf bytes.Buffer
err := json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req := httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr := httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
ss.ValidateKeystores(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
assert.StringContains(t, "Password required for keystores", wr.Body.String())
request = &ValidateKeystoresRequest{
KeystoresPassword: strongPass,
}
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
ss.ValidateKeystores(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
assert.StringContains(t, "No keystores included in request", wr.Body.String())
request = &ValidateKeystoresRequest{
KeystoresPassword: strongPass,
Keystores: []string{"badjson"},
}
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
ss.ValidateKeystores(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
assert.StringContains(t, "Not a valid EIP-2335 keystore", wr.Body.String())
}
func TestServer_ValidateKeystores_OK(t *testing.T) {
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,
Description: 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.
request := &ValidateKeystoresRequest{
KeystoresPassword: strongPass,
Keystores: keystores,
}
var buf bytes.Buffer
err := json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req := httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr := httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
ss.ValidateKeystores(wr, req)
require.Equal(t, http.StatusOK, wr.Code)
// Check that using a different password will return an error.
request = &ValidateKeystoresRequest{
KeystoresPassword: "badpassword",
Keystores: keystores,
}
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
ss.ValidateKeystores(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "is incorrect", wr.Body.String())
// 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,
Description: encryptor.Name(),
}
encodedFile, err := json.MarshalIndent(item, "", "\t")
keystores = append(keystores, string(encodedFile))
require.NoError(t, err)
request = &ValidateKeystoresRequest{
KeystoresPassword: strongPass,
Keystores: keystores,
}
err = json.NewEncoder(&buf).Encode(request)
require.NoError(t, err)
req = httptest.NewRequest(http.MethodPost, "/v2/validator/wallet/recover", &buf)
wr = httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
ss.ValidateKeystores(wr, req)
require.NotEqual(t, http.StatusOK, wr.Code)
require.StringContains(t, "Password for keystore with public key somepubkey is incorrect", wr.Body.String())
}
func TestServer_WalletConfig_NoWalletFound(t *testing.T) {
s := &Server{}
req := httptest.NewRequest(http.MethodGet, "/v2/validator/wallet/keystores/validate", nil)
wr := httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.WalletConfig(wr, req)
require.Equal(t, http.StatusOK, wr.Code)
var resp WalletResponse
require.NoError(t, json.Unmarshal(wr.Body.Bytes(), &resp))
require.DeepEqual(t, resp, WalletResponse{})
}
func TestServer_WalletConfig(t *testing.T) {
localWalletDir := setupWalletDir(t)
defaultWalletPath = localWalletDir
ctx := t.Context()
s := &Server{
walletInitializedFeed: new(event.Feed),
walletDir: defaultWalletPath,
}
// We attempt to create the wallet.
opts := []accounts.Option{
accounts.WithWalletDir(defaultWalletPath),
accounts.WithKeymanagerType(keymanager.Local),
accounts.WithWalletPassword(strongPass),
accounts.WithSkipMnemonicConfirm(true),
}
acc, err := accounts.NewCLIManager(opts...)
require.NoError(t, err)
w, err := acc.WalletCreate(ctx)
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: &testutil.FakeValidator{
Km: km,
},
})
require.NoError(t, err)
s.validatorService = vs
req := httptest.NewRequest(http.MethodGet, "/v2/validator/wallet/keystores/validate", nil)
wr := httptest.NewRecorder()
wr.Body = &bytes.Buffer{}
s.WalletConfig(wr, req)
require.Equal(t, http.StatusOK, wr.Code)
var resp WalletResponse
require.NoError(t, json.Unmarshal(wr.Body.Bytes(), &resp))
assert.DeepEqual(t, resp, WalletResponse{
WalletPath: localWalletDir,
KeymanagerKind: importedKeymanagerKind,
})
}
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)
exists, err := file.Exists(passwordFilePath, file.Regular)
require.NoError(t, err, "could not check if password file exists")
assert.Equal(t, false, exists, "password file should not exist")
resetCfg = features.InitWithReset(&features.Flags{
WriteWalletPasswordOnWebOnboarding: true,
})
defer resetCfg()
err = writeWalletPasswordToDisk(walletDir, "somepassword")
require.NoError(t, err)
// File should have been written.
exists, err = file.Exists(passwordFilePath, file.Regular)
require.NoError(t, err, "could not check if password file exists")
assert.Equal(t, true, exists, "password file should exist")
// Attempting to write again should trigger an error.
err = writeWalletPasswordToDisk(walletDir, "somepassword")
require.NotNil(t, err)
}
func createRandomKeystore(t testing.TB, password string) *keymanager.Keystore {
encryptor := keystorev4.New()
id, err := uuid.NewRandom()
require.NoError(t, err)
validatingKey, err := bls.RandKey()
require.NoError(t, err)
pubKey := validatingKey.PublicKey().Marshal()
cryptoFields, err := encryptor.Encrypt(validatingKey.Marshal(), password)
require.NoError(t, err)
return &keymanager.Keystore{
Crypto: cryptoFields,
Pubkey: fmt.Sprintf("%x", pubKey),
ID: id.String(),
Version: encryptor.Version(),
Description: encryptor.Name(),
}
}