README
¶
securefs
Go library for secure file system operations scoped to an arbitrary root directory on Linux, without chroot, mount namespaces, or other privileged features.
This uses the Linux-specific openat2 syscall with RESOLVE_IN_ROOT to prevent symlink escapes and race conditions. Other solutions like securejoin are subject to race conditions.
Unlike O_NOFOLLOW, this supports all file system operations and works with symlinks (as long as they don't escape the specified root directory).
Documentation
¶
Index ¶
- func Create(at string, name string) (*os.File, error)
- func Mkdir(at string, name string, perm os.FileMode) error
- func MkdirAll(at string, path string, perm os.FileMode) error
- func Open(at string, name string) (*os.File, error)
- func OpenFile(at string, name string, flag int, perm os.FileMode) (*os.File, error)
- func ReadDir(at string, name string) ([]os.DirEntry, error)
- func ReadFile(at string, name string) ([]byte, error)
- func Remove(at string, name string) error
- func ResolvePath(at string, name string) (string, error)
- func Stat(at string, name string) (os.FileInfo, error)
- func Symlink(at string, oldname, newname string) error
- func WriteFile(at string, name string, data []byte, perm os.FileMode) error
- type FS
- func (fs *FS) Close() error
- func (fs *FS) Create(name string) (*os.File, error)
- func (fs *FS) Mkdir(name string, perm os.FileMode) error
- func (fs *FS) MkdirAll(path string, perm os.FileMode) error
- func (fs *FS) Open(name string) (*os.File, error)
- func (fs *FS) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
- func (fs *FS) ReadDir(name string) ([]os.DirEntry, error)
- func (fs *FS) ReadFile(name string) ([]byte, error)
- func (fs *FS) Remove(name string) error
- func (fs *FS) ResolvePath(name string) (string, error)
- func (fs *FS) Stat(name string) (os.FileInfo, error)
- func (fs *FS) Symlink(oldname, newname string) error
- func (fs *FS) WriteFile(name string, data []byte, perm os.FileMode) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.