mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-25 12:57:18 +00:00
5569a68452
* Value assigned to a variable is never read before being overwritten * The result of append is not used anywhere * Suspicious assignment of range-loop vars detected * Unused method receiver detected * Revert "Auxiliary commit to revert individual files from 54edcb445484a2e5d79612e19af8e949b8861253" This reverts commit bbd1e1beabf7b0c5cfc4f514dcc820062ad6c063. * Method modifies receiver * Fix test * Duplicate imports detected * Incorrectly formatted error string * Types of function parameters can be combined * One more "Unused method receiver detected" * Unused parameter detected in function
311 lines
10 KiB
Go
311 lines
10 KiB
Go
package imported
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"strings"
|
|
"sync"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/pkg/errors"
|
|
"github.com/prysmaticlabs/prysm/async/event"
|
|
"github.com/prysmaticlabs/prysm/crypto/bls"
|
|
"github.com/prysmaticlabs/prysm/encoding/bytesutil"
|
|
validatorpb "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1/validator-client"
|
|
"github.com/prysmaticlabs/prysm/runtime/interop"
|
|
"github.com/prysmaticlabs/prysm/validator/accounts/iface"
|
|
"github.com/prysmaticlabs/prysm/validator/accounts/petnames"
|
|
"github.com/prysmaticlabs/prysm/validator/keymanager"
|
|
keystorev4 "github.com/wealdtech/go-eth2-wallet-encryptor-keystorev4"
|
|
"go.opencensus.io/trace"
|
|
)
|
|
|
|
var (
|
|
lock sync.RWMutex
|
|
orderedPublicKeys = make([][48]byte, 0)
|
|
secretKeysCache = make(map[[48]byte]bls.SecretKey)
|
|
)
|
|
|
|
const (
|
|
// KeystoreFileNameFormat exposes the filename the keystore should be formatted in.
|
|
KeystoreFileNameFormat = "keystore-%d.json"
|
|
// AccountsPath where all imported keymanager keystores are kept.
|
|
AccountsPath = "accounts"
|
|
// AccountsKeystoreFileName exposes the name of the keystore file.
|
|
AccountsKeystoreFileName = "all-accounts.keystore.json"
|
|
)
|
|
|
|
// Keymanager implementation for imported keystores utilizing EIP-2335.
|
|
type Keymanager struct {
|
|
wallet iface.Wallet
|
|
accountsStore *accountStore
|
|
accountsChangedFeed *event.Feed
|
|
}
|
|
|
|
// SetupConfig includes configuration values for initializing
|
|
// a keymanager, such as passwords, the wallet, and more.
|
|
type SetupConfig struct {
|
|
Wallet iface.Wallet
|
|
ListenForChanges bool
|
|
}
|
|
|
|
// Defines a struct containing 1-to-1 corresponding
|
|
// private keys and public keys for Ethereum validators.
|
|
type accountStore struct {
|
|
PrivateKeys [][]byte `json:"private_keys"`
|
|
PublicKeys [][]byte `json:"public_keys"`
|
|
}
|
|
|
|
// AccountsKeystoreRepresentation defines an internal Prysm representation
|
|
// of validator accounts, encrypted according to the EIP-2334 standard.
|
|
type AccountsKeystoreRepresentation struct {
|
|
Crypto map[string]interface{} `json:"crypto"`
|
|
ID string `json:"uuid"`
|
|
Version uint `json:"version"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// ResetCaches for the keymanager.
|
|
func ResetCaches() {
|
|
lock.Lock()
|
|
orderedPublicKeys = make([][48]byte, 0)
|
|
secretKeysCache = make(map[[48]byte]bls.SecretKey)
|
|
lock.Unlock()
|
|
}
|
|
|
|
// NewKeymanager instantiates a new imported keymanager from configuration options.
|
|
func NewKeymanager(ctx context.Context, cfg *SetupConfig) (*Keymanager, error) {
|
|
k := &Keymanager{
|
|
wallet: cfg.Wallet,
|
|
accountsStore: &accountStore{},
|
|
accountsChangedFeed: new(event.Feed),
|
|
}
|
|
|
|
if err := k.initializeAccountKeystore(ctx); err != nil {
|
|
return nil, errors.Wrap(err, "failed to initialize account store")
|
|
}
|
|
|
|
if cfg.ListenForChanges {
|
|
// We begin a goroutine to listen for file changes to our
|
|
// all-accounts.keystore.json file in the wallet directory.
|
|
go k.listenForAccountChanges(ctx)
|
|
}
|
|
return k, nil
|
|
}
|
|
|
|
// NewInteropKeymanager instantiates a new imported keymanager with the deterministically generated interop keys.
|
|
func NewInteropKeymanager(_ context.Context, offset, numValidatorKeys uint64) (*Keymanager, error) {
|
|
k := &Keymanager{
|
|
accountsChangedFeed: new(event.Feed),
|
|
}
|
|
if numValidatorKeys == 0 {
|
|
return k, nil
|
|
}
|
|
secretKeys, publicKeys, err := interop.DeterministicallyGenerateKeys(offset, numValidatorKeys)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not generate interop keys")
|
|
}
|
|
lock.Lock()
|
|
pubKeys := make([][48]byte, numValidatorKeys)
|
|
for i := uint64(0); i < numValidatorKeys; i++ {
|
|
publicKey := bytesutil.ToBytes48(publicKeys[i].Marshal())
|
|
pubKeys[i] = publicKey
|
|
secretKeysCache[publicKey] = secretKeys[i]
|
|
}
|
|
orderedPublicKeys = pubKeys
|
|
lock.Unlock()
|
|
return k, nil
|
|
}
|
|
|
|
// SubscribeAccountChanges creates an event subscription for a channel
|
|
// to listen for public key changes at runtime, such as when new validator accounts
|
|
// are imported into the keymanager while the validator process is running.
|
|
func (km *Keymanager) SubscribeAccountChanges(pubKeysChan chan [][48]byte) event.Subscription {
|
|
return km.accountsChangedFeed.Subscribe(pubKeysChan)
|
|
}
|
|
|
|
// ValidatingAccountNames for a imported keymanager.
|
|
func (_ *Keymanager) ValidatingAccountNames() ([]string, error) {
|
|
lock.RLock()
|
|
names := make([]string, len(orderedPublicKeys))
|
|
for i, pubKey := range orderedPublicKeys {
|
|
names[i] = petnames.DeterministicName(bytesutil.FromBytes48(pubKey), "-")
|
|
}
|
|
lock.RUnlock()
|
|
return names, nil
|
|
}
|
|
|
|
// Initialize public and secret key caches that are used to speed up the functions
|
|
// FetchValidatingPublicKeys and Sign
|
|
func (km *Keymanager) initializeKeysCachesFromKeystore() error {
|
|
lock.Lock()
|
|
defer lock.Unlock()
|
|
count := len(km.accountsStore.PrivateKeys)
|
|
orderedPublicKeys = make([][48]byte, count)
|
|
secretKeysCache = make(map[[48]byte]bls.SecretKey, count)
|
|
for i, publicKey := range km.accountsStore.PublicKeys {
|
|
publicKey48 := bytesutil.ToBytes48(publicKey)
|
|
orderedPublicKeys[i] = publicKey48
|
|
secretKey, err := bls.SecretKeyFromBytes(km.accountsStore.PrivateKeys[i])
|
|
if err != nil {
|
|
return errors.Wrap(err, "failed to initialize keys caches from account keystore")
|
|
}
|
|
secretKeysCache[publicKey48] = secretKey
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// FetchValidatingPublicKeys fetches the list of active public keys from the imported account keystores.
|
|
func (_ *Keymanager) FetchValidatingPublicKeys(ctx context.Context) ([][48]byte, error) {
|
|
_, span := trace.StartSpan(ctx, "keymanager.FetchValidatingPublicKeys")
|
|
defer span.End()
|
|
|
|
lock.RLock()
|
|
keys := orderedPublicKeys
|
|
result := make([][48]byte, len(keys))
|
|
copy(result, keys)
|
|
lock.RUnlock()
|
|
return result, nil
|
|
}
|
|
|
|
// FetchValidatingPrivateKeys fetches the list of private keys from the secret keys cache
|
|
func (km *Keymanager) FetchValidatingPrivateKeys(ctx context.Context) ([][32]byte, error) {
|
|
lock.RLock()
|
|
defer lock.RUnlock()
|
|
privKeys := make([][32]byte, len(secretKeysCache))
|
|
pubKeys, err := km.FetchValidatingPublicKeys(ctx)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not retrieve public keys")
|
|
}
|
|
for i, pk := range pubKeys {
|
|
seckey, ok := secretKeysCache[pk]
|
|
if !ok {
|
|
return nil, errors.New("Could not fetch private key")
|
|
}
|
|
privKeys[i] = bytesutil.ToBytes32(seckey.Marshal())
|
|
}
|
|
return privKeys, nil
|
|
}
|
|
|
|
// Sign signs a message using a validator key.
|
|
func (_ *Keymanager) Sign(ctx context.Context, req *validatorpb.SignRequest) (bls.Signature, error) {
|
|
_, span := trace.StartSpan(ctx, "keymanager.Sign")
|
|
defer span.End()
|
|
|
|
publicKey := req.PublicKey
|
|
if publicKey == nil {
|
|
return nil, errors.New("nil public key in request")
|
|
}
|
|
lock.RLock()
|
|
secretKey, ok := secretKeysCache[bytesutil.ToBytes48(publicKey)]
|
|
lock.RUnlock()
|
|
if !ok {
|
|
return nil, errors.New("no signing key found in keys cache")
|
|
}
|
|
return secretKey.Sign(req.SigningRoot), nil
|
|
}
|
|
|
|
func (km *Keymanager) initializeAccountKeystore(ctx context.Context) error {
|
|
encoded, err := km.wallet.ReadFileAtPath(ctx, AccountsPath, AccountsKeystoreFileName)
|
|
if err != nil && strings.Contains(err.Error(), "no files found") {
|
|
// If there are no keys to initialize at all, just exit.
|
|
return nil
|
|
} else if err != nil {
|
|
return errors.Wrapf(err, "could not read keystore file for accounts %s", AccountsKeystoreFileName)
|
|
}
|
|
keystoreFile := &AccountsKeystoreRepresentation{}
|
|
if err := json.Unmarshal(encoded, keystoreFile); err != nil {
|
|
return errors.Wrapf(err, "could not decode keystore file for accounts %s", AccountsKeystoreFileName)
|
|
}
|
|
// We extract the validator signing private key from the keystore
|
|
// by utilizing the password and initialize a new BLS secret key from
|
|
// its raw bytes.
|
|
password := km.wallet.Password()
|
|
decryptor := keystorev4.New()
|
|
enc, err := decryptor.Decrypt(keystoreFile.Crypto, password)
|
|
if err != nil && strings.Contains(err.Error(), keymanager.IncorrectPasswordErrMsg) {
|
|
return errors.Wrap(err, "wrong password for wallet entered")
|
|
} else if err != nil {
|
|
return errors.Wrap(err, "could not decrypt keystore")
|
|
}
|
|
|
|
store := &accountStore{}
|
|
if err := json.Unmarshal(enc, store); err != nil {
|
|
return err
|
|
}
|
|
if len(store.PublicKeys) != len(store.PrivateKeys) {
|
|
return errors.New("unequal number of public keys and private keys")
|
|
}
|
|
if len(store.PublicKeys) == 0 {
|
|
return nil
|
|
}
|
|
km.accountsStore = store
|
|
err = km.initializeKeysCachesFromKeystore()
|
|
if err != nil {
|
|
return errors.Wrap(err, "failed to initialize keys caches")
|
|
}
|
|
return err
|
|
}
|
|
|
|
// CreateAccountsKeystore creates a new keystore holding the provided keys.
|
|
func (km *Keymanager) CreateAccountsKeystore(
|
|
_ context.Context,
|
|
privateKeys, publicKeys [][]byte,
|
|
) (*AccountsKeystoreRepresentation, error) {
|
|
encryptor := keystorev4.New()
|
|
id, err := uuid.NewRandom()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(privateKeys) != len(publicKeys) {
|
|
return nil, fmt.Errorf(
|
|
"number of private keys and public keys is not equal: %d != %d", len(privateKeys), len(publicKeys),
|
|
)
|
|
}
|
|
if km.accountsStore == nil {
|
|
km.accountsStore = &accountStore{
|
|
PrivateKeys: privateKeys,
|
|
PublicKeys: publicKeys,
|
|
}
|
|
} else {
|
|
existingPubKeys := make(map[string]bool)
|
|
existingPrivKeys := make(map[string]bool)
|
|
for i := 0; i < len(km.accountsStore.PrivateKeys); i++ {
|
|
existingPrivKeys[string(km.accountsStore.PrivateKeys[i])] = true
|
|
existingPubKeys[string(km.accountsStore.PublicKeys[i])] = true
|
|
}
|
|
// We append to the accounts store keys only
|
|
// if the private/secret key do not already exist, to prevent duplicates.
|
|
for i := 0; i < len(privateKeys); i++ {
|
|
sk := privateKeys[i]
|
|
pk := publicKeys[i]
|
|
_, privKeyExists := existingPrivKeys[string(sk)]
|
|
_, pubKeyExists := existingPubKeys[string(pk)]
|
|
if privKeyExists || pubKeyExists {
|
|
continue
|
|
}
|
|
km.accountsStore.PublicKeys = append(km.accountsStore.PublicKeys, pk)
|
|
km.accountsStore.PrivateKeys = append(km.accountsStore.PrivateKeys, sk)
|
|
}
|
|
}
|
|
err = km.initializeKeysCachesFromKeystore()
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to initialize keys caches")
|
|
}
|
|
encodedStore, err := json.MarshalIndent(km.accountsStore, "", "\t")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
cryptoFields, err := encryptor.Encrypt(encodedStore, km.wallet.Password())
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not encrypt accounts")
|
|
}
|
|
return &AccountsKeystoreRepresentation{
|
|
Crypto: cryptoFields,
|
|
ID: id.String(),
|
|
Version: encryptor.Version(),
|
|
Name: encryptor.Name(),
|
|
}, nil
|
|
}
|