tideway 0.7.17

A batteries-included Rust web framework built on Axum for building SaaS applications quickly
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
use crate::app::AuthProviderExtension;
use crate::auth::{provider::AuthProvider, token::TokenExtractor};
use crate::error::TidewayError;
use axum::{extract::FromRequestParts, http::request::Parts};
#[cfg(feature = "test-auth-bypass")]
use base64::Engine;
use std::future::Future;
use std::sync::Arc;

fn resolve_provider<P: AuthProvider>(parts: &Parts) -> Result<P, TidewayError> {
    if let Some(provider) = parts.extensions.get::<P>() {
        return Ok(provider.clone());
    }

    if let Some(provider) = parts.extensions.get::<AuthProviderExtension>() {
        if let Some(typed) = provider.0.downcast_ref::<P>() {
            return Ok(typed.clone());
        }
    }

    Err(TidewayError::internal(
        "Auth provider not found in request extensions",
    ))
}

#[cfg(feature = "test-auth-bypass")]
pub(crate) const TEST_USER_ID_HEADER: &str = "X-Test-User-Id";
#[cfg(feature = "test-auth-bypass")]
pub(crate) const TEST_CLAIMS_HEADER: &str = "X-Test-Claims";

#[cfg(feature = "test-auth-bypass")]
pub(crate) fn encode_test_claims_header<T: serde::Serialize>(claims: &T) -> String {
    let json = serde_json::to_vec(claims).expect("test claims should serialize");
    base64::engine::general_purpose::URL_SAFE_NO_PAD.encode(json)
}

#[cfg(feature = "test-auth-bypass")]
fn decode_test_claims_header<P: AuthProvider>(
    parts: &Parts,
) -> Result<Option<P::Claims>, TidewayError> {
    let Some(raw) = parts.headers.get(TEST_CLAIMS_HEADER) else {
        return Ok(None);
    };

    let raw = raw
        .to_str()
        .map_err(|_| TidewayError::unauthorized("Invalid X-Test-Claims header"))?;
    let bytes = base64::engine::general_purpose::URL_SAFE_NO_PAD
        .decode(raw)
        .map_err(|_| TidewayError::unauthorized("Invalid X-Test-Claims encoding"))?;

    serde_json::from_slice(&bytes).map(Some).map_err(|error| {
        TidewayError::unauthorized(format!("Invalid X-Test-Claims payload: {error}"))
    })
}

#[cfg(feature = "test-auth-bypass")]
pub(crate) async fn resolve_test_claims<P: AuthProvider>(
    parts: &Parts,
    provider: &P,
) -> Result<Option<P::Claims>, TidewayError> {
    if let Some(claims) = decode_test_claims_header::<P>(parts)? {
        return Ok(Some(claims));
    }

    let Some(user_id) = parts.headers.get(TEST_USER_ID_HEADER) else {
        return Ok(None);
    };

    let user_id = user_id
        .to_str()
        .map_err(|_| TidewayError::unauthorized("Invalid X-Test-User-Id header"))?;

    provider.test_claims(user_id).await.map(Some)
}

/// Trait for users that can be administrators.
///
/// Implement this trait on your user type to enable admin-only route protection.
///
/// # Example
///
/// ```rust,ignore
/// impl AdminUser for User {
///     fn is_admin(&self) -> bool {
///         self.is_platform_admin
///     }
/// }
/// ```
pub trait AdminUser {
    /// Returns true if this user has administrator privileges.
    fn is_admin(&self) -> bool;
}

/// Axum extractor for authenticated users
///
/// Use this in your handler to require authentication.
/// The request will be rejected with 401 if authentication fails.
///
/// # Type Parameters
///
/// * `P` - The AuthProvider type
///
/// # Example
///
/// ```rust,ignore
/// async fn protected_handler(
///     AuthUser(user): AuthUser<MyAuthProvider>
/// ) -> Json<UserData> {
///     Json(UserData {
///         id: user.id,
///         email: user.email,
///     })
/// }
/// ```
pub struct AuthUser<P: AuthProvider>(pub P::User);

impl<P, S> FromRequestParts<S> for AuthUser<P>
where
    P: AuthProvider,
    S: Send + Sync,
{
    type Rejection = TidewayError;

    fn from_request_parts(
        parts: &mut Parts,
        _state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send {
        Box::pin(async move {
            // Extract the auth provider from the app state
            let provider = resolve_provider::<P>(parts)?;

            // Reuse cached user if already loaded by middleware
            if let Some(user) = parts.extensions.get::<P::User>().cloned() {
                return Ok(AuthUser(user));
            }

            #[cfg(feature = "test-auth-bypass")]
            {
                if let Some(claims) = resolve_test_claims(parts, &provider).await? {
                    let claims = Arc::new(claims);
                    let user = provider.load_user(&claims).await?;
                    provider.validate_user(&user).await?;

                    parts.extensions.insert(user.clone());
                    parts.extensions.insert(Arc::clone(&claims));

                    return Ok(AuthUser(user));
                }
            }

            // Extract token from Authorization header
            let token = TokenExtractor::from_header(parts)?;

            // Verify token and get claims
            let claims = Arc::new(provider.verify_token(&token).await?);

            // Load user from claims
            let user = provider.load_user(&claims).await?;

            // Validate user (optional business logic)
            provider.validate_user(&user).await?;

            // Cache user + claims for downstream extractors in the same request.
            parts.extensions.insert(user.clone());
            // Cache verified claims after successful user validation
            parts.extensions.insert(Arc::clone(&claims));

            Ok(AuthUser(user))
        })
    }
}

/// Axum extractor for optional authentication
///
/// Use this when authentication is optional.
/// Returns Some(user) if authenticated, None if not.
/// Does not reject the request if authentication fails.
///
/// # Example
///
/// ```rust,ignore
/// async fn handler(
///     OptionalAuth(user): OptionalAuth<MyAuthProvider>
/// ) -> Json<Response> {
///     if let Some(user) = user {
///         Json(Response::Authenticated { user_id: user.id })
///     } else {
///         Json(Response::Anonymous)
///     }
/// }
/// ```
pub struct OptionalAuth<P: AuthProvider>(pub Option<P::User>);

impl<P, S> FromRequestParts<S> for OptionalAuth<P>
where
    P: AuthProvider,
    S: Send + Sync,
{
    type Rejection = TidewayError;

    fn from_request_parts(
        parts: &mut Parts,
        _state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send {
        Box::pin(async move {
            // Try to get the auth provider
            let provider = match resolve_provider::<P>(parts) {
                Ok(provider) => provider,
                Err(_) => return Ok(OptionalAuth(None)),
            };

            // Reuse cached user if already loaded by middleware
            if let Some(user) = parts.extensions.get::<P::User>().cloned() {
                return Ok(OptionalAuth(Some(user)));
            }

            #[cfg(feature = "test-auth-bypass")]
            {
                if let Some(claims) = resolve_test_claims(parts, &provider).await? {
                    let claims = Arc::new(claims);
                    match provider.load_user(&claims).await {
                        Ok(user) => {
                            if provider.validate_user(&user).await.is_ok() {
                                parts.extensions.insert(user.clone());
                                parts.extensions.insert(Arc::clone(&claims));
                                return Ok(OptionalAuth(Some(user)));
                            }
                        }
                        Err(_) => return Ok(OptionalAuth(None)),
                    }

                    return Ok(OptionalAuth(None));
                }
            }

            // Try to extract token
            let token = match TokenExtractor::from_header(parts) {
                Ok(t) => t,
                Err(_) => return Ok(OptionalAuth(None)),
            };

            // Try to verify and load user
            match provider.verify_token(&token).await {
                Ok(claims) => {
                    let claims = Arc::new(claims);
                    match provider.load_user(&claims).await {
                        Ok(user) => {
                            // Validate user
                            if provider.validate_user(&user).await.is_ok() {
                                // Cache user + claims for downstream extractors in the same request.
                                parts.extensions.insert(user.clone());
                                // Cache verified claims after successful user validation
                                parts.extensions.insert(Arc::clone(&claims));
                                Ok(OptionalAuth(Some(user)))
                            } else {
                                Ok(OptionalAuth(None))
                            }
                        }
                        Err(_) => Ok(OptionalAuth(None)),
                    }
                }
                Err(_) => Ok(OptionalAuth(None)),
            }
        })
    }
}

/// Helper extractor for accessing just the JWT claims without loading the full user
///
/// Useful when you only need to verify authentication but don't need
/// to query the database for user details.
///
/// # Example
///
/// ```rust,ignore
/// async fn handler(
///     Claims(claims): Claims<MyAuthProvider>
/// ) -> String {
///     format!("User ID: {}", claims.sub)
/// }
/// ```
pub struct Claims<P: AuthProvider>(pub P::Claims);

impl<P, S> FromRequestParts<S> for Claims<P>
where
    P: AuthProvider,
    S: Send + Sync,
{
    type Rejection = TidewayError;

    fn from_request_parts(
        parts: &mut Parts,
        _state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send {
        Box::pin(async move {
            let provider = resolve_provider::<P>(parts)?;

            #[cfg(feature = "test-auth-bypass")]
            {
                if let Some(claims) = resolve_test_claims(parts, &provider).await? {
                    return Ok(Claims(claims));
                }
            }

            let token = TokenExtractor::from_header(parts)?;
            let claims = provider.verify_token(&token).await?;

            Ok(Claims(claims))
        })
    }
}

/// Axum extractor that reuses cached claims if available.
///
/// This avoids re-verifying the token when claims were already verified earlier
/// in the same request (e.g., by auth middleware).
pub struct ClaimsRef<P: AuthProvider>(pub Arc<P::Claims>);

impl<P, S> FromRequestParts<S> for ClaimsRef<P>
where
    P: AuthProvider,
    S: Send + Sync,
{
    type Rejection = TidewayError;

    fn from_request_parts(
        parts: &mut Parts,
        _state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send {
        Box::pin(async move {
            if let Some(claims) = parts.extensions.get::<Arc<P::Claims>>() {
                return Ok(ClaimsRef(Arc::clone(claims)));
            }

            let provider = resolve_provider::<P>(parts)?;

            #[cfg(feature = "test-auth-bypass")]
            {
                if let Some(claims) = resolve_test_claims(parts, &provider).await? {
                    let claims = Arc::new(claims);
                    parts.extensions.insert(Arc::clone(&claims));
                    return Ok(ClaimsRef(claims));
                }
            }

            let token = TokenExtractor::from_header(parts)?;
            let claims = Arc::new(provider.verify_token(&token).await?);
            parts.extensions.insert(Arc::clone(&claims));

            Ok(ClaimsRef(claims))
        })
    }
}

/// Axum extractor for admin-only routes.
///
/// Use this in your handler to require admin privileges.
/// The request will be rejected with 401 if not authenticated,
/// or 403 if authenticated but not an admin.
///
/// Requires your user type to implement the [`AdminUser`] trait.
///
/// # Type Parameters
///
/// * `P` - The AuthProvider type (user type must implement AdminUser)
///
/// # Example
///
/// ```rust,ignore
/// use tideway::auth::{RequireAdmin, AdminUser};
///
/// impl AdminUser for User {
///     fn is_admin(&self) -> bool {
///         self.is_platform_admin
///     }
/// }
///
/// async fn admin_only_handler(
///     RequireAdmin(user): RequireAdmin<MyAuthProvider>
/// ) -> Json<AdminData> {
///     // Only admins can reach here
///     Json(AdminData { ... })
/// }
/// ```
pub struct RequireAdmin<P: AuthProvider>(pub P::User)
where
    P::User: AdminUser;

impl<P, S> FromRequestParts<S> for RequireAdmin<P>
where
    P: AuthProvider,
    P::User: AdminUser,
    S: Send + Sync,
{
    type Rejection = TidewayError;

    fn from_request_parts(
        parts: &mut Parts,
        _state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send {
        Box::pin(async move {
            // Extract the auth provider from the app state
            let provider = resolve_provider::<P>(parts)?;

            // Reuse cached user if already loaded by middleware
            if let Some(user) = parts.extensions.get::<P::User>().cloned() {
                if !user.is_admin() {
                    return Err(TidewayError::forbidden("Admin privileges required"));
                }
                return Ok(RequireAdmin(user));
            }

            #[cfg(feature = "test-auth-bypass")]
            {
                if let Some(claims) = resolve_test_claims(parts, &provider).await? {
                    let claims = Arc::new(claims);
                    let user = provider.load_user(&claims).await?;
                    provider.validate_user(&user).await?;
                    parts.extensions.insert(Arc::clone(&claims));

                    if !user.is_admin() {
                        return Err(TidewayError::forbidden("Admin privileges required"));
                    }

                    return Ok(RequireAdmin(user));
                }
            }

            // Extract token from Authorization header
            let token = TokenExtractor::from_header(parts)?;

            // Verify token and get claims
            let claims = Arc::new(provider.verify_token(&token).await?);

            // Load user from claims
            let user = provider.load_user(&claims).await?;

            // Validate user (optional business logic)
            provider.validate_user(&user).await?;

            // Cache verified claims after successful user validation
            parts.extensions.insert(Arc::clone(&claims));

            // Check admin privileges
            if !user.is_admin() {
                return Err(TidewayError::forbidden("Admin privileges required"));
            }

            Ok(RequireAdmin(user))
        })
    }
}