Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sandbox

package

Go to main page

Versions in this module

v0

v0.3.0

Aug 16, 2026

Changes in this version

+ var ErrSizeNotALength = errors.New("sandbox: size is not a length")

+ func CheckWriteSize(size int64) error

type Provider

+ Attach func(ctx context.Context, sessionID domain.ID) (Sandbox, error)

v0.2.0

Aug 7, 2026

Changes in this version

+ const BulkDiscardShell

+ const BulkPrepareShell

+ const BulkRenameShell

+ const DefaultCPUMillis

+ const DefaultPidsLimit

+ const ExitBulkExtract

+ const ExitBulkIncomplete

+ const ExitPathIsDirectory

+ const ExitPathNotDirectory

+ const ExitPathNotReplaceable

+ const ExitPathNotWritable

+ const PathFaultShell

+ const PreserveModeShell

+ const ShellStateRoot

+ const TempPrefix

+ const UnreplaceableShell

+ var DefaultCapDrop = []string

+ var ErrNotDirectory = errors.New("sandbox: path is not a directory")

+ var ErrNotReplaceable = errors.New("sandbox: target cannot be replaced")

+ var ErrNotWritable = errors.New("sandbox: target cannot be written")

+ var ErrSpecMismatch = errors.New("sandbox: existing sandbox does not match the requested spec")

+ func ReservedEnvName(k string) bool

+ func TempName() string

+ func ValidEnvName(k string) bool

+ func ValidateEnv(env map[string]string) error

+ func WritablePaths(workdir string) []string

+ type BulkWrite struct

+ DirList string

+ Manifest string

+ func NewBulkWrite(workdir string, files []FileWrite) (*BulkWrite, error)

+ func (b *BulkWrite) Archive(w io.Writer) error

+ func (b *BulkWrite) Bookkeeping(w io.Writer) error

+ func (b *BulkWrite) Delivered() []string

+ func (b *BulkWrite) EmptyArchive(paths []string, w io.Writer) error

+ func (b *BulkWrite) Fault(backend string, code int, stderr string) error

+ func (b *BulkWrite) LeftBehind(stdout string) []string

+ func (b *BulkWrite) LostItsList(stdout string) bool

+ func (b *BulkWrite) Members(w io.Writer) error

+ type FileWrite struct

+ Data []byte

+ Path string

+ type GateSpec struct

+ ControlplaneURL string

+ Image string

+ OTelEndpoint string

+ OTelInsecure bool

+ TokenMinter GateTokenMinter

+ type GateTokenMinter interface

+ Generate func() string

+ Persist func(ctx context.Context, sessionID domain.ID, token string) error

+ type GateTokenRevoker interface

+ Revoke func(ctx context.Context, sessionID domain.ID) error

+ type Hardening struct

+ CPUMillis int64

+ CapDrop []string

+ EphemeralStorageBytes int64

+ MemoryBytes int64

+ PidsLimit int64

+ ReadOnlyRootfs bool

+ RunAsUser *int64

+ func HardeningFromEnv() (Hardening, error)

+ func (h Hardening) EffectiveCapDrop(gated bool) []string

+ func (h Hardening) Validate(gated bool) error

+ type PathNotWritableError struct

+ Path string

+ Reason string

+ func (e *PathNotWritableError) Error() string

+ func (e *PathNotWritableError) Is(target error) bool

type Provider

+ Export func(ctx context.Context, sessionID domain.ID, root string) (io.ReadCloser, error)

+ Owned func(ctx context.Context) ([]domain.ID, error)

+ Reap func(ctx context.Context, sessionID domain.ID) error

type Sandbox

+ ReadFileStream func(ctx context.Context, path string, maxBytes int64) (io.ReadCloser, int64, error)

+ WriteFileStream func(ctx context.Context, path string, src io.Reader, size int64) error

+ WriteFiles func(ctx context.Context, files []FileWrite) error

type Spec

+ Env map[string]string

+ Gate *GateSpec

+ GateTokenRevoker GateTokenRevoker

+ Hardening Hardening

v0.1.0

Jul 16, 2026

Changes in this version

+ const DefaultWorkdir

+ const MaxFileBytes

+ const MaxOutputBytes

+ var ErrFileNotExist = errors.New("sandbox: no such file")

+ var ErrFileTooLarge = errors.New("sandbox: file too large")

+ var ErrIsDirectory = errors.New("sandbox: path is a directory")

+ var ErrNotFound = errors.New("sandbox: no such sandbox")

+ var ErrNotRegularFile = errors.New("sandbox: not a regular file")

+ type ExecRequest struct

+ Command string

+ Timeout time.Duration

+ type ExecResult struct

+ ExitCode int

+ Stderr string

+ Stdout string

+ TimedOut bool

+ Truncated bool

+ type Provider interface

+ Provision func(ctx context.Context, spec Spec) (Sandbox, error)

+ type Sandbox interface

+ Destroy func(ctx context.Context) error

+ Exec func(ctx context.Context, req ExecRequest) (ExecResult, error)

+ ID func() string

+ ReadFile func(ctx context.Context, path string) ([]byte, error)

+ WriteFile func(ctx context.Context, path string, data []byte) error

+ type Spec struct

+ Image string

+ Networking domain.Networking

+ SessionID domain.ID

+ Workdir string