server

Documentation

Overview

Package server implements the Katzenpost non-voting authority server.

The non-voting authority server is intended to be a stop gap for debugging and testing and is likely only suitable for very small networks where the lack of distributed trust and or quality of life features is a non-issue.

Index

• Variables
• type Server
  • func New(cfg *config.Config) (*Server, error)
  • func (s *Server) IdentityKey() *eddsa.PublicKey
  • func (s *Server) RotateLog()
  • func (s *Server) Shutdown()
  • func (s *Server) Wait()

Variables

var ErrGenerateOnly = errors.New("server: GenerateOnly set")

ErrGenerateOnly is the error returned when the server initialization terminates due to the `GenerateOnly` debug config option.

Types

type Server

type Server struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

Server is a non-voting authority server instance.

func New

func New(cfg *config.Config) (*Server, error)

New returns a new Server instance parameterized with the specific configuration.

func (*Server) IdentityKey

func (s *Server) IdentityKey() *eddsa.PublicKey

IdentityKey returns the running Server's identity public key.

func (*Server) RotateLog

func (s *Server) RotateLog()

RotateLog rotates the log file if logging to a file is enabled.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown cleanly shuts down a given Server instance.

func (*Server) Wait

func (s *Server) Wait()

Wait waits till the server is terminated for any reason.