Skip to content

Security: OSpoon/api-starter-kit

Security

docs/security.md

安全与治理

本文概述系统安全边界。强制开发规则见根目录 AGENTS.md;部署加固和环境配置见部署指南。

认证与凭据

  • 注册关闭;首个管理员由 backend 初始化配置创建。
  • 系统登录密码、2FA 和恢复码、API Key 与外部服务凭据由 backend 管理;独立移动身份验证器的 TOTP 账户保存在设备安全存储中。
  • API Key、临时密码等敏感凭据只在明确的创建或重置流程中展示一次;不得写入日志、普通读取响应或浏览器持久化。
  • 安全敏感或不可逆操作需要明确确认。

授权与审计

  • 用户通过角色获得 resource:action 权限;受保护 API 使用认证和命名权限 middleware,并由 Bouncer access ability 授权。
  • super-admin 是受保护的引导角色;管理操作必须保留至少一个可用的超级管理员。
  • 委派管理权限不能超出操作者自身权限范围。
  • 前端路由和控件显隐仅用于体验;backend 每次请求都重新鉴权。
  • 管理操作和已确认的 AI 操作写入审计日志。

知识库与 AI

  • 知识文档按角色过滤;群聊访客只访问公开文档。
  • AI 知识问答先检索可访问的目录,再限定到本轮返回的文档检索正文;目录摘要不是回答证据。
  • AI 查询只能使用注册模板;backend 每次校验权限、参数、范围和结果上限,并在共享 provider 边界做有限脱敏。该机制不等同完整 DLP,细节见AI 助手架构。
  • MCP 进程以 backend 用户身份运行且不经过技能 sandbox;只配置可信 stdio 服务。
  • 有副作用的 AI 操作先创建提议,确认时重新检查会话归属、权限、有效期和目标状态。
  • 模型文本、浏览器状态和聊天记录都不是授权依据;不得执行自由 SQL 或任意 shell。
  • 查询审计不保存原始查询、正文摘录或敏感参数。

实现细节见AI 助手架构和知识库实现说明。

应用与部署

  • Backend 是认证、校验、授权、数据和 API 契约的唯一权威。
  • 生产错误响应不暴露堆栈或内部异常;登录、2FA 和用户级操作按系统策略限流。
  • 桌面端与 Chrome 扩展不保存服务端密钥;扩展不读取网页内容,桌面端只申请实际所需原生权限。
  • 生产环境使用 HTTPS,限制 CORS、CSP 和数据库网络暴露,并按组织策略备份和保护数据库凭据。
  • GitHub 仓库的 Secret Scanning 和 Push Protection 需由仓库管理员在设置中启用。

There aren't any published security advisories