sec

Documentation

Overview

Package sec provides security utilities for safe file path handling and directory traversal prevention.

Index

• func Filename(root string, elem ...string) (string, error)

Examples

• Filename
• Filename (Traversal)

Functions

func Filename

func Filename(root string, elem ...string) (string, error)

Filename joins a root directory with one or more path elements and ensures the resulting path is safely within the root.

Example

package main

import (
	"fmt"

	"github.com/foomo/go/sec"
)

func main() {
	path, err := sec.Filename("/tmp", "a", "b", "file.txt")
	if err != nil {
		fmt.Println("error:", err)
		return
	}

	fmt.Println(path)

}

Output:
/tmp/a/b/file.txt

Example (Traversal)

package main

import (
	"fmt"

	"github.com/foomo/go/sec"
)

func main() {
	_, err := sec.Filename("/tmp", "../etc/passwd")
	fmt.Println(err)

}

Output:
path traversal attempt