summaryrefslogtreecommitdiffstats
path: root/cmd/mattermost/commands/user.go
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/mattermost/commands/user.go')
-rw-r--r--cmd/mattermost/commands/user.go715
1 files changed, 715 insertions, 0 deletions
diff --git a/cmd/mattermost/commands/user.go b/cmd/mattermost/commands/user.go
new file mode 100644
index 000000000..ebcebcce8
--- /dev/null
+++ b/cmd/mattermost/commands/user.go
@@ -0,0 +1,715 @@
+// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package commands
+
+import (
+ "encoding/json"
+ "errors"
+ "fmt"
+ "io/ioutil"
+
+ "github.com/mattermost/mattermost-server/app"
+ "github.com/mattermost/mattermost-server/model"
+ "github.com/spf13/cobra"
+)
+
+var UserCmd = &cobra.Command{
+ Use: "user",
+ Short: "Management of users",
+}
+
+var UserActivateCmd = &cobra.Command{
+ Use: "activate [emails, usernames, userIds]",
+ Short: "Activate users",
+ Long: "Activate users that have been deactivated.",
+ Example: ` user activate user@example.com
+ user activate username`,
+ RunE: userActivateCmdF,
+}
+
+var UserDeactivateCmd = &cobra.Command{
+ Use: "deactivate [emails, usernames, userIds]",
+ Short: "Deactivate users",
+ Long: "Deactivate users. Deactivated users are immediately logged out of all sessions and are unable to log back in.",
+ Example: ` user deactivate user@example.com
+ user deactivate username`,
+ RunE: userDeactivateCmdF,
+}
+
+var UserCreateCmd = &cobra.Command{
+ Use: "create",
+ Short: "Create a user",
+ Long: "Create a user",
+ Example: ` user create --email user@example.com --username userexample --password Password1`,
+ RunE: userCreateCmdF,
+}
+
+var UserInviteCmd = &cobra.Command{
+ Use: "invite [email] [teams]",
+ Short: "Send user an email invite to a team.",
+ Long: `Send user an email invite to a team.
+You can invite a user to multiple teams by listing them.
+You can specify teams by name or ID.`,
+ Example: ` user invite user@example.com myteam
+ user invite user@example.com myteam1 myteam2`,
+ RunE: userInviteCmdF,
+}
+
+var ResetUserPasswordCmd = &cobra.Command{
+ Use: "password [user] [password]",
+ Short: "Set a user's password",
+ Long: "Set a user's password",
+ Example: " user password user@example.com Password1",
+ RunE: resetUserPasswordCmdF,
+}
+
+var updateUserEmailCmd = &cobra.Command{
+ Use: "email [user] [new email]",
+ Short: "Change email of the user",
+ Long: "Change email of the user.",
+ Example: ` user email test user@example.com
+ user activate username`,
+ RunE: updateUserEmailCmdF,
+}
+
+var ResetUserMfaCmd = &cobra.Command{
+ Use: "resetmfa [users]",
+ Short: "Turn off MFA",
+ Long: `Turn off multi-factor authentication for a user.
+If MFA enforcement is enabled, the user will be forced to re-enable MFA as soon as they login.`,
+ Example: " user resetmfa user@example.com",
+ RunE: resetUserMfaCmdF,
+}
+
+var DeleteUserCmd = &cobra.Command{
+ Use: "delete [users]",
+ Short: "Delete users and all posts",
+ Long: "Permanently delete user and all related information including posts.",
+ Example: " user delete user@example.com",
+ RunE: deleteUserCmdF,
+}
+
+var DeleteAllUsersCmd = &cobra.Command{
+ Use: "deleteall",
+ Short: "Delete all users and all posts",
+ Long: "Permanently delete all users and all related information including posts.",
+ Example: " user deleteall",
+ RunE: deleteAllUsersCommandF,
+}
+
+var MigrateAuthCmd = &cobra.Command{
+ Use: "migrate_auth [from_auth] [to_auth] [migration-options]",
+ Short: "Mass migrate user accounts authentication type",
+ Long: `Migrates accounts from one authentication provider to another. For example, you can upgrade your authentication provider from email to ldap.`,
+ Example: " user migrate_auth email saml users.json",
+ Args: func(command *cobra.Command, args []string) error {
+ if len(args) < 2 {
+ return errors.New("Auth migration requires at least 2 arguments.")
+ }
+
+ toAuth := args[1]
+
+ if toAuth != "ldap" && toAuth != "saml" {
+ return errors.New("Invalid to_auth parameter, must be saml or ldap.")
+ }
+
+ if toAuth == "ldap" && len(args) != 3 {
+ return errors.New("Ldap migration requires 3 arguments.")
+ }
+
+ autoFlag, _ := command.Flags().GetBool("auto")
+
+ if toAuth == "saml" && autoFlag {
+ if len(args) != 2 {
+ return errors.New("Saml migration requires two arguments when using the --auto flag. See help text for details.")
+ }
+ }
+
+ if toAuth == "saml" && !autoFlag {
+ if len(args) != 3 {
+ return errors.New("Saml migration requires three arguments when not using the --auto flag. See help text for details.")
+ }
+ }
+ return nil
+ },
+ RunE: migrateAuthCmdF,
+}
+
+var VerifyUserCmd = &cobra.Command{
+ Use: "verify [users]",
+ Short: "Verify email of users",
+ Long: "Verify the emails of some users.",
+ Example: " user verify user1",
+ RunE: verifyUserCmdF,
+}
+
+var SearchUserCmd = &cobra.Command{
+ Use: "search [users]",
+ Short: "Search for users",
+ Long: "Search for users based on username, email, or user ID.",
+ Example: " user search user1@mail.com user2@mail.com",
+ RunE: searchUserCmdF,
+}
+
+func init() {
+ UserCreateCmd.Flags().String("username", "", "Required. Username for the new user account.")
+ UserCreateCmd.Flags().String("email", "", "Required. The email address for the new user account.")
+ UserCreateCmd.Flags().String("password", "", "Required. The password for the new user account.")
+ UserCreateCmd.Flags().String("nickname", "", "Optional. The nickname for the new user account.")
+ UserCreateCmd.Flags().String("firstname", "", "Optional. The first name for the new user account.")
+ UserCreateCmd.Flags().String("lastname", "", "Optional. The last name for the new user account.")
+ UserCreateCmd.Flags().String("locale", "", "Optional. The locale (ex: en, fr) for the new user account.")
+ UserCreateCmd.Flags().Bool("system_admin", false, "Optional. If supplied, the new user will be a system administrator. Defaults to false.")
+
+ DeleteUserCmd.Flags().Bool("confirm", false, "Confirm you really want to delete the user and a DB backup has been performed.")
+
+ DeleteAllUsersCmd.Flags().Bool("confirm", false, "Confirm you really want to delete the user and a DB backup has been performed.")
+
+ MigrateAuthCmd.Flags().Bool("force", false, "Force the migration to occur even if there are duplicates on the LDAP server. Duplicates will not be migrated. (ldap only)")
+ MigrateAuthCmd.Flags().Bool("auto", false, "Automatically migrate all users. Assumes the usernames and emails are identical between Mattermost and SAML services. (saml only)")
+ MigrateAuthCmd.Flags().Bool("dryRun", false, "Run a simulation of the migration process without changing the database.")
+ MigrateAuthCmd.SetUsageTemplate(`Usage:
+ platform user migrate_auth [from_auth] [to_auth] [migration-options] [flags]
+
+Examples:
+{{.Example}}
+
+Arguments:
+ from_auth:
+ The authentication service to migrate users accounts from.
+ Supported options: email, gitlab, ldap, saml.
+
+ to_auth:
+ The authentication service to migrate users to.
+ Supported options: ldap, saml.
+
+ migration-options:
+ Migration specific options, full command help for more information.
+
+Flags:
+{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}
+
+Global Flags:
+{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}
+`)
+ MigrateAuthCmd.SetHelpTemplate(`Usage:
+ platform user migrate_auth [from_auth] [to_auth] [migration-options] [flags]
+
+Examples:
+{{.Example}}
+
+Arguments:
+ from_auth:
+ The authentication service to migrate users accounts from.
+ Supported options: email, gitlab, ldap, saml.
+
+ to_auth:
+ The authentication service to migrate users to.
+ Supported options: ldap, saml.
+
+ migration-options (ldap):
+ match_field:
+ The field that is guaranteed to be the same in both authentication services. For example, if the users emails are consistent set to email.
+ Supported options: email, username.
+
+ migration-options (saml):
+ users_file:
+ The path of a json file with the usernames and emails of all users to migrate to SAML. The username and email must be the same that the SAML service provider store. And the email must match with the email in mattermost database.
+
+ Example json content:
+ {
+ "usr1@email.com": "usr.one",
+ "usr2@email.com": "usr.two"
+ }
+
+Flags:
+{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}
+
+Global Flags:
+{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}
+`)
+
+ UserCmd.AddCommand(
+ UserActivateCmd,
+ UserDeactivateCmd,
+ UserCreateCmd,
+ UserInviteCmd,
+ ResetUserPasswordCmd,
+ updateUserEmailCmd,
+ ResetUserMfaCmd,
+ DeleteUserCmd,
+ DeleteAllUsersCmd,
+ MigrateAuthCmd,
+ VerifyUserCmd,
+ SearchUserCmd,
+ )
+ RootCmd.AddCommand(UserCmd)
+}
+
+func userActivateCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) < 1 {
+ return errors.New("Expected at least one argument. See help text for details.")
+ }
+
+ changeUsersActiveStatus(a, args, true)
+
+ return nil
+}
+
+func changeUsersActiveStatus(a *app.App, userArgs []string, active bool) {
+ users := getUsersFromUserArgs(a, userArgs)
+ for i, user := range users {
+ err := changeUserActiveStatus(a, user, userArgs[i], active)
+
+ if err != nil {
+ CommandPrintErrorln(err.Error())
+ }
+ }
+}
+
+func changeUserActiveStatus(a *app.App, user *model.User, userArg string, activate bool) error {
+ if user == nil {
+ return fmt.Errorf("Can't find user '%v'", userArg)
+ }
+ if user.IsSSOUser() {
+ fmt.Println("You must also deactivate this user in the SSO provider or they will be reactivated on next login or sync.")
+ }
+ if _, err := a.UpdateActive(user, activate); err != nil {
+ return fmt.Errorf("Unable to change activation status of user: %v", userArg)
+ }
+
+ return nil
+}
+
+func userDeactivateCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) < 1 {
+ return errors.New("Expected at least one argument. See help text for details.")
+ }
+
+ changeUsersActiveStatus(a, args, false)
+
+ return nil
+}
+
+func userCreateCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ username, erru := command.Flags().GetString("username")
+ if erru != nil || username == "" {
+ return errors.New("Username is required")
+ }
+ email, erre := command.Flags().GetString("email")
+ if erre != nil || email == "" {
+ return errors.New("Email is required")
+ }
+ password, errp := command.Flags().GetString("password")
+ if errp != nil || password == "" {
+ return errors.New("Password is required")
+ }
+ nickname, _ := command.Flags().GetString("nickname")
+ firstname, _ := command.Flags().GetString("firstname")
+ lastname, _ := command.Flags().GetString("lastname")
+ locale, _ := command.Flags().GetString("locale")
+ systemAdmin, _ := command.Flags().GetBool("system_admin")
+
+ user := &model.User{
+ Username: username,
+ Email: email,
+ Password: password,
+ Nickname: nickname,
+ FirstName: firstname,
+ LastName: lastname,
+ Locale: locale,
+ }
+
+ if ruser, err := a.CreateUser(user); err != nil {
+ return errors.New("Unable to create user. Error: " + err.Error())
+ } else if systemAdmin {
+ a.UpdateUserRoles(ruser.Id, "system_user system_admin", false)
+ }
+
+ CommandPrettyPrintln("Created User")
+
+ return nil
+}
+
+func userInviteCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) < 2 {
+ return errors.New("Expected at least two arguments. See help text for details.")
+ }
+
+ email := args[0]
+ if !model.IsValidEmail(email) {
+ return errors.New("Invalid email")
+ }
+
+ teams := getTeamsFromTeamArgs(a, args[1:])
+ for i, team := range teams {
+ err := inviteUser(a, email, team, args[i+1])
+
+ if err != nil {
+ CommandPrintErrorln(err.Error())
+ }
+ }
+
+ return nil
+}
+
+func inviteUser(a *app.App, email string, team *model.Team, teamArg string) error {
+ invites := []string{email}
+ if team == nil {
+ return fmt.Errorf("Can't find team '%v'", teamArg)
+ }
+
+ a.SendInviteEmails(team, "Administrator", invites, *a.Config().ServiceSettings.SiteURL)
+ CommandPrettyPrintln("Invites may or may not have been sent.")
+
+ return nil
+}
+
+func resetUserPasswordCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) != 2 {
+ return errors.New("Expected two arguments. See help text for details.")
+ }
+
+ user := getUserFromUserArg(a, args[0])
+ if user == nil {
+ return errors.New("Unable to find user '" + args[0] + "'")
+ }
+ password := args[1]
+
+ if result := <-a.Srv.Store.User().UpdatePassword(user.Id, model.HashPassword(password)); result.Err != nil {
+ return result.Err
+ }
+
+ return nil
+}
+
+func updateUserEmailCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) != 2 {
+ return errors.New("Expected two arguments. See help text for details.")
+ }
+
+ newEmail := args[1]
+
+ if !model.IsValidEmail(newEmail) {
+ return errors.New("Invalid email: '" + newEmail + "'")
+ }
+
+ if len(args) != 2 {
+ return errors.New("Expected two arguments. See help text for details.")
+ }
+
+ user := getUserFromUserArg(a, args[0])
+ if user == nil {
+ return errors.New("Unable to find user '" + args[0] + "'")
+ }
+
+ user.Email = newEmail
+ _, errUpdate := a.UpdateUser(user, true)
+ if errUpdate != nil {
+ return errors.New(errUpdate.Message)
+ }
+
+ return nil
+}
+
+func resetUserMfaCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) < 1 {
+ return errors.New("Expected at least one argument. See help text for details.")
+ }
+
+ users := getUsersFromUserArgs(a, args)
+
+ for i, user := range users {
+ if user == nil {
+ return errors.New("Unable to find user '" + args[i] + "'")
+ }
+
+ if err := a.DeactivateMfa(user.Id); err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
+func deleteUserCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) < 1 {
+ return errors.New("Expected at least one argument. See help text for details.")
+ }
+
+ confirmFlag, _ := command.Flags().GetBool("confirm")
+ if !confirmFlag {
+ var confirm string
+ CommandPrettyPrintln("Have you performed a database backup? (YES/NO): ")
+ fmt.Scanln(&confirm)
+
+ if confirm != "YES" {
+ return errors.New("ABORTED: You did not answer YES exactly, in all capitals.")
+ }
+ CommandPrettyPrintln("Are you sure you want to permanently delete the specified users? (YES/NO): ")
+ fmt.Scanln(&confirm)
+ if confirm != "YES" {
+ return errors.New("ABORTED: You did not answer YES exactly, in all capitals.")
+ }
+ }
+
+ users := getUsersFromUserArgs(a, args)
+
+ for i, user := range users {
+ if user == nil {
+ return errors.New("Unable to find user '" + args[i] + "'")
+ }
+
+ if err := a.PermanentDeleteUser(user); err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
+func deleteAllUsersCommandF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) > 0 {
+ return errors.New("Expected zero arguments.")
+ }
+
+ confirmFlag, _ := command.Flags().GetBool("confirm")
+ if !confirmFlag {
+ var confirm string
+ CommandPrettyPrintln("Have you performed a database backup? (YES/NO): ")
+ fmt.Scanln(&confirm)
+
+ if confirm != "YES" {
+ return errors.New("ABORTED: You did not answer YES exactly, in all capitals.")
+ }
+ CommandPrettyPrintln("Are you sure you want to permanently delete all user accounts? (YES/NO): ")
+ fmt.Scanln(&confirm)
+ if confirm != "YES" {
+ return errors.New("ABORTED: You did not answer YES exactly, in all capitals.")
+ }
+ }
+
+ if err := a.PermanentDeleteAllUsers(); err != nil {
+ return err
+ }
+
+ CommandPrettyPrintln("All user accounts successfully deleted.")
+
+ return nil
+}
+
+func migrateAuthCmdF(command *cobra.Command, args []string) error {
+ if args[1] == "saml" {
+ return migrateAuthToSamlCmdF(command, args)
+ }
+ return migrateAuthToLdapCmdF(command, args)
+}
+
+func migrateAuthToLdapCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ fromAuth := args[0]
+ matchField := args[2]
+
+ if len(fromAuth) == 0 || (fromAuth != "email" && fromAuth != "gitlab" && fromAuth != "saml") {
+ return errors.New("Invalid from_auth argument")
+ }
+
+ // Email auth in Mattermost system is represented by ""
+ if fromAuth == "email" {
+ fromAuth = ""
+ }
+
+ if len(matchField) == 0 || (matchField != "email" && matchField != "username") {
+ return errors.New("Invalid match_field argument")
+ }
+
+ forceFlag, _ := command.Flags().GetBool("force")
+ dryRunFlag, _ := command.Flags().GetBool("dryRun")
+
+ if migrate := a.AccountMigration; migrate != nil {
+ if err := migrate.MigrateToLdap(fromAuth, matchField, forceFlag, dryRunFlag); err != nil {
+ return errors.New("Error while migrating users: " + err.Error())
+ }
+
+ CommandPrettyPrintln("Successfully migrated accounts.")
+ }
+
+ return nil
+}
+
+func migrateAuthToSamlCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ dryRunFlag, _ := command.Flags().GetBool("dryRun")
+ autoFlag, _ := command.Flags().GetBool("auto")
+
+ matchesFile := ""
+ matches := map[string]string{}
+ if !autoFlag {
+ matchesFile = args[2]
+
+ file, e := ioutil.ReadFile(matchesFile)
+ if e != nil {
+ return errors.New("Invalid users file.")
+ }
+ if json.Unmarshal(file, &matches) != nil {
+ return errors.New("Invalid users file.")
+ }
+ }
+
+ fromAuth := args[0]
+
+ if len(fromAuth) == 0 || (fromAuth != "email" && fromAuth != "gitlab" && fromAuth != "ldap") {
+ return errors.New("Invalid from_auth argument")
+ }
+
+ if autoFlag && !dryRunFlag {
+ var confirm string
+ CommandPrettyPrintln("You are about to perform an automatic \"" + fromAuth + " to saml\" migration. This must only be done if your current Mattermost users with " + fromAuth + " auth have the same username and email in your SAML service. Otherwise, provide the usernames and emails from your SAML Service using the \"users file\" without the \"--auto\" option.\n\nDo you want to proceed with automatic migration anyway? (YES/NO):")
+ fmt.Scanln(&confirm)
+
+ if confirm != "YES" {
+ return errors.New("ABORTED: You did not answer YES exactly, in all capitals.")
+ }
+ }
+
+ // Email auth in Mattermost system is represented by ""
+ if fromAuth == "email" {
+ fromAuth = ""
+ }
+
+ if migrate := a.AccountMigration; migrate != nil {
+ if err := migrate.MigrateToSaml(fromAuth, matches, autoFlag, dryRunFlag); err != nil {
+ return errors.New("Error while migrating users: " + err.Error())
+ }
+
+ CommandPrettyPrintln("Successfully migrated accounts.")
+ }
+
+ return nil
+}
+
+func verifyUserCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) < 1 {
+ return errors.New("Expected at least one argument. See help text for details.")
+ }
+
+ users := getUsersFromUserArgs(a, args)
+
+ for i, user := range users {
+ if user == nil {
+ CommandPrintErrorln("Unable to find user '" + args[i] + "'")
+ continue
+ }
+ if cresult := <-a.Srv.Store.User().VerifyEmail(user.Id); cresult.Err != nil {
+ CommandPrintErrorln("Unable to verify '" + args[i] + "' email. Error: " + cresult.Err.Error())
+ }
+ }
+
+ return nil
+}
+
+func searchUserCmdF(command *cobra.Command, args []string) error {
+ a, err := InitDBCommandContextCobra(command)
+ if err != nil {
+ return err
+ }
+ defer a.Shutdown()
+
+ if len(args) < 1 {
+ return errors.New("Expected at least one argument. See help text for details.")
+ }
+
+ users := getUsersFromUserArgs(a, args)
+
+ for i, user := range users {
+ if i > 0 {
+ CommandPrettyPrintln("------------------------------")
+ }
+ if user == nil {
+ CommandPrintErrorln("Unable to find user '" + args[i] + "'")
+ continue
+ }
+
+ CommandPrettyPrintln("id: " + user.Id)
+ CommandPrettyPrintln("username: " + user.Username)
+ CommandPrettyPrintln("nickname: " + user.Nickname)
+ CommandPrettyPrintln("position: " + user.Position)
+ CommandPrettyPrintln("first_name: " + user.FirstName)
+ CommandPrettyPrintln("last_name: " + user.LastName)
+ CommandPrettyPrintln("email: " + user.Email)
+ CommandPrettyPrintln("auth_service: " + user.AuthService)
+ }
+
+ return nil
+}
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-05-17 08:06:19 +0000