tls

Documentation

Index

• Variables
• type CertWatcher
  • func NewCertWatcher(certPath, keyPath, caPath string, logger *zap.Logger) (*CertWatcher, error)
  • func (cw *CertWatcher) GetTLSConfig() *tls.Config
  • func (cw *CertWatcher) ReadTlsConfig() error
  • func (cw *CertWatcher) RegisterCallback(callback func())
  • func (cw *CertWatcher) Start(ctx context.Context) error
  • func (cw *CertWatcher) Watch()
• type ClientConfig
  • func (c *ClientConfig) TLSConfig() (*tls.Config, error)
• type ServerConfig
  • func (c *ServerConfig) TLSConfig() (*tls.Config, error)

Variables

var NewCertWatcherFunc = NewCertWatcher

Types

type CertWatcher

type CertWatcher struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

CertWatcher watches certificate and key files for changes. When either file changes, it reads and parses both and calls an optional callback with the new certificate.

func NewCertWatcher

func NewCertWatcher(certPath, keyPath, caPath string, logger *zap.Logger) (*CertWatcher, error)

NewCertWatcher returns a new CertWatcher watching the given server certificate and client certificate.

func (*CertWatcher) GetTLSConfig

func (cw *CertWatcher) GetTLSConfig() *tls.Config

GetTLSConfig fetches the currently loaded tls Config, which may be nil.

func (*CertWatcher) ReadTlsConfig

func (cw *CertWatcher) ReadTlsConfig() error

func (*CertWatcher) RegisterCallback

func (cw *CertWatcher) RegisterCallback(callback func())

RegisterCallback registers a callback to be invoked when the certificate changes.

func (*CertWatcher) Start

func (cw *CertWatcher) Start(ctx context.Context) error

Start starts the watch on the certificate and key files.

func (*CertWatcher) Watch

func (cw *CertWatcher) Watch()

Watch reads events from the watcher's channel and reacts to changes.

type ClientConfig

type ClientConfig struct {
	TLSCA              string `toml:"tls_ca"`
	TLSCert            string `toml:"tls_cert"`
	TLSKey             string `toml:"tls_key"`
	InsecureSkipVerify bool   `toml:"insecure_skip_verify"`

	// Deprecated in 1.7; use TLS variables above
	SSLCA   string `toml:"ssl_ca"`
	SSLCert string `toml:"ssl_cert"`
	SSLKey  string `toml:"ssl_key"`
}

ClientConfig represents the standard client TLS config.

func (*ClientConfig) TLSConfig

func (c *ClientConfig) TLSConfig() (*tls.Config, error)

TLSConfig returns a tls.Config, may be nil without error if TLS is not configured.

type ServerConfig

type ServerConfig struct {
	TLSCert           string   `toml:"tls_cert"`
	TLSKey            string   `toml:"tls_key"`
	TLSAllowedCACerts []string `toml:"tls_allowed_cacerts"`
}

ServerConfig represents the standard server TLS config.

func (*ServerConfig) TLSConfig

func (c *ServerConfig) TLSConfig() (*tls.Config, error)

TLSConfig returns a tls.Config, may be nil without error if TLS is not configured.