filter

Documentation

Index

• Constants
• func RegisterNewFilterFunc(filterType string, fn NewFilterFunc)
• type BasicAuthFilter
  • func (f *BasicAuthFilter) Request(ctx *fasthttp.RequestCtx) bool
  • func (f *BasicAuthFilter) Response(ctx *fasthttp.RequestCtx) bool
• type BasicAuthUser
• type Filter
  • func NewBasicAuthFilter(cfg tree.Map) (Filter, error)
  • func NewFilter(cfg tree.Map) (Filter, error)
  • func NewHeaderFilter(cfg tree.Map) (Filter, error)
• type FilterDelegator
  • func (d *FilterDelegator) Request(ctx *fasthttp.RequestCtx) bool
  • func (d *FilterDelegator) Response(ctx *fasthttp.RequestCtx) bool
• type HeaderFilter
  • func (f *HeaderFilter) Request(ctx *fasthttp.RequestCtx) bool
  • func (f *HeaderFilter) Response(ctx *fasthttp.RequestCtx) bool
• type NewFilterFunc

Constants

const (
	DefaultRealm = "Restricted"
)

Functions

func RegisterNewFilterFunc

func RegisterNewFilterFunc(filterType string, fn NewFilterFunc)

RegisterNewFilterFunc registers a NewFilterFunc with filterType.

Types

type BasicAuthFilter

type BasicAuthFilter struct {
	Realm     string           `yaml:"realm"`
	Users     []*BasicAuthUser `yaml:"users"`
	UsersFile string           `yaml:"usersFile"`
}

BasicAuthFilter implements Filter.

func (*BasicAuthFilter) Request

func (f *BasicAuthFilter) Request(ctx *fasthttp.RequestCtx) bool

Request examines the Authorization header of the given ctx and matches it against the user it holds. If the user does not match, it sets 401 Unauthorized and returns false.

func (*BasicAuthFilter) Response

func (f *BasicAuthFilter) Response(ctx *fasthttp.RequestCtx) bool

Response dose nothing and returns true.

type BasicAuthUser

type BasicAuthUser struct {
	Name   string `yaml:"name"`
	Secret string `yaml:"secret"`
	// contains filtered or unexported fields
}

BasicAuthUser represents a basic auth user.

type Filter

type Filter interface {
	// Request filters before handling request context. If it returns false,
	// further processing will stop.
	Request(ctx *fasthttp.RequestCtx) bool
	// Response filters after handling request context. If it returns false,
	// further processing will stop.
	Response(ctx *fasthttp.RequestCtx) bool
}

Filter represents a filter that defines to filter request and response.

func NewBasicAuthFilter

func NewBasicAuthFilter(cfg tree.Map) (Filter, error)

NewBasicAuthFilter returns a new BasicAuthFilter.

func NewFilter

func NewFilter(cfg tree.Map) (Filter, error)

NewFilter returns a new filter.

func NewHeaderFilter

func NewHeaderFilter(cfg tree.Map) (Filter, error)

NewHeaderFilter returns a new HeaderFilter.

type FilterDelegator

type FilterDelegator struct {
	RequestFunc  func(ctx *fasthttp.RequestCtx) bool
	ResponseFunc func(ctx *fasthttp.RequestCtx) bool
}

FilterDelegator can delegate the Filter functions.

func (*FilterDelegator) Request

func (d *FilterDelegator) Request(ctx *fasthttp.RequestCtx) bool

func (*FilterDelegator) Response

func (d *FilterDelegator) Response(ctx *fasthttp.RequestCtx) bool

type HeaderFilter

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

HeaderFilter implements the Filter that filters headers of request and response.

func (*HeaderFilter) Request

func (f *HeaderFilter) Request(ctx *fasthttp.RequestCtx) bool

Request filters ctx.Request.Header.

func (*HeaderFilter) Response

func (f *HeaderFilter) Response(ctx *fasthttp.RequestCtx) bool

Response filters ctx.Response.Header.

type NewFilterFunc

type NewFilterFunc func(cfg tree.Map) (Filter, error)

NewFilterFunc is a function that returns a new filter.