garrison 0.7.2

Garrison - 面向 Rust 生态的一站式身份认证鉴权框架
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
//! Copyright (c) 2026 Kirky.X. All rights reserved.
//! See LICENSE for full license text.

//! `BanStorage` 适配器,用 `GarrisonDao` KV 存储封禁记录。
//!
//! # 存储格式
//! - 封禁记录:`limiteron:ban:{type}:{value}` → `expires_at_ts|ban_times|is_manual|reason`
//! - 封禁次数:`limiteron:ban:times:{type}:{value}` → `u64`
//! - 封禁历史:`limiteron:ban:history:{type}:{value}` → `ban_times|last_banned_at_ts`
//!
//! # 限制
//! `list_bans` 和 `cleanup_expired_bans` 无法实现(GarrisonDao 无 iter API),
//! `is_banned` 在查询时检查过期时间(过期返回 None)。

use crate::dao::GarrisonDao;
use async_trait::async_trait;
use chrono::{DateTime, Utc};
use limiteron::error::StorageError;
use limiteron::storage::{BanHistory, BanRecord, BanStorage, BanTarget};
use std::sync::Arc;
use std::time::Duration;

use super::errors::map_to_storage_err;

/// 封禁 key 前缀。
const BAN_KEY_PREFIX: &str = "limiteron:ban";
/// 封禁次数 key 前缀。
const BAN_TIMES_KEY_PREFIX: &str = "limiteron:ban:times";
/// 封禁历史 key 前缀。
const BAN_HISTORY_KEY_PREFIX: &str = "limiteron:ban:history";

/// 将 `BanTarget` 序列化为 key 片段。
fn target_to_key_fragment(target: &BanTarget) -> String {
    match target {
        BanTarget::Ip(ip) => format!("ip:{}", ip),
        BanTarget::UserId(uid) => format!("user:{}", uid),
        BanTarget::Mac(mac) => format!("mac:{}", mac),
        BanTarget::Geo { country_code } => format!("geo:{}", country_code),
    }
}

/// 封禁记录 key:`limiteron:ban:{type}:{value}`。
fn ban_record_key(target: &BanTarget) -> String {
    format!("{}:{}", BAN_KEY_PREFIX, target_to_key_fragment(target))
}

/// 封禁次数 key:`limiteron:ban:times:{type}:{value}`。
fn ban_times_key(target: &BanTarget) -> String {
    format!(
        "{}:{}",
        BAN_TIMES_KEY_PREFIX,
        target_to_key_fragment(target)
    )
}

/// 封禁历史 key:`limiteron:ban:history:{type}:{value}`。
fn ban_history_key(target: &BanTarget) -> String {
    format!(
        "{}:{}",
        BAN_HISTORY_KEY_PREFIX,
        target_to_key_fragment(target)
    )
}

/// 序列化 `BanRecord` 为字符串:`expires_at_ts|ban_times|is_manual|reason`。
fn serialize_ban_record(record: &BanRecord) -> String {
    format!(
        "{}|{}|{}|{}",
        record.expires_at.timestamp(),
        record.ban_times,
        record.is_manual,
        record.reason
    )
}

/// 反序列化 `BanRecord`。
fn deserialize_ban_record(target: &BanTarget, val: &str) -> Option<BanRecord> {
    let parts: Vec<&str> = val.splitn(4, '|').collect();
    if parts.len() != 4 {
        return None;
    }
    let expires_at_ts: i64 = parts[0].parse().ok()?;
    let ban_times: u32 = parts[1].parse().ok()?;
    let is_manual = parts[2] == "true";
    let reason = parts[3].to_string();
    let expires_at = DateTime::from_timestamp(expires_at_ts, 0)?;
    let banned_at = expires_at
        - chrono::Duration::from_std(record_duration_from_ban(target, ban_times))
            .unwrap_or_else(|_| chrono::Duration::seconds(0));
    let duration = record_duration_from_ban(target, ban_times);
    Some(BanRecord {
        target: target.clone(),
        ban_times,
        duration,
        banned_at,
        expires_at,
        is_manual,
        reason,
    })
}

/// 从 ban_times 推断 duration(简化:ban_times * 300s)。
fn record_duration_from_ban(_target: &BanTarget, ban_times: u32) -> Duration {
    Duration::from_secs((ban_times as u64).saturating_mul(300))
}

/// `BanStorage` 适配器,用 `GarrisonDao` KV 存储封禁记录。
///
/// # 存储格式
/// - 封禁记录:`limiteron:ban:{type}:{value}` → `expires_at_ts|ban_times|is_manual|reason`
/// - 封禁次数:`limiteron:ban:times:{type}:{value}` → `u64`
/// - 封禁历史:`limiteron:ban:history:{type}:{value}` → `ban_times|last_banned_at_ts`
///
/// # 限制
/// `list_bans` 和 `cleanup_expired_bans` 无法实现(GarrisonDao 无 iter API),
/// `is_banned` 在查询时检查过期时间(过期返回 None)。
pub struct GarrisonDaoBanStorage {
    pub(super) dao: Arc<dyn GarrisonDao>,
}

impl GarrisonDaoBanStorage {
    /// 创建适配器实例。
    ///
    /// # 参数
    /// - `dao`: 内部 DAO 实现。
    pub fn new(dao: Arc<dyn GarrisonDao>) -> Self {
        Self { dao }
    }
}

#[async_trait]
impl BanStorage for GarrisonDaoBanStorage {
    async fn is_banned(&self, target: &BanTarget) -> Result<Option<BanRecord>, StorageError> {
        let key = ban_record_key(target);
        match self.dao.get(&key).await.map_err(map_to_storage_err)? {
            None => Ok(None),
            Some(val) => {
                let record = deserialize_ban_record(target, &val);
                if let Some(ref r) = record {
                    if r.expires_at <= Utc::now() {
                        // 已过期,返回 None
                        return Ok(None);
                    }
                }
                Ok(record)
            },
        }
    }

    async fn save(&self, record: &BanRecord) -> Result<(), StorageError> {
        let key = ban_record_key(&record.target);
        let val = serialize_ban_record(record);
        let ttl = (record.expires_at - Utc::now()).num_seconds().max(0) as u64;
        self.dao
            .set(&key, &val, ttl)
            .await
            .map_err(map_to_storage_err)?;

        // 同步更新封禁次数和历史
        let times_key = ban_times_key(&record.target);
        self.dao
            .set(&times_key, &record.ban_times.to_string(), ttl)
            .await
            .map_err(map_to_storage_err)?;

        let history_key = ban_history_key(&record.target);
        let history_val = format!("{}|{}", record.ban_times, Utc::now().timestamp());
        self.dao
            .set(&history_key, &history_val, ttl)
            .await
            .map_err(map_to_storage_err)
    }

    async fn get_history(&self, target: &BanTarget) -> Result<Option<BanHistory>, StorageError> {
        let key = ban_history_key(target);
        match self.dao.get(&key).await.map_err(map_to_storage_err)? {
            None => Ok(None),
            Some(val) => {
                let parts: Vec<&str> = val.splitn(2, '|').collect();
                if parts.len() != 2 {
                    return Err(StorageError::QueryError(format!(
                        "limiteron-ban-history-format-error::{}::{}::{}",
                        key,
                        val,
                        parts.len()
                    )));
                }
                // M-3: parse 失败显性化 — 脏数据返回 Err(fail-fast)
                let ban_times: u32 = parts[0].parse().map_err(|e| {
                    StorageError::QueryError(format!(
                        "limiteron-ban-history-parse-ban-times::{}::{}::{}",
                        key, parts[0], e
                    ))
                })?;
                let last_banned_at_ts: i64 = parts[1].parse().map_err(|e| {
                    StorageError::QueryError(format!(
                        "limiteron-ban-history-parse-last-banned::{}::{}::{}",
                        key, parts[1], e
                    ))
                })?;
                let last_banned_at =
                    DateTime::from_timestamp(last_banned_at_ts, 0).unwrap_or_else(Utc::now);
                Ok(Some(BanHistory {
                    ban_times,
                    last_banned_at,
                }))
            },
        }
    }

    async fn increment_ban_times(&self, target: &BanTarget) -> Result<u64, StorageError> {
        let key = ban_times_key(target);
        // 用 incr 递增(默认 TTL=0,永久存储)
        self.dao.incr(&key, 0).await.map_err(map_to_storage_err)
    }

    async fn get_ban_times(&self, target: &BanTarget) -> Result<u64, StorageError> {
        let key = ban_times_key(target);
        match self.dao.get(&key).await.map_err(map_to_storage_err)? {
            None => Ok(0),
            // M-3: parse 失败显性化 — 脏数据返回错误而非静默用 0
            Some(val) => val.parse::<u64>().map_err(|e| {
                StorageError::QueryError(format!(
                    "limiteron-ban-times-parse-failed::{}::{}::{}",
                    key, val, e
                ))
            }),
        }
    }

    async fn remove_ban(&self, target: &BanTarget) -> Result<(), StorageError> {
        let record_key = ban_record_key(target);
        let times_key = ban_times_key(target);
        let history_key = ban_history_key(target);
        self.dao
            .delete(&record_key)
            .await
            .map_err(map_to_storage_err)?;
        self.dao
            .delete(&times_key)
            .await
            .map_err(map_to_storage_err)?;
        self.dao
            .delete(&history_key)
            .await
            .map_err(map_to_storage_err)
    }

    async fn cleanup_expired_bans(&self) -> Result<u64, StorageError> {
        // GarrisonDao 无 iter API,无法扫描过期 key
        // 封禁记录设置 TTL,过期自动删除;is_banned 查询时检查过期时间
        Ok(0)
    }

    async fn list_bans(
        &self,
        _active_only: bool,
        _offset: u64,
        _limit: u64,
    ) -> Result<Vec<BanRecord>, StorageError> {
        // GarrisonDao 无 iter API,无法列出所有 key
        Ok(Vec::new())
    }

    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::dao::tests::MockDao;

    fn make_dao() -> Arc<dyn GarrisonDao> {
        Arc::new(MockDao::new())
    }

    // --- GarrisonDaoBanStorage 测试 ---

    #[tokio::test]
    async fn ban_save_and_is_banned() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Ip("192.168.1.1".to_string());

        // 未封禁
        assert!(storage.is_banned(&target).await.unwrap().is_none());

        // 封禁
        let record = BanRecord {
            target: target.clone(),
            ban_times: 1,
            duration: Duration::from_secs(300),
            banned_at: Utc::now(),
            expires_at: Utc::now() + chrono::Duration::seconds(300),
            is_manual: false,
            reason: "bruteforce".to_string(),
        };
        storage.save(&record).await.unwrap();

        // 已封禁
        let banned = storage.is_banned(&target).await.unwrap();
        assert!(banned.is_some());
        assert_eq!(banned.unwrap().ban_times, 1);
    }

    #[tokio::test]
    async fn ban_expired_returns_none() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Ip("10.0.0.1".to_string());

        let record = BanRecord {
            target: target.clone(),
            ban_times: 1,
            duration: Duration::from_secs(1),
            banned_at: Utc::now() - chrono::Duration::seconds(10),
            expires_at: Utc::now() - chrono::Duration::seconds(5), // 已过期
            is_manual: false,
            reason: "test".to_string(),
        };
        // 直接写入 DAO(绕过 save 的 TTL 计算)
        let key = ban_record_key(&target);
        let val = serialize_ban_record(&record);
        storage.dao.set(&key, &val, 0).await.unwrap();

        // is_banned 应返回 None(已过期)
        assert!(storage.is_banned(&target).await.unwrap().is_none());
    }

    #[tokio::test]
    async fn ban_increment_and_get_times() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::UserId("user123".to_string());

        assert_eq!(storage.get_ban_times(&target).await.unwrap(), 0);

        let t1 = storage.increment_ban_times(&target).await.unwrap();
        assert_eq!(t1, 1);

        let t2 = storage.increment_ban_times(&target).await.unwrap();
        assert_eq!(t2, 2);

        assert_eq!(storage.get_ban_times(&target).await.unwrap(), 2);
    }

    #[tokio::test]
    async fn ban_remove() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Ip("172.16.0.1".to_string());

        let record = BanRecord {
            target: target.clone(),
            ban_times: 1,
            duration: Duration::from_secs(300),
            banned_at: Utc::now(),
            expires_at: Utc::now() + chrono::Duration::seconds(300),
            is_manual: true,
            reason: "manual".to_string(),
        };
        storage.save(&record).await.unwrap();
        assert!(storage.is_banned(&target).await.unwrap().is_some());

        storage.remove_ban(&target).await.unwrap();
        assert!(storage.is_banned(&target).await.unwrap().is_none());
        assert_eq!(storage.get_ban_times(&target).await.unwrap(), 0);
    }

    #[tokio::test]
    async fn ban_get_history() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Mac("AA:BB:CC:DD:EE:FF".to_string());

        let record = BanRecord {
            target: target.clone(),
            ban_times: 3,
            duration: Duration::from_secs(900),
            banned_at: Utc::now(),
            expires_at: Utc::now() + chrono::Duration::seconds(900),
            is_manual: false,
            reason: "repeat".to_string(),
        };
        storage.save(&record).await.unwrap();

        let history = storage.get_history(&target).await.unwrap();
        assert!(history.is_some());
        assert_eq!(history.unwrap().ban_times, 3);
    }

    #[tokio::test]
    async fn ban_list_bans_returns_empty() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let bans = storage.list_bans(true, 0, 10).await.unwrap();
        assert!(
            bans.is_empty(),
            "list_bans 应返回空 Vec(GarrisonDao 无 iter API)"
        );
    }

    #[tokio::test]
    async fn ban_cleanup_returns_zero() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let count = storage.cleanup_expired_bans().await.unwrap();
        assert_eq!(
            count, 0,
            "cleanup_expired_bans 应返回 0(GarrisonDao 无 iter API)"
        );
    }

    // --- M-3: unwrap_or(0) 静默吞错修复测试 ---

    /// M-3: BanStorage::get_ban_times 遇到脏数据时返回错误(非静默用 0)。
    #[tokio::test]
    async fn m3_ban_get_ban_times_dirty_data_returns_err() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Ip("1.2.3.4".to_string());
        // 直接注入脏数据
        let key = ban_times_key(&target);
        storage.dao.set(&key, "not-a-number", 0).await.unwrap();
        let result = storage.get_ban_times(&target).await;
        assert!(result.is_err(), "脏数据应返回错误,实际: {:?}", result);
        let err_msg = format!("{}", result.unwrap_err());
        assert!(
            err_msg.contains("limiteron-ban-times-parse-failed"),
            "错误消息应包含 'limiteron-ban-times-parse-failed',实际: {}",
            err_msg
        );
    }

    /// M-3: BanStorage::get_history 遇到脏数据时返回错误(fail-fast)。
    #[tokio::test]
    async fn m3_ban_get_history_dirty_data_returns_err() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Ip("5.6.7.8".to_string());
        let key = ban_history_key(&target);
        // ban_times 字段是非数字
        storage.dao.set(&key, "not-number|1000", 0).await.unwrap();
        let result = storage.get_history(&target).await;
        assert!(result.is_err(), "脏数据应返回错误,实际: {:?}", result);
        let err_msg = format!("{}", result.unwrap_err());
        assert!(
            err_msg.contains("limiteron-ban-history-parse-ban-times"),
            "错误消息应包含 'limiteron-ban-history-parse-ban-times',实际: {}",
            err_msg
        );
    }

    // --- 补充覆盖:ban 辅助函数与边界路径 ---

    /// target_to_key_fragment 对所有 BanTarget 变体生成正确的 key 片段。
    #[test]
    fn target_to_key_fragment_all_variants() {
        assert_eq!(
            target_to_key_fragment(&BanTarget::Ip("1.2.3.4".into())),
            "ip:1.2.3.4"
        );
        assert_eq!(
            target_to_key_fragment(&BanTarget::UserId("u123".into())),
            "user:u123"
        );
        assert_eq!(
            target_to_key_fragment(&BanTarget::Mac("AA:BB:CC".into())),
            "mac:AA:BB:CC"
        );
        assert_eq!(
            target_to_key_fragment(&BanTarget::Geo {
                country_code: "CN".into()
            }),
            "geo:CN"
        );
    }

    /// ban_record_key / ban_times_key / ban_history_key 生成正确格式。
    #[test]
    fn ban_key_functions_correct_format() {
        let target = BanTarget::Ip("10.0.0.1".to_string());
        assert_eq!(ban_record_key(&target), "limiteron:ban:ip:10.0.0.1");
        assert_eq!(ban_times_key(&target), "limiteron:ban:times:ip:10.0.0.1");
        assert_eq!(
            ban_history_key(&target),
            "limiteron:ban:history:ip:10.0.0.1"
        );
    }

    /// serialize_ban_record / deserialize_ban_record round-trip 正确。
    #[tokio::test]
    async fn ban_serialize_deserialize_round_trip() {
        let target = BanTarget::UserId("round_trip_user".to_string());
        let original = BanRecord {
            target: target.clone(),
            ban_times: 3,
            duration: Duration::from_secs(900),
            banned_at: Utc::now(),
            expires_at: Utc::now() + chrono::Duration::seconds(3600),
            is_manual: true,
            reason: "test_reason".to_string(),
        };
        let serialized = serialize_ban_record(&original);
        let deserialized = deserialize_ban_record(&target, &serialized);
        assert!(deserialized.is_some(), "反序列化应返回 Some");
        let deserialized = deserialized.unwrap();
        assert_eq!(deserialized.ban_times, 3);
        assert!(deserialized.is_manual);
        assert_eq!(deserialized.reason, "test_reason");
        assert_eq!(deserialized.target, target);
    }

    /// deserialize_ban_record 格式错误(段数不对)返回 None。
    #[test]
    fn ban_deserialize_malformed_data_returns_none() {
        let target = BanTarget::Ip("1.1.1.1".to_string());
        // 只有 2 段(应为 4 段)
        assert!(deserialize_ban_record(&target, "100|5").is_none());
        // 只有 1 段
        assert!(deserialize_ban_record(&target, "100").is_none());
        // 空字符串
        assert!(deserialize_ban_record(&target, "").is_none());
    }

    /// deserialize_ban_record 数字解析失败返回 None。
    #[test]
    fn ban_deserialize_non_numeric_returns_none() {
        let target = BanTarget::Ip("2.2.2.2".to_string());
        // expires_at_ts 不是数字
        assert!(deserialize_ban_record(&target, "not_num|5|true|reason").is_none());
        // ban_times 不是数字
        assert!(deserialize_ban_record(&target, "1000|not_num|true|reason").is_none());
    }

    /// record_duration_from_ban 正确计算 duration。
    #[test]
    fn ban_record_duration_from_ban_correct() {
        let target = BanTarget::Ip("3.3.3.3".to_string());
        assert_eq!(
            record_duration_from_ban(&target, 1),
            Duration::from_secs(300)
        );
        assert_eq!(
            record_duration_from_ban(&target, 3),
            Duration::from_secs(900)
        );
        assert_eq!(record_duration_from_ban(&target, 0), Duration::from_secs(0));
    }

    /// get_history 段数不对时返回错误。
    #[tokio::test]
    async fn ban_get_history_wrong_parts_returns_err() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Ip("9.9.9.9".to_string());
        let key = ban_history_key(&target);
        // 只有 1 段(应为 2 段)
        storage.dao.set(&key, "only_one_segment", 0).await.unwrap();
        let result = storage.get_history(&target).await;
        assert!(result.is_err(), "段数不对应返回错误");
        let err_msg = format!("{}", result.unwrap_err());
        assert!(
            err_msg.contains("limiteron-ban-history-format-error"),
            "错误消息应包含 'limiteron-ban-history-format-error',实际: {}",
            err_msg
        );
    }

    /// get_history last_banned_at_ts 不是数字时返回错误。
    #[tokio::test]
    async fn ban_get_history_non_numeric_ts_returns_err() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Ip("8.8.8.8".to_string());
        let key = ban_history_key(&target);
        // ban_times 正确,但 last_banned_at_ts 不是数字
        storage.dao.set(&key, "3|not_a_number", 0).await.unwrap();
        let result = storage.get_history(&target).await;
        assert!(result.is_err(), "非数字 ts 应返回错误");
    }

    /// get_history ban_times 不是数字时返回错误。
    #[tokio::test]
    async fn ban_get_history_non_numeric_ban_times_returns_err() {
        let storage = GarrisonDaoBanStorage::new(make_dao());
        let target = BanTarget::Mac("AA:BB".to_string());
        let key = ban_history_key(&target);
        storage.dao.set(&key, "not_num|1000", 0).await.unwrap();
        let result = storage.get_history(&target).await;
        assert!(result.is_err(), "非数字 ban_times 应返回错误");
    }
}