From 2d8c8e18f74726303f7789af9731e8a80ce05610 Mon Sep 17 00:00:00 2001 From: BlackDex Date: Tue, 24 Jan 2023 13:06:31 +0100 Subject: [PATCH] Update KDF Configuration and processing - Change default Password Hash KDF Storage from 100_000 to 600_000 iterations - Update Password Hash when the default iteration value is different - Validate password_iterations - Validate client-side KDF to prevent it from being set lower than 100_000 --- .env.template | 6 +++--- src/api/core/accounts.rs | 11 ++++++++--- src/api/core/emergency_access.rs | 2 +- src/api/identity.rs | 13 +++++++++++-- src/config.rs | 10 +++++++--- src/db/models/user.rs | 8 +++++--- 6 files changed, 35 insertions(+), 15 deletions(-) diff --git a/.env.template b/.env.template index 4b323706..1b691298 100644 --- a/.env.template +++ b/.env.template @@ -298,9 +298,9 @@ ## This setting applies globally to all users. # INCOMPLETE_2FA_TIME_LIMIT=3 -## Controls the PBBKDF password iterations to apply on the server -## The change only applies when the password is changed -# PASSWORD_ITERATIONS=100000 +## Number of server-side passwords hashing iterations for the password hash. +## The default for new users. If changed, it will be updated during login for existing users. +# PASSWORD_ITERATIONS=350000 ## Controls whether users can set password hints. This setting applies globally to all users. # PASSWORD_HINTS_ALLOWED=true diff --git a/src/api/core/accounts.rs b/src/api/core/accounts.rs index 758d9028..5faff713 100644 --- a/src/api/core/accounts.rs +++ b/src/api/core/accounts.rs @@ -161,7 +161,7 @@ pub async fn _register(data: JsonUpcase, mut conn: DbConn) -> Json user.client_kdf_type = client_kdf_type; } - user.set_password(&data.MasterPasswordHash, None); + user.set_password(&data.MasterPasswordHash, true, None); user.akey = data.Key; user.password_hint = password_hint; @@ -318,6 +318,7 @@ async fn post_password( user.set_password( &data.NewMasterPasswordHash, + true, Some(vec![String::from("post_rotatekey"), String::from("get_contacts"), String::from("get_public_keys")]), ); user.akey = data.Key; @@ -348,9 +349,13 @@ async fn post_kdf(data: JsonUpcase, headers: Headers, mut conn: D err!("Invalid password") } + if data.KdfIterations < 100_000 { + err!("KDF iterations lower then 100000 are not allowed.") + } + user.client_kdf_iter = data.KdfIterations; user.client_kdf_type = data.Kdf; - user.set_password(&data.NewMasterPasswordHash, None); + user.set_password(&data.NewMasterPasswordHash, true, None); user.akey = data.Key; let save_result = user.save(&mut conn).await; @@ -560,7 +565,7 @@ async fn post_email( user.email_new = None; user.email_new_token = None; - user.set_password(&data.NewMasterPasswordHash, None); + user.set_password(&data.NewMasterPasswordHash, true, None); user.akey = data.Key; let save_result = user.save(&mut conn).await; diff --git a/src/api/core/emergency_access.rs b/src/api/core/emergency_access.rs index f15c1b8e..64ed6d86 100644 --- a/src/api/core/emergency_access.rs +++ b/src/api/core/emergency_access.rs @@ -662,7 +662,7 @@ async fn password_emergency_access( }; // change grantor_user password - grantor_user.set_password(new_master_password_hash, None); + grantor_user.set_password(new_master_password_hash, true, None); grantor_user.akey = key; grantor_user.save(&mut conn).await?; diff --git a/src/api/identity.rs b/src/api/identity.rs index 0cb1c03a..7d004a9c 100644 --- a/src/api/identity.rs +++ b/src/api/identity.rs @@ -130,7 +130,7 @@ async fn _password_login( // Get the user let username = data.username.as_ref().unwrap().trim(); - let user = match User::find_by_mail(username, conn).await { + let mut user = match User::find_by_mail(username, conn).await { Some(user) => user, None => err!("Username or password is incorrect. Try again", format!("IP: {}. Username: {}.", ip.ip, username)), }; @@ -150,6 +150,16 @@ async fn _password_login( ) } + // Change the KDF Iterations + if user.password_iterations != CONFIG.password_iterations() { + user.password_iterations = CONFIG.password_iterations(); + user.set_password(password, false, None); + + if let Err(e) = user.save(conn).await { + error!("Error updating user: {:#?}", e); + } + } + // Check if the user is disabled if !user.enabled { err!( @@ -172,7 +182,6 @@ async fn _password_login( if resend_limit == 0 || user.login_verify_count < resend_limit { // We want to send another email verification if we require signups to verify // their email address, and we haven't sent them a reminder in a while... - let mut user = user; user.last_verifying_at = Some(now); user.login_verify_count += 1; diff --git a/src/config.rs b/src/config.rs index f8990dc0..46deed54 100644 --- a/src/config.rs +++ b/src/config.rs @@ -463,9 +463,9 @@ make_config! { invitation_expiration_hours: u32, false, def, 120; /// Allow emergency access |> Controls whether users can enable emergency access to their accounts. This setting applies globally to all users. emergency_access_allowed: bool, true, def, true; - /// Password iterations |> Number of server-side passwords hashing iterations. - /// The changes only apply when a user changes their password. Not recommended to lower the value - password_iterations: i32, true, def, 100_000; + /// Password iterations |> Number of server-side passwords hashing iterations for the password hash. + /// The default for new users. If changed, it will be updated during login for existing users. + password_iterations: i32, true, def, 600_000; /// Allow password hints |> Controls whether users can set password hints. This setting applies globally to all users. password_hints_allowed: bool, true, def, true; /// Show password hint |> Controls whether a password hint should be shown directly in the web page @@ -673,6 +673,10 @@ fn validate_config(cfg: &ConfigItems) -> Result<(), Error> { } } + if cfg.password_iterations < 100_000 { + err!("PASSWORD_ITERATIONS should be at least 100000 or higher. The default is 600000!"); + } + let limit = 256; if cfg.database_max_conns < 1 || cfg.database_max_conns > limit { err!(format!("`DATABASE_MAX_CONNS` contains an invalid value. Ensure it is between 1 and {limit}.",)); diff --git a/src/db/models/user.rs b/src/db/models/user.rs index 611c4ebb..15aacf1f 100644 --- a/src/db/models/user.rs +++ b/src/db/models/user.rs @@ -74,7 +74,7 @@ pub struct UserStampException { /// Local methods impl User { pub const CLIENT_KDF_TYPE_DEFAULT: i32 = 0; // PBKDF2: 0 - pub const CLIENT_KDF_ITER_DEFAULT: i32 = 100_000; + pub const CLIENT_KDF_ITER_DEFAULT: i32 = 600_000; pub fn new(email: String) -> Self { let now = Utc::now().naive_utc(); @@ -151,14 +151,16 @@ impl User { /// These routes are able to use the previous stamp id for the next 2 minutes. /// After these 2 minutes this stamp will expire. /// - pub fn set_password(&mut self, password: &str, allow_next_route: Option>) { + pub fn set_password(&mut self, password: &str, reset_security_stamp: bool, allow_next_route: Option>) { self.password_hash = crypto::hash_password(password.as_bytes(), &self.salt, self.password_iterations as u32); if let Some(route) = allow_next_route { self.set_stamp_exception(route); } - self.reset_security_stamp() + if reset_security_stamp { + self.reset_security_stamp() + } } pub fn reset_security_stamp(&mut self) {