server

Documentation

Index

• func LoadCert(tlsCfg *tls.Config, cert, key string) error
• func ReadMsgFromReq(req *http.Request) (*dns.Msg, error)
• func ServeDoQ(l *quic.Listener, h Handler, opts DoQServerOpts) error
• func ServeTCP(l net.Listener, h Handler, opts TCPServerOpts) error
• func ServeUDP(c *net.UDPConn, h Handler, opts UDPServerOpts) error
• type DoQServerOpts
• type Handler
• type HttpHandler
  • func NewHttpHandler(h Handler, opts HttpHandlerOpts) *HttpHandler
  • func (h *HttpHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type HttpHandlerOpts
• type QueryMeta
• type TCPServerOpts
• type UDPServerOpts

Functions

func LoadCert

func LoadCert(tlsCfg *tls.Config, cert, key string) error

func ReadMsgFromReq

func ReadMsgFromReq(req *http.Request) (*dns.Msg, error)

func ServeDoQ

func ServeDoQ(l *quic.Listener, h Handler, opts DoQServerOpts) error

ServeDoQ starts a server at l. It returns if l had an Accept() error. It always returns a non-nil error.

func ServeTCP

func ServeTCP(l net.Listener, h Handler, opts TCPServerOpts) error

ServeTCP starts a server at l. It returns if l had an Accept() error. It always returns a non-nil error.

func ServeUDP

func ServeUDP(c *net.UDPConn, h Handler, opts UDPServerOpts) error

ServeUDP starts a server at c. It returns if c had a read error. It always returns a non-nil error. h is required. logger is optional.

Types

type DoQServerOpts

type DoQServerOpts struct {
	Logger      *zap.Logger
	IdleTimeout time.Duration
}

type Handler

type Handler interface {
	Handle(ctx context.Context, q *dns.Msg, meta QueryMeta, packMsgPayload func(m *dns.Msg) (*[]byte, error)) (respPayload *[]byte)
}

Handler handles incoming request q and MUST ALWAYS return a response. Handler MUST handle dns errors by itself and return a proper error responses. e.g. Return a SERVFAIL if something goes wrong. If Handle() returns a nil resp, caller will udp: do nothing. tcp/dot: close the connection immediately. doh: send a 500 response. doq: close the stream immediately.

type HttpHandler

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

func NewHttpHandler

func NewHttpHandler(h Handler, opts HttpHandlerOpts) *HttpHandler

func (*HttpHandler) ServeHTTP

func (h *HttpHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type HttpHandlerOpts

type HttpHandlerOpts struct {
	// GetSrcIPFromHeader specifies the header that contain client source address.
	// e.g. "X-Forwarded-For".
	GetSrcIPFromHeader string

	// Logger specifies the logger which Handler writes its log to.
	// Default is a nop logger.
	Logger *zap.Logger
}

type QueryMeta

type QueryMeta struct {
	FromUDP bool

	// Optional
	ClientAddr netip.Addr
	ServerName string
	UrlPath    string
}

type TCPServerOpts

type TCPServerOpts struct {
	// Nil logger == nop
	Logger *zap.Logger

	// Default is defaultTCPIdleTimeout.
	IdleTimeout time.Duration
}

type UDPServerOpts

type UDPServerOpts struct {
	Logger *zap.Logger
}