Reset admin password CLI

docs/v3.x/cli/CLI.md

@@ -32,7 +32,9 @@ options: [--no-run|--use-npm|--debug|--quickstart|--dbclient=<dbclient> --dbhost
   - **&#60;dbssl&#62;** and **&#60;dbauth&#62;** are available only for `mongo` and are optional.
   - **--dbforce** Allows you to overwrite content if the provided database is not empty. Only available for `postgres`, `mysql`, and is optional.
 
-## strapi develop|dev
+## strapi develop
+
+**Alias**: `dev`
 
 Start a Strapi application with autoReload enabled.
 
@@ -89,7 +91,9 @@ options: [--no-optimization]
 - **strapi build --no-optimization**<br/>
   Builds the administration panel without minimizing the assets. The build duration is faster.
 
-## strapi configuration:dump|config:dump
+## strapi configuration:dump
+
+**Alias**: `config:dump`
 
 Dumps configurations to a file or stdout to help you migrate to production.
 
@@ -120,7 +124,9 @@ In case of doubt, you should avoid committing the dump file into a versioning sy
 
 :::
 
-## strapi configuration:restore|config:restore
+## strapi configuration:restore
+
+**Alias**: `config:restore`
 
 Restores a configuration dump into your application.
 
@@ -151,6 +157,27 @@ When running the restore command, you can choose from three different strategies
 - **merge**: Will create missing keys and merge existing keys with their new value.
 - **keep**: Will create missing keys and keep existing keys as is.
 
+## strapi admin:reset-user-password
+
+**Alias** `admin:reset-password`
+
+Reset an admin user's password.
+You can pass the email and new password as options or set them interactivly if you call the command without passing the options.
+
+**Example**
+
+```bash
+strapi admin:reset-user-password --email=chef@strapi.io --password=Gourmet1234
+```
+
+**Options**
+
+| Option         | Type   | Description               |
+| -------------- | ------ | ------------------------- |
+| -e, --email    | string | The user email            |
+| -p, --password | string | New password for the user |
+| -h, --help     |        | display help for command  |
+
 ## strapi generate:api
 
 Scaffold a complete API with its configurations, controller, model and service.

packages/create-strapi-app/package.json

@@ -20,7 +20,7 @@
     "index.js"
   ],
   "dependencies": {
-    "commander": "^2.20.0",
+    "commander": "6.1.0",
     "strapi-generate-new": "3.2.3"
   },
   "scripts": {

packages/strapi-admin/services/__tests__/user.test.js

@@ -744,4 +744,86 @@ describe('User', () => {
       );
     });
   });
+
+  describe('resetPasswordByEmail', () => {
+    test('Throws on missing user', async () => {
+      const email = 'email@email.fr';
+      const password = 'invalidpass';
+
+      const findOne = jest.fn(() => {
+        return null;
+      });
+
+      global.strapi = {
+        query() {
+          return {
+            findOne,
+          };
+        },
+      };
+
+      await expect(userService.resetPasswordByEmail(email, password)).rejects.toEqual(
+        new Error(`User not found for email: ${email}`)
+      );
+
+      expect(findOne).toHaveBeenCalledWith({ email }, undefined);
+    });
+
+    test.each(['abc', 'Abcd', 'Abcdefgh', 'Abcd123'])(
+      'Throws on invalid password',
+      async password => {
+        const email = 'email@email.fr';
+
+        const findOne = jest.fn(() => ({ id: 1 }));
+
+        global.strapi = {
+          query() {
+            return {
+              findOne,
+            };
+          },
+        };
+
+        await expect(userService.resetPasswordByEmail(email, password)).rejects.toEqual(
+          new Error(
+            'Invalid password. Expected a minimum of 8 characters with at least one number and one uppercase letter'
+          )
+        );
+
+        expect(findOne).toHaveBeenCalledWith({ email }, undefined);
+      }
+    );
+  });
+
+  test('Call the update function with the expected params', async () => {
+    const email = 'email@email.fr';
+    const password = 'Testing1234';
+    const hash = 'hash';
+    const userId = 1;
+
+    const findOne = jest.fn(() => ({ id: userId }));
+    const update = jest.fn();
+    const hashPassword = jest.fn(() => hash);
+
+    global.strapi = {
+      query() {
+        return {
+          findOne,
+          update,
+        };
+      },
+      admin: {
+        services: {
+          auth: {
+            hashPassword,
+          },
+        },
+      },
+    };
+
+    await userService.resetPasswordByEmail(email, password);
+    expect(findOne).toHaveBeenCalledWith({ email }, undefined);
+    expect(update).toHaveBeenCalledWith({ id: userId }, { password: hash });
+    expect(hashPassword).toHaveBeenCalledWith(password);
+  });
 });

packages/strapi-admin/services/user.js

@@ -4,6 +4,7 @@ const _ = require('lodash');
 const { stringIncludes } = require('strapi-utils');
 const { createUser, hasSuperAdminRole } = require('../domain/user');
 const { SUPER_ADMIN_CODE } = require('./constants');
+const { password: passwordValidator } = require('../validation/common-validators');
 
 const sanitizeUserRoles = role => _.pick(role, ['id', 'name', 'description', 'code']);
 
@@ -43,7 +44,7 @@ const create = async attributes => {
 
 /**
  * Update a user in database
- * @param params query params to find the user to update
+ * @param id query params to find the user to update
  * @param attributes A partial user object
  * @returns {Promise<user>}
  */
@@ -89,6 +90,29 @@ const updateById = async (id, attributes) => {
   return strapi.query('user', 'admin').update({ id }, attributes);
 };
 
+/**
+ * Reset a user password by email. (Used in admin:reset CLI)
+ * @param {string} email - user email
+ * @param {string} password - new password
+ */
+const resetPasswordByEmail = async (email, password) => {
+  const user = await findOne({ email });
+
+  if (!user) {
+    throw new Error(`User not found for email: ${email}`);
+  }
+
+  try {
+    await passwordValidator.validate(password);
+  } catch (error) {
+    throw new Error(
+      'Invalid password. Expected a minimum of 8 characters with at least one number and one uppercase letter'
+    );
+  }
+
+  await updateById(user.id, { password });
+};
+
 /**
  * Check if a user is the last super admin
  * @param {int|string} userId user's id to look for
@@ -320,4 +344,5 @@ module.exports = {
   assignARoleToAll,
   displayWarningIfUsersDontHaveRole,
   migrateUsers,
+  resetPasswordByEmail,
 };