file

package

v0.4.0 Latest Latest Go to latest Published: Dec 12, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/neticdk/go-common

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Variables
func Copy(srcFile, dstFile string) error
func CopyDirectory(srcDir, dest string) error
func Exists(path string) (bool, error)
func IsDir(path string) bool
func SafeCreate(root, path string, mode int64) (*os.File, error)
func SafeOpen(root, path string) (*os.File, error)
func SafeOpenFile(root, path string, flag int, mode int64) (*os.File, error)
func SafePath(root, path string) (string, error)
func SafeReadFile(root, path string) ([]byte, error)
func ValidMode(mode int64) (os.FileMode, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrEmptyPath = errors.New("path cannot be empty")
	ErrNullByte  = errors.New("path contains null byte")
	ErrTraversal = errors.New("path traversal attempt detected")
	ErrSymlink   = errors.New("symlink traversal attempt detected")
)

Functions ¶

func CopyDirectory ¶

func CopyDirectory(srcDir, dest string) error

CopyDirectory copies a directory from src to dest

func Exists ¶

func Exists(path string) (bool, error)

func IsDir ¶

func IsDir(path string) bool

func SafeCreate ¶

func SafeCreate(root, path string, mode int64) (*os.File, error)

SafeCreate creates or truncates a file with the specified mode. It uses SafeOpenFile with write-only, create and truncate flags.

func SafeOpen ¶

func SafeOpen(root, path string) (*os.File, error)

SafeOpen opens a file for read-only access in a secure manner. It uses SafeOpenFile with read-only flag and default permissions.

func SafeOpenFile ¶

func SafeOpenFile(root, path string, flag int, mode int64) (*os.File, error)

SafeOpenFile opens a file with the specified path, base directory, flags, and mode. It ensures the file operation is secure by validating the mode and path. Returns a file handle and any error encountered.

func SafePath ¶

func SafePath(root, path string) (string, error)

SafePath ensures the given path is safe to use within the specified root directory. It returns the cleaned absolute path and an error if the path is unsafe. The function performs the following checks and operations: 1. Validates that the path is not empty and does not contain null bytes. 2. Cleans and converts both the root and input paths to absolute paths. 3. Resolves any symlinks in the input path, even if the path does not exist. 4. Ensures the resolved path is within the root directory to prevent path traversal attacks. 5. Works on both Windows and Unix-like systems, handling platform-specific path separators and case sensitivity.

Parameters: - root: The root directory within which the path must be contained. - path: The input path to be validated and resolved. It can be either an absolute or relative path.

func SafeReadFile ¶

func SafeReadFile(root, path string) ([]byte, error)

SafeReadFile reads the entire contents of a file securely. It ensures the file path is safe before reading. Returns the file contents and any error encountered.

func ValidMode ¶

func ValidMode(mode int64) (os.FileMode, error)

ValidMode checks if the given mode is a valid file mode

Types ¶