Crate axum_database_sessions
source · [−]Expand description
Axum_database_Sessions
Library to Provide a Sqlx Database Session management layer.
You must choose only one of [‘postgres’, ‘mysql’, ‘sqlite’] features to use this library.
Install
Axum Database Sessions uses tokio
runtime along with sqlx
; it supports native-tls
and rustls
TLS backends. When adding the dependency, you must chose a database feature that is DatabaseType
and a tls
backend. You can only choose one database type and one TLS Backend.
sqlx
current version used is 0.6.0
[dependencies]
axum_database_sessions = { version = "3.0.2", features = [ "postgres", "rustls"] }
Cargo Feature Flags
sqlite
: Sqlx
support for the self-contained SQLite database engine.
postgres
: Sqlx
support for the Postgres database server.
mysql
: Sqlx
support for the MySQL/MariaDB database server.
native-tls
: Use the tokio
runtime and native-tls
TLS backend.
rustls
: Use the tokio
runtime and rustls
TLS backend.
Example
use sqlx::{ConnectOptions, postgres::{PgPoolOptions, PgConnectOptions}};
use std::net::SocketAddr;
use axum_database_sessions::{AxumSession, AxumSessionConfig, AxumSessionStore, AxumSessionLayer};
use axum::{
Router,
routing::get,
};
#[tokio::main]
async fn main() {
let poll = connect_to_database().await.unwrap();
//This Defaults as normal Cookies.
//To enable Private cookies for integrity, and authenticity please check the next Example.
let session_config = AxumSessionConfig::default()
.with_table_name("test_table");
let session_store = AxumSessionStore::new(Some(poll.clone().into()), session_config);
session_store.migrate().await.unwrap();
// build our application with some routes
let app = Router::new()
.route("/greet", get(greet))
.layer(AxumSessionLayer::new(session_store));
// 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();
}
async fn greet(session: AxumSession) -> String {
let mut count: usize = session.get("count").await.unwrap_or(0);
count += 1;
session.set("count", count).await;
count.to_string()
}
async fn connect_to_database() -> anyhow::Result<sqlx::Pool<sqlx::Postgres>> {
// ...
unimplemented!()
}
To enable private cookies for confidentiality, integrity, and authenticity. When a Key is set it will automatically set the Cookie into an encypted Private cookie which both protects the cookies data from prying eye’s it also ensures the authenticity of the cookie.
Example
use sqlx::{ConnectOptions, postgres::{PgPoolOptions, PgConnectOptions}};
use std::net::SocketAddr;
use axum_database_sessions::{AxumSession, AxumSessionConfig, AxumSessionStore, AxumSessionLayer, AxumSessionMode, Key};
use axum::{
Router,
routing::get,
};
#[tokio::main]
async fn main() {
let session_config = AxumSessionConfig::default()
.with_table_name("test_table")
// 'Key::generate()' will generate a new key each restart of the server.
// If you want it to be more permanent then generate and set it to a config file.
// If with_key() is used it will set all cookies as private, which guarantees integrity, and authenticity.
.with_key(Key::generate());
let session_store = AxumSessionStore::new(None, session_config);
session_store.migrate().await.unwrap();
// build our application with some routes
let app = Router::new()
.route("/greet", get(greet))
.layer(AxumSessionLayer::new(session_store));
// 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();
}
To use Axum_database_session in non_persistant mode Set the client to None.
Example
use sqlx::{ConnectOptions, postgres::{PgPoolOptions, PgConnectOptions}};
use std::net::SocketAddr;
use axum_database_sessions::{AxumSession, AxumSessionConfig, AxumSessionStore, AxumSessionLayer};
use axum::{
Router,
routing::get,
};
#[tokio::main]
async fn main() {
let session_config = AxumSessionConfig::default()
.with_table_name("test_table");
let session_store = AxumSessionStore::new(None, session_config);
// build our application with some routes
let app = Router::new()
.route("/greet", get(greet))
.layer(AxumSessionLayer::new(session_store));
// 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();
}
async fn greet(session: AxumSession) -> String {
let mut count: usize = session.get("count").await.unwrap_or(0);
count += 1;
session.set("count", count).await;
count.to_string()
}
To use Axum_database_session with session mode set as Storable.
Example
use sqlx::{ConnectOptions, postgres::{PgPoolOptions, PgConnectOptions}};
use std::net::SocketAddr;
use axum_database_sessions::{AxumSession, AxumSessionConfig, AxumSessionStore, AxumSessionLayer, AxumSessionMode};
use axum::{
Router,
routing::get,
};
#[tokio::main]
async fn main() {
let session_config = AxumSessionConfig::default()
.with_table_name("test_table").with_mode(AxumSessionMode::AcceptedOnly);
let session_store = AxumSessionStore::new(None, session_config);
session_store.migrate().await.unwrap();
// build our application with some routes
let app = Router::new()
.route("/greet", get(greet))
.layer(AxumSessionLayer::new(session_store));
// 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();
}
//No need to set the sessions accepted or not with gdpr mode disabled
async fn greet(session: AxumSession) -> String {
let mut count: usize = session.get("count").await.unwrap_or(0);
// Allow the Session data to be keep in memory and the database for the lifetime.
session.set_store(true).await;
count += 1;
session.set("count", count).await;
count.to_string()
}
Help
If you need help with this library or have suggestions please go to our Discord Group
Structs
Mysql’s Pool type for AxumDatabasePool
A Session Store.
Configuration for how the Session and Cookies are used.
Sessions Layer used with Axum to activate the Service.
Contains the main Services storage for all session’s and database access for persistant Sessions.
A cryptographic master key for use with Signed
and/or Private
jars.
Enums
Mode at which the Session will function As.
The SameSite
cookie attribute.