lib

Documentation

Index

• Constants
• func NewHandler(c *Config) (http.Handler, error)
• type CORS
• type Config
  • func ParseConfig(filename string, flags *pflag.FlagSet) (*Config, error)
  • func (c *Config) Validate() error
• type Dir
  • func (d Dir) OpenFile(ctx context.Context, name string, flag int, perm os.FileMode) (webdav.File, error)
  • func (d Dir) Stat(ctx context.Context, name string) (os.FileInfo, error)
• type Handler
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Permissions
  • func (p Permissions) Allowed(r *http.Request) bool
  • func (p *Permissions) Validate() error
• type Rule
  • func (r *Rule) Matches(path string) bool
  • func (r *Rule) Validate() error
• type User
  • func (u *User) Validate() error

Constants

const (
	DefaultScope     = "/"
	DefaultModify    = false
	DefaultDebug     = false
	DefaultNoSniff   = false
	DefaultTLS       = false
	DefaultAuth      = false
	DefaultCert      = "cert.pem"
	DefaultKey       = "key.pem"
	DefaultAddress   = "0.0.0.0"
	DefaultPort      = 0
	DefaultPrefix    = "/"
	DefaultLogFormat = "console"
)

Functions

func NewHandler

func NewHandler(c *Config) (http.Handler, error)

Types

type CORS

type CORS struct {
	Enabled        bool
	Credentials    bool
	AllowedHeaders []string `mapstructure:"allowed_headers"`
	AllowedHosts   []string `mapstructure:"allowed_hosts"`
	AllowedMethods []string `mapstructure:"allowed_methods"`
	ExposedHeaders []string `mapstructure:"exposed_headers"`
}

type Config

type Config struct {
	Permissions `mapstructure:",squash"`
	Debug       bool
	Address     string
	Port        int
	TLS         bool
	Cert        string
	Key         string
	Prefix      string
	NoSniff     bool
	LogFormat   string `mapstructure:"log_format"`
	Auth        bool
	CORS        CORS
	Users       []User
}

func ParseConfig

func ParseConfig(filename string, flags *pflag.FlagSet) (*Config, error)

func (*Config) Validate

func (c *Config) Validate() error

type Dir

type Dir struct {
	webdav.Dir
	// contains filtered or unexported fields
}

func (Dir) OpenFile

func (d Dir) OpenFile(ctx context.Context, name string, flag int, perm os.FileMode) (webdav.File, error)

func (Dir) Stat

func (d Dir) Stat(ctx context.Context, name string) (os.FileInfo, error)

type Handler

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

func (*Handler) ServeHTTP

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

ServeHTTP determines if the request is for this plugin, and if all prerequisites are met.

type Permissions

type Permissions struct {
	Scope  string
	Modify bool
	Rules  []*Rule
}

func (Permissions) Allowed

func (p Permissions) Allowed(r *http.Request) bool

Allowed checks if the user has permission to access a directory/file

func (*Permissions) Validate

func (p *Permissions) Validate() error

type Rule

type Rule struct {
	Regex  bool
	Allow  bool
	Modify bool
	Path   string
	// TODO: remove Regex and replace by this. It encodes
	Regexp *regexp.Regexp `mapstructure:"-"`
}

func (*Rule) Matches

func (r *Rule) Matches(path string) bool

Matches checks if Rule matches the given path.

func (*Rule) Validate

func (r *Rule) Validate() error

type User

type User struct {
	Permissions `mapstructure:",squash"`
	Username    string
	Password    string
}

func (*User) Validate

func (u *User) Validate() error