Documentation
¶
Index ¶
- func Chtimes(name string, atime time.Time, mtime time.Time) error
- func CombineURL(parts ...string) string
- func Copy(src, dstDir string, chownRoot bool) error
- func Download(rawurl string, directory string, filename string) (savedname string, err error)
- func DownloadDisabledTLS(rawurl string, directory string, filename string) (savedname string, err error)
- func DownloadWithHeader(rawurl string, directory string, filename string, header map[string]string) (savedname string, err error)
- func EnsureDir(path string, perm fs.FileMode) error
- func HttpGet(url string) (body []byte, statusCode int, err error)
- func HttpGetPanic(url string) string
- func IsDir(path string) bool
- func IsNotExist(err error) bool
- func IsURL(str string) bool
- func LUtimesNano(path string, ts []syscall.Timespec) error
- func Max[T Comparable](a, b T) T
- func Min[T Comparable](a, b T) T
- func PathExists(path string) bool
- func SafeFilename(dstDir string, ext string, parts ...string) (filename string)
- func SecureJoin(root, unsafePath string) (string, error)
- func URLtoFilename(url string) (filename string)
- func UnescapeURL(encodedURL string) (string, error)
- type Comparable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Chtimes ¶
Chtimes changes the access time and modified time of a file at the given path. If the modified time is prior to the Unix Epoch (unixMinTime), or after the end of Unix Time (unixEpochTime), os.Chtimes has undefined behavior. In this case, Chtimes defaults to Unix Epoch, just in case.
func CombineURL ¶
func DownloadDisabledTLS ¶
func DownloadWithHeader ¶
func EnsureDir ¶
ensureDir checks if a path exists and is a directory. If the path does not exist, it tries to create the directory. If the path is a file, it returns an error.
func HttpGetPanic ¶ added in v0.2.2
func IsNotExist ¶
IsNotExist tells you if err is an error that implies that either the path accessed does not exist (or path components don't exist). This is effectively a more broad version of os.IsNotExist.
func LUtimesNano ¶
LUtimesNano is used to change access and modification time of the specified path. It's used for symbol link file because unix.UtimesNano doesn't support a NOFOLLOW flag atm.
func Max ¶
func Max[T Comparable](a, b T) T
func Min ¶
func Min[T Comparable](a, b T) T
func PathExists ¶
func SafeFilename ¶ added in v0.2.2
generate a safe filename for target directory, by only preserve the letters and numbers in `parts` and add a number if a file with same name already exists in the target directory. TODO: safe for parallel calling?
func SecureJoin ¶
SecureJoinVFS joins the two given path components (similar to Join) except that the returned path is guaranteed to be scoped inside the provided root path (when evaluated). Any symbolic links in the path are evaluated with the given root treated as the root of the filesystem, similar to a chroot. The filesystem state is evaluated through the given VFS interface (if nil, the standard os.* family of functions are used).
Note that the guarantees provided by this function only apply if the path components in the returned string are not modified (in other words are not replaced with symlinks on the filesystem) after this function has returned. Such a symlink race is necessarily out-of-scope of SecureJoin.
NOTE: Due to the above limitation, Linux users are strongly encouraged to use OpenInRoot instead, which does safely protect against these kinds of attacks. There is no way to solve this problem with SecureJoinVFS because the API is fundamentally wrong (you cannot return a "safe" path string and guarantee it won't be modified afterwards).
Volume names in unsafePath are always discarded, regardless if they are provided via direct input or when evaluating symlinks. Therefore:
"C:\Temp" + "D:\path\to\file.txt" results in "C:\Temp\path\to\file.txt"
Source Files