diff --git a/README.md b/README.md index 073099c..6e59070 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ DeerFlow has newly integrated the intelligent search and crawling toolset indepe - [Recommended Models](#recommended-models) - [Embedded Python Client](#embedded-python-client) - [Documentation](#documentation) + - [⚠️ Security Notice](#️-security-notice) - [Contributing](#contributing) - [License](#license) - [Acknowledgments](#acknowledgments) @@ -529,6 +530,24 @@ All dict-returning methods are validated against Gateway Pydantic response model - [Architecture Overview](backend/CLAUDE.md) - Technical architecture details - [Backend Architecture](backend/README.md) - Backend architecture and API reference +## ⚠️ Security Notice + +### Improper Deployment May Introduce Security Risks + +DeerFlow has key high-privilege capabilities including **system command execution, resource operations, and business logic invocation**, and is designed by default to be **deployed in a local trusted environment (accessible only via the 127.0.0.1 loopback interface)**. If you deploy the agent in untrusted environments — such as LAN networks, public cloud servers, or other multi-endpoint accessible environments — without strict security measures, it may introduce security risks, including: + +- **Unauthorized illegal invocation**: Agent functionality could be discovered by unauthorized third parties or malicious internet scanners, triggering bulk unauthorized requests that execute high-risk operations such as system commands and file read/write, potentially causing serious security consequences. +- **Compliance and legal risks**: If the agent is illegally invoked to conduct cyberattacks, data theft, or other illegal activities, it may result in legal liability and compliance risks. + +### Security Recommendations + +**Note: We strongly recommend deploying DeerFlow in a local trusted network environment.** If you need cross-device or cross-network deployment, you must implement strict security measures, such as: + +- **IP allowlist**: Use `iptables`, or deploy hardware firewalls / switches with Access Control Lists (ACL), to **configure IP allowlist rules** and deny access from all other IP addresses. +- **Authentication gateway**: Configure a reverse proxy (e.g., nginx) and **enable strong pre-authentication**, blocking any unauthenticated access. +- **Network isolation**: Where possible, place the agent and trusted devices in the **same dedicated VLAN**, isolated from other network devices. +- **Stay updated**: Continue to follow DeerFlow's security feature updates. + ## Contributing We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, workflow, and guidelines. diff --git a/README_fr.md b/README_fr.md index 3aaefd0..17b1d52 100644 --- a/README_fr.md +++ b/README_fr.md @@ -68,6 +68,7 @@ DeerFlow intègre désormais le toolkit de recherche et de crawling intelligent - [Modèles recommandés](#modèles-recommandés) - [Client Python intégré](#client-python-intégré) - [Documentation](#documentation) + - [⚠️ Avertissement de sécurité](#️-avertissement-de-sécurité) - [Contribuer](#contribuer) - [Licence](#licence) - [Remerciements](#remerciements) @@ -527,6 +528,24 @@ Toutes les méthodes retournant des dicts sont validées en CI contre les modèl - [Vue d'ensemble de l'architecture](backend/CLAUDE.md) - Détails de l'architecture technique - [Architecture backend](backend/README.md) - Architecture backend et référence API +## ⚠️ Avertissement de sécurité + +### Un déploiement inapproprié peut introduire des risques de sécurité + +DeerFlow dispose de capacités clés à hauts privilèges, notamment **l'exécution de commandes système, les opérations sur les ressources et l'invocation de logique métier**. Il est conçu par défaut pour être **déployé dans un environnement local de confiance (accessible uniquement via l'interface de loopback 127.0.0.1)**. Si vous déployez l'agent dans des environnements non fiables — tels que des réseaux LAN, des serveurs cloud publics ou d'autres environnements accessibles depuis plusieurs terminaux — sans mesures de sécurité strictes, cela peut introduire des risques, notamment : + +- **Invocation non autorisée** : les fonctionnalités de l'agent pourraient être découvertes par des tiers non autorisés ou des scanners malveillants, déclenchant des requêtes non autorisées en masse qui exécutent des opérations à haut risque (commandes système, lecture/écriture de fichiers), pouvant causer de graves conséquences. +- **Risques juridiques et de conformité** : si l'agent est utilisé illégalement pour mener des cyberattaques, du vol de données ou d'autres activités illicites, cela peut entraîner des responsabilités juridiques et des risques de conformité. + +### Recommandations de sécurité + +**Note : nous recommandons fortement de déployer DeerFlow dans un environnement réseau local de confiance.** Si vous avez besoin d'un déploiement multi-appareils ou multi-réseaux, vous devez mettre en place des mesures de sécurité strictes, par exemple : + +- **Liste blanche d'IP** : utilisez `iptables`, ou déployez des pare-feux matériels / commutateurs avec ACL, pour **configurer des règles de liste blanche d'IP** et refuser l'accès à toutes les autres adresses IP. +- **Passerelle d'authentification** : configurez un proxy inverse (ex. nginx) et **activez une authentification forte en amont**, bloquant tout accès non authentifié. +- **Isolation réseau** : si possible, placez l'agent et les appareils de confiance dans le **même VLAN dédié**, isolé des autres équipements réseau. +- **Restez informé** : continuez à suivre les mises à jour de sécurité du projet DeerFlow. + ## Contribuer Les contributions sont les bienvenues ! Consultez [CONTRIBUTING.md](CONTRIBUTING.md) pour la mise en place de l'environnement de développement, le workflow et les conventions. diff --git a/README_ja.md b/README_ja.md index f54bf6c..bd835a1 100644 --- a/README_ja.md +++ b/README_ja.md @@ -68,6 +68,7 @@ DeerFlowは、BytePlusが独自に開発したインテリジェント検索・ - [推奨モデル](#推奨モデル) - [組み込みPythonクライアント](#組み込みpythonクライアント) - [ドキュメント](#ドキュメント) + - [⚠️ セキュリティに関する注意](#️-セキュリティに関する注意) - [コントリビュート](#コントリビュート) - [ライセンス](#ライセンス) - [謝辞](#謝辞) @@ -480,6 +481,24 @@ client.upload_files("thread-1", ["./report.pdf"]) # {"success": True, "files": - [アーキテクチャ概要](backend/CLAUDE.md) - 技術的なアーキテクチャの詳細 - [バックエンドアーキテクチャ](backend/README.md) - バックエンドアーキテクチャとAPIリファレンス +## ⚠️ セキュリティに関する注意 + +### 不適切なデプロイはセキュリティリスクを引き起こす可能性があります + +DeerFlowは**システムコマンドの実行、リソース操作、ビジネスロジックの呼び出し**などの重要な高権限機能を備えており、デフォルトでは**ローカルの信頼できる環境（127.0.0.1のループバックアクセスのみ）にデプロイされる設計**になっています。信頼できないLAN、公開クラウドサーバー、または複数のエンドポイントからアクセス可能なネットワーク環境にエージェントをデプロイし、厳格なセキュリティ対策を講じない場合、以下のようなセキュリティリスクが生じる可能性があります： + +- **不正な違法呼び出し**：エージェントの機能が権限のない第三者や悪意のあるインターネットスキャナーに発見され、システムコマンドやファイル読み書きなどの高リスク操作を実行する不正な一括リクエストが引き起こされ、重大なセキュリティ上の問題が発生する可能性があります。 +- **コンプライアンスおよび法的リスク**：エージェントがサイバー攻撃やデータ窃取などの違法行為に不正使用された場合、法的責任やコンプライアンス上のリスクが生じる可能性があります。 + +### セキュリティ推奨事項 + +**注意：DeerFlowはローカルの信頼できるネットワーク環境にデプロイすることを強く推奨します。** クロスデバイス・クロスネットワークのデプロイが必要な場合は、以下のような厳格なセキュリティ対策を実装する必要があります： + +- **IPホワイトリストの設定**：`iptables`を使用するか、ハードウェアファイアウォール / ACL機能付きスイッチをデプロイして**IPホワイトリストルールを設定**し、他のすべてのIPアドレスからのアクセスを拒否します。 +- **前置認証**：リバースプロキシ（nginxなど）を設定し、**強力な前置認証を有効化**して、認証なしのアクセスをブロックします。 +- **ネットワーク分離**：可能であれば、エージェントと信頼できるデバイスを**同一の専用VLAN**に配置し、他のネットワークデバイスから隔離します。 +- **アップデートを継続的に確認**：DeerFlowのセキュリティ機能のアップデートを継続的にフォローしてください。 + ## コントリビュート コントリビューションを歓迎します！開発環境のセットアップ、ワークフロー、ガイドラインについては[CONTRIBUTING.md](CONTRIBUTING.md)をご覧ください。 diff --git a/README_ru.md b/README_ru.md index 752697c..fef6e4a 100644 --- a/README_ru.md +++ b/README_ru.md @@ -70,6 +70,7 @@ DeerFlow интегрирован с инструментарием для ум - [Рекомендуемые модели](#рекомендуемые-модели) - [Встроенный Python-клиент](#встроенный-python-клиент) - [Документация](#документация) + - [⚠️ Безопасность](#️-безопасность) - [Участие в разработке](#участие-в-разработке) - [Лицензия](#лицензия) - [Благодарности](#благодарности) @@ -412,6 +413,24 @@ client.upload_files("thread-1", ["./report.pdf"]) # {"success": True, "files": - [Обзор архитектуры](backend/CLAUDE.md) — технические детали - [Архитектура бэкенда](backend/README.md) — бэкенд и справочник API +## ⚠️ Безопасность + +### Неправильное развёртывание может привести к угрозам безопасности + +DeerFlow обладает ключевыми высокопривилегированными возможностями, включая **выполнение системных команд, операции с ресурсами и вызов бизнес-логики**. По умолчанию он рассчитан на **развёртывание в локальной доверенной среде (доступ только через loopback-адрес 127.0.0.1)**. Если вы разворачиваете агент в недоверенных средах — локальных сетях, публичных облачных серверах или других окружениях, доступных с нескольких устройств — без строгих мер безопасности, это может привести к следующим угрозам: + +- **Несанкционированные вызовы**: функциональность агента может быть обнаружена неавторизованными третьими лицами или вредоносными сканерами, что приведёт к массовым несанкционированным запросам с выполнением высокорисковых операций (системные команды, чтение/запись файлов) и серьёзным последствиям для безопасности. +- **Юридические и compliance-риски**: если агент будет незаконно использован для кибератак, кражи данных или других противоправных действий, это может повлечь юридическую ответственность и compliance-риски. + +### Рекомендации по безопасности + +**Примечание: настоятельно рекомендуем развёртывать DeerFlow только в локальной доверенной сети.** Если вам необходимо развёртывание через несколько устройств или сетей, обязательно реализуйте строгие меры безопасности, например: + +- **Белый список IP-адресов**: используйте `iptables` или аппаратные межсетевые экраны / коммутаторы с ACL, чтобы **настроить правила белого списка IP** и заблокировать доступ со всех остальных адресов. +- **Шлюз аутентификации**: настройте обратный прокси (nginx и др.) и **включите строгую предварительную аутентификацию**, запрещающую любой доступ без авторизации. +- **Сетевая изоляция**: по возможности разместите агент и доверенные устройства в **одном выделенном VLAN**, изолированном от остальной сети. +- **Следите за обновлениями**: регулярно отслеживайте обновления безопасности проекта DeerFlow. + ## Участие в разработке Приветствуем контрибьюторов! Настройка среды разработки, воркфлоу и гайдлайны — в [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/README_zh.md b/README_zh.md index 22e8f4d..6134d9c 100644 --- a/README_zh.md +++ b/README_zh.md @@ -56,6 +56,7 @@ https://github.com/user-attachments/assets/a8bcadc4-e040-4cf2-8fda-dd768b999c18 - [推荐模型](#推荐模型) - [内嵌 Python Client](#内嵌-python-client) - [文档](#文档) + - [⚠️ 安全使用](#️-安全使用) - [参与贡献](#参与贡献) - [许可证](#许可证) - [致谢](#致谢) @@ -466,6 +467,24 @@ client.upload_files("thread-1", ["./report.pdf"]) # {"success": True, "files": - [架构概览](backend/CLAUDE.md) - 技术架构说明 - [后端架构](backend/README.md) - 后端架构与 API 参考 +## ⚠️ 安全使用 + +### 不恰当的部署可能导致安全风险 + +DeerFlow 具备**系统指令执行、资源操作、业务逻辑调用**等关键高权限能力，默认设计为**部署在本地可信环境（仅本机 127.0.0.1 回环访问）**。若您将 agent 部署至不可信局域网、公网云服务器等可被多终端访问的网络环境，且未采取严格的安全防护措施，可能导致安全风险，例如： + +- **未授权的非法调用**：agent 功能被未授权的第三方、公网恶意扫描程序探测到，进而发起批量非法调用请求，执行系统命令、文件读写等高危操作，可能导致安全后果。 +- **合规与法律风险**：若 agent 被非法调用用于实施网络攻击、信息窃取等违法违规行为，可能产生法律责任与合规风险。 + +### 安全使用建议 + +**注意：建议您将 DeerFlow 部署在本地可信的网络环境下。**若您有跨设备、跨网络的部署需求，必须加入严格的安全措施。例如，采取如下手段： + +- **设置访问 IP 白名单**：使用 `iptables`，或部署硬件防火墙 / 带访问控制（ACL）功能的交换机等，**配置规则设置 IP 白名单**，拒绝其他所有 IP 进行访问。 +- **前置身份验证**：配置反向代理（nginx 等），并**开启高强度的前置身份验证功能**，禁止无任何身份验证的访问。 +- **网络隔离**：若有可能，建议将 agent 和可信设备划分到**同一个专用 VLAN**，与其他网络设备做隔离。 +- **持续关注项目更新**：请持续关注 DeerFlow 项目的安全功能更新。 + ## 参与贡献 欢迎参与贡献。开发环境、工作流和相关规范见 [CONTRIBUTING.md](CONTRIBUTING.md)。