Skip to main content

yang_base/action/auth/
logout.rs

1//! 登出 Action:撤销 Token(写入 Redis 黑名单)。
2
3use super::audit::{token_fingerprint, AuthAuditEvent, AuthAuditHook, TracingAuditHook};
4use super::dto::{LogoutInput, MessageResponse};
5use crate::action::{ActionContext, TypedHandler};
6use crate::error::BaseError;
7use async_trait::async_trait;
8use yang_base_derive::Action;
9
10// ──────────────────────────────────────────────────────────────────────────────
11// LogoutAction
12// ──────────────────────────────────────────────────────────────────────────────
13
14/// 登出 Action:按用户水位线撤销该用户此前签发的全部 Token(写入 Redis)。
15///
16/// 通过 ``revoke_by_subject`` 写入 `sub` 的最小有效签发时间水位线,早于该时刻签发的
17/// Access 与 Refresh Token 一次性失效,因此无需另行传入 Refresh Token。
18///
19/// # 所有权校验(AUTH-4)
20///
21/// 当请求携带 Bearer Token(`Authorization` 头)时,本 Action 会校验该 Bearer Token
22/// 的 `sub` 与待撤销 Token(`input.token`)的 `sub` 一致。不一致时返回
23/// [`BaseError::PermissionDenied`],防止用户撤销他人的 Token。
24///
25/// 若请求未携带 Bearer Token,则待撤销 Token 本身必须尚未撤销;失效凭据不能
26/// 再次推进用户水位线、撤销后续新会话。
27#[derive(Action, Default)]
28#[action(
29    name = "logout",
30    display_name = "登出",
31    description = "撤销 Token,使其在过期前失效",
32    public
33)]
34pub struct LogoutAction<A: AuthAuditHook = TracingAuditHook> {
35    audit: A,
36}
37
38impl LogoutAction<TracingAuditHook> {
39    /// 创建 LogoutAction(默认 tracing 审计钩子)。
40    pub fn new() -> Self {
41        Self {
42            audit: TracingAuditHook,
43        }
44    }
45}
46
47impl<A: AuthAuditHook> LogoutAction<A> {
48    /// 用自定义审计钩子创建 LogoutAction。
49    pub fn with_audit(audit: A) -> Self {
50        Self { audit }
51    }
52}
53
54#[async_trait]
55impl<A: AuthAuditHook> TypedHandler for LogoutAction<A> {
56    type Input = LogoutInput;
57    type Output = MessageResponse;
58
59    async fn handle(
60        &self,
61        ctx: ActionContext,
62        input: LogoutInput,
63    ) -> Result<MessageResponse, BaseError> {
64        let request_id = ctx.request_id.to_string();
65        let manager = ctx.tools().token()?;
66
67        let run = async {
68            // 有效 Bearer 可授权同用户撤销;匿名调用须由目标凭据自身授权。
69            let target_claims = manager.verify_token(&input.token)?;
70
71            // 若请求携带 Bearer Token,校验其 sub 与待撤销 Token 的 sub 一致
72            if let Some(bearer_token) = ctx.request.token() {
73                // Bearer Token 需完整验证(含黑名单),确保调用者身份有效
74                let caller_claims = manager
75                    .verify_token_checked(bearer_token, crate::token::TokenType::Access)
76                    .await?;
77                if caller_claims.sub != target_claims.sub {
78                    return Err(BaseError::PermissionDenied(
79                        "只能撤销自己的 Token".to_string(),
80                    ));
81                }
82            } else {
83                manager
84                    .verify_token_checked(&input.token, target_claims.token_type)
85                    .await?;
86            }
87
88            // CONC-1:用 subject 水位线一次性原子撤销该用户所有 Token
89            //(Access + Refresh + 任何其他已签发 Token),避免双 revoke 非原子竞态。
90            // 水位线 TTL 取 Access/Refresh 有效期较大值,早于此时间签发的 Token 全部失效。
91            manager.revoke_by_subject(&target_claims.sub).await?;
92            Ok::<(), BaseError>(())
93        };
94
95        match run.await {
96            Ok(()) => {
97                // subject 用 Access Token 指纹标识(不泄漏原文)
98                self.audit
99                    .on_success(AuthAuditEvent {
100                        request_id,
101                        action: "logout",
102                        subject: Some(token_fingerprint(&input.token)),
103                        error_code: None,
104                    })
105                    .await;
106                Ok(MessageResponse {
107                    message: "已登出".to_string(),
108                })
109            }
110            Err(e) => {
111                self.audit
112                    .on_failure(AuthAuditEvent {
113                        request_id,
114                        action: "logout",
115                        subject: Some(token_fingerprint(&input.token)),
116                        error_code: Some(e.code_str()),
117                    })
118                    .await;
119                Err(e)
120            }
121        }
122    }
123}