axum-sessions

🥠 Cookie-based sessions for axum via async_session.

🎨 Overview

axum-sessions is a middleware providing cookie-based sessions for axum applications.

Cryptographically-signed cookies, ensuring authenticity
Wraps async_session, enabling flexible cookie storage (e.g. async-sqlx-session)
Convenient extractor-based API (i.e. ReadableSession and WritableSession)
Can be used as a generic Tower middleware

📦 Install

To use the crate in your project, add the following to your Cargo.toml file:

toml [dependencies] axum-sessions = "0.3.1"

🤸 Usage

axum applications can use the middleware via the session layer.

`axum` Example

```rust use axum::{routing::get, Router}; use axumsessions::{ asyncsession::MemoryStore, extractors::{ReadableSession, WritableSession}, SessionLayer, }; use rand::Rng;

[tokio::main]

async fn main() { let store = MemoryStore::new(); let secret = rand::threadrng().gen::<[u8; 128]>(); let sessionlayer = SessionLayer::new(store, &secret);

async fn signin_handler(mut session: WritableSession) {
    session
        .insert("signed_in", true)
        .expect("Could not sign in.");
}

async fn signout_handler(mut session: WritableSession) {
    session.destroy();
}

async fn protected_handler(session: ReadableSession) -> &'static str {
    if session
        .get::<bool>("signed_in")
        .map_or(false, |signed_in| signed_in)
    {
        "Shh, it's secret!"
    } else {
        "Nothing to see here."
    }
}

let app = Router::new()
    .route("/signin", get(signin_handler))
    .route("/signout", get(signout_handler))
    .route("/protected", get(protected_handler))
    .layer(session_layer);

axum::Server::bind(&"0.0.0.0:3000".parse().unwrap())
    .serve(app.into_make_service())
    .await
    .unwrap();

} ```

You can find this example as well as other example projects in the example directory.