keymanager

Documentation

Index

• Variables
• type Direct
  • func NewDirect(sks []*bls.SecretKey) *Direct
  • func (km *Direct) FetchValidatingKeys() ([][48]byte, error)
  • func (km *Direct) Sign(pubKey [48]byte, root [32]byte) (*bls.Signature, error)
• type Interop
  • func NewInterop(input string) (*Interop, string, error)
• type KeyManager
  • func NewKeystore(input string) (KeyManager, string, error)
  • func NewRemoteWallet(input string) (KeyManager, string, error)
  • func NewRemoteWalletd(location, caCert, clientCert, clientKey, accountPath string) (KeyManager, error)
  • func NewWallet(input string) (KeyManager, string, error)
• type Keystore
• type ProtectingKeyManager
• type Remote
  • func (km *Remote) FetchValidatingKeys() ([][48]byte, error)
  • func (km *Remote) RefreshValidatingKeys() error
  • func (km *Remote) Sign(pubKey [48]byte, root [32]byte) (*bls.Signature, error)
  • func (km *Remote) SignAttestation(pubKey [48]byte, domain [32]byte, data *ethpb.AttestationData) (*bls.Signature, error)
  • func (km *Remote) SignGeneric(pubKey [48]byte, root [32]byte, domain [32]byte) (*bls.Signature, error)
  • func (km *Remote) SignProposal(pubKey [48]byte, domain [32]byte, data *ethpb.BeaconBlockHeader) (*bls.Signature, error)
• type Unencrypted
  • func NewUnencrypted(input string) (*Unencrypted, string, error)
• type Wallet
  • func (km *Wallet) FetchValidatingKeys() ([][48]byte, error)
  • func (km *Wallet) Sign(pubKey [48]byte, root [32]byte) (*bls.Signature, error)

Variables

var ErrCannotSign = errors.New("cannot sign")

ErrCannotSign is returned whenever a signing attempt fails.

var ErrDenied = errors.New("signing attempt denied")

ErrDenied is returned whenever a signing attempt is denied.

var ErrNoSuchKey = errors.New("no such key")

ErrNoSuchKey is returned whenever a request is made for a key of which a key manager is unaware.

Types

type Direct

type Direct struct {
	// contains filtered or unexported fields
}

Direct is a key manager that holds all secret keys directly.

func NewDirect

func NewDirect(sks []*bls.SecretKey) *Direct

NewDirect creates a new direct key manager from the secret keys provided to it.

func (*Direct) FetchValidatingKeys

func (km *Direct) FetchValidatingKeys() ([][48]byte, error)

FetchValidatingKeys fetches the list of public keys that should be used to validate with.

func (*Direct) Sign

func (km *Direct) Sign(pubKey [48]byte, root [32]byte) (*bls.Signature, error)

Sign signs a message for the validator to broadcast.

type Interop

type Interop struct {
	*Direct
}

Interop is a key manager that deterministically generates keys.

func NewInterop

func NewInterop(input string) (*Interop, string, error)

NewInterop creates a key manager using a number of interop keys at a given offset.

type KeyManager

type KeyManager interface {
	// FetchValidatingKeys fetches the list of public keys that should be used to validate with.
	FetchValidatingKeys() ([][48]byte, error)
	// Sign signs a message for the validator to broadcast.
	// Note that the domain should already be part of the root, but it is passed along for security purposes.
	Sign(pubKey [48]byte, root [32]byte) (*bls.Signature, error)
}

KeyManager controls access to private keys by the validator.

func NewKeystore

func NewKeystore(input string) (KeyManager, string, error)

NewKeystore creates a key manager populated with the keys from the keystore at the given path.

func NewRemoteWallet

func NewRemoteWallet(input string) (KeyManager, string, error)

NewRemoteWallet creates a key manager populated with the keys from walletd.

func NewRemoteWalletd

func NewRemoteWalletd(location, caCert, clientCert, clientKey, accountPath string) (KeyManager, error)

NewRemoteWalletd creates a key manager populated with the keys from walletd.

func NewWallet

func NewWallet(input string) (KeyManager, string, error)

NewWallet creates a key manager populated with the keys from a wallet at the given path.

type Keystore

type Keystore struct {
	*Direct
}

Keystore is a key manager that loads keys from a standard keystore.

type ProtectingKeyManager

type ProtectingKeyManager interface {
	// SignGeneric signs a generic root.
	// Note that the domain should already be part of the root, but it is provided for authorisation purposes.
	SignGeneric(pubKey [48]byte, root [32]byte, domain [32]byte) (*bls.Signature, error)

	// SignProposal signs a block proposal for the validator to broadcast.
	SignProposal(pubKey [48]byte, domain [32]byte, data *ethpb.BeaconBlockHeader) (*bls.Signature, error)

	// SignAttestation signs an attestation for the validator to broadcast.
	SignAttestation(pubKey [48]byte, domain [32]byte, data *ethpb.AttestationData) (*bls.Signature, error)
}

ProtectingKeyManager provides access to a keymanager that protects its clients from slashing events.

type Remote

type Remote struct {
	// contains filtered or unexported fields
}

Remote is a key manager that accesses a remote wallet daemon.

func (*Remote) FetchValidatingKeys

func (km *Remote) FetchValidatingKeys() ([][48]byte, error)

FetchValidatingKeys fetches the list of public keys that should be used to validate with.

func (*Remote) RefreshValidatingKeys

func (km *Remote) RefreshValidatingKeys() error

RefreshValidatingKeys refreshes the list of validating keys from the remote signer.

func (*Remote) Sign

func (km *Remote) Sign(pubKey [48]byte, root [32]byte) (*bls.Signature, error)

Sign without protection is not supported by remote keymanagers.

func (*Remote) SignAttestation

func (km *Remote) SignAttestation(pubKey [48]byte, domain [32]byte, data *ethpb.AttestationData) (*bls.Signature, error)

SignAttestation signs an attestation for the validator to broadcast.

func (*Remote) SignGeneric

func (km *Remote) SignGeneric(pubKey [48]byte, root [32]byte, domain [32]byte) (*bls.Signature, error)

SignGeneric signs a generic message for the validator to broadcast.

func (*Remote) SignProposal

func (km *Remote) SignProposal(pubKey [48]byte, domain [32]byte, data *ethpb.BeaconBlockHeader) (*bls.Signature, error)

SignProposal signs a block proposal for the validator to broadcast.

type Unencrypted

type Unencrypted struct {
	*Direct
}

Unencrypted is a key manager that loads keys from an unencrypted store.

func NewUnencrypted

func NewUnencrypted(input string) (*Unencrypted, string, error)

NewUnencrypted creates a keymanager from a file of unencrypted keys.

type Wallet

type Wallet struct {
	// contains filtered or unexported fields
}

Wallet is a key manager that loads keys from a local Ethereum 2 wallet.

func (*Wallet) FetchValidatingKeys

func (km *Wallet) FetchValidatingKeys() ([][48]byte, error)

FetchValidatingKeys fetches the list of public keys that should be used to validate with.

func (*Wallet) Sign

func (km *Wallet) Sign(pubKey [48]byte, root [32]byte) (*bls.Signature, error)

Sign signs a message for the validator to broadcast.