garrison 0.9.0

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
//! 设备管理模块:设备会话管理与设备指纹生成。
use crate::error::GarrisonResult;
use crate::session::GarrisonSession;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use std::sync::Arc;

/// 设备会话信息(由 [`DeviceManager::list_devices`] 返回的活跃会话设备信息)。
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeviceSession {
    /// 设备标识(如 "web"/"ios"/"android" 或自动生成的指纹)。
    pub device: String,
    /// 关联的登录主体标识。
    pub login_id: String,
    /// 会话 token。
    pub token: String,
    /// 客户端 IP 地址。
    pub ip: Option<String>,
    /// 客户端 User-Agent。
    pub user_agent: Option<String>,
    /// 最后活跃时间戳(Unix 秒)。
    pub last_active_at: i64,
}

/// 设备管理器:持有 [`GarrisonSession`] 引用,经 `login_token_map` 和 `TokenSession` 实现设备管理。
pub struct DeviceManager {
    /// 会话管理器引用。
    session: Arc<GarrisonSession>,
}

impl DeviceManager {
    /// 创建设备管理器实例。
    pub fn new(session: Arc<GarrisonSession>) -> Self {
        Self { session }
    }

    /// 列出指定 login_id 的所有设备会话。
    ///
    /// 遍历 `login_token_map` 查询每个 TokenSession 并映射为 [`DeviceSession`],已过期或不存在 token 跳过;无会话返回空 Vec。
    pub async fn list_devices(&self, login_id: &str) -> GarrisonResult<Vec<DeviceSession>> {
        let tokens = self.session.get_tokens_by_login_id(login_id);
        let mut devices = Vec::with_capacity(tokens.len());
        for token in tokens {
            if let Some(ts) = self.session.get_token_session(&token).await? {
                devices.push(DeviceSession {
                    device: ts.device.unwrap_or_default(),
                    login_id: ts.login_id,
                    token: ts.token,
                    ip: ts.ip,
                    user_agent: ts.user_agent,
                    last_active_at: ts.last_active_at,
                });
            }
        }
        Ok(devices)
    }

    /// 踢出指定设备的会话:委托 [`GarrisonSession::kickout_by_device`],踢出指定 login_id 中 `device` 字段匹配的所有 TokenSession。
    pub async fn kickout_device(&self, login_id: &str, device: &str) -> GarrisonResult<()> {
        self.session.kickout_by_device(login_id, device).await
    }
}

/// 生成设备指纹:SHA-256(UA `\x1f` IP),截断 16 字节 hex = 32 字符。
///
/// UA 与 IP 以 `\x1f`(Unit Separator)分隔后哈希,消除维度拼接歧义(无分隔符时 `ua="ab"+ip="c"` 与
/// `ua="a"+ip="bc"` 哈希相同,可伪造同指纹);生产登录路径默认使用 [`device_fingerprint_rich`](多维度指纹)。
pub fn device_fingerprint(user_agent: &str, ip: &str) -> String {
    let mut hasher = Sha256::new();
    hasher.update(user_agent.as_bytes());
    // \x1f 分隔符防止维度拼接歧义(与 device_fingerprint_rich 对齐)
    hasher.update([0x1f]);
    hasher.update(ip.as_bytes());
    let result = hasher.finalize();
    hex_prefix_16(&result)
}

/// 设备指纹输入维度(A10 强化:防止攻击者仅伪造部分 header 即可复用指纹)。
///
/// `accept_language` / `sec_ch_ua` / `sec_ch_ua_platform` 未提供时以哨兵字节 `\0` 参与 hash,与 `Some("")`
/// 区分(fail-safe:缺失维度不等于空串维度,防止省略 header 绕过维度校验)。
#[derive(Debug, Clone, Copy)]
pub struct DeviceFingerprintInput<'a> {
    /// 客户端 User-Agent。
    pub user_agent: &'a str,
    /// 客户端 IP 地址。
    pub ip: &'a str,
    /// Accept-Language header(如 "zh-CN,zh;q=0.9,en;q=0.8")。
    pub accept_language: Option<&'a str>,
    /// sec-ch-ua header(如 `"Chromium";v="120", "Not.A/Brand";v="24"`)。
    pub sec_ch_ua: Option<&'a str>,
    /// sec-ch-ua-platform header(如 `"Windows"`)。
    pub sec_ch_ua_platform: Option<&'a str>,
}

impl<'a> DeviceFingerprintInput<'a> {
    /// 创建包含全部维度的输入。
    pub fn new(
        user_agent: &'a str,
        ip: &'a str,
        accept_language: Option<&'a str>,
        sec_ch_ua: Option<&'a str>,
        sec_ch_ua_platform: Option<&'a str>,
    ) -> Self {
        Self {
            user_agent,
            ip,
            accept_language,
            sec_ch_ua,
            sec_ch_ua_platform,
        }
    }

    /// 仅从 ua + ip 构造(其他维度为 `None`,对应 [`device_fingerprint`] 的二维输入)。
    pub fn from_ua_ip(user_agent: &'a str, ip: &'a str) -> Self {
        Self {
            user_agent,
            ip,
            accept_language: None,
            sec_ch_ua: None,
            sec_ch_ua_platform: None,
        }
    }
}

/// 将哈希结果的前 16 字节编码为 32 字符小写 hex(查找表 + push,避免逐字节 `format!` 的临时分配)。
fn hex_prefix_16(hash: &[u8]) -> String {
    const HEX: &[u8; 16] = b"0123456789abcdef";
    let mut out = String::with_capacity(32);
    for b in hash.iter().take(16) {
        out.push(HEX[(b >> 4) as usize] as char);
        out.push(HEX[(b & 0x0f) as usize] as char);
    }
    out
}

/// 生成强化设备指纹:SHA-256(ua | ip | accept_language | sec_ch_ua | sec_ch_ua_platform),截断 16 字节 hex = 32 字符。
///
/// 各维度以 `\x1f`(Unit Separator)分隔,防止维度拼接歧义;攻击者仅伪造 UA 或 IP 无法复用指纹,必须同时匹配全部维度。
pub fn device_fingerprint_rich(input: &DeviceFingerprintInput<'_>) -> String {
    let mut hasher = Sha256::new();
    const SEP: u8 = 0x1f;
    hasher.update(input.user_agent.as_bytes());
    hasher.update([SEP]);
    hasher.update(input.ip.as_bytes());
    hasher.update([SEP]);
    match input.accept_language {
        Some(v) => hasher.update(v.as_bytes()),
        None => hasher.update([0x00]),
    }
    hasher.update([SEP]);
    match input.sec_ch_ua {
        Some(v) => hasher.update(v.as_bytes()),
        None => hasher.update([0x00]),
    }
    hasher.update([SEP]);
    match input.sec_ch_ua_platform {
        Some(v) => hasher.update(v.as_bytes()),
        None => hasher.update([0x00]),
    }
    let result = hasher.finalize();
    hex_prefix_16(&result)
}

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

    #[test]
    fn device_fingerprint_deterministic() {
        let fp1 = device_fingerprint("Mozilla/5.0 Chrome", "192.168.1.1");
        let fp2 = device_fingerprint("Mozilla/5.0 Chrome", "192.168.1.1");
        assert_eq!(fp1, fp2, "相同输入应生成相同指纹");
    }

    #[test]
    fn device_fingerprint_different_inputs_different_output() {
        let fp1 = device_fingerprint("Mozilla/5.0 Chrome", "192.168.1.1");
        let fp2 = device_fingerprint("Mozilla/5.0 Firefox", "192.168.1.1");
        assert_ne!(fp1, fp2, "不同 UA 应生成不同指纹");

        let fp3 = device_fingerprint("Mozilla/5.0 Chrome", "10.0.0.1");
        assert_ne!(fp1, fp3, "不同 IP 应生成不同指纹");
    }

    #[test]
    fn device_fingerprint_length_is_32() {
        let fp = device_fingerprint("TestAgent", "127.0.0.1");
        assert_eq!(fp.len(), 32, "指纹应为 32 字符(16 字节 hex)");
    }

    /// 指纹分隔符:ua="ab"+ip="c" 与 ua="a"+ip="bc" 应产生不同指纹(验证 `\x1f` 分隔符消除维度拼接歧义)。
    #[test]
    fn device_fingerprint_delimiter_prevents_concat_ambiguity() {
        let fp1 = device_fingerprint("ab", "c");
        let fp2 = device_fingerprint("a", "bc");
        assert_ne!(fp1, fp2, "分隔符应防止指纹的维度拼接歧义");
    }

    #[test]
    fn a10_rich_fingerprint_deterministic() {
        let input = DeviceFingerprintInput::new(
            "Mozilla/5.0 Chrome",
            "192.168.1.1",
            Some("zh-CN,zh;q=0.9"),
            Some("\"Chromium\";v=\"120\""),
            Some("\"Windows\""),
        );
        let fp1 = device_fingerprint_rich(&input);
        let fp2 = device_fingerprint_rich(&input);
        assert_eq!(fp1, fp2, "相同输入应生成相同指纹");
    }

    #[test]
    fn a10_rich_fingerprint_length_is_32() {
        let input = DeviceFingerprintInput::new("UA", "IP", None, None, None);
        let fp = device_fingerprint_rich(&input);
        assert_eq!(fp.len(), 32, "强化指纹应为 32 字符(16 字节 hex)");
    }

    /// A10 核心:伪造任意单一维度仍触发指纹变化(防止部分 header 伪造绕过)。
    #[test]
    fn a10_rich_fingerprint_spoofing_partial_dimensions_detected() {
        let base = DeviceFingerprintInput::new(
            "Mozilla/5.0 Chrome",
            "192.168.1.1",
            Some("zh-CN,zh;q=0.9"),
            Some("\"Chromium\";v=\"120\""),
            Some("\"Windows\""),
        );
        let base_fp = device_fingerprint_rich(&base);

        // 仅伪造 UA
        let spoof_ua = DeviceFingerprintInput::new(
            "Mozilla/5.0 Firefox",
            "192.168.1.1",
            Some("zh-CN,zh;q=0.9"),
            Some("\"Chromium\";v=\"120\""),
            Some("\"Windows\""),
        );
        assert_ne!(
            device_fingerprint_rich(&spoof_ua),
            base_fp,
            "伪造 UA 应改变指纹"
        );

        // 仅伪造 IP
        let spoof_ip = DeviceFingerprintInput::new(
            "Mozilla/5.0 Chrome",
            "10.0.0.1",
            Some("zh-CN,zh;q=0.9"),
            Some("\"Chromium\";v=\"120\""),
            Some("\"Windows\""),
        );
        assert_ne!(
            device_fingerprint_rich(&spoof_ip),
            base_fp,
            "伪造 IP 应改变指纹"
        );

        // 仅伪造 Accept-Language
        let spoof_al = DeviceFingerprintInput::new(
            "Mozilla/5.0 Chrome",
            "192.168.1.1",
            Some("en-US,en;q=0.9"),
            Some("\"Chromium\";v=\"120\""),
            Some("\"Windows\""),
        );
        assert_ne!(
            device_fingerprint_rich(&spoof_al),
            base_fp,
            "伪造 Accept-Language 应改变指纹"
        );

        // 仅伪造 sec-ch-ua
        let spoof_chua = DeviceFingerprintInput::new(
            "Mozilla/5.0 Chrome",
            "192.168.1.1",
            Some("zh-CN,zh;q=0.9"),
            Some("\"Firefox\";v=\"121\""),
            Some("\"Windows\""),
        );
        assert_ne!(
            device_fingerprint_rich(&spoof_chua),
            base_fp,
            "伪造 sec-ch-ua 应改变指纹"
        );

        // 仅伪造 sec-ch-ua-platform
        let spoof_plat = DeviceFingerprintInput::new(
            "Mozilla/5.0 Chrome",
            "192.168.1.1",
            Some("zh-CN,zh;q=0.9"),
            Some("\"Chromium\";v=\"120\""),
            Some("\"macOS\""),
        );
        assert_ne!(
            device_fingerprint_rich(&spoof_plat),
            base_fp,
            "伪造 sec-ch-ua-platform 应改变指纹"
        );
    }

    /// A10: None 与 Some("") 应产生不同指纹(防止攻击者用空串绕过 None 维度)。
    #[test]
    fn a10_rich_fingerprint_none_vs_some_empty_differ() {
        let with_none = DeviceFingerprintInput::new("UA", "IP", None, None, None);
        let with_empty = DeviceFingerprintInput::new("UA", "IP", Some(""), Some(""), Some(""));
        assert_ne!(
            device_fingerprint_rich(&with_none),
            device_fingerprint_rich(&with_empty),
            "None 与 Some(\"\") 应产生不同指纹(哨兵字节区分)"
        );
    }

    /// A10: from_ua_ip 构造等价于显式 None 构造。
    #[test]
    fn a10_rich_fingerprint_from_ua_ip_equivalent_to_none() {
        let input1 = DeviceFingerprintInput::from_ua_ip("UA", "IP");
        let input2 = DeviceFingerprintInput::new("UA", "IP", None, None, None);
        assert_eq!(
            device_fingerprint_rich(&input1),
            device_fingerprint_rich(&input2),
            "from_ua_ip 应等价于显式 None 构造"
        );
    }

    /// A10: 维度拼接歧义防护(ua="ab"+ip="c" 与 ua="a"+ip="bc" 应产生不同指纹)。
    #[test]
    fn a10_rich_fingerprint_delimiter_prevents_concat_ambiguity() {
        let ambiguous1 = DeviceFingerprintInput::from_ua_ip("ab", "c");
        let ambiguous2 = DeviceFingerprintInput::from_ua_ip("a", "bc");
        assert_ne!(
            device_fingerprint_rich(&ambiguous1),
            device_fingerprint_rich(&ambiguous2),
            "分隔符应防止维度拼接歧义"
        );
    }

    /// 辅助函数:创建带 MockDao 的 Arc<GarrisonSession>(供 DeviceManager 使用)。
    fn make_device_session(timeout: u64, active_timeout: u64) -> Arc<GarrisonSession> {
        use crate::dao::tests::MockDao;
        let dao: Arc<dyn crate::dao::GarrisonDao> = Arc::new(MockDao::new());
        Arc::new(GarrisonSession::new(dao, timeout, active_timeout, 0))
    }

    /// 验证 list_devices 返回指定 login_id 的所有活跃设备会话。
    #[tokio::test]
    async fn list_devices_returns_all_active_sessions() {
        let session = make_device_session(3600, 86400);

        session.create("user-001", "token-1").await.unwrap();
        session.create("user-001", "token-2").await.unwrap();

        let mgr = DeviceManager::new(session);
        let devices = mgr.list_devices("user-001").await.unwrap();
        assert_eq!(devices.len(), 2, "应有 2 个设备会话");

        for d in &devices {
            assert_eq!(d.login_id, "user-001");
            assert!(!d.token.is_empty());
        }
    }

    /// 验证 list_devices 在无会话时返回空列表。
    #[tokio::test]
    async fn list_devices_empty_when_no_sessions() {
        let session = make_device_session(3600, 86400);

        let mgr = DeviceManager::new(session);
        let devices = mgr.list_devices("nonexistent-user").await.unwrap();
        assert!(devices.is_empty(), "无会话时应返回空列表");
    }

    /// 验证 kickout_device 踢出 device 匹配的会话,保留不匹配的会话。
    #[tokio::test]
    async fn kickout_device_removes_matching_session() {
        let session = make_device_session(3600, 86400);

        // 创建带 device="web" 的会话
        let params = crate::stp::LoginParams {
            device: Some("web".to_string()),
            ..Default::default()
        };
        session
            .create_token_session("user-kickout-001", "token-with-device", &params)
            .await
            .unwrap();

        // 创建不带 device 的会话
        session
            .create("user-kickout-001", "token-no-device")
            .await
            .unwrap();

        let mgr = DeviceManager::new(session.clone());
        let result = mgr.kickout_device("user-kickout-001", "web").await;
        assert!(result.is_ok(), "kickout_device 应成功");

        // 带 device="web" 的会话应被踢出
        let removed = session
            .get_token_session("token-with-device")
            .await
            .unwrap();
        assert!(removed.is_none(), "device 匹配的会话应被踢出");

        // 不带 device 的会话应保留
        let kept = session.get_token_session("token-no-device").await.unwrap();
        assert!(kept.is_some(), "device 不匹配的会话应保留");
    }
}