workspace

Documentation

Overview

Package workspace defines workspace scope, grants, and path authorization.

Index

• Variables
• type Access
• type Decision
  • func (d Decision) Allowed() bool
  • func (d Decision) RequiresApproval() bool
• type Grant
• type Options
• type Scope
  • func New(root string, opts ...Options) (*Scope, error)
  • func (s *Scope) Authorize(access Access, path string) (Decision, error)
  • func (s *Scope) Check(access Access, path string) (Decision, error)
  • func (s *Scope) Grant(path string, recursive bool) (Grant, error)
  • func (s *Scope) Grants() []Grant
  • func (s *Scope) Root() string

Variables

var (
	ErrRootRequired       = errors.New("root is required")
	ErrRootNotDirectory   = errors.New("root must be an existing directory")
	ErrPathRequired       = errors.New("path is required")
	ErrAccessRequired     = errors.New("access is required")
	ErrPermissionRequired = errors.New("path requires user approval")
)

Types

type Access

type Access string

const (
	AccessRead    Access = "read"
	AccessWrite   Access = "write"
	AccessList    Access = "list"
	AccessExec    Access = "exec"
	AccessWorkdir Access = "workdir"
)

type Decision

type Decision struct {
	Access       Access
	InputPath    string
	ResolvedPath string
	WithinRoot   bool
	Granted      bool
}

func (Decision) Allowed

func (d Decision) Allowed() bool

func (Decision) RequiresApproval

func (d Decision) RequiresApproval() bool

type Grant

type Grant struct {
	Path      string
	Recursive bool
}

type Options

type Options struct {
	Grants []Grant
}

type Scope

type Scope struct {
	// contains filtered or unexported fields
}

func New

func New(root string, opts ...Options) (*Scope, error)

func (*Scope) Authorize

func (s *Scope) Authorize(access Access, path string) (Decision, error)

func (*Scope) Check

func (s *Scope) Check(access Access, path string) (Decision, error)

func (*Scope) Grant

func (s *Scope) Grant(path string, recursive bool) (Grant, error)

func (*Scope) Grants

func (s *Scope) Grants() []Grant

func (*Scope) Root

func (s *Scope) Root() string