Files
WebHooker/docs/zh/guide/ingress.md
翅膀 5fcb129170 docs(worker): align guides with runtime behavior
Synchronize both language guides, API references and examples with
the implemented authorization, storage and delivery behavior.
Document migration requirements and accepted operational limits.
2026-10-23 23:24:05 +08:00

9.4 KiB
Raw Permalink Blame History

Webhook 接入与租户隔离

Webhook 提供方

WebHooker 通过同一个 POST /webhook 端点接收多个 forge 的 webhook,按请求头自动识别来源;只需把各 forge 的 webhook 指向 {BASE_URL}/webhook 即可。

提供方 事件请求头 签名请求头 签名格式 密钥
GitHub X-GitHub-Event X-Hub-Signature-256 sha256=<hex> HMAC-SHA256 GITHUB_WEBHOOK_SECRET
Gitea X-Gitea-Event X-Gitea-Signature 纯 hex HMAC-SHA256 GITEA_WEBHOOK_SECRET

投递 id 去重使用 X-GitHub-Delivery(GitHub)或 X-Gitea-Delivery(Gitea)请求头(存在时)。

启用投递队列时,webhook 只有在持久入队后才返回 200。若队列拒收,端点返回 503 并释放去重占用,发送方的重投会被接受,而不会被当作重复丢弃。已被接受的 webhook 再次投递时返回 200 { "duplicate": true };第一份仍在处理中时到达的重投返回 503,由发送方稍后重试。

未绑定队列时,webhook 内联分发,分发结束后才应答:所有目标都处理完返回 200,有目标暂时失败时返回 503(发送方重投时会跳过已成功的目标)。内联分发最多发送 8 分钟,其余目标返回 503,避免单个请求超过其去重占用的有效期。

Gitea 载荷会被归一化为与 GitHub 事件相同的内部结构,因此路由、过滤器与 28 个格式化器无需改动即可工作。未知或未映射的 Gitea 事件回退到通用格式化器。仓库/提交/用户链接取自载荷中的 repository.html_url,因此指向你的 Gitea 实例。

全局端点(POST /webhook)

全局端点使用运营者的全局密钥(GITHUB_WEBHOOK_SECRET、GITEA_WEBHOOK_SECRET)验签,并分发到所有路由——未绑定来源的隔离分组除外。GitHub App 安装的事件都在此送达;在分组上设置 installationId 可保持租户隔离。

分组端点(POST /webhook/{groupId})

每个分组都可以选择接入自己的 webhook 入口,使用独立的密钥(在分组页面的 Webhook 端点 面板生成,owner 角色)。载荷使用分组的密钥验签,而不是全局密钥,并且只有该分组的路由会被触发。SaaS 用户以此配置 Gitea、经典 GitHub 或自定义 webhook,而无需共享(或知道)运营者的密钥。

  • 支持任意提供方:GitHub(X-Hub-Signature-256)、Gitea(X-Gitea-Signature)、自定义(X-WebHooker-Signature)
  • 密钥为 64 位 hex 字符串,与分组一起存于 D1(生成之后不再发给控制台);重新生成会立即失效旧密钥,只有当前 owner 能轮换或删除
  • 投递 id 去重键按提供方与租户隔离(delivery:{provider}:@i:{instance}:{id}——使用分组不可变的 instance,改名不改变作用域,以同一 id 新建的分组也不会共用;全局入口使用作用域 @global)
  • 租户签名的载荷只具备租户本身的可信度:其中的 installation.id 会被忽略,因此它不会使用运营者的 GitHub App 凭据(不做 job/构建日志补全),也不会创建或重新绑定安装分组;分组自身入口的事件不受安装限制约束
  • 分组没有密钥(或已不存在)时端点返回 404;分组存储的配置无法读取时返回 503

自定义 Webhook

向 POST /webhook/{groupId}(或全局端点)POST 一个 JSON 对象,并使用分组密钥将原始 body 的 HMAC-SHA256 以 X-WebHooker-Signature: sha256=<hex> 签名(顶层为数组或标量时返回 400)。载荷会变成 custom 事件,走正常的路由管线——创建一条 event: custom 的路由(控制台有模板),即可分发到该路由的目标、记录 send_logs,并出现在分组的 webhook 日志频道中。

重放防护

自定义 webhook 支持可选的防重放机制,在签名之外再附带两个请求头:

  • X-WebHooker-Timestamp — 请求发送时的 Unix 秒数
  • X-WebHooker-Nonce — 每次请求唯一且不可预测的值(如 UUID)

当同时提供这两个请求头时,签名改为对 {timestamp}.{nonce}.{原始body} 计算(而非仅原始 body),且仅当以下条件满足时才被接受:

  1. 时间戳与服务器时钟相差不超过 ±5 分钟(拒绝重放与时钟漂移滥用)
  2. 该 nonce 对此密钥从未被使用过(原子占用并保留 10 分钟;重放的 nonce 会被拒绝,其他租户可以使用相同 nonce)。第一次请求仍在处理中的 nonce,或 nonce 存储故障,返回 503 而不是 401,由发送方重试
input="${timestamp}.${nonce}.${body}"
signature="sha256=$(printf '%s' "$input" | openssl dgst -sha256 -hmac "$secret" -hex | sed 's/.*= //')"

省略这些请求头时,WebHooker 回退到旧版的仅对 body 签名,现有发送方无需改动即可继续工作。

载荷模式:

{
  "title": "Deploy failed",
  "description": "Prod rollout failed at 12:03 UTC",
  "color": "red",
  "url": "https://ci.example.com/runs/42",
  "repo": "acme/widget",
  "author": {
    "name": "alice",
    "iconUrl": "https://…/alice.png",
    "url": "https://github.com/alice"
  },
  "fields": [{ "name": "Env", "value": "prod", "inline": true }],
  "footer": "my-monitor",
  "deliveryId": "alert-123"
}
字段 类型 说明
title string 消息标题(缺省时为 "Custom message")
description string 可选消息正文
color string 可选嵌入颜色:颜色词(red、green、yellow、blue、purple、orange、cyan、gray)或 #rrggbb
url string 可选的标题链接
repo string 可选 owner/repo;作为标题前缀并用作页脚
author object 可选 { name, iconUrl, url }
fields object[] 可选嵌入字段 { name, value, inline }
footer string 可选页脚覆盖
deliveryId string 可选的发送方去重 id(重试)。没有 deliveryId 时以 nonce 标识请求;两者都没有时,重试的请求会被再次投递

GitHub App 租户隔离

GitHub App 安装后,所有安装方的事件都会到达全局端点。要让租户互相隔离,请把每个分组绑定到应当为其提供事件的安装 ID:"installationId": 12345678。该 ID 可从 App 安装 webhook 载荷(installation.id)或 GitHub App 安装页 URL 看到。即使分组的 owners 为空,来自其它安装的事件也会被拒绝。未设置 installationId 的分组保持旧行为(owners 过滤)。

绑定是自动配置的 —— 将 GitHub App 的 Setup URL 指向 {BASE_URL}/auth/github/install。用户安装 App 后浏览器立即跳转到该页面(页面需要已登录的管理员会话——未登录用户会先被重定向走 OAuth 流程),可选择将安装绑定到:新分组(inst-{installationId},默认)或任意自己拥有 owner 权限的已有分组(提交时再次校验角色;由 POST /auth/github/install/bind 完成配置)。无需手动填写 ID。Setup URL 中的 installation_id 可以被随意填写,因此页面与绑定步骤都会先用登录用户本人的 GitHub token 验证其有权管理该安装:用户就是安装所属账号,或是其组织的有效管理员(仅以协作者身份能访问该安装并不够)。否则会带 ?error=install-forbidden 返回。超级管理员可以绑定任意安装。开启 ALLOW_SELF_SIGNUP 时,只有当专用的 inst-{installationId} 分组仍绑定该安装且尚无任何成员时,安装者才会成为其 owner——其他分组绝不会以这种方式交给新 owner。以 inst- 或 u- 开头的 id 为这些系统分组保留:只有超级管理员能创建或重命名为此类 id,已存在但未绑定的 inst-* 分组也不会被自动绑定。

作为兜底(例如未配置 Setup URL 时),installation.created webhook 事件(仅限全局入口)也会自动创建/绑定分组 —— owners 匹配安装账号的现有分组会被绑定,否则创建独立的 inst-{installationId} 分组。之后在控制台为分组添加路由和成员即可。自动配置在该投递完成去重检查之后执行,并按安装、按已绑定分组各记录 7 天,因此重投的事件不会重新绑定超级管理员已解除绑定的分组;配置失败时端点返回 503,让事件被重新投递。

要在选择页显示安装所属账号的登录名,请设置 GITHUB_APP_ID 与 GITHUB_PRIVATE_KEY——见密钥。