1
0
mirror of https://github.com/matrix-org/matrix-authentication-service.git synced 2025-08-06 06:02:40 +03:00

Simplify session-related filters

This commit is contained in:
Quentin Gliech
2021-09-23 19:16:30 +02:00
parent d06cdb6e02
commit 2cfaff737e
5 changed files with 120 additions and 38 deletions

View File

@@ -23,8 +23,12 @@ use data_encoding::BASE64URL_NOPAD;
use headers::{Header, HeaderValue, SetCookie}; use headers::{Header, HeaderValue, SetCookie};
use serde::{de::DeserializeOwned, Deserialize, Serialize}; use serde::{de::DeserializeOwned, Deserialize, Serialize};
use thiserror::Error; use thiserror::Error;
use warp::{reject::Reject, Filter, Rejection, Reply}; use warp::{
reject::{MissingCookie, Reject},
Filter, Rejection, Reply,
};
use super::none_on_error;
use crate::{ use crate::{
config::CookiesConfig, config::CookiesConfig,
errors::WrapError, errors::WrapError,
@@ -108,17 +112,16 @@ impl EncryptedCookie {
#[must_use] #[must_use]
pub fn maybe_encrypted<T>( pub fn maybe_encrypted<T>(
options: &CookiesConfig, options: &CookiesConfig,
) -> impl Filter<Extract = (Option<T>,), Error = Infallible> + Clone + Send + Sync + 'static ) -> impl Filter<Extract = (Option<T>,), Error = Rejection> + Clone + Send + Sync + 'static
where where
T: DeserializeOwned + EncryptableCookieValue + 'static, T: DeserializeOwned + EncryptableCookieValue + 'static,
{ {
encrypted(options).map(Some).recover(recover::<T>).unify() encrypted(options)
} .map(Some)
.recover(none_on_error::<T, MissingCookie>)
async fn recover<T>(_rejection: Rejection) -> Result<Option<T>, Infallible> { .unify()
// We could actually look for MissingCookie and CookieDecryptionError .recover(none_on_error::<T, CookieDecryptionError<T>>)
// rejections, but nothing else should happen here anyway .unify()
Ok(None)
} }
/// Extract an encrypted cookie /// Extract an encrypted cookie
@@ -143,6 +146,7 @@ where
}) })
} }
/// Get an [`EncryptedCookieSaver`] to help saving an [`EncryptableCookieValue`]
#[must_use] #[must_use]
pub fn encrypted_cookie_saver( pub fn encrypted_cookie_saver(
options: &CookiesConfig, options: &CookiesConfig,
@@ -153,7 +157,7 @@ pub fn encrypted_cookie_saver(
} }
/// A cookie that can be encrypted with a well-known cookie key /// A cookie that can be encrypted with a well-known cookie key
pub trait EncryptableCookieValue: Send + Sync + std::fmt::Debug { pub trait EncryptableCookieValue: Serialize + Send + Sync + std::fmt::Debug {
fn cookie_key() -> &'static str; fn cookie_key() -> &'static str;
} }
@@ -163,7 +167,7 @@ pub struct EncryptedCookieSaver {
} }
impl EncryptedCookieSaver { impl EncryptedCookieSaver {
pub fn save_encrypted<T: Serialize + EncryptableCookieValue, R: Reply>( pub fn save_encrypted<T: EncryptableCookieValue, R: Reply>(
&self, &self,
cookie: &T, cookie: &T,
reply: R, reply: R,

View File

@@ -16,6 +16,7 @@ use headers::{Header, HeaderValue};
use thiserror::Error; use thiserror::Error;
use warp::{reject::Reject, Filter, Rejection}; use warp::{reject::Reject, Filter, Rejection};
/// Failed to decode typed header
#[derive(Debug, Error)] #[derive(Debug, Error)]
#[error("could not decode header {1}")] #[error("could not decode header {1}")]
pub struct InvalidTypedHeader(#[source] headers::Error, &'static str); pub struct InvalidTypedHeader(#[source] headers::Error, &'static str);

View File

@@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//! Set of [`warp`] filters
#![allow(clippy::unused_async)] // Some warp filters need that #![allow(clippy::unused_async)] // Some warp filters need that
pub mod csrf; pub mod csrf;
@@ -25,7 +27,7 @@ pub mod session;
use std::convert::Infallible; use std::convert::Infallible;
use warp::Filter; use warp::{Filter, Rejection};
pub use self::csrf::CsrfToken; pub use self::csrf::CsrfToken;
use crate::{ use crate::{
@@ -48,3 +50,30 @@ pub fn with_keys(
let keyset = oauth2_config.keys.clone(); let keyset = oauth2_config.keys.clone();
warp::any().map(move || keyset.clone()) warp::any().map(move || keyset.clone())
} }
/// Recover a particular rejection type with a `None` option variant
///
/// # Example
///
/// ```rust
/// extern crate warp;
///
/// use warp::{filters::header::header, reject::MissingHeader, Filter};
///
/// use mas_core::filters::none_on_error;
///
/// header("Content-Length")
/// .map(Some)
/// .recover(none_on_error::<_, MissingHeader>)
/// .unify()
/// .map(|length: Option<u64>| {
/// format!("header: {:?}", length)
/// });
/// ```
pub async fn none_on_error<T, E: 'static>(rejection: Rejection) -> Result<Option<T>, Rejection> {
if rejection.find::<E>().is_some() {
Ok(None)
} else {
Err(rejection)
}
}

View File

@@ -14,18 +14,37 @@
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use sqlx::{pool::PoolConnection, Executor, PgPool, Postgres}; use sqlx::{pool::PoolConnection, Executor, PgPool, Postgres};
use warp::{Filter, Rejection}; use thiserror::Error;
use tracing::warn;
use warp::{
reject::{MissingCookie, Reject},
Filter, Rejection,
};
use super::{ use super::{
cookies::{encrypted, maybe_encrypted, EncryptableCookieValue}, cookies::{encrypted, CookieDecryptionError, EncryptableCookieValue},
database::connection, database::connection,
none_on_error,
}; };
use crate::{ use crate::{
config::CookiesConfig, config::CookiesConfig,
errors::WrapError, storage::{lookup_active_session, user::ActiveSessionLookupError, SessionInfo},
storage::{lookup_active_session, SessionInfo},
}; };
#[derive(Error, Debug)]
pub enum SessionLoadError {
#[error("missing session cookie")]
MissingCookie,
#[error("unable to parse or decrypt session cookie")]
InvalidCookie,
#[error("unknown or inactive session")]
UnknownSession,
}
impl Reject for SessionLoadError {}
#[derive(Serialize, Deserialize, Debug)] #[derive(Serialize, Deserialize, Debug)]
pub struct SessionCookie { pub struct SessionCookie {
current: i64, current: i64,
@@ -42,7 +61,7 @@ impl SessionCookie {
pub async fn load_session_info( pub async fn load_session_info(
&self, &self,
executor: impl Executor<'_, Database = Postgres>, executor: impl Executor<'_, Database = Postgres>,
) -> anyhow::Result<SessionInfo> { ) -> Result<SessionInfo, ActiveSessionLookupError> {
let res = lookup_active_session(executor, self.current).await?; let res = lookup_active_session(executor, self.current).await?;
Ok(res) Ok(res)
} }
@@ -61,31 +80,59 @@ pub fn optional_session(
cookies_config: &CookiesConfig, cookies_config: &CookiesConfig,
) -> impl Filter<Extract = (Option<SessionInfo>,), Error = Rejection> + Clone + Send + Sync + 'static ) -> impl Filter<Extract = (Option<SessionInfo>,), Error = Rejection> + Clone + Send + Sync + 'static
{ {
maybe_encrypted(cookies_config) session(pool, cookies_config)
.and(connection(pool)) .map(Some)
.and_then( .recover(none_on_error::<_, SessionLoadError>)
|maybe_session: Option<SessionCookie>, mut conn: PoolConnection<Postgres>| async move { .unify()
let maybe_session_info = if let Some(session) = maybe_session {
session.load_session_info(&mut conn).await.ok()
} else {
None
};
Ok::<_, Rejection>(maybe_session_info)
},
)
} }
/// Extract a user session information, rejecting if not logged in /// Extract a user session information, rejecting if not logged in
///
/// # Rejections
///
/// This filter will reject with a [`SessionLoadError`] when the session is
/// inactive or missing. It will reject with a wrapped error on other database
/// failures.
#[must_use] #[must_use]
pub fn session( pub fn session(
pool: &PgPool, pool: &PgPool,
cookies_config: &CookiesConfig, cookies_config: &CookiesConfig,
) -> impl Filter<Extract = (SessionInfo,), Error = Rejection> + Clone + Send + Sync + 'static { ) -> impl Filter<Extract = (SessionInfo,), Error = Rejection> + Clone + Send + Sync + 'static {
// TODO: this should be wrapped up in a recoverable error encrypted(cookies_config)
encrypted(cookies_config).and(connection(pool)).and_then( .and(connection(pool))
|session: SessionCookie, mut conn: PoolConnection<Postgres>| async move { .and_then(load_session)
let session_info = session.load_session_info(&mut conn).await.wrap_error()?; .recover(recover)
Ok::<_, Rejection>(session_info) .unify()
}, }
)
async fn load_session(
session: SessionCookie,
mut conn: PoolConnection<Postgres>,
) -> Result<SessionInfo, Rejection> {
let session_info = session.load_session_info(&mut conn).await?;
Ok(session_info)
}
/// Recover from expected rejections, to transform them into a
/// [`SessionLoadError`]
async fn recover<T>(rejection: Rejection) -> Result<T, Rejection> {
if let Some(e) = rejection.find::<ActiveSessionLookupError>() {
if e.not_found() {
return Err(warp::reject::custom(SessionLoadError::UnknownSession));
}
// If we're here, there is a real database error that should be
// propagated
}
if let Some(_e) = rejection.find::<MissingCookie>() {
return Err(warp::reject::custom(SessionLoadError::MissingCookie));
}
if let Some(error) = rejection.find::<CookieDecryptionError<SessionCookie>>() {
warn!(?error, "could not decrypt session cookie");
return Err(warp::reject::custom(SessionLoadError::InvalidCookie));
}
Err(rejection)
} }

View File

@@ -24,6 +24,7 @@ use sqlx::{Acquire, Executor, FromRow, Postgres, Transaction};
use thiserror::Error; use thiserror::Error;
use tokio::task; use tokio::task;
use tracing::{info_span, Instrument}; use tracing::{info_span, Instrument};
use warp::reject::Reject;
use crate::errors::HtmlError; use crate::errors::HtmlError;
@@ -142,14 +143,14 @@ pub async fn login(
#[error("could not fetch session")] #[error("could not fetch session")]
pub struct ActiveSessionLookupError(#[from] sqlx::Error); pub struct ActiveSessionLookupError(#[from] sqlx::Error);
/* impl Reject for ActiveSessionLookupError {}
impl ActiveSessionLookupError { impl ActiveSessionLookupError {
#[must_use] #[must_use]
pub fn not_found(&self) -> bool { pub fn not_found(&self) -> bool {
matches!(self.0, sqlx::Error::RowNotFound) matches!(self.0, sqlx::Error::RowNotFound)
} }
} }
*/
pub async fn lookup_active_session( pub async fn lookup_active_session(
executor: impl Executor<'_, Database = Postgres>, executor: impl Executor<'_, Database = Postgres>,