effects

Documentation

Index

• func CleanScope(path string) string
• func GrantAllowsKey(grantedKey, requestedKey string) bool
• func GrantKey(kind Kind, pattern string) string
• type Effect
  • func ExternalDirectoryEffect(path string) Effect
  • func ReadPathEffect(path string) Effect
  • func ShellExecEffect(command string) Effect
  • func WritePathEffect(path string) Effect
• type Grant
  • func ParseGrantKey(key string) (Grant, bool)
• type Kind
• type Plan
• type Risk

Functions

func CleanScope

func CleanScope(path string) string

func GrantAllowsKey

func GrantAllowsKey(grantedKey, requestedKey string) bool

func GrantKey

func GrantKey(kind Kind, pattern string) string

Types

type Effect

type Effect struct {
	Kind     Kind
	Scope    string
	Risk     Risk
	Metadata map[string]string
}

func ExternalDirectoryEffect

func ExternalDirectoryEffect(path string) Effect

func ReadPathEffect

func ReadPathEffect(path string) Effect

func ShellExecEffect

func ShellExecEffect(command string) Effect

func WritePathEffect

func WritePathEffect(path string) Effect

type Grant

type Grant struct {
	Kind    Kind
	Pattern string
	Action  string
}

func ParseGrantKey

func ParseGrantKey(key string) (Grant, bool)

type Kind

type Kind string

const (
	ExternalDirectory Kind = "external_directory"
	ReadPath          Kind = "read_path"
	WritePath         Kind = "write_path"
	ShellExec         Kind = "shell_exec"
)

type Plan

type Plan struct {
	Effects []Effect
	Risk    Risk
}

type Risk

type Risk string

const (
	RiskSafeRead     Risk = "safe_read"
	RiskBoundedWrite Risk = "bounded_write"
	RiskUnknown      Risk = "unknown"
)