Files
blackbird/docs/INDEX.md
T

11 KiB
Raw Blame History

micro_servers 文档索引

所有项目文档的统一入口。

目录结构

docs/
├── INDEX.md                              # 本文件(文档总索引)
├── security/                             # 安全审计与加固(29 篇)
├── reviews/                              # 代码审查日志(4 篇)
└── reports/                              # 分析报告与开发规划(13 篇)

一、项目总览

文档 路径 说明
项目 README ../README.md 架构总览、服务说明、安装运行指南

二、安全文档 (security/)

全局审计与加固

文档 说明
DEPLOY_SECURITY_AUDIT_20260801.md 部署配置安全审计(docker-compose、systemd、防火墙、TLS 等)
DEPS_SECURITY_AUDIT_20260801.md 依赖安全审计(第三方库版本、已知漏洞、许可证)
SECURITY_HARDENING_PLAN_20260803.md 安全加固计划(内网通信安全加固开发计划)

各模块安全审计报告

模块 文档 审计范围
waf waf_SECURITY_AUDIT_20260801.md Go WAF 网关(TLS、coraza、反向代理)
gateway gateway_SECURITY_AUDIT_20260801.md C++20 应用网关(鉴权、Token、反向代理)初版
gateway gateway_SECURITY_AUDIT_20260807.md C++20 应用网关复审版(P0全部修复,进程退出bug修复)
gateway gateway_SECURITY_AUDIT_20260809.md C++20 应用网关增量复审(8 项新发现:关闭崩溃、头名大小写架空XFF修复等;黑盒测试重写落地)
core core_SECURITY_AUDIT_20260801.md C++20 进程托管服务(PMC/Nidus)
db db_SECURITY_AUDIT_20260801.md Python 数据库服务(pymsg、SQLAlchemy、日志收集)
db2 db2_SECURITY_AUDIT_20260806.md C++20 数据库 RPC 服务(db 的 C++ 重实现,SQLite C API)
pymsg pymsg_SECURITY_AUDIT_20260801.md Python RPC 基础库(长度前缀帧、MsgClient/Server)
dnfs dnfs_SECURITY_AUDIT_20260801.md Python 树状菜单服务
dnfs2 dnfs2_SECURITY_AUDIT_20260808.md C++20 树状菜单服务(dnfs 重实现)
static static_SECURITY_AUDIT_20260801.md Python 前端托管/文件服务
fsys fsys_SECURITY_AUDIT_20260808.md Python 文件系统服务
ai_review ai_review_SECURITY_AUDIT_20260801.md Python AI 内容审核(DeepSeek + RAG)
smtp smtp_SECURITY_AUDIT_20260801.md Python 邮件服务(验证码发送/校验)初版 + 0809 复审合并版
smtp3 smtp3_SECURITY_AUDIT_20260809.md C++20 邮件服务(smtp 重写),2 项 P0 + P1-2 + 全部 P3 当日已修复,仅剩 P1-1(TLS 校验)待修
captcha captcha_SECURITY_AUDIT_20260801.md Python 验证码服务
captcha2 captcha2_SECURITY_AUDIT_20260809.md C++20 验证码服务(captcha 重写,FreeType + stb,含 P0 大小写缺陷发现)
confs confs_SECURITY_AUDIT_20260801.md Python 统一配置服务
libmsg libmsg_SECURITY_AUDIT_20260806.md C++ RPC 基础库(pymsg 协议帧、MsgClient/Server、RpcClient/Server)
libhttp libhttp_SECURITY_AUDIT_20260803.md C++ HTTP/WebSocket 库(请求/响应/WS/静态文件)
libsqlite3 libsqlite3_SECURITY_AUDIT_20260806.md C++ SQLite3 封装(Header-only)
libth libth_SECURITY_AUDIT_20260804.md C++ 线程库(Thread、Cv_wait、Fsm)
aibox aibox_SECURITY_AUDIT_20260801.md Python AI 智能体系统(WebSocket)
BotOps BotOps_SECURITY_AUDIT_20260801.md BotOps 运维控制面板
actpred actpred_SECURITY_AUDIT_20260808.md Python 动作预测模块(PyTorch 训练/推理、.mt 解析、ONNX 导出)

三、代码审查 (reviews/)

文档 说明
core_CODE_REVIEW_LOG_20260730.md Core 模块代码审查日志(2026-07-30,自动化审查)
DEPLOY_DEFECT_AUDIT_20260806.md 部署缺陷审查(2026-08-06,首次原生部署实录,含修复记录)
actpred_CODE_AUDIT_20260808.md actpred 模块代码审计(2026-08-08,两轮合并:第 1 轮 16 项 + 第 2 轮复审 11 项,共 27 项全部修复)
bot4cj_CODE_AUDIT_20260808.md bot4cj 模块代码审计(2026-08-08,仓颉机器人硬件脚本解析器,15 项发现,待修复)

四、分析报告与开发规划 (reports/)

文档 说明
blackbird_research_report.md blackbird 项目研究报告(安全架构分析、改进建议、里程碑规划)
core_service_registry_dev_doc.md Core 模块注册中心功能扩展开发文档(服务注册/发现/健康守护/自动重启)
auth_service_plan.md 认证独立化(CA 模块)开发文档(waf→ca→gateway 前置拓扑;gateway 退 8445 纯转发不验签;下游/WAF/前端零改动)
aibox_open_dev_plan.md aibox 开放版开发计划(命令注入漏洞修复、安全沙箱方案)
aibox_file_network_cli_refactor.md aibox 文件/网络操作命令行化重构计划
blackbird_promo_full.md blackbird 项目完整版宣传文案
bot4cj_analysis_20260525_00.md bot4cj 机器人模块分析报告(Markdown)
libcrypt_CBC_deprecation_dev_doc.md libcrypt CBC 模式缺陷分析与 AES-GCM 迁移开发文档
bot4cj_analysis_20260525_00.html bot4cj 机器人模块分析报告(HTML)
actpred_pretrain_test_20260808.md actpred 预训练与推理测试报告(action_dim=18 变更、.mt 解析器、预训练、推理基准、NPU 调研)
captcha_cpp_rewrite_dev_doc.md captcha 模块 C++20 重写开发方案(FreeType + stb_image_write 替代 Pillow,协议兼容零改动)
smtp_cpp_rewrite_dev_doc.md smtp 模块 C++20 重写开发方案(SMTP_SSL 客户端手写,审计 7 项遗留一并在重写中修复,零新增系统依赖)
libhttp_remote_addr_dev_doc.md libhttp 对端地址透传开发方案(X-Remote-Addr 可信头注入,非破坏;gateway trust_xff 配套,闭环审计 A4)
confs2_cpp_rewrite_dev_doc.md confs 模块 C++20 重写开发方案(libmsg RpcServer 替代 pymsg,协议兼容零改动,审计 7 项遗留一并修复,零新增系统依赖,未来可合入 core 注册中心)

五、各模块 README(保留在原目录)

各模块根目录的 README.md 保留在原位,方便 GitHub 直接浏览:

核心服务

模块 路径 说明
core ../core/README.md 进程托管服务(PMC/Nidus)
waf ../waf/README.md WAF 网关(Go, coraza)
gateway ../gateway/README.md 应用层网关(C++20)
db ../db/README.md 通用数据库服务(pymsg)
db2 ../db2/README.md C++20 数据库 RPC 服务(db 重实现)
confs ../confs/README.md 统一配置服务
static ../static/README.md 前端托管服务
dnfs ../dnfs/README.md 树状网络文件系统
dnfs2 ../dnfs2/README.md C++20 树状菜单服务(dnfs 重实现)
ai_review ../ai_review/README.md AI 内容审核
captcha ../captcha/README.md 验证码服务
smtp ../smtp/README.md 邮件服务
redirect80 ../redirect80/README.md HTTP 重定向服务

共享库

库 路径 说明
pymsg ../pymsg/README.md Python RPC 基础库
libhttp ../libhttp/README.md C++ HTTP/WebSocket 库
libcrypt ../libcrypt/README.md C++ 加密库
libth ../libth/README.md C++ 线程库
libsqlite3 ../libsqlite3/README.md C++ SQLite3 封装
libmsg ../libmsg/README.md C++ RPC 基础库(pymsg 协议 C++ 实现)
libtry ../libtry/ 嵌入式脚本解释器

其他模块

模块 路径 说明
aibox ../aibox/README.md AI 智能体系统
bot4cj ../bot4cj/README.md 机器人硬件脚本解析器(仓颉)
BotOps ../BotOps/README.md aibox 智能体 TUI 前端(Textual)
actpred ../actpred/README.md 动作预测神经网络(PyTorch)
lci ../lci/README.md 嵌入式帧缓冲图形界面
fsys ../fsys/README.md 文件系统服务
tests ../tests/blackbox/README.md 黑盒测试套件

Robot 文档 (README.robot.md)

模块 路径
pymsg ../pymsg/README.robot.md
libhttp ../libhttp/README.robot.md
libtry ../libtry/README.robot.md
aibox ../aibox/README.robot.md
bot4cj ../bot4cj/README.robot.md

六、aibox 技能与任务文档

aibox 模块的技能提示词和任务模板属于运行时数据,保留在原目录:

类型 路径
技能格式说明 ../aibox/SKILLS_FORMAT.md
技能目录 ../aibox/skills/
任务目录 ../aibox/tasks/