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
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
585
586
587
588
589
590
591
592
593
594
595
// Copyright (c) 2026 Kirky.X🌠
// SPDX-License-Identifier: Apache-2.0

//! BackendEmbedded — 进程内认证后端实现。
//!
//! 委托全局 `GarrisonManager` 单例,通过 `with_current_token` 将显式 token 参数
//! 转换为 task_local 上下文,适配 `GarrisonLogicDefault` 的方法签名。
//!
//! 设计要点:零字段 struct(manager 是全局单例,无需持有引用);`check_safe` /
//! `check_disable` 的 bool 适配只映射业务错误(NotSafe / DisableService),会话无效
//! (伪造/过期/被踢)的 `Session` 错误原样透传(fail-closed,不并入 bool)。

use crate::error::{GarrisonError, GarrisonResult};
use crate::manager::GarrisonManager;
use crate::stp::mfa::MfaLogic;
use crate::stp::permission::PermissionLogic;
use crate::stp::session::SessionLogic;
use crate::stp::with_current_token;
use async_trait::async_trait;

use super::types::{LoginParams, SessionData, TokenInfo};
use super::AuthBackend;

/// 进程内认证后端(零字段 struct,委托全局 GarrisonManager 单例)。
///
/// 所有方法经 `GarrisonManager::logic()` 获取 `GarrisonLogicDefault`,再委托到
/// 对应的子 trait 方法。
pub struct BackendEmbedded;

impl BackendEmbedded {
    /// 创建 BackendEmbedded 实例。
    ///
    /// GarrisonManager 必须已通过 `builder().build().await` 初始化,否则所有方法
    /// 调用返回 `GarrisonError::Session`。
    pub fn new() -> Self {
        Self
    }
}

impl Default for BackendEmbedded {
    fn default() -> Self {
        Self::new()
    }
}

#[async_trait]
impl AuthBackend for BackendEmbedded {
    #[tracing::instrument(skip_all, fields(login_id = %login_id))]
    async fn login(&self, login_id: &str, params: &LoginParams) -> GarrisonResult<String> {
        let logic = GarrisonManager::logic()?;
        logic.login(login_id, params).await
    }

    #[tracing::instrument(skip_all)]
    async fn logout(&self, token: &str) -> GarrisonResult<()> {
        let logic = GarrisonManager::logic()?;
        with_current_token(token.to_string(), async { logic.logout().await }).await
    }

    #[tracing::instrument(skip_all)]
    async fn check_login(&self, token: &str) -> GarrisonResult<bool> {
        let logic = GarrisonManager::logic()?;
        with_current_token(token.to_string(), async { logic.check_login().await }).await
    }

    async fn check_permission(&self, token: &str, permission: &str) -> GarrisonResult<()> {
        let logic = GarrisonManager::logic()?;
        let perm = permission.to_string();
        with_current_token(token.to_string(), async move {
            logic.check_permission(&perm).await
        })
        .await
    }

    async fn check_role(&self, token: &str, role: &str) -> GarrisonResult<()> {
        let logic = GarrisonManager::logic()?;
        let role = role.to_string();
        with_current_token(
            token.to_string(),
            async move { logic.check_role(&role).await },
        )
        .await
    }

    async fn check_safe(&self, token: &str) -> GarrisonResult<bool> {
        let logic = GarrisonManager::logic()?;
        with_current_token(token.to_string(), async {
            // 仅 NotSafe 是「未通过二级认证」的业务 false;会话无效等错误原样透传
            match logic.check_safe().await {
                Ok(()) => Ok(true),
                Err(GarrisonError::NotSafe { .. }) => Ok(false),
                Err(e) => Err(e),
            }
        })
        .await
    }

    async fn check_disable(&self, token: &str) -> GarrisonResult<bool> {
        let logic = GarrisonManager::logic()?;
        with_current_token(token.to_string(), async {
            // 仅 DisableService 是「已封禁」的业务 true;会话无效等错误原样透传
            match logic.check_disable().await {
                Ok(()) => Ok(false),
                Err(GarrisonError::DisableService { .. }) => Ok(true),
                Err(e) => Err(e),
            }
        })
        .await
    }

    async fn check_api_key(&self, api_key: &str, namespace: &str) -> GarrisonResult<()> {
        let logic = GarrisonManager::logic()?;
        let ns = namespace.to_string();
        with_current_token(api_key.to_string(), async move {
            logic.check_api_key(&ns).await
        })
        .await
    }

    async fn get_token_info(&self, token: &str) -> GarrisonResult<TokenInfo> {
        let logic = GarrisonManager::logic()?;
        let ts = logic
            .session
            .get_token_session(token)
            .await?
            .ok_or_else(|| {
                GarrisonError::InvalidToken("backend-token-invalid-or-expired::".to_string())
            })?;
        Ok(TokenInfo {
            token: ts.token,
            created_at: ts.created_at,
            last_active_at: ts.last_active_at,
        })
    }

    async fn get_session(&self, token: &str) -> GarrisonResult<SessionData> {
        let logic = GarrisonManager::logic()?;
        logic
            .session
            .get_token_session(token)
            .await?
            .ok_or_else(|| {
                GarrisonError::InvalidToken("backend-token-invalid-or-expired::".to_string())
            })
    }

    async fn kickout(&self, login_id: &str) -> GarrisonResult<()> {
        let logic = GarrisonManager::logic()?;
        logic.kickout(login_id).await
    }

    async fn switch_to(&self, token: &str, target_login_id: &str) -> GarrisonResult<()> {
        let logic = GarrisonManager::logic()?;
        let auth_logic = logic.auth_logic.as_ref().ok_or_else(|| {
            GarrisonError::NotImplemented("backend-auth-logic-not-injected::".to_string())
        })?;
        auth_logic.switch_to(token, target_login_id).await
    }

    #[tracing::instrument(skip_all)]
    async fn renew_to_equivalent(&self, token: &str) -> GarrisonResult<String> {
        let logic = GarrisonManager::logic()?;
        let auth_logic = logic.auth_logic.as_ref().ok_or_else(|| {
            GarrisonError::NotImplemented("backend-auth-logic-not-injected-renew::".to_string())
        })?;
        auth_logic.renew_to_equivalent(token).await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::GarrisonConfig;
    use crate::dao::GarrisonDao;
    use crate::stp::mock::{MockDao, MockInterface};
    use crate::stp::GarrisonInterface;
    use serial_test::serial;
    use std::sync::Arc;

    /// 初始化全局 GarrisonManager,返回 BackendEmbedded 实例。
    async fn setup_backend() -> BackendEmbedded {
        GarrisonManager::reset_for_test();
        let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
        let mut config = GarrisonConfig::default_config();
        config.timeout = 3600;
        config.active_timeout = -1;
        config.throw_on_not_login = false;
        let interface: Arc<dyn GarrisonInterface> = Arc::new(MockInterface);
        GarrisonManager::builder()
            .dao(dao)
            .config(Arc::new(config))
            .interface(interface)
            .build()
            .await
            .unwrap();
        BackendEmbedded::new()
    }

    #[tokio::test]
    #[serial]
    async fn test_login_returns_token() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        assert!(!token.is_empty());
    }

    #[tokio::test]
    #[serial]
    async fn test_check_login_valid_token() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        assert!(backend.check_login(&token).await.unwrap());
    }

    #[tokio::test]
    #[serial]
    async fn test_check_login_invalid_token() {
        let backend = setup_backend().await;
        assert!(!backend.check_login("invalid-token").await.unwrap());
    }

    #[tokio::test]
    #[serial]
    async fn test_logout_invalidates_token() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        backend.logout(&token).await.unwrap();
        assert!(!backend.check_login(&token).await.unwrap());
    }

    #[tokio::test]
    #[serial]
    async fn test_kickout_invalidates_all_sessions() {
        let backend = setup_backend().await;
        let t1 = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        let t2 = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        backend.kickout("user1").await.unwrap();
        assert!(!backend.check_login(&t1).await.unwrap());
        assert!(!backend.check_login(&t2).await.unwrap());
    }

    #[tokio::test]
    #[serial]
    async fn test_get_token_info() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        let info = backend.get_token_info(&token).await.unwrap();
        assert_eq!(info.token, token);
        assert!(info.created_at > 0);
        assert!(info.last_active_at >= info.created_at);
    }

    #[tokio::test]
    #[serial]
    async fn test_get_token_info_invalid_token() {
        let backend = setup_backend().await;
        let result = backend.get_token_info("invalid").await;
        assert!(result.is_err());
        match result.unwrap_err() {
            GarrisonError::InvalidToken(_) => {},
            e => panic!("期望 InvalidToken,实际: {:?}", e),
        }
    }

    #[tokio::test]
    #[serial]
    async fn test_get_session() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        let session = backend.get_session(&token).await.unwrap();
        assert_eq!(session.token, token);
        assert_eq!(session.login_id, "user1");
    }

    #[tokio::test]
    #[serial]
    async fn test_get_session_invalid_token() {
        let backend = setup_backend().await;
        let result = backend.get_session("invalid").await;
        assert!(result.is_err());
    }

    #[cfg(feature = "security-extra")]
    #[tokio::test]
    #[serial]
    async fn test_check_safe_default_returns_false() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        // safe-auth feature 下,新用户未通过二级认证(safe_services 为空),check_safe 返回 false
        assert!(!backend.check_safe(&token).await.unwrap());
    }

    #[tokio::test]
    #[serial]
    async fn test_check_disable_default_returns_false() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        // 默认未注入 disable_repository,check_disable 返回 false
        assert!(!backend.check_disable(&token).await.unwrap());
    }

    // 会话前置校验回归:无效 token 显性拒绝,不再宽松 bool

    /// `check_safe` 伪造 token → 显性 `Err(Session)`,不再恒返回 true。
    #[tokio::test]
    #[serial]
    async fn test_check_safe_forged_token_returns_session_error() {
        let backend = setup_backend().await;
        let result = backend
            .check_safe("00000000-0000-0000-0000-000000000000")
            .await;
        assert!(
            matches!(result, Err(GarrisonError::Session(_))),
            "伪造 token 的 check_safe 应返回 Err(Session),实际: {:?}",
            result
        );
    }

    /// `check_safe` kickout 后旧 token → 显性 `Err(Session)`(已撤销会话不再放行)。
    #[tokio::test]
    #[serial]
    async fn test_check_safe_kicked_out_token_returns_session_error() {
        let backend = setup_backend().await;
        let token = backend
            .login("safe-kick-user", &LoginParams::default())
            .await
            .unwrap();
        backend.kickout("safe-kick-user").await.unwrap();

        let result = backend.check_safe(&token).await;
        assert!(
            matches!(result, Err(GarrisonError::Session(_))),
            "kickout 后旧 token 的 check_safe 应返回 Err(Session),实际: {:?}",
            result
        );
    }

    /// `check_disable` 伪造 token → 显性 `Err(Session)` 而非 `Ok(false)`(「token
    /// 无效」不再与「未封禁」合并为同一 bool)。
    #[tokio::test]
    #[serial]
    async fn test_check_disable_forged_token_returns_session_error() {
        let backend = setup_backend().await;
        let result = backend
            .check_disable("00000000-0000-0000-0000-000000000000")
            .await;
        assert!(
            matches!(result, Err(GarrisonError::Session(_))),
            "伪造 token 的 check_disable 应返回 Err(Session),实际: {:?}",
            result
        );
    }

    /// `check_disable` kickout 后旧 token → 显性 `Err(Session)` 而非 `Ok(false)`。
    #[tokio::test]
    #[serial]
    async fn test_check_disable_kicked_out_token_returns_session_error() {
        let backend = setup_backend().await;
        let token = backend
            .login("disable-kick-user", &LoginParams::default())
            .await
            .unwrap();
        backend.kickout("disable-kick-user").await.unwrap();

        let result = backend.check_disable(&token).await;
        assert!(
            matches!(result, Err(GarrisonError::Session(_))),
            "kickout 后旧 token 的 check_disable 应返回 Err(Session),实际: {:?}",
            result
        );
    }

    #[tokio::test]
    #[serial]
    async fn test_switch_to_default_guard_denies() {
        let backend = setup_backend().await;
        let token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        // 需预先创建 target Account-Session,否则 target_account_exists 校验先返回 InvalidParam
        let _ = backend
            .login("user2", &LoginParams::default())
            .await
            .unwrap();
        // 默认 DenyAllSwitchToGuard 拒绝所有切换(安全默认)
        let result = backend.switch_to(&token, "user2").await;
        assert!(result.is_err());
        match result.unwrap_err() {
            GarrisonError::NotPermission(_) => {},
            e => panic!("期望 NotPermission,实际: {:?}", e),
        }
    }

    #[tokio::test]
    #[serial]
    async fn test_renew_to_equivalent_returns_new_token() {
        let backend = setup_backend().await;
        let old_token = backend
            .login("user1", &LoginParams::default())
            .await
            .unwrap();
        let new_token = backend.renew_to_equivalent(&old_token).await.unwrap();
        assert_ne!(old_token, new_token);
        assert!(!backend.check_login(&old_token).await.unwrap());
        assert!(backend.check_login(&new_token).await.unwrap());
    }

    #[tokio::test]
    #[serial]
    async fn test_check_permission_invalid_token() {
        let backend = setup_backend().await;
        let result = backend.check_permission("invalid", "user:read").await;
        assert!(result.is_err());
    }

    #[tokio::test]
    #[serial]
    async fn test_dyn_dispatch_with_backend_embedded() {
        let backend: Arc<dyn AuthBackend> = Arc::new(setup_backend().await);
        let token = backend
            .login("dyn-user", &LoginParams::default())
            .await
            .unwrap();
        assert!(backend.check_login(&token).await.unwrap());
    }

    // Tracing #[instrument] span 覆盖验证

    use std::sync::Mutex;
    use tracing::span::Attributes;
    use tracing::{Id, Metadata, Subscriber};

    /// 轻量测试 subscriber:记录所有被创建的 span 名称,用于断言
    /// 目标函数(login/logout/check_login/renew_to_equivalent)是否创建了 span。
    #[derive(Default)]
    struct SpanNameCollector {
        names: Arc<Mutex<Vec<&'static str>>>,
    }

    impl Subscriber for SpanNameCollector {
        fn enabled(&self, _metadata: &Metadata<'_>) -> bool {
            true
        }

        fn new_span(&self, span: &Attributes<'_>) -> Id {
            self.names.lock().unwrap().push(span.metadata().name());
            Id::from_u64(1)
        }

        fn record(&self, _span: &Id, _values: &tracing::span::Record<'_>) {}
        fn record_follows_from(&self, _span: &Id, _follows: &Id) {}
        fn event(&self, _event: &tracing::Event<'_>) {}
        fn enter(&self, _span: &Id) {}
        fn exit(&self, _span: &Id) {}
    }

    #[tokio::test(flavor = "current_thread")]
    #[serial]
    async fn test_login_creates_tracing_span() {
        let backend = setup_backend().await;
        let names = Arc::new(Mutex::new(Vec::new()));
        let _guard = tracing::subscriber::set_default(SpanNameCollector {
            names: names.clone(),
        });
        let _ = backend.login("span-user", &LoginParams::default()).await;
        assert!(
            names.lock().unwrap().contains(&"login"),
            "login 应创建名为 'login' 的 tracing span,实际捕获: {:?}",
            names.lock().unwrap()
        );
    }

    #[tokio::test(flavor = "current_thread")]
    #[serial]
    async fn test_logout_creates_tracing_span() {
        let backend = setup_backend().await;
        let token = backend
            .login("span-user", &LoginParams::default())
            .await
            .unwrap();
        let names = Arc::new(Mutex::new(Vec::new()));
        let _guard = tracing::subscriber::set_default(SpanNameCollector {
            names: names.clone(),
        });
        let _ = backend.logout(&token).await;
        assert!(
            names.lock().unwrap().contains(&"logout"),
            "logout 应创建名为 'logout' 的 tracing span,实际捕获: {:?}",
            names.lock().unwrap()
        );
    }

    #[tokio::test(flavor = "current_thread")]
    #[serial]
    async fn test_check_login_creates_tracing_span() {
        let backend = setup_backend().await;
        let token = backend
            .login("span-user", &LoginParams::default())
            .await
            .unwrap();
        let names = Arc::new(Mutex::new(Vec::new()));
        let _guard = tracing::subscriber::set_default(SpanNameCollector {
            names: names.clone(),
        });
        let _ = backend.check_login(&token).await;
        assert!(
            names.lock().unwrap().contains(&"check_login"),
            "check_login 应创建名为 'check_login' 的 tracing span,实际捕获: {:?}",
            names.lock().unwrap()
        );
    }

    // 覆盖率补充:Default + check_role/check_safe/check_api_key

    /// `BackendEmbedded::default()` 返回新实例。
    #[test]
    fn backend_embedded_default_returns_instance() {
        let _backend = BackendEmbedded;
    }

    /// `check_role` 无效 token 返回错误。
    #[tokio::test]
    #[serial]
    async fn test_check_role_invalid_token() {
        let backend = setup_backend().await;
        let result = backend.check_role("invalid-token", "admin").await;
        assert!(result.is_err());
    }

    /// `check_safe` 无 security-extra feature 时默认通过(无 safe service 配置)。
    #[tokio::test]
    #[serial]
    async fn test_check_safe_no_security_extra_returns_true() {
        let backend = setup_backend().await;
        let token = backend
            .login("safe-user", &LoginParams::default())
            .await
            .unwrap();
        // 无 security-extra feature 时 check_safe 默认返回 Ok(true)
        let result = backend.check_safe(&token).await;
        assert!(result.is_ok(), "check_safe 应成功: {:?}", result);
    }

    /// `check_api_key` 无效 key 返回错误。
    #[tokio::test]
    #[serial]
    async fn test_check_api_key_invalid() {
        let backend = setup_backend().await;
        let result = backend.check_api_key("invalid-key", "default").await;
        assert!(result.is_err());
    }

    /// 触发 `SpanNameCollector::record` 和 `record_follows_from`。
    #[tokio::test(flavor = "current_thread")]
    #[serial]
    async fn test_span_name_collector_record_and_follows() {
        let backend = setup_backend().await;
        let names = Arc::new(Mutex::new(Vec::new()));
        let _guard = tracing::subscriber::set_default(SpanNameCollector {
            names: names.clone(),
        });
        // 触发 record(span 创建时有 field 值)
        let _ = backend.login("record-user", &LoginParams::default()).await;
        // 触发 record_follows_from(span 关系)
        tracing::info!("test event to trigger record");
    }
}