Axum Session Auth

Library to Provide a User Authentication and privilege Token Checks. It requires the Axum_Session library. This library will help by making it so User ID or authorizations are not stored on the Client side but rather on the Server side. The Authorization is linked by the Clients Serverside Session ID which is stored on the Client side. Formally known as Axum Sessions Auth

Wraps axum_session for data management serverside.
Right Management API
Auto load of user Data upon Page loads.
User Data cache to Avoid Repeated Database calls when not needed.

Help

If you need help with this library or have suggestions please go to our Discord Group

Install

Sessions Authentication uses tokio runtime and ['axum_session'];

# Cargo.toml
[dependencies]
# Postgres + rustls
axum_session_auth = { version = "0.6.0", features = [ "postgres-rustls" ] }

Cargo Feature Flags

default: [postgres-rustls]

sqlite-rustls: Sqlx support for the self-contained SQLite database engine and rustls.

sqlite-native: Sqlx support for the self-contained SQLite database engine and native-tls.

postgres-rustls: Sqlx support for the Postgres database server and rustls.

postgres-native: Sqlx support for the Postgres database server and native-tls.

mysql-rustls: Sqlx support for the MySQL/MariaDB database server and rustls.

mysql-native: Sqlx support for the MySQL/MariaDB database server and native-tls.

redis-db: redis_pool 0.2.1 session support. Enables Redis Client Pool

redis-clusterdb: redis_pool 0.2.0 session support. Enabled Redis ClusterClient Pool.

surrealdb-rocksdb: 1.0.0 support for rocksdb.

surrealdb-tikv : 1.0.0 support for tikv.

surrealdb-fdb-?_? : 1.0.0 support for fdb versions 6_1, 6_2, 6_3, 7_0, 7_1. Replace ?_? with version.

surrealdb-mem : 1.0.0 support for mem.

mongo : mongodb 2.6.1 support for mongo.

Example

use sqlx::{PgPool, ConnectOptions, postgres::{PgPoolOptions, PgConnectOptions}};
use std::net::SocketAddr;
use axum_session::{SessionPgPool, Session, SessionConfig, SessionLayer, DatabasePool};
use axum_session_auth::{AuthSession, AuthSessionLayer, Authentication, AuthConfig};
use axum::{
    Router,
    routing::get,
};

#[tokio::main]
async fn main() {
    # async {
    let poll = connect_to_database().await.unwrap();

    let session_config = SessionConfig::default()
        .with_database("test")
        .with_table_name("test_table");
    let auth_config = AuthConfig::<i64>::default().with_anonymous_user_id(Some(1));
    let session_store = SessionStore::<SessionPgPool>::new(Some(poll.clone().into()), session_config);

    // Build our application with some routes
    let app = Router::new()
        .route("/greet/:name", get(greet))
        .layer(SessionLayer::new(session_store))
        .layer(AuthSessionLayer::<User, i64, SessionPgPool, PgPool>::new(Some(poll)).with_config(auth_config));

    // Run it
    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    tracing::debug!("listening on {}", addr);
    axum::Server::bind(&addr)
        .serve(app.into_make_service())
        .await
        .unwrap();
    # };
}

// We can get the Method to compare with what Methods we allow. Useful if this supports multiple methods.
// When called auth is loaded in the background for you.
async fn greet(method: Method, auth: AuthSession<User, i64, SessionPgPool, PgPool>) -> &'static str {
    let mut count: usize = auth.session.get("count").unwrap_or(0);
    
    // We will get the user if not then a guest which should be our default.
    let current_user = auth.current_user.clone().unwrap_or_default();
    count += 1;

    // Session is Also included with Auth so no need to require it in the function arguments if your using
    // AuthSession.
    auth.session.set("count", count);

    // If for some reason you needed to update your Users Permissions 
    // or data that is cached then you will want to clear the user cache if it is enabled.
    // The user Cache is enabled by default. To clear simply use.
    auth.cache_clear_user(1).await;
    // To clear all cached user data for a large update
    auth.cache_clear_all().await;

    // This is our Auth Permission Builder and Rights Checker. We Build it with the Methods to check for
    // So in this case Method::Get. If they loaded the page with Method::Post it will fail with the no Permissions! error.
    // the false is build it to deturmine is Authentication is Required or not. this runs is_authenticated() when true. 
    if !Auth::<User, i64, PgPool>::build([Method::Get], false)
        // We Prepare what Rights we accept or Deny from Guest or Other users.
        .requires(Rights::none([
            Rights::permission("Token::UseAdmin"),
            Rights::permission("Token::ModifyPerms"),
        ]))
        // We then Validate the Current user, and Method. We also pass our Database along for database permissions checking
        // if required otherwise None.
        .validate(&current_user, &method, None)
        .await
    {
        // We return No Permissions message if validate fails for any reason.
        return format!("No Permissions! for {}", current_user.username)[];
    }

    // Since we had the is_authenticated set to false Above we will instead use it to login our Guest user. 
    if !auth.is_authenticated() {
        // Set the user ID of the User to the Session so it can be Auto Loaded the next load or redirect
        auth.login_user(2);
        // Set the session to be long term. Good for Remember me type instances.
        auth.remember_user(true);
        // We dont currently know the username until the next page access.
        // so Normally we would Redirect here after login if we did indeed login.
        // But in this case we will just use a let the user know to reload the page for the example.
        "You have Logged in! Please Refreash the page to display the username and counter."
    } else {
        // On Page Reload if the user has all the permissions and the Method is correct and they are logged in
        // It will display their username and a count that increments with each page refreash.
        format!("{}-{}", current_user.username, count)[..]
    };
}

#[derive(Clone, Debug)]
pub struct User {
    pub id: i32,
    pub anonymous: bool,
    pub username: String,
}

// This is only used if you want to use Token based Authentication checks
#[async_trait]
impl HasPermission<PgPool> for User {
    async fn has(&self, perm: &String, _pool: &Option<&PgPool>) -> bool {
        match &perm[..] {
            "Token::UseAdmin" => true,
            "Token::ModifyUser" => true,
            _ => false,
        }
    }
}

#[async_trait]
impl Authentication<User, i64, PgPool> for User {
    // This is ran when the user has logged in and has not yet been Cached in the system.
    // Once ran it will load and cache the user.
    async fn load_user(userid: i64, _pool: Option<&PgPool>) -> Result<User> {
        Ok(User {
            id: userid,
            anonymous: true,
            username: "Guest".to_string(),
        })
    }

    // This function is used internally to deturmine if they are logged in or not.
    fn is_authenticated(&self) -> bool {
        !self.anonymous
    }

    fn is_active(&self) -> bool {
        !self.anonymous
    }

    fn is_anonymous(&self) -> bool {
        self.anonymous
    }
}

async fn connect_to_database() -> anyhow::Result<sqlx::Pool<sqlx::Postgres>> {
    // ...
    # unimplemented!()
}

toursslivers / axumsessionauth Goto Github PK