jsonnetsecure

Documentation

Index

• Constants
• Variables
• func JsonnetTestBinary(t testing.TB) string
• func NewJsonnetCmd() *cobra.Command
• func SetVirtualMemoryLimit(limitBytes uint64) error
• type DefaultProvider
  • func (p *DefaultProvider) JsonnetVM(ctx context.Context) (VM, error)
• type ErrorImporter
  • func (importer *ErrorImporter) Import(importedFrom, importedPath string) (contents jsonnet.Contents, foundAt string, err error)
• type Option
  • func WithJsonnetBinary(jsonnetBinaryPath string) Option
  • func WithProcessArgs(args ...string) Option
  • func WithProcessPool(p Pool) Option
• type Pool
  • func NewProcessPool(size int) Pool
• type ProcessVM
• type TestProvider
  • func NewTestProvider(t testing.TB) *TestProvider
  • func (p *TestProvider) JsonnetVM(ctx context.Context) (VM, error)
• type VM
  • func MakeSecureVM(opts ...Option) VM
  • func NewProcessPoolVM(opts *vmOptions) VM
• type VMProvider

Constants

const (
	GiB uint64 = 1024 * 1024 * 1024
)

const (
	KiB = 1024
)

Variables

var (
	ErrProcessPoolClosed = errors.New("jsonnetsecure: process pool closed")
)

Functions

func JsonnetTestBinary

func JsonnetTestBinary(t testing.TB) string

func NewJsonnetCmd

func NewJsonnetCmd() *cobra.Command

func SetVirtualMemoryLimit

func SetVirtualMemoryLimit(limitBytes uint64) error

Types

type DefaultProvider

type DefaultProvider struct {
	Subcommand string
	Pool       Pool
}

DefaultProvider provides a secure VM by calling the currently running the current binary with the provided subcommand.

func (*DefaultProvider) JsonnetVM

func (p *DefaultProvider) JsonnetVM(ctx context.Context) (VM, error)

type ErrorImporter

type ErrorImporter struct{}

ErrorImporter errors when calling "import".

func (*ErrorImporter) Import

func (importer *ErrorImporter) Import(importedFrom, importedPath string) (contents jsonnet.Contents, foundAt string, err error)

Import fetches data from a map entry. All paths are treated as absolute keys.

type Option

type Option func(o *vmOptions)

func WithJsonnetBinary

func WithJsonnetBinary(jsonnetBinaryPath string) Option

func WithProcessArgs

func WithProcessArgs(args ...string) Option

func WithProcessPool

func WithProcessPool(p Pool) Option

type Pool

type Pool interface {
	Close()
	// contains filtered or unexported methods
}

func NewProcessPool

func NewProcessPool(size int) Pool

type ProcessVM

type ProcessVM struct {
	// contains filtered or unexported fields
}

type TestProvider

type TestProvider struct {
	// contains filtered or unexported fields
}

TestProvider provides a secure VM by running go build on github. com/ory/x/jsonnetsecure/cmd.

func NewTestProvider

func NewTestProvider(t testing.TB) *TestProvider

func (*TestProvider) JsonnetVM

func (p *TestProvider) JsonnetVM(ctx context.Context) (VM, error)

type VM

type VM interface {
	EvaluateAnonymousSnippet(filename string, snippet string) (json string, formattedErr error)
	ExtCode(key string, val string)
	ExtVar(key string, val string)
	TLACode(key string, val string)
	TLAVar(key string, val string)
}

func MakeSecureVM

func MakeSecureVM(opts ...Option) VM

func NewProcessPoolVM

func NewProcessPoolVM(opts *vmOptions) VM

type VMProvider

type VMProvider interface {
	// JsonnetVM creates a new secure process-isolated Jsonnet VM whose
	// execution is bound to the provided context, i.e.,
	// cancelling the context will terminate the VM process.
	JsonnetVM(context.Context) (VM, error)
}