firewall

Documentation

Index

• type Attempt
• type Config
  • func Enabled(enabled ...bool) Config
  • func Groups(groups ...string) Config
  • func Matchers(matchers ...*regexp.Regexp) Config
  • func Name(name string) Config
  • func Paths(paths ...string) Config
  • func Redirect(redirect string) Config
  • func Roles(roles ...auth.Role) Config
  • func Secret(secret string) Config
• type Firewall
  • func New(configs ...Config) *Firewall
  • func (f *Firewall) Match(path string) bool
  • func (f *Firewall) MatchGroup(group string) bool
  • func (f *Firewall) MatchPath(path string) bool
  • func (f *Firewall) Try(attempt Attempt) Result
• type Result

Types

type Attempt

type Attempt struct {
	Roles  []auth.Role
	Secret string
}

type Config

type Config interface {
}

func Enabled

func Enabled(enabled ...bool) Config

func Groups

func Groups(groups ...string) Config

func Matchers

func Matchers(matchers ...*regexp.Regexp) Config

func Name

func Name(name string) Config

func Paths

func Paths(paths ...string) Config

func Redirect

func Redirect(redirect string) Config

func Roles

func Roles(roles ...auth.Role) Config

func Secret

func Secret(secret string) Config

type Firewall

type Firewall struct {
	Enabled  bool
	Name     string
	Groups   []string
	Matchers []*regexp.Regexp
	Paths    []string
	Redirect string
	Roles    []auth.Role
	Secret   string
}

func New

func New(configs ...Config) *Firewall

func (*Firewall) Match

func (f *Firewall) Match(path string) bool

func (*Firewall) MatchGroup

func (f *Firewall) MatchGroup(group string) bool

func (*Firewall) MatchPath

func (f *Firewall) MatchPath(path string) bool

func (*Firewall) Try

func (f *Firewall) Try(attempt Attempt) Result

type Result

type Result struct {
	Ok       bool
	Err      error
	Redirect string
}