safepath

Documentation

Overview

Package safepath constrains filesystem paths for user-controlled inputs (cache roots, config discovery, recipe files) and performs reads/writes via os.Root where appropriate.

Index

• func JoinUnder(root string, parts ...string) (string, error)
• func OpenReadWriteProbe(path string) (err error)
• func ReadFile(path string) (data []byte, err error)
• func Stat(path string) (info os.FileInfo, err error)
• func Under(root, path string) error
• func WriteFile(path string, data []byte, perm os.FileMode) (err error)

Functions

func JoinUnder

func JoinUnder(root string, parts ...string) (string, error)

JoinUnder returns filepath.Join(root, parts...) if the result stays under root.

func OpenReadWriteProbe

func OpenReadWriteProbe(path string) (err error)

OpenReadWriteProbe returns nil if path is a regular file that can be opened read-write via os.Root on the parent directory (used to detect user-writable known_hosts files).

func ReadFile

func ReadFile(path string) (data []byte, err error)

ReadFile reads path using os.Root on the parent directory so the basename cannot traverse.

func Stat

func Stat(path string) (info os.FileInfo, err error)

Stat stats path using os.Root on the parent directory.

func Under

func Under(root, path string) error

Under returns nil if path equals root or is a subdirectory of root (after absolute resolution).

func WriteFile

func WriteFile(path string, data []byte, perm os.FileMode) (err error)

WriteFile writes data to path using a temp file and rename within os.Root of the parent directory.