session: Add Sqlite session backend

actix-session/CHANGES.md

@@ -1,7 +1,7 @@
 # Changes
 
 ## Unreleased - 2021-xx-xx
-
+- Added Sqlite session backend
 
 ## 0.7.2 - 2022-09-11
 - Set SameSite attribute when adding a session removal cookie. [#284]

actix-session/Cargo.toml

@@ -26,6 +26,7 @@ cookie-session = []
 redis-actor-session = ["actix-redis", "actix", "futures-core", "rand"]
 redis-rs-session = ["redis", "rand"]
 redis-rs-tls-session = ["redis-rs-session", "redis/tokio-native-tls-comp"]
+sqlite-session = ["rusqlite", "r2d2", "r2d2_sqlite", "rand"]
 
 [dependencies]
 actix-service = "2"
@@ -48,16 +49,21 @@ futures-core = { version = "0.3.7", default-features = false, optional = true }
 # redis-rs-session
 redis = { version = "0.21", default-features = false, features = ["aio", "tokio-comp", "connection-manager"], optional = true }
 
+# sqlite-session
+rusqlite = { version = "0.27", features = ["bundled", "chrono"], optional = true }
+r2d2 = { version = "0.8", optional = true }
+r2d2_sqlite = { version = "0.20", optional = true }
+
 [dev-dependencies]
-actix-session = { path = ".", features = ["cookie-session", "redis-actor-session", "redis-rs-session"] }
+actix-session = { path = ".", features = ["cookie-session", "sqlite-session"] }
 actix-test = "0.1.0-beta.10"
 actix-web = { version = "4", default_features = false, features = ["cookies", "secure-cookies", "macros"] }
 env_logger = "0.9"
 log = "0.4"
 
 [[example]]
 name = "basic"
-required-features = ["redis-actor-session"]
+required-features = ["sqlite-session"]
 
 [[example]]
 name = "authentication"

actix-session/examples/basic.rs

@@ -1,18 +1,19 @@
-use actix_session::{storage::RedisActorSessionStore, Session, SessionMiddleware};
-use actix_web::{cookie::Key, middleware, web, App, Error, HttpRequest, HttpServer, Responder};
+use actix_session::{storage::SqliteSessionStore, Session, SessionMiddleware};
+use actix_web::{
+    cookie::{time::Duration, Key},
+    middleware, web, App, Error, HttpRequest, HttpServer, Responder,
+};
+use r2d2_sqlite::{self, SqliteConnectionManager};
 
 /// simple handler
-async fn index(req: HttpRequest, session: Session) -> Result<impl Responder, Error> {
-    println!("{:?}", req);
-
+async fn index(_req: HttpRequest, session: Session) -> Result<impl Responder, Error> {
     // session
     if let Some(count) = session.get::<i32>("counter")? {
         println!("SESSION value: {}", count);
         session.insert("counter", count + 1)?;
     } else {
         session.insert("counter", 1)?;
     }
-
     Ok("Welcome!")
 }
 
@@ -23,17 +24,28 @@ async fn main() -> std::io::Result<()> {
     // The signing key would usually be read from a configuration file/environment variables.
     let signing_key = Key::generate();
 
+    let manager = SqliteConnectionManager::file("sessions.db");
+    let pool = r2d2::Pool::<r2d2_sqlite::SqliteConnectionManager>::new(manager).unwrap();
+
+    let sqlite_session_store = SqliteSessionStore::new(pool, true).unwrap();
+
     log::info!("starting HTTP server at http://localhost:8080");
 
     HttpServer::new(move || {
         App::new()
             // enable logger
-            .wrap(middleware::Logger::default())
             // cookie session middleware
-            .wrap(SessionMiddleware::new(
-                RedisActorSessionStore::new("127.0.0.1:6379"),
-                signing_key.clone(),
-            ))
+            .wrap(
+                SessionMiddleware::builder(sqlite_session_store.clone(), signing_key.clone())
+                    .cookie_name(String::from("session"))
+                    .cookie_secure(false)
+                    .session_lifecycle(
+                        actix_session::config::PersistentSession::default()
+                            .session_ttl(Duration::seconds(100)),
+                    )
+                    .build(),
+            )
+            .wrap(middleware::Logger::default())
             // register simple route, handle all methods
             .service(web::resource("/").to(index))
     })

actix-session/src/storage/mod.rs

@@ -17,7 +17,14 @@ mod redis_actor;
 #[cfg(feature = "redis-rs-session")]
 mod redis_rs;
 
-#[cfg(any(feature = "redis-actor-session", feature = "redis-rs-session"))]
+#[cfg(feature = "sqlite-session")]
+mod sqlite;
+
+#[cfg(any(
+    feature = "redis-actor-session",
+    feature = "redis-rs-session",
+    feature = "sqlite-session"
+))]
 mod utils;
 
 #[cfg(feature = "cookie-session")]
@@ -26,3 +33,5 @@ pub use cookie::CookieSessionStore;
 pub use redis_actor::{RedisActorSessionStore, RedisActorSessionStoreBuilder};
 #[cfg(feature = "redis-rs-session")]
 pub use redis_rs::{RedisSessionStore, RedisSessionStoreBuilder};
+#[cfg(feature = "sqlite-session")]
+pub use sqlite::SqliteSessionStore;