mdtazizulislam/zonforge-platform
GitHub: mdtazizulislam/zonforge-platform
ZonForge Sentinel 是一款面向生产环境的网络安全平台,提供全面的安全监控和响应功能。
Stars: 0 | Forks: 0
# ZonForge Sentinel v4.6.0 -> ZonForge Sentinel v4.6.0
[](docs/ROADMAP.md)
ZonForge Sentinel 是一个基于单仓库的网络安全平台,用于事件摄取、分析、风险评估、警报和人工智能辅助的 SOC 工作流程。
**定位:** 正在积极开发的生产导向平台 — 结构化以适应实际部署模式,具有基于证据的本地验证和持续强化可选服务和生产路径。
## 概述
此仓库包含运行 ZonForge Sentinel 在本地和部署环境中所需的内核后端服务、人工智能服务、共享平台包、仪表板应用程序、收集器和基础设施定义。
当前验证的本地开发者路径侧重于可以在 Windows PowerShell 上启动和端到端验证的必需服务子集。并非每个服务、集成或部署表面都已完全验证;请参阅 [docs/ROADMAP.md](docs/ROADMAP.md) 和 [docs/VERIFICATION_INDEX.md](docs/VERIFICATION_INDEX.md) 了解当前范围。
## 为什么选择 ZonForge
- 服务、共享合约和工具的单仓库一致性。
- 在摄取、检测、关联、风险和警报管道中明确的服务边界。
- 将人工智能模块作为一等服务集成,而不是临时脚本。
- 以验证为首要的本地工作流程,具有文档化的健康检查和证据工件。
## 核心功能
- 事件摄取和标准化管道。
- 检测和威胁情报丰富。
- 关联和风险评估引擎。
- 警报和人工智能辅助的三级/调查服务。
- API 网关和 Web 仪表板,用于平台访问和操作。
## 架构
必需的本地路径由以下部分组成:
1. 共享包 (`packages/*`),用于配置、类型、日志记录、身份验证、模式和数据库访问。
2. 核心运行时服务 (`apps/*`),用于通过警报生命周期进行摄取。
3. 人工智能服务 (`apps/*`),用于行为分析、分类和 SOC 协助。
4. UI (`apps/web-dashboard`),用于操作可见性。
有关完整的架构摘要和请求/数据流,请参阅 [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)。
架构图资产:
- [docs/demo/architecture/zonforge-platform-architecture.md](docs/demo/architecture/zonforge-platform-architecture.md)
- [docs/demo/architecture/zonforge-platform-architecture.mmd](docs/demo/architecture/zonforge-platform-architecture.mmd)
## 仓库结构
```
zonforge-platform/
apps/ # Microservices and apps
collectors/ # External source collectors
packages/ # Shared libraries and contracts
infra/ # IaC, monitoring, deployment assets
security/ # Security hardening, policies, rules
docs/ # Architecture, local dev, demo, troubleshooting
scripts/ # Developer helper scripts
proof/runs/ # Execution and verification reports
```
## 服务和端口
验证的必需本地路径:
| 服务 | 包 | 端口 | 验证路径中的状态 |
|---|---|---:|---|
| API 网关 | `@zonforge/api-gateway` | 3000 | 必需 |
| 摄取服务 | `@zonforge/ingestion-service` | 3001 | 必需 |
| 标准化工作进程 | `@zonforge/normalization-worker` | 3002 | 必需 |
| 检测引擎 | `@zonforge/detection-engine` | 3003 | 必需 |
| 威胁情报服务 | `@zonforge/threat-intel-service` | 3005 | 必需 |
| 关联引擎 | `@zonforge/correlation-engine` | 3006 | 必需 |
| 风险评分引擎 | `@zonforge/risk-scoring-engine` | 3007 | 必需 |
| 警报服务 | `@zonforge/alert-service` | 3008 | 必需 |
| AI SOC 分析师 | `@zonforge/ai-soc-analyst` | 3015 | 必需 |
| 行为 AI | `@zonforge/behavioral-ai` | 3020 | 必需 |
| 警报分类 AI | `@zonforge/alert-triage-ai` | 3021 | 必需 |
| 安全助手 | `@zonforge/security-assistant` | 3022 | 必需 |
| Web 仪表板 | `@zonforge/web-dashboard` | 5173 | 必需 UI |
完整映射:[docs/SERVICE_MAP.md](docs/SERVICE_MAP.md)
## 快速入门
先决条件:
- Node.js 20+
- npm 10+
- Docker Desktop(用于 PostgreSQL、Redis、ClickHouse)
```
npm install
npm run infra:up
npm run build:required
npm run dev:required
```
Windows 辅助脚本:
```
./scripts/demo-start-required.ps1
./scripts/demo-health-check.ps1
```
详细设置:[DEVELOPMENT.md](DEVELOPMENT.md) · [docs/LOCAL_DEVELOPMENT.md](docs/LOCAL_DEVELOPMENT.md)
## 演示
演示指南和操作流程:[docs/DEMO.md](docs/DEMO.md)
演示资产:
- API 示例:[docs/demo/api](docs/demo/api)
- 截图和捕获说明:[docs/demo/screenshots/README.md](docs/demo/screenshots/README.md)
- 投资组合截图占位符:[docs/demo/screenshots/portfolio/README.md](docs/demo/screenshots/portfolio/README.md)
- 架构视觉:[docs/demo/architecture/README.md](docs/demo/architecture/README.md)
### 视觉演示
仪表板本地表面(真实捕获):

网关健康和 API 可视性(真实捕获):

服务运行证明(从实时运行输出捕获的真实捕获):

必需路径健康证明(从实时健康命令输出捕获的真实捕获):

AI 模块就绪证明(从运行 AI 服务端点捕获的真实捕获):

## 健康验证
可以使用以下方式验证必需的健康端点:
```
./scripts/demo-health-check.ps1
```
参考验证输出和报告:
- [proof/runs/2026-03-19_local-dev-boot-fix.md](proof/runs/2026-03-19_local-dev-boot-fix.md)
- [docs/VERIFICATION_INDEX.md](docs/VERIFICATION_INDEX.md)
## 示例 API 流程
演示有效载荷和示例响应:
- [docs/demo/api/ingest-event-request.json](docs/demo/api/ingest-event-request.json)
- [docs/demo/api/ingest-event-response.json](docs/demo/api/ingest-event-response.json)
- [docs/demo/api/health-check-output.txt](docs/demo/api/health-check-output.txt)
示例摄取请求(演示样本):
```
curl -X POST "http://localhost:3001/v1/events/ingest" \
-H "Content-Type: application/json" \
-d @docs/demo/api/ingest-event-request.json
```
## 文档索引
完整索引:[docs/README.md](docs/README.md)
| 主题 | 文档 |
|---|---|
| 开发 | [DEVELOPMENT.md](DEVELOPMENT.md) |
| 架构 | [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) |
| 本地设置 | [docs/LOCAL_DEVELOPMENT.md](docs/LOCAL_DEVELOPMENT.md) |
| 演示 | [docs/DEMO.md](docs/DEMO.md) |
| 故障排除 | [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) |
| 服务映射 | [docs/SERVICE_MAP.md](docs/SERVICE_MAP.md) |
| 验证 | [docs/VERIFICATION_INDEX.md](docs/VERIFICATION_INDEX.md) |
| 安全 | [docs/SECURITY.md](docs/SECURITY.md) · [SECURITY.md](SECURITY.md) |
| 路线图 | [docs/ROADMAP.md](docs/ROADMAP.md) |
## 发布管理
- [CHANGELOG.md](CHANGELOG.md)
- [docs/RELEASE_PROCESS.md](docs/RELEASE_PROCESS.md)
GitHub 发布的发布说明类别映射:
- [/.github/release.yml](.github/release.yml)
## 治理和贡献
- [CONTRIBUTING.md](CONTRIBUTING.md)
- [CODEOWNERS](CODEOWNERS)
- [docs/REPOSITORY_GOVERNANCE.md](docs/REPOSITORY_GOVERNANCE.md)
- [docs/BRANCH_PROTECTION_CHECKLIST.md](docs/BRANCH_PROTECTION_CHECKLIST.md)
## 安全注意事项
- 不要提交 `.env.local` 或生产机密。
- 使用专用的本地唯一凭据进行开发基础设施。
- 将所有演示/样本有效载荷视为合成,除非明确标记为真实捕获。
- 在外部部署之前,请查阅 [docs/SECURITY.md](docs/SECURITY.md)。
安全披露和响应流程:
- [SECURITY.md](SECURITY.md)
- [docs/SECURITY_RESPONSE_PROCESS.md](docs/SECURITY_RESPONSE_PROCESS.md)
## 路线图
短期和中期优先事项在 [docs/ROADMAP.md](docs/ROADMAP.md)
当前仓库状态:
- 必需的本地平台路径已验证并记录。
- 可选服务有意保持在外部最低本地成功标准之外,直到各自验证。
维护参考:
- [docs/MAINTENANCE.md](docs/MAINTENANCE.md)
标签:AMSI绕过, API网关, Windows PowerShell, 事件处理, 事件收集, 人工智能, 代码示例, 仪表盘, 单一代码库, 威胁情报, 威胁检测, 安全运营中心, 开发者工具, 开源框架, 持续部署, 持续集成, 搜索引擎查询, 数据分析, 日志审计, 服务边界, 本地开发, 用户模式Hook绕过, 监控平台, 网络安全, 网络映射, 自动化攻击, 警报系统, 请求拦截, 逆向工具, 隐私保护, 风险评分, 验证优先