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
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
//! Distributed Session Management Module | 分布式 Session 管理模块
//!
//! # Overview | 概述
//!
//! This module enables **distributed session management** for microservices architecture,
//! allowing multiple services to share authentication sessions seamlessly.
//! 本模块为微服务架构提供**分布式 Session 管理**,允许多个服务无缝共享认证会话。
//!
//! ## Architecture Context | 架构上下文
//!
//! ```text
//! ┌────────────────────────────────────────────────────────────────────┐
//! │ Microservices Architecture │
//! │ 微服务架构 │
//! └────────────────────────────────────────────────────────────────────┘
//!
//! ┌──────────────┐ ┌──────────────┐ ┌──────────────┐
//! │ Service A │ │ Service B │ │ Service C │
//! │ (User API) │ │ (Order API) │ │ (Pay API) │
//! └──────┬───────┘ └──────┬───────┘ └──────┬───────┘
//! │ │ │
//! └──────────────────┼──────────────────┘
//! │
//! ┌─────────▼──────────┐
//! │ Distributed │
//! │ Session Storage │
//! │ (Redis/Database) │
//! └────────────────────┘
//!
//! Each service can:
//! 每个服务可以:
//! 1. Create sessions for users
//! 为用户创建会话
//! 2. Access sessions created by other services
//! 访问其他服务创建的会话
//! 3. Share user authentication state
//! 共享用户认证状态
//! ```
//!
//! ## Key Use Cases | 关键使用场景
//!
//! ### 1. Single Sign-On (SSO) Across Services | 跨服务单点登录
//!
//! ```text
//! Scenario: User logs in to Service A and accesses Service B
//! 场景:用户登录服务 A 并访问服务 B
//!
//! 1. User → Service A: Login
//! 用户 → 服务 A:登录
//! ├─ Service A creates session: session_id = "abc123"
//! │ 服务 A 创建会话:session_id = "abc123"
//! └─ Saves to distributed storage
//! 保存到分布式存储
//!
//! 2. User → Service B: Request with session_id = "abc123"
//! 用户 → 服务 B:请求带 session_id = "abc123"
//! ├─ Service B retrieves session from storage
//! │ 服务 B 从存储中获取会话
//! ├─ Validates user is authenticated
//! │ 验证用户已认证
//! └─ Processes request ✅
//! 处理请求 ✅
//!
//! No need to log in again! 无需再次登录!
//! ```
//!
//! ### 2. Session Sharing for User Context | 会话共享用户上下文
//!
//! ```text
//! Service A stores: { "user_role": "admin", "department": "IT" }
//! 服务 A 存储:{ "user_role": "admin", "department": "IT" }
//!
//! Service B reads: Same session attributes available
//! 服务 B 读取:相同的会话属性可用
//!
//! Service C updates: { "last_order": "order_123" }
//! 服务 C 更新:{ "last_order": "order_123" }
//!
//! All services share the same session state!
//! 所有服务共享相同的会话状态!
//! ```
//!
//! ### 3. Multi-Device Session Management | 多设备会话管理
//!
//! ```text
//! User: user_123
//! ├─ Session 1: Web (Service A)
//! │ 会话 1:网页(服务 A)
//! ├─ Session 2: Mobile (Service B)
//! │ 会话 2:移动端(服务 B)
//! └─ Session 3: Desktop (Service C)
//! 会话 3:桌面端(服务 C)
//!
//! All sessions can be:
//! 所有会话可以:
//! - Listed: get_sessions_by_login_id()
//! - Managed individually
//! - Terminated all at once: delete_all_sessions()
//! ```
//!
//! ## Integration with Sa-Token | 与 Sa-Token 的集成
//!
//! ```text
//! ┌─────────────────────────────────────────────────────────┐
//! │ Sa-Token Core Flow │
//! │ Sa-Token 核心流程 │
//! └─────────────────────────────────────────────────────────┘
//!
//! SaTokenManager::login()
//! ├─ 1. Generate token
//! │ 生成 token
//! ├─ 2. Create TokenInfo
//! │ 创建 TokenInfo
//! └─ 3. Create DistributedSession (if enabled)
//! 创建 DistributedSession(如果启用)
//! ├─ session_id: UUID
//! ├─ login_id: user's login ID
//! ├─ token: access token
//! ├─ service_id: current service
//! └─ attributes: custom data
//!
//! StpUtil::get_session()
//! └─ Retrieves distributed session
//! 获取分布式会话
//!
//! StpUtil::logout()
//! └─ Deletes distributed session(s)
//! 删除分布式会话
//! ```
//!
//! ## Workflow Diagrams | 工作流程图
//!
//! ### Complete Session Lifecycle | 完整会话生命周期
//!
//! ```text
//! ┌──────────────────────────────────────────────────────────────────┐
//! │ Session Lifecycle │
//! │ 会话生命周期 │
//! └──────────────────────────────────────────────────────────────────┘
//!
//! User Service A Storage Service B
//! 用户 服务 A 存储 服务 B
//! │ │ │ │
//! │ 1. Login │ │ │
//! │ 登录 │ │ │
//! ├────────────────────▶│ │ │
//! │ │ 2. create_session() │
//! │ │ 创建会话 │ │
//! │ │ ├─ session_id: uuid │
//! │ │ ├─ login_id: user_123 │
//! │ │ ├─ token: access_token │
//! │ │ └─ service_id: service-a │
//! │ │ │ │
//! │ │ 3. save_session()│ │
//! │ │ 保存会话 │ │
//! │ ├──────────────────▶│ │
//! │ │ │ Store with TTL │
//! │ │ │ 存储并设置 TTL │
//! │ │ │ │
//! │ 4. session_id │ │ │
//! │ 返回会话 ID │ │ │
//! │◀────────────────────│ │ │
//! │ │ │ │
//! │ 5. Request to Service B with session_id │
//! │ 带 session_id 请求服务 B │
//! ├────────────────────────────────────────────────────────────▶│
//! │ │ │ │
//! │ │ │ 6. get_session() │
//! │ │ │ 获取会话 │
//! │ │ │◀──────────────────│
//! │ │ │ │
//! │ │ │ 7. Return session│
//! │ │ │ 返回会话数据 │
//! │ │ ├──────────────────▶│
//! │ │ │ │
//! │ │ │ 8. refresh_session()
//! │ │ │ 刷新会话 │
//! │ │ │ (update last_access)
//! │ │ │◀──────────────────│
//! │ │ │ │
//! │ 9. Response │ │ │
//! │ 响应 │ │ │
//! │◀────────────────────────────────────────────────────────────│
//! │ │ │ │
//! │ 10. Logout │ │ │
//! │ 登出 │ │ │
//! ├────────────────────▶│ │ │
//! │ │ 11. delete_session() │
//! │ │ 删除会话 │ │
//! │ ├──────────────────▶│ │
//! │ │ │ Remove from storage
//! │ │ │ 从存储中移除 │
//! │ │ │ │
//! │ 12. Logout Success │ │ │
//! │ 登出成功 │ │ │
//! │◀────────────────────│ │ │
//! │ │ │ │
//! ```
//!
//! ### Service Authentication Flow | 服务认证流程
//!
//! ```text
//! ┌──────────────────────────────────────────────────────────────────┐
//! │ Service Inter-Communication │
//! │ 服务间通信 │
//! └──────────────────────────────────────────────────────────────────┘
//!
//! Service B Service A (Session Manager) Storage
//! 服务 B 服务 A(会话管理器) 存储
//! │ │ │
//! │ 1. Register │ │
//! │ 注册服务 │ │
//! │ ├─ service_id │ │
//! │ ├─ service_name │ │
//! │ ├─ secret_key │ │
//! │ └─ permissions │ │
//! ├───────────────────────▶│ │
//! │ │ Store credentials │
//! │ │ 存储凭证 │
//! │ │ (in memory) │
//! │ │ │
//! │ 2. Registered ✅ │ │
//! │◀───────────────────────│ │
//! │ │ │
//! │ 3. Access session │ │
//! │ 访问会话 │ │
//! │ ├─ service_id │ │
//! │ ├─ secret_key │ │
//! │ └─ session_id │ │
//! ├───────────────────────▶│ │
//! │ │ 4. verify_service() │
//! │ │ 验证服务 │
//! │ │ ├─ Lookup service │
//! │ │ └─ Compare secret_key │
//! │ │ │
//! │ │ 5. get_session() │
//! │ │ 获取会话 │
//! │ ├──────────────────────────────▶│
//! │ │ │
//! │ │ 6. Return session │
//! │ │ 返回会话 │
//! │ │◀──────────────────────────────│
//! │ │ │
//! │ 7. Session data ✅ │ │
//! │◀───────────────────────│ │
//! │ │ │
//! ```
//!
//! ## Storage Backends | 存储后端
//!
//! The module is storage-agnostic. You can implement custom backends:
//! 本模块与存储无关。您可以实现自定义后端:
//!
//! ### Redis Implementation (Recommended) | Redis 实现(推荐)
//!
//! ```rust,ignore
//! use redis::AsyncCommands;
//!
//! pub struct RedisDistributedStorage {
//! client: redis::Client,
//! }
//!
//! #[async_trait]
//! impl DistributedSessionStorage for RedisDistributedStorage {
//! async fn save_session(&self, session: DistributedSession, ttl: Option<Duration>)
//! -> Result<(), SaTokenError>
//! {
//! let mut conn = self.client.get_async_connection().await?;
//! let key = format!("distributed:session:{}", session.session_id);
//! let value = serde_json::to_string(&session)?;
//!
//! if let Some(ttl) = ttl {
//! conn.set_ex(&key, value, ttl.as_secs() as usize).await?;
//! } else {
//! conn.set(&key, value).await?;
//! }
//!
//! // Index by login_id
//! let index_key = format!("distributed:login:{}", session.login_id);
//! conn.sadd(index_key, &session.session_id).await?;
//!
//! Ok(())
//! }
//!
//! // ... other methods
//! }
//! ```
//!
//! ### Database Implementation | 数据库实现
//!
//! ```rust,ignore
//! use sqlx::PgPool;
//!
//! pub struct PostgresDistributedStorage {
//! pool: PgPool,
//! }
//!
//! #[async_trait]
//! impl DistributedSessionStorage for PostgresDistributedStorage {
//! async fn save_session(&self, session: DistributedSession, ttl: Option<Duration>)
//! -> Result<(), SaTokenError>
//! {
//! let expires_at = ttl.map(|t| Utc::now() + chrono::Duration::from_std(t).unwrap());
//!
//! sqlx::query!(
//! "INSERT INTO distributed_sessions
//! (session_id, login_id, token, service_id, attributes, expires_at)
//! VALUES ($1, $2, $3, $4, $5, $6)
//! ON CONFLICT (session_id) DO UPDATE
//! SET attributes = $5, last_access = NOW()",
//! session.session_id,
//! session.login_id,
//! session.token,
//! session.service_id,
//! serde_json::to_value(&session.attributes)?,
//! expires_at,
//! )
//! .execute(&self.pool)
//! .await?;
//!
//! Ok(())
//! }
//!
//! // ... other methods
//! }
//! ```
//!
//! ## Best Practices | 最佳实践
//!
//! ### 1. Service Registration | 服务注册
//!
//! ```rust,ignore
//! // Initialize each service with unique credentials
//! // 为每个服务初始化唯一凭证
//! let credential = ServiceCredential {
//! service_id: "user-service".to_string(),
//! service_name: "User Management Service".to_string(),
//! secret_key: generate_secure_secret(), // Use crypto-secure generation
//! created_at: Utc::now(),
//! permissions: vec!["user.read".to_string(), "user.write".to_string()],
//! };
//! manager.register_service(credential).await;
//! ```
//!
//! ### 2. Session Creation with Context | 带上下文的会话创建
//!
//! ```rust,ignore
//! // Create session with user context
//! // 创建带用户上下文的会话
//! let session = manager.create_session(login_id, token).await?;
//!
//! // Add relevant attributes immediately
//! // 立即添加相关属性
//! manager.set_attribute(&session.session_id, "user_role".to_string(), "admin".to_string()).await?;
//! manager.set_attribute(&session.session_id, "department".to_string(), "IT".to_string()).await?;
//! manager.set_attribute(&session.session_id, "login_device".to_string(), "web".to_string()).await?;
//! ```
//!
//! ### 3. Cross-Service Access Pattern | 跨服务访问模式
//!
//! ```rust,ignore
//! // Service B accesses session created by Service A
//! // 服务 B 访问服务 A 创建的会话
//!
//! // 1. Verify service identity
//! // 验证服务身份
//! let service_cred = manager.verify_service("service-b", request.secret).await?;
//!
//! // 2. Check permissions
//! // 检查权限
//! if !service_cred.permissions.contains(&"session.read".to_string()) {
//! return Err(SaTokenError::PermissionDenied);
//! }
//!
//! // 3. Access session
//! // 访问会话
//! let session = manager.get_session(&request.session_id).await?;
//!
//! // 4. Refresh to keep session alive
//! // 刷新以保持会话活跃
//! manager.refresh_session(&session.session_id).await?;
//! ```
//!
//! ### 4. Multi-Device Logout | 多设备登出
//!
//! ```rust,ignore
//! // Logout from all devices
//! // 从所有设备登出
//! manager.delete_all_sessions(&login_id).await?;
//!
//! // Or logout specific session
//! // 或登出特定会话
//! manager.delete_session(&session_id).await?;
//! ```
//!
//! ### 5. Session Monitoring | 会话监控
//!
//! ```rust,ignore
//! // Monitor user's active sessions
//! // 监控用户的活跃会话
//! let sessions = manager.get_sessions_by_login_id(&login_id).await?;
//!
//! for session in sessions {
//! println!("Session: {} from service: {}, last active: {}",
//! session.session_id,
//! session.service_id,
//! session.last_access
//! );
//!
//! // Check for suspicious activity
//! // 检查可疑活动
//! if is_suspicious(&session) {
//! manager.delete_session(&session.session_id).await?;
//! }
//! }
//! ```
//!
//! ## Security Considerations | 安全考虑
//!
//! ```text
//! 1. ✅ Service Authentication | 服务认证
//! - Each service has unique secret_key
//! - Verify credentials before granting access
//! - Rotate keys periodically
//!
//! 2. ✅ Permission-Based Access | 基于权限的访问
//! - Services have explicit permissions
//! - Check permissions before operations
//! - Implement least-privilege principle
//!
//! 3. ✅ Session Timeout | 会话超时
//! - Configure appropriate TTL
//! - Auto-expire inactive sessions
//! - Refresh on active use
//!
//! 4. ✅ Data Encryption | 数据加密
//! - Encrypt sensitive session attributes
//! - Use TLS for inter-service communication
//! - Encrypt data at rest in storage
//!
//! 5. ✅ Audit Logging | 审计日志
//! - Log session creation/deletion
//! - Track cross-service access
//! - Monitor for anomalies
//! ```
use crateSaTokenError;
use async_trait;
use ;
use HashMap;
use Arc;
use Duration;
use ;
use RwLock;
/// Distributed session data structure
/// 分布式 Session 数据结构
///
/// Represents a session that can be shared across multiple services
/// 表示可以在多个服务之间共享的 Session
/// Service credential for inter-service authentication
/// 服务间认证的服务凭证
///
/// Contains service identification and permission information
/// 包含服务标识和权限信息
/// Distributed session storage trait
/// 分布式 Session 存储 trait
///
/// Implement this trait to provide custom storage backends
/// 实现此 trait 以提供自定义存储后端
/// Distributed session manager
/// 分布式 Session 管理器
///
/// Manages distributed sessions and service authentication
/// 管理分布式 Sessions 和服务认证
/// In-memory distributed session storage implementation
/// 内存分布式 Session 存储实现
///
/// For testing and development purposes
/// 用于测试和开发目的