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

exec

package

Go to main page

Versions in this module

v0

v0.9.0

Aug 14, 2026

Changes in this version

+ const Allow

+ const Deny

+ const Gated

+ const GrantClassCommandStart

+ const GrantClassFilesystemHostRead

+ const GrantClassFilesystemHostWrite

+ const GrantClassFilesystemPathRead

+ const GrantClassFilesystemPathWrite

+ const GrantClassFilesystemTreeRead

+ const GrantClassFilesystemTreeWrite

+ const GrantClassNetworkBroad

+ const GrantClassNetworkProxyTarget

+ const GuaranteeAddressNetwork

+ const GuaranteeEnvScrub

+ const GuaranteeNetworkBoundary

+ const GuaranteeProcessBoundary

+ const GuaranteeReadBoundary

+ const GuaranteeResourceLimits

+ const GuaranteeTargetNetwork

+ const GuaranteeWriteBoundary

+ const IsolatedHome

+ const LevelDegraded

+ const LevelFull

+ const LevelNone

+ const RealHome

+ const Sandboxed

+ const Unconfined

+ var ErrEgressRouteDenied = network.ErrRouteDenied

+ var ErrExecutorClosed = network.ErrClosed

+ var ErrExecutorLimit = errors.New("sandbox: executor set limit reached")

+ var ErrExecutorSetClosed = errors.New("sandbox: executor set closed")

+ var ErrGrantBadMAC = errors.New("sandbox: grant token MAC mismatch")

+ var ErrGrantDenied = errors.New("sandbox: capability denied")

+ var ErrGrantExpired = errors.New("sandbox: grant token expired")

+ var ErrGrantGuaranteeMismatch = errors.New("sandbox: grant token guarantee mismatch")

+ var ErrGrantMalformed = policy.ErrMalformed

+ var ErrGrantProfileMismatch = errors.New("sandbox: grant token profile mismatch")

+ var ErrGrantReplay = errors.New("sandbox: grant token replay")

+ var ErrGrantRequired = errors.New("sandbox: approval grant required")

+ var ErrGrantRouteMismatch = errors.New("sandbox: grant token route mismatch")

+ var ErrGrantTargetChanged = policy.ErrTargetChanged

+ var ErrGrantUnsupported = policy.ErrUnsupportedClass

+ var ErrGrantWrongCommand = errors.New("sandbox: grant token command mismatch")

+ var ErrGrantWrongExecution = errors.New("sandbox: grant token execution mismatch")

+ var ErrGrantWrongWorkingDirectory = errors.New("sandbox: grant token working directory mismatch")

+ var ErrInvalidProfile = profile.ErrInvalidProfile

+ var ErrNetworkTargetDenied = network.ErrTargetDenied

+ var ErrOutputLimit = errors.New("sandbox: process output limit exceeded")

+ var ErrProcessAlreadyStarted = errors.New("sandbox: process already started")

+ var ErrProcessClosed = errors.New("sandbox: process closed")

+ var ErrProcessConPTYUnavailable = errors.New("sandbox: ConPTY (pseudo console) is not available on this host")

+ var ErrProcessResizeUnsupported = errors.New("sandbox: process resize is not yet supported")

+ var ErrProcessSignalUnsupported = errors.New("sandbox: process signal delivery is not yet supported")

+ var ErrProcessStdinClosed = errors.New("sandbox: process stdin closed")

+ var ErrProcessTTYUnsupported = errors.New("sandbox: process TTY mode is not yet supported")

+ var ErrSandboxUnavailable = enforce.ErrUnavailable

+ type Access = profile.Access

+ type CompileReport = profile.CompileReport

+ type ConPTYAttribute struct

+ PseudoConsoleHandle uintptr

+ type ConPTYBrokerCredentials struct

+ Desktop string

+ TokenHandle uintptr

+ type ConPTYJobAssignment struct

+ JobHandle uintptr

+ type ConPTYLaunchPlan struct

+ func NewConPTYLaunchPlan(pipes ConPTYPipes, attribute ConPTYAttribute, job ConPTYJobAssignment, ...) (*ConPTYLaunchPlan, error)

+ func (plan *ConPTYLaunchPlan) Attribute() ConPTYAttribute

+ func (plan *ConPTYLaunchPlan) Broker() ConPTYBrokerCredentials

+ func (plan *ConPTYLaunchPlan) Job() ConPTYJobAssignment

+ func (plan *ConPTYLaunchPlan) Pipes() ConPTYPipes

+ func (plan *ConPTYLaunchPlan) Steps() []ConPTYLaunchStep

+ func (plan *ConPTYLaunchPlan) Validate() error

+ type ConPTYLaunchStep uint8

+ const ConPTYStepAllocatePipes

+ const ConPTYStepAssignJob

+ const ConPTYStepCreatePseudoConsole

+ const ConPTYStepCreateSuspended

+ const ConPTYStepResume

+ func (step ConPTYLaunchStep) String() string

+ type ConPTYPipes struct

+ ConsoleInputRead uintptr

+ ConsoleInputWrite uintptr

+ ConsoleOutputRead uintptr

+ ConsoleOutputWrite uintptr

+ type EgressRoute = network.Route

+ func NewDirectEgressRoute() (EgressRoute, error)

+ func NewUpstreamEgressRoute(rawURL string, trustedAddressGuarantee bool) (EgressRoute, error)

+ type Executor struct

+ func (e *Executor) GrantVersion() uint16

+ func (e *Executor) GuaranteeBits() uint64

+ func (e *Executor) Guarantees() Guarantees

+ func (e *Executor) IssueGrant(ctx context.Context, ...) (string, error)

+ func (e *Executor) Level() uint8

+ func (e *Executor) PrepareProcess(ctx context.Context, opts ProcessOptions) (*PreparedProcess, error)

+ func (e *Executor) Report() CompileReport

+ func (e *Executor) RunArgv(ctx context.Context, dir string, argv []string) ([]byte, int, error)

+ func (e *Executor) RunArgvLimited(ctx context.Context, dir string, argv []string, maxOutputBytes int64) ([]byte, int, error)

+ func (e *Executor) RunCommand(ctx context.Context, dir, command string) ([]byte, int, error)

+ func (e *Executor) RunCommandWithGrants(ctx context.Context, executionID, dir, command string, grants []string) ([]byte, int, error)

+ type ExecutorSet struct

+ func NewExecutorSet(prof *Profile, options ...ExecutorSetOption) (*ExecutorSet, error)

+ func (set *ExecutorSet) Close() error

+ func (set *ExecutorSet) For(key string) (*Executor, error)

+ type ExecutorSetOption func(*executorSetConfig)

+ func WithEgressRoute(route EgressRoute) ExecutorSetOption

+ func WithGrantTTL(duration time.Duration) ExecutorSetOption

+ func WithMaxExecutors(max int) ExecutorSetOption

+ func WithScratchRoot(path string) ExecutorSetOption

+ func WithWindowsSandboxMode(mode windows.SandboxMode) ExecutorSetOption

+ func WithWindowsSandboxStateRoot(path string) ExecutorSetOption

+ type Guarantees = profile.Guarantees

+ type Home = profile.Home

+ type Isolation = profile.Isolation

+ type LifetimeContainment uint8

+ const LifetimeContainmentBestEffort

+ const LifetimeContainmentEnforced

+ const LifetimeContainmentUnspecified

+ func (c LifetimeContainment) String() string

+ type NetworkTarget = network.Target

+ func ParseNetworkTarget(raw string) (NetworkTarget, error)

+ type PreparedProcess struct

+ func (p *PreparedProcess) Close() error

+ func (p *PreparedProcess) EffectiveAccess() ProcessAccess

+ func (p *PreparedProcess) Start(ctx context.Context) (*Process, error)

+ type Process struct

+ func (p *Process) Activities() <-chan ProcessActivity

+ func (p *Process) Close(ctx context.Context) error

+ func (p *Process) LifetimeContainment() LifetimeContainment

+ func (p *Process) Resize(ctx context.Context, rows, cols uint16) error

+ func (p *Process) Signal(ctx context.Context, kind ProcessSignal) error

+ func (p *Process) Stderr() io.ReadCloser

+ func (p *Process) Stdin() io.WriteCloser

+ func (p *Process) Stdout() io.ReadCloser

+ func (p *Process) StreamMode() ProcessStreamMode

+ func (p *Process) Wait(ctx context.Context) (ProcessResult, error)

+ type ProcessAccess struct

+ Kind ProcessAccessKind

+ func (a ProcessAccess) WritePaths() []string

+ func (a ProcessAccess) WriteTrees() []string

+ type ProcessAccessKind uint8

+ const ProcessAccessBroadWrite

+ const ProcessAccessReadOnly

+ const ProcessAccessScopedWrite

+ func (k ProcessAccessKind) Valid() bool

+ type ProcessActivity struct

+ Kind ProcessActivityKind

+ func (a ProcessActivity) EffectiveKind() ProcessActivityKind

+ type ProcessActivityKind uint8

+ const ProcessActivityBroadWrite

+ const ProcessActivityWrite

+ func (k ProcessActivityKind) Valid() bool

+ type ProcessOptions struct

+ Command string

+ Deadline time.Time

+ Directory string

+ ExecutionID string

+ Grants []string

+ TTY bool

+ TerminateGrace time.Duration

+ type ProcessResult struct

+ ExitCode int

+ FinishedAt time.Time

+ StartedAt time.Time

+ type ProcessSignal uint8

+ const ProcessSignalInterrupt

+ const ProcessSignalKill

+ const ProcessSignalTerminate

+ func (s ProcessSignal) Valid() bool

+ type ProcessStreamMode uint8

+ const ProcessStreamModePTY

+ const ProcessStreamModePipes

+ func (m ProcessStreamMode) Valid() bool

+ type Profile = profile.Profile

+ func NewProfile(config ProfileConfig) (*Profile, error)

+ func Restrict(base, ceiling *Profile) (*Profile, error)

+ type ProfileConfig = profile.ProfileConfig

+ type ReportEntry = profile.ReportEntry

+ type RootAccess = profile.RootAccess

v0.8.1

Aug 11, 2026

v0.8.0

Aug 11, 2026

v0.7.0

Aug 7, 2026

v0.6.1

Aug 7, 2026

v0.6.0

Aug 7, 2026

v0.5.1

Aug 5, 2026

v0.5.0

Jul 30, 2026

v0.4.0

Jul 28, 2026