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

sandboxbroker

package module

Go to main page

Versions in this module

v1

v1.10.4

Nov 4, 2026

v1.10.3

Oct 30, 2026

v1.9.0

Oct 27, 2026

Changes in this version

+ var ErrConflict = errors.New("cortex: sandbox job identity conflict")

+ var ErrDenied = errors.New("cortex: sandbox access denied")

+ var ErrNotFound = errors.New("cortex: sandbox job not found")

+ var ErrPending = errors.New("cortex: sandbox result pending")

+ func ReadExport(directory, name string, maximum int64) ([]byte, error) — darwin/amd64, linux/amd64

+ func ValidateRuntimeResult(result sandbox.Result, j sandbox.Job) error

+ func VerifyReceipt(receipt sandbox.Receipt, key ed25519.PublicKey) error

+ func VerifyResult(result sandbox.Result, j sandbox.Job, key ed25519.PublicKey) error

+ func WithIdentity(ctx context.Context, who Identity) context.Context

+ type Authenticator func(*http.Request) (Identity, error)

+ type Authorizer func(context.Context, Identity, sandbox.Job) error

+ type Broker struct

+ func Open(cfg Config) (*Broker, error)

+ func (b *Broker) Cancel(ctx context.Context, key id.ID) error

+ func (b *Broker) Capabilities(ctx context.Context) (sandbox.Capabilities, error)

+ func (b *Broker) Close() error

+ func (b *Broker) Collect(ctx context.Context, key id.ID) (sandbox.Result, error)

+ func (b *Broker) Handler(authenticate Authenticator) http.Handler

+ func (b *Broker) Inspect(ctx context.Context, key id.ID) (sandbox.JobStatus, error)

+ func (b *Broker) PublicKey() ed25519.PublicKey

+ func (b *Broker) Reconcile(ctx context.Context, now time.Time) error

+ func (b *Broker) Submit(ctx context.Context, j sandbox.Job) (sandbox.Receipt, error)

+ type Client struct

+ func NewClient(endpoint string, transport *http.Client, key ed25519.PublicKey) (*Client, error)

+ func (c *Client) Cancel(ctx context.Context, key id.ID) error

+ func (c *Client) Capabilities(ctx context.Context) (sandbox.Capabilities, error)

+ func (c *Client) Collect(ctx context.Context, key id.ID) (sandbox.Result, error)

+ func (c *Client) Inspect(ctx context.Context, key id.ID) (sandbox.JobStatus, error)

+ func (c *Client) Submit(ctx context.Context, j sandbox.Job) (sandbox.Receipt, error)

+ type Config struct

+ Authorize Authorizer

+ Database string

+ Images []string

+ MaxActive int

+ MaxJobs int

+ Name string

+ Now func() time.Time

+ Runtime Runtime

+ SigningKey ed25519.PrivateKey

+ type Identity struct

+ Principal string

+ Scope cortex.Scope

+ type Runtime interface

+ Cancel func(context.Context, id.ID) error

+ Capabilities func(context.Context) (sandbox.Capabilities, error)

+ Inspect func(context.Context, id.ID) (sandbox.Result, error)

+ Start func(context.Context, sandbox.Receipt) error

+ type Server struct

+ func NewServer(cfg ServerConfig) (*Server, error)

+ func (s *Server) Serve(ctx context.Context, listener net.Listener, instance *Broker) error

+ func (s *Server) ServeHandler(ctx context.Context, listener net.Listener, handler http.Handler) error

+ type ServerConfig struct

+ Authenticate Authenticator

+ Certificate tls.Certificate

+ ClientCAs *x509.CertPool

+ Limits ServerLimits

+ type ServerLimits struct

+ Connections int

+ HeaderBytes int

+ HeaderTimeout time.Duration

+ IdleTimeout time.Duration

+ RequestTimeout time.Duration

+ func (l ServerLimits) Validate() error