api

Documentation

Index

• type EphemeralSecretStats
• type MasterSecretStats
• type RuntimeAccessList
• type Status
• type StatusState
  • func (s StatusState) MarshalText() ([]byte, error)
  • func (s StatusState) String() string
  • func (s *StatusState) UnmarshalText(text []byte) error
• type WorkerStatus

Types

type EphemeralSecretStats

type EphemeralSecretStats struct {
	// NumLoaded is the number of loaded secrets.
	NumLoaded int `json:"num_loaded"`
	// LastLoaded is the epoch of the last loaded secret.
	LastLoaded beacon.EpochTime `json:"last_loaded_epoch"`
	// NumGenerated is the number of generated secrets.
	NumGenerated int `json:"num_generated"`
	// LastGenerated is the epoch of the last generated secret.
	LastGenerated beacon.EpochTime `json:"last_generated_epoch"`
}

EphemeralSecretStats are the ephemeral secret generation and replication stats.

type MasterSecretStats

type MasterSecretStats struct {
	// NumLoaded is the number of loaded secrets.
	NumLoaded int `json:"num_loaded"`
	// LastLoaded is the generation of the last loaded secret.
	LastLoaded uint64 `json:"last_loaded_generation"`
	// NumGenerated is the number of generated secrets.
	NumGenerated int `json:"num_generated"`
	// LastGenerated is the generation of the last generated secret.
	LastGenerated uint64 `json:"last_generated_generation"`
}

MasterSecretStats are the master secret generation and replication stats.

type RuntimeAccessList

type RuntimeAccessList struct {
	// RuntimeID is the runtime ID of the runtime this access list is for.
	RuntimeID common.Namespace `json:"runtime_id"`

	// Peers is a list of peers that are allowed to call protected methods.
	Peers []core.PeerID `json:"peers"`
}

RuntimeAccessList is an access control lists for a runtime.

type Status

type Status struct {
	// GlobalStatus is the global key manager committee status.
	GlobalStatus *api.Status `json:"global"`

	// WorkerStatus is the key manager worker status.
	WorkerStatus WorkerStatus `json:"worker"`
}

Status is the key manager global and worker status.

type StatusState

type StatusState uint8

StatusState is the concise status state of the key manager worker.

const (
	// StatusStateReady is the ready status state.
	StatusStateReady StatusState = 0
	// StatusStateStarting is the starting status state.
	StatusStateStarting StatusState = 1
	// StatusStateStopped is the stopped status state.
	StatusStateStopped StatusState = 2
	// StatusStateDisabled is the disabled status state.
	StatusStateDisabled StatusState = 3
)

func (StatusState) MarshalText

func (s StatusState) MarshalText() ([]byte, error)

MarshalText encodes a StatusState into text form.

func (StatusState) String

func (s StatusState) String() string

String returns a string representation of a status state.

func (*StatusState) UnmarshalText

func (s *StatusState) UnmarshalText(text []byte) error

UnmarshalText decodes a text slice into a StatusState.

type WorkerStatus

type WorkerStatus struct {
	// Status is a concise status of the key manager worker.
	Status StatusState `json:"status"`

	// ActiveVersion is the currently active version.
	ActiveVersion *version.Version `json:"active_version"`

	// MayGenerate returns whether the enclave can generate a master secret.
	MayGenerate bool `json:"may_generate"`

	// RuntimeID is the runtime ID of the key manager.
	RuntimeID *common.Namespace `json:"runtime_id"`
	// ClientRuntimes is a list of compute runtimes that use this key manager.
	ClientRuntimes []common.Namespace `json:"client_runtimes"`

	// AccessList is per-runtime list of peers that are allowed to call protected methods.
	AccessList []RuntimeAccessList `json:"access_list"`
	// PrivatePeers is a list of peers that are always allowed to call protected methods.
	PrivatePeers []core.PeerID `json:"private_peers"`

	// Policy is the key manager policy.
	Policy *api.SignedPolicySGX `json:"policy"`
	// PolicyChecksum is the checksum of the key manager policy.
	PolicyChecksum []byte `json:"policy_checksum"`

	// MasterSecrets are the master secret generation and replication stats.
	MasterSecrets MasterSecretStats `json:"master_secrets"`
	// EphemeralSecrets are the ephemeral secret generation and replication stats.
	EphemeralSecrets EphemeralSecretStats `json:"ephemeral_secrets"`
}

WorkerStatus is the key manager worker status.