pysandbox 项目技术文档

1. 安装指南

环境要求

• Python 2.5 或 2.6
• Linux 操作系统

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/haypo/pysandbox.git
   

2. 进入项目目录：

   cd pysandbox
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 安装 pysandbox：

   python setup.py install
   

2. 项目的使用说明

基本概念

pysandbox 是一个 Python 沙盒环境，用于在受限的环境中执行不受信任的代码。默认情况下，沙盒会阻止对文件系统、模块导入、退出 Python 等功能的访问。用户可以通过配置沙盒来选择允许或禁止某些功能。

主要功能

• 阻止访问文件系统：默认情况下，沙盒中的代码无法访问文件系统。
• 阻止模块导入：默认情况下，沙盒中的代码无法导入 Python 模块。
• 阻止退出 Python：默认情况下，沙盒中的代码无法退出 Python 解释器。
• 阻止访问标准输入输出：默认情况下，沙盒中的代码无法访问 stdin、stdout 或 stderr。
• 阻止执行任意字节码：默认情况下，沙盒中的代码无法执行任意字节码。

配置沙盒

用户可以通过 SandboxConfig 类来配置沙盒。例如，启用某些功能或模块：

from sandbox import Sandbox, SandboxConfig

config = SandboxConfig('stdout', 'math')
sandbox = Sandbox(config)

3. 项目API使用文档

Sandbox 类

Sandbox 类是 pysandbox 的核心类，用于创建和管理沙盒环境。

方法

• __init__(self, config=None)：初始化沙盒，config 参数为 SandboxConfig 对象。
• call(self, func, *args, **kwargs)：在沙盒中调用函数 func，并传递参数 *args 和 **kwargs。
• execute(self, code, globals=None, locals=None)：在沙盒中执行代码字符串 code，并可选地传递全局和局部变量。

SandboxConfig 类

SandboxConfig 类用于配置沙盒的行为。

方法

• __init__(self, *features, **kwargs)：初始化配置，features 参数为允许的功能列表。
• enable(self, feature)：启用某个功能。
• allowPath(self, path)：允许从指定路径读取文件。
• allowModule(self, name, *symbols)：允许导入指定模块，并限制只能访问指定的符号。

4. 项目安装方式

通过源码安装

1. 克隆项目仓库：

   git clone https://github.com/haypo/pysandbox.git
   

2. 进入项目目录：

   cd pysandbox
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 安装 pysandbox：

   python setup.py install
   

通过 pip 安装

pip install pysandbox

5. 注意事项

• pysandbox 的设计存在缺陷，建议使用其他沙盒解决方案。
• 沙盒仅保护 Python 命名空间，不保护系统免受 Python 安全漏洞的影响。
• 默认情况下，沙盒中的代码在子进程中执行，具有超时、内存限制等保护措施。