server

Documentation

Index

• func Listen(network, addr string, options ...ListenerOption) (net.Listener, error)
• type ListenerConfig
• type ListenerOption
  • func WithCertificateSource(certificateSource servertls.CertificateSource) ListenerOption
  • func WithTLSCipherSuites(suites []string) ListenerOption
  • func WithTLSMinVersion(version string) ListenerOption

Functions

func Listen

func Listen(network, addr string, options ...ListenerOption) (net.Listener, error)

Listen will listen on a given network and port, with additional options available for enabling TLS and obtaining certificates.

Types

type ListenerConfig

type ListenerConfig struct {
	TLSEnabled bool
	TLSConfig  tls.Config
}

ListenerConfig defines the config of the listener, this mainly deals with configuring the TLSConfig

type ListenerOption

type ListenerOption func(*ListenerConfig) error

ListenerOption is function used to mutate the config, it allows for convenience methods such as WithCertificateSource

func WithCertificateSource

func WithCertificateSource(certificateSource servertls.CertificateSource) ListenerOption

WithCertificateSource specifies the certificate source for TLS, this also implicitly enables TLS for the listener when not nil

func WithTLSCipherSuites

func WithTLSCipherSuites(suites []string) ListenerOption

WithTLSCipherSuites specifies the allowed ciper suites, when an empty/nil array is passed the go defaults are used

func WithTLSMinVersion

func WithTLSMinVersion(version string) ListenerOption

WithTLSMinVersion specifies the minimum TLS version, when an empty string is passed the go defaults are used