web

type AuthHandler ¶

type AuthHandler[Entity any] struct {
	KeyHeaderName    string
	SecretHeaderName string
	BasicAuthRealm   string

	// Handler will be used if AuthFunc is successful.
	Handler http.Handler
	// UnauthorizedHandler will be used if AuthFunc is not successful.
	UnauthorizedHandler http.Handler
	// ErrorHandler will be used if there is an error. If it is nil, a panic will occur.
	ErrorHandler func(w http.ResponseWriter, r *http.Request, err error)

	// AuthFunc validates credentials. It should return if credentials are valid,
	// and optional entity which will be passed to PostAuthFunc.
	AuthFunc func(r *http.Request, key, secret string) (valid bool, entity Entity, err error)
	// PostAuthFunc is a hook to log, set request context or preform any other action
	// after credentials check. If not nil, it is always called, regardless of other
	// configurations. It provides access to response writer, request and returned
	// information from the AuthFunc: valid and entity.
	PostAuthFunc func(w http.ResponseWriter, r *http.Request, valid bool, entity Entity) (rr *http.Request, err error)

	// AuthorizeAll will bypass all methods and authorize all requests.
	AuthorizeAll bool
	// AuthorizedNetworks are network ranges from where requests are authorized
	// without credentials check. Only address from request's RemoteAddr will be
	// checked.
	AuthorizedNetworks []net.IPNet
	// TrustedProxyNetworks are network ranges that are trusted to provide a valid
	// X-Forwarded-For and X-Real-Ip headers that will be validated against
	// the AuthorizedNetworks list.
	TrustedProxyNetworks []net.IPNet
}

AuthHandler is a net/http Handler that can be configured to check credentials from custom Key and Secret HTTP headers, or Basic auth from Authorization header. Depending on configuration of BasicAuthRealm, KeyHeaderName or SecretHeaderName, it can be used as"

• Basic auth handler - only BasicAuthRealm is set
• single API key auth handler - only KeyHeaderName is set
• single API key auth handler with Basic auth support - BasicAuthRealm and KeyHeaderName are set
• public/secret API key auth handler - KeyHeaderName and SecretHeaderName are set
• public/secret API key auth handler with Basic auth support - all three are set

By setting AuthorizedNetworks, this handler can authorize requests based only on RemoteAddr address.

func (h AuthHandler[Entity]) ServeHTTP(w http.ResponseWriter, r *http.Request)

type FormErrors ¶

type FormErrors struct {
	Errors      []string            `json:"errors,omitempty"`
	FieldErrors map[string][]string `json:"field_errors,omitempty"`
}

FormErrors represent structure errors returned by API server to request based on HTML form data.

func NewError(e string) FormErrors

func NewFieldError(field, e string) FormErrors

func (f *FormErrors) AddError(e string)

func (f *FormErrors) AddFieldError(field, e string)

func (f FormErrors) HasErrors() bool

type MaxBodyBytesHandler ¶

type MaxBodyBytesHandler struct {
	// Handler will be used if limit is not reached.
	Handler http.Handler
	// Limit is a maximum number of bytes that a request body can have.
	Limit int64
	// BodyFunc response will be written as the response.
	BodyFunc func(r *http.Request) (string, error)
	// ContentType will be used as a value for
	ContentType string
	// ErrorHandler will be used if there is an error from BodyFunc. If it is nil,
	// a panic will occur.
	ErrorHandler func(w http.ResponseWriter, r *http.Request, err error)
}

MaxBodyBytesHandler blocks requests with body size greater then specified, by responding with a request entity too large 513 HTTP response. It is a wrapper around http.MaxBytesReader to also check Content-Length header and and multipart form requests.

func (h MaxBodyBytesHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ResponseStatusRecorder ¶ added in v0.5.2

type ResponseStatusRecorder struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

ResponseStatusRecorder implements http.ResponseWriter that keeps tack of HTTP response status code and written body size in bytes.

func NewResponseStatusRecorder(w http.ResponseWriter) *ResponseStatusRecorder

func (r *ResponseStatusRecorder) Flush()

func (r *ResponseStatusRecorder) Hijack() (net.Conn, *bufio.ReadWriter, error)

func (r *ResponseStatusRecorder) Push(target string, opts *http.PushOptions) error

func (r *ResponseStatusRecorder) ReadFrom(src io.Reader) (int64, error)

func (r *ResponseStatusRecorder) ResponseBodySize() int

func (r *ResponseStatusRecorder) Status() int

func (r *ResponseStatusRecorder) Write(b []byte) (int, error)

func (r *ResponseStatusRecorder) WriteHeader(s int)

type RoundTripperFunc ¶ added in v0.1.2

type RoundTripperFunc func(*http.Request) (*http.Response, error)

RoundTripperFunc type is an adapter to allow the use of ordinary functions as RoundTripper interfaces. If f is a function with the appropriate signature, RoundTripperFunc(f) is a RoundTripper that calls f.

Example to set User-Agent header for every request made by Client:

httpClient := &http.Client{
	Transport: RoundTripperFunc(func(r *http.Request) (*http.Response, error) {
		r.Header.Set("User-Agent", "a clockwork orange")
		return http.DefaultTransport.RoundTrip(r)
	}),
}

func (f RoundTripperFunc) RoundTrip(r *http.Request) (*http.Response, error)

type TCPKeepAliveListener ¶

type TCPKeepAliveListener struct {
	*net.TCPListener
}

TCPKeepAliveListener sets TCP keep alive period.

func NewTCPKeepAliveListener(listener *net.TCPListener) TCPKeepAliveListener

func (ln TCPKeepAliveListener) Accept() (c net.Conn, err error)

type TLSListener ¶

type TLSListener struct {
	*net.TCPListener
	TLSConfig *tls.Config
}

TLSListener is a TCP listener that will check if the connection should be encrypted, and return encrypted connection, and if not, to return plain connection. It can be used along with HTTPToHTTPSRedirectHandler, to automatically redirect users from http:// to https:// protocol, by checking if http.Request has TLS equal to nil. Or to provide provide a different content in case that client provided or not TLS connection.

func (l TLSListener) Accept() (net.Conn, error)