caddyhttp: properly sanitize requests for root path (#6360)

SanitizePathJoin protects against directory traversal attacks by
checking for requests whose URL path look like they are trying to
request something other than a local file, and returns the root
directory in those cases.

The method is also careful to ensure that requests which contain a
trailing slash include a trailing slash in the returned value.  However,
for requests that contain only a slash (requests for the root path), the
IsLocal check returns early before the matching trailing slash is
re-added.

This change updates SanitizePathJoin to only perform the
filepath.IsLocal check if the cleaned request URL path is non-empty.

---

This change also updates the existing SanitizePathJoin tests to use
filepath.FromSlash rather than filepath.Join. This makes the expected
value a little easier to read, but also has the advantage of not being
processed by filepath.Clean like filepath.Join is. This means that the
exact expect value will be compared, not the result of first cleaning
it.

Fixes #6352
This commit is contained in:
Will Norris 2024-06-01 20:40:59 -07:00 committed by GitHub
parent 01308b4bae
commit f8a2c60297
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 19 additions and 11 deletions

View file

@ -239,7 +239,7 @@ func SanitizedPathJoin(root, reqPath string) string {
} }
relPath := path.Clean("/" + reqPath)[1:] // clean path and trim the leading / relPath := path.Clean("/" + reqPath)[1:] // clean path and trim the leading /
if !filepath.IsLocal(relPath) { if relPath != "" && !filepath.IsLocal(relPath) {
// path is unsafe (see https://github.com/golang/go/issues/56336#issuecomment-1416214885) // path is unsafe (see https://github.com/golang/go/issues/56336#issuecomment-1416214885)
return root return root
} }

View file

@ -26,22 +26,28 @@ func TestSanitizedPathJoin(t *testing.T) {
inputPath: "/", inputPath: "/",
expect: ".", expect: ".",
}, },
{
// fileserver.MatchFile passes an inputPath of "//" for some try_files values.
// See https://github.com/caddyserver/caddy/issues/6352
inputPath: "//",
expect: filepath.FromSlash("./"),
},
{ {
inputPath: "/foo", inputPath: "/foo",
expect: "foo", expect: "foo",
}, },
{ {
inputPath: "/foo/", inputPath: "/foo/",
expect: "foo" + separator, expect: filepath.FromSlash("foo/"),
}, },
{ {
inputPath: "/foo/bar", inputPath: "/foo/bar",
expect: filepath.Join("foo", "bar"), expect: filepath.FromSlash("foo/bar"),
}, },
{ {
inputRoot: "/a", inputRoot: "/a",
inputPath: "/foo/bar", inputPath: "/foo/bar",
expect: filepath.Join("/", "a", "foo", "bar"), expect: filepath.FromSlash("/a/foo/bar"),
}, },
{ {
inputPath: "/foo/../bar", inputPath: "/foo/../bar",
@ -50,32 +56,34 @@ func TestSanitizedPathJoin(t *testing.T) {
{ {
inputRoot: "/a/b", inputRoot: "/a/b",
inputPath: "/foo/../bar", inputPath: "/foo/../bar",
expect: filepath.Join("/", "a", "b", "bar"), expect: filepath.FromSlash("/a/b/bar"),
}, },
{ {
inputRoot: "/a/b", inputRoot: "/a/b",
inputPath: "/..%2fbar", inputPath: "/..%2fbar",
expect: filepath.Join("/", "a", "b", "bar"), expect: filepath.FromSlash("/a/b/bar"),
}, },
{ {
inputRoot: "/a/b", inputRoot: "/a/b",
inputPath: "/%2e%2e%2fbar", inputPath: "/%2e%2e%2fbar",
expect: filepath.Join("/", "a", "b", "bar"), expect: filepath.FromSlash("/a/b/bar"),
}, },
{ {
// inputPath fails the IsLocal test so only the root is returned,
// but with a trailing slash since one was included in inputPath
inputRoot: "/a/b", inputRoot: "/a/b",
inputPath: "/%2e%2e%2f%2e%2e%2f", inputPath: "/%2e%2e%2f%2e%2e%2f",
expect: "/a/b", // inputPath fails the IsLocal test so only the root is returned expect: filepath.FromSlash("/a/b/"),
}, },
{ {
inputRoot: "/a/b", inputRoot: "/a/b",
inputPath: "/foo%2fbar", inputPath: "/foo%2fbar",
expect: filepath.Join("/", "a", "b", "foo", "bar"), expect: filepath.FromSlash("/a/b/foo/bar"),
}, },
{ {
inputRoot: "/a/b", inputRoot: "/a/b",
inputPath: "/foo%252fbar", inputPath: "/foo%252fbar",
expect: filepath.Join("/", "a", "b", "foo%2fbar"), expect: filepath.FromSlash("/a/b/foo%2fbar"),
}, },
{ {
inputRoot: "C:\\www", inputRoot: "C:\\www",
@ -92,7 +100,7 @@ func TestSanitizedPathJoin(t *testing.T) {
// https://github.com/golang/go/issues/56336#issuecomment-1416214885 // https://github.com/golang/go/issues/56336#issuecomment-1416214885
inputRoot: "root", inputRoot: "root",
inputPath: "/a/b/../../c", inputPath: "/a/b/../../c",
expect: filepath.Join("root", "c"), expect: filepath.FromSlash("root/c"),
}, },
} { } {
// we don't *need* to use an actual parsed URL, but it // we don't *need* to use an actual parsed URL, but it