Class CodeSandbox

Code Execution Sandbox implementation.

Runs code with a time limit and a minimal set of globals: JavaScript in a node:vm context inside this process, Python in a child process. node:vm is not a security mechanism (Node's documentation).

Implements

ICodeSandbox

Index

Constructors

Methods

initialize execute kill getExecution listExecutions isLanguageSupported getSupportedLanguages getStats resetStats validateCode dispose

Constructors

constructor

new CodeSandbox(defaultConfig?): CodeSandbox
Parameters
- Optional defaultConfig: Partial<SandboxConfig>
Returns CodeSandbox
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:182

Methods

initialize

initialize(logger?, defaultConfig?): Promise<void>
Initializes the sandbox.
Parameters
- Optional logger: ILogger
- Optional defaultConfig: SandboxConfig
Returns Promise<void>
Implementation of ICodeSandbox.initialize
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:190

execute

execute(request): Promise<ExecutionResult>
Executes code in the sandbox.
Parameters
- request: ExecutionRequest
Returns Promise<ExecutionResult>
Implementation of ICodeSandbox.execute
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:201

kill

kill(executionId): Promise<boolean>
Kills a running execution.
Parameters
- executionId: string
Returns Promise<boolean>
Implementation of ICodeSandbox.kill
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:641

getExecution

getExecution(executionId): Promise<undefined | ExecutionResult>
Gets the status of an execution.
Parameters
- executionId: string
Returns Promise<undefined | ExecutionResult>
Implementation of ICodeSandbox.getExecution
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:658

listExecutions

listExecutions(limit?): Promise<ExecutionResult[]>
Lists recent executions.
Parameters
- limit: number = 50
Returns Promise<ExecutionResult[]>
Implementation of ICodeSandbox.listExecutions
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:665

isLanguageSupported

isLanguageSupported(language): boolean
Checks if a language is supported.
Parameters
- language: string
Returns boolean
Implementation of ICodeSandbox.isLanguageSupported
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:674

getSupportedLanguages

getSupportedLanguages(): SandboxLanguage[]
Gets supported languages.

Returns SandboxLanguage[]
Implementation of ICodeSandbox.getSupportedLanguages
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:681

getStats

getStats(): SandboxStats
Gets sandbox statistics.

Returns SandboxStats
Implementation of ICodeSandbox.getStats
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:688

resetStats

resetStats(): void
Resets statistics.

Returns void
Implementation of ICodeSandbox.resetStats
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:695

validateCode

validateCode(language, code): SecurityEvent[]
Validates code for security issues.
Parameters
- language: SandboxLanguage
- code: string
Returns SecurityEvent[]
Implementation of ICodeSandbox.validateCode
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:702

dispose

dispose(): Promise<void>
Disposes of the sandbox.

Returns Promise<void>
Implementation of ICodeSandbox.dispose
- Defined in src/safety/sandbox/executor/CodeSandbox.ts:724