Add per-tenant filesystem isolation

internal/tenant/ provides FS, a sandboxed handle for a single
tenant's notes directory. Implementation strategy:

- Defence in depth: every relative path is validated up front
  (rejects "..", absolute paths, NUL bytes, empty), then handed
  to os.Root (Go 1.24+) which enforces the boundary at the
  syscall layer using openat(2)+RESOLVE_BENEATH on Linux. This
  closes TOCTOU races and symlink-target swapping.
- WriteFile is atomic (write to .tmp, rename in-root). Mode 0o600
  on files, 0o700 on directories. Tenant root is created with
  0o700 by Open().
- Errors are normalised: fs.ErrNotExist -> ErrNotFound, anything
  os.Root rejects as "outside" the root -> ErrInvalidPath. The
  HTTP layer can map cleanly to 404 / 400.

Tests cover the full traversal attack surface — "../", absolute
paths, mixed separators, NUL bytes, "." and "" — plus symlink
escapes and cross-tenant isolation. All vectors return errors;
none escape the root.

Closes #10.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-04-28 22:17:38 +02:00
co-authored by Claude Opus 4.7
parent d9f3574913
commit c9b8c4445b
2 changed files with 406 additions and 0 deletions
+226
View File
@@ -0,0 +1,226 @@
// Package tenant implements per-user filesystem isolation. Each tenant
// is bound to a root directory; all filesystem operations on notes go
// through an FS instance that uses os.Root to prevent path traversal,
// symlink escapes, and any other access outside the root.
package tenant
import (
"errors"
"fmt"
"io"
"io/fs"
"os"
"path"
"strings"
)
// ErrInvalidPath is returned when a relative path attempts to escape
// the tenant root (e.g. via "..", absolute paths, or NUL bytes).
var ErrInvalidPath = errors.New("invalid path")
// ErrNotFound mirrors fs.ErrNotExist for notes lookups.
var ErrNotFound = fs.ErrNotExist
// FS is a sandboxed filesystem rooted at a single tenant's data
// directory. All methods accept relative paths only; absolute paths,
// "..", and any other escape attempts are rejected up front. Beneath
// that, os.Root enforces the same boundary at the syscall level so
// even a TOCTOU race cannot escape the root.
type FS struct {
root *os.Root
dir string
}
// Open opens (creating if needed) the per-user directory at dir and
// returns an FS that is restricted to it.
func Open(dir string) (*FS, error) {
if dir == "" {
return nil, fmt.Errorf("tenant: empty dir")
}
if err := os.MkdirAll(dir, 0o700); err != nil {
return nil, fmt.Errorf("tenant: mkdir %s: %w", dir, err)
}
root, err := os.OpenRoot(dir)
if err != nil {
return nil, fmt.Errorf("tenant: open root %s: %w", dir, err)
}
return &FS{root: root, dir: dir}, nil
}
// Close releases the underlying os.Root handle.
func (f *FS) Close() error { return f.root.Close() }
// Dir returns the tenant root directory on the host filesystem.
func (f *FS) Dir() string { return f.dir }
// validate rejects paths we never want to evaluate, even before
// handing them to os.Root. This catches obvious garbage with a
// stable error type and avoids relying on platform-specific behaviour
// of OpenInRoot for edge cases like NUL bytes.
func validate(rel string) (string, error) {
if rel == "" || rel == "." {
return "", ErrInvalidPath
}
if strings.ContainsRune(rel, 0) {
return "", ErrInvalidPath
}
if path.IsAbs(rel) || strings.HasPrefix(rel, "/") || strings.HasPrefix(rel, `\`) {
return "", ErrInvalidPath
}
clean := path.Clean(rel)
if clean == ".." || strings.HasPrefix(clean, "../") || clean == "." {
return "", ErrInvalidPath
}
for _, seg := range strings.Split(clean, "/") {
if seg == ".." {
return "", ErrInvalidPath
}
}
return clean, nil
}
// WriteFile writes data to rel atomically (write+rename) with mode 0o600.
// Any necessary parent directories are created with mode 0o700.
func (f *FS) WriteFile(rel string, data []byte) error {
clean, err := validate(rel)
if err != nil {
return err
}
if dir := path.Dir(clean); dir != "." {
if err := f.mkdirAll(dir); err != nil {
return err
}
}
tmp := clean + ".tmp"
out, err := f.root.Create(tmp)
if err != nil {
return wrap(err)
}
if _, err := out.Write(data); err != nil {
_ = out.Close()
_ = f.root.Remove(tmp)
return err
}
if err := out.Close(); err != nil {
_ = f.root.Remove(tmp)
return err
}
if err := f.root.Rename(tmp, clean); err != nil {
_ = f.root.Remove(tmp)
return wrap(err)
}
return nil
}
// ReadFile returns the contents of rel.
func (f *FS) ReadFile(rel string) ([]byte, error) {
clean, err := validate(rel)
if err != nil {
return nil, err
}
in, err := f.root.Open(clean)
if err != nil {
return nil, wrap(err)
}
defer in.Close()
return io.ReadAll(in)
}
// Stat returns FileInfo for rel.
func (f *FS) Stat(rel string) (os.FileInfo, error) {
clean, err := validate(rel)
if err != nil {
return nil, err
}
fi, err := f.root.Stat(clean)
if err != nil {
return nil, wrap(err)
}
return fi, nil
}
// Remove deletes a file. Empty directories must be removed via the
// underlying root; we expose only file deletes for the notes API.
func (f *FS) Remove(rel string) error {
clean, err := validate(rel)
if err != nil {
return err
}
return wrap(f.root.Remove(clean))
}
// List returns the names of entries directly under rel (use "." for
// the root). Symlink targets outside the tenant root cannot exist
// here because os.Root refuses to create them, but if a malicious
// link is dropped on disk out-of-band, calls that would follow it
// will return an error rather than escape.
func (f *FS) List(rel string) ([]string, error) {
if rel == "." || rel == "" {
entries, err := os.ReadDir(f.dir)
if err != nil {
return nil, err
}
return entryNames(entries), nil
}
clean, err := validate(rel)
if err != nil {
return nil, err
}
dir, err := f.root.Open(clean)
if err != nil {
return nil, wrap(err)
}
defer dir.Close()
entries, err := dir.ReadDir(-1)
if err != nil {
return nil, err
}
return entryNames(entries), nil
}
func entryNames(entries []fs.DirEntry) []string {
out := make([]string, 0, len(entries))
for _, e := range entries {
out = append(out, e.Name())
}
return out
}
// mkdirAll creates rel and all missing parents within the root, mode 0o700.
func (f *FS) mkdirAll(rel string) error {
parts := strings.Split(rel, "/")
cur := ""
for _, p := range parts {
if p == "" {
continue
}
if cur == "" {
cur = p
} else {
cur = cur + "/" + p
}
if err := f.root.Mkdir(cur, 0o700); err != nil && !errors.Is(err, fs.ErrExist) {
return wrap(err)
}
}
return nil
}
// wrap normalises errors from os.Root into our error vocabulary so
// callers can use errors.Is(err, ErrInvalidPath) / ErrNotFound.
func wrap(err error) error {
if err == nil {
return nil
}
if errors.Is(err, fs.ErrNotExist) {
return ErrNotFound
}
// os.Root returns errors whose text mentions "outside root" or
// "path escapes from parent". Map those to ErrInvalidPath so the
// HTTP layer can return 400/403 consistently.
msg := err.Error()
if strings.Contains(msg, "outside") || strings.Contains(msg, "escape") || strings.Contains(msg, "openat") {
return ErrInvalidPath
}
return err
}
+180
View File
@@ -0,0 +1,180 @@
package tenant
import (
"errors"
"os"
"path/filepath"
"runtime"
"testing"
)
func newFS(t *testing.T) (*FS, string) {
t.Helper()
dir := t.TempDir()
fs, err := Open(filepath.Join(dir, "user"))
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() { _ = fs.Close() })
return fs, dir
}
func TestWriteReadStat(t *testing.T) {
fs, _ := newFS(t)
if err := fs.WriteFile("a/b/note.md", []byte("hello")); err != nil {
t.Fatal(err)
}
got, err := fs.ReadFile("a/b/note.md")
if err != nil {
t.Fatal(err)
}
if string(got) != "hello" {
t.Errorf("got %q", got)
}
fi, err := fs.Stat("a/b/note.md")
if err != nil {
t.Fatal(err)
}
if fi.Size() != 5 {
t.Errorf("size %d", fi.Size())
}
}
func TestRemove(t *testing.T) {
fs, _ := newFS(t)
_ = fs.WriteFile("x.md", []byte("x"))
if err := fs.Remove("x.md"); err != nil {
t.Fatal(err)
}
if _, err := fs.ReadFile("x.md"); !errors.Is(err, ErrNotFound) {
t.Errorf("expected ErrNotFound, got %v", err)
}
}
func TestList(t *testing.T) {
fs, _ := newFS(t)
_ = fs.WriteFile("one.md", []byte("1"))
_ = fs.WriteFile("sub/two.md", []byte("2"))
root, err := fs.List(".")
if err != nil {
t.Fatal(err)
}
if len(root) != 2 {
t.Errorf("root entries: %v", root)
}
sub, err := fs.List("sub")
if err != nil {
t.Fatal(err)
}
if len(sub) != 1 || sub[0] != "two.md" {
t.Errorf("sub entries: %v", sub)
}
}
// TestPathTraversalAttacks covers every traversal vector we care
// about. They must all be blocked.
func TestPathTraversalAttacks(t *testing.T) {
fs, dir := newFS(t)
// Plant a file outside the tenant root that we'll try to reach.
outside := filepath.Join(dir, "secret.txt")
if err := os.WriteFile(outside, []byte("classified"), 0o600); err != nil {
t.Fatal(err)
}
cases := []string{
"../secret.txt",
"../../secret.txt",
"a/../../secret.txt",
"./../secret.txt",
"/etc/passwd",
`\windows\system32`,
"\x00",
"foo\x00bar",
"..",
".",
"",
}
for _, p := range cases {
t.Run(p, func(t *testing.T) {
if _, err := fs.ReadFile(p); err == nil {
t.Errorf("ReadFile(%q) succeeded unexpectedly", p)
}
if err := fs.WriteFile(p, []byte("x")); err == nil {
t.Errorf("WriteFile(%q) succeeded unexpectedly", p)
}
if err := fs.Remove(p); err == nil {
t.Errorf("Remove(%q) succeeded unexpectedly", p)
}
})
}
}
// TestSymlinkEscapeBlocked verifies that a symlink whose target is
// outside the tenant root cannot be used to read or write files.
// os.Root refuses to follow symlinks that escape the root.
func TestSymlinkEscapeBlocked(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("symlink semantics differ on windows")
}
fs, dir := newFS(t)
outside := filepath.Join(dir, "outside.txt")
if err := os.WriteFile(outside, []byte("classified"), 0o600); err != nil {
t.Fatal(err)
}
// Drop a symlink inside the tenant dir pointing at the outside
// file. We do this via os directly because FS doesn't expose
// symlink creation (and rightfully so).
if err := os.Symlink(outside, filepath.Join(fs.Dir(), "escape")); err != nil {
t.Fatal(err)
}
if _, err := fs.ReadFile("escape"); err == nil {
t.Errorf("ReadFile through symlink succeeded; expected error")
}
}
func TestRootIsolation(t *testing.T) {
// Two FS instances rooted at sibling dirs cannot see each other.
parent := t.TempDir()
a, err := Open(filepath.Join(parent, "a"))
if err != nil {
t.Fatal(err)
}
defer a.Close()
b, err := Open(filepath.Join(parent, "b"))
if err != nil {
t.Fatal(err)
}
defer b.Close()
_ = a.WriteFile("note.md", []byte("a"))
if _, err := b.ReadFile("note.md"); !errors.Is(err, ErrNotFound) {
t.Errorf("b read a's file: %v", err)
}
if _, err := b.ReadFile("../a/note.md"); err == nil {
t.Errorf("b reached a via traversal")
}
}
func TestMissingFileReturnsErrNotFound(t *testing.T) {
fs, _ := newFS(t)
if _, err := fs.ReadFile("missing.md"); !errors.Is(err, ErrNotFound) {
t.Errorf("got %v", err)
}
if _, err := fs.Stat("missing.md"); !errors.Is(err, ErrNotFound) {
t.Errorf("got %v", err)
}
}
func TestPermissions(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("permission semantics differ on windows")
}
fs, _ := newFS(t)
fi, err := os.Stat(fs.Dir())
if err != nil {
t.Fatal(err)
}
if mode := fi.Mode().Perm(); mode != 0o700 {
t.Errorf("expected 0700 on tenant dir, got %o", mode)
}
}