viewer.rs 95.5%

64 of 67 lines run, 17 of 38 functions · run #532 on main · run missed

//! Who is asking: the session cookie resolved to an account, as an axum
//! extractor every page handler takes.

use super::{csrf_token, mac_equal, token_hash, SESSION_COOKIE};
use crate::db::{self, accounts::Account};
use crate::Shared;
use axum::extract::FromRequestParts;
use axum::http::request::Parts;
use axum::http::{header, HeaderMap};
use std::convert::Infallible;

#[derive(Clone, Debug)]
pub struct ViewerAccount {
    pub account: Account,
    /// The cookie value, which CSRF tokens are bound to.
    pub session: String,
    /// The session's record (oxygenhub#223): "this browser" in the list.
    pub session_id: i64,
    pub csrf: String,
    /// Unread notifications, for the header.
    pub unread: i64,
}

/// The signed-in account, if any. Never fails: anonymous is a valid viewer.
#[derive(Clone, Debug, Default)]
pub struct Viewer(pub Option<ViewerAccount>);

impl Viewer {
    pub fn account(&self) -> Option<&Account> {
        self.0.as_ref().map(|v| &v.account)
    }

    pub fn signed_in(&self) -> bool {
        self.0.is_some()
    }

    pub fn is_admin(&self) -> bool {
        self.account().is_some_and(|a| a.is_admin)
    }

    pub fn csrf(&self) -> &str {
        self.0.as_ref().map(|v| v.csrf.as_str()).unwrap_or("")
    }

    /// Whether a submitted CSRF token belongs to this session.
    pub fn csrf_ok(&self, token: &str) -> bool {
        self.0.as_ref().is_some_and(|v| mac_equal(&v.csrf, token))
    }
}

/// The value of a named cookie in the request.
pub fn cookie(headers: &HeaderMap, name: &str) -> Option<String> {
    headers.get_all(header::COOKIE).iter().filter_map(|v| v.to_str().ok()).flat_map(|line| line.split(';')).find_map(|kv| {
        let (k, v) = kv.trim().split_once('=')?;
        (k == name).then(|| v.trim().to_string())
    })
}

/// Resolve a session cookie value to its account: a live session record
/// (oxygenhub#223) whose salt is still the account's.
pub async fn resolve(app: &Shared, value: &str) -> Option<(ViewerAccount, db::sessions::Session)> {
    if value.is_empty() || value.len() > 128 {
        return None;
    }
    let session = db::sessions::by_hash(&app.db, &token_hash(value)).await.ok()??;
    let account = db::accounts::account_by_id(&app.db, session.account_id).await.ok()??;
    if account.blocked() || !session.live(&account.session_salt, db::now_ms()) {
        return None;
    }
    let csrf = csrf_token(&app.cookie_key, value);
    let unread = db::notify::unread(&app.db, account.id).await.unwrap_or(0);
    let viewer = ViewerAccount { account, session: value.to_string(), session_id: session.id, csrf, unread };
    Some((viewer, session))
}

impl FromRequestParts<Shared> for Viewer {
    type Rejection = Infallible;

    async fn from_request_parts(parts: &mut Parts, app: &Shared) -> Result<Viewer, Infallible> {
        let Some(value) = cookie(&parts.headers, SESSION_COOKIE) else { return Ok(Viewer(None)) };
        let Some((viewer, session)) = resolve(app, &value).await else { return Ok(Viewer(None)) };
        let address = crate::api::client_addr(app, &parts.headers, &parts.extensions);
        let agent: String = parts
            .headers
            .get(header::USER_AGENT)
            .and_then(|v| v.to_str().ok())
            .unwrap_or("")
            .chars()
            .filter(|c| !c.is_control())
            .take(300)
            .collect();
        let pool = app.db.clone();
        let id = viewer.account.id;
        tokio::spawn(async move {
            let _ = db::accounts::touch_seen(&pool, id).await;
            let _ = db::sessions::touch(&pool, &session, &address, &agent, db::now_ms()).await;
        });
        Ok(Viewer(Some(viewer)))
    }
}

1		//! Who is asking: the session cookie resolved to an account, as an axum
2		//! extractor every page handler takes.
3
4		use super::{csrf_token, mac_equal, token_hash, SESSION_COOKIE};
5		use crate::db::{self, accounts::Account};
6		use crate::Shared;
7		use axum::extract::FromRequestParts;
8		use axum::http::request::Parts;
9		use axum::http::{header, HeaderMap};
10		use std::convert::Infallible;
11
12		#[derive(Clone, Debug)]
13		pub struct ViewerAccount {
14		pub account: Account,
15		/// The cookie value, which CSRF tokens are bound to.
16		pub session: String,
17		/// The session's record (oxygenhub#223): "this browser" in the list.
18		pub session_id: i64,
19		pub csrf: String,
20		/// Unread notifications, for the header.
21		pub unread: i64,
22		}
23
24		/// The signed-in account, if any. Never fails: anonymous is a valid viewer.
25		#[derive(Clone, Debug, Default)]
26		pub struct Viewer(pub Option<ViewerAccount>);
27
28		impl Viewer {
29	7322×	pub fn account(&self) -> Option<&Account> {
30	7322×	self.0.as_ref().map(\|v\| &v.account)
31	7322×	}
32
33	135×	pub fn signed_in(&self) -> bool {
34	135×	self.0.is_some()
35	135×	}
36
37	1669×	pub fn is_admin(&self) -> bool {
38	1669×	self.account().is_some_and(\|a\| a.is_admin)
39	1669×	}
40
41	1652×	pub fn csrf(&self) -> &str {
42	1652×	self.0.as_ref().map(\|v\| v.csrf.as_str()).unwrap_or("")
43	1652×	}
44
45		/// Whether a submitted CSRF token belongs to this session.
46	492×	pub fn csrf_ok(&self, token: &str) -> bool {
47	492×	self.0.as_ref().is_some_and(\|v\| mac_equal(&v.csrf, token))
48	492×	}
49		}
50
51		/// The value of a named cookie in the request.
52	1698×	pub fn cookie(headers: &HeaderMap, name: &str) -> Option<String> {
53	1698×	headers.get_all(header::COOKIE).iter().filter_map(\|v\| v.to_str().ok()).flat_map(\|line\| line.split(';')).find_map(\|kv\| {
54	1219×	let (k, v) = kv.trim().split_once('=')?;
55	1210×	(k == name).then(\|\| v.trim().to_string())
56	1219×	})
57	1698×	}
58
59		/// Resolve a session cookie value to its account: a live session record
60		/// (oxygenhub#223) whose salt is still the account's.
61	1122×	pub async fn resolve(app: &Shared, value: &str) -> Option<(ViewerAccount, db::sessions::Session)> {
62	1122×	if value.is_empty() \|\| value.len() > 128 {
63	0×	return None;
64	1122×	}
65	1122×	let session = db::sessions::by_hash(&app.db, &token_hash(value)).await.ok()??;
66	1118×	let account = db::accounts::account_by_id(&app.db, session.account_id).await.ok()??;
67	1118×	if account.blocked() \|\| !session.live(&account.session_salt, db::now_ms()) {
68	4×	return None;
69	1114×	}
70	1114×	let csrf = csrf_token(&app.cookie_key, value);
71	1114×	let unread = db::notify::unread(&app.db, account.id).await.unwrap_or(0);
72	1114×	let viewer = ViewerAccount { account, session: value.to_string(), session_id: session.id, csrf, unread };
73	1114×	Some((viewer, session))
74	1122×	}
75
76		impl FromRequestParts<Shared> for Viewer {
77		type Rejection = Infallible;
78
79	1648×	async fn from_request_parts(parts: &mut Parts, app: &Shared) -> Result<Viewer, Infallible> {
80	1648×	let Some(value) = cookie(&parts.headers, SESSION_COOKIE) else { return Ok(Viewer(None)) };
81	1122×	let Some((viewer, session)) = resolve(app, &value).await else { return Ok(Viewer(None)) };
82	1114×	let address = crate::api::client_addr(app, &parts.headers, &parts.extensions);
83	1114×	let agent: String = parts
84	1114×	.headers
85	1114×	.get(header::USER_AGENT)
86	1114×	.and_then(\|v\| v.to_str().ok())
87	1114×	.unwrap_or("")
88	1114×	.chars()
89	1114×	.filter(\|c\| !c.is_control())
90	1114×	.take(300)
91	1114×	.collect();
92	1114×	let pool = app.db.clone();
93	1114×	let id = viewer.account.id;
94	1114×	tokio::spawn(async move {
95	1113×	let _ = db::accounts::touch_seen(&pool, id).await;
96	1113×	let _ = db::sessions::touch(&pool, &session, &address, &agent, db::now_ms()).await;
97	1113×	});
98	1114×	Ok(Viewer(Some(viewer)))
99	1648×	}
100		}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

Coverage / crates/hub/src/auth/viewer.rs 95.5%

Keyboard