Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

controller

package

Go to main page

Versions in this module

v0

v0.2.0

Nov 12, 2026

Changes in this version

type Config

+ AuditAppend bool

+ AuditQueue int

+ AuditSyncWindow time.Duration

+ AuditWhenFull string

+ Limits policy.Limits

+ Network *forward.Network

+ ReloadCertificate func()

+ ReloadKeys func() (pipeline.TrustConfig, *forward.Network, error)

type Controller

+ func (c *Controller) Network() *forward.Network

v0.1.0

Nov 8, 2026

Changes in this version

+ const DefaultAuditWait

+ const DefaultIdle

+ const DefaultLifetime

+ const MaxAuditBytes

+ const MaxAuditFiles

+ const MaxSession

+ const MinAuditBytes

+ const MinSession

+ const ShutdownWait

+ func CandidateGeneration(p policy.Policy, parent int64, overrides []store.Override) (*compile.Generation, error)

+ type Change struct

+ Expected int64

+ ID string

+ Policy json.RawMessage

+ type Config struct

+ AdminIdleTimeout time.Duration

+ AdminListen string

+ AdminSessionLifetime time.Duration

+ AuditLog string

+ AuditMaxBytes int64

+ AuditMaxFiles int

+ AuditTimeout time.Duration

+ Database string

+ JWT pipeline.TrustConfig

+ ReloadTrust func() (pipeline.TrustConfig, error)

+ func (cfg Config) Check() error

+ type Controller struct

+ func Prepare(cfg Config, logger *slog.Logger) (*Controller, error)

+ func (c *Controller) Activate(ctx context.Context, t store.TransitionRecord, candidate int64, ...) (Outcome, int)

+ func (c *Controller) Addresses() *store.BlockedAddresses

+ func (c *Controller) Admission() string

+ func (c *Controller) Audit() *audit.AuditLog

+ func (c *Controller) BeginStop()

+ func (c *Controller) Block(ctx context.Context, t store.TransitionRecord, reason string) (json.RawMessage, int)

+ func (c *Controller) BlockAddress(ctx context.Context, t store.TransitionRecord, entry store.BlockedAddress) (json.RawMessage, int)

+ func (c *Controller) Blocked() *store.BlockedAccounts

+ func (c *Controller) Capture(ctx context.Context) (*compile.Generation, store.Authority, error)

+ func (c *Controller) ChangePassword(ctx context.Context, admin store.Administrator, passwordHash string) (Outcome, int)

+ func (c *Controller) CreateOverride(ctx context.Context, t store.TransitionRecord, request OverrideRequest) (Outcome, int)

+ func (c *Controller) Current() *compile.Generation

+ func (c *Controller) Enrol(ctx context.Context, e store.Enrolment, passwordHash string) (Outcome, int)

+ func (c *Controller) EstablishBase(ctx context.Context, kind, actor string, candidate int64, checksum string) (Outcome, int)

+ func (c *Controller) Expired(g *compile.Generation)

+ func (c *Controller) Gauges() (revision int64, overrides, blocked int)

+ func (c *Controller) Observations() *monitor.Observations

+ func (c *Controller) Open() error

+ func (c *Controller) Publish(ctx context.Context, actor string, change Change) (Outcome, int)

+ func (c *Controller) Reads() store.Reads

+ func (c *Controller) ReloadKeys(ctx context.Context, t store.TransitionRecord) (json.RawMessage, int)

+ func (c *Controller) Resolve(ctx context.Context, t store.TransitionRecord, provisional int64, ...) (Outcome, int)

+ func (c *Controller) RevokeOverride(ctx context.Context, t store.TransitionRecord, id int64) (Outcome, int)

+ func (c *Controller) Sessions() *session.Table

+ func (c *Controller) Settings() Config

+ func (c *Controller) StageCandidate(ctx context.Context, t store.TransitionRecord, document []byte) (Outcome, int)

+ func (c *Controller) Start(admin http.Handler) error

+ func (c *Controller) State() string

+ func (c *Controller) Stop() error

+ func (c *Controller) StopWithin(ctx context.Context) error

+ func (c *Controller) Unblock(ctx context.Context, t store.TransitionRecord) (json.RawMessage, int)

+ func (c *Controller) UnblockAddress(ctx context.Context, t store.TransitionRecord, entry store.BlockedAddress) (json.RawMessage, int)

+ func (c *Controller) ValidateOverride(ctx context.Context, actor string, expected int64, request OverrideRequest) (Outcome, int)

+ func (c *Controller) Verifier() *pipeline.Verifier

+ func (c *Controller) WithdrawCandidate(ctx context.Context, t store.TransitionRecord, id int64) (Outcome, int)

+ type Outcome struct

+ Candidate int64

+ Deadline time.Time

+ Disposition string

+ Expires time.Time

+ Field string

+ Generation string

+ Outcome string

+ Override int64

+ Provisional int64

+ Reason string

+ Revision int64

+ RollbackTarget int64

+ Target string

+ Transition string

+ type OverrideRequest struct

+ Control string

+ Count *int64

+ ExpiresInSeconds int64

+ Operation string

+ Role *string

+ Type string