svid

Documentation

Index

• Constants
• type Observer
• type ObserverFunc
  • func (fn ObserverFunc) State() State
• type Rotator
  • func NewRotator(c *RotatorConfig) *Rotator
  • func (r *Rotator) Initialize(ctx context.Context) error
  • func (r *Rotator) Interval() time.Duration
  • func (r *Rotator) Run(ctx context.Context) error
  • func (r *Rotator) State() State
  • func (r *Rotator) Subscribe() observer.Stream
• type RotatorConfig
• type State

Constants

const (
	DefaultRotatorInterval = 5 * time.Second
)

Types

type Observer

type Observer interface {
	State() State
}

Observer is a convenience interface for subsystems that only want to observer the current SVID state but don't care about other rotator methods.

type ObserverFunc

type ObserverFunc func() State

func (ObserverFunc) State

func (fn ObserverFunc) State() State

type Rotator

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

func NewRotator

func NewRotator(c *RotatorConfig) *Rotator

func (*Rotator) Initialize

func (r *Rotator) Initialize(ctx context.Context) error

Start generates a new SVID and then starts the rotator.

func (*Rotator) Interval

func (r *Rotator) Interval() time.Duration

func (*Rotator) Run

func (r *Rotator) Run(ctx context.Context) error

Run starts a ticker which monitors the server SVID for expiration and rotates the SVID as necessary.

func (*Rotator) State

func (r *Rotator) State() State

func (*Rotator) Subscribe

func (r *Rotator) Subscribe() observer.Stream

type RotatorConfig

type RotatorConfig struct {
	Log         logrus.FieldLogger
	Metrics     telemetry.Metrics
	TrustDomain spiffeid.TrustDomain
	ServerCA    ca.ServerCA
	Clock       clock.Clock
	KeyType     keymanager.KeyType

	// How long to wait between expiry checks
	Interval time.Duration
}

type State

type State struct {
	SVID []*x509.Certificate
	Key  crypto.Signer
}

State is the current SVID and key