yang-base 0.1.2

个人使用构建后端服务器
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
//! TokenManager 单元测试

use crate::error::BaseError;
use crate::token::TokenManager;
use jsonwebtoken::Algorithm;
use serde_json::json;

/// 测试对称加密 Token 生成和验证
#[test]
fn test_symmetric_token_generation_and_verification() {
    // 创建对称加密的 Token 管理器
    let manager = TokenManager::new_symmetric(
        "test_secret_key_12345",
        Algorithm::HS256,
        "test-issuer".to_string(),
        "test-audience".to_string(),
        3600,  // 1 小时
        86400, // 1 天
    );

    // 生成 Access Token
    let custom_claims = json!({
        "role": "admin",
        "permissions": ["read", "write", "delete"]
    });

    let token = manager
        .generate_access_token("user_123", custom_claims.clone())
        .expect("生成 Token 失败");

    // 验证 Token 不为空
    assert!(!token.is_empty());

    // 验证 Token
    let claims = manager.verify_token(&token).expect("验证 Token 失败");

    // 验证标准声明
    assert_eq!(claims.iss, "test-issuer");
    assert_eq!(claims.sub, "user_123");
    assert_eq!(claims.aud, "test-audience");
    assert_eq!(claims.token_type, crate::token::TokenType::Access);

    // 验证自定义声明
    assert_eq!(claims.custom.get("role").unwrap(), "admin");
    assert_eq!(
        claims.custom.get("permissions").unwrap(),
        &json!(["read", "write", "delete"])
    );
}

/// 测试不同对称加密算法
#[test]
fn test_symmetric_algorithms() {
    let algorithms = vec![Algorithm::HS256, Algorithm::HS384, Algorithm::HS512];

    for algorithm in algorithms {
        let manager = TokenManager::new_symmetric(
            "test_secret_key",
            algorithm,
            "issuer".to_string(),
            "audience".to_string(),
            3600,
            86400,
        );

        let token = manager
            .generate_access_token("user_test", json!({}))
            .expect("生成 Token 失败");

        let claims = manager.verify_token(&token).expect("验证 Token 失败");

        assert_eq!(claims.sub, "user_test");
    }
}

/// 测试 Refresh Token 生成和验证
#[test]
fn test_refresh_token_generation() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    // 生成 Refresh Token
    let refresh_token = manager
        .generate_refresh_token("user_456")
        .expect("生成 Refresh Token 失败");

    // 验证 Refresh Token
    let claims = manager
        .verify_token(&refresh_token)
        .expect("验证 Refresh Token 失败");

    // 验证 Token 类型
    assert_eq!(claims.token_type, crate::token::TokenType::Refresh);
    assert_eq!(claims.sub, "user_456");

    // 验证自定义声明为空
    assert!(claims.custom.is_null() || claims.custom.as_object().unwrap().is_empty());
}

/// 测试 Token 对生成
#[test]
fn test_token_pair_generation() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    let custom_claims = json!({"role": "user"});

    // 生成 Token 对
    let (access_token, refresh_token) = manager
        .generate_token_pair("user_789", custom_claims)
        .expect("生成 Token 对失败");

    // 验证 Access Token
    let access_claims = manager
        .verify_token(&access_token)
        .expect("验证 Access Token 失败");
    assert_eq!(access_claims.token_type, crate::token::TokenType::Access);
    assert_eq!(access_claims.sub, "user_789");

    // 验证 Refresh Token
    let refresh_claims = manager
        .verify_token(&refresh_token)
        .expect("验证 Refresh Token 失败");
    assert_eq!(refresh_claims.token_type, crate::token::TokenType::Refresh);
    assert_eq!(refresh_claims.sub, "user_789");
}

/// 测试 Token 验证失败(错误的密钥)
#[test]
fn test_token_verification_with_wrong_secret() {
    // 使用密钥 A 生成 Token
    let manager_a = TokenManager::new_symmetric(
        "secret_key_a",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    let token = manager_a
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 失败");

    // 使用密钥 B 验证 Token(应该失败)
    let manager_b = TokenManager::new_symmetric(
        "secret_key_b",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    let result = manager_b.verify_token(&token);
    assert!(result.is_err());

    // 验证错误消息包含签名相关信息
    if let Err(BaseError::TokenVerifyFailed(ref err)) = result {
        let msg = err.to_string();
        assert!(msg.contains("signature") || msg.contains("Invalid"));
    }
    // 断言错误类型为 TokenVerifyFailed
    assert!(
        matches!(result, Err(BaseError::TokenVerifyFailed(_))),
        "期望 TokenVerifyFailed 错误,实际: {:?}",
        result
    );
}

/// 测试 Token 验证失败(错误的签发者)
#[test]
fn test_token_verification_with_wrong_issuer() {
    // 使用签发者 A 生成 Token
    let manager_a = TokenManager::new_symmetric(
        "secret_key",
        Algorithm::HS256,
        "issuer_a".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    let token = manager_a
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 失败");

    // 使用签发者 B 验证 Token(应该失败)
    let manager_b = TokenManager::new_symmetric(
        "secret_key",
        Algorithm::HS256,
        "issuer_b".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    let result = manager_b.verify_token(&token);
    assert!(result.is_err());
}

/// 测试 Token 验证失败(错误的受众)
#[test]
fn test_token_verification_with_wrong_audience() {
    // 使用受众 A 生成 Token
    let manager_a = TokenManager::new_symmetric(
        "secret_key",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience_a".to_string(),
        3600,
        86400,
    );

    let token = manager_a
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 失败");

    // 使用受众 B 验证 Token(应该失败)
    let manager_b = TokenManager::new_symmetric(
        "secret_key",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience_b".to_string(),
        3600,
        86400,
    );

    let result = manager_b.verify_token(&token);
    assert!(result.is_err());
}

/// 测试 Token 过期验证
/// 注意:由于 jsonwebtoken 库可能有时间容差,我们使用足够长的等待时间
#[test]
fn test_token_expiration() {
    // 创建一个 Token 有效期为 3 秒的管理器
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3, // 3 秒过期
        86400,
    );

    let token = manager
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 失败");

    // 立即验证应该成功
    assert!(manager.verify_token(&token).is_ok());

    // 等待 5 秒后验证应该失败
    std::thread::sleep(std::time::Duration::from_secs(5));

    let result = manager.verify_token(&token);
    assert!(result.is_err(), "Token 应该已过期但验证仍然成功");

    // 验证错误类型为 TokenExpired
    if let Err(BaseError::TokenExpired) = &result {
        // TokenExpired 显示"Token 已过期",符合预期
    }
    // 断言错误类型为 TokenExpired
    assert!(
        matches!(result, Err(BaseError::TokenExpired)),
        "期望 TokenExpired 错误,实际: {:?}",
        result
    );
}

/// 测试 parse_token_unsafe 方法
/// 注意:由于 jsonwebtoken 库可能有时间容差,我们使用足够长的等待时间
#[allow(deprecated)]
#[allow(clippy::expect_used)]
#[test]
fn test_parse_token_unsafe() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3, // 3 秒过期
        86400,
    );

    let custom_claims = json!({"role": "admin"});
    let token = manager
        .generate_access_token("user_test", custom_claims)
        .expect("生成 Token 失败");

    // 等待 Token 过期
    std::thread::sleep(std::time::Duration::from_secs(5));

    // 正常验证应该失败
    assert!(
        manager.verify_token(&token).is_err(),
        "Token 应该已过期但验证仍然成功"
    );

    // 不安全解析应该成功(不验证过期时间)
    let claims = manager.parse_token_unsafe(&token).expect("解析 Token 失败");

    assert_eq!(claims.sub, "user_test");
    assert_eq!(claims.custom.get("role").unwrap(), "admin");
}

/// 测试 is_token_expiring_soon 方法
#[test]
fn test_is_token_expiring_soon() {
    // 创建一个 Token 有效期为 10 秒的管理器
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        10, // 10 秒过期
        86400,
    );

    let token = manager
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 失败");

    // 检查是否在 20 秒内过期(应该返回 true)
    let expiring_soon = manager
        .is_token_expiring_soon(&token, 20)
        .expect("检查失败");
    assert!(expiring_soon);

    // 检查是否在 5 秒内过期(应该返回 false)
    let expiring_soon = manager.is_token_expiring_soon(&token, 5).expect("检查失败");
    assert!(!expiring_soon);
}

/// 测试 refresh_access_token 方法
///
/// 此方法内部调用 `verify_token_checked`,需要 Redis 黑名单支持。
/// 运行时需先初始化 `GlobalRedis`,并通过 `--ignored` 执行:
/// ```bash
/// cargo test --test '' test_refresh_access_token -- --ignored --test-threads=1
/// ```
#[tokio::test]
#[ignore = "需要 Redis(verify_token_checked 依赖黑名单查询)"]
async fn test_refresh_access_token() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    // 生成 Refresh Token
    let refresh_token = manager
        .generate_refresh_token("user_test")
        .expect("生成 Refresh Token 失败");

    // 使用 Refresh Token 刷新 Access Token(async: 走 verify_token_checked 含黑名单检查)
    let new_access_token = manager
        .refresh_access_token(&refresh_token, json!({"role": "user"}))
        .await
        .expect("刷新 Access Token 失败");

    // 验证新的 Access Token
    let claims = manager
        .verify_token(&new_access_token)
        .expect("验证新 Access Token 失败");

    assert_eq!(claims.token_type, crate::token::TokenType::Access);
    assert_eq!(claims.sub, "user_test");
    assert_eq!(claims.custom.get("role").unwrap(), "user");
}

/// 测试使用 Access Token 刷新应该失败
///
/// 此方法内部调用 `verify_token_checked`,需要 Redis 黑名单支持。
/// 运行时需先初始化 `GlobalRedis`,并通过 `--ignored` 执行:
/// ```bash
/// cargo test --test '' test_refresh_with_access_token_should_fail -- --ignored --test-threads=1
/// ```
#[tokio::test]
#[ignore = "需要 Redis(verify_token_checked 依赖黑名单查询)"]
async fn test_refresh_with_access_token_should_fail() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    // 生成 Access Token
    let access_token = manager
        .generate_access_token("user_test", json!({}))
        .expect("生成 Access Token 失败");

    // 尝试使用 Access Token 刷新(应该失败)
    let result = manager.refresh_access_token(&access_token, json!({})).await;

    assert!(result.is_err());

    // 断言错误类型为 TokenTypeInvalid 且消息包含 "refresh"
    assert!(
        matches!(result, Err(BaseError::TokenTypeInvalid(ref msg)) if msg.contains("refresh")),
        "期望 TokenTypeInvalid 错误,实际: {:?}",
        result
    );
}

/// 测试自定义声明的序列化和反序列化
#[test]
fn test_custom_claims_serialization() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    // 创建复杂的自定义声明
    let custom_claims = json!({
        "user_id": 12345,
        "username": "john_doe",
        "email": "john@example.com",
        "roles": ["admin", "user"],
        "permissions": {
            "read": true,
            "write": true,
            "delete": false
        },
        "metadata": {
            "last_login": "2024-01-01T00:00:00Z",
            "login_count": 42
        }
    });

    let token = manager
        .generate_access_token("user_12345", custom_claims.clone())
        .expect("生成 Token 失败");

    let claims = manager.verify_token(&token).expect("验证 Token 失败");

    // 验证所有自定义字段
    assert_eq!(claims.custom.get("user_id").unwrap(), 12345);
    assert_eq!(claims.custom.get("username").unwrap(), "john_doe");
    assert_eq!(claims.custom.get("email").unwrap(), "john@example.com");
    assert_eq!(
        claims.custom.get("roles").unwrap(),
        &json!(["admin", "user"])
    );

    let permissions = claims.custom.get("permissions").unwrap();
    assert_eq!(permissions.get("read").unwrap(), true);
    assert_eq!(permissions.get("write").unwrap(), true);
    assert_eq!(permissions.get("delete").unwrap(), false);

    let metadata = claims.custom.get("metadata").unwrap();
    assert_eq!(metadata.get("last_login").unwrap(), "2024-01-01T00:00:00Z");
    assert_eq!(metadata.get("login_count").unwrap(), 42);
}

/// 测试空自定义声明
#[test]
fn test_empty_custom_claims() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    let token = manager
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 失败");

    let claims = manager.verify_token(&token).expect("验证 Token 失败");

    assert!(claims.custom.is_object());
    assert_eq!(claims.custom.as_object().unwrap().len(), 0);
}

/// 测试 JTI 唯一性
#[test]
fn test_jti_uniqueness() {
    let manager = TokenManager::new_symmetric(
        "test_secret",
        Algorithm::HS256,
        "issuer".to_string(),
        "audience".to_string(),
        3600,
        86400,
    );

    // 生成多个 Token
    let token1 = manager
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 1 失败");
    let token2 = manager
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 2 失败");
    let token3 = manager
        .generate_access_token("user_test", json!({}))
        .expect("生成 Token 3 失败");

    // 验证 JTI 唯一性
    let claims1 = manager.verify_token(&token1).expect("验证 Token 1 失败");
    let claims2 = manager.verify_token(&token2).expect("验证 Token 2 失败");
    let claims3 = manager.verify_token(&token3).expect("验证 Token 3 失败");

    assert_ne!(claims1.jti, claims2.jti);
    assert_ne!(claims1.jti, claims3.jti);
    assert_ne!(claims2.jti, claims3.jti);
}