From 0b7a743c299c94cf542f9423530eeb8c6450e279 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Mon, 26 Jun 2017 15:39:35 +0100 Subject: [PATCH] add caddy plugin Former-commit-id: da7aa22ac54f646dc73f62cad9e3501a59cf503e --- .github/ISSUE_TEMPLATE.md | 21 ++- .travis.yml | 2 + _assets/css/styles.css | 4 +- caddy/README.md | 164 +++++++++++++++++++++++ caddy/filemanager.go | 268 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 451 insertions(+), 8 deletions(-) create mode 100644 caddy/README.md create mode 100644 caddy/filemanager.go diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 94902d9d..ad3cfc9a 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,15 +1,24 @@ ### Instructions (remove before submitting): -1. If you are filing a bug report, please answer the following questions. -2. If your issue is not a bug report, you do not need to use this template. +1. Are you asking for help with using Caddy or File Manager? Please use our forum instead: https://forum.caddyserver.com. +2. If you are filing a bug report, please answer the following questions. +3. If your issue is not a bug report, you do not need to use this template. +4. If not using with Caddy, ignore questions 1 and 2. -### 1. What are you trying to do? +### 1. Have you downloaded File Manager from caddyserver.com? If yes, when have you done that? If no, and you are running a custom build, which is the revision of File Manager's repository? + +### 2. What is your entire Caddyfile? +```text +(Put Caddyfile here) +``` + +### 3. What are you trying to do? -### 2. What did you expect to see? +### 4. What did you expect to see? -### 3. What did you see instead (give full error messages and/or log)? +### 5. What did you see instead (give full error messages and/or log)? -### 4. How can someone who is starting from scratch reproduce this behaviour as minimally as possible? +### 6. How can someone who is starting from scratch reproduce this behaviour as minimally as possible? diff --git a/.travis.yml b/.travis.yml index b0415ea0..10d4e4b8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,5 +9,7 @@ install: - go get github.com/gordonklaus/ineffassign script: + - sed -i 's/\_ \"github.com\/mholt\/caddy\/caddyhttp\"/\_ \"github.com\/mholt\/caddy\/caddyhttp\"\n\_ \"github.com\/hacdias\/filemanager\/caddy\"/g' $GOPATH/src/github.com/mholt/caddy/caddy/caddymain/run.go + - go build github.com/mholt/caddy/caddy - go build github.com/hacdias/filemanager - ineffassign . \ No newline at end of file diff --git a/_assets/css/styles.css b/_assets/css/styles.css index 502f7748..eb1196a2 100644 --- a/_assets/css/styles.css +++ b/_assets/css/styles.css @@ -672,8 +672,8 @@ header>div div { #listing h2 { margin: 0 0 0 0.5em; - font-size: 1em; - color: rgba(0, 0, 0, 0.2); + font-size: .9em; + color: rgba(0, 0, 0, 0.38); font-weight: 500; } diff --git a/caddy/README.md b/caddy/README.md new file mode 100644 index 00000000..60072fc0 --- /dev/null +++ b/caddy/README.md @@ -0,0 +1,164 @@ +# filemanager - a caddy plugin + +filemanager provides WebDAV features and a file managing interface within the specified directory and it can be used to upload, delete, preview, rename and edit your files within that directory. It is an implementation of [hacdias/filemanager](https://github.com/hacdias/filemanager) library. + +It is extremely important for security reasons to cover the path of filemanager with some kind of authentication. You can use, for example, [`basicauth`](https://caddyserver.com/docs/basicauth) directive. + +Note that if you are handling large files you might run into troubles due to the defaults of [`timeouts`](https://caddyserver.com/docs/timeouts) plugin. Check its [documentation](https://caddyserver.com/docs/timeouts) to learn more about that plugin. + +## Get Started + +To start using this plugin you just need to go to the [download Caddy page](https://caddyserver.com/download) and choose `filemanager` in the directives section. For further information on how Caddy works refer to [its documentation](https://caddyserver.com/docs). + +If you want to build it from source, consult our [developers section](#developers). + +## Syntax + +``` +filemanager [baseurl] { + show directory + webdav [path] + styles filepath + allow_new [true|false] + allow_edit [true|false] + allow_commands [true|false] + allow_command command + block_command command + before_save command + after_save command + allow [url|dotfiles] + allow_r regex + block [url|dotfiles] + block_r regex +} +``` + +All of the options above are optional. + ++ **baseurl** is the URL where you will access the File Manager interface. Defaults to `/`. ++ **show** is the path, relative or absolute, to the directory you want to browse in. Defaults to `./`. ++ **webdav** is the path that will be appended to baseurl in which the [WebDAV](https://en.wikipedia.org/wiki/WebDAV) will be accessible. Defaults to `/webdav`. ++ **styles** is the relative or absolute path to the stylesheet file. This file doesn't need to be accessible from the web. ++ **allow_new** is the permission to create new files and directories. Defaults to `true`. ++ **allow_edit** is the permission to edit, rename and delete files or directories. Defaults to `true`. ++ **allow_commands** is the permission to execute commands. Defaults to `true`. ++ **allow_command** and **block_command** gives, or denies, permission to execute a certain command through the admin interface. By default `git`, `svn` and `hg` are enabled. ++ **before_save** and **after_save** allow you to set a custom command to be executed before saving and after saving a file. The placeholder `{path}` can be used and it will be replaced by the file path. ++ **allow** and **block** can be used to allow or deny the access to specific files or directories using their URL. You can use the magic word `dotfiles` to allow or block the access to dot-files. The blocked files won't show in the admin interface. By default, `block dotfiles` is activated. ++ **allow_r** and **block_r** and variations of the previous options but you are able to use regular expressions with them. These regular expressions are used to match the URL, **not** the internal file path. + + +So, by **default** we have: + +``` +filemanager / { + show ./ + webdav /webdav + allow_new true + allow_edit true + allow_commands true + allow_command git + allow_command svn + allow_command hg + block dotfiles +} +``` + +As already mentioned, this extension should be used with [`basicauth`](https://caddyserver.com/docs/basicauth). If you do that, you will also be able to set permissions for different users using the following syntax: + +``` +filemanager { + # You set the global configurations here and + # all the users will inherit them. + user1: + # Here you can set specific settings for the 'user1'. + # They will override the global ones for this specific user. +} +``` + +## Examples + +Show the directory where Caddy is being executed at the root of the domain: + +``` +filemanager +``` + +Use only WebDAV: + +``` +filemanager { + webdav / +} +``` + +Show the content of `foo` at the root of the domain: + +``` +filemanager { + show foo/ +} +``` + +Show the directory where Caddy is being executed at `/filemanager`: + +``` +filemanager /filemanager +``` + +Show the content of `foo` at `/bar`: + +``` +filemanager /bar{ + show foo/ +} +``` + +Now, a bit more complicated example. You have three users: an administrator, a manager and an editor. The administrator can do everything and has access to the commands `rm` and `mv` because he is a geeky. The manager, doesn't have access to commands, but can create and edit files. The editor can **only** edit files. He can't even create new ones, because he will only edit the files after the manager creates them for him. Both the editor and the manager won't have access to the financial folder. We would have: + +``` +basicauth /admin admin pass +basicauth /admin manager pass +basicauth /admin editor pass + +filemanager /admin { + show ./ + allow_commands false + admin: + allow_commands true + allow_command rm + allow_command mv + allow dotfiles + manager: + block /admin/financial + editor: + allow_new false + block /admin/financial +} +``` + +## About Search + +FileManager allows you to search through your files and it has some options. By default, your search will be something like this: + +``` +this are keywords +``` + +If you search for that it will look at every file that contains "this", "are" or "keywords" on their name. If you want to search for an exact term, you should surround your search by double quotes: + +``` +"this is the name" +``` + +That will search for any file that contains "this is the name" on its name. It won't search for each separated term this time. + +By default, every search will be case sensitive. Although, you can make a case insensitive search by adding `case:insensitive` to the search terms, like this: + +``` +this are keywords case:insensitive +``` + +## Developers + +If you are a developer and want to contribute, please go to the [filemanager library repository](https://github.com/hacdias/filemanager) where you can find the base code for this project. \ No newline at end of file diff --git a/caddy/filemanager.go b/caddy/filemanager.go new file mode 100644 index 00000000..53f1798f --- /dev/null +++ b/caddy/filemanager.go @@ -0,0 +1,268 @@ +// Package filemanager provides middleware for managing files in a directory +// when directory path is requested instead of a specific file. Based on browse +// middleware. +package filemanager + +import ( + "fmt" + "io/ioutil" + "log" + "net/http" + "os" + "os/exec" + "path/filepath" + "regexp" + "strconv" + "strings" + + "github.com/hacdias/filemanager" + "github.com/mholt/caddy" + "github.com/mholt/caddy/caddyhttp/httpserver" +) + +func init() { + caddy.RegisterPlugin("filemanager", caddy.Plugin{ + ServerType: "http", + Action: setup, + }) +} + +// FileManager is an http.Handler that can show a file listing when +// directories in the given paths are specified. +type FileManager struct { + Next httpserver.Handler + Configs []*filemanager.FileManager +} + +// ServeHTTP determines if the request is for this plugin, and if all prerequisites are met. +func (f FileManager) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error) { + for i := range f.Configs { + // Checks if this Path should be handled by File Manager. + if !httpserver.Path(r.URL.Path).Matches(f.Configs[i].BaseURL) { + continue + } + + return f.Configs[i].ServeHTTP(w, r) + } + + return f.Next.ServeHTTP(w, r) +} + +// setup configures a new FileManager middleware instance. +func setup(c *caddy.Controller) error { + configs, err := parse(c) + if err != nil { + return err + } + + httpserver.GetConfig(c).AddMiddleware(func(next httpserver.Handler) httpserver.Handler { + return FileManager{Configs: configs, Next: next} + }) + + return nil +} + +func parse(c *caddy.Controller) ([]*filemanager.FileManager, error) { + var ( + configs []*filemanager.FileManager + err error + ) + + for c.Next() { + var ( + m = filemanager.New(".") + u = m.User + name = "" + ) + + caddyConf := httpserver.GetConfig(c) + + m.PrefixURL = strings.TrimSuffix(caddyConf.Addr.Path, "/") + m.Commands = []string{"git", "svn", "hg"} + m.Rules = append(m.Rules, &filemanager.Rule{ + Regex: true, + Allow: false, + Regexp: regexp.MustCompile("\\/\\..+"), + }) + + // Get the baseURL + args := c.RemainingArgs() + + if len(args) > 0 { + m.SetBaseURL(args[0]) + m.SetWebDavURL("/webdav") + } + + for c.NextBlock() { + switch c.Val() { + case "before_save": + if m.BeforeSave, err = makeCommand(c); err != nil { + return configs, err + } + case "after_save": + if m.AfterSave, err = makeCommand(c); err != nil { + return configs, err + } + case "webdav": + if !c.NextArg() { + return configs, c.ArgErr() + } + + m.SetWebDavURL(c.Val()) + case "show": + if !c.NextArg() { + return configs, c.ArgErr() + } + + m.SetScope(c.Val(), name) + case "styles": + if !c.NextArg() { + return configs, c.ArgErr() + } + + var tplBytes []byte + tplBytes, err = ioutil.ReadFile(c.Val()) + if err != nil { + return configs, err + } + + u.StyleSheet = string(tplBytes) + case "allow_new": + if !c.NextArg() { + return configs, c.ArgErr() + } + + u.AllowNew, err = strconv.ParseBool(c.Val()) + if err != nil { + return configs, err + } + case "allow_edit": + if !c.NextArg() { + return configs, c.ArgErr() + } + + u.AllowEdit, err = strconv.ParseBool(c.Val()) + if err != nil { + return configs, err + } + case "allow_commands": + if !c.NextArg() { + return configs, c.ArgErr() + } + + u.AllowCommands, err = strconv.ParseBool(c.Val()) + if err != nil { + return configs, err + } + case "allow_command": + if !c.NextArg() { + return configs, c.ArgErr() + } + + u.Commands = append(u.Commands, c.Val()) + case "block_command": + if !c.NextArg() { + return configs, c.ArgErr() + } + + index := 0 + + for i, val := range u.Commands { + if val == c.Val() { + index = i + } + } + + u.Commands = append(u.Commands[:index], u.Commands[index+1:]...) + case "allow", "allow_r", "block", "block_r": + ruleType := c.Val() + + if !c.NextArg() { + return configs, c.ArgErr() + } + + if c.Val() == "dotfiles" && !strings.HasSuffix(ruleType, "_r") { + ruleType += "_r" + } + + rule := &filemanager.Rule{ + Allow: ruleType == "allow" || ruleType == "allow_r", + Regex: ruleType == "allow_r" || ruleType == "block_r", + } + + if rule.Regex && c.Val() == "dotfiles" { + rule.Regexp = regexp.MustCompile("\\/\\..+") + } else if rule.Regex { + rule.Regexp = regexp.MustCompile(c.Val()) + } else { + rule.Path = c.Val() + } + + u.Rules = append(u.Rules, rule) + default: + // Is it a new user? Is it? + val := c.Val() + + // Checks if it's a new user! + if !strings.HasSuffix(val, ":") { + fmt.Println("Unknown option " + val) + } + + // Get the username, sets the current user, and initializes it + val = strings.TrimSuffix(val, ":") + m.NewUser(val) + name = val + } + } + + configs = append(configs, m) + } + + return configs, nil +} + +func makeCommand(c *caddy.Controller) (filemanager.Command, error) { + fn := func(r *http.Request, c *filemanager.FileManager, u *filemanager.User) error { return nil } + + args := c.RemainingArgs() + if len(args) == 0 { + return fn, c.ArgErr() + } + + nonblock := false + if len(args) > 1 && args[len(args)-1] == "&" { + // Run command in background; non-blocking + nonblock = true + args = args[:len(args)-1] + } + + command, args, err := caddy.SplitCommandAndArgs(strings.Join(args, " ")) + if err != nil { + return fn, c.Err(err.Error()) + } + + fn = func(r *http.Request, c *filemanager.FileManager, u *filemanager.User) error { + path := strings.Replace(r.URL.Path, c.WebDavURL, "", 1) + path = u.Scope() + "/" + path + path = filepath.Clean(path) + + for i := range args { + args[i] = strings.Replace(args[i], "{path}", path, -1) + } + + cmd := exec.Command(command, args...) + cmd.Stdin = os.Stdin + cmd.Stdout = os.Stdout + cmd.Stderr = os.Stderr + + if nonblock { + log.Printf("[INFO] Nonblocking Command:\"%s %s\"", command, strings.Join(args, " ")) + return cmd.Start() + } + + log.Printf("[INFO] Blocking Command:\"%s %s\"", command, strings.Join(args, " ")) + return cmd.Run() + } + + return fn, nil +}