From d6ebd3a4a6f8251a27c406051bece86a4b811a75 Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Mon, 8 Apr 2024 18:25:32 -0700 Subject: [PATCH 01/10] works! --- .gitignore | 3 +- Cargo.lock | 45 ++++++ Cargo.toml | 2 + config.toml.sample | 4 +- diesel.toml | 9 ++ migrations/.keep | 0 .../down.sql | 1 + .../2024-04-08-223926_create_accounts/up.sql | 4 + src/app.rs | 133 +++++++++++++++--- src/config.rs | 11 +- src/db.rs | 56 ++++++++ src/lib.rs | 14 +- src/models.rs | 10 ++ src/schema.rs | 8 ++ 14 files changed, 276 insertions(+), 24 deletions(-) create mode 100644 diesel.toml create mode 100644 migrations/.keep create mode 100644 migrations/2024-04-08-223926_create_accounts/down.sql create mode 100644 migrations/2024-04-08-223926_create_accounts/up.sql create mode 100644 src/db.rs create mode 100644 src/models.rs create mode 100644 src/schema.rs diff --git a/.gitignore b/.gitignore index cab0673..7e5fef8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /target /.vscode -/config.toml \ No newline at end of file +/config.toml +*.db \ No newline at end of file diff --git a/Cargo.lock b/Cargo.lock index f804b68..00201a4 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -795,6 +795,39 @@ dependencies = [ "syn 1.0.109", ] +[[package]] +name = "diesel" +version = "2.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03fc05c17098f21b89bc7d98fe1dd3cce2c11c2ad8e145f2a44fe08ed28eb559" +dependencies = [ + "chrono", + "diesel_derives", + "libsqlite3-sys", + "time", +] + +[[package]] +name = "diesel_derives" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d02eecb814ae714ffe61ddc2db2dd03e6c49a42e269b5001355500d431cce0c" +dependencies = [ + "diesel_table_macro_syntax", + "proc-macro2", + "quote", + "syn 2.0.58", +] + +[[package]] +name = "diesel_table_macro_syntax" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc5557efc453706fed5e4fa85006fe9817c224c3f480a34c7e5959fd700921c5" +dependencies = [ + "syn 2.0.58", +] + [[package]] name = "digest" version = "0.10.7" @@ -1449,6 +1482,16 @@ version = "0.2.8" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "4ec2a862134d2a7d32d7983ddcdd1c4923530833c9f2ea1a44fc5fa473989058" +[[package]] +name = "libsqlite3-sys" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c10584274047cb335c23d3e61bcef8e323adae7c5c8c760540f73610177fc3f" +dependencies = [ + "pkg-config", + "vcpkg", +] + [[package]] name = "linux-raw-sys" version = "0.4.13" @@ -2434,9 +2477,11 @@ version = "0.1.0" dependencies = [ "actix-session", "actix-web", + "chrono", "clap", "clio", "color-eyre", + "diesel", "env_logger", "eyre", "futures", diff --git a/Cargo.toml b/Cargo.toml index 807610c..db2d81d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,9 +8,11 @@ edition = "2021" [dependencies] actix-session = { version = "0.9.0", features = ["cookie-session"] } actix-web = { version = "4.5.1", features = ["secure-cookies"] } +chrono = { version = "0.4.37", features = ["now"] } clap = { version = "4.5.4", features = ["derive"] } clio = { version = "0.3.5", features = ["clap-parse"] } color-eyre = "0.6.3" +diesel = { version = "2.1.5", features = ["sqlite", "chrono"] } env_logger = "0.11.3" eyre = "0.6.12" futures = "0.3.30" diff --git a/config.toml.sample b/config.toml.sample index da14b88..649d1ae 100644 --- a/config.toml.sample +++ b/config.toml.sample @@ -1,3 +1,5 @@ +sqlite_db = "subscribe-list.db" + [oidc.google] pretty_name = "Google" issuer_url = "https://accounts.google.com" @@ -12,4 +14,4 @@ issuer_url = "https://salsa.debian.org" client_id = "" secret = "" redirect_url = "https://my-site/subscription/callback/debian-salsa" -scopes = ["email"] +scopes = ["email", "openid"] diff --git a/diesel.toml b/diesel.toml new file mode 100644 index 0000000..c028f4a --- /dev/null +++ b/diesel.toml @@ -0,0 +1,9 @@ +# For documentation on how to configure this file, +# see https://diesel.rs/guides/configuring-diesel-cli + +[print_schema] +file = "src/schema.rs" +custom_type_derives = ["diesel::query_builder::QueryId"] + +[migrations_directory] +dir = "migrations" diff --git a/migrations/.keep b/migrations/.keep new file mode 100644 index 0000000..e69de29 diff --git a/migrations/2024-04-08-223926_create_accounts/down.sql b/migrations/2024-04-08-223926_create_accounts/down.sql new file mode 100644 index 0000000..b882e7c --- /dev/null +++ b/migrations/2024-04-08-223926_create_accounts/down.sql @@ -0,0 +1 @@ +DROP TABLE "accounts" \ No newline at end of file diff --git a/migrations/2024-04-08-223926_create_accounts/up.sql b/migrations/2024-04-08-223926_create_accounts/up.sql new file mode 100644 index 0000000..db9059a --- /dev/null +++ b/migrations/2024-04-08-223926_create_accounts/up.sql @@ -0,0 +1,4 @@ +CREATE TABLE "accounts" ( + "email" TEXT NOT NULL PRIMARY KEY ASC, + "date" TIMESTAMP NOT NULL +) WITHOUT ROWID; \ No newline at end of file diff --git a/src/app.rs b/src/app.rs index 7186e7d..92ebac5 100644 --- a/src/app.rs +++ b/src/app.rs @@ -1,7 +1,4 @@ -use crate::{ - client::async_http_client, - config::{Config, OIDCProvider}, -}; +use crate::{client::async_http_client, config::Config, db::DbThread, models::Account}; use actix_session::Session; use actix_web::{ get, @@ -9,10 +6,10 @@ use actix_web::{ web::{self, ServiceConfig}, HttpResponse, Responder, }; -use eyre::{ensure, Context, OptionExt}; +use eyre::{ensure, OptionExt}; use openidconnect::{ core::{CoreAuthenticationFlow, CoreUserInfoClaims}, - AuthorizationCode, CsrfToken, EndUserEmail, Nonce, OAuth2TokenResponse, + AuthorizationCode, CsrfToken, EndUserEmail, Nonce, OAuth2TokenResponse, TokenResponse, }; use serde::{Deserialize, Serialize}; use std::marker::PhantomData; @@ -74,6 +71,8 @@ pub struct SubscriptionLoggedOutTemplateProviders { templates! { #[text = r#"Subscription +

Register or Sign In:

+As an anti-spam measure, you need to register using a 3rd-party account:
    {{- for provider in providers -}}
  • {provider.pretty_name}
    • @@ -86,7 +85,11 @@ templates! { } #[text = r#"Subscription -

    Logged in as {email}

    +

    Signed in as {email}

    + "#] #[derive(Debug, Serialize)] pub struct SubscriptionLoggedInTemplate { @@ -129,7 +132,44 @@ impl SessionState { } } -impl OIDCProvider {} +pub async fn get_or_insert_account( + email: EndUserEmail, + session: &Session, + db: web::Data, +) -> SessionState { + let state = SessionState { + email: email.clone(), + }; + db.run_on(move |connection| { + use crate::schema::accounts::dsl::accounts; + use diesel::prelude::*; + let account = Account { + email: email.to_string(), + date: chrono::Utc::now().naive_utc(), + }; + match diesel::insert_into(accounts) + .values(&account) + .on_conflict_do_nothing() + .execute(connection) + { + Ok(0) => { + log::debug!("found existing account: {}", account.email.as_str()); + } + Ok(_) => { + log::info!("created new account: {}", account.email.as_str()); + } + Err(e) => { + log::error!( + "failed to get/insert account: {}\n{e}", + account.email.as_str() + ) + } + } + }) + .await; + state.set(session); + state +} const NONCE: &'static str = "nonce"; const CSRF_TOKEN: &'static str = "csrf_token"; @@ -146,6 +186,7 @@ pub async fn callback( session: Session, path: web::Path<(String,)>, query: web::Query, + db: web::Data, ) -> impl Responder { let mut resp = HttpResponse::SeeOther().body(""); resp.headers_mut() @@ -155,15 +196,15 @@ pub async fn callback( } let body = async { let csrf_token = session - .get::(CSRF_TOKEN) - .context("invalid csrf token")? - .ok_or_eyre("missing csrf token")?; + .remove_as::(CSRF_TOKEN) + .ok_or_eyre("missing csrf token")? + .ok() + .ok_or_eyre("invalid csrf token")?; let nonce = session - .get::(NONCE) - .context("invalid nonce")? - .ok_or_eyre("missing nonce")?; - session.remove(CSRF_TOKEN); - session.remove(NONCE); + .remove_as::(NONCE) + .ok_or_eyre("missing nonce")? + .ok() + .ok_or_eyre("invalid nonce")?; ensure!( csrf_token.secret() == query.state.secret(), "csrf token doesn't match" @@ -175,6 +216,14 @@ pub async fn callback( .exchange_code(query.into_inner().code) .request_async(async_http_client) .await?; + if let Some(id_token) = token.id_token() { + let id_token_claims = + id_token.claims(&provider.state().client.id_token_verifier(), &nonce)?; + if let Some(email) = id_token_claims.email().cloned() { + get_or_insert_account(email, &session, db).await; + return Ok(()); + } + } let user_info: CoreUserInfoClaims = provider .state() .client @@ -182,7 +231,7 @@ pub async fn callback( .request_async(async_http_client) .await?; let email = user_info.email().ok_or_eyre("no email provided")?.clone(); - SessionState { email }.set(&session); + get_or_insert_account(email, &session, db).await; Ok(()) }; let result: eyre::Result<()> = body.await; @@ -224,10 +273,50 @@ pub async fn login( resp } +#[get("/subscription/logout")] +pub async fn logout(session: Session) -> impl Responder { + session.purge(); + let mut resp = HttpResponse::SeeOther().body(""); + resp.headers_mut() + .insert(LOCATION, "/subscription".parse().unwrap()); + resp +} + +#[get("/subscription/unsubscribe")] +pub async fn unsubscribe(session: Session, db: web::Data) -> impl Responder { + if let Some(state) = SessionState::get(&session) { + db.run_on(move |connection| { + use crate::schema::accounts::dsl::*; + use diesel::prelude::*; + match diesel::delete(accounts.filter(email.eq(state.email.as_str()))) + .execute(connection) + { + Ok(_) => { + log::info!("deleted account: {}", state.email.as_str()); + } + Err(e) => { + log::error!("failed to delete account: {}\n{e}", state.email.as_str()) + } + } + }) + .await; + } + session.purge(); + let mut resp = HttpResponse::SeeOther().body(""); + resp.headers_mut() + .insert(LOCATION, "/subscription".parse().unwrap()); + resp +} + #[get("/subscription")] -pub async fn subscription(config: web::Data, session: Session) -> impl Responder { +pub async fn subscription( + config: web::Data, + session: Session, + db: web::Data, +) -> impl Responder { if let Some(SessionState { email }) = SessionState::get(&session) { - let mut template = SubscriptionLoggedInTemplate { email }; + get_or_insert_account(email.clone(), &session, db).await; + let template = SubscriptionLoggedInTemplate { email }; HttpResponse::Ok() .content_type(ContentType::html()) .body(template.render().expect("rendering can't fail")) @@ -248,7 +337,11 @@ pub async fn subscription(config: web::Data, session: Session) -> impl R } pub fn all_services(cfg: &mut ServiceConfig) { - cfg.service(subscription).service(login).service(callback); + cfg.service(subscription) + .service(login) + .service(callback) + .service(logout) + .service(unsubscribe); } #[cfg(test)] diff --git a/src/config.rs b/src/config.rs index 6107f11..85fbd61 100644 --- a/src/config.rs +++ b/src/config.rs @@ -9,9 +9,17 @@ use openidconnect::{ ClientId, ClientSecret, IssuerUrl, RedirectUrl, Scope, }; use serde::{Deserialize, Serialize}; +use std::num::NonZeroU16; + +pub fn default_db_thread_channel_capacity() -> NonZeroU16 { + NonZeroU16::new(10).unwrap() +} #[derive(Deserialize, Serialize, Debug, Clone)] pub struct Config { + pub sqlite_db: String, + #[serde(default = "default_db_thread_channel_capacity")] + pub db_thread_channel_capacity: NonZeroU16, pub oidc: IndexMap, } @@ -27,6 +35,7 @@ impl ValueParserFactory for Config { } impl Config { + #[allow(dead_code)] pub const EXAMPLE: &'static str = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/config.toml.sample")); pub fn load_str(input: &str, path: impl ToString) -> eyre::Result { @@ -35,7 +44,7 @@ impl Config { pub fn load(input: CachedInput) -> eyre::Result { let s = std::str::from_utf8(input.get_data()).wrap_err_with(|| input.path().to_string())?; - toml::from_str(s).wrap_err_with(|| input.path().to_string()) + Self::load_str(s, input.path()) } pub async fn resolve(&mut self) -> eyre::Result<()> { diff --git a/src/db.rs b/src/db.rs new file mode 100644 index 0000000..46c44c3 --- /dev/null +++ b/src/db.rs @@ -0,0 +1,56 @@ +use tokio::sync::{mpsc, oneshot}; + +struct DbThreadInner { + op_sender: mpsc::Sender>, + join_handle: std::thread::JoinHandle<()>, +} + +pub struct DbThread(Option); + +impl DbThread { + pub fn new(mut connection: diesel::SqliteConnection, buffer: usize) -> Self { + let (op_sender, mut op_receiver) = + mpsc::channel::>(buffer); + let join_handle = std::thread::spawn(move || loop { + let Some(f) = op_receiver.blocking_recv() else { + break; + }; + f(&mut connection); + }); + Self(Some(DbThreadInner { + op_sender, + join_handle, + })) + } + pub async fn run_on< + F: FnOnce(&mut diesel::SqliteConnection) -> T + Send + 'static, + T: Send + 'static, + >( + &self, + f: F, + ) -> T { + let (result_sender, result_receiver) = oneshot::channel(); + self.0 + .as_ref() + .unwrap() + .op_sender + .send(Box::new(move |connection| { + // if send failed, the future must have been canceled, so ignore send failures + let _ = result_sender.send(f(connection)); + })) + .await + .expect("send to succeed"); + result_receiver.await.expect("result to be written") + } +} + +impl Drop for DbThread { + fn drop(&mut self) { + let DbThreadInner { + op_sender, + join_handle, + } = self.0.take().unwrap(); + drop(op_sender); + join_handle.join().unwrap(); + } +} diff --git a/src/lib.rs b/src/lib.rs index 7235f9e..ae458de 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,19 +1,30 @@ -use crate::cli::{Listen, ListenFdSocket, ListenFdSockets}; +use crate::{ + cli::{Listen, ListenFdSocket, ListenFdSockets}, + db::DbThread, +}; use actix_session::{storage::CookieSessionStore, SessionMiddleware}; use actix_web::{cookie::Key, web, App, HttpServer}; use clap::Parser; +use diesel::Connection; use listenfd::ListenFd; mod app; mod cli; mod client; mod config; +mod db; +mod models; +mod schema; pub async fn main() -> eyre::Result<()> { env_logger::init(); let mut listenfd = ListenFd::from_env(); color_eyre::install()?; let mut args = cli::CLI::parse(); + let db = web::Data::new(DbThread::new( + diesel::SqliteConnection::establish(&args.config.sqlite_db)?, + args.config.db_thread_channel_capacity.get().into(), + )); args.resolve(&mut listenfd).await?; log::info!("retrieved config from auth servers"); let config = web::Data::new(args.config); @@ -26,6 +37,7 @@ pub async fn main() -> eyre::Result<()> { App::new() .wrap(cookie_session) .app_data(config.clone()) + .app_data(db.clone()) .configure(app::all_services) }); let Listen { diff --git a/src/models.rs b/src/models.rs new file mode 100644 index 0000000..d0a643a --- /dev/null +++ b/src/models.rs @@ -0,0 +1,10 @@ +use chrono::NaiveDateTime; +use diesel::prelude::*; + +#[derive(Queryable, Selectable, Insertable)] +#[diesel(table_name = crate::schema::accounts)] +#[diesel(check_for_backend(diesel::sqlite::Sqlite))] +pub struct Account { + pub email: String, + pub date: NaiveDateTime, +} diff --git a/src/schema.rs b/src/schema.rs new file mode 100644 index 0000000..65fc72d --- /dev/null +++ b/src/schema.rs @@ -0,0 +1,8 @@ +// @generated automatically by Diesel CLI. + +diesel::table! { + accounts (email) { + email -> Text, + date -> Timestamp, + } +} From 40e8445848a0ab14224b478817cad7e4b31e6417 Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Mon, 8 Apr 2024 23:38:50 -0700 Subject: [PATCH 02/10] it all works! --- Cargo.lock | 78 +++++++++- Cargo.toml | 4 + build.rs | 3 + config.toml.sample | 1 + .../down.sql | 1 + .../up.sql | 4 + src/app.rs | 60 +++++++- src/cli.rs | 41 +++++- src/config.rs | 70 ++++++--- src/keys.rs | 139 ++++++++++++++++++ src/lib.rs | 71 +++++++-- src/models.rs | 33 +++++ src/schema.rs | 13 ++ 13 files changed, 471 insertions(+), 47 deletions(-) create mode 100644 build.rs create mode 100644 migrations/2024-04-09-022737_add-email-unsubscribe-url-key/down.sql create mode 100644 migrations/2024-04-09-022737_add-email-unsubscribe-url-key/up.sql create mode 100644 src/keys.rs diff --git a/Cargo.lock b/Cargo.lock index 00201a4..a841d33 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -819,6 +819,17 @@ dependencies = [ "syn 2.0.58", ] +[[package]] +name = "diesel_migrations" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6036b3f0120c5961381b570ee20a02432d7e2d27ea60de9578799cf9156914ac" +dependencies = [ + "diesel", + "migrations_internals", + "migrations_macros", +] + [[package]] name = "diesel_table_macro_syntax" version = "0.1.0" @@ -867,6 +878,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "115531babc129696a58c64a4fef0a8bf9e9698629fb97e9e40767d235cfbcd53" dependencies = [ "pkcs8", + "serde", "signature", ] @@ -878,6 +890,7 @@ checksum = "4a3daa8e81a3963a60642bcc1f90a670680bd4a77535faa384e9d1c79d620871" dependencies = [ "curve25519-dalek", "ed25519", + "rand_core", "serde", "sha2", "subtle", @@ -1548,6 +1561,27 @@ version = "2.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6c8640c5d730cb13ebd907d8d04b52f55ac9a2eec55b440c8892f40d56c76c1d" +[[package]] +name = "migrations_internals" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f23f71580015254b020e856feac3df5878c2c7a8812297edd6c0a485ac9dada" +dependencies = [ + "serde", + "toml 0.7.8", +] + +[[package]] +name = "migrations_macros" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cce3325ac70e67bbab5bd837a31cae01f1a6db64e0e744a33cb03a543469ef08" +dependencies = [ + "migrations_internals", + "proc-macro2", + "quote", +] + [[package]] name = "mime" version = "0.3.17" @@ -2482,6 +2516,8 @@ dependencies = [ "clio", "color-eyre", "diesel", + "diesel_migrations", + "ed25519-dalek", "env_logger", "eyre", "futures", @@ -2492,9 +2528,11 @@ dependencies = [ "reqwest", "serde", "serde_json", + "serde_urlencoded", + "serde_with", "tinytemplate", "tokio", - "toml", + "toml 0.8.12", ] [[package]] @@ -2714,6 +2752,18 @@ dependencies = [ "tracing", ] +[[package]] +name = "toml" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd79e69d3b627db300ff956027cc6c3798cef26d22526befdfcd12feeb6d2257" +dependencies = [ + "serde", + "serde_spanned", + "toml_datetime", + "toml_edit 0.19.15", +] + [[package]] name = "toml" version = "0.8.12" @@ -2724,7 +2774,7 @@ dependencies = [ "serde", "serde_spanned", "toml_datetime", - "toml_edit", + "toml_edit 0.22.9", ] [[package]] @@ -2736,6 +2786,19 @@ dependencies = [ "serde", ] +[[package]] +name = "toml_edit" +version = "0.19.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b5bb770da30e5cbfde35a2d7b9b8a2c4b8ef89548a7a6aeab5c9a576e3e7421" +dependencies = [ + "indexmap 2.2.6", + "serde", + "serde_spanned", + "toml_datetime", + "winnow 0.5.40", +] + [[package]] name = "toml_edit" version = "0.22.9" @@ -2746,7 +2809,7 @@ dependencies = [ "serde", "serde_spanned", "toml_datetime", - "winnow", + "winnow 0.6.5", ] [[package]] @@ -3224,6 +3287,15 @@ version = "0.52.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32b752e52a2da0ddfbdbcc6fceadfeede4c939ed16d13e648833a61dfb611ed8" +[[package]] +name = "winnow" +version = "0.5.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f593a95398737aeed53e489c785df13f3618e41dbcd6718c6addbf1395aa6876" +dependencies = [ + "memchr", +] + [[package]] name = "winnow" version = "0.6.5" diff --git a/Cargo.toml b/Cargo.toml index db2d81d..606876c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -13,6 +13,8 @@ clap = { version = "4.5.4", features = ["derive"] } clio = { version = "0.3.5", features = ["clap-parse"] } color-eyre = "0.6.3" diesel = { version = "2.1.5", features = ["sqlite", "chrono"] } +diesel_migrations = { version = "2.1.0", features = ["sqlite"] } +ed25519-dalek = { version = "2.1.1", features = ["rand_core", "serde"] } env_logger = "0.11.3" eyre = "0.6.12" futures = "0.3.30" @@ -23,6 +25,8 @@ openidconnect = "3.5.0" reqwest = "0.11.27" serde = { version = "1.0.197", features = ["derive"] } serde_json = "1.0.115" +serde_urlencoded = "0.7.1" +serde_with = { version = "3.7.0", features = ["base64"] } tinytemplate = "1.2.1" tokio = { version = "1.37.0", features = ["macros", "rt-multi-thread"] } toml = { version = "0.8.12", features = ["preserve_order"] } diff --git a/build.rs b/build.rs new file mode 100644 index 0000000..3a8149e --- /dev/null +++ b/build.rs @@ -0,0 +1,3 @@ +fn main() { + println!("cargo:rerun-if-changed=migrations"); +} diff --git a/config.toml.sample b/config.toml.sample index 649d1ae..5b7d36e 100644 --- a/config.toml.sample +++ b/config.toml.sample @@ -1,4 +1,5 @@ sqlite_db = "subscribe-list.db" +server_base_url = "https://my-site/" [oidc.google] pretty_name = "Google" diff --git a/migrations/2024-04-09-022737_add-email-unsubscribe-url-key/down.sql b/migrations/2024-04-09-022737_add-email-unsubscribe-url-key/down.sql new file mode 100644 index 0000000..031d0dc --- /dev/null +++ b/migrations/2024-04-09-022737_add-email-unsubscribe-url-key/down.sql @@ -0,0 +1 @@ +DROP TABLE "keys"; \ No newline at end of file diff --git a/migrations/2024-04-09-022737_add-email-unsubscribe-url-key/up.sql b/migrations/2024-04-09-022737_add-email-unsubscribe-url-key/up.sql new file mode 100644 index 0000000..96af126 --- /dev/null +++ b/migrations/2024-04-09-022737_add-email-unsubscribe-url-key/up.sql @@ -0,0 +1,4 @@ +CREATE TABLE "keys" ( + "id" INTEGER PRIMARY KEY CHECK ("id" = 0) NOT NULL DEFAULT 0, + "email-unsubscribe-url" BLOB NOT NULL +) WITHOUT ROWID; \ No newline at end of file diff --git a/src/app.rs b/src/app.rs index 92ebac5..496eecd 100644 --- a/src/app.rs +++ b/src/app.rs @@ -1,4 +1,10 @@ -use crate::{client::async_http_client, config::Config, db::DbThread, models::Account}; +use crate::{ + client::async_http_client, + config::Config, + db::DbThread, + keys::Signed, + models::{Account, Keys}, +}; use actix_session::Session; use actix_web::{ get, @@ -11,6 +17,7 @@ use openidconnect::{ core::{CoreAuthenticationFlow, CoreUserInfoClaims}, AuthorizationCode, CsrfToken, EndUserEmail, Nonce, OAuth2TokenResponse, TokenResponse, }; +use reqwest::Url; use serde::{Deserialize, Serialize}; use std::marker::PhantomData; use tinytemplate::TinyTemplate; @@ -95,6 +102,14 @@ As an anti-spam measure, you need to register using a 3rd-party account: pub struct SubscriptionLoggedInTemplate { pub email: EndUserEmail, } + #[text = r#"Subscription + +

    Bad Signature.

    +
    +Register or Sign In +"#] + #[derive(Debug, Serialize)] + pub struct SubscriptionBadSignature {} } pub fn make_templates() -> TinyTemplate<'static> { @@ -273,6 +288,46 @@ pub async fn login( resp } +#[derive(Serialize, Deserialize)] +#[serde(transparent)] +pub struct EmailUnsubscribeUrlQueryParams { + pub signed_email: Signed, +} + +impl EmailUnsubscribeUrlQueryParams { + pub fn new(email: &EndUserEmail, keys: &Keys) -> Self { + Self { + signed_email: Signed::sign(email, keys.email_unsubscribe_url.secret()).unwrap(), + } + } + pub fn make_url(&self, config: &Config) -> Url { + let mut retval = config.server_base_url.join("/subscription/email").unwrap(); + retval.set_query(Some(&serde_urlencoded::to_string(&self).unwrap())); + retval + } +} + +#[get("/subscription/email")] +pub async fn email_unsubscribe( + keys: web::Data, + session: Session, + query: web::Query, +) -> impl Responder { + let Ok(Ok(email)) = query + .signed_email + .verify(keys.email_unsubscribe_url.secret()) + else { + return HttpResponse::Forbidden() + .content_type(ContentType::html()) + .body(SubscriptionBadSignature {}.render().unwrap()); + }; + SessionState { email }.set(&session); + let mut resp = HttpResponse::SeeOther().body(""); + resp.headers_mut() + .insert(LOCATION, "/subscription".parse().unwrap()); + resp +} + #[get("/subscription/logout")] pub async fn logout(session: Session) -> impl Responder { session.purge(); @@ -341,7 +396,8 @@ pub fn all_services(cfg: &mut ServiceConfig) { .service(login) .service(callback) .service(logout) - .service(unsubscribe); + .service(unsubscribe) + .service(email_unsubscribe); } #[cfg(test)] diff --git a/src/cli.rs b/src/cli.rs index aec9713..f1398dd 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -1,25 +1,52 @@ use crate::config; -use clap::{ArgAction, Args, Parser}; +use clap::{ArgAction, Args, Parser, Subcommand}; use eyre::ensure; -use futures::try_join; +use futures::future::try_join_all; use listenfd::ListenFd; -use std::{net::TcpListener, os::unix::net::UnixListener, path::PathBuf}; + +use std::{future::Future, net::TcpListener, os::unix::net::UnixListener, path::PathBuf, pin::Pin}; #[derive(Parser, Debug)] pub struct CLI { - #[arg(long, value_parser, value_name = "path/to/config.toml")] + #[arg(long, value_name = "path/to/config.toml")] pub config: config::Config, - #[command(flatten)] - pub listen: Listen, + #[command(subcommand)] + pub subcommand: CLISubcommand, } impl CLI { pub async fn resolve(&mut self, listenfd: &mut ListenFd) -> eyre::Result<()> { - try_join!(self.config.resolve(), self.listen.resolve(listenfd))?; + let mut futures: Vec> + Send>>> = vec![]; + let resolve_provider_metadata; + match &mut self.subcommand { + CLISubcommand::Serve { listen } => { + resolve_provider_metadata = true; + futures.push(Box::pin(listen.resolve(listenfd))); + } + CLISubcommand::GenerateUnsubscribeUrls { emails: _ } => { + resolve_provider_metadata = false; + } + } + futures.push(Box::pin(self.config.resolve(resolve_provider_metadata))); + try_join_all(futures).await?; + if resolve_provider_metadata { + log::info!("retrieved config from auth servers"); + } Ok(()) } } +#[derive(Subcommand, Debug)] +pub enum CLISubcommand { + Serve { + #[command(flatten)] + listen: Listen, + }, + GenerateUnsubscribeUrls { + emails: Vec, + }, +} + #[derive(Args, Debug)] #[group(required = true)] pub struct Listen { diff --git a/src/config.rs b/src/config.rs index 85fbd61..043f46e 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,13 +1,14 @@ use crate::client::async_http_client; use clap::builder::{TryMapValueParser, TypedValueParser, ValueParserFactory}; use clio::CachedInput; -use eyre::Context; +use eyre::{ensure, Context, OptionExt}; use futures::future::try_join_all; use indexmap::IndexMap; use openidconnect::{ core::{CoreClient, CoreProviderMetadata}, ClientId, ClientSecret, IssuerUrl, RedirectUrl, Scope, }; +use reqwest::Url; use serde::{Deserialize, Serialize}; use std::num::NonZeroU16; @@ -20,17 +21,18 @@ pub struct Config { pub sqlite_db: String, #[serde(default = "default_db_thread_channel_capacity")] pub db_thread_channel_capacity: NonZeroU16, + pub server_base_url: Url, pub oidc: IndexMap, } impl ValueParserFactory for Config { type Parser = TryMapValueParser< ::Parser, - fn(CachedInput) -> eyre::Result, + fn(CachedInput) -> Result, >; fn value_parser() -> Self::Parser { - CachedInput::value_parser().try_map(Config::load) + CachedInput::value_parser().try_map(|v| Config::load(&v).map_err(|e| format!("{e:#}"))) } } @@ -42,13 +44,28 @@ impl Config { toml::from_str(input).wrap_err_with(|| path.to_string()) } - pub fn load(input: CachedInput) -> eyre::Result { + pub fn load(input: &CachedInput) -> eyre::Result { + log::debug!("loading config from: {}", input.path()); let s = std::str::from_utf8(input.get_data()).wrap_err_with(|| input.path().to_string())?; Self::load_str(s, input.path()) } - pub async fn resolve(&mut self) -> eyre::Result<()> { - try_join_all(self.oidc.iter_mut().map(|(_, provider)| provider.resolve())).await?; + pub async fn resolve(&mut self, resolve_provider_metadata: bool) -> eyre::Result<()> { + let expected_server_base_url: Url = self + .server_base_url + .origin() + .ascii_serialization() + .parse() + .ok() + .ok_or_eyre("invalid server_base_url")?; + ensure!( + self.server_base_url == expected_server_base_url, + "invalid server_base_url -- expected {expected_server_base_url}" + ); + try_join_all(self.oidc.iter_mut().map(|(name, provider)| { + provider.resolve(name, resolve_provider_metadata, &self.server_base_url) + })) + .await?; Ok(()) } } @@ -75,21 +92,34 @@ impl OIDCProvider { pub fn state(&self) -> &OIDCProviderState { self.state.as_ref().expect("resolve called by main") } - pub async fn resolve(&mut self) -> eyre::Result<()> { - let provider_metadata = - CoreProviderMetadata::discover_async(self.issuer_url.clone(), async_http_client) - .await?; - let client = CoreClient::from_provider_metadata( - provider_metadata.clone(), - self.client_id.clone(), - Some(self.secret.clone()), + pub async fn resolve( + &mut self, + name: &str, + resolve_provider_metadata: bool, + server_base_url: &Url, + ) -> eyre::Result<()> { + let expected_redirect_url = + server_base_url.join(&format!("/subscription/callback/{name}"))?; + ensure!( + self.redirect_url.as_str() == expected_redirect_url.as_str(), + "oidc.{name:?}.redirect_url should be {expected_redirect_url}" ); - let client = client.disable_openid_scope(); - let client = client.set_redirect_uri(self.redirect_url.clone()); - self.state = Some(OIDCProviderState { - client, - provider_metadata, - }); + if resolve_provider_metadata { + let provider_metadata = + CoreProviderMetadata::discover_async(self.issuer_url.clone(), async_http_client) + .await?; + let client = CoreClient::from_provider_metadata( + provider_metadata.clone(), + self.client_id.clone(), + Some(self.secret.clone()), + ); + let client = client.disable_openid_scope(); + let client = client.set_redirect_uri(self.redirect_url.clone()); + self.state = Some(OIDCProviderState { + client, + provider_metadata, + }); + } Ok(()) } } diff --git a/src/keys.rs b/src/keys.rs new file mode 100644 index 0000000..d0969e7 --- /dev/null +++ b/src/keys.rs @@ -0,0 +1,139 @@ +use crate::models::{Keys, OnlyZero}; +use core::fmt; +use diesel::{ + expression::TypedExpressionType, sql_types::SqlType, Connection, RunQueryDsl, SqliteConnection, +}; +use ed25519_dalek::{ + ed25519::{signature::rand_core::OsRng, SignatureEncoding}, + SignatureError, Signer, Verifier, +}; +use serde::{de::DeserializeOwned, Deserialize, Serialize}; +use serde_with::{ + base64::{Base64, UrlSafe}, + formats::Unpadded, + serde_as, +}; +use std::marker::PhantomData; + +#[derive(Copy, Clone)] +pub struct Key(T); + +impl fmt::Debug for Key { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "Key([redacted])") + } +} + +impl Key { + pub fn new(v: T) -> Self { + Self(v) + } + pub fn secret(&self) -> &T { + &self.0 + } +} + +impl diesel::Queryable for Key +where + Vec: diesel::Queryable, +{ + type Row = as diesel::Queryable>::Row; + + fn build(row: Self::Row) -> diesel::deserialize::Result { + let v = as diesel::Queryable>::build(row)?; + Ok(Key(ed25519_dalek::SigningKey::try_from(&*v)?)) + } +} + +impl diesel::expression::AsExpression + for Key +where + Vec: diesel::expression::AsExpression, +{ + type Expression = as diesel::expression::AsExpression>::Expression; + + fn as_expression(self) -> Self::Expression { + Vec::::from(self.0.to_bytes()).as_expression() + } +} + +impl<'a, T: SqlType + TypedExpressionType> diesel::expression::AsExpression + for &'a Key +where + &'a [u8]: diesel::expression::AsExpression, +{ + type Expression = <&'a [u8] as diesel::expression::AsExpression>::Expression; + + fn as_expression(self) -> Self::Expression { + self.0.as_bytes()[..].as_expression() + } +} + +impl<'a, T: SqlType + TypedExpressionType> diesel::expression::AsExpression + for &'a &'_ Key +where + &'a [u8]: diesel::expression::AsExpression, +{ + type Expression = <&'a [u8] as diesel::expression::AsExpression>::Expression; + + fn as_expression(self) -> Self::Expression { + self.0.as_bytes()[..].as_expression() + } +} + +pub fn get_or_make_keys(db: &mut SqliteConnection) -> eyre::Result { + db.transaction(|db| -> eyre::Result { + let keys: Option = crate::schema::keys::dsl::keys.load(db)?.get(0).cloned(); + if let Some(keys) = keys { + return Ok(keys); + } + let keys = Keys { + id: OnlyZero::Zero, + email_unsubscribe_url: Key::new(ed25519_dalek::SigningKey::generate(&mut OsRng)), + }; + diesel::insert_into(crate::schema::keys::dsl::keys) + .values(keys.clone()) + .execute(db)?; + Ok(keys) + }) +} + +#[serde_as] +#[derive(Serialize, Deserialize)] +pub struct Signed { + #[serde(rename = "v")] + value: String, + #[serde(rename = "s", bound(deserialize = "S::Repr: TryFrom>"))] + #[serde_as(as = "Base64")] + signature: S::Repr, + #[serde(skip)] + _phantom: PhantomData<(fn() -> T, S)>, +} + +impl Signed { + pub fn sign(value: &T, key: &K) -> Result + where + K: Signer, + { + let value = serde_json::to_string(value)?; + let signature = key.sign(value.as_bytes()).to_bytes(); + Ok(Self { + value, + signature, + _phantom: PhantomData, + }) + } + pub fn verify(&self, key: &K) -> eyre::Result> + where + K: Verifier, + for<'a> eyre::Report: From<>::Error>, + { + if let Err(e) = key.verify( + &self.value.as_bytes(), + &S::try_from(self.signature.as_ref())?, + ) { + return Ok(Err(e)); + } + Ok(Ok(serde_json::from_str(&self.value)?)) + } +} diff --git a/src/lib.rs b/src/lib.rs index ae458de..0887a55 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,33 +1,38 @@ use crate::{ - cli::{Listen, ListenFdSocket, ListenFdSockets}, + app::EmailUnsubscribeUrlQueryParams, + cli::{CLISubcommand, Listen, ListenFdSocket, ListenFdSockets}, + config::Config, db::DbThread, + keys::get_or_make_keys, + models::Keys, }; use actix_session::{storage::CookieSessionStore, SessionMiddleware}; use actix_web::{cookie::Key, web, App, HttpServer}; use clap::Parser; use diesel::Connection; +use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness}; +use eyre::eyre; use listenfd::ListenFd; +use openidconnect::EndUserEmail; + +pub const MIGRATIONS: EmbeddedMigrations = embed_migrations!(); mod app; mod cli; mod client; mod config; mod db; +mod keys; mod models; mod schema; -pub async fn main() -> eyre::Result<()> { - env_logger::init(); - let mut listenfd = ListenFd::from_env(); - color_eyre::install()?; - let mut args = cli::CLI::parse(); - let db = web::Data::new(DbThread::new( - diesel::SqliteConnection::establish(&args.config.sqlite_db)?, - args.config.db_thread_channel_capacity.get().into(), - )); - args.resolve(&mut listenfd).await?; - log::info!("retrieved config from auth servers"); - let config = web::Data::new(args.config); +pub async fn run_server( + config: Config, + db: web::Data, + keys: web::Data, + listen: Listen, +) -> eyre::Result<()> { + let config = web::Data::new(config); let cookie_session_key = Key::generate(); let mut server = HttpServer::new(move || { let cookie_session = @@ -38,13 +43,14 @@ pub async fn main() -> eyre::Result<()> { .wrap(cookie_session) .app_data(config.clone()) .app_data(db.clone()) + .app_data(keys.clone()) .configure(app::all_services) }); let Listen { listen_tcp, listen_unix, listen_fd, - } = &mut args.listen; + } = listen; for sock in listen_tcp.iter() { server = server.bind_auto_h2c(sock)?; } @@ -52,7 +58,7 @@ pub async fn main() -> eyre::Result<()> { server = server.bind_uds(sock)?; } if let Some(ListenFdSockets(sockets)) = listen_fd { - for sock in sockets.drain(..) { + for sock in sockets.into_iter() { server = match sock { ListenFdSocket::Tcp(sock) => server.listen_auto_h2c(sock)?, ListenFdSocket::Unix(sock) => server.listen_uds(sock)?, @@ -63,3 +69,38 @@ pub async fn main() -> eyre::Result<()> { server.run().await?; Ok(()) } + +pub async fn generate_unsubscribe_urls( + config: Config, + keys: web::Data, + emails: Vec, +) -> eyre::Result<()> { + for email in emails { + let email = EndUserEmail::new(email); + let url = EmailUnsubscribeUrlQueryParams::new(&email, &keys).make_url(&config); + println!("{url}"); + } + Ok(()) +} + +pub async fn main() -> eyre::Result<()> { + env_logger::init(); + let mut listenfd = ListenFd::from_env(); + color_eyre::install()?; + let mut cli = cli::CLI::parse(); + let mut db = diesel::SqliteConnection::establish(&cli.config.sqlite_db)?; + db.run_pending_migrations(MIGRATIONS) + .map_err(|e| eyre!(e))?; + let keys = web::Data::new(get_or_make_keys(&mut db)?); + let db = web::Data::new(DbThread::new( + db, + cli.config.db_thread_channel_capacity.get().into(), + )); + cli.resolve(&mut listenfd).await?; + match cli.subcommand { + CLISubcommand::Serve { listen } => run_server(cli.config, db, keys, listen).await, + CLISubcommand::GenerateUnsubscribeUrls { emails } => { + generate_unsubscribe_urls(cli.config, keys, emails).await + } + } +} diff --git a/src/models.rs b/src/models.rs index d0a643a..502ab72 100644 --- a/src/models.rs +++ b/src/models.rs @@ -1,5 +1,7 @@ +use crate::keys::Key; use chrono::NaiveDateTime; use diesel::prelude::*; +use eyre::ensure; #[derive(Queryable, Selectable, Insertable)] #[diesel(table_name = crate::schema::accounts)] @@ -8,3 +10,34 @@ pub struct Account { pub email: String, pub date: NaiveDateTime, } + +#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)] +pub enum OnlyZero { + #[default] + Zero = 0, +} + +impl From for i32 { + fn from(_value: OnlyZero) -> Self { + 0 + } +} + +impl TryFrom for OnlyZero { + type Error = eyre::Report; + + fn try_from(value: i32) -> Result { + ensure!(value == 0, "tried to convert nonzero value into OnlyZero"); + Ok(OnlyZero::Zero) + } +} + +#[derive(Queryable, Selectable, Insertable, Clone)] +#[diesel(table_name = crate::schema::keys)] +#[diesel(check_for_backend(diesel::sqlite::Sqlite))] +pub struct Keys { + #[diesel(serialize_as = i32)] + #[diesel(deserialize_as = i32)] + pub id: OnlyZero, + pub email_unsubscribe_url: Key, +} diff --git a/src/schema.rs b/src/schema.rs index 65fc72d..93f31d2 100644 --- a/src/schema.rs +++ b/src/schema.rs @@ -6,3 +6,16 @@ diesel::table! { date -> Timestamp, } } + +diesel::table! { + keys (id) { + id -> Integer, + #[sql_name = "email-unsubscribe-url"] + email_unsubscribe_url -> Binary, + } +} + +diesel::allow_tables_to_appear_in_same_query!( + accounts, + keys, +); From a5e75b3dcab23960b87162bb8bb167005daed2ad Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Mon, 8 Apr 2024 23:42:02 -0700 Subject: [PATCH 03/10] add license --- Cargo.toml | 4 +- LICENSE.md | 675 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 677 insertions(+), 2 deletions(-) create mode 100644 LICENSE.md diff --git a/Cargo.toml b/Cargo.toml index 606876c..568c602 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,8 +2,8 @@ name = "subscribe-list" version = "0.1.0" edition = "2021" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +license = "GPL-3.0-or-later" +publish = false [dependencies] actix-session = { version = "0.9.0", features = ["cookie-session"] } diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..496acdb --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . From 14f1c5addc0a51bf12958b99a618ae4ee68f066f Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Tue, 9 Apr 2024 22:01:48 -0700 Subject: [PATCH 04/10] add config for systemd --- config.toml.sample | 2 +- subscribe-list.service | 14 ++++++++++++++ subscribe-list.socket | 11 +++++++++++ 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 subscribe-list.service create mode 100644 subscribe-list.socket diff --git a/config.toml.sample b/config.toml.sample index 5b7d36e..37a5d0b 100644 --- a/config.toml.sample +++ b/config.toml.sample @@ -1,4 +1,4 @@ -sqlite_db = "subscribe-list.db" +sqlite_db = "/var/local/lib/subscribe-list.db" server_base_url = "https://my-site/" [oidc.google] diff --git a/subscribe-list.service b/subscribe-list.service new file mode 100644 index 0000000..47253fd --- /dev/null +++ b/subscribe-list.service @@ -0,0 +1,14 @@ +[Unit] +Description=web server for managing subscriptions +Requires=subscribe-list.socket + +[Service] +Environment=RUST_LOG=info +Type=exec +ExecStart=!sh -c 'mkdir -p /var/local/lib; umask 007; touch /var/local/lib/subscribe-list.db; chown www-data:www-data /var/local/lib/subscribe-list.db' +ExecStart=/usr/local/bin/subscribe-list --config /etc/subscribe-list/config.toml serve --listen-fd +User=www-data +Group=www-data + +[Install] +Also=subscribe-list.socket \ No newline at end of file diff --git a/subscribe-list.socket b/subscribe-list.socket new file mode 100644 index 0000000..b0f76eb --- /dev/null +++ b/subscribe-list.socket @@ -0,0 +1,11 @@ +[Unit] +Description=subscribe-list socket + +[Socket] +ListenStream=/run/subscribe-list.socket +SocketMode=0660 +SocketUser=www-data +SocketGroup=www-data + +[Install] +WantedBy=sockets.target From cf8af5d173848fae489eff172cd234c3ba2e82d3 Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Wed, 10 Apr 2024 00:25:52 -0700 Subject: [PATCH 05/10] add config for cargo-deb --- Cargo.toml | 15 +++++++++++++++ config.toml.sample | 2 +- debian/postinst | 42 ++++++++++++++++++++++++++++++++++++++++++ subscribe-list.service | 4 ++-- 4 files changed, 60 insertions(+), 3 deletions(-) create mode 100755 debian/postinst diff --git a/Cargo.toml b/Cargo.toml index 568c602..e1990f3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,8 @@ name = "subscribe-list" version = "0.1.0" edition = "2021" +authors = ["Jacob Lifshay "] +description = "web server for managing subscriptions" license = "GPL-3.0-or-later" publish = false @@ -30,3 +32,16 @@ serde_with = { version = "3.7.0", features = ["base64"] } tinytemplate = "1.2.1" tokio = { version = "1.37.0", features = ["macros", "rt-multi-thread"] } toml = { version = "0.8.12", features = ["preserve_order"] } + +[package.metadata.deb] +depends = ["$auto", "adduser (>= 3.11)"] +assets = [ + ["target/release/subscribe-list", "usr/bin/", "755"], + ["config.toml.sample", "usr/share/subscribe-list/config.toml.sample", "644"], +] +maintainer-scripts = "debian" + +[package.metadata.deb.systemd-units] +unit-name = "subscribe-list" +unit-scripts = "." +enable = false \ No newline at end of file diff --git a/config.toml.sample b/config.toml.sample index 37a5d0b..42c7e5d 100644 --- a/config.toml.sample +++ b/config.toml.sample @@ -1,4 +1,4 @@ -sqlite_db = "/var/local/lib/subscribe-list.db" +sqlite_db = "/var/lib/subscribe-list/list.db" server_base_url = "https://my-site/" [oidc.google] diff --git a/debian/postinst b/debian/postinst new file mode 100755 index 0000000..422d058 --- /dev/null +++ b/debian/postinst @@ -0,0 +1,42 @@ +#!/bin/sh +set -e + +case "$1" in + configure) + if ! getent group | grep -q "^www-data:"; then + echo -n "Adding group www-data.." + addgroup --quiet --system www-data 2>/dev/null || true + echo ".done" + fi + test -d /var/www || mkdir /var/www + if ! getent passwd | grep -q "^www-data:"; then + echo -n "Adding system user www-data.." + adduser --quiet --system --ingroup www-data --no-create-home --disabled-password www-data 2>/dev/null || true + echo ".done" + fi + usermod -c www-data -d /var/www -g www-data www-data + if ! test -d /var/lib/subscribe-list/; then + mkdir -m 750 /var/lib/subscribe-list/ + touch /var/lib/subscribe-list/list.db + chmod 640 /var/lib/subscribe-list/list.db + chown -R www-data:www-data /var/lib/subscribe-list/ + fi + if ! test -d /etc/subscribe-list/; then + mkdir -m 750 /etc/subscribe-list/ + install -m 640 /usr/share/subscribe-list/config.toml.sample /etc/subscribe-list/config.toml + chown -R root:www-data /etc/subscribe-list/ + fi + ;; + + abort-upgrade|abort-remove|abort-deconfigure) + ;; + + *) + echo "postinst called with unknown argument \`$1'" >&2 + exit 1 + ;; +esac + +#DEBHELPER# + +exit 0 \ No newline at end of file diff --git a/subscribe-list.service b/subscribe-list.service index 47253fd..a916eba 100644 --- a/subscribe-list.service +++ b/subscribe-list.service @@ -5,8 +5,8 @@ Requires=subscribe-list.socket [Service] Environment=RUST_LOG=info Type=exec -ExecStart=!sh -c 'mkdir -p /var/local/lib; umask 007; touch /var/local/lib/subscribe-list.db; chown www-data:www-data /var/local/lib/subscribe-list.db' -ExecStart=/usr/local/bin/subscribe-list --config /etc/subscribe-list/config.toml serve --listen-fd +ExecStart=test -f /var/lib/subscribe-list/list.db +ExecStart=/usr/bin/subscribe-list --config /etc/subscribe-list/config.toml serve --listen-fd User=www-data Group=www-data From d05a80f850c2059e049d16c93c131ce7246beb6e Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Wed, 10 Apr 2024 00:38:10 -0700 Subject: [PATCH 06/10] fix typo ExecStart -> ExecStartPre --- subscribe-list.service | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subscribe-list.service b/subscribe-list.service index a916eba..06e4ac9 100644 --- a/subscribe-list.service +++ b/subscribe-list.service @@ -5,7 +5,7 @@ Requires=subscribe-list.socket [Service] Environment=RUST_LOG=info Type=exec -ExecStart=test -f /var/lib/subscribe-list/list.db +ExecStartPre=test -f /var/lib/subscribe-list/list.db ExecStart=/usr/bin/subscribe-list --config /etc/subscribe-list/config.toml serve --listen-fd User=www-data Group=www-data From f7f9785d8b2f42f9417129b614edfbe8d0fe4778 Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Wed, 10 Apr 2024 00:43:52 -0700 Subject: [PATCH 07/10] change socket permissions --- subscribe-list.socket | 3 --- 1 file changed, 3 deletions(-) diff --git a/subscribe-list.socket b/subscribe-list.socket index b0f76eb..8083ff1 100644 --- a/subscribe-list.socket +++ b/subscribe-list.socket @@ -3,9 +3,6 @@ Description=subscribe-list socket [Socket] ListenStream=/run/subscribe-list.socket -SocketMode=0660 -SocketUser=www-data -SocketGroup=www-data [Install] WantedBy=sockets.target From 21c8b35bbacaf10de11aa7a979f27cae484eb9b0 Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Thu, 11 Apr 2024 01:49:26 -0700 Subject: [PATCH 08/10] use templates generated from website.git --- .gitmodules | 3 ++ Cargo.lock | 3 +- Cargo.toml | 7 +++-- build.rs | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++-- src/app.rs | 35 ++++++++++------------- website | 1 + 6 files changed, 104 insertions(+), 25 deletions(-) create mode 100644 .gitmodules create mode 160000 website diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..819396e --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "website"] + path = website + url = https://git.libre-chip.org/libre-chip/website.git diff --git a/Cargo.lock b/Cargo.lock index a841d33..f9b6cc2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2507,7 +2507,7 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] name = "subscribe-list" -version = "0.1.0" +version = "0.1.1" dependencies = [ "actix-session", "actix-web", @@ -2525,6 +2525,7 @@ dependencies = [ "listenfd", "log", "openidconnect", + "regex", "reqwest", "serde", "serde_json", diff --git a/Cargo.toml b/Cargo.toml index e1990f3..5f88576 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "subscribe-list" -version = "0.1.0" +version = "0.1.1" edition = "2021" authors = ["Jacob Lifshay "] description = "web server for managing subscriptions" @@ -33,6 +33,9 @@ tinytemplate = "1.2.1" tokio = { version = "1.37.0", features = ["macros", "rt-multi-thread"] } toml = { version = "0.8.12", features = ["preserve_order"] } +[build-dependencies] +regex = "1.10.4" + [package.metadata.deb] depends = ["$auto", "adduser (>= 3.11)"] assets = [ @@ -44,4 +47,4 @@ maintainer-scripts = "debian" [package.metadata.deb.systemd-units] unit-name = "subscribe-list" unit-scripts = "." -enable = false \ No newline at end of file +enable = false diff --git a/build.rs b/build.rs index 3a8149e..47838f7 100644 --- a/build.rs +++ b/build.rs @@ -1,3 +1,79 @@ -fn main() { - println!("cargo:rerun-if-changed=migrations"); +use regex::Regex; +use std::{collections::HashSet, env, error::Error, fs, path::Path, process::Command}; + +fn escape_template(v: &str) -> Result { + let cant_escape = "\\{"; + if v.contains(cant_escape) { + return Err(format!("can't escape {cant_escape}")); + } + Ok(v.replace("{", "\\{")) +} + +fn main() -> Result<(), Box> { + println!("cargo:rerun-if-changed=migrations"); + println!("cargo:rerun-if-changed=website"); + let out_dir = env::var_os("OUT_DIR").unwrap(); + let website_dir = Path::new(&out_dir).join("website"); + let templates_dir = Path::new(&out_dir).join("templates"); + fs::create_dir_all(&templates_dir)?; + let status = Command::new("mdbook") + .arg("build") + .arg("--dest-dir") + .arg(&website_dir) + .current_dir("website") + .status() + .map_err(|e| format!("Can't run mdbook: {e}"))?; + if !status.success() { + return Err(format!("mdbook exited with an error: {status:?}").into()); + } + let sub_template_path = website_dir.join("subscription/index.html"); + let sub_template = fs::read_to_string(&sub_template_path) + .map_err(|e| format!("Error reading {}: {e}", sub_template_path.display()))?; + let regex = Regex::new(r#"(?s)