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 (cfg *Config) GetLogger() (*zap.Logger, 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 Log
• type Permissions
  • func (p Permissions) Allowed(r *request, fileExists func(string) bool) bool
  • func (p Permissions) AllowedDestination(r *request, fileExists func(string) bool) bool
  • func (p *Permissions) UnmarshalText(data []byte) error
• type Rule
  • func (r *Rule) Matches(path string) bool
  • func (r *Rule) Validate() error
• type RulesBehavior
• type User
  • func (u *User) Validate(noPassword bool) error
• type UserPermissions
  • func (p UserPermissions) Allowed(r *request, fileExists func(string) bool) bool
  • func (p *UserPermissions) Validate() error

Constants

const (
	DefaultTLS     = false
	DefaultCert    = "cert.pem"
	DefaultKey     = "key.pem"
	DefaultAddress = "0.0.0.0"
	DefaultPort    = 6065
	DefaultPrefix  = "/"
)

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 {
	UserPermissions `mapstructure:",squash"`
	Debug           bool
	Address         string
	Port            int
	TLS             bool
	Cert            string
	Key             string
	Prefix          string
	NoSniff         bool
	NoPassword      bool
	BehindProxy     bool
	Log             Log
	CORS            CORS
	Users           []User
}

func ParseConfig

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

func (*Config) GetLogger

func (cfg *Config) GetLogger() (*zap.Logger, 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 Log

type Log struct {
	Format  string
	Colors  bool
	Outputs []string
}

type Permissions

type Permissions struct {
	Create bool
	Read   bool
	Update bool
	Delete bool
}

func (Permissions) Allowed

func (p Permissions) Allowed(r *request, fileExists func(string) bool) bool

Allowed returns whether this permission set has permissions to execute this request in the source directory. This applies to all requests with all methods.

func (Permissions) AllowedDestination

func (p Permissions) AllowedDestination(r *request, fileExists func(string) bool) bool

AllowedDestination returns whether this permissions set has permissions to execute this request in the destination directory. This only applies for COPY and MOVE requests.

func (*Permissions) UnmarshalText

func (p *Permissions) UnmarshalText(data []byte) error

type Rule

type Rule struct {
	Permissions Permissions
	Path        string
	Regex       *regexp.Regexp
}

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 RulesBehavior

type RulesBehavior string

const (
	RulesOverwrite RulesBehavior = "overwrite"
	RulesAppend    RulesBehavior = "append"
)

type User

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

func (*User) Validate

func (u *User) Validate(noPassword bool) error

type UserPermissions

type UserPermissions struct {
	Directory     string
	Permissions   Permissions
	Rules         []*Rule
	RulesBehavior RulesBehavior
}

func (UserPermissions) Allowed

func (p UserPermissions) Allowed(r *request, fileExists func(string) bool) bool

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

func (*UserPermissions) Validate

func (p *UserPermissions) Validate() error