Skip to content

fix(email): preserve legacy verification attempt budgets - #7920

Open
MrCrazyLeo wants to merge 2 commits into
Wei-Shaw:mainfrom
MrCrazyLeo:fix/legacy-email-verification-attempts
Open

MrCrazyLeo wants to merge 2 commits into
Wei-Shaw:mainfrom
MrCrazyLeo:fix/legacy-email-verification-attempts

Conversation

@MrCrazyLeo

@MrCrazyLeo MrCrazyLeo commented Oct 8, 2026 •

Copy link
Copy Markdown

问题与触发条件

本 PR 修复 #7676 引入独立验证码计数器后,对升级前已有 Redis 数据的兼容缺口:旧验证码已消耗的尝试次数没有被继承到独立计数器,导致仍有效的旧验证码获得额外猜测机会。

触发条件:

  1. 验证码由 fix(email): 验证码尝试次数原子化 + 重置密码 token 哈希存储且原子单次消费 #7676 之前的实现生成,仍处于有效期内。
  2. 失败次数保存在验证码 JSON 的 Attempts 字段中。
  3. 新增的 :attempts 独立计数器不存在,或其值落后于 JSON 中的次数。
  4. 升级后的服务继续校验该验证码。

例如,JSON 中已有 Attempts: 4、独立计数器不存在时,修复前的 INCR 从 0 递增到 1,第五次错误输入没有耗尽既有的五次尝试额度。修复后先继承 4,再递增到 5,该次错误输入立即返回 ErrVerifyCodeMaxAttempts;随后即使输入正确验证码,也会因额度已耗尽而被拒绝。

根因

#7676 将验证码尝试次数改为独立 Redis key,以支持原子递增。读取验证码的 getCode 已取 JSON 与独立计数器的较大值,但旧版 incrAttemptsScript 仅检查验证码 key 是否存在,然后直接递增独立计数器,没有继承旧 JSON 的 Attempts。

因此,读取到的历史次数与递增返回的次数可能不一致;业务层用于本次额度判断的递增结果会落后于升级前已经消耗的次数。

改动范围

本 PR 共 1 个提交、2 个文件,新增 139 行、删除 5 行。生产代码仅修改共享的计数 Lua 脚本,其余为回归测试。

文件 改动 用途
backend/internal/repository/email_cache.go +18 / -5 修复 incrAttemptsScript 对旧 JSON 次数的继承,并保留验证码剩余 TTL
backend/internal/repository/email_cache_atomic_test.go +121 新增旧数据兼容、业务上限、并发及重发回归测试

Lua 脚本在同一次原子操作中完成:

  • 读取验证码 JSON;验证码不存在、JSON 无法解码或解码结果不是 table 时返回失效结果。
  • 读取验证码剩余 PTTL,对不存在或剩余 TTL 为 0 的验证码返回失效结果。
  • 读取 JSON 的 Attempts 和独立计数器,以两者较大值为基础递增;已有独立计数器领先时,不将其回退到旧 JSON 的较小值。
  • 对仍有正数剩余 TTL 的验证码,将计数器过期时间对齐到该剩余 TTL。

计数规则为 max(legacy Attempts, separate counter) + 1,例如:

JSON 次数 独立计数器 缓存递增结果
0 不存在 1
4 不存在 5
4 2 5
4 7 8
5 不存在 6

以上是缓存递增行为;业务校验仍会在读取到已达上限的次数时提前拒绝,不代表允许超过五次进行验证码比较。

影响范围与行为边界

两类验证码共用 incrCodeAttempts 和此次修改的 Lua 脚本:

场景 Redis key 调用链 修复后的行为
邮箱验证码校验 verify_code:<email> 及其 :attempts key EmailService.VerifyCode → verifyCodeWithAttempts → IncrVerificationCodeAttempts 升级前已有的尝试次数继续占用原额度
添加/验证额外通知邮箱 notify_verify:<email> 及其 :attempts key UserService.VerifyAndAddNotifyEmail → verifyNotifyCode → verifyCodeWithAttempts → IncrNotifyVerifyCodeAttempts 同样保留历史次数,第五次错误尝试达到上限
  • 直接修复对象:仍有效、已有 JSON 次数且独立计数器缺失或落后的验证码。该兼容修复在下一次递增时生效,无需批量迁移 Redis 数据。
  • 升级后新发验证码:继续使用现有初始化方式;零次尝试从 1 开始递增,有效的已有计数器不会因本次修复被降低。
  • 有效期:不改写验证码 JSON,不改变其中的验证码、创建时间或到期时间,不延长原验证码 Redis key 的生命周期;计数器跟随验证码剩余 TTL 过期。
  • 并发:次数比较、继承、递增和 TTL 对齐均在一个 Lua 原子操作中完成。业务层既有的五次尝试上限、先预占次数再比较验证码的逻辑保持不变。
  • 重新发送:沿用现有 setCode 清理旧计数器的行为,新验证码重新开始计数。
  • 接口与其他功能:不修改 HTTP 路由、请求/响应结构、前端、数据库 schema 或配置;不修改密码重置 token 的存储/消费脚本、SMTP 发送逻辑、发送冷却或通知邮箱用户级限流。
  • 运行开销:Lua 内增加验证码 JSON 解码与计数读取,客户端仍通过一次脚本调用完成递增,没有新增该操作的 Redis 客户端往返。此次没有性能基准测试,不宣称吞吐或延迟提升。

回归测试

新增 3 个顶层测试:

测试 覆盖内容
TestEmailCacheLegacyAttemptCountAndRemainingTTL 邮箱验证码与通知邮箱验证码两种缓存;零次、旧次数为 4/5、独立计数器领先/落后;先消耗 23 秒有效期后递增;验证码 JSON 不被改写、剩余 TTL 不延长、计数器 TTL 对齐;到期后递增失败且计数器不存在
TestEmailCacheLegacyCodeStillStopsAtFifthWrongAttempt 两种业务校验链路均从旧 JSON 的 4 次失败开始,第五次错误输入返回上限错误,随后正确验证码也被拒绝
TestEmailCacheLegacyAttemptsConcurrentAndResend 通知邮箱旧次数为 4 时,30 个并发递增返回互不重复的 5–34;计数器 TTL 与验证码一致;重新发送后下一次递增返回 1

同一测试文件内已有的并发尝试上限、新验证码计数重置、密码重置 token 哈希存储和一次性消费测试也包含在下面的定向命令中。

验证结果与未覆盖项

提交前已完成的验证(沿用原 PR 的验证记录):

  • 在上游 main 基础上执行 go test -mod=readonly -tags=unit ./internal/repository -run TestEmailCache -count=1:7 个顶层测试和 14 个子测试通过。
  • 使用 Go overlay 恢复修复前的 Lua 后,新增的旧数据兼容测试失败,确认测试能够捕获原问题。
  • gofmt 和 git diff --check 通过。

证据边界:上述缓存测试使用 miniredis,业务上限测试调用真实 service 校验逻辑;不等同于真实 Redis 集成、HTTP/浏览器端到端、生产部署或新旧节点同时处理同一验证码的完整滚动升级验收。本次正文更新没有重新执行测试,也没有修改代码提交。

CLA 已签署,原失败的 cla-check 重跑后通过。当前 CI 与 Security Scan 仍等待上游维护者批准运行,尚无这两项工作流的测试结果;后续全量测试、lint 和安全扫描结果以 GitHub 工作流为准。

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA. ✅
Posted by the CLA Assistant Lite bot.

@MrCrazyLeo

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Oct 8, 2026
riofutab added a commit to riofutab/sub2api that referenced this pull request Oct 9, 2026
- 合入上游 Wei-Shaw#7920:升级前生成的验证码把已消耗的尝试次数继承到独立计数器,不再多给猜测机会

测试:随整合分支统一验证(unit 全量、golangci-lint、前端检查)。
riofutab added a commit to riofutab/sub2api that referenced this pull request Oct 9, 2026
- 合入上游已合并的 Wei-Shaw#7618:平台改为数据驱动,接入 Command Code 与 Cline,Go 升级到 1.27.2,golangci-lint 升级到 v2.14.0。
- 合入开放 PR Wei-Shaw#7920 Wei-Shaw#7924 Wei-Shaw#7928 Wei-Shaw#7930 Wei-Shaw#7931 Wei-Shaw#7933 Wei-Shaw#7935 Wei-Shaw#7936 Wei-Shaw#7939 Wei-Shaw#7941 Wei-Shaw#7947 Wei-Shaw#7951 Wei-Shaw#7954 Wei-Shaw#7956 Wei-Shaw#7960。
- 新增 Decisions 决策接口(Wei-Shaw#7922)及其与 TypeSafe System One 的双向互转(Wei-Shaw#7948),上游 404 时切换账号。
- Haiku 5.5 的 top_p 违规请求在网关直接拒绝,OAuth 伪装不再在 top_p 旁补 temperature,工具集 beta 过滤覆盖 Haiku 5.5。
- 修正新增代码的静态检查告警。

全量 unit 测试、golangci-lint、前端全量 vitest 均已通过;集成测试本机无 Docker,待 CI 验证。
@MrCrazyLeo

Copy link
Copy Markdown
Author

@Wei-Shaw 麻烦有空帮忙看一下这个小修复,并批准运行最新 CI 🙏

本 PR 补齐 #7676 的旧数据兼容:升级前验证码 JSON 中已消耗的 Attempts,没有继承到独立计数器,可能使仍有效的旧验证码获得额外尝试机会。

已同步最新 main,差异仅 2 个文件;7 个定向测试及 14 个子测试通过,本地 govulncheck 通过。新增回归测试可捕获修复前的问题。

如果更适合其他实现方式,我可以按建议调整。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant