pathpolicy

Documentation

Index

• Variables
• type PathPolicies
  • func NewPathPolicies(entries map[string]PathPolicy) *PathPolicies
  • func (pol *PathPolicies) Check(fsPath string) error
• type PathPolicy
• type PathTrie
  • func NewPathTrieFromMap(entries map[string]interface{}) *PathTrie
  • func (root *PathTrie) Lookup(path string) (*PathTrie, []string)

Variables

var CustomDirectoriesPolicies = NewPathPolicies(map[string]PathPolicy{
	"/":    {Deny: true},
	"/etc": {},
})

CustomDirectoriesPolicies is a set of default policies for custom directories

var CustomFilesPolicies = NewPathPolicies(map[string]PathPolicy{
	"/":           {Deny: true},
	"/etc":        {},
	"/root":       {},
	"/etc/fstab":  {Deny: true},
	"/etc/shadow": {Deny: true},
	"/etc/passwd": {Deny: true},
	"/etc/group":  {Deny: true},
})

CustomFilesPolicies is a set of default policies for custom files

var MountpointPolicies = NewPathPolicies(map[string]PathPolicy{
	"/":     {Exact: true},
	"/boot": {Exact: true},
	"/var":  {},
	"/opt":  {},
	"/srv":  {},
	"/usr":  {},
	"/app":  {},
	"/data": {},
	"/home": {},
	"/tmp":  {},
})

MountpointPolicies is a set of default mountpoint policies used for filesystem customizations

Types

type PathPolicies

type PathPolicies = PathTrie

func NewPathPolicies

func NewPathPolicies(entries map[string]PathPolicy) *PathPolicies

Create a new PathPolicies trie from a map of path to PathPolicy

func (*PathPolicies) Check

func (pol *PathPolicies) Check(fsPath string) error

Check a given path against the PathPolicies

type PathPolicy

type PathPolicy struct {
	Deny  bool // explicitly do not allow this entry
	Exact bool // require and exact match, no subdirs
}

type PathTrie

type PathTrie struct {
	Name    []string
	Paths   []*PathTrie
	Payload interface{}
}

func NewPathTrieFromMap

func NewPathTrieFromMap(entries map[string]interface{}) *PathTrie

Construct a new trie from a map of paths to their payloads. Returns the root node of the trie.

func (*PathTrie) Lookup

func (root *PathTrie) Lookup(path string) (*PathTrie, []string)

Lookup returns the node that is the prefix of path and the unmatched path segment. Must be called on the root trie node.