MM-61707 (#29606)

* updating maxattempts for ldap

server/channels/app/authentication.go

@@ -64,8 +64,8 @@ func (a *App) IsPasswordValid(rctx request.CTX, password string) *model.AppError
 func (a *App) CheckPasswordAndAllCriteria(rctx request.CTX, userID string, password string, mfaToken string) *model.AppError {
 	// MM-37585
 	// Use locks to avoid concurrently checking AND updating the failed login attempts.
-	a.ch.loginAttemptsMut.Lock()
-	defer a.ch.loginAttemptsMut.Unlock()
+	a.ch.emailLoginAttemptsMut.Lock()
+	defer a.ch.emailLoginAttemptsMut.Unlock()
 
 	user, err := a.GetUser(userID)
 	if err != nil {
@@ -149,31 +149,86 @@ func (a *App) DoubleCheckPassword(rctx request.CTX, user *model.User, password s
 	return nil
 }
 
-func (a *App) checkLdapUserPasswordAndAllCriteria(rctx request.CTX, ldapId *string, password string, mfaToken string) (*model.User, *model.AppError) {
-	if a.Ldap() == nil || ldapId == nil {
+func (a *App) checkLdapUserPasswordAndAllCriteria(rctx request.CTX, user *model.User, password, mfaToken string) (*model.User, *model.AppError) {
+	// MM-37585: Use locks to avoid concurrently checking AND updating the failed login attempts.
+	a.ch.ldapLoginAttemptsMut.Lock()
+	defer a.ch.ldapLoginAttemptsMut.Unlock()
+
+	// We need to get the latest value of the user from the database after we acquire the lock. user is nil for first-time LDAP users.
+	if user.Id != "" {
+		var err *model.AppError
+		user, err = a.GetUser(user.Id)
+		if err != nil {
+			if err.Id != MissingAccountError {
+				err.StatusCode = http.StatusInternalServerError
+				return nil, err
+			}
+			err.StatusCode = http.StatusBadRequest
+			return nil, err
+		}
+	}
+
+	ldapID := user.AuthData
+
+	if a.Ldap() == nil || ldapID == nil {
 		err := model.NewAppError("doLdapAuthentication", "api.user.login_ldap.not_available.app_error", nil, "", http.StatusNotImplemented)
 		return nil, err
 	}
 
-	ldapUser, err := a.Ldap().DoLogin(rctx, *ldapId, password)
+	// First time LDAP users will not have a userID
+	if user.Id != "" {
+		if err := checkUserLoginAttempts(user, *a.Config().LdapSettings.MaximumLoginAttempts); err != nil {
+			return nil, err
+		}
+	}
+
+	ldapUser, err := a.Ldap().DoLogin(rctx, *ldapID, password)
 	if err != nil {
+		// If this is a new LDAP user, we need to get the user from the database because DoLogin will have created the user.
+		if user.Id == "" {
+			var getUserByAuthErr *model.AppError
+			ldapUser, getUserByAuthErr = a.GetUserByAuth(ldapID, model.UserAuthServiceLdap)
+			if getUserByAuthErr != nil {
+				return nil, getUserByAuthErr
+			}
+		} else {
+			ldapUser = user
+		}
+
 		// Log a info to make it easier to admin to spot that a user tried to log in with a legitimate user name.
 		if err.Id == "ent.ldap.do_login.invalid_password.app_error" {
-			rctx.Logger().LogM(mlog.MlvlLDAPInfo, "A user tried to sign in, which matched an LDAP account, but the password was incorrect.", mlog.String("ldap_id", *ldapId))
+			rctx.Logger().LogM(mlog.MlvlLDAPInfo, "A user tried to sign in, which matched an LDAP account, but the password was incorrect.", mlog.String("ldap_id", *ldapID))
+
+			if passErr := a.Srv().Store().User().UpdateFailedPasswordAttempts(ldapUser.Id, ldapUser.FailedAttempts+1); passErr != nil {
+				return nil, model.NewAppError("CheckPasswordAndAllCriteria", "app.user.update_failed_pwd_attempts.app_error", nil, "", http.StatusInternalServerError).Wrap(passErr)
+			}
 		}
 
 		err.StatusCode = http.StatusUnauthorized
 		return nil, err
 	}
 
-	if err := a.CheckUserMfa(rctx, ldapUser, mfaToken); err != nil {
+	if err = a.CheckUserMfa(rctx, ldapUser, mfaToken); err != nil {
+		// If the mfaToken is not set, we assume the client used this as a pre-flight request to query the server
+		// about the MFA state of the user in question
+		if mfaToken != "" && ldapUser.Id != "" {
+			if passErr := a.Srv().Store().User().UpdateFailedPasswordAttempts(ldapUser.Id, ldapUser.FailedAttempts+1); passErr != nil {
+				return nil, model.NewAppError("CheckPasswordAndAllCriteria", "app.user.update_failed_pwd_attempts.app_error", nil, "", http.StatusInternalServerError).Wrap(passErr)
+			}
+		}
 		return nil, err
 	}
 
-	if err := checkUserNotDisabled(ldapUser); err != nil {
+	if err = checkUserNotDisabled(ldapUser); err != nil {
 		return nil, err
 	}
 
+	if ldapUser.FailedAttempts > 0 {
+		if passErr := a.Srv().Store().User().UpdateFailedPasswordAttempts(ldapUser.Id, 0); passErr != nil {
+			return nil, model.NewAppError("CheckPasswordAndAllCriteria", "app.user.update_failed_pwd_attempts.app_error", nil, "", http.StatusInternalServerError).Wrap(passErr)
+		}
+	}
+
 	// user successfully authenticated
 	return ldapUser, nil
 }
@@ -286,6 +341,9 @@ func (a *App) MFARequired(rctx request.CTX) *model.AppError {
 
 func checkUserLoginAttempts(user *model.User, max int) *model.AppError {
 	if user.FailedAttempts >= max {
+		if user.AuthService == model.UserAuthServiceLdap {
+			return model.NewAppError("checkUserLoginAttempts", "api.user.check_user_login_attempts.too_many_ldap.app_error", nil, "user_id="+user.Id, http.StatusUnauthorized)
+		}
 		return model.NewAppError("checkUserLoginAttempts", "api.user.check_user_login_attempts.too_many.app_error", nil, "user_id="+user.Id, http.StatusUnauthorized)
 	}
 
@@ -316,7 +374,7 @@ func (a *App) authenticateUser(rctx request.CTX, user *model.User, password, mfa
 			return user, err
 		}
 
-		ldapUser, err := a.checkLdapUserPasswordAndAllCriteria(rctx, user.AuthData, password, mfaToken)
+		ldapUser, err := a.checkLdapUserPasswordAndAllCriteria(rctx, user, password, mfaToken)
 		if err != nil {
 			err.StatusCode = http.StatusUnauthorized
 			return user, err

server/channels/app/authentication_test.go

@@ -13,9 +13,11 @@ import (
 	"time"
 
 	"github.com/dgryski/dgoogauth"
+	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 
 	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/v8/einterfaces/mocks"
 )
 
 func TestParseAuthTokenFromRequest(t *testing.T) {
@@ -153,3 +155,211 @@ func TestCheckPasswordAndAllCriteria(t *testing.T) {
 		}
 	})
 }
+
+func TestCheckLdapUserPasswordAndAllCriteria(t *testing.T) {
+	th := SetupEnterprise(t).InitBasic()
+	defer th.TearDown()
+
+	// update config
+	const maxFailedLoginAttempts = 3
+	th.App.UpdateConfig(func(cfg *model.Config) {
+		*cfg.LdapSettings.MaximumLoginAttempts = maxFailedLoginAttempts
+		*cfg.ServiceSettings.EnableMultifactorAuthentication = true
+	})
+
+	mockLdap := &mocks.LdapInterface{}
+	th.App.Channels().Ldap = mockLdap
+
+	authData := model.NewRandomString(32)
+
+	// create an ldap user by calling createUser
+	ldapUser := &model.User{
+		Email:         "ldapuser@mattermost-customer.com",
+		Username:      "ldapuser",
+		AuthService:   model.UserAuthServiceLdap,
+		AuthData:      &authData,
+		EmailVerified: true,
+	}
+	user, appErr := th.App.CreateUser(th.Context, ldapUser)
+	require.Nil(t, appErr)
+	user.AuthData = &authData
+
+	testCases := []struct {
+		name          string
+		password      string
+		expectedErrID string
+		mockDoLogin   func()
+	}{
+		{
+			name:          "valid password",
+			password:      "password",
+			expectedErrID: "",
+			mockDoLogin: func() {
+				mockLdap.Mock.On("DoLogin", th.Context, authData, "password").Return(user, nil)
+			},
+		},
+		{
+			name:          "invalid password",
+			password:      "wrongpassword",
+			expectedErrID: "api.user.check_user_password.invalid.app_error",
+			mockDoLogin: func() {
+				mockLdap.Mock.On("DoLogin", th.Context, authData, "wrongpassword").Return(nil, &model.AppError{Id: "ent.ldap.do_login.invalid_password.app_error"})
+			},
+		},
+		{
+			name:          "too many login attempts",
+			password:      "wrongpassword",
+			expectedErrID: "api.user.check_user_login_attempts.too_many_ldap.app_error",
+			mockDoLogin: func() {
+				mockLdap.Mock.On("DoLogin", th.Context, authData, "wrongpassword").Return(nil, &model.AppError{Id: "ent.ldap.do_login.invalid_password.app_error"}).Once()
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Reset login attempts
+			err := th.App.Srv().Store().User().UpdateFailedPasswordAttempts(user.Id, 0)
+			require.NoError(t, err)
+
+			tc.mockDoLogin()
+
+			ldapUser := user
+
+			// Simulate failed login attempts if necessary
+			if tc.expectedErrID == "api.user.check_user_login_attempts.too_many_ldap.app_error" {
+				for i := 0; i < maxFailedLoginAttempts-1; i++ {
+					_, appErr = th.App.checkLdapUserPasswordAndAllCriteria(th.Context, ldapUser, "wrongpassword", "")
+					require.NotNil(t, appErr)
+					require.Equal(t, "ent.ldap.do_login.invalid_password.app_error", appErr.Id)
+				}
+			}
+			// Call the method with the test case parameters
+			_, appErr := th.App.checkLdapUserPasswordAndAllCriteria(th.Context, ldapUser, tc.password, "")
+
+			// Verify the returned error matches the expected error
+			if tc.expectedErrID == "" {
+				require.Nil(t, appErr)
+			} else {
+				require.NotNil(t, appErr)
+			}
+
+			if tc.expectedErrID == "api.user.check_user_login_attempts.too_many_ldap.app_error" {
+				updatedUser, err := th.App.GetUser(ldapUser.Id)
+				require.Nil(t, err)
+				require.Equal(t, maxFailedLoginAttempts, updatedUser.FailedAttempts)
+			}
+		})
+	}
+}
+
+func TestCheckLdapUserPasswordConcurrency(t *testing.T) {
+	th := SetupEnterprise(t).InitBasic()
+	defer th.TearDown()
+
+	// update config
+	const maxFailedLoginAttempts = 1
+	const concurrentAttempts = 10
+	th.App.UpdateConfig(func(cfg *model.Config) {
+		*cfg.LdapSettings.MaximumLoginAttempts = maxFailedLoginAttempts
+		*cfg.ServiceSettings.EnableMultifactorAuthentication = true
+	})
+
+	authData := model.NewRandomString(32)
+
+	// create an ldap user by calling createUser
+	ldapUser := &model.User{
+		Email:         "ldapuser@mattermost-customer.com",
+		Username:      "ldapuser",
+		AuthService:   model.UserAuthServiceLdap,
+		AuthData:      &authData,
+		EmailVerified: true,
+	}
+	user, appErr := th.App.CreateUser(th.Context, ldapUser)
+	require.Nil(t, appErr)
+
+	// setup MFA
+	secret, appErr := th.App.GenerateMfaSecret(user.Id)
+	require.Nil(t, appErr)
+	err := th.Server.Store().User().UpdateMfaActive(user.Id, true)
+	require.NoError(t, err)
+	err = th.Server.Store().User().UpdateMfaSecret(user.Id, secret.Secret)
+	require.NoError(t, err)
+
+	user, appErr = th.App.GetUser(user.Id)
+	require.Nil(t, appErr)
+	user.AuthData = &authData
+
+	t.Run("validate concurrent failed attempts to bypass checks", func(t *testing.T) {
+		testCases := []struct {
+			name                 string
+			password             string
+			mfaToken             string
+			expectedErrID        string
+			doLoginExpectedErrID string
+		}{
+			{
+				name:                 "should not breach max. login attempts when password is wrong",
+				password:             "wrong password",
+				mfaToken:             "",
+				doLoginExpectedErrID: "ent.ldap.do_login.invalid_password.app_error",
+				expectedErrID:        "ent.ldap.do_login.invalid_password.app_error",
+			},
+			{
+				name:                 "should not breach max. login attempts when MFA is wrong",
+				password:             "password",
+				mfaToken:             "123456",
+				doLoginExpectedErrID: "",
+				expectedErrID:        "api.user.check_user_mfa.bad_code.app_error",
+			},
+		}
+
+		for _, tc := range testCases {
+			t.Run(tc.name, func(t *testing.T) {
+				mockLdap := &mocks.LdapInterface{}
+				th.App.Channels().Ldap = mockLdap
+				// Reset login attempts
+				err := th.App.Srv().Store().User().UpdateFailedPasswordAttempts(user.Id, 0)
+				require.NoError(t, err)
+
+				// Capture all concurrent errors
+				appErrs := make([]*model.AppError, concurrentAttempts)
+
+				// Wait to complete the test
+				var completeWG sync.WaitGroup
+				completeWG.Add(concurrentAttempts)
+
+				for i := 0; i < concurrentAttempts; i++ {
+					go func(i int) {
+						defer completeWG.Done()
+
+						if tc.doLoginExpectedErrID == "ent.ldap.do_login.invalid_password.app_error" {
+							mockLdap.Mock.On("DoLogin", mock.AnythingOfType("*request.Context"), mock.AnythingOfType("string"), mock.AnythingOfType("string")).Return(nil, &model.AppError{Id: tc.doLoginExpectedErrID})
+						} else {
+							mockLdap.Mock.On("DoLogin", mock.AnythingOfType("*request.Context"), mock.AnythingOfType("string"), tc.password).Return(user, nil)
+						}
+						_, appErrs[i] = th.App.checkLdapUserPasswordAndAllCriteria(th.Context, user, tc.password, tc.mfaToken)
+					}(i)
+				}
+
+				completeWG.Wait()
+
+				expectedErrsCount := 0
+				for i := 0; i < concurrentAttempts; i++ {
+					if appErrs[i].Id == tc.expectedErrID {
+						expectedErrsCount++
+						continue
+					}
+
+					if appErrs[i] != nil {
+						require.Equal(t, "api.user.check_user_login_attempts.too_many_ldap.app_error", appErrs[i].Id, "All other errors should be of too many login attempts only.")
+					}
+				}
+
+				// Password/MFA failure attempts should not breach the maxFailedAttempts
+				// even during concurrent access by the same user.
+				require.Equal(t, maxFailedLoginAttempts, expectedErrsCount)
+			})
+		}
+	})
+}

server/channels/app/channels.go

@@ -80,10 +80,11 @@ type Channels struct {
 	postReminderMut  sync.Mutex
 	postReminderTask *model.ScheduledTask
 
-	interruptQuitChan chan struct{}
-	scheduledPostMut  sync.Mutex
-	scheduledPostTask *model.ScheduledTask
-	loginAttemptsMut  sync.Mutex
+	interruptQuitChan     chan struct{}
+	scheduledPostMut      sync.Mutex
+	scheduledPostTask     *model.ScheduledTask
+	emailLoginAttemptsMut sync.Mutex
+	ldapLoginAttemptsMut  sync.Mutex
 }
 
 func NewChannels(s *Server) (*Channels, error) {

server/channels/app/ldap.go

@@ -153,11 +153,8 @@ func (a *App) SwitchLdapToEmail(c request.CTX, ldapPassword, code, email, newPas
 		return "", model.NewAppError("SwitchLdapToEmail", "api.user.ldap_to_email.not_available.app_error", nil, "", http.StatusNotImplemented)
 	}
 
-	if err := ldapInterface.CheckPasswordAuthData(c, *user.AuthData, ldapPassword); err != nil {
-		return "", err
-	}
-
-	if err := a.CheckUserMfa(c, user, code); err != nil {
+	user, err = a.checkLdapUserPasswordAndAllCriteria(c, user, ldapPassword, code)
+	if err != nil {
 		return "", err
 	}
 

server/channels/app/user.go

@@ -2922,3 +2922,12 @@ func (a *App) UserIsFirstAdmin(rctx request.CTX, user *model.User) bool {
 
 	return true
 }
+
+func (a *App) ResetPasswordFailedAttempts(c request.CTX, user *model.User) *model.AppError {
+	err := a.Srv().Store().User().UpdateFailedPasswordAttempts(user.Id, 0)
+	if err != nil {
+		return model.NewAppError("ResetPasswordFailedAttempts", "app.user.reset_password_failed_attempts.app_error", nil, "", http.StatusInternalServerError).Wrap(err)
+	}
+
+	return nil
+}