mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-04-10 21:12:37 +00:00
* fix: add path and URL validation to RAG tools Add validation utilities to prevent unauthorized file reads and SSRF when RAG tools accept LLM-controlled paths/URLs at runtime. Changes: - New crewai_tools.utilities.safe_path module with validate_file_path(), validate_directory_path(), and validate_url() - File paths validated against base directory (defaults to cwd). Resolves symlinks and ../ traversal. Rejects escape attempts. - URLs validated: file:// blocked entirely. HTTP/HTTPS resolves DNS and blocks private/reserved IPs (10.x, 172.16-31.x, 192.168.x, 127.x, 169.254.x, 0.0.0.0, ::1, fc00::/7). - Validation applied in RagTool.add() — catches all RAG search tools (JSON, CSV, PDF, TXT, DOCX, MDX, Directory, etc.) - Removed file:// scheme support from DataTypes.from_content() - CREWAI_TOOLS_ALLOW_UNSAFE_PATHS=true env var for backward compat - 27 tests covering traversal, symlinks, private IPs, cloud metadata, IPv6, escape hatch, and valid paths/URLs * fix: validate path/URL keyword args in RagTool.add() The original patch validated positional *args but left all keyword arguments (path=, file_path=, directory_path=, url=, website=, github_url=, youtube_url=) unvalidated, providing a trivial bypass for both path-traversal and SSRF checks. Applies validate_file_path() to path/file_path/directory_path kwargs and validate_url() to url/website/github_url/youtube_url kwargs before they reach the adapter. Adds a regression-test file covering all eight kwarg vectors plus the two existing positional-arg checks. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: address CodeQL and review comments on RAG path/URL validation - Replace insecure tempfile.mktemp() with inline symlink target in test - Remove unused 'target' variable and unused tempfile import - Narrow broad except Exception: pass to only catch urlparse errors; validate_url ValueError now propagates instead of being silently swallowed - Fix ruff B904 (raise-without-from-inside-except) in safe_path.py - Fix ruff B007 (unused loop variable 'family') in safe_path.py - Use validate_directory_path in DirectorySearchTool.add() so the public utility is exercised in production code Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * style: fix ruff format + remaining lint issues * fix: resolve mypy type errors in RAG path/URL validation - Cast sockaddr[0] to str() to satisfy mypy (socket.getaddrinfo returns sockaddr where [0] is str but typed as str | int) - Remove now-unnecessary `type: ignore[assignment]` and `type: ignore[literal-required]` comments in rag_tool.py Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: unroll dynamic TypedDict key loops to satisfy mypy literal-required Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * test: allow tmp paths in RAG data-type tests via CREWAI_TOOLS_ALLOW_UNSAFE_PATHS TemporaryDirectory creates files under /tmp/ which is outside CWD and is correctly blocked by the new path validation. These tests exercise data-type handling, not security, so add an autouse fixture that sets CREWAI_TOOLS_ALLOW_UNSAFE_PATHS=true for the whole file. Path/URL security is covered by test_rag_tool_path_validation.py. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * test: allow tmp paths in search-tool and rag_tool tests via CREWAI_TOOLS_ALLOW_UNSAFE_PATHS test_search_tools.py has tests for TXTSearchTool, CSVSearchTool, MDXSearchTool, JSONSearchTool, and DirectorySearchTool that create files under /tmp/ via tempfile, which is outside CWD and correctly blocked by the new path validation. rag_tool_test.py has one test that calls tool.add() with a TemporaryDirectory path. Add the same autouse allow_tmp_paths fixture used in test_rag_tool_add_data_type.py. Security is covered separately by test_rag_tool_path_validation.py. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: update tool specifications * docs: document CodeInterpreterTool removal and RAG path/URL validation Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: address three review comments on path/URL validation - safe_path._is_private_or_reserved: after unwrapping IPv4-mapped IPv6 to IPv4, only check against IPv4 networks to avoid TypeError when comparing an IPv4Address against IPv6Network objects. - safe_path.validate_file_path: handle filesystem-root base_dir ('/') by not appending os.sep when the base already ends with a separator, preventing the '//'-prefix bug. - rag_tool.add: path-detection heuristic now checks for both '/' and os.sep so forward-slash paths are caught on Windows as well as Unix. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: remove unused _BLOCKED_NETWORKS variable after IPv4/IPv6 split * chore: update tool specifications --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
215 lines
9.5 KiB
Plaintext
215 lines
9.5 KiB
Plaintext
---
|
|
title: مفسّر الكود
|
|
description: أداة `CodeInterpreterTool` هي أداة قوية مصممة لتنفيذ كود Python 3 في بيئة آمنة ومعزولة.
|
|
icon: code-simple
|
|
mode: "wide"
|
|
---
|
|
|
|
# `CodeInterpreterTool`
|
|
|
|
<Warning>
|
|
**مهجور:** تمت إزالة `CodeInterpreterTool` من `crewai-tools`. كما أن معاملَي `allow_code_execution` و`code_execution_mode` على `Agent` أصبحا مهجورَين. استخدم خدمة بيئة معزولة مخصصة — [E2B](https://e2b.dev) أو [Modal](https://modal.com) — لتنفيذ الكود بشكل آمن ومعزول.
|
|
</Warning>
|
|
|
|
## الوصف
|
|
|
|
تمكّن `CodeInterpreterTool` وكلاء CrewAI من تنفيذ كود Python 3 الذي يولّدونه بشكل مستقل. هذه الوظيفة ذات قيمة خاصة لأنها تتيح للوكلاء إنشاء الكود وتنفيذه والحصول على النتائج واستخدام تلك المعلومات لاتخاذ القرارات والإجراءات اللاحقة.
|
|
|
|
هناك عدة طرق لاستخدام هذه الأداة:
|
|
|
|
### حاوية Docker (موصى بها)
|
|
|
|
هذا هو الخيار الأساسي. يُنفَّذ الكود في حاوية Docker آمنة ومعزولة، مما يضمن السلامة بغض النظر عن محتواه.
|
|
تأكد من تثبيت Docker وتشغيله على نظامك. إذا لم يكن لديك، يمكنك تثبيته من [هنا](https://docs.docker.com/get-docker/).
|
|
|
|
### بيئة الحماية
|
|
|
|
إذا لم يكن Docker متاحاً - إما غير مُثبّت أو غير قابل للوصول لأي سبب - سيُنفَّذ الكود في بيئة Python مقيدة تُسمى بيئة الحماية.
|
|
هذه البيئة محدودة جداً، مع قيود صارمة على العديد من الوحدات والدوال المدمجة.
|
|
|
|
### التنفيذ غير الآمن
|
|
|
|
**غير موصى به للإنتاج**
|
|
يسمح هذا الوضع بتنفيذ أي كود Python، بما في ذلك الاستدعاءات الخطيرة لـ `sys, os..` والوحدات المماثلة. [اطلع على](/ar/tools/ai-ml/codeinterpretertool#enabling-unsafe-mode) كيفية تفعيل هذا الوضع
|
|
|
|
## التسجيل
|
|
|
|
تسجّل `CodeInterpreterTool` استراتيجية التنفيذ المختارة في STDOUT
|
|
|
|
|
|
## التثبيت
|
|
|
|
لاستخدام هذه الأداة، تحتاج إلى تثبيت حزمة أدوات CrewAI:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## مثال
|
|
|
|
يوضح المثال التالي كيفية استخدام `CodeInterpreterTool` مع وكيل CrewAI:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew, Process
|
|
from crewai_tools import CodeInterpreterTool
|
|
|
|
# Initialize the tool
|
|
code_interpreter = CodeInterpreterTool()
|
|
|
|
# Define an agent that uses the tool
|
|
programmer_agent = Agent(
|
|
role="Python Programmer",
|
|
goal="Write and execute Python code to solve problems",
|
|
backstory="An expert Python programmer who can write efficient code to solve complex problems.",
|
|
tools=[code_interpreter],
|
|
verbose=True,
|
|
)
|
|
|
|
# Example task to generate and execute code
|
|
coding_task = Task(
|
|
description="Write a Python function to calculate the Fibonacci sequence up to the 10th number and print the result.",
|
|
expected_output="The Fibonacci sequence up to the 10th number.",
|
|
agent=programmer_agent,
|
|
)
|
|
|
|
# Create and run the crew
|
|
crew = Crew(
|
|
agents=[programmer_agent],
|
|
tasks=[coding_task],
|
|
verbose=True,
|
|
process=Process.sequential,
|
|
)
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
يمكنك أيضاً تفعيل تنفيذ الكود مباشرة عند إنشاء وكيل:
|
|
|
|
```python Code
|
|
from crewai import Agent
|
|
|
|
# Create an agent with code execution enabled
|
|
programmer_agent = Agent(
|
|
role="Python Programmer",
|
|
goal="Write and execute Python code to solve problems",
|
|
backstory="An expert Python programmer who can write efficient code to solve complex problems.",
|
|
allow_code_execution=True, # This automatically adds the CodeInterpreterTool
|
|
verbose=True,
|
|
)
|
|
```
|
|
|
|
### تفعيل `unsafe_mode`
|
|
|
|
```python Code
|
|
from crewai_tools import CodeInterpreterTool
|
|
|
|
code = """
|
|
import os
|
|
os.system("ls -la")
|
|
"""
|
|
|
|
CodeInterpreterTool(unsafe_mode=True).run(code=code)
|
|
```
|
|
|
|
## المعاملات
|
|
|
|
تقبل `CodeInterpreterTool` المعاملات التالية أثناء التهيئة:
|
|
|
|
- **user_dockerfile_path**: اختياري. مسار ملف Dockerfile مخصص لاستخدامه لحاوية مفسّر الكود.
|
|
- **user_docker_base_url**: اختياري. عنوان URL لبرنامج Docker daemon لتشغيل الحاوية.
|
|
- **unsafe_mode**: اختياري. ما إذا كان سيتم تشغيل الكود مباشرة على الجهاز المضيف بدلاً من حاوية Docker أو بيئة الحماية. القيمة الافتراضية `False`. استخدم بحذر!
|
|
- **default_image_tag**: اختياري. وسم صورة Docker الافتراضي. القيمة الافتراضية `code-interpreter:latest`
|
|
|
|
عند استخدام الأداة مع وكيل، سيحتاج الوكيل لتقديم:
|
|
|
|
- **code**: مطلوب. كود Python 3 المراد تنفيذه.
|
|
- **libraries_used**: اختياري. قائمة المكتبات المستخدمة في الكود التي تحتاج إلى تثبيت. القيمة الافتراضية `[]`
|
|
|
|
## مثال على التكامل مع الوكيل
|
|
|
|
إليك مثالاً أكثر تفصيلاً عن كيفية دمج `CodeInterpreterTool` مع وكيل CrewAI:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import CodeInterpreterTool
|
|
|
|
# Initialize the tool
|
|
code_interpreter = CodeInterpreterTool()
|
|
|
|
# Define an agent that uses the tool
|
|
data_analyst = Agent(
|
|
role="Data Analyst",
|
|
goal="Analyze data using Python code",
|
|
backstory="""You are an expert data analyst who specializes in using Python
|
|
to analyze and visualize data. You can write efficient code to process
|
|
large datasets and extract meaningful insights.""",
|
|
tools=[code_interpreter],
|
|
verbose=True,
|
|
)
|
|
|
|
# Create a task for the agent
|
|
analysis_task = Task(
|
|
description="""
|
|
Write Python code to:
|
|
1. Generate a random dataset of 100 points with x and y coordinates
|
|
2. Calculate the correlation coefficient between x and y
|
|
3. Create a scatter plot of the data
|
|
4. Print the correlation coefficient and save the plot as 'scatter.png'
|
|
|
|
Make sure to handle any necessary imports and print the results.
|
|
""",
|
|
expected_output="The correlation coefficient and confirmation that the scatter plot has been saved.",
|
|
agent=data_analyst,
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[data_analyst],
|
|
tasks=[analysis_task],
|
|
verbose=True,
|
|
process=Process.sequential,
|
|
)
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
## تفاصيل التنفيذ
|
|
|
|
تستخدم `CodeInterpreterTool` حاوية Docker لإنشاء بيئة آمنة لتنفيذ الكود:
|
|
|
|
```python Code
|
|
class CodeInterpreterTool(BaseTool):
|
|
name: str = "Code Interpreter"
|
|
description: str = "Interprets Python3 code strings with a final print statement."
|
|
args_schema: Type[BaseModel] = CodeInterpreterSchema
|
|
default_image_tag: str = "code-interpreter:latest"
|
|
|
|
def _run(self, **kwargs) -> str:
|
|
code = kwargs.get("code", self.code)
|
|
libraries_used = kwargs.get("libraries_used", [])
|
|
|
|
if self.unsafe_mode:
|
|
return self.run_code_unsafe(code, libraries_used)
|
|
else:
|
|
return self.run_code_safety(code, libraries_used)
|
|
```
|
|
|
|
تقوم الأداة بالخطوات التالية:
|
|
1. التحقق من وجود صورة Docker أو بنائها إذا لزم الأمر
|
|
2. إنشاء حاوية Docker مع تركيب مجلد العمل الحالي
|
|
3. تثبيت أي مكتبات مطلوبة حددها الوكيل
|
|
4. تنفيذ كود Python في الحاوية
|
|
5. إرجاع مخرجات تنفيذ الكود
|
|
6. التنظيف عن طريق إيقاف الحاوية وإزالتها
|
|
|
|
## اعتبارات الأمان
|
|
|
|
بشكل افتراضي، تشغّل `CodeInterpreterTool` الكود في حاوية Docker معزولة، مما يوفر طبقة من الأمان. ومع ذلك، هناك بعض اعتبارات الأمان التي يجب مراعاتها:
|
|
|
|
1. تمتلك حاوية Docker وصولاً إلى مجلد العمل الحالي، لذا قد يتم الوصول إلى ملفات حساسة.
|
|
2. إذا لم تكن حاوية Docker متاحة وكان الكود يحتاج للتشغيل بأمان، سيُنفَّذ في بيئة حماية. لأسباب أمنية، لا يُسمح بتثبيت مكتبات عشوائية
|
|
3. يسمح معامل `unsafe_mode` بتنفيذ الكود مباشرة على الجهاز المضيف، ويجب استخدامه فقط في بيئات موثوقة.
|
|
4. كن حذراً عند السماح للوكلاء بتثبيت مكتبات عشوائية، لأنها قد تتضمن كوداً ضاراً.
|
|
|
|
## الخلاصة
|
|
|
|
توفر `CodeInterpreterTool` طريقة قوية لوكلاء CrewAI لتنفيذ كود Python في بيئة آمنة نسبياً. من خلال تمكين الوكلاء من كتابة وتشغيل الكود، توسّع قدراتهم في حل المشكلات بشكل كبير، خاصة للمهام التي تتضمن تحليل البيانات أو الحسابات أو أعمال حسابية أخرى. هذه الأداة مفيدة بشكل خاص للوكلاء الذين يحتاجون إلى إجراء عمليات معقدة يُعبَّر عنها بكفاءة أكبر في الكود مقارنة باللغة الطبيعية.
|