Skip to main content

yang_base/token/
revocation.rs

1//! Token 撤销 / 黑名单机制(H-4)
2//!
3//! JWT 一经签发,在过期前本身无法失效。对登出、改密、强制下线等场景,
4//! 需要一个额外的撤销层。本模块基于 `ToolsBuilder` 显式注入的 Redis 客户端提供两层撤销能力:
5//!
6//! 1. **按单个 Token 撤销(jti 黑名单)**:用于登出。撤销时把 Token 的 `jti`
7//!    写入 Redis,TTL 设为 Token 剩余有效期(过期后 key 自动消失,黑名单不会
8//!    无限增长)。校验时在标准签名/过期校验之外,额外查一次该黑名单。
9//! 2. **按用户批量撤销(subject 时间水位线)**:用于改密、强制下线。撤销时把
10//!    "当前时间戳"写入 `token:user:{hex(sub)}:min_iat`(sub 经 hex 编码,避免特殊
11//!    字符导致 Redis key 歧义),TTL 取 Refresh Token 有效期。
12//!    校验时若该用户存在水位线且 Token 的 `iat` 早于或等于水位线,则视为已撤销——
13//!    一次写入即可让该用户在此之前签发的所有 Token 全部失效。
14//!
15//! 设计约束:**不修改** [`TokenManager::verify_token`] 的现有签名与行为,
16//! 撤销校验通过 [`TokenManager::verify_token_checked`] 提供,保持向后兼容。
17
18use crate::error::BaseError;
19use crate::token::manager::current_unix_timestamp;
20use crate::token::{TokenClaims, TokenManager, TokenType};
21use yang_db::RedisValue;
22
23/// Redis 黑名单 key 前缀。最终 key 形如 `token:blacklist:{jti}`。
24const BLACKLIST_PREFIX: &str = "token:blacklist:";
25
26/// 根据 jti 构造黑名单 Redis key。
27fn blacklist_key(jti: &str) -> String {
28    format!("{BLACKLIST_PREFIX}{jti}")
29}
30
31/// 按用户撤销的时间水位线 key 前缀。最终 key 形如 `token:user:{hex(sub)}:min_iat`。
32const SUBJECT_MIN_IAT_PREFIX: &str = "token:user:";
33
34/// 将字节切片编码为小写 hex 字符串(无外部依赖)。
35fn hex_encode(bytes: &[u8]) -> String {
36    let mut s = String::with_capacity(bytes.len() * 2);
37    for b in bytes {
38        s.push_str(&format!("{b:02x}"));
39    }
40    s
41}
42
43/// 根据 subject 构造"最小签发时间水位线"Redis key。
44///
45/// `sub` 经 hex 编码后嵌入 key,避免含 `:` 等特殊字符导致 Redis key 歧义。
46fn subject_min_iat_key(sub: &str) -> String {
47    format!(
48        "{SUBJECT_MIN_IAT_PREFIX}{}:min_iat",
49        hex_encode(sub.as_bytes())
50    )
51}
52
53/// 判定一个 Token 的签发时间 `iat` 是否被用户水位线 `min_iat` 撤销。
54///
55/// 采用 `iat <= min_iat`(含等号)而非严格小于:撤销与签发都是**秒级**时间戳,
56/// 若用 `<`,则在改密/强制下线那一秒内签发的 Token(`iat == min_iat`)会逃过
57/// 撤销,留下 1 秒旁路窗口(NEW-6)。安全取「过撤一侧」——同秒签发的 Token 一并
58/// 撤销(用户至多需在该秒后重新登录一次),杜绝旁路。
59fn iat_revoked_by_watermark(iat: u64, min_iat: u64) -> bool {
60    iat <= min_iat
61}
62
63fn invalid_revocation_state(message: &str) -> BaseError {
64    BaseError::TokenRevocationStateInvalid(message.to_string())
65}
66
67/// 解析撤销水位线的唯一入口。损坏原值不进入错误文本,避免日志注入和敏感数据回显。
68fn parse_subject_min_iat(raw: &str) -> Result<u64, BaseError> {
69    raw.parse::<u64>()
70        .map_err(|_| invalid_revocation_state("用户撤销水位线不是有效的 u64 时间戳"))
71}
72
73/// 解析 Redis GET 水位线结果;只有 Nil 和 UTF-8 String 属于合法协议形态。
74fn parse_subject_min_iat_value(value: &RedisValue) -> Result<Option<u64>, BaseError> {
75    match value {
76        RedisValue::Nil => Ok(None),
77        RedisValue::String(raw) => parse_subject_min_iat(raw).map(Some),
78        _ => Err(invalid_revocation_state(
79            "用户撤销水位线的 Redis 类型不是 nil/string",
80        )),
81    }
82}
83
84/// 解析单条 GET pipeline 结果,避免高层字符串 API 将非 UTF-8 值折叠为 None。
85fn parse_subject_min_iat_pipeline_results(
86    results: &[RedisValue],
87) -> Result<Option<u64>, BaseError> {
88    let [value] = results else {
89        return Err(invalid_revocation_state(
90            "用户撤销水位线 GET pipeline 返回数量不是 1",
91        ));
92    };
93    parse_subject_min_iat_value(value)
94}
95
96/// 解析固定的 EXISTS + GET pipeline 结果,任何形态歧义均失败关闭。
97fn parse_revocation_pipeline_results(
98    results: &[RedisValue],
99) -> Result<(bool, Option<u64>), BaseError> {
100    let [blacklist_result, watermark_result] = results else {
101        return Err(invalid_revocation_state(
102            "Token 撤销查询 pipeline 返回数量不是 2",
103        ));
104    };
105    let blacklisted = match blacklist_result {
106        RedisValue::Int(0) => false,
107        RedisValue::Int(1) => true,
108        _ => {
109            return Err(invalid_revocation_state(
110                "Token 黑名单 EXISTS 结果不是 0/1 整数",
111            ))
112        }
113    };
114    Ok((blacklisted, parse_subject_min_iat_value(watermark_result)?))
115}
116
117impl TokenManager {
118    /// 撤销一个 Token(写入 Redis 黑名单)。
119    ///
120    /// 先验证 Token(确保 `jti`/`exp` 合法且签名有效),再按 `exp - now` 计算
121    /// 剩余 TTL 写入黑名单。若 Token 已过期则无需撤销,直接返回 `Ok(())`。
122    ///
123    /// # 参数
124    ///
125    /// - `token`: 待撤销的 Token 字符串
126    ///
127    /// # 返回
128    ///
129    /// - `Ok(())`: 撤销成功,或 Token 已过期无需撤销
130    /// - `Err(BaseError::TokenVerifyFailed)`: Token 签名/声明校验失败
131    /// - `Err(BaseError::TokenExpired)`: Token 已过期(无需撤销,返回 `Ok(())`)
132    /// - `Err(BaseError::RedisOperationFailed)`: 写黑名单失败
133    pub async fn revoke_token(&self, token: &str) -> Result<(), BaseError> {
134        let claims = self.verify_token(token)?;
135        self.revoke_claims(&claims).await
136    }
137
138    /// 按已验证的 [`TokenClaims`] 撤销 Token。
139    ///
140    /// 当调用方手头已有验证过的 claims 时,可避免重复验证。
141    ///
142    /// # 参数
143    ///
144    /// - `claims`: 已通过验证的 Token 声明
145    pub async fn revoke_claims(&self, claims: &TokenClaims) -> Result<(), BaseError> {
146        let now = current_unix_timestamp()?;
147        // 剩余有效期;已过期则无需写黑名单
148        let ttl = claims.exp.saturating_sub(now);
149        if ttl == 0 {
150            return Ok(());
151        }
152
153        self.revocation_cache()?
154            .setex(blacklist_key(&claims.jti), ttl as i64, "1")
155            .await
156            .map_err(BaseError::RedisOperationFailed)?;
157        Ok(())
158    }
159
160    /// 按 jti 直接写入撤销黑名单(按给定 TTL 保留)。
161    ///
162    /// 用于「踢出单个会话」等场景:调用方已知会话的当前 refresh jti,
163    /// 但手上没有完整 claims(无法计算 exp)。TTL 由调用方提供,
164    /// 应覆盖对应 refresh token 的剩余有效期(保守取完整 refresh TTL)。
165    pub async fn revoke_by_jti_with_ttl(
166        &self,
167        jti: &str,
168        ttl_seconds: u64,
169    ) -> Result<(), BaseError> {
170        let ttl = i64::try_from(ttl_seconds)
171            .map_err(|_| BaseError::ConfigError("jti 黑名单 TTL 超出 i64 范围".to_string()))?;
172        self.revocation_cache()?
173            .setex(blacklist_key(jti), ttl, "1")
174            .await
175            .map_err(BaseError::RedisOperationFailed)?;
176        Ok(())
177    }
178
179    /// 查询某个 `jti` 是否已被撤销。
180    ///
181    /// # 参数
182    ///
183    /// - `jti`: Token 的唯一标识
184    ///
185    /// # 返回
186    ///
187    /// - `Ok(true)`: 已撤销(命中黑名单)
188    /// - `Ok(false)`: 未撤销
189    /// - `Err(BaseError::RedisOperationFailed)`: Redis 查询失败
190    pub async fn is_revoked(&self, jti: &str) -> Result<bool, BaseError> {
191        let count = self
192            .revocation_cache()?
193            .exists(&[blacklist_key(jti)])
194            .await
195            .map_err(BaseError::RedisOperationFailed)?;
196        Ok(count > 0)
197    }
198
199    /// 按用户(subject)批量撤销该用户在此刻之前签发的所有 Token(token-3)。
200    ///
201    /// 在 Redis 中将 `token:user:{hex(sub)}:min_iat` 写为当前时间戳,作为该用户的
202    /// "最小有效签发时间"水位线。此后 [`TokenManager::verify_token_checked`]
203    /// 会拒绝任何 `iat` 早于或等于该水位线的 Token,从而让此前签发的全部 Token 一次性失效。
204    ///
205    /// 适用于**改密、强制下线**等需要让某用户全部会话立即失效的场景。
206    /// 水位线 TTL 取 Access / Refresh 有效期的较大值(`TokenManager::revocation_watermark_ttl`),
207    /// 确保覆盖撤销前签发的最长寿命 Token,避免 key 过早过期导致已撤销会话「复活」。
208    ///
209    /// # 参数
210    ///
211    /// - `sub`: 用户主题标识(即 Token 的 `sub`)
212    ///
213    /// # 返回
214    ///
215    /// - `Ok(())`: 水位线写入成功
216    /// - `Err(BaseError::RedisOperationFailed)`: Redis 写入失败
217    ///
218    /// # 依赖
219    ///
220    /// 依赖 `ToolsBuilder` 已为 TokenManager 连接 Redis 撤销存储。
221    pub async fn revoke_by_subject(&self, sub: &str) -> Result<(), BaseError> {
222        let now = current_unix_timestamp()?;
223        let ttl = self.revocation_watermark_ttl();
224        self.revocation_cache()?
225            .setex(subject_min_iat_key(sub), ttl as i64, now.to_string())
226            .await
227            .map_err(BaseError::RedisOperationFailed)?;
228        Ok(())
229    }
230
231    /// 查询某用户的"最小有效签发时间"水位线(若不存在返回 `None`)。
232    ///
233    /// # 参数
234    ///
235    /// - `sub`: 用户主题标识
236    ///
237    /// # 返回
238    ///
239    /// - `Ok(Some(ts))`: 该用户已被批量撤销,水位线时间戳为 `ts`
240    /// - `Ok(None)`: 该用户无批量撤销记录
241    /// - `Err(BaseError::RedisOperationFailed)`: Redis 查询失败
242    /// - `Err(BaseError::TokenRevocationStateInvalid)`: 水位线值损坏
243    pub async fn subject_min_iat(&self, sub: &str) -> Result<Option<u64>, BaseError> {
244        let mut pipeline = self.revocation_cache()?.pipeline();
245        pipeline.get(subject_min_iat_key(sub));
246        let results = pipeline
247            .execute()
248            .await
249            .map_err(BaseError::RedisOperationFailed)?;
250        parse_subject_min_iat_pipeline_results(&results)
251    }
252
253    /// 尝试原子撤销一次(SET key val NX EX ttl)。
254    ///
255    /// 与 `revoke_claims`(无条件 SETEX)不同,本方法仅在黑名单中尚不存在该 jti
256    /// 时执行写入。为轮换流程 [`TokenManager::rotate_refresh_token`] 提供竞态保护:
257    /// 并发请求中仅第一个能成功写入,后续返回 `false`。
258    ///
259    /// # 参数
260    ///
261    /// - `jti`: Token 唯一标识
262    /// - `ttl`: 黑名单过期时间(秒),源自 Token 剩余有效期。为 `0` 时直接返回
263    ///   `false`,避免向 Redis 发送 `EX 0`(非法参数)。
264    ///   注意:调用方若需要区分「Token 已过期」与「jti 已被消费(重放)」,
265    ///   必须在调用前自行判断 `exp`,本方法对两者统一返回 `false`。
266    ///
267    /// # 返回
268    ///
269    /// - `Ok(true)`: 成功将 jti 写入黑名单(本次是第一个到达的)
270    /// - `Ok(false)`: jti 已在黑名单中(竞态中落败),或 ttl 为 0(Token 已过期)
271    pub(crate) async fn try_revoke_once(&self, jti: &str, ttl: u64) -> Result<bool, BaseError> {
272        if ttl == 0 {
273            return Ok(false);
274        }
275        self.revocation_cache()?
276            .set_nx_ex(blacklist_key(jti), "1", ttl as i64)
277            .await
278            .map_err(BaseError::RedisOperationFailed)
279    }
280
281    /// 验证 Token,并额外检查黑名单。
282    ///
283    /// 在 [`TokenManager::verify_token`] 的全部校验之上,再做两层撤销检查:
284    /// 1. 查 `jti` 黑名单(单 Token 撤销 / 登出);
285    /// 2. 查该用户的 `min_iat` 水位线(按用户批量撤销 / 改密、强制下线):
286    ///    若存在水位线且 Token 的 `iat` 早于或等于它,则视为已撤销。
287    ///
288    /// 鉴权路径若需支持登出/撤销,应使用本方法替代 `verify_token`。
289    ///
290    /// # 参数
291    ///
292    /// - `token`: 待验证的 Token 字符串
293    /// - `expected`: 期望的 Token 类型(下沉校验:签名验证通过后、Redis 查询之前
294    ///   比对 `token_type`,鉴权路径不再依赖调用点自行比对)
295    ///
296    /// # 返回
297    ///
298    /// - `Ok(TokenClaims)`: 验证通过且未被撤销
299    /// - `Err(BaseError::TokenVerifyFailed)`: 签名/过期/声明校验失败
300    /// - `Err(BaseError::TokenTypeInvalid)`: Token 类型与 `expected` 不匹配
301    /// - `Err(BaseError::TokenRevoked)`: Token 已被撤销(命中黑名单或不晚于用户水位线)
302    /// - `Err(BaseError::RedisOperationFailed)`: 黑名单查询失败
303    /// - `Err(BaseError::TokenRevocationStateInvalid)`: 撤销查询结果或水位线损坏
304    pub async fn verify_token_checked(
305        &self,
306        token: &str,
307        expected: TokenType,
308    ) -> Result<TokenClaims, BaseError> {
309        let claims = self.verify_token(token)?;
310        // 下沉 token_type 校验:鉴权路径不再依赖调用点自行比对,防止遗漏。
311        if claims.token_type != expected {
312            return Err(BaseError::TokenTypeInvalid("Token 类型不匹配".to_string()));
313        }
314
315        // PERF-2: 将两次 Redis 读(EXISTS + GET)合并为一条 pipeline,2 RTT → 1 RTT。
316        // 对已黑名单 token 会失去短路(不再提前返回),但撤销场景罕见,可接受。
317        let mut pipeline = self.revocation_cache()?.pipeline();
318        pipeline
319            .exists(blacklist_key(&claims.jti))
320            .get(subject_min_iat_key(&claims.sub));
321        let results = pipeline
322            .execute()
323            .await
324            .map_err(BaseError::RedisOperationFailed)?;
325
326        let (blacklisted, min_iat) = parse_revocation_pipeline_results(&results)?;
327        if blacklisted {
328            return Err(BaseError::TokenRevoked);
329        }
330
331        if min_iat.is_some_and(|watermark| iat_revoked_by_watermark(claims.iat, watermark)) {
332            return Err(BaseError::TokenRevoked);
333        }
334
335        Ok(claims)
336    }
337}
338
339#[cfg(test)]
340mod tests {
341    use super::*;
342
343    #[test]
344    fn test_blacklist_key_format() {
345        assert_eq!(blacklist_key("abc-123"), "token:blacklist:abc-123");
346    }
347
348    #[test]
349    fn test_subject_min_iat_key_format() {
350        // sub 经 hex 编码,避免特殊字符导致 key 歧义
351        assert_eq!(
352            subject_min_iat_key("user_42"),
353            "token:user:757365725f3432:min_iat"
354        );
355    }
356
357    #[test]
358    fn test_subject_min_iat_key_colon_safe() {
359        // sub 含冒号时 hex 编码后不再产生歧义
360        let key = subject_min_iat_key("user:admin");
361        assert_eq!(key, "token:user:757365723a61646d696e:min_iat");
362        // 确保 key 中不会出现未转义的冒号(除固定分隔符外)
363        let after_prefix = key.strip_prefix("token:user:").unwrap();
364        let (hex_part, rest) = after_prefix.split_once(':').unwrap();
365        assert_eq!(rest, "min_iat");
366        // hex 部分只含 0-9a-f
367        assert!(hex_part.chars().all(|c| c.is_ascii_hexdigit()));
368    }
369
370    /// NEW-6:同秒签发(iat == min_iat)必须被撤销,杜绝 1 秒旁路窗口。
371    #[test]
372    fn test_iat_revoked_by_watermark_same_second() {
373        // 早于水位线:撤销
374        assert!(iat_revoked_by_watermark(100, 200));
375        // 同秒签发:必须撤销(含等号,这是修复点)
376        assert!(iat_revoked_by_watermark(200, 200));
377        // 晚于水位线:放行
378        assert!(!iat_revoked_by_watermark(201, 200));
379    }
380
381    #[test]
382    fn watermark_parser_accepts_only_absent_or_valid_u64_string() {
383        assert_eq!(
384            parse_subject_min_iat_value(&yang_db::RedisValue::Nil).expect("缺少水位线是合法状态"),
385            None
386        );
387        assert_eq!(
388            parse_subject_min_iat_value(&yang_db::RedisValue::String("0".to_string()))
389                .expect("u64 下界应有效"),
390            Some(0)
391        );
392        assert_eq!(
393            parse_subject_min_iat_value(&yang_db::RedisValue::String(u64::MAX.to_string()))
394                .expect("u64 上界应有效"),
395            Some(u64::MAX)
396        );
397    }
398
399    #[test]
400    fn watermark_parser_rejects_corrupt_strings_and_wrong_redis_types() {
401        let invalid_values = [
402            yang_db::RedisValue::String(String::new()),
403            yang_db::RedisValue::String("-1".to_string()),
404            yang_db::RedisValue::String("18446744073709551616".to_string()),
405            yang_db::RedisValue::String("secret-corrupt-watermark".to_string()),
406            yang_db::RedisValue::Bytes(vec![0xff]),
407            yang_db::RedisValue::Int(42),
408            yang_db::RedisValue::Bool(false),
409            yang_db::RedisValue::Array(Vec::new()),
410        ];
411
412        for value in invalid_values {
413            let error = parse_subject_min_iat_value(&value)
414                .expect_err("损坏或错误类型的水位线必须失败关闭");
415            assert!(
416                matches!(&error, BaseError::TokenRevocationStateInvalid(_)),
417                "损坏水位线必须返回结构化错误,实际为: {error:?}"
418            );
419            assert_eq!(error.code(), 400008);
420            assert!(error.is_server_error());
421            assert!(
422                !error.to_string().contains("secret-corrupt-watermark"),
423                "错误不得回显 Redis 中的损坏原值"
424            );
425        }
426    }
427
428    #[test]
429    fn subject_watermark_pipeline_parser_requires_exactly_one_result() {
430        for values in [
431            vec![],
432            vec![yang_db::RedisValue::Nil, yang_db::RedisValue::Nil],
433        ] {
434            assert!(
435                matches!(
436                    parse_subject_min_iat_pipeline_results(&values),
437                    Err(BaseError::TokenRevocationStateInvalid(_))
438                ),
439                "水位线 GET 必须恰好返回一个结果: {values:?}"
440            );
441        }
442
443        assert_eq!(
444            parse_subject_min_iat_pipeline_results(&[yang_db::RedisValue::Nil])
445                .expect("缺少水位线是合法状态"),
446            None
447        );
448        assert_eq!(
449            parse_subject_min_iat_pipeline_results(&[yang_db::RedisValue::String(
450                "42".to_string()
451            )])
452            .expect("合法水位线应通过"),
453            Some(42)
454        );
455    }
456
457    #[test]
458    fn revocation_pipeline_parser_rejects_ambiguous_results() {
459        for values in [
460            vec![],
461            vec![yang_db::RedisValue::Int(0)],
462            vec![
463                yang_db::RedisValue::Int(0),
464                yang_db::RedisValue::Nil,
465                yang_db::RedisValue::Nil,
466            ],
467            vec![
468                yang_db::RedisValue::String("0".to_string()),
469                yang_db::RedisValue::Nil,
470            ],
471            vec![yang_db::RedisValue::Int(-1), yang_db::RedisValue::Nil],
472            vec![yang_db::RedisValue::Int(2), yang_db::RedisValue::Nil],
473        ] {
474            assert!(
475                matches!(
476                    parse_revocation_pipeline_results(&values),
477                    Err(BaseError::TokenRevocationStateInvalid(_))
478                ),
479                "不明确的撤销查询结果必须失败关闭: {values:?}"
480            );
481        }
482
483        assert_eq!(
484            parse_revocation_pipeline_results(&[
485                yang_db::RedisValue::Int(0),
486                yang_db::RedisValue::String("42".to_string()),
487            ])
488            .expect("固定合法结果应通过"),
489            (false, Some(42))
490        );
491        assert_eq!(
492            parse_revocation_pipeline_results(&[
493                yang_db::RedisValue::Int(1),
494                yang_db::RedisValue::Nil,
495            ])
496            .expect("黑名单命中且无水位线是合法状态"),
497            (true, None)
498        );
499    }
500}