wkhttp

package
v1.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 25, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BearerTokenCompat added in v1.18.0

func BearerTokenCompat() gin.HandlerFunc

BearerTokenCompat 把 `Authorization: Bearer <token>` 回填成 `token` 头, 让按标准 OAuth2 习惯开发的客户端能直接调用本服务。

为什么需要:AuthMiddleware 只读自定义的 `token` 头。接入外部 IdP 之后, 客户端拿到我方签发的 token 后若按标准发 Authorization 头,登录能过、 之后每个 API 调用都 401 —— 一个只在集成联调阶段才会暴露的断点。

为什么不改 AuthMiddleware:它在 octo-lib 共享库里。改它要升库版本, 且影响所有依赖该库的服务。本仓加一层全局前置件即可,影响面收敛在本服务内。

三条约束:

  • **`token` 头优先**。两个头都在且值不同时,用 `token`、不比较、不报错。 报错会让既有客户端在本中间件上线的瞬间开始失败;而这里的目的是纯增量兼容。
  • **只认 Bearer**。Basic 等其它 scheme 原样放过 —— 仍有 webhook 在用。
  • **不接受 query 参数兜底**。凭据放 URL 会进浏览器历史与 Referer, accesslog 的脱敏只能挡住日志这一层,挡不住那两处。

副作用边界:本件**只**在 `token` 头缺失时新增该头,从不修改或删除 Authorization 头 —— `bot_api` / `botfather` / `integration` / `bot_provision` / `usersecret` 都直接读 Authorization,必须保持原样。

bot token 会不会被误当用户 token:不会。bot 路由不挂 AuthMiddleware; 即便挂了,bot token 在用户 token 缓存里查不到,结果仍是 401。

挂载位置:main.go 的全局中间件段。全局件先于各 route group 的 AuthMiddleware 执行,回填才能生效。

func SharedUIDRateLimiter

func SharedUIDRateLimiter(r *libwkhttp.WKHttp, ctx *config.Context) libwkhttp.HandlerFunc

SharedUIDRateLimiter 返回进程级共享的 UID 限流中间件。

所有调用点共用同一个中间件实例和同一把 Redis keyspace("ratelimit:uid:{uid}"), 即同一 UID 跨所有挂载端点的总配额受控——这是 octo-server#1086 P2 的设计目标, 把公平性锚定到"用户"维度,避免共享出网 IP 的办公室场景互相挤占。

挂载要求:必须放在 AuthMiddleware 之后,仅用于认证路由组;未认证场景下本中间件 会 fail-open 放行(详见 UIDRateLimitMiddleware 注释)。

auth := r.Group("/v1/foo",
    ctx.AuthMiddleware(r),
    appwkhttp.SharedUIDRateLimiter(r, ctx),
)

环境变量(进程启动时读取一次,不支持热更新):

  • DM_API_UID_RATELIMIT_RPS 每秒填充速率(float,缺省 2.0 = 120 req/min)
  • DM_API_UID_RATELIMIT_BURST 桶容量(int,缺省 60)

进程级单例:首次调用时按传入的 ctx 初始化;后续调用忽略 ctx,返回同一个中间件。 在集成测试中若需用不同 Redis 实例重建,调用 resetUIDRateLimiterForTest。

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址