token.go 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425
  1. // Package token SSO token 签发/验签/吊销(ADR-014 最小可行 SSO)。
  2. //
  3. // 本包实现架构规格 §7.2 的 Token 规范:
  4. // - access:JWT RS256,有效期 30min;claims 含 sub(canonical_user_id ULID)、
  5. // roles[]、institution_id、campus_id、jti(吊销维度);
  6. // - refresh:不透明随机串(32 字节 hex),有效期 30 天;Redis 存白名单
  7. // (键 refresh:{jti} → 载荷),刷新时**轮换**(旧 jti 立即失效,防重放);
  8. // - 本地验签:验签只用公钥(进程内存),不依赖中心服务——grace 期语义:
  9. // 滚动重启/服务抖动时,30min 内已签发的 access 仍可通过本地验签通过(ADR-015);
  10. // - 吊销:改密/禁用/登出 → 写 Redis 黑名单 jti(TTL = 该 access 剩余有效期),
  11. // 验签中间件**先查黑名单再验签名**(黑名单命中即拒,无需解析 JWT 载荷)。
  12. //
  13. // 典型使用:
  14. //
  15. // // 启动时装配签发器(私钥/公钥/过期参数/Redis 存储来自 config + infra)
  16. // iss, _ := token.NewIssuer(cfg.Auth.PrivateKeyPEM, cfg.Auth.Issuer,
  17. // 30*time.Minute, 30*24*time.Hour, redisStore, redisStore)
  18. //
  19. // // 登录成功后签发一对凭证
  20. // access, refresh, err := iss.Issue(ctx, token.Claims{
  21. // Sub: canonicalUID, UserID: uid, Roles: []string{"2"},
  22. // InstitutionID: 11, CampusID: 3,
  23. // })
  24. // // 响应 {accessToken: access, refreshToken: refresh, user: ...}
  25. //
  26. // // 验签中间件(每个受保护 Handler 前置)
  27. // claims, err := token.Verify(c.Context(), cfg.Auth.PublicKeysPEM, redisStore,
  28. // cfg.Auth.Issuer, bearer)
  29. // if err != nil { _ = response.Fail(c, errors.ErrUnauth); return }
  30. // // 把 claims 注入多租户作用域(见 infra/scope)
  31. // scope.Set(c, &scope.Scope{InstitutionID: claims.InstitutionID, CampusID: claims.CampusID, ...})
  32. package token
  33. import (
  34. "context"
  35. "crypto/rand"
  36. "crypto/rsa"
  37. "crypto/x509"
  38. "encoding/hex"
  39. "encoding/json"
  40. "encoding/pem"
  41. "errors"
  42. "fmt"
  43. "strconv"
  44. "strings"
  45. "time"
  46. "github.com/golang-jwt/jwt/v5"
  47. )
  48. // ErrInvalidToken access token 无效(签名错误/exp/iss 不符/格式损坏)。
  49. // 调用方(验签中间件)统一映射为 code=1001 未登录(不向用户细分原因)。
  50. var ErrInvalidToken = errors.New("token: access token 无效")
  51. // ErrRevoked access token 已被吊销(jti 命中 Redis 黑名单)。
  52. // 调用方映射为 code=1002 登录态失效(与"过期"区分,便于前端决定"静默 refresh 还是跳登录")。
  53. var ErrRevoked = errors.New("token: 登录态已失效")
  54. // ErrRefreshInvalid refresh token 无效(不在 Redis 白名单/已轮换/已过期)。
  55. var ErrRefreshInvalid = errors.New("token: refresh token 无效")
  56. // RefreshStore refresh 白名单存储接口(Redis 实现见 infra/redis;
  57. // 接口在 identity 侧定义,消费方 identity,infra 只提供 Client——
  58. // 依赖方向:identity → infra,infra 不依赖 identity)。
  59. type RefreshStore interface {
  60. // SetRefresh 写入 refresh 白名单(键 refresh:{jti},TTL=有效期)。
  61. // 入参:ctx 上下文;jti 唯一标识;payload []byte 载荷(序列化后的 RefreshPayload);ttl 有效期。
  62. // 出参:error——仅 Redis 不可用时非 nil(登录接口此时返回 4001/5001 降级,不放行)。
  63. SetRefresh(ctx context.Context, jti string, payload []byte, ttl time.Duration) error
  64. // GetRefresh 读取 refresh 白名单。
  65. // 入参:ctx、jti。出参:payload []byte(不存在时 nil)+ error。
  66. GetRefresh(ctx context.Context, jti string) ([]byte, error)
  67. // DeleteRefresh 删除(轮换/登出/撤销时调用)。幂等:键不存在不报错。
  68. DeleteRefresh(ctx context.Context, jti string) error
  69. }
  70. // RevocationStore 吊销黑名单存储接口(jti 维度)。
  71. type RevocationStore interface {
  72. // AddRevoked 写入黑名单(键 {prefix}:{jti},TTL=该 access 剩余有效期;
  73. // 剩余 ≤0 时实现方可直接跳过——token 本已过期,无需吊销)。
  74. AddRevoked(ctx context.Context, jti string, ttl time.Duration) error
  75. // IsRevoked 查询 jti 是否被吊销。
  76. // 出参:bool 命中;error——Redis 故障时返回 error,调用方策略:**fail-closed**
  77. // (拒绝请求 + 告警),不可 fail-open(吊销失效 = 改密后旧 token 仍可用,安全红线)。
  78. IsRevoked(ctx context.Context, jti string) (bool, error)
  79. }
  80. // Claims access token 的业务声明(嵌入 jwt.RegisteredClaims)。
  81. //
  82. // 字段(与 ADR-014 契约对齐):
  83. // - Sub:canonical_user_id(ULID,26 字符;**禁止**用旧 int user_id 作 sub)。
  84. // - UserID:内部 int 用户 ID(兼容过渡期旧表外键查询;新表一律 Sub)。
  85. // - Roles:角色码数组(7 角色字典:"1"超管/"2"教务/"3"财务/"4"老师/"5"学生/"6"家长/"8"市场;
  86. // 市场登录禁用,正常不会出现 "9")。
  87. // - InstitutionID / CampusID:多租户作用域(Repository scoping 依据,scope.FromCtx 来源)。
  88. // - JTI:走嵌入的 RegisteredClaims.ID(JSON 名 "jti")——吊销/轮换锚点;
  89. // **不要**再自定义 jti 字段(浅层字段会遮蔽 RegisteredClaims.ID,导致解析侧 ID 恒空)。
  90. type Claims struct {
  91. Sub string `json:"sub"`
  92. UserID int64 `json:"uid"`
  93. Roles []string `json:"roles"`
  94. InstitutionID int64 `json:"institution_id"`
  95. CampusID int64 `json:"campus_id"`
  96. jwt.RegisteredClaims
  97. }
  98. // RefreshPayload refresh token 在 Redis 白名单中的载荷(不透明串本身只含 jti 的随机因子,
  99. // 业务载荷存 Redis——refresh 泄露时服务端可即时删除,JWT 做不到)。
  100. //
  101. // 字段:
  102. // - Sub / UserID / Roles / InstitutionID / CampusID:与 access 同源(刷新时原样带入新 access)。
  103. // - CreatedAt time.Time:签发时刻(审计 + 防"未来 refresh")。
  104. type RefreshPayload struct {
  105. Sub string `json:"sub"`
  106. UserID int64 `json:"uid"`
  107. Roles []string `json:"roles"`
  108. InstitutionID int64 `json:"institution_id"`
  109. CampusID int64 `json:"campus_id"`
  110. CreatedAt time.Time `json:"created_at"`
  111. }
  112. // Issuer access/refresh 签发器(持有 RS256 私钥 + 过期参数 + jti 生成器)。
  113. type Issuer struct {
  114. key *rsa.PrivateKey
  115. issuer string
  116. accessTTL time.Duration
  117. refreshTTL time.Duration
  118. refreshStore RefreshStore
  119. revocation RevocationStore
  120. }
  121. // NewIssuer 构造签发器(启动时装配一次,全进程共享;私钥解析失败应 fail-fast 阻止启动)。
  122. //
  123. // 入参:
  124. // - privateKeyPEM string:RS256 私钥 PEM(PKCS1 或 PKCS8;配置 AuthCfg.PrivateKeyPEM,走环境变量)。
  125. // - issuer string:token iss 声明(如 "https://unified.example.com")。
  126. // - accessTTL time.Duration:access 有效期(固定 30min,架构规格 §7.2)。
  127. // - refreshTTL time.Duration:refresh 有效期(固定 30 天)。
  128. // - refreshStore RefreshStore:refresh 白名单存储(Redis 实现)。
  129. // - revocation RevocationStore:吊销黑名单存储(可为 nil——仅纯签发场景;验签必须提供)。
  130. //
  131. // 出参:
  132. // - *Issuer:就绪的签发器。
  133. // - error:私钥 PEM 解析失败(PKCS1/PKCS8 都不匹配时);其余入参不校验(调用方责任)。
  134. //
  135. // 异常场景:
  136. // - 双实例共享同一对 RS256 密钥(ADR-015 单机双实例):两实例签发 token 互相可验,
  137. // refresh/吊销走共享 Redis,天然一致——**无需** per-instance 密钥。
  138. func NewIssuer(privateKeyPEM, issuer string, accessTTL, refreshTTL time.Duration,
  139. refreshStore RefreshStore, revocation RevocationStore) (*Issuer, error) {
  140. key, err := parseRSAPrivateKey(privateKeyPEM)
  141. if err != nil {
  142. return nil, fmt.Errorf("token: 解析 RS256 私钥失败: %w", err)
  143. }
  144. return &Issuer{
  145. key: key,
  146. issuer: issuer,
  147. accessTTL: accessTTL,
  148. refreshTTL: refreshTTL,
  149. refreshStore: refreshStore,
  150. revocation: revocation,
  151. }, nil
  152. }
  153. // Issue 签发一对 access + refresh(登录/refresh 轮换成功后调用)。
  154. //
  155. // 入参:
  156. // - ctx context.Context:请求上下文(透传给 Redis 存储操作)。
  157. // - claims Claims:业务声明(Sub 必填且应为合法 ULID;JTI 留空由本函数填充)。
  158. //
  159. // 出参:
  160. // - accessToken string:JWT(RS256 签名,含 sub/roles/institution_id/campus_id/jti +
  161. // iss/iat/exp/nbf;exp=iat+accessTTL)。
  162. // - refreshToken string:不透明串(48 字符 hex:32 字节随机,前 8 字节为 jti 因子)。
  163. // - err error:以下场景非 nil:
  164. // - claims.Sub 为空 → 包装错误(调用方 bug,单测覆盖);
  165. // - 随机数生成失败(熵源故障);
  166. // - refreshStore 写入失败(Redis 不可用)→ 登录整体失败,不返回"只有 access"的半套凭证。
  167. //
  168. // 样例:
  169. //
  170. // access, refresh, err := iss.Issue(ctx, token.Claims{Sub: uid, UserID: 123,
  171. // Roles: []string{"4"}, InstitutionID: 11, CampusID: 3})
  172. func (iss *Issuer) Issue(ctx context.Context, claims Claims) (accessToken, refreshToken string, err error) {
  173. if claims.Sub == "" {
  174. return "", "", errors.New("token: Issue 要求 claims.Sub(canonical_user_id)非空")
  175. }
  176. now := time.Now()
  177. claims.IssuedAt = jwt.NewNumericDate(now)
  178. claims.NotBefore = jwt.NewNumericDate(now)
  179. claims.ExpiresAt = jwt.NewNumericDate(now.Add(iss.accessTTL))
  180. claims.Issuer = iss.issuer
  181. claims.ID = newJTI() // 每次签发唯一(吊销/轮换的锚点)
  182. token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
  183. signed, err := token.SignedString(iss.key)
  184. if err != nil {
  185. return "", "", fmt.Errorf("token: 签发 access 失败: %w", err)
  186. }
  187. // refresh:32 字节随机 → hex;jti 因子取前 8 字节(白名单键)
  188. buf := make([]byte, 32)
  189. if _, err := rand.Read(buf); err != nil {
  190. return "", "", fmt.Errorf("token: 生成 refresh 随机数失败: %w", err)
  191. }
  192. rjti := hex.EncodeToString(buf[:8])
  193. payload, _ := jsonMarshal(RefreshPayload{
  194. Sub: claims.Sub, UserID: claims.UserID, Roles: claims.Roles,
  195. InstitutionID: claims.InstitutionID, CampusID: claims.CampusID,
  196. CreatedAt: now,
  197. })
  198. if err := iss.refreshStore.SetRefresh(ctx, rjti, payload, iss.refreshTTL); err != nil {
  199. return "", "", fmt.Errorf("token: 写 refresh 白名单失败: %w", err)
  200. }
  201. refreshToken = hex.EncodeToString(buf)
  202. return signed, refreshToken, nil
  203. }
  204. // Verify 验签 access token(验签中间件入口):先查吊销黑名单 → 再验 RS256 签名与 exp/iss。
  205. //
  206. // 入参:
  207. // - ctx context.Context:请求上下文(黑名单查询透传)。
  208. // - rawToken string:Authorization: Bearer <raw> 中的 raw 部分。
  209. //
  210. // 出参:
  211. // - Claims:验签通过的业务声明(含 Sub/Roles/InstitutionID/CampusID/JTI)。
  212. // - error:
  213. // - ErrRevoked:jti 命中黑名单(改密/登出/禁用后);
  214. // - ErrInvalidToken:签名错/exp 过期/iss 不符/格式损坏;
  215. // - 其它 error:黑名单存储故障(fail-closed,调用方映射 5001 + 告警,**不放行**)。
  216. //
  217. // 顺序说明:先查黑名单再验签——黑名单键含 jti,需要解析 JWT 拿 jti;
  218. // 实现上先做轻量格式解析(不验签)取 jti,命中黑名单直接拒(省一次 RSA 验签);
  219. // 未命中再完整验签。解析失败走 ErrInvalidToken。
  220. //
  221. // 样例(验签中间件,c 为 *fiber.Ctx,bearer 取自 Authorization: Bearer <token>):
  222. //
  223. // claims, err := token.Verify(c.Context(), pubKeys, revStore, issuer, bearer)
  224. // switch {
  225. // case errors.Is(err, ErrRevoked), errors.Is(err, ErrInvalidToken):
  226. // return response.Fail(c, errors.ErrUnauth) // 未登录/登录态失效
  227. // case err != nil:
  228. // return response.Fail(c, errors.WithCause(errors.ErrInternal, err)) // 黑名单存储故障(fail-closed)
  229. // }
  230. // sc := scope.Set(c, &scope.Scope{...来自 claims...}) // 注入多租户作用域
  231. func Verify(ctx context.Context, publicKeys []string, revocation RevocationStore, issuer string, rawToken string) (Claims, error) {
  232. var claims Claims
  233. // 轻量解析取 jti(不验签);格式错误直接判无效
  234. parser := jwt.NewParser(jwt.WithoutClaimsValidation())
  235. parsed, _, err := parser.ParseUnverified(rawToken, jwt.MapClaims{})
  236. if err != nil {
  237. return claims, ErrInvalidToken
  238. }
  239. jtiID := jtiFromClaims(parsed.Claims)
  240. if jtiID != "" && revocation != nil {
  241. revoked, rerr := revocation.IsRevoked(ctx, jtiID)
  242. if rerr != nil {
  243. return claims, rerr // fail-closed:存储故障不放行
  244. }
  245. if revoked {
  246. return claims, ErrRevoked
  247. }
  248. }
  249. // 完整验签(签名 + exp + iss);公钥列表支持密钥轮换期新旧并存
  250. for _, pemBlock := range publicKeys {
  251. parsed, err := jwt.ParseWithClaims(rawToken, &claims, func(t *jwt.Token) (interface{}, error) {
  252. if !strings.EqualFold(t.Method.Alg(), "RS256") {
  253. return nil, fmt.Errorf("token: 非预期签名算法 %s", t.Method.Alg())
  254. }
  255. return parseRSAPublicKey(pemBlock)
  256. }, jwt.WithIssuer(issuer), jwt.WithExpirationRequired(), jwt.WithValidMethods([]string{jwt.SigningMethodRS256.Alg()}))
  257. if err == nil && parsed != nil && parsed.Valid {
  258. if claims.ID != jtiID {
  259. // 防御:两次解析 jti 不一致(理论不可能)按无效处理
  260. return Claims{}, ErrInvalidToken
  261. }
  262. return claims, nil
  263. }
  264. }
  265. return claims, ErrInvalidToken
  266. }
  267. // Rotate 用旧 refresh 换新 access + 新 refresh(refresh 轮换,防重放)。
  268. //
  269. // 入参:
  270. // - ctx context.Context:请求上下文。
  271. // - oldRefresh string:旧 refresh 不透明串(48 hex;格式非法直接 ErrRefreshInvalid)。
  272. //
  273. // 出参:
  274. // - accessToken string:新 access(claims 从旧 refresh 的 Redis 载荷恢复,JTI 换新)。
  275. // - newRefresh string:新 refresh(旧 jti 已从白名单删除——旧串再次使用即失效)。
  276. // - err error:
  277. // - ErrRefreshInvalid:串格式错 / 白名单无此 jti(已轮换/已登出/已过期);
  278. // - 载荷反序列化失败:按 ErrRefreshInvalid(脏数据不产生 5xx);
  279. // - 签发/写白名单失败:同 Issuer.Issue 的错误语义。
  280. //
  281. // 原子性说明:Get-Delete-Issue 三步在 Redis 单线程下靠"先删后写"收窄重放窗口;
  282. // 极端并发(同一旧串双请求)下,后到者 Get 已删 → ErrRefreshInvalid,安全侧收敛。
  283. //
  284. // 样例:
  285. //
  286. // access, newRefresh, err := iss.Rotate(ctx, oldRefresh)
  287. // // 响应 {accessToken, refreshToken, refreshExpiresAt}
  288. func (iss *Issuer) Rotate(ctx context.Context, oldRefresh string) (string, string, error) {
  289. raw, err := hex.DecodeString(oldRefresh)
  290. if err != nil || len(raw) != 32 {
  291. return "", "", ErrRefreshInvalid
  292. }
  293. rjti := hex.EncodeToString(raw[:8])
  294. payloadBytes, err := iss.refreshStore.GetRefresh(ctx, rjti)
  295. if err != nil || payloadBytes == nil {
  296. return "", "", ErrRefreshInvalid // 不存在/Redis 故障:一律按"无效"(故障时前端可重试登录)
  297. }
  298. var rp RefreshPayload
  299. if err := jsonUnmarshal(payloadBytes, &rp); err != nil {
  300. return "", "", ErrRefreshInvalid
  301. }
  302. if err := iss.refreshStore.DeleteRefresh(ctx, rjti); err != nil {
  303. return "", "", fmt.Errorf("token: 删除旧 refresh 失败: %w", err) // 删除失败不签发(宁可让用户重登,不放重放窗口)
  304. }
  305. access, refresh, err := iss.Issue(ctx, Claims{
  306. Sub: rp.Sub, UserID: rp.UserID, Roles: rp.Roles,
  307. InstitutionID: rp.InstitutionID, CampusID: rp.CampusID,
  308. })
  309. if err != nil {
  310. return "", "", err
  311. }
  312. return access, refresh, nil
  313. }
  314. // RevokeAll 撤销该用户全部 access token(改密/禁用/删号/登出"多端下线"统一入口,
  315. // 架构规格 §7.4 改密链路)。
  316. //
  317. // 入参:
  318. // - ctx context.Context:请求上下文。
  319. // - jti string:目标 token 的 jti(已知单个);多端下线场景由调用方枚举该用户
  320. // 活跃 jti 列表后逐个调用(jti 枚举依赖 Redis 活跃集合,见 infra/redis 扩展)。
  321. // - ttl time.Duration:该 token 剩余有效期(黑名单键 TTL;≤0 时存储实现可跳过写入)。
  322. //
  323. // 出参:
  324. // - error:仅 Redis 写失败时非 nil(调用方:改密场景下失败必须**阻断改密提交**——
  325. // 凭证已变而旧 token 未吊销 = 安全漏洞;登录态场景可降级为告警)。
  326. //
  327. // 样例:
  328. //
  329. // // 改密成功后的撤销(事务外,Redis 操作)
  330. // if err := iss.RevokeAll(ctx, jti, remainingTTL); err != nil {
  331. // return errors.WithCause(errors.ErrInternal, err) // 阻断改密
  332. // }
  333. func (iss *Issuer) RevokeAll(ctx context.Context, jti string, ttl time.Duration) error {
  334. if iss.revocation == nil {
  335. return errors.New("token: Issuer 未装配 RevocationStore,无法吊销")
  336. }
  337. return iss.revocation.AddRevoked(ctx, jti, ttl)
  338. }
  339. // ---- 私有工具 ----
  340. // jtiFromClaims 从解析后的 claims 中取 jti(兼容 string / float64 两种 JSON 解码形态;
  341. // 空/异常形态返回 "",由调用方按"无可吊销信息"处理——不阻断验签)。
  342. func jtiFromClaims(claims jwt.Claims) string {
  343. if mc, ok := claims.(jwt.MapClaims); ok {
  344. switch v := mc["jti"].(type) {
  345. case string:
  346. return v
  347. case float64: // JWT 数字 jti 的 JSON 解码形态(本项目签发恒为 string,此为防御)
  348. return strconv.FormatInt(int64(v), 10)
  349. }
  350. }
  351. return ""
  352. }
  353. // newJTI 生成 token 唯一 ID(16 字节随机 hex;jti 同时用作吊销/轮换锚点)。
  354. func newJTI() string {
  355. buf := make([]byte, 16)
  356. _, _ = rand.Read(buf) // 熵源故障概率≈0;失败时退化为时间戳(仍唯一性足够,不阻断签发)
  357. return hex.EncodeToString(buf)
  358. }
  359. // parseRSAPrivateKey 解析 PEM 私钥(PKCS1 "RSA PRIVATE KEY" 或 PKCS8 "PRIVATE KEY")。
  360. func parseRSAPrivateKey(pemStr string) (*rsa.PrivateKey, error) {
  361. block, _ := pem.Decode([]byte(pemStr))
  362. if block == nil {
  363. return nil, errors.New("token: 私钥不是合法 PEM")
  364. }
  365. if k, err := x509.ParsePKCS1PrivateKey(block.Bytes); err == nil {
  366. return k, nil
  367. }
  368. k8, err := x509.ParsePKCS8PrivateKey(block.Bytes)
  369. if err != nil {
  370. return nil, err
  371. }
  372. k, ok := k8.(*rsa.PrivateKey)
  373. if !ok {
  374. return nil, errors.New("token: 非 RSA 私钥(要求 RS256)")
  375. }
  376. return k, nil
  377. }
  378. // parseRSAPublicKey 解析 PEM 公钥(SPKI "PUBLIC KEY")。
  379. func parseRSAPublicKey(pemStr string) (*rsa.PublicKey, error) {
  380. block, _ := pem.Decode([]byte(pemStr))
  381. if block == nil {
  382. return nil, errors.New("token: 公钥不是合法 PEM")
  383. }
  384. any, err := x509.ParsePKIXPublicKey(block.Bytes)
  385. if err != nil {
  386. return nil, err
  387. }
  388. k, ok := any.(*rsa.PublicKey)
  389. if !ok {
  390. return nil, errors.New("token: 非 RSA 公钥(要求 RS256)")
  391. }
  392. return k, nil
  393. }
  394. // jsonMarshal / jsonUnmarshal 薄封装(等价于 json.Marshal/Unmarshal,
  395. // 抽一层便于未来统一换加速实现,调用方不直接依赖 encoding/json)。
  396. func jsonMarshal(v interface{}) ([]byte, error) {
  397. return json.Marshal(v)
  398. }
  399. func jsonUnmarshal(b []byte, v interface{}) error {
  400. return json.Unmarshal(b, v)
  401. }