uxar 0.1.5

Opinionated Rust web framework built on Axum for Postgres-backed JSON APIs
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

use std::any::Any;
use std::hash::{Hash, Hasher};
use std::sync::Arc;

use super::site::Site;
use axum::http::request::Parts;
use thiserror::Error;
use axum::http::{header, StatusCode};
use axum::response::{IntoResponse, Response};
use axum_extra::extract::cookie::{self, Cookie};
use axum_extra::extract::CookieJar;
use jsonwebtoken::{decode, encode, Algorithm, DecodingKey, EncodingKey, Validation};
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use time;
use base64::{Engine as _, engine::general_purpose::STANDARD};
use ring::{pbkdf2, rand::{SystemRandom, SecureRandom}, digest};
use std::fmt::Write as _;
use std::num::NonZeroU32;

pub use crate::roles::{BitRole, Permit, PermitAll, PermitAny, RoleType, format_roles};
pub use crate::permit;

const DEFAULT_PBKDF2_ITERATIONS: u32 = 260_000;
const UNUSABLE_PASSWORD_PREFIX: &str = "!";
const UNUSABLE_PASSWORD_SUFFIX_LEN: usize = 40;



#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct CookieConf {
    pub name: String,
    pub path: String,
    pub http_only: bool,
    pub secure: bool,
    pub same_site: String,
}

impl Default for CookieConf {
    fn default() -> Self {
        return CookieConf {
            name: "".to_string(),
            path: "/".to_string(),
            http_only: true,
            secure: true,
            same_site: "Lax".to_string(),
        };
    }
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct AuthConf {
    pub access_ttl: i64,
    pub refresh_ttl: i64,
    pub access_cookie: Option<CookieConf>,
    pub refresh_cookie: Option<CookieConf>,
}

impl Default for AuthConf {
    fn default() -> Self {
        return AuthConf {
            access_ttl: 3600,
            refresh_ttl: 604800,
            access_cookie: Some(CookieConf{
                name: "access_token".to_string(),
                ..Default::default()
            }),
            refresh_cookie: Some(CookieConf{
                name: "refresh_token".to_string(),
                same_site: "Strict".to_string(),
                ..Default::default()
            }),
        };
    }
}


fn extract_token(parts: &Parts) -> Option<&str> {
    let header = parts.headers.get(header::AUTHORIZATION)?;
    let value = header.as_bytes();
    if value.len() > 4 && value[..4].eq_ignore_ascii_case(b"JWT ") {
        std::str::from_utf8(&value[4..]).ok()
    } else {
        None
    }
}

fn unix_timestamp() -> i64 {
    chrono::Utc::now().timestamp()
}

fn to_hex(input: &[u8]) -> String {
    let mut out = String::with_capacity(input.len() * 2);
    for b in input {
        let _ = write!(&mut out, "{:02x}", b);
    }
    out
}

/// Create a Django-compatible unusable password marker.
///
/// Django marks unusable passwords with a value that starts with `!`.
pub fn unusable_password() -> Result<String, AuthError> {
    let rng = SystemRandom::new();
    let mut buf = [0u8; UNUSABLE_PASSWORD_SUFFIX_LEN / 2];
    rng.fill(&mut buf)
        .map_err(|_| AuthError::InternalError("rng error".to_string()))?;
    Ok(format!("{}{}", UNUSABLE_PASSWORD_PREFIX, to_hex(&buf)))
}

/// Create a Django-compatible password hash using PBKDF2.
///
/// Format returned: `<algorithm>$<iterations>$<salt>$<hash>`
/// Supported algorithms: `pbkdf2_sha256`, `pbkdf2_sha1`
pub fn make_password(password: &str, salt: Option<&str>, algorithm: Option<&str>) -> Result<String, AuthError> {
    let alg = algorithm.unwrap_or("pbkdf2_sha256");
    let iterations = DEFAULT_PBKDF2_ITERATIONS;
    let salt = match salt {
        Some(s) => s.to_string(),
        None => {
            let rng = SystemRandom::new();
            let mut buf = [0u8; 16];
            rng.fill(&mut buf).map_err(|_| AuthError::InternalError("rng error".to_string()))?;
            STANDARD.encode(buf)
        }
    };

    let n = NonZeroU32::new(iterations).ok_or(AuthError::InternalError("invalid iterations".to_string()))?;

    match alg {
        "pbkdf2_sha256" => {
            let mut dk = [0u8; digest::SHA256_OUTPUT_LEN];
            pbkdf2::derive(pbkdf2::PBKDF2_HMAC_SHA256, n, salt.as_bytes(), password.as_bytes(), &mut dk);
            let hash = STANDARD.encode(dk);
            Ok(format!("{}${}${}${}", alg, iterations, salt, hash))
        }
        "pbkdf2_sha1" => {
            let mut dk = [0u8; digest::SHA1_OUTPUT_LEN];
            pbkdf2::derive(pbkdf2::PBKDF2_HMAC_SHA1, n, salt.as_bytes(), password.as_bytes(), &mut dk);
            let hash = STANDARD.encode(dk);
            Ok(format!("{}${}${}${}", alg, iterations, salt, hash))
        }
        _ => Err(AuthError::InternalError(format!("unsupported algorithm: {}", alg))),
    }
}

/// Verify a Django-compatible password hash. Returns `Ok(true)` when passwords match.
pub fn check_password(password: &str, encoded: &str) -> Result<bool, AuthError> {
    if encoded.starts_with(UNUSABLE_PASSWORD_PREFIX) {
        return Ok(false);
    }

    let parts: Vec<&str> = encoded.split('$').collect();
    if parts.len() != 4 {
        return Err(AuthError::InternalError("invalid password hash format".to_string()));
    }
    let alg = parts[0];
    let iterations: u32 = parts[1].parse().map_err(|_| AuthError::InternalError("invalid iterations".to_string()))?;
    let salt = parts[2];
    let hash_b64 = parts[3];
    let decoded = STANDARD.decode(hash_b64).map_err(|_| AuthError::InternalError("invalid base64".to_string()))?;

    let n = NonZeroU32::new(iterations).ok_or(AuthError::InternalError("invalid iterations".to_string()))?;

    match alg {
        "pbkdf2_sha256" => {
            let res = pbkdf2::verify(pbkdf2::PBKDF2_HMAC_SHA256, n, salt.as_bytes(), password.as_bytes(), &decoded);
            Ok(res.is_ok())
        }
        "pbkdf2_sha1" => {
            let res = pbkdf2::verify(pbkdf2::PBKDF2_HMAC_SHA1, n, salt.as_bytes(), password.as_bytes(), &decoded);
            Ok(res.is_ok())
        }
        _ => Err(AuthError::InternalError(format!("unsupported algorithm: {}", alg))),
    }
}

#[derive(Debug, Serialize, Deserialize)]
pub struct TokenPair{
    pub access_token: String,
    pub refresh_token: String,
}

#[derive(Clone)]
pub struct Authenticator {
    access_ttl: i64,
    refresh_ttl: i64,    
    access_cookie_conf: Option<CookieConf>,
    refresh_cookie_conf: Option<CookieConf>,
    access_cookie_same_site: cookie::SameSite,
    refresh_cookie_same_site: cookie::SameSite,
    algorithm: Algorithm,
    encoding_key: EncodingKey,
    decoding_key: DecodingKey,
    validation: Validation,
}

impl std::fmt::Debug for Authenticator {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Authenticator")
            .field("access_ttl", &self.access_ttl)
            .field("refresh_ttl", &self.refresh_ttl)
            .field("access_cookie_conf", &self.access_cookie_conf)
            .field("refresh_cookie_conf", &self.refresh_cookie_conf)
            .field("algorithm", &self.algorithm)
            .finish()
    }
}

fn get_cookie_same_site(cookie_conf: &Option<CookieConf>) -> cookie::SameSite {
    if let Some(conf) = cookie_conf {
        match conf.same_site.to_lowercase().as_str() {
            "lax" => cookie::SameSite::Lax,
            "strict" => cookie::SameSite::Strict,
            "none" => cookie::SameSite::None,
            _ => cookie::SameSite::Lax,
        }
    } else {
        cookie::SameSite::Lax
    }
}

impl Authenticator {

    pub(crate) fn new(
        conf: &AuthConf,
        secret_key: &str,
    ) -> Self {
        let secret_key = secret_key.as_bytes();
        let access_ttl = conf.access_ttl;
        let refresh_ttl = conf.refresh_ttl;
        let access_cookie_conf = conf.access_cookie.clone();
        let refresh_cookie_conf = conf.refresh_cookie.clone();
        let algorithm = Algorithm::HS256;
        let encoding_key = EncodingKey::from_secret(secret_key);
        let decoding_key = DecodingKey::from_secret(secret_key);
        let validation = Validation::new(algorithm);
        
        Self {
            access_ttl,
            refresh_ttl,
            access_cookie_same_site: get_cookie_same_site(&access_cookie_conf),
            refresh_cookie_same_site: get_cookie_same_site(&refresh_cookie_conf),
            access_cookie_conf,
            refresh_cookie_conf,
            algorithm,
            encoding_key,
            decoding_key,
            validation,
        }
    }

    pub fn encode(&self, item: &JWTClaim) -> Result<String, AuthError> {
        let key = &self.encoding_key;
        let header = jsonwebtoken::Header::new(self.algorithm);
        encode(&header, item, &key).map_err(|e| AuthError::from(&e))
    }

    pub fn decode(&self, token: &str) -> Result<JWTClaim, AuthError> {
        let key = &self.decoding_key;
        decode::<JWTClaim>(&token, &key, &self.validation)
            .map(|o| o.claims)
            .map_err(|e| AuthError::from(&e))
    }

    pub fn extract_claims(&self, parts: &Parts, refresh: bool) -> Result<JWTClaim, AuthError> {
        let cookies_conf = if refresh{
            &self.refresh_cookie_conf
        } else {
            &self.access_cookie_conf    
        };
        let token = extract_token(parts)
            .map(|t| t.to_owned())
            .or_else(|| {
                cookies_conf
                    .as_ref()
                    .map(|c| c.name.as_str())
                    .and_then(|cookie_name| {
                        CookieJar::from_headers(&parts.headers)
                            .get(cookie_name)
                            .map(|c| c.value().to_owned())
                    })
            })
            .ok_or(AuthError::MissingToken)?;
        let claims = self.decode(&token)?;        
        return Ok(claims);
    }

    pub fn extract_user(&self, parts: &Parts, aud: &[&str], refresh: bool) -> Result<AuthUser, AuthError> {
        let claims = self.extract_claims(parts, refresh)?;
        if !claims.aud.is_empty() && !aud.is_empty() {
            if !claims.aud.iter().any(|a| {aud.iter().any(|&b| a == b)}) {
                return Err(AuthError::Forbidden);
            }
        }
        let user = claims.into_auth_user();
        return Ok(user);
    }

    pub fn create_token_pair(&self, user: AuthUser, aud: &[&str]) -> Result<TokenPair, AuthError> {
        let aud: Vec<String> = aud.iter().map(|&s| s.to_string()).collect();
        let access_claims = JWTClaim::new(&user, "", aud.clone(), self.access_ttl);
        let access_token = self.encode(&access_claims)?;
        let mut refresh_claims = JWTClaim::new(&user, "", aud, self.refresh_ttl);
        refresh_claims.refresh = true;
        let refresh_token = self.encode(&refresh_claims)?;
        Ok(TokenPair { access_token, refresh_token})
    }

    pub fn login_token(&self, token: &str, refresh: bool, resp: &mut Response) {
        let cookie_conf = if refresh {
            &self.refresh_cookie_conf
        } else {
            &self.access_cookie_conf
        };
        let same_site = if refresh {
            self.refresh_cookie_same_site
        } else {
            self.access_cookie_same_site
        };
        let access_ttl = if refresh {
            self.refresh_ttl
        } else {
            self.access_ttl
        };
        if let Some(conf) = cookie_conf {
            let c = Cookie::build((&conf.name, token))
                .path(conf.path.as_str())
                .max_age(time::Duration::seconds(access_ttl))
                .http_only(conf.http_only)
                .same_site(same_site)
                .secure(conf.secure)
                .build();

            match c.to_string().parse() {
                Ok(hv) => {
                    resp.headers_mut().append(header::SET_COOKIE, hv);
                }
                Err(err) => {
                    *resp.status_mut() = axum::http::StatusCode::INTERNAL_SERVER_ERROR;
                    resp.headers_mut().insert(
                        axum::http::header::CONTENT_TYPE,
                        axum::http::HeaderValue::from_static("text/plain"),
                    );
                    *resp.body_mut() = err.to_string().into();
                }
            }
        }
    }

    pub fn login_user(&self, user: AuthUser, aud: &[&str], resp: &mut Response)->Result<TokenPair, AuthError>{
        let pair = self.create_token_pair(user, aud)?;
        self.login_token(&pair.access_token, false, resp);
        self.login_token(&pair.refresh_token, true, resp);
        Ok(pair)
    }

    pub fn refresh(&self, parts: &Parts, aud: &[&str]) -> Result<TokenPair, AuthError> {
        // generate refresh token and bind it to cookie just like login
        let user = self.extract_user(parts, aud, true)?;
        let pair = self.create_token_pair(user, aud)?;
        return Ok(pair)
    }

    pub fn logout(&self, refresh: bool, resp: &mut Response) {
        let cookie_conf = if refresh {
            &self.refresh_cookie_conf
        } else {
            &self.access_cookie_conf
        };
        if let Some(conf) = cookie_conf.as_ref() {
            let c = Cookie::build((conf.name.as_str(), ""))
                .path(conf.path.as_str())
                .max_age(time::Duration::seconds(0))
                .build();
            match c.to_string().parse() {
                Ok(hv) => {
                    resp.headers_mut().append(header::SET_COOKIE, hv);
                }
                Err(err) => {
                    *resp.status_mut() = axum::http::StatusCode::INTERNAL_SERVER_ERROR;
                    resp.headers_mut().insert(
                        axum::http::header::CONTENT_TYPE,
                        axum::http::HeaderValue::from_static("text/plain"),
                    );
                    *resp.body_mut() = err.to_string().into();
                }
            }
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AuthUser {
    pub key: Arc<str>,
    pub roles: u64,
}

impl AuthUser {
    pub fn new(key: &str, roles: u64) -> Self {
        Self {
            key: Arc::from(key),
            roles,
        }
    }
}

impl PartialEq for AuthUser {
    fn eq(&self, other: &Self) -> bool {
        self.key.eq(&other.key)
    }
}

impl Eq for AuthUser {}

impl Hash for AuthUser {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.key.hash(state);
    }
}


#[derive(Serialize, Deserialize, Debug)]
pub struct JWTClaim {
    #[serde(default)]
    kid: String,
    #[serde(default)]
    jti: String,
    #[serde(default)]
    sub: String,
    #[serde(default)]
    aud: Vec<String>,
    iat: i64,
    exp: i64,
    #[serde(default)]
    refresh: bool,
    #[serde(default)]
    roles: u64,
}

impl JWTClaim {
    pub fn new(user: &AuthUser, kid: &str, aud: Vec<String>, ttl: i64) -> Self {
        let now = unix_timestamp();
        Self {
            kid: kid.to_string(),
            jti: uuid::Uuid::new_v4().to_string(),
            sub: user.key.to_string(),
            aud,
            iat: now,
            exp: now + ttl,
            refresh: false,
            roles: user.roles,
        }
    }

    fn into_auth_user(self) -> AuthUser {
        AuthUser {
            key: Arc::from(self.sub),
            roles: self.roles,
        }
    }

}



#[derive(Debug, Error)]
pub enum AuthError {
    #[error("invalid token")]
    InvalidToken,
    #[error("missing token")]
    MissingToken,
    #[error("expired token")]
    ExpiredToken,
    #[error("invalid token signature")]
    InvalidSignature,
    #[error("forbidden")]
    Forbidden,
    #[error("internal authentication error: {0}")]
    InternalError(String),
}

//convert jsonwebtoken::errors::Error to JWTError
impl From<&jsonwebtoken::errors::Error> for AuthError {
    fn from(err: &jsonwebtoken::errors::Error) -> Self {
        match err.kind() {
            jsonwebtoken::errors::ErrorKind::InvalidToken => AuthError::InvalidToken,
            jsonwebtoken::errors::ErrorKind::ExpiredSignature => AuthError::ExpiredToken,
            jsonwebtoken::errors::ErrorKind::InvalidSignature => AuthError::InvalidSignature,
            _ => AuthError::InternalError(err.to_string()),
        }
    }
}

impl axum::extract::FromRequestParts<Site> for AuthUser {
    type Rejection = AuthError;

    async fn from_request_parts(parts: &mut Parts, site: &Site) -> Result<Self, Self::Rejection> {
        if let Some(user) = parts.extensions.get::<AuthUser>() {
            return Ok(user.clone());
        }
        let refresh = false;
        let auth = site.authenticator();
        let user = auth.extract_user(parts, &[], refresh)?;                    
        parts.extensions.insert(user.clone());
        Ok(user)
    }
}

impl IntoResponse for AuthError {
    fn into_response(self) -> Response {
        let (status, message) = match &self {
            AuthError::InvalidToken => (StatusCode::UNAUTHORIZED, "Invalid token"),
            AuthError::MissingToken => (StatusCode::UNAUTHORIZED, "Missing token"),
            AuthError::ExpiredToken => (StatusCode::UNAUTHORIZED, "Expired token"),
            AuthError::InvalidSignature => (StatusCode::UNAUTHORIZED, "Invalid token signature"),
            AuthError::Forbidden => (StatusCode::FORBIDDEN, "Forbidden"),
            AuthError::InternalError(msg) => (StatusCode::INTERNAL_SERVER_ERROR, msg.as_ref()),
        };
        let body = serde_json::json!({
            "detail": message
        });
        let mut resp = axum::response::Json(body).into_response();
        *resp.status_mut() = status;
        resp
    }
}