keymanager

Documentation

Overview

Package keymanager implements the key manager worker.

Index

• type AccessList
  • func NewAccessList() *AccessList
  • func (l *AccessList) RuntimeAccessLists() []api.RuntimeAccessList
  • func (l *AccessList) Runtimes(peer core.PeerID) *RuntimeList
  • func (l *AccessList) Update(runtimeID common.Namespace, peers []core.PeerID)
  • func (l *AccessList) UpdateNodes(runtimeID common.Namespace, nodes []*node.Node)
• type PeerMap
  • func NewPeerMap() *PeerMap
  • func (m *PeerMap) NodeID(peer core.PeerID) (signature.PublicKey, bool)
  • func (m *PeerMap) Update(peers map[core.PeerID]signature.PublicKey)
• type RuntimeList
  • func NewRuntimeList() *RuntimeList
  • func (l *RuntimeList) Add(runtimeID common.Namespace)
  • func (l *RuntimeList) Contains(runtimeID common.Namespace) bool
  • func (l *RuntimeList) Delete(runtimeID common.Namespace)
  • func (l *RuntimeList) Empty() bool
• type TaskInfo
• type TaskQueue
  • func (s *TaskQueue) Add(info *TaskInfo)
  • func (s *TaskQueue) Cancel(epoch beacon.EpochTime, cause error)
  • func (s *TaskQueue) Clear(epoch beacon.EpochTime)
  • func (s *TaskQueue) Get(churpID uint8) (*TaskInfo, bool)
  • func (s *TaskQueue) Remove(info *TaskInfo, cause error)
  • func (s *TaskQueue) Run(epoch beacon.EpochTime, height int64) []*TaskInfo
  • func (s *TaskQueue) Stop(cause error)
• type Worker
  • func New(commonWorker *workerCommon.Worker, r *registration.Worker, backend api.Backend) (*Worker, error)
  • func (w *Worker) CallEnclave(ctx context.Context, data []byte, kind enclaverpc.Kind) ([]byte, error)
  • func (w *Worker) Cleanup()
  • func (w *Worker) Enabled() bool
  • func (w *Worker) GetRuntime() runtimeRegistry.Runtime
  • func (w *Worker) GetStatus() (*api.Status, error)
  • func (w *Worker) Initialized() <-chan struct{}
  • func (w *Worker) Name() string
  • func (w *Worker) NewRuntimeHostHandler() host.RuntimeHandler
  • 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()

Types

type AccessList

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

AccessList is a thread-safe data structure for managing access permissions.

func NewAccessList

func NewAccessList() *AccessList

NewAccessList constructs an empty access list.

func (*AccessList) RuntimeAccessLists

func (l *AccessList) RuntimeAccessLists() []api.RuntimeAccessList

RuntimeAccessLists returns a per-runtime list of allowed peers.

func (*AccessList) Runtimes

func (l *AccessList) Runtimes(peer core.PeerID) *RuntimeList

Runtimes returns the IDs of runtimes in which the given peer participates.

func (*AccessList) Update

func (l *AccessList) Update(runtimeID common.Namespace, peers []core.PeerID)

Update clears the access list for the specified runtime and adds the provided peers.

func (*AccessList) UpdateNodes

func (l *AccessList) UpdateNodes(runtimeID common.Namespace, nodes []*node.Node)

UpdateNodes converts node public keys to peer IDs and updates the access list for the specified runtime.

type PeerMap

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

PeerMap is a thread-safe data structure for translating peer IDs to node IDs.

func NewPeerMap

func NewPeerMap() *PeerMap

NewPeerMap creates an empty peer map.

func (*PeerMap) NodeID

func (m *PeerMap) NodeID(peer core.PeerID) (signature.PublicKey, bool)

NodeID returns the node ID of the specified peer.

func (*PeerMap) Update

func (m *PeerMap) Update(peers map[core.PeerID]signature.PublicKey)

Update updates the map with the provided peers.

type RuntimeList

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

RuntimeList is a thread-safe collection of unique runtime IDs.

func NewRuntimeList

func NewRuntimeList() *RuntimeList

NewRuntimeList constructs an empty runtime list.

func (*RuntimeList) Add

func (l *RuntimeList) Add(runtimeID common.Namespace)

Add adds the given runtime to the list.

func (*RuntimeList) Contains

func (l *RuntimeList) Contains(runtimeID common.Namespace) bool

Contains returns true if and only if the list contains the given runtime.

A nil runtime list is considered empty and will always return false.

func (*RuntimeList) Delete

func (l *RuntimeList) Delete(runtimeID common.Namespace)

Delete removes the given runtime from the list.

If the runtime list is nil or there is no such element, this function is a no-op.

func (*RuntimeList) Empty

func (l *RuntimeList) Empty() bool

Empty returns true if and only if the list contains no elements.

type TaskInfo

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

TaskInfo contains details about a scheduled task.

type TaskQueue

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

TaskQueue represents a queue of tasks.

func (*TaskQueue) Add

func (s *TaskQueue) Add(info *TaskInfo)

Add queues a task to the task queue.

func (*TaskQueue) Cancel

func (s *TaskQueue) Cancel(epoch beacon.EpochTime, cause error)

Cancel cancels and removes all running tasks with the next handoff epoch smaller than the given value.

func (*TaskQueue) Clear

func (s *TaskQueue) Clear(epoch beacon.EpochTime)

Clear removes all scheduled tasks with the next handoff epoch smaller than the given value.

func (*TaskQueue) Get

func (s *TaskQueue) Get(churpID uint8) (*TaskInfo, bool)

Get returns the information about a task with the given identifier.

func (*TaskQueue) Remove

func (s *TaskQueue) Remove(info *TaskInfo, cause error)

Remove removes the given task from the task queue and stops it if it is running.

func (*TaskQueue) Run

func (s *TaskQueue) Run(epoch beacon.EpochTime, height int64) []*TaskInfo

Run returns all scheduled tasks with the next handoff epoch and the minimum block height not exceeding the given values, and marks them as running.

func (*TaskQueue) Stop

func (s *TaskQueue) Stop(cause error)

Stop cancels and removes all running tasks.

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(
	commonWorker *workerCommon.Worker,
	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, kind enclaverpc.Kind) ([]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() (*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() host.RuntimeHandler

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()