keymanager

Documentation

Overview

Package keymanager implements the key manager worker.

Index

• Constants
• Variables
• type Worker
  • func New(dataDir string, commonWorker *workerCommon.Worker, ias ias.Endpoint, ...) (*Worker, error)
  • func (w *Worker) CallEnclave(ctx context.Context, data []byte) ([]byte, error)
  • func (w *Worker) Cleanup()
  • func (w *Worker) Enabled() bool
  • func (w *Worker) GetRuntime() runtimeRegistry.Runtime
  • func (w *Worker) GetStatus(ctx context.Context) (*api.Status, error)
  • func (w *Worker) Initialized() <-chan struct{}
  • func (w *Worker) Name() string
  • func (w *Worker) NewRuntimeHostHandler() protocol.Handler
  • func (w *Worker) NewRuntimeHostNotifier(ctx context.Context, host host.Runtime) protocol.Notifier
  • func (w *Worker) Quit() <-chan struct{}
  • func (w *Worker) Start() error
  • func (w *Worker) Stop()

Constants

const (
	// CfgRuntimeID configures the runtime ID.
	CfgRuntimeID = "worker.keymanager.runtime.id"
	// CfgMayGenerate allows the enclave to generate a master secret.
	CfgMayGenerate = "worker.keymanager.may_generate"
	// CfgPrivatePeerPubKeys allows adding manual, unadvertised peers that can call protected methods.
	CfgPrivatePeerPubKeys = "worker.keymanager.private_peer_pub_keys"
)

Variables

var Flags = flag.NewFlagSet("", flag.ContinueOnError)

Flags has the configuration flags.

Types

type Worker

type Worker struct {
	sync.RWMutex
	*runtimeRegistry.RuntimeHostNode
	// contains filtered or unexported fields
}

Worker is the key manager worker.

It behaves differently from other workers as the key manager has its own runtime. It needs to keep track of executor committees for other runtimes in order to update the access control lists.

func New

func New(
	dataDir string,
	commonWorker *workerCommon.Worker,
	ias ias.Endpoint,
	r *registration.Worker,
	backend api.Backend,
) (*Worker, error)

New constructs a new key manager worker.

func (*Worker) CallEnclave

func (w *Worker) CallEnclave(ctx context.Context, data []byte) ([]byte, error)

func (*Worker) Cleanup

func (w *Worker) Cleanup()

func (*Worker) Enabled

func (w *Worker) Enabled() bool

Enabled returns if worker is enabled.

func (*Worker) GetRuntime

func (w *Worker) GetRuntime() runtimeRegistry.Runtime

GetRuntime implements workerCommon.RuntimeHostHandlerFactory.

func (*Worker) GetStatus

func (w *Worker) GetStatus(ctx context.Context) (*api.Status, error)

GetStatus returns the key manager worker status.

func (*Worker) Initialized

func (w *Worker) Initialized() <-chan struct{}

Initialized returns a channel that will be closed when the worker is initialized, ready to service requests and registered with the consensus layer.

func (*Worker) Name

func (w *Worker) Name() string

func (*Worker) NewRuntimeHostHandler

func (w *Worker) NewRuntimeHostHandler() protocol.Handler

NewRuntimeHostHandler implements workerCommon.RuntimeHostHandlerFactory.

func (*Worker) NewRuntimeHostNotifier

func (w *Worker) NewRuntimeHostNotifier(ctx context.Context, host host.Runtime) protocol.Notifier

NewRuntimeHostNotifier implements workerCommon.RuntimeHostHandlerFactory.

func (*Worker) Quit

func (w *Worker) Quit() <-chan struct{}

func (*Worker) Start

func (w *Worker) Start() error

func (*Worker) Stop

func (w *Worker) Stop()