xingrin/README.md

Xingrin - 星环

一款现代化的企业级漏洞扫描与资产管理平台
提供自动化安全检测、资产发现、漏洞管理等功能

---

✨ 功能特性

🎯 目标与资产管理

• 组织管理 - 多层级目标组织，灵活分组
• 目标管理 - 支持域名、IP、URL 等多种目标类型
• 资产发现 - 子域名、网站、端点、目录自动发现
• 资产快照 - 扫描结果快照对比，追踪资产变化

🔍 漏洞扫描

• 多引擎支持 - 集成 Nuclei 等主流扫描引擎
• 自定义流程 - YAML 配置扫描流程，灵活编排
• 漏洞分级 - 严重/高危/中危/低危 四级分类
• 定时扫描 - Cron 表达式配置，自动化周期扫描

🖥️ 分布式架构

• Worker 节点 - 支持多节点分布式扫描
• 本地/远程 - 本地 Docker 节点 + SSH 远程节点
• 负载均衡 - 自动任务分发与负载监控
• 实时状态 - WebSocket 实时推送扫描进度

📊 可视化界面

• 数据统计 - 资产/漏洞统计仪表盘
• 实时通知 - WebSocket 消息推送
• 暗色主题 - 支持明暗主题切换

---

🛠️ 技术栈

• 前端: Next.js + React + TailwindCSS
• 后端: Django + Django REST Framework
• 数据库: PostgreSQL + Redis
• 部署: Docker + Nginx
• 扫描引擎: Nuclei

---

📦 快速开始

环境要求

• Docker 20.10+
• Docker Compose 2.0+
• 推荐 2核 4G 内存起步
• 10GB+ 磁盘空间

一键安装

# 克隆项目
git clone https://github.com/yyhuni/xingrin.git
cd xingrin

# 安装并启动（生产模式）
sudo ./install.sh

# 开发模式
sudo ./install.sh --dev

访问服务

• Web 界面: https://localhost 或 http://localhost
• API 接口: http://localhost:8888/api/
• API 文档: http://localhost:8888/swagger/

常用命令

# 启动服务
sudo ./start.sh

# 停止服务
sudo ./stop.sh

# 重启服务
sudo ./restart.sh

# 卸载
sudo ./uninstall.sh

# 更新
sudo ./update.sh

⚠️ 免责声明

重要：请在使用前仔细阅读

1. 本工具仅供授权的安全测试和安全研究使用
2. 使用者必须确保已获得目标系统的合法授权
3. 严禁将本工具用于未经授权的渗透测试或攻击行为
4. 未经授权扫描他人系统属于违法行为，可能面临法律责任
5. 开发者不对任何滥用行为负责

使用本工具即表示您同意：

• 仅在合法授权范围内使用
• 遵守所在地区的法律法规
• 承担因滥用产生的一切后果

📄 许可证

本项目采用 PolyForm Noncommercial License 1.0.0 许可证。

允许的用途

• ✅ 个人学习和研究
• ✅ 非商业安全测试
• ✅ 教育机构使用
• ✅ 非营利组织使用

禁止的用途

• ❌ 商业用途（包括但不限于：出售、商业服务、SaaS 等）
• ❌ 未经授权的渗透测试
• ❌ 任何违法行为

如需商业授权，请联系作者。

🤝 反馈与贡献

• 🐛 发现 Bug？ 欢迎提交 Issue
• 💡 有新想法？ 欢迎提交功能建议
• 🔧 想参与开发？ 欢迎提交 Pull Request

📧 联系

• GitHub: @yyhuni
• 微信公众号: 洋洋的小黑屋