From bc467368630e66e8b630b4e0440086916141dc87 Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sun, 30 Jul 2023 20:46:44 +0100 Subject: [PATCH 1/7] fix: add an index for expirey --- src/lib.rs | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 2bd7bea..dd2fa11 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -57,9 +57,8 @@ pub async fn db_init(config: &Config) -> Result, Error> { .execute(&pool) .await?; - sqlx::query("CREATE INDEX IF NOT EXISTS index_auth_code ON accounts_new (auth_code)") - .execute(&pool) - .await?; + sqlx::query("CREATE INDEX IF NOT EXISTS index_auth_code ON accounts_new (auth_code)").execute(&pool).await?; + sqlx::query("CREATE INDEX IF NOT EXISTS index_date_expiry ON accounts_new (date_expiry)").execute(&pool).await?; // this is for active use sqlx::query( From a851a81decdd9ca06894def5f9b14ea3cd383c4c Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sun, 30 Jul 2023 21:14:36 +0100 Subject: [PATCH 2/7] feat: started teh password reset option --- src/lib.rs | 34 ++++- src/methods/mod.rs | 1 + src/methods/password_reset.rs | 227 ++++++++++++++++++++++++++++++++++ 3 files changed, 259 insertions(+), 3 deletions(-) create mode 100644 src/methods/password_reset.rs diff --git a/src/lib.rs b/src/lib.rs index dd2fa11..1c2f710 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,7 +25,14 @@ pub struct AccountsNew { pub id_student: String, } -#[derive(Debug, Deserialize, Serialize, sqlx::FromRow)] +#[derive(Debug, Clone, Deserialize, Serialize, sqlx::FromRow)] +pub struct AccountsReset { + pub user: String, + pub auth_code: String, + pub date_expiry: String, +} + +#[derive(Debug, Clone, Deserialize, Serialize, sqlx::FromRow)] pub struct Accounts { pub user: String, pub uid: i64, @@ -57,8 +64,29 @@ pub async fn db_init(config: &Config) -> Result, Error> { .execute(&pool) .await?; - sqlx::query("CREATE INDEX IF NOT EXISTS index_auth_code ON accounts_new (auth_code)").execute(&pool).await?; - sqlx::query("CREATE INDEX IF NOT EXISTS index_date_expiry ON accounts_new (date_expiry)").execute(&pool).await?; + sqlx::query("CREATE INDEX IF NOT EXISTS index_auth_code ON accounts_new (auth_code)") + .execute(&pool) + .await?; + sqlx::query("CREATE INDEX IF NOT EXISTS index_date_expiry ON accounts_new (date_expiry)") + .execute(&pool) + .await?; + + sqlx::query( + "CREATE TABLE IF NOT EXISTS accounts_reset ( + user text primary key, + auth_code text not null, + date_expiry text not null + )", + ) + .execute(&pool) + .await?; + + sqlx::query("CREATE INDEX IF NOT EXISTS index_auth_code ON accounts_reset (auth_code)") + .execute(&pool) + .await?; + sqlx::query("CREATE INDEX IF NOT EXISTS index_date_expiry ON accounts_reset (date_expiry)") + .execute(&pool) + .await?; // this is for active use sqlx::query( diff --git a/src/methods/mod.rs b/src/methods/mod.rs index f4ba1d1..f223eda 100644 --- a/src/methods/mod.rs +++ b/src/methods/mod.rs @@ -1,2 +1,3 @@ pub mod account_new; pub mod account_update; +pub mod password_reset; diff --git a/src/methods/password_reset.rs b/src/methods/password_reset.rs new file mode 100644 index 0000000..64589a2 --- /dev/null +++ b/src/methods/password_reset.rs @@ -0,0 +1,227 @@ +use crate::{get_now_iso, random_string, Accounts, AccountsReset, Config, State}; +use chrono::{Duration, SecondsFormat, Utc}; +use lettre::{ + message::{header, MultiPart, SinglePart}, + transport::smtp::{authentication::Credentials, response::Response, Error}, + Message, SmtpTransport, Transport, +}; +use maud::html; +use sqlx::{Pool, Sqlite}; +use tide::{ + prelude::{json, Deserialize}, + Request, +}; + +#[derive(Debug, Deserialize)] +pub struct PassReset { + user: Option, + email: Option, +} + +/// Handles password resets +/// All responses are success, never want to leak info +pub async fn post_password_reset(mut req: Request) -> tide::Result { + let PassReset { + user, + email, + } = req.body_json().await?; + + // check that any mail is not using @skynet.ie + if let Some(mail) = &email { + if mail.trim().ends_with("@skynet.ie") { + // all responses from this are a success + return Ok(json!({"result": "success"}).into()); + } + } + + let config = &req.state().config; + let db = &req.state().db; + + // considering the local db is updated hourly (or less) use that instead of teh ldap for lookups + let user_details = match db_get_user(db, &user, &email).await { + None => { + return Ok(json!({"result": "success"}).into()); + } + Some(x) => x, + }; + + // user does not have a different email address set + if user_details.mail.trim().ends_with("@skynet.ie") { + return Ok(json!({"result": "success"}).into()); + } + + // check if a recent password reset request happened lately + db_pending_clear_expired(db).await?; + + if db_get_user_reset(db, &user_details.user).await.is_some() { + // reset already requested within timeframe + return Ok(json!({"result": "success"}).into()); + } + + // send mail + let auth = random_string(50); + + if send_mail(config, &user_details, &auth).is_ok() { + // save to db + + save_to_db(db, &user_details, &auth).await?; + } + + Ok(json!({"result": "success"}).into()) +} + +async fn db_get_user(pool: &Pool, user_in: &Option, mail_in: &Option) -> Option { + let user = match user_in { + None => "", + Some(x) => x, + }; + let mail = match mail_in { + None => "", + Some(x) => x, + }; + + if let Ok(res) = sqlx::query_as::<_, Accounts>( + r#" + SELECT * + FROM accounts + WHERE user == ? OR mail ==? + "#, + ) + .bind(user) + .bind(mail) + .fetch_all(pool) + .await + { + if !res.is_empty() { + return Some(res[0].to_owned()); + } + } + + None +} + +async fn db_pending_clear_expired(pool: &Pool) -> Result, sqlx::Error> { + sqlx::query_as::<_, AccountsReset>( + r#" + DELETE + FROM accounts_reset + WHERE date_expiry < ? + "#, + ) + .bind(get_now_iso(false)) + .fetch_all(pool) + .await +} + +async fn db_get_user_reset(pool: &Pool, user: &str) -> Option { + if let Ok(res) = sqlx::query_as::<_, AccountsReset>( + r#" + SELECT * + FROM accounts_reset + WHERE user == ? + "#, + ) + .bind(user) + .fetch_all(pool) + .await + { + if !res.is_empty() { + return Some(res[0].to_owned()); + } + } + + None +} + +fn send_mail(config: &Config, record: &Accounts, auth: &str) -> Result { + let recipient = &record.user; + let mail = &record.mail; + let url_base = "https://sso.skynet.ie"; + let link_new = format!("{url_base}/reset_pw?auth={auth}"); + let discord = "https://discord.gg/mkuKJkCuyM"; + let sender = format!("UL Computer Society <{}>", &config.mail_user); + + // Create the html we want to send. + let html = html! { + head { + title { "Hello from Skynet!" } + style type="text/css" { + "h2, h4 { font-family: Arial, Helvetica, sans-serif; }" + } + } + div style="display: flex; flex-direction: column; align-items: center;" { + h2 { "Hello from Skynet!" } + // Substitute in the name of our recipient. + p { "Hi " (recipient) "," } + p { + "Here is your password reset link:" + br; + a href=(link_new) { (link_new) } + } + p { + "If did not request this please ignore." + } + p { + "UL Computer Society" + br; + "Skynet Team" + br; + a href=(discord) { (discord) } + } + } + }; + + let body_text = format!( + r#" + Hi {recipient} + + Here is your password reset link: + {link_new} + + If did not request this please ignore. + + UL Computer Society + Skynet Team + {discord} + "# + ); + + // Build the message. + let email = Message::builder() + .from(sender.parse().unwrap()) + .to(mail.parse().unwrap()) + .subject("Skynet: Password Reset") + .multipart( + // This is composed of two parts. + // also helps not trip spam settings (uneven number of url's + MultiPart::alternative() + .singlepart(SinglePart::builder().header(header::ContentType::TEXT_PLAIN).body(body_text)) + .singlepart(SinglePart::builder().header(header::ContentType::TEXT_HTML).body(html.into_string())), + ) + .expect("failed to build email"); + + let creds = Credentials::new(config.mail_user.clone(), config.mail_pass.clone()); + + // Open a remote connection to gmail using STARTTLS + let mailer = SmtpTransport::starttls_relay(&config.mail_smtp).unwrap().credentials(creds).build(); + + // Send the email + mailer.send(&email) +} + +async fn save_to_db(db: &Pool, record: &Accounts, auth: &str) -> Result, sqlx::Error> { + // lets start off a 4 hour timeout on password resets + let offset = Utc::now() + Duration::hours(4); + + sqlx::query_as::<_, AccountsReset>( + " + INSERT OR REPLACE INTO accounts_reset (user, auth_code, date_expiry) + VALUES (?1, ?2, ?3) + ", + ) + .bind(record.user.to_owned()) + .bind(auth.to_owned()) + .bind(offset.to_rfc3339_opts(SecondsFormat::Millis, true)) + .fetch_optional(db) + .await +} From 712cd50ff24c9ee0edf2ccde4a97fa02a81aa0b8 Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sun, 30 Jul 2023 22:56:02 +0100 Subject: [PATCH 3/7] feat: handle the receiving of the token --- src/bin/update_groups.rs | 6 +-- src/lib.rs | 4 ++ src/main.rs | 8 +++- src/methods/password_reset.rs | 77 ++++++++++++++++++++++++++++++++++- 4 files changed, 88 insertions(+), 7 deletions(-) diff --git a/src/bin/update_groups.rs b/src/bin/update_groups.rs index e1c4e9d..6d6761c 100644 --- a/src/bin/update_groups.rs +++ b/src/bin/update_groups.rs @@ -1,6 +1,6 @@ use dotenvy::dotenv; use ldap3::{LdapConn, Mod}; -use skynet_ldap_backend::{db_init, get_config, get_now_iso, read_csv, Accounts, Config}; +use skynet_ldap_backend::{db_init, get_config, get_now_iso, read_csv, uid_to_dn, Accounts, Config}; use sqlx::{Pool, Sqlite}; use std::{collections::HashSet, env, error::Error}; @@ -46,10 +46,6 @@ async fn update_users(config: &Config) -> tide::Result<()> { Ok(()) } -fn uid_to_dn(uid: &str) -> String { - format!("uid={},ou=users,dc=skynet,dc=ie", uid) -} - async fn update_admin(config: &Config) -> tide::Result<()> { dotenv().ok(); diff --git a/src/lib.rs b/src/lib.rs index 1c2f710..5994ae2 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -310,3 +310,7 @@ pub fn read_csv(config: &Config) -> Result, Box String { thread_rng().sample_iter(&Alphanumeric).take(len).map(char::from).collect() } + +pub fn uid_to_dn(uid: &str) -> String { + format!("uid={},ou=users,dc=skynet,dc=ie", uid) +} diff --git a/src/main.rs b/src/main.rs index 9cd988f..617f356 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,6 +1,10 @@ use skynet_ldap_backend::{ db_init, get_config, - methods::{account_new::post_new_account, account_update::post_update_ldap}, + methods::{ + account_new::post_new_account, + account_update::post_update_ldap, + password_reset::{post_password_auth, post_password_reset}, + }, State, }; @@ -22,6 +26,8 @@ async fn main() -> tide::Result<()> { app.at("/ldap/update").post(post_update_ldap); app.at("/ldap/new").post(post_new_account); + app.at("/ldap/reset").post(post_password_reset); + app.at("/ldap/reset/auth").post(post_password_auth); app.listen(host_port).await?; Ok(()) diff --git a/src/methods/password_reset.rs b/src/methods/password_reset.rs index 64589a2..b41ea03 100644 --- a/src/methods/password_reset.rs +++ b/src/methods/password_reset.rs @@ -1,5 +1,6 @@ -use crate::{get_now_iso, random_string, Accounts, AccountsReset, Config, State}; +use crate::{get_now_iso, random_string, uid_to_dn, Accounts, AccountsReset, Config, State}; use chrono::{Duration, SecondsFormat, Utc}; +use ldap3::{exop::PasswordModify, LdapConn}; use lettre::{ message::{header, MultiPart, SinglePart}, transport::smtp::{authentication::Credentials, response::Response, Error}, @@ -70,6 +71,40 @@ pub async fn post_password_reset(mut req: Request) -> tide::Result { Ok(json!({"result": "success"}).into()) } +#[derive(Debug, Deserialize)] +pub struct PassResetAuth { + auth: String, + pass: String, +} + +pub async fn post_password_auth(mut req: Request) -> tide::Result { + let PassResetAuth { + auth, + pass, + } = req.body_json().await?; + + let config = &req.state().config; + let db = &req.state().db; + + if db_pending_clear_expired(db).await.is_err() { + return Ok(json!({"result": "success"}).into()); + } + + // check if auth exists + let details = match db_get_user_reset_auth(db, &auth).await { + None => { + return Ok(json!({"result": "success"}).into()); + } + Some(x) => x, + }; + + if ldap_reset_pw(config, &details, &pass).await.is_err() { + return Ok(json!({"result": "error", "error": "ldap error"}).into()); + }; + + Ok(json!({"result": "success", "success": "Password set"}).into()) +} + async fn db_get_user(pool: &Pool, user_in: &Option, mail_in: &Option) -> Option { let user = match user_in { None => "", @@ -133,6 +168,46 @@ async fn db_get_user_reset(pool: &Pool, user: &str) -> Option, auth: &str) -> Option { + if let Ok(res) = sqlx::query_as::<_, AccountsReset>( + r#" + SELECT * + FROM accounts_reset + WHERE auth == ? + "#, + ) + .bind(auth) + .fetch_all(pool) + .await + { + if !res.is_empty() { + return Some(res[0].to_owned()); + } + } + + None +} + +async fn ldap_reset_pw(config: &Config, details: &AccountsReset, pass: &str) -> Result<(), ldap3::LdapError> { + let mut ldap = LdapConn::new(&config.ldap_host)?; + ldap.simple_bind(&config.ldap_admin, &config.ldap_admin_pw)?.success()?; + + let dn = uid_to_dn(&details.user); + + // if so then set password + let tmp = PasswordModify { + // none as we are staying on the same connection + user_id: Some(&dn), + old_pass: None, + new_pass: Some(pass), + }; + + ldap.extended(tmp)?.success()?; + ldap.unbind()?; + + Ok(()) +} + fn send_mail(config: &Config, record: &Accounts, auth: &str) -> Result { let recipient = &record.user; let mail = &record.mail; From e46ae563e0c57ce9984e80b98bcb8669d48725d3 Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sun, 30 Jul 2023 22:58:52 +0100 Subject: [PATCH 4/7] fmt: smol cleanup Related to #4 --- src/main.rs | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/main.rs b/src/main.rs index 617f356..07298aa 100644 --- a/src/main.rs +++ b/src/main.rs @@ -32,7 +32,3 @@ async fn main() -> tide::Result<()> { app.listen(host_port).await?; Ok(()) } - -/* -Password reset via email -*/ From bfe96f0f2c70f9946a9f41e9a229d35698dd2b07 Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sun, 30 Jul 2023 23:14:13 +0100 Subject: [PATCH 5/7] test: bump for pipeline --- Cargo.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/Cargo.toml b/Cargo.toml index 6eaea8c..605df1c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -41,3 +41,4 @@ csv = "1.2" # for email lettre = "0.10.4" maud = "0.25.0" + From 04853f439bfc6e7e1811a4845ad9cb0249cebe69 Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sun, 30 Jul 2023 23:22:40 +0100 Subject: [PATCH 6/7] doc: added documentation for the path --- README.md | 43 +++++++++++++++++++++++++++++++++++ src/methods/password_reset.rs | 4 ++-- 2 files changed, 45 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4392de7..b1e8da4 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,49 @@ Invalid Auth: Generic responses which is used unless otherwise specified above. +### POST /ldap/reset + +```json +{ + "user" : "[OPTIONAL] username looking for reset", + "email" : "[OPTIONAL] email looking for reset" +} +``` + +All responses: +```json +{"result": "success"} +``` + +### POST /ldap/reset/auth + +```json +{ + "auth" : "Auth key from teh email", + "pass" : "Password the user chooses" +} +``` + +Early Errors: +```json +{"result": "error"} +``` + +LDAP error: +```json +{"result": "error", "error": "ldap error"} +``` + +Success: +```json +{"result": "success", "success": "Password set"} +``` + +## Responses + +Generic responses which is used unless otherwise specified above. + + ### Success: HTTP 200 ```json { diff --git a/src/methods/password_reset.rs b/src/methods/password_reset.rs index b41ea03..6d3dd58 100644 --- a/src/methods/password_reset.rs +++ b/src/methods/password_reset.rs @@ -87,13 +87,13 @@ pub async fn post_password_auth(mut req: Request) -> tide::Result { let db = &req.state().db; if db_pending_clear_expired(db).await.is_err() { - return Ok(json!({"result": "success"}).into()); + return Ok(json!({"result": "error"}).into()); } // check if auth exists let details = match db_get_user_reset_auth(db, &auth).await { None => { - return Ok(json!({"result": "success"}).into()); + return Ok(json!({"result": "error"}).into()); } Some(x) => x, }; From 0605bf5e4da9956c430a567732c3b15ab0050fce Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sat, 5 Aug 2023 17:44:54 +0100 Subject: [PATCH 7/7] fix: use the more broad term recovery --- src/methods/password_reset.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/methods/password_reset.rs b/src/methods/password_reset.rs index 6d3dd58..60da73a 100644 --- a/src/methods/password_reset.rs +++ b/src/methods/password_reset.rs @@ -212,7 +212,7 @@ fn send_mail(config: &Config, record: &Accounts, auth: &str) -> Result", &config.mail_user);