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

//! 备份码凭证子模块:`BackupCodeCredential` 实现 `Credential` trait,支持 10 个一次性 MFA 备份码
//! (8 字节随机数 → Base32 → `XXXX-XXXX-XXXX`)。
//!
//! `CredentialModel.secret_data` 存储如下 JSON:
//!
//! ```json
//! {"codes":["hash1","hash2",...]}
//! ```
//!
//! `codes` 为每个备份码规范化形式(大写去 `-`)的 SHA-256 哈希列表;明文仅在 `generate()` 返回时可见,
//! 此后仅存哈希;`verify_and_consume()` 校验通过后从列表移除该哈希(一次性使用)。

use super::{Credential, CredentialModel, CredentialType};
use crate::constants::DaoKeyPrefix;
use crate::dao::GarrisonDao;
use crate::error::{GarrisonError, GarrisonResult};
use crate::secure::ct_eq::constant_time_eq;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};

/// 备份码数量。
const CODE_COUNT: usize = 10;

/// 每个备份码的随机字节数。
const CODE_BYTES: usize = 8;

/// 备份码 secret_data 的 JSON 结构。
#[derive(Debug, Clone, Serialize, Deserialize)]
struct BackupCodeSecretData {
    /// SHA-256 哈希列表(每个备份码的规范化形式哈希后存入)。
    codes: Vec<String>,
}

impl BackupCodeSecretData {
    /// 从 `secret_data` JSON 字符串解析。
    fn from_json(secret_data: &str) -> GarrisonResult<Self> {
        serde_json::from_str(secret_data)
            .map_err(|e| GarrisonError::InvalidParam(format!("account-backup-deserialize::{}", e)))
    }
}

/// 将输入字符串计算 SHA-256 并返回小写十六进制字符串。
fn sha256_hex(input: &str) -> String {
    let mut hasher = Sha256::new();
    hasher.update(input.as_bytes());
    let result = hasher.finalize();
    result.iter().map(|b| format!("{:02x}", b)).collect()
}

/// 规范化备份码输入:移除 `-` 分隔符并转为大写。
fn normalize(input: &str) -> String {
    input.to_uppercase().replace('-', "")
}

/// 将 Base32 编码字符串格式化为 `XXXX-XXXX-XXXX`(取前 12 字符,每 4 字符一组)。
fn format_code(base32_str: &str) -> String {
    format!(
        "{}-{}-{}",
        &base32_str[..4],
        &base32_str[4..8],
        &base32_str[8..12]
    )
}

/// 备份码凭证(实现 [`Credential`] trait):`generate()` 生成 10 个一次性备份码(明文仅此一次返回),
/// `verify_and_consume()` 校验输入并消费(一次性使用,更新 DAO)。
///
/// # 示例
///
/// ```ignore
/// use garrison::account::credential::backup_code::BackupCodeCredential;
///
/// let (cred, codes) = BackupCodeCredential::generate("alice")?;
/// // 将 cred.to_model() 持久化到 DAO 后,可用 verify_and_consume 校验
/// ```
#[cfg_attr(
    feature = "credential-zeroize",
    derive(zeroize::Zeroize, zeroize::ZeroizeOnDrop)
)]
pub struct BackupCodeCredential {
    /// 凭证存储模型。
    model: CredentialModel,
}

impl BackupCodeCredential {
    /// 创建备份码凭证(`model.secret_data` 应为 `{"codes":["hash1",...]}` JSON)。
    pub fn new(model: CredentialModel) -> Self {
        Self { model }
    }

    /// 生成 10 个一次性备份码(`login_id` 存入 `model.user_id`):每个为 8 字节随机数(OS CSPRNG)→
    /// Base32 → `XXXX-XXXX-XXXX`,哈希存入 `secret_data`,明文仅此一次返回;序列化失败返回 `Err`。
    pub fn generate(login_id: &str) -> GarrisonResult<(BackupCodeCredential, Vec<String>)> {
        let mut codes = Vec::with_capacity(CODE_COUNT);
        let mut hashes = Vec::with_capacity(CODE_COUNT);
        for _ in 0..CODE_COUNT {
            let mut bytes = [0u8; CODE_BYTES];
            getrandom::fill(&mut bytes).expect("OS CSPRNG 不可用");
            let encoded = base32::encode(base32::Alphabet::Rfc4648 { padding: false }, &bytes);
            let formatted = format_code(&encoded);
            let normalized = normalize(&formatted);
            codes.push(formatted);
            hashes.push(sha256_hex(&normalized));
        }
        let secret_data = serde_json::to_string(&BackupCodeSecretData { codes: hashes })
            .map_err(|e| GarrisonError::Internal(format!("account-backup-serialize::{}", e)))?;
        let model = CredentialModel {
            id: uuid::Uuid::new_v4().to_string(),
            user_id: login_id.to_string(),
            credential_type: "backup_code".to_string(),
            secret_data,
            label: None,
            created_at: chrono::Utc::now().timestamp(),
            enabled: true,
            priority: 0,
        };
        Ok((BackupCodeCredential { model }, codes))
    }

    /// 校验并消费备份码(一次性使用):从 DAO 读取当前 model,将输入(规范化后)的 SHA-256 与
    /// `secret_data` 哈希列表常量时间比对;匹配则从列表移除该哈希并写回 DAO,不匹配返回 `Ok(false)`。
    ///
    /// 消费成功后同步更新本实例内存快照,使同一实例后续的 [`verify`](Credential::verify) 可见本次消费。
    ///
    /// # 并发安全(CAS 原子消费)
    ///
    /// `compare_and_swap` 实现原子 get→verify→set,消除 TOCTOU 双花竞态;CAS 失败自动重试
    /// (最多 `MAX_CAS_RETRIES` 次)。生产后端需保证 CAS 原子(Redis 应重写为 Lua 脚本
    /// GET + COMPARE + SET;dbnexus 应重写为 `UPDATE ... WHERE value = expected`)。
    #[tracing::instrument(skip(self, input, dao), fields(user_id = %self.model.user_id))]
    pub async fn verify_and_consume(
        &mut self,
        input: &str,
        dao: &dyn GarrisonDao,
    ) -> GarrisonResult<bool> {
        const MAX_CAS_RETRIES: u32 = 5;
        let key = format!(
            "{}{}:{}",
            DaoKeyPrefix::Cred,
            self.model.user_id,
            self.model.id
        );
        let input_hash = sha256_hex(&normalize(input));

        for attempt in 0..MAX_CAS_RETRIES {
            let old_json = match dao.get(&key).await? {
                Some(j) => j,
                None => {
                    return Err(GarrisonError::InvalidParam(format!(
                        "credential-backup-code-not-found::{}",
                        key
                    )))
                },
            };
            let model: CredentialModel = serde_json::from_str(&old_json)
                .map_err(|e| GarrisonError::Internal(format!("account-cred-deserialize::{}", e)))?;
            let mut data = BackupCodeSecretData::from_json(&model.secret_data)?;

            // 常量时间比较(CWE-208)
            if let Some(idx) = data
                .codes
                .iter()
                .position(|h| constant_time_eq(h.as_bytes(), input_hash.as_bytes()))
            {
                data.codes.remove(idx);
                let new_secret = serde_json::to_string(&data).map_err(|e| {
                    GarrisonError::Internal(format!("account-backup-serialize::{}", e))
                })?;
                let mut updated_model = model.clone();
                updated_model.secret_data = new_secret.clone();
                let updated_json = serde_json::to_string(&updated_model).map_err(|e| {
                    GarrisonError::Internal(format!("account-cred-serialize::{}", e))
                })?;

                // 原子 CAS:仅当 DAO 值未被并发修改时写入
                if dao
                    .compare_and_swap(&key, Some(&old_json), &updated_json, 0)
                    .await?
                {
                    // 同步内存快照:消费成功后更新本实例 model.secret_data,
                    // 使同一实例的 verify() 不再对已消费码返回 true
                    self.model.secret_data = new_secret;
                    tracing::info!(
                        user_id = %self.model.user_id,
                        remaining = data.codes.len(),
                        attempt = attempt + 1,
                        "backup code consumed via atomic CAS"
                    );
                    return Ok(true);
                }
                // CAS 失败:并发修改,重试
                tracing::debug!(
                    attempt = attempt + 1,
                    max_retries = MAX_CAS_RETRIES,
                    "CAS conflict on backup code consume, retrying"
                );
            } else {
                return Ok(false);
            }
        }
        Err(GarrisonError::Internal(format!(
            "backup_code CAS retry exhausted after {} attempts: {}",
            MAX_CAS_RETRIES, key
        )))
    }
}

#[async_trait]
impl Credential for BackupCodeCredential {
    fn credential_type(&self) -> CredentialType {
        "backup_code"
    }

    fn to_model(&self) -> CredentialModel {
        self.model.clone()
    }

    async fn verify(&self, input: &str) -> GarrisonResult<bool> {
        // 内存快照语义:只比对实例内存中的 `self.model.secret_data` 快照,不查 DAO——本实例内
        // `verify_and_consume` 成功后会同步该快照(已消费码返回 false);跨实例/并发消费不可见
        // (无 DAO 参数),权威校验请用 [`BackupCodeCredential::verify_and_consume`]。
        let data = BackupCodeSecretData::from_json(&self.model.secret_data)?;
        let input_hash = sha256_hex(&normalize(input));
        // 常量时间比较(CWE-208):不使用 contains/== 短路比较
        Ok(data
            .codes
            .iter()
            .any(|h| constant_time_eq(h.as_bytes(), input_hash.as_bytes())))
    }
}

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

    /// 辅助函数:将 BackupCodeCredential 的 model 持久化到 DAO。
    async fn store_in_dao(cred: &BackupCodeCredential, dao: &MockDao) {
        let model = cred.to_model();
        let key = format!("cred:{}:{}", model.user_id, model.id);
        let json = serde_json::to_string(&model).expect("序列化应成功");
        dao.set_permanent(&key, &json)
            .await
            .expect("DAO 写入应成功");
    }

    /// `generate()` 返回 10 个备份码。
    #[test]
    fn generate_returns_10_codes() {
        let (cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        assert_eq!(codes.len(), 10, "应生成 10 个备份码");
        assert_eq!(
            cred.credential_type(),
            "backup_code",
            "credential_type 应为 backup_code"
        );
    }

    /// `generate()` 每个备份码格式为 `XXXX-XXXX-XXXX`(14 字符:12 字母数字 + 2 连字符)。
    #[test]
    fn generate_codes_have_correct_format() {
        let (_, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        for code in &codes {
            assert_eq!(
                code.len(),
                14,
                "备份码应为 14 字符(XXXX-XXXX-XXXX),实际: {}",
                code
            );
            let parts: Vec<&str> = code.split('-').collect();
            assert_eq!(parts.len(), 3, "备份码应有 3 段,实际: {}", code);
            for part in &parts {
                assert_eq!(part.len(), 4, "每段应为 4 字符,实际: {}", part);
                assert!(
                    part.chars()
                        .all(|c| c.is_ascii_uppercase() || c.is_ascii_digit()),
                    "每段应为 Base32 字符(A-Z, 2-7),实际: {}",
                    part
                );
            }
        }
    }

    /// `generate()` 返回的 10 个备份码互不重复。
    #[test]
    fn generate_codes_are_unique() {
        let (_, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let unique: std::collections::HashSet<_> = codes.iter().collect();
        assert_eq!(unique.len(), 10, "10 个备份码应互不重复");
    }

    /// `credential_type()` 返回 `"backup_code"`。
    #[test]
    fn credential_type_returns_backup_code() {
        let (cred, _) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        assert_eq!(cred.credential_type(), "backup_code");
    }

    /// `to_model()` 返回原始 CredentialModel(字段一致)。
    #[test]
    fn to_model_returns_original() {
        let (cred, _) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let model = cred.to_model();
        assert_eq!(model.user_id, "alice");
        assert_eq!(model.credential_type, "backup_code");
        assert!(model.secret_data.contains("codes"));
        assert!(model.enabled);
    }

    /// `verify_and_consume()` 正确备份码返回 `Ok(true)`。
    #[tokio::test]
    async fn verify_and_consume_correct_code() {
        let (mut cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        let result = cred
            .verify_and_consume(&codes[0], &dao)
            .await
            .expect("verify_and_consume 应成功");
        assert!(result, "正确备份码应校验通过");
    }

    /// `verify_and_consume()` 已使用的备份码返回 `Ok(false)`(一次性使用)。
    #[tokio::test]
    async fn verify_and_consume_rejects_used_code() {
        let (mut cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        let first = cred
            .verify_and_consume(&codes[0], &dao)
            .await
            .expect("首次校验应成功");
        assert!(first, "首次应通过");

        let second = cred
            .verify_and_consume(&codes[0], &dao)
            .await
            .expect("二次校验应成功");
        assert!(!second, "已使用的备份码应被拒绝(一次性使用)");
    }

    /// `verify_and_consume()` 错误备份码返回 `Ok(false)`。
    #[tokio::test]
    async fn verify_and_consume_wrong_code_returns_false() {
        let (mut cred, _) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        let result = cred
            .verify_and_consume("WRONG-CODE-XXXX", &dao)
            .await
            .expect("verify_and_consume 应成功");
        assert!(!result, "错误备份码应返回 false");
    }

    /// `verify_and_consume()` 支持含 `-` 和不含 `-` 两种输入形式。
    #[tokio::test]
    async fn verify_and_consume_normalizes_input() {
        let (mut cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        let normalized = codes[0].replace('-', "");
        let result = cred
            .verify_and_consume(&normalized, &dao)
            .await
            .expect("verify_and_consume 应成功");
        assert!(result, "不含连字符的输入应校验通过");
    }

    /// `verify_and_consume()` 小写输入应通过(规范化转大写)。
    #[tokio::test]
    async fn verify_and_consume_lowercase_input() {
        let (mut cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        let lower = codes[0].to_lowercase();
        let result = cred
            .verify_and_consume(&lower, &dao)
            .await
            .expect("verify_and_consume 应成功");
        assert!(result, "小写输入应校验通过(规范化转大写)");
    }

    /// `Credential::verify()` 正确备份码返回 `Ok(true)`(仅比对,不消费)。
    #[tokio::test]
    async fn verify_correct_code() {
        let (cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let result = cred.verify(&codes[0]).await.expect("verify 应成功");
        assert!(result, "正确备份码应校验通过");
    }

    /// `Credential::verify()` 错误备份码返回 `Ok(false)`。
    #[tokio::test]
    async fn verify_wrong_code() {
        let (cred, _) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let result = cred.verify("WRONG-CODE-XXXX").await.expect("verify 应成功");
        assert!(!result, "错误备份码应返回 false");
    }

    /// `Credential::verify()` 不消费备份码(verify 后 verify_and_consume 仍应通过)。
    #[tokio::test]
    async fn verify_does_not_consume() {
        let (cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        let verify_result = cred.verify(&codes[0]).await.expect("verify 应成功");
        assert!(verify_result, "verify 应通过");

        let mut cred = cred;
        let consume_result = cred
            .verify_and_consume(&codes[0], &dao)
            .await
            .expect("verify_and_consume 应成功");
        assert!(consume_result, "verify 不应消费备份码");
    }

    /// 同一实例消费后,`verify()` 对已消费码应返回 false
    /// (内存快照与 DAO 同步),对未消费码仍返回 true。
    #[tokio::test]
    async fn verify_sees_consumption_by_same_instance() {
        let (mut cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        let consumed = cred
            .verify_and_consume(&codes[0], &dao)
            .await
            .expect("verify_and_consume 应成功");
        assert!(consumed, "首次消费应通过");

        let verify_consumed = cred.verify(&codes[0]).await.expect("verify 应成功");
        assert!(
            !verify_consumed,
            "已消费码 verify 应返回 false(内存快照已同步)"
        );

        let verify_remaining = cred.verify(&codes[1]).await.expect("verify 应成功");
        assert!(verify_remaining, "未消费码 verify 应仍返回 true");
    }

    /// 备份码哈希比较(`secure::ct_eq` 统一原语)语义:相等/不等/长度不等。
    /// 与 `==` 的全组合等价性矩阵由原语测试模块单点维护(`secure::ct_eq`)。
    #[test]
    fn constant_time_eq_comparison_semantics() {
        let h = sha256_hex("AAAA-AAAA-AAAA");
        assert!(
            constant_time_eq(h.as_bytes(), h.as_bytes()),
            "相同哈希应相等"
        );
        assert!(
            !constant_time_eq(h.as_bytes(), sha256_hex("BBBB-BBBB-BBBB").as_bytes()),
            "不同哈希应不等"
        );
        assert!(
            !constant_time_eq(h.as_bytes(), b"short"),
            "长度不等应返回 false"
        );
        assert!(constant_time_eq(b"", b""), "空串应相等");
    }

    /// `BackupCodeCredential` 可作 `Box<dyn Credential>` 使用(对象安全验证)。
    #[tokio::test]
    async fn usable_as_dyn_credential() {
        let (cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dyn_cred: Box<dyn Credential> = Box::new(cred);
        assert_eq!(dyn_cred.credential_type(), "backup_code");
        let result = dyn_cred.verify(&codes[0]).await.expect("verify 应成功");
        assert!(result, "dyn Credential 正确备份码应校验通过");
    }

    /// `secret_data` JSON 解析 — 非法 JSON 返回错误。
    #[tokio::test]
    async fn invalid_secret_data_returns_error() {
        let model = CredentialModel {
            id: "bad".to_string(),
            user_id: "alice".to_string(),
            credential_type: "backup_code".to_string(),
            secret_data: "not-json".to_string(),
            label: None,
            created_at: 0,
            enabled: true,
            priority: 0,
        };
        let cred = BackupCodeCredential::new(model);
        let result = cred.verify("XXXX-XXXX-XXXX").await;
        assert!(result.is_err(), "非法 secret_data 应返回错误");
    }

    /// 消费全部 10 个备份码后,第 11 次校验返回 `Ok(false)`。
    #[tokio::test]
    async fn consume_all_codes_then_reject() {
        let (mut cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let dao = MockDao::new();
        store_in_dao(&cred, &dao).await;

        for code in &codes {
            let result = cred
                .verify_and_consume(code, &dao)
                .await
                .expect("verify_and_consume 应成功");
            assert!(result, "每个备份码首次使用应通过: {}", code);
        }

        let result = cred
            .verify_and_consume(&codes[0], &dao)
            .await
            .expect("verify_and_consume 应成功");
        assert!(!result, "全部消费后应返回 false");
    }

    /// 并发双花防护 — CAS 原子消费保证同一备份码并发仅一次成功(另一个 CAS 冲突重试后发现码已消费;
    /// MockDao 的 Mutex 保证 CAS 进程内原子)。
    #[tokio::test]
    async fn concurrent_consume_same_code_only_one_succeeds() {
        use std::sync::Arc;
        let (cred, codes) = BackupCodeCredential::generate("alice").expect("generate 应成功");
        let mock_dao = MockDao::new();
        store_in_dao(&cred, &mock_dao).await;
        let dao: Arc<dyn GarrisonDao> = Arc::new(mock_dao);

        let code = codes[0].clone();
        let mut cred1 = BackupCodeCredential::new(cred.to_model());
        let mut cred2 = BackupCodeCredential::new(cred.to_model());
        let dao1 = dao.clone();
        let dao2 = dao.clone();
        let code1 = code.clone();
        let code2 = code.clone();

        let (r1, r2) = tokio::join!(
            cred1.verify_and_consume(&code1, dao1.as_ref()),
            cred2.verify_and_consume(&code2, dao2.as_ref()),
        );

        let ok1 = r1.expect("调用 1 不应报错");
        let ok2 = r2.expect("调用 2 不应报错");
        assert!(
            ok1 ^ ok2,
            "并发消费同一备份码应仅一个成功(XOR),实际: ok1={}, ok2={}",
            ok1,
            ok2
        );
    }
}