cluster

Documentation

Index

• Constants
• Variables
• type Client
• type ClusterHook
• type Handler
• type Listener
  • func NewListener(addrs []*net.TCPAddr, cipherSuites []uint16, logger log.Logger) *Listener
  • func (cl *Listener) AddClient(alpn string, client Client)
  • func (cl *Listener) AddHandler(alpn string, handler Handler)
  • func (cl *Listener) Addr() net.Addr
  • func (cl *Listener) Addrs() []*net.TCPAddr
  • func (cl *Listener) Handler(alpn string) (Handler, bool)
  • func (cl *Listener) RemoveClient(alpn string)
  • func (cl *Listener) Run(ctx context.Context) error
  • func (cl *Listener) Server() *http2.Server
  • func (cl *Listener) Stop()
  • func (cl *Listener) StopHandler(alpn string)
  • func (cl *Listener) TLSConfig(ctx context.Context) (*tls.Config, error)

Constants

const (
	ListenerAcceptDeadline = 500 * time.Millisecond
)

Variables

var (
	// Making this a package var allows tests to modify
	HeartbeatInterval = 5 * time.Second
)

Types

type Client

type Client interface {
	ClientLookup(context.Context, *tls.CertificateRequestInfo) (*tls.Certificate, error)
}

Client is used to lookup a client certificate.

type ClusterHook

type ClusterHook interface {
	AddClient(alpn string, client Client)
	RemoveClient(alpn string)
	AddHandler(alpn string, handler Handler)
	StopHandler(alpn string)
	TLSConfig(ctx context.Context) (*tls.Config, error)
	Addr() net.Addr
}

type Handler

type Handler interface {
	ServerLookup(context.Context, *tls.ClientHelloInfo) (*tls.Certificate, error)
	CALookup(context.Context) ([]*x509.Certificate, error)

	// Handoff is used to pass the connection lifetime off to
	// the handler
	Handoff(context.Context, *sync.WaitGroup, chan struct{}, *tls.Conn) error
	Stop() error
}

Handler exposes functions for looking up TLS configuration and handing off a connection for a cluster listener application.

type Listener

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

Listener is the source of truth for cluster handlers and connection clients. It dynamically builds the cluster TLS information. It's also responsible for starting tcp listeners and accepting new cluster connections.

func NewListener

func NewListener(addrs []*net.TCPAddr, cipherSuites []uint16, logger log.Logger) *Listener

func (*Listener) AddClient

func (cl *Listener) AddClient(alpn string, client Client)

AddClient adds a new client for an ALPN name

func (*Listener) AddHandler

func (cl *Listener) AddHandler(alpn string, handler Handler)

AddHandler registers a new cluster handler for the provided ALPN name.

func (*Listener) Addr

func (cl *Listener) Addr() net.Addr

TODO: This probably isn't correct

func (*Listener) Addrs

func (cl *Listener) Addrs() []*net.TCPAddr

func (*Listener) Handler

func (cl *Listener) Handler(alpn string) (Handler, bool)

Handler returns the handler for the provided ALPN name

func (*Listener) RemoveClient

func (cl *Listener) RemoveClient(alpn string)

RemoveClient removes the client for the specified ALPN name

func (*Listener) Run

func (cl *Listener) Run(ctx context.Context) error

Run starts the tcp listeners and will accept connections until stop is called. This function blocks so should be called in a goroutine.

func (*Listener) Server

func (cl *Listener) Server() *http2.Server

Server returns the http2 server that the cluster listener is using

func (*Listener) Stop

func (cl *Listener) Stop()

Stop stops the cluster listner

func (*Listener) StopHandler

func (cl *Listener) StopHandler(alpn string)

StopHandler stops the cluster handler for the provided ALPN name, it also calls stop on the handler.

func (*Listener) TLSConfig

func (cl *Listener) TLSConfig(ctx context.Context) (*tls.Config, error)

TLSConfig returns a tls config object that uses dynamic lookups to correctly authenticate registered handlers/clients