LoginGet Started

安全性与 API 密钥

为你的数据提供安全认证与范围权限。你的知识始终私密且受到保护。

API 密钥仪表盘，展示 API 密钥列表及创建和撤销选项

API 密钥认证

ContextForge 使用 API 密钥对 MCP 客户端进行认证。每个密钥在存储前都会使用 SHA-256 进行安全哈希处理。

密钥格式

cf_live_xxxxxxxxxxxxxxxxxxxxxxxx

前缀标识密钥类型（live/test）

存储方式

密钥在存储前经过哈希处理（SHA-256）。我们从不以明文存储密钥。

创建 API 密钥

可从仪表盘或通过 API 生成 API 密钥。

  1. 1

    进入设置

    导航至 Dashboard → Settings → API Keys

  2. 2

    点击 "Create New Key"

    为密钥输入一个描述性名称

  3. 3

    立即复制密钥

    完整密钥仅显示一次，请妥善保存。

重要：API 密钥在创建时仅显示一次。请务必复制并保存到密码管理器或环境变量等安全位置。

密钥权限范围

API 密钥可以具有不同的权限级别。

范围权限
read查询、列出 Spaces、查看条目
write摄取、更新、删除条目
admin管理 Spaces、Snapshots、git 仓库
*所有权限（默认）

使用 API 密钥

在 MCP 客户端中

# 设置为环境变量：

export CONTEXTFORGE_API_KEY="cf_live_your_key_here"

# Or in claude_desktop_config.json:
{
  "mcpServers": {
    "contextforge": {
      "command": "npx",
      "args": ["-y", "contextforge-mcp"],
      "env": {
        "CONTEXTFORGE_API_KEY": "your-api-key-here",
        "CONTEXTFORGE_API_URL": "https://your-project-ref.supabase.co"
      }
    }
  }
}

在 REST API 中

# 通过 Authorization 请求头传递：

curl -X POST https://your-project.supabase.co/functions/v1/query \
  -H "Authorization: Bearer cf_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"query": "authentication patterns"}'

撤销密钥

如果密钥泄露，请立即从仪表盘撤销。

  1. 进入 Dashboard → Settings → API Keys
  2. 找到泄露的密钥
  3. 点击 "Revoke" ——操作立即生效且不可撤销
  4. 创建新密钥以恢复访问

数据安全

静态加密

所有数据在 Supabase 中使用 AES-256 加密

传输加密

所有连接使用 TLS 1.3

行级安全

PostgreSQL RLS 确保数据隔离

SOC 2 合规

基础设施托管于通过 SOC 2 认证的服务商

最佳实践

  • 使用环境变量

    切勿将 API 密钥硬编码到配置文件中

  • 每个环境使用独立密钥

    为开发、预发和生产环境分别使用独立密钥

  • 定期轮换密钥

    定期创建新密钥并撤销旧密钥

  • 使用最小必要权限范围

    每个密钥只授予其实际需要的权限

  • 监控密钥使用情况

    查看 last_used_at 以识别未使用或可疑的密钥