spiffe

Documentation

Index

• type Helper
  • func NewHelper(config *HelperConfig) (*Helper, error)
  • func (h *Helper) CertReadyChan() <-chan struct{}
  • func (h *Helper) ProcessStarted()
  • func (h *Helper) RunDaemon(ctx context.Context)
• type HelperConfig

Types

type Helper

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

Helper is the component that consumes the Workload API and renews certs implements the interface Helper

func NewHelper

func NewHelper(config *HelperConfig) (*Helper, error)

NewHelper creates a new SPIFFE helper

func (*Helper) CertReadyChan

func (h *Helper) CertReadyChan() <-chan struct{}

CertReadyChan returns a channel to know when the trust bundle is ready

func (*Helper) ProcessStarted

func (h *Helper) ProcessStarted()

ProcessStarted is used to notify SPIFFE helper that externally manged process is ready

func (*Helper) RunDaemon

func (h *Helper) RunDaemon(ctx context.Context)

RunDaemon starts the main loop Starts the workload API client to listen for new SVID updates When a new SVID is received on the updateChan, the SVID certificates are stored in disk and a restart signal is sent to the proxy's process

type HelperConfig

type HelperConfig struct {
	AgentAddress       string
	Cmd                string
	CmdArgs            string
	CertDir            string
	SvidFileName       string
	SvidKeyFileName    string
	SvidBundleFileName string
	RenewSignal        string
	Timeout            string
	ExternalProcess    bool
	ProcessReloadFunc  func() error
}

HelperConfig contains config variables when creating a SPIFFE Helper.