core

Documentation

Overview

Package core provides the core functionality for the Coordinator object including state transition, APIs for marbles and clients, handling of manifests and the sealing functionalities.

Index

• type BaseVec
• type Core
  • func NewCore(dnsNames []string, qv quote.Validator, qi quote.Issuer, ...) (*Core, error)
  • func NewCoreWithMocks() *Core
  • func (c *Core) Activate(ctx context.Context, req *rpc.ActivationReq) (res *rpc.ActivationResp, err error)
  • func (c *Core) AdvanceState(newState state.State, tx interface{ ... }) error
  • func (c *Core) GenerateQuote(cert []byte) error
  • func (c *Core) GenerateSecrets(secrets map[string]manifest.Secret, id uuid.UUID, ...) (map[string]manifest.Secret, error)
  • func (c *Core) GetQuote() []byte
  • func (c *Core) GetState(ctx context.Context) (state.State, string, error)
  • func (c *Core) GetTLSConfig() (*tls.Config, error)
  • func (c *Core) GetTLSMarbleRootCertificate(clientHello *tls.ClientHelloInfo) (*tls.Certificate, error)
  • func (c *Core) GetTLSRootCertificate(clientHello *tls.ClientHelloInfo) (*tls.Certificate, error)
  • func (c *Core) RequireState(ctx context.Context, states ...state.State) error
  • func (c *Core) Unlock()
• type CounterVec
• type NullBaseVec
  • func (NullBaseVec) Delete(_ prometheus.Labels) bool
  • func (NullBaseVec) DeleteLabelValues(_ ...string) bool
  • func (NullBaseVec) Reset()
• type NullCollector
  • func (NullCollector) Collect(chan<- prometheus.Metric)
  • func (NullCollector) Describe(chan<- *prometheus.Desc)
• type NullCounter
  • func (NullCounter) Add(float64)
  • func (NullCounter) Inc()
• type NullCounterVec
  • func (NullCounterVec) GetMetricWith(_ prometheus.Labels) (prometheus.Counter, error)
  • func (NullCounterVec) GetMetricWithLabelValues(_ ...string) (prometheus.Counter, error)
  • func (NullCounterVec) With(_ prometheus.Labels) prometheus.Counter
  • func (NullCounterVec) WithLabelValues(_ ...string) prometheus.Counter
• type NullMetric
  • func (NullMetric) Desc() *prometheus.Desc
  • func (NullMetric) Write(*dto.Metric) error
• type QuoteError
  • func (e QuoteError) Error() string

Types

type BaseVec

type BaseVec interface {
	prometheus.Collector

	Delete(labels prometheus.Labels) bool
	DeleteLabelValues(lvs ...string) bool
	Reset()
}

BaseVec is a vector of metrics.

type Core

type Core struct {
	rpc.UnimplementedMarbleServer
	// contains filtered or unexported fields
}

Core implements the core logic of the Coordinator.

func NewCore

func NewCore(
	dnsNames []string, qv quote.Validator, qi quote.Issuer, txHandle transactionHandle,
	recovery recovery.Recovery, zapLogger *zap.Logger, promFactory *promauto.Factory, eventlog *events.Log,
) (*Core, error)

NewCore creates and initializes a new Core object.

func NewCoreWithMocks

func NewCoreWithMocks() *Core

NewCoreWithMocks creates a new core object with quote and seal mocks for testing.

func (*Core) Activate

func (c *Core) Activate(ctx context.Context, req *rpc.ActivationReq) (res *rpc.ActivationResp, err error)

Activate implements the MarbleAPI function to authenticate a marble (implements the MarbleServer interface).

Verifies the marble's integrity and subsequently provides the marble with a certificate for authentication and application-specific parameters as defined in the Coordinator's manifest.

Parameter req needs to contain a MarbleType present in the Coordinator's manifest and a CSR with the Subject and DNSNames set with desired values.

Returns a signed certificate-key-pair and the application's parameters if the authentication was successful. Returns an error if the authentication failed.

func (*Core) AdvanceState

func (c *Core) AdvanceState(newState state.State, tx interface {
	PutState(state.State) error
	GetState() (state.State, error)
},
) error

AdvanceState advances the state of the Coordinator.

func (*Core) GenerateQuote

func (c *Core) GenerateQuote(cert []byte) error

GenerateQuote generates a quote for the Coordinator using the given certificate. If no quote can be generated due to the system not supporting SGX, no error is returned, and the Coordinator proceeds to run in simulation mode.

func (*Core) GenerateSecrets

func (c *Core) GenerateSecrets(
	secrets map[string]manifest.Secret, id uuid.UUID,
	parentCertificate *x509.Certificate, parentPrivKey *ecdsa.PrivateKey, rootPrivK *ecdsa.PrivateKey,
) (map[string]manifest.Secret, error)

GenerateSecrets generates secrets for the given manifest and parent certificate.

func (*Core) GetQuote

func (c *Core) GetQuote() []byte

GetQuote returns the quote of the Coordinator.

func (*Core) GetState

func (c *Core) GetState(ctx context.Context) (state.State, string, error)

GetState returns the current state of the Coordinator.

func (*Core) GetTLSConfig

func (c *Core) GetTLSConfig() (*tls.Config, error)

GetTLSConfig gets the core's TLS configuration.

func (*Core) GetTLSMarbleRootCertificate

func (c *Core) GetTLSMarbleRootCertificate(clientHello *tls.ClientHelloInfo) (*tls.Certificate, error)

GetTLSMarbleRootCertificate creates a TLS certificate for the Coordinator's x509 marbleRoot certificate.

This function initializes a read transaction and should not be called from other functions with ongoing transactions.

func (*Core) GetTLSRootCertificate

func (c *Core) GetTLSRootCertificate(clientHello *tls.ClientHelloInfo) (*tls.Certificate, error)

GetTLSRootCertificate creates a TLS certificate for the Coordinators self-signed x509 certificate.

This function initializes a read transaction and should not be called from other functions with ongoing transactions.

func (*Core) RequireState

func (c *Core) RequireState(ctx context.Context, states ...state.State) error

RequireState checks if the Coordinator is in one of the given states. This function locks the Core's mutex and therefore should be paired with `defer c.mux.Unlock()`.

func (*Core) Unlock

func (c *Core) Unlock()

Unlock the Core's mutex.

type CounterVec

type CounterVec interface {
	BaseVec

	GetMetricWith(labels prometheus.Labels) (prometheus.Counter, error)
	GetMetricWithLabelValues(lvs ...string) (prometheus.Counter, error)
	With(labels prometheus.Labels) prometheus.Counter
	WithLabelValues(lvs ...string) prometheus.Counter
}

CounterVec is a vector of metrics.

type NullBaseVec

type NullBaseVec struct {
	NullCollector
}

NullBaseVec implements BaseVec but does nothing.

func (NullBaseVec) Delete

func (NullBaseVec) Delete(_ prometheus.Labels) bool

Delete implements BaseVec.

func (NullBaseVec) DeleteLabelValues

func (NullBaseVec) DeleteLabelValues(_ ...string) bool

DeleteLabelValues implements BaseVec.

func (NullBaseVec) Reset

func (NullBaseVec) Reset()

Reset implements BaseVec.

type NullCollector

type NullCollector struct{}

NullCollector implements prometheus.Collector but does nothing.

func (NullCollector) Collect

func (NullCollector) Collect(chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (NullCollector) Describe

func (NullCollector) Describe(chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

type NullCounter

type NullCounter struct {
	NullMetric
	NullCollector
}

NullCounter implements prometheus.Counter but does nothing.

func (NullCounter) Add

func (NullCounter) Add(float64)

Add implements prometheus.Counter.

func (NullCounter) Inc

func (NullCounter) Inc()

Inc implements prometheus.Counter.

type NullCounterVec

type NullCounterVec struct {
	NullBaseVec
}

NullCounterVec implements CounterVec but does nothing.

func (NullCounterVec) GetMetricWith

func (NullCounterVec) GetMetricWith(_ prometheus.Labels) (prometheus.Counter, error)

GetMetricWith implements CounterVec.

func (NullCounterVec) GetMetricWithLabelValues

func (NullCounterVec) GetMetricWithLabelValues(_ ...string) (prometheus.Counter, error)

GetMetricWithLabelValues implements CounterVec.

func (NullCounterVec) With

func (NullCounterVec) With(_ prometheus.Labels) prometheus.Counter

With implements CounterVec.

func (NullCounterVec) WithLabelValues

func (NullCounterVec) WithLabelValues(_ ...string) prometheus.Counter

WithLabelValues implements CounterVec.

type NullMetric

type NullMetric struct{}

NullMetric implements prometheus.Metric but does nothing.

func (NullMetric) Desc

func (NullMetric) Desc() *prometheus.Desc

Desc implements prometheus.Metric.

func (NullMetric) Write

func (NullMetric) Write(*dto.Metric) error

Write implements prometheus.Metric.

type QuoteError

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

QuoteError is returned when the quote could not be retrieved.

func (QuoteError) Error

func (e QuoteError) Error() string

Error returns the error message.