bwrap

Documentation

Index

• Constants
• type Builder
• type ChmodConfig
  • func (c ChmodConfig) Append(args *[]string)
  • func (c ChmodConfig) Len() int
• type Config
  • func (c *Config) Args() (args []string)
  • func (c *Config) Bind(src, dest string, opts ...bool) *Config
  • func (c *Config) DevTmpfs(dest string) *Config
  • func (c *Config) Dir(dest string) *Config
  • func (c *Config) Mqueue(dest string) *Config
  • func (c *Config) Procfs(dest string) *Config
  • func (c *Config) RemountRO(dest string) *Config
  • func (c *Config) SetGID(gid int) *Config
  • func (c *Config) SetUID(uid int) *Config
  • func (c *Config) Symlink(src, dest string, perm ...os.FileMode) *Config
  • func (c *Config) Tmpfs(dest string, size int, perm ...os.FileMode) *Config
• type FSBuilder
• type PermConfig
  • func (p *PermConfig[T]) Append(args *[]string)
  • func (p *PermConfig[T]) Len() int
  • func (p *PermConfig[T]) Path() string
• type SymlinkConfig
  • func (s SymlinkConfig) Append(args *[]string)
  • func (s SymlinkConfig) Len() int
  • func (s SymlinkConfig) Path() string
• type TmpfsConfig
  • func (t *TmpfsConfig) Append(args *[]string)
  • func (t *TmpfsConfig) Len() int
  • func (t *TmpfsConfig) Path() string
• type UnshareConfig

Constants

const (
	Tmpfs = iota
	Dir
	Symlink
)

const (
	UnshareAll = iota
	UnshareUser
	UnshareIPC
	UnsharePID
	UnshareNet
	UnshareUTS
	UnshareCGroup
	ShareNet

	UserNS
	Clearenv

	NewSession
	DieWithParent
	AsInit
)

const (
	UID = iota
	GID
	Perms
	Size
)

const (
	SetEnv = iota

	Bind
	BindTry
	DevBind
	DevBindTry
	ROBind
	ROBindTry

	Chmod
)

const (
	Hostname = iota
	Chdir
	UnsetEnv
	LockFile

	RemountRO
	Procfs
	DevTmpfs
	Mqueue
)

Types

type Builder

type Builder interface {
	Len() int
	Append(args *[]string)
}

type ChmodConfig

type ChmodConfig map[string]os.FileMode

func (ChmodConfig) Append

func (c ChmodConfig) Append(args *[]string)

func (ChmodConfig) Len

func (c ChmodConfig) Len() int

type Config

type Config struct {
	// unshare every namespace we support by default if nil
	// (--unshare-all)
	Unshare *UnshareConfig `json:"unshare,omitempty"`
	// retain the network namespace (can only combine with nil Unshare)
	// (--share-net)
	Net bool `json:"net"`

	// disable further use of user namespaces inside sandbox and fail unless
	// further use of user namespace inside sandbox is disabled if false
	// (--disable-userns) (--assert-userns-disabled)
	UserNS bool `json:"userns"`

	// custom uid in the sandbox, requires new user namespace
	// (--uid UID)
	UID *int `json:"uid,omitempty"`
	// custom gid in the sandbox, requires new user namespace
	// (--gid GID)
	GID *int `json:"gid,omitempty"`
	// custom hostname in the sandbox, requires new uts namespace
	// (--hostname NAME)
	Hostname string `json:"hostname,omitempty"`

	// change directory
	// (--chdir DIR)
	Chdir string `json:"chdir,omitempty"`
	// unset all environment variables
	// (--clearenv)
	Clearenv bool `json:"clearenv"`
	// set environment variable
	// (--setenv VAR VALUE)
	SetEnv map[string]string `json:"setenv,omitempty"`
	// unset environment variables
	// (--unsetenv VAR)
	UnsetEnv []string `json:"unsetenv,omitempty"`

	// take a lock on file while sandbox is running
	// (--lock-file DEST)
	LockFile []string `json:"lock_file,omitempty"`

	// ordered filesystem args
	Filesystem []FSBuilder

	// change permissions (must already exist)
	// (--chmod OCTAL PATH)
	Chmod ChmodConfig `json:"chmod,omitempty"`

	// create a new terminal session
	// (--new-session)
	NewSession bool `json:"new_session"`
	// kills with SIGKILL child process (COMMAND) when bwrap or bwrap's parent dies.
	// (--die-with-parent)
	DieWithParent bool `json:"die_with_parent"`
	// do not install a reaper process with PID=1
	// (--as-pid-1)
	AsInit bool `json:"as_init"`
}

func (*Config) Args

func (c *Config) Args() (args []string)

Args returns a slice of bwrap args corresponding to c.

func (*Config) Bind

func (c *Config) Bind(src, dest string, opts ...bool) *Config

Bind binds mount src on host to dest in sandbox.

Bind(src, dest) bind mount host path readonly on sandbox (--ro-bind SRC DEST). Bind(src, dest, true) equal to ROBind but ignores non-existent host path (--ro-bind-try SRC DEST).

Bind(src, dest, false, true) bind mount host path on sandbox. (--bind SRC DEST). Bind(src, dest, true, true) equal to Bind but ignores non-existent host path (--bind-try SRC DEST).

Bind(src, dest, false, true, true) bind mount host path on sandbox, allowing device access (--dev-bind SRC DEST). Bind(src, dest, true, true, true) equal to DevBind but ignores non-existent host path (--dev-bind-try SRC DEST).

func (*Config) DevTmpfs

func (c *Config) DevTmpfs(dest string) *Config

DevTmpfs mount new dev in sandbox (--dev DEST)

func (*Config) Dir

func (c *Config) Dir(dest string) *Config

Dir create dir in sandbox (--dir DEST)

func (*Config) Mqueue

func (c *Config) Mqueue(dest string) *Config

Mqueue mount new mqueue in sandbox (--mqueue DEST)

func (*Config) Procfs

func (c *Config) Procfs(dest string) *Config

Procfs mount new procfs in sandbox (--proc DEST)

func (*Config) RemountRO

func (c *Config) RemountRO(dest string) *Config

RemountRO remount path as readonly; does not recursively remount (--remount-ro DEST)

func (*Config) SetGID

func (c *Config) SetGID(gid int) *Config

SetGID sets custom gid in the sandbox, requires new user namespace (--gid GID).

func (*Config) SetUID

func (c *Config) SetUID(uid int) *Config

SetUID sets custom uid in the sandbox, requires new user namespace (--uid UID).

func (*Config) Symlink

func (c *Config) Symlink(src, dest string, perm ...os.FileMode) *Config

Symlink create symlink within sandbox (--symlink SRC DEST)

func (*Config) Tmpfs

func (c *Config) Tmpfs(dest string, size int, perm ...os.FileMode) *Config

Tmpfs mount new tmpfs in sandbox (--tmpfs DEST)

type FSBuilder

type FSBuilder interface {
	Path() string
	Builder
}

type PermConfig

type PermConfig[T FSBuilder] struct {
	// set permissions of next argument
	// (--perms OCTAL)
	Mode *os.FileMode `json:"mode,omitempty"`
	// path to get the new permission
	// (--bind-data, --file, etc.)
	Inner T `json:"path"`
}

func (*PermConfig[T]) Append

func (p *PermConfig[T]) Append(args *[]string)

func (*PermConfig[T]) Len

func (p *PermConfig[T]) Len() int

func (*PermConfig[T]) Path

func (p *PermConfig[T]) Path() string

type SymlinkConfig

type SymlinkConfig [2]string

func (SymlinkConfig) Append

func (s SymlinkConfig) Append(args *[]string)

func (SymlinkConfig) Len

func (s SymlinkConfig) Len() int

func (SymlinkConfig) Path

func (s SymlinkConfig) Path() string

type TmpfsConfig

type TmpfsConfig struct {
	// set size of tmpfs
	// (--size BYTES)
	Size int `json:"size,omitempty"`
	// mount point of new tmpfs
	// (--tmpfs DEST)
	Dir string `json:"dir"`
}

func (*TmpfsConfig) Append

func (t *TmpfsConfig) Append(args *[]string)

func (*TmpfsConfig) Len

func (t *TmpfsConfig) Len() int

func (*TmpfsConfig) Path

func (t *TmpfsConfig) Path() string

type UnshareConfig

type UnshareConfig struct {
	// (--unshare-user)
	// create new user namespace
	User bool `json:"user"`
	// (--unshare-ipc)
	// create new ipc namespace
	IPC bool `json:"ipc"`
	// (--unshare-pid)
	// create new pid namespace
	PID bool `json:"pid"`
	// (--unshare-net)
	// create new network namespace
	Net bool `json:"net"`
	// (--unshare-uts)
	// create new uts namespace
	UTS bool `json:"uts"`
	// (--unshare-cgroup)
	// create new cgroup namespace
	CGroup bool `json:"cgroup"`
}