safepath

Documentation

Overview

Package safepath provides root-anchored path joins that reject traversal. All operations are pure functions with no I/O side effects.

Index

• Variables
• func Anchor(root, name string) (string, error)

Variables

var ErrAbsolute = errors.New("safepath: name must not be absolute")

ErrAbsolute is returned when the name is an absolute path.

var ErrEmpty = errors.New("safepath: name must not be empty")

ErrEmpty is returned when the name is empty.

var ErrEscapesRoot = errors.New("safepath: path escapes root")

ErrEscapesRoot is returned when a name resolves to a path outside the root.

var ErrNUL = errors.New("safepath: name must not contain NUL")

ErrNUL is returned when the name contains a NUL byte.

Functions

func Anchor

func Anchor(root, name string) (string, error)

Anchor returns filepath.Join(root, name) after verifying the cleaned result remains within root. It rejects names that are:

• empty
• absolute paths
• contain NUL bytes
• resolve to a path outside root after cleaning (e.g. via ".." segments)