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
// Copyright (c) 2026 Kirky.X🌠
// SPDX-License-Identifier: Apache-2.0

//! `SsoClient` 单元测试。

use super::mock::MockDao;
use super::*;
use crate::error::GarrisonError;

/// 创建 SsoClient 实例(使用 MockDao + 测试用 secret)。
fn make_client() -> SsoClient {
    let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
    SsoClient::new(dao, "test-sso-secret-key-for-unit-tests-01").expect("secret 非空构造应成功")
}

// SsoClient 构造测试

/// 构造 SsoClient(持有 dao)。
#[test]
fn new_creates_client_with_dao() {
    let _client = make_client();
    // 构造成功即验证(dao 通过类型系统保证非空)
}

// issue_ticket 测试

/// 成功签发票据,格式为 `{64_hex_random}.{hmac_b64}`。
#[tokio::test]
async fn issue_ticket_returns_signed_format() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let (random_part, sig) = ticket.split_once('.').expect("ticket 应包含 '.' 分隔符");
    assert_eq!(random_part.len(), 64, "随机部分应为 64 字符 hex");
    assert!(
        random_part.chars().all(|c| c.is_ascii_hexdigit()),
        "随机部分应全为 hex 字符"
    );
    assert!(!sig.is_empty(), "签名部分不应为空");
}

/// 票据随机性:连续签发返回不同票据。
#[tokio::test]
async fn issue_ticket_generates_unique_tickets() {
    let client = make_client();
    let t1 = client.issue_ticket("1001", 2001).await.unwrap();
    let t2 = client.issue_ticket("1001", 2001).await.unwrap();
    assert_ne!(t1, t2);
}

/// 相同 login_id 多 client 签发独立票据。
#[tokio::test]
async fn issue_ticket_same_login_different_clients() {
    let client = make_client();
    let t1 = client.issue_ticket("1001", 2001).await.unwrap();
    let t2 = client.issue_ticket("1001", 2002).await.unwrap();
    assert_ne!(t1, t2);
}

/// key 前缀正确。
#[tokio::test]
async fn issue_ticket_uses_correct_key_prefix() {
    let dao = Arc::new(MockDao::new());
    let client = SsoClient::new(dao.clone(), "test-sso-secret-key-for-unit-tests-01")
        .expect("secret 非空构造应成功");
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let key = format!("garrison:sso:ticket:{}", ticket);
    let value = dao.get(&key).await.unwrap();
    assert!(value.is_some());
    let data: SsoTicketData = serde_json::from_str(&value.unwrap()).unwrap();
    assert_eq!(data.login_id, "1001");
    assert_eq!(data.client_id, 2001);
}

// validate_ticket 测试

/// 成功校验返回 login_id。
#[tokio::test]
async fn validate_ticket_success_returns_login_id() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let login_id = client.validate_ticket(&ticket, 2001).await.unwrap();
    assert_eq!(login_id, "1001");
}

/// 校验成功后票据被删除(一次性使用)。
#[tokio::test]
async fn validate_ticket_deletes_after_success() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let _ = client.validate_ticket(&ticket, 2001).await.unwrap();
    let result = client.validate_ticket(&ticket, 2001).await;
    assert!(
        matches!(result, Err(GarrisonError::InvalidToken(_))),
        "第二次校验应返回 InvalidToken,实际: {:?}",
        result
    );
}

/// client_id 不匹配返回 InvalidToken 错误。
#[tokio::test]
async fn validate_ticket_client_id_mismatch_returns_error() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let result = client.validate_ticket(&ticket, 9999).await;
    assert!(result.is_err());
    match result.err() {
        Some(GarrisonError::InvalidToken(_)) => {},
        other => panic!("期望 InvalidToken 错误,实际: {:?}", other),
    }
}

/// 票据不存在返回错误。
#[tokio::test]
async fn validate_ticket_nonexistent_returns_error() {
    let client = make_client();
    let result = client.validate_ticket("nonexistent-ticket", 2001).await;
    assert!(result.is_err());
    match result.err() {
        Some(GarrisonError::InvalidToken(_)) => {},
        other => panic!("期望 InvalidToken 错误,实际: {:?}", other),
    }
}

/// 一次性使用:第二次校验失败。
#[tokio::test]
async fn validate_ticket_one_time_use_second_fails() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let first = client.validate_ticket(&ticket, 2001).await;
    let second = client.validate_ticket(&ticket, 2001).await;
    assert_eq!(first.unwrap(), "1001", "第一次校验应返回 login_id");
    assert!(
        matches!(second, Err(GarrisonError::InvalidToken(_))),
        "第二次校验应返回 InvalidToken,实际: {:?}",
        second
    );
}

// destroy_ticket 测试

/// 销毁存在的票据。
#[tokio::test]
async fn destroy_ticket_existing() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let result = client.destroy_ticket(&ticket).await;
    assert_eq!(result.unwrap(), (), "销毁存在的票据应返回 Ok(())");
    let validate_result = client.validate_ticket(&ticket, 2001).await;
    assert!(
        matches!(validate_result, Err(GarrisonError::InvalidToken(_))),
        "已销毁票据 validate 应返回 InvalidToken,实际: {:?}",
        validate_result
    );
}

/// 销毁不存在的票据返回 Ok(幂等)。
#[tokio::test]
async fn destroy_ticket_nonexistent_returns_ok() {
    let client = make_client();
    let result = client.destroy_ticket("nonexistent-ticket").await;
    assert_eq!(result.unwrap(), (), "销毁不存在的票据应返回 Ok(())(幂等)");
}

// with_ticket_ttl 测试

/// with_ticket_ttl 设置 TTL。
#[test]
fn with_ticket_ttl_sets_ttl() {
    let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
    let client = SsoClient::new(dao, "test-sso-secret-key-for-unit-tests-01")
        .expect("secret 非空构造应成功")
        .with_ticket_ttl(120);
    assert_eq!(client.ticket_ttl_seconds, 120);
}

// LoginId newtype 接入(impl Into<LoginId>)

/// 验证 `SsoClient::issue_ticket` 接受 String 形式 login_id。
#[tokio::test]
async fn issue_ticket_accepts_login_id_numeric() {
    let client = make_client();
    let ticket = client.issue_ticket("1001".to_string(), 2001).await.unwrap();
    let login_id = client.validate_ticket(&ticket, 2001).await.unwrap();
    assert_eq!(login_id, "1001");
}

// TOCTOU 修复测试

/// 并发消费同一 ticket 仅一个成功(TOCTOU 修复核心验证)。
///
/// 10 个并发任务同时 validate_ticket,仅一个返回 Ok,其他返回 InvalidToken。
#[tokio::test(flavor = "multi_thread")]
async fn validate_ticket_concurrent_only_one_succeeds() {
    let client = Arc::new(make_client());
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();

    let mut handles = Vec::new();
    for _ in 0..10 {
        let c = client.clone();
        let t = ticket.clone();
        handles.push(tokio::spawn(
            async move { c.validate_ticket(&t, 2001).await },
        ));
    }

    let mut success = 0;
    let mut invalid_token = 0;
    for handle in handles {
        match handle.await.unwrap() {
            Ok(login_id) => {
                assert_eq!(login_id, "1001");
                success += 1;
            },
            Err(GarrisonError::InvalidToken(_)) => invalid_token += 1,
            Err(e) => panic!("期望 InvalidToken 或 Ok,实际: {:?}", e),
        }
    }

    assert_eq!(success, 1, "并发消费同一 ticket 仅一个成功");
    assert_eq!(invalid_token, 9, "其他 9 个应返回 InvalidToken");
}

// ticket HMAC 签名测试

/// 伪造的 ticket(无签名部分)应被拒绝。
#[tokio::test]
async fn validate_ticket_rejects_unsigned_ticket() {
    let client = make_client();
    // 伪造的 ticket:纯 64 hex,无 `.{hmac}` 部分
    let fake_ticket = "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789";
    let result = client.validate_ticket(fake_ticket, 2001).await;
    assert!(
        matches!(result, Err(GarrisonError::InvalidToken(ref msg)) if msg.contains("sso-ticket-format-no-sig")),
        "无签名的 ticket 应被拒绝,实际: {:?}",
        result
    );
}

/// 签名被篡改的 ticket 应被拒绝。
#[tokio::test]
async fn validate_ticket_rejects_tampered_signature() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let tampered_ticket = format!("{}X", ticket);
    let result = client.validate_ticket(&tampered_ticket, 2001).await;
    assert!(
        matches!(result, Err(GarrisonError::InvalidToken(ref msg)) if msg.contains("sso-ticket-sig-verify")),
        "篡改签名的 ticket 应被拒绝,实际: {:?}",
        result
    );
}

/// 使用不同 secret 签发的 ticket 应被另一个 client 拒绝。
#[tokio::test]
async fn validate_ticket_rejects_different_secret() {
    let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
    let issuer = SsoClient::new(dao.clone(), "secret-a-0123456789abcdef-32bytes!")
        .expect("secret 非空构造应成功");
    let validator =
        SsoClient::new(dao, "secret-b-0123456789abcdef-32bytes!").expect("secret 非空构造应成功");

    let ticket = issuer.issue_ticket("1001", 2001).await.unwrap();
    let result = validator.validate_ticket(&ticket, 2001).await;
    assert!(
        matches!(result, Err(GarrisonError::InvalidToken(ref msg)) if msg.contains("sso-ticket-sig-verify")),
        "不同 secret 签发的 ticket 应被拒绝,实际: {:?}",
        result
    );
}

/// 空 secret 构造返回 `InvalidParam` 错误(不 panic,与文档承诺一致)。
#[test]
fn new_rejects_empty_secret() {
    let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
    let result = SsoClient::new(dao, "");
    match result {
        Err(GarrisonError::InvalidParam(msg)) => {
            assert!(
                msg.contains("sso-client-secret-empty"),
                "错误消息应含 sso-client-secret-empty 前缀,实际: {}",
                msg
            );
        },
        Err(other) => panic!("期望 InvalidParam,实际: {:?}", other),
        Ok(_) => panic!("空 secret 不应构造成功"),
    }
}

/// 短于 32 字节的 secret 构造返回 `InvalidParam`(与 qrlogin/protocol-sign 对齐,弱密钥可被离线爆破后伪造签名)。
#[test]
fn new_rejects_short_secret() {
    let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
    let result = SsoClient::new(dao, "a".repeat(31));
    match result {
        Err(GarrisonError::InvalidParam(msg)) => {
            assert!(
                msg.contains("sso-client-secret-too-short"),
                "错误消息应含 sso-client-secret-too-short 前缀,实际: {}",
                msg
            );
        },
        Err(other) => panic!("期望 InvalidParam,实际: {:?}", other),
        Ok(_) => panic!("31 字节 secret 不应构造成功"),
    }
    let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
    assert!(
        SsoClient::new(dao, "a".repeat(32)).is_ok(),
        "32 字节 secret 应构造成功"
    );
}

/// client_id 不匹配的错误消息不得回显存储/调用方 client_id(防枚举)。
#[tokio::test]
async fn validate_ticket_client_id_mismatch_message_does_not_leak_ids() {
    let client = make_client();
    let ticket = client.issue_ticket("1001", 2001).await.unwrap();
    let result = client.validate_ticket(&ticket, 9999).await;
    match result {
        Err(GarrisonError::InvalidToken(msg)) => {
            assert!(
                msg.contains("sso-ticket-client-id-mismatch"),
                "错误消息应含固定前缀,实际: {}",
                msg
            );
            assert!(
                !msg.contains("2001") && !msg.contains("9999"),
                "错误消息不得回显 client_id,实际: {}",
                msg
            );
        },
        other => panic!("期望 InvalidToken,实际: {:?}", other),
    }
}

// DefaultSamlProvider:Destination / Audience 校验与 XML 解析分支

mod saml_provider_tests {
    use super::*;
    use crate::protocol::sso::saml::{DefaultSamlProvider, SamlProvider};

    /// 构造 Destination/Audience 均匹配的 Response XML。
    fn saml_xml(destination: &str, audience: &str) -> String {
        let future = chrono::Utc::now().timestamp() + 3600;
        let future_str = chrono::DateTime::from_timestamp(future, 0)
            .unwrap()
            .to_rfc3339();
        format!(
            r#"<?xml version="1.0" encoding="UTF-8"?>
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
                xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
                Destination="{destination}">
  <saml:Issuer>https://idp.example.com</saml:Issuer>
  <samlp:Status>
    <samlp:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success"/>
  </samlp:Status>
  <saml:Assertion ID="assertion-123">
    <saml:Issuer>https://idp.example.com</saml:Issuer>
    <saml:Subject>
      <saml:NameID>user@example.com</saml:NameID>
      <saml:SubjectConfirmation>
        <saml:SubjectConfirmationData NotOnOrAfter="{future_str}"></saml:SubjectConfirmationData>
      </saml:SubjectConfirmation>
    </saml:Subject>
    <saml:Conditions NotBefore="2020-01-01T00:00:00Z">
      <saml:AudienceRestriction>
        <saml:Audience>{audience}</saml:Audience>
      </saml:AudienceRestriction>
    </saml:Conditions>
  </saml:Assertion>
  <saml:Extensions><saml:VendorSpecific x="1"/></saml:Extensions>
</samlp:Response>"#
        )
    }

    /// Default trait 构造与 new 等价(构造不 panic 即为通过)。
    #[test]
    fn default_impl_constructs() {
        let _provider = DefaultSamlProvider::default();
    }

    /// Destination 不匹配(expected 已配置)→ InvalidParam(fail-loud,防 open redirect)。
    #[tokio::test]
    async fn destination_mismatch_is_rejected_when_expected_configured() {
        let provider = DefaultSamlProvider::new()
            .unwrap()
            .with_expected_destination("https://sp.example.com/acs".to_string());
        let err = provider
            .parse_response(&saml_xml(
                "https://evil.example.com/acs",
                "https://sp.example.com",
            ))
            .await
            .unwrap_err();
        assert!(
            matches!(&err, GarrisonError::InvalidParam(m) if m.contains("sso-saml-destination-mismatch")),
            "Destination 不匹配应报 sso-saml-destination-mismatch,实际: {err:?}"
        );
    }

    /// Destination 匹配(expected 已配置)→ 解析成功。
    #[tokio::test]
    async fn destination_match_passes_when_expected_configured() {
        let provider = DefaultSamlProvider::new()
            .unwrap()
            .with_expected_destination("https://sp.example.com/acs".to_string());
        let response = provider
            .parse_response(&saml_xml(
                "https://sp.example.com/acs",
                "https://sp.example.com",
            ))
            .await
            .unwrap();
        assert_eq!(response.destination, "https://sp.example.com/acs");
    }

    /// Audience 不匹配(expected 已配置)→ InvalidParam(防跨 SP 重放)。
    #[tokio::test]
    async fn audience_mismatch_is_rejected_when_expected_configured() {
        let provider = DefaultSamlProvider::new()
            .unwrap()
            .with_expected_audience("https://sp.example.com".to_string());
        let err = provider
            .parse_response(&saml_xml(
                "https://sp.example.com/acs",
                "https://other-sp.example.com",
            ))
            .await
            .unwrap_err();
        assert!(
            matches!(&err, GarrisonError::InvalidParam(m) if m.contains("sso-saml-audience-mismatch")),
            "Audience 不匹配应报 sso-saml-audience-mismatch,实际: {err:?}"
        );
    }

    /// Audience 匹配(expected 已配置)→ 解析成功。
    #[tokio::test]
    async fn audience_match_passes_when_expected_configured() {
        let provider = DefaultSamlProvider::new()
            .unwrap()
            .with_expected_audience("https://sp.example.com".to_string());
        let response = provider
            .parse_response(&saml_xml(
                "https://sp.example.com/acs",
                "https://sp.example.com",
            ))
            .await
            .unwrap();
        assert!(
            response.assertion.is_none(),
            "无签名校验实现时 Assertion 剥离"
        );
    }

    /// 同名 Attribute 携带多个 AttributeValue:解析出多条属性并触发
    /// 重复属性告警分支(属性污染防御可见性)。
    #[tokio::test]
    async fn duplicate_attribute_names_are_all_collected() {
        let future = chrono::Utc::now().timestamp() + 3600;
        let future_str = chrono::DateTime::from_timestamp(future, 0)
            .unwrap()
            .to_rfc3339();
        let xml = format!(
            r#"<?xml version="1.0" encoding="UTF-8"?>
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
                xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
                Destination="https://sp.example.com/acs">
  <saml:Issuer>https://idp.example.com</saml:Issuer>
  <samlp:Status>
    <samlp:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success"/>
  </samlp:Status>
  <saml:Assertion ID="a1">
    <saml:Issuer>https://idp.example.com</saml:Issuer>
    <saml:Subject>
      <saml:NameID>user@example.com</saml:NameID>
      <saml:SubjectConfirmation>
        <saml:SubjectConfirmationData NotOnOrAfter="{future_str}"></saml:SubjectConfirmationData>
      </saml:SubjectConfirmation>
    </saml:Subject>
    <saml:AttributeStatement>
      <saml:Attribute Name="role">
        <saml:AttributeValue>admin</saml:AttributeValue>
        <saml:AttributeValue>auditor</saml:AttributeValue>
      </saml:Attribute>
    </saml:AttributeStatement>
  </saml:Assertion>
</samlp:Response>"#
        );
        let provider = DefaultSamlProvider::new().unwrap();
        let response = provider.parse_response(&xml).await.unwrap();
        assert!(
            response.assertion.is_none(),
            "无签名校验时 Assertion 剥离,属性解析分支仍应执行"
        );
    }
}