mll-axum-utils 0.2.1

一个 Axum 的工具库
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

use std::{
    sync::Arc,
    task::{Context, Poll},
    time::{SystemTime, UNIX_EPOCH},
};

use axum::extract::FromRequestParts;
use axum::http::request::Parts;
use axum::http::HeaderMap;
use axum::{
    async_trait,
    body::Body,
    headers::{authorization::Bearer, Authorization, HeaderMapExt},
    http::Request,
    response::{IntoResponse, Response},
};
use futures_util::future::BoxFuture;
use jsonwebtoken::{DecodingKey, EncodingKey, Validation};
use serde::{Deserialize, Serialize};
use tower::{Layer, Service};

use crate::res::Res;

/// 验证 token 并解析 token 携带的数据
#[must_use]
#[derive(Debug, Clone)]
pub struct Jwt<T: JwtToken>(pub T);

#[async_trait]
impl<T, S> FromRequestParts<S> for Jwt<T>
where
    T: JwtToken,
    S: Send + Sync,
{
    type Rejection = Response;
    async fn from_request_parts(parts: &mut Parts, _: &S) -> Result<Self, Self::Rejection> {
        let claims = auth_token::<T>(&parts.headers)?;
        Ok(Jwt(claims))
    }
}

fn auth_token<T: JwtToken>(header: &HeaderMap) -> Result<T, Response> {
    let auth = header
        .typed_get::<Authorization<Bearer>>()
        .ok_or(Res::msg(401, "请求未携带有效token").into_response())?;

    let claims = T::decode(auth.token()).map_err(|err| err.into_response())?;

    Ok(claims)
}

/// # Examples
/// ```no_run,ignore
/// use std::net::SocketAddr;
/// use axum::{Router,Json,Extension};
/// use axum::routing::{get, post};
/// use mll_axum_utils::middleware::jwt::{JwtAuth,JwtToken};
/// use mll_axum_utils::middleware::logger::Logger;
/// use mll_axum_utils::res::{Res, SendRes};
/// use serde::{Serialize,Deserialize};
///
/// #[tokio::main]
/// async fn main() {
/// let addr = "127.0.0.1:3000";
///     let app = Router::new()
///         .route("/index", get(index))
///         .route("/login", post(login))
///         .layer(JwtAuth::<Claims>::new(vec!["/login"]))
///         .layer(Logger::default());
///
///     axum::Server::bind(&addr.parse().unwrap())
///         .serve(app.into_make_service_with_connect_info::<SocketAddr>())
///         .await
///         .unwrap();
/// }
///
/// async fn login(Json(user): Json<User>) -> SendRes<String> {
/// use mll_axum_utils::res::SendRes;
/// let token = Claims::new(user).encode()?;
///     // some validation
///     Ok(Res::ok("登录成功", token))
/// }
///
/// async fn index(Extension(token): Extension<Claims>) -> &'static str {
///     println!("{:?}", token);
///     "身份认证成功 允许访问"
/// }
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct User {
///     uid: u64,
///     name: String,
/// }
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct Claims {
///     exp: u64,
///     user: User,
/// }
///
/// impl JwtToken for Claims {}
/// impl Claims {
///     fn new(user: User) -> Self {
///         Self {
///             exp: Self::expiration(),
///             user,
///         }
///     }
/// }
/// ```
#[derive(Clone)]
pub struct JwtAuth<T> {
    filter: Arc<Vec<&'static str>>,
    claims: Arc<Option<T>>,
}

impl<T> JwtAuth<T>
where
    T: JwtToken,
{
    pub fn new(filter: Vec<&'static str>) -> Self {
        Self {
            filter: Arc::new(filter),
            claims: Arc::new(None),
        }
    }
}

impl<S, T> Layer<S> for JwtAuth<T>
where
    T: JwtToken,
{
    type Service = JwtAuthService<S, T>;

    fn layer(&self, inner: S) -> Self::Service {
        JwtAuthService {
            inner,
            filter: self.filter.clone(),
            claims: self.claims.clone(),
        }
    }
}

#[allow(dead_code)]
#[derive(Clone)]
pub struct JwtAuthService<S, T> {
    inner: S,
    filter: Arc<Vec<&'static str>>,
    claims: Arc<Option<T>>,
}

impl<S, T> Service<Request<Body>> for JwtAuthService<S, T>
where
    T: JwtToken + Default + Sync + Send + 'static,
    S: Service<Request<Body>, Response = Response> + Send + 'static,
    S::Future: Send + 'static,
{
    type Response = S::Response;
    type Error = S::Error;
    type Future = BoxFuture<'static, Result<Self::Response, Self::Error>>;

    fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        self.inner.poll_ready(cx)
    }

    fn call(&mut self, mut req: Request<Body>) -> Self::Future {
        let mut response = None;

        if !self.filter.contains(&req.uri().path()) {
            match auth_token::<T>(req.headers()) {
                Ok(claims) => {
                    req.extensions_mut().insert(claims);
                }
                Err(err_res) => response = Some(err_res),
            }
        }

        let future = self.inner.call(req);
        Box::pin(async move {
            let response = match response {
                Some(v) => v,
                None => future.await?,
            };
            Ok(response)
        })
    }
}

/// # Examples
/// ```no_run,ignore
/// use mll_axum_utils::middleware::jwt::JwtToken;
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct User {
///     uid: u64,
///     name: String,
/// }
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct Claims {
///     exp: u64,
///     user: User,
/// }
///
/// impl JwtToken for Claims {
///     const SECRET: &'static str = "new_key";
/// }
/// impl Claims {
///     fn new(user: User) -> Self {
///         Self {
///             exp: Self::expiration(),
///             user,
///         }
///     }
/// }
/// ```
pub trait JwtToken
where
    Self: Serialize + for<'a> Deserialize<'a>,
{
    /// token key
    const SECRET: &'static str = "my_key";

    /// token 持续时间 默认15天 单位 s
    const DURATION: u64 = 60 * 60 * 24 * 15;

    /// token 编码
    fn encode(&self) -> Result<String, Res<()>> {
        let res = jsonwebtoken::encode(
            &jsonwebtoken::Header::default(),
            self,
            &EncodingKey::from_secret(Self::SECRET.as_bytes()),
        );

        res.map_err(|err| Res::error(err.to_string()))
    }

    /// token 解码
    fn decode(token: &str) -> Result<Self, Res<()>> {
        let res = jsonwebtoken::decode::<Self>(
            token,
            &DecodingKey::from_secret(Self::SECRET.as_bytes()),
            &Validation::default(),
        );
        match res {
            Ok(res) => Ok(res.claims),
            Err(err) => Err(Res::msg(401, err.to_string())),
        }
    }

    /// token 过期时间: 当前时间 + Self::DURATION
    fn expiration() -> u64 {
        let timestamp = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_secs();
        timestamp + Self::DURATION
    }
}