@strapi/plugin-users-permissions 4.13.0-beta.0 → 4.13.0

package/server/controllers/auth.js

@@ -9,7 +9,11 @@
 /* eslint-disable no-useless-escape */
 const crypto = require('crypto');
 const _ = require('lodash');
+const { concat, compact, isArray } = require('lodash/fp');
 const utils = require('@strapi/utils');
+const {
+  contentTypes: { getNonWritableAttributes },
+} = require('@strapi/utils');
 const { getService } = require('../utils');
 const {
   validateCallbackBody,
@@ -273,20 +277,49 @@ module.exports = {
       throw new ApplicationError('Register action is currently disabled');
     }
 
+    const { register } = strapi.config.get('plugin.users-permissions');
+    const alwaysAllowedKeys = ['username', 'password', 'email'];
+    const userModel = strapi.contentTypes['plugin::users-permissions.user'];
+    const { attributes } = userModel;
+
+    const nonWritable = getNonWritableAttributes(userModel);
+
+    const allowedKeys = compact(
+      concat(
+        alwaysAllowedKeys,
+        isArray(register?.allowedFields)
+          ? // Note that we do not filter allowedFields in case a user explicitly chooses to allow a private or otherwise omitted field on registration
+            register.allowedFields // if null or undefined, compact will remove it
+          : // to prevent breaking changes, if allowedFields is not set in config, we only remove private and known dangerous user schema fields
+            // TODO V5: allowedFields defaults to [] when undefined and remove this case
+            Object.keys(attributes).filter(
+              (key) =>
+                !nonWritable.includes(key) &&
+                !attributes[key].private &&
+                ![
+                  // many of these are included in nonWritable, but we'll list them again to be safe and since we're removing this code in v5 anyway
+                  // Strapi user schema fields
+                  'confirmed',
+                  'blocked',
+                  'confirmationToken',
+                  'resetPasswordToken',
+                  'provider',
+                  'id',
+                  'role',
+                  // other Strapi fields that might be added
+                  'createdAt',
+                  'updatedAt',
+                  'createdBy',
+                  'updatedBy',
+                  'publishedAt', // d&p
+                  'strapi_reviewWorkflows_stage', // review workflows
+                ].includes(key)
+            )
+      )
+    );
+
     const params = {
-      ..._.omit(ctx.request.body, [
-        'confirmed',
-        'blocked',
-        'confirmationToken',
-        'resetPasswordToken',
-        'provider',
-        'id',
-        'createdAt',
-        'updatedAt',
-        'createdBy',
-        'updatedBy',
-        'role',
-      ]),
+      ..._.pick(ctx.request.body, allowedKeys),
       provider: 'local',
     };
 

package/server/controllers/user.js

@@ -11,7 +11,7 @@ const utils = require('@strapi/utils');
 const { getService } = require('../utils');
 const { validateCreateUserBody, validateUpdateUserBody } = require('./validation/user');
 
-const { sanitize } = utils;
+const { sanitize, validate } = utils;
 const { ApplicationError, ValidationError, NotFoundError } = utils.errors;
 
 const sanitizeOutput = async (user, ctx) => {
@@ -21,6 +21,13 @@ const sanitizeOutput = async (user, ctx) => {
   return sanitize.contentAPI.output(user, schema, { auth });
 };
 
+const validateQuery = async (query, ctx) => {
+  const schema = strapi.getModel('plugin::users-permissions.user');
+  const { auth } = ctx.state;
+
+  return validate.contentAPI.query(query, schema, { auth });
+};
+
 const sanitizeQuery = async (query, ctx) => {
   const schema = strapi.getModel('plugin::users-permissions.user');
   const { auth } = ctx.state;
@@ -143,6 +150,7 @@ module.exports = {
    * @return {Object|Array}
    */
   async find(ctx) {
+    await validateQuery(ctx.query, ctx);
     const sanitizedQuery = await sanitizeQuery(ctx.query, ctx);
     const users = await getService('user').fetchAll(sanitizedQuery);
 
@@ -155,6 +163,7 @@ module.exports = {
    */
   async findOne(ctx) {
     const { id } = ctx.params;
+    await validateQuery(ctx.query, ctx);
     const sanitizedQuery = await sanitizeQuery(ctx.query, ctx);
 
     let data = await getService('user').fetch(id, sanitizedQuery);
@@ -171,6 +180,7 @@ module.exports = {
    * @return {Number}
    */
   async count(ctx) {
+    await validateQuery(ctx.query, ctx);
     const sanitizedQuery = await sanitizeQuery(ctx.query, ctx);
 
     ctx.body = await getService('user').count(sanitizedQuery);
@@ -201,6 +211,7 @@ module.exports = {
       return ctx.unauthorized();
     }
 
+    await validateQuery(query, ctx);
     const sanitizedQuery = await sanitizeQuery(query, ctx);
     const user = await getService('user').fetch(authUser.id, sanitizedQuery);
 

package/admin/src/hooks/index.js

@@ -1,5 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export { default as useForm } from './useForm';
-export { default as useRolesList } from './useRolesList';
-export * from './usePlugins';
-export { default as useFetchRole } from './useFetchRole';

package/admin/src/hooks/useFetchRole/index.js

@@ -1,67 +0,0 @@
-import { useCallback, useEffect, useReducer, useRef } from 'react';
-
-import { useFetchClient, useNotification } from '@strapi/helper-plugin';
-
-import pluginId from '../../pluginId';
-
-import reducer, { initialState } from './reducer';
-
-const useFetchRole = (id) => {
-  const [state, dispatch] = useReducer(reducer, initialState);
-  const toggleNotification = useNotification();
-  const isMounted = useRef(null);
-  const { get } = useFetchClient();
-
-  useEffect(() => {
-    isMounted.current = true;
-
-    if (id) {
-      fetchRole(id);
-    } else {
-      dispatch({
-        type: 'GET_DATA_SUCCEEDED',
-        role: {},
-      });
-    }
-
-    return () => (isMounted.current = false);
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [id]);
-
-  const fetchRole = async (roleId) => {
-    try {
-      const {
-        data: { role },
-      } = await get(`/${pluginId}/roles/${roleId}`);
-
-      // Prevent updating state on an unmounted component
-      if (isMounted.current) {
-        dispatch({
-          type: 'GET_DATA_SUCCEEDED',
-          role,
-        });
-      }
-    } catch (err) {
-      console.error(err);
-
-      dispatch({
-        type: 'GET_DATA_ERROR',
-      });
-      toggleNotification({
-        type: 'warning',
-        message: { id: 'notification.error' },
-      });
-    }
-  };
-
-  const handleSubmitSucceeded = useCallback((data) => {
-    dispatch({
-      type: 'ON_SUBMIT_SUCCEEDED',
-      ...data,
-    });
-  }, []);
-
-  return { ...state, onSubmitSucceeded: handleSubmitSucceeded };
-};
-
-export default useFetchRole;

package/admin/src/hooks/useFetchRole/reducer.js

@@ -1,31 +0,0 @@
-/* eslint-disable consistent-return */
-import produce from 'immer';
-
-export const initialState = {
-  role: {},
-  isLoading: true,
-};
-
-const reducer = (state, action) =>
-  produce(state, (draftState) => {
-    switch (action.type) {
-      case 'GET_DATA_SUCCEEDED': {
-        draftState.role = action.role;
-        draftState.isLoading = false;
-        break;
-      }
-      case 'GET_DATA_ERROR': {
-        draftState.isLoading = false;
-        break;
-      }
-      case 'ON_SUBMIT_SUCCEEDED': {
-        draftState.role.name = action.name;
-        draftState.role.description = action.description;
-        break;
-      }
-      default:
-        return draftState;
-    }
-  });
-
-export default reducer;

package/admin/src/hooks/useForm/index.js

@@ -1,68 +0,0 @@
-import { useCallback, useEffect, useReducer, useRef } from 'react';
-
-import { useFetchClient, useNotification, useRBAC } from '@strapi/helper-plugin';
-
-import reducer, { initialState } from './reducer';
-
-const useUserForm = (endPoint, permissions) => {
-  const { isLoading: isLoadingForPermissions, allowedActions } = useRBAC(permissions);
-  const [{ isLoading, modifiedData }, dispatch] = useReducer(reducer, initialState);
-  const toggleNotification = useNotification();
-  const isMounted = useRef(true);
-
-  const { get } = useFetchClient();
-
-  useEffect(() => {
-    const getData = async () => {
-      try {
-        dispatch({
-          type: 'GET_DATA',
-        });
-
-        const { data } = await get(`/users-permissions/${endPoint}`);
-
-        dispatch({
-          type: 'GET_DATA_SUCCEEDED',
-          data,
-        });
-      } catch (err) {
-        // The user aborted the request
-        if (isMounted.current) {
-          dispatch({
-            type: 'GET_DATA_ERROR',
-          });
-          console.error(err);
-          toggleNotification({
-            type: 'warning',
-            message: { id: 'notification.error' },
-          });
-        }
-      }
-    };
-
-    if (!isLoadingForPermissions) {
-      getData();
-    }
-
-    return () => {
-      isMounted.current = false;
-    };
-  }, [isLoadingForPermissions, endPoint, get, toggleNotification]);
-
-  const dispatchSubmitSucceeded = useCallback((data) => {
-    dispatch({
-      type: 'ON_SUBMIT_SUCCEEDED',
-      data,
-    });
-  }, []);
-
-  return {
-    allowedActions,
-    dispatchSubmitSucceeded,
-    isLoading,
-    isLoadingForPermissions,
-    modifiedData,
-  };
-};
-
-export default useUserForm;

package/admin/src/hooks/useForm/reducer.js

@@ -1,40 +0,0 @@
-import produce from 'immer';
-
-const initialState = {
-  isLoading: true,
-  modifiedData: {},
-};
-
-const reducer = (state, action) =>
-  // eslint-disable-next-line consistent-return
-  produce(state, (draftState) => {
-    switch (action.type) {
-      case 'GET_DATA': {
-        draftState.isLoading = true;
-        draftState.modifiedData = {};
-
-        break;
-      }
-      case 'GET_DATA_SUCCEEDED': {
-        draftState.isLoading = false;
-        draftState.modifiedData = action.data;
-
-        break;
-      }
-      case 'GET_DATA_ERROR': {
-        draftState.isLoading = true;
-        break;
-      }
-      case 'ON_SUBMIT_SUCCEEDED': {
-        draftState.modifiedData = action.data;
-
-        break;
-      }
-      default: {
-        return draftState;
-      }
-    }
-  });
-
-export default reducer;
-export { initialState };

package/admin/src/hooks/useRolesList/index.js

@@ -1,65 +0,0 @@
-import { useCallback, useEffect, useReducer, useRef } from 'react';
-
-import { useFetchClient, useNotification } from '@strapi/helper-plugin';
-import get from 'lodash/get';
-
-import pluginId from '../../pluginId';
-
-import init from './init';
-import reducer, { initialState } from './reducer';
-
-const useRolesList = (shouldFetchData = true) => {
-  const [{ roles, isLoading }, dispatch] = useReducer(reducer, initialState, () =>
-    init(initialState, shouldFetchData)
-  );
-  const toggleNotification = useNotification();
-
-  const isMounted = useRef(true);
-  const fetchClient = useFetchClient();
-
-  const fetchRolesList = useCallback(async () => {
-    try {
-      dispatch({
-        type: 'GET_DATA',
-      });
-
-      const {
-        data: { roles },
-      } = await fetchClient.get(`/${pluginId}/roles`);
-
-      dispatch({
-        type: 'GET_DATA_SUCCEEDED',
-        data: roles,
-      });
-    } catch (err) {
-      const message = get(err, ['response', 'payload', 'message'], 'An error occured');
-
-      if (isMounted.current) {
-        dispatch({
-          type: 'GET_DATA_ERROR',
-        });
-
-        if (message !== 'Forbidden') {
-          toggleNotification({
-            type: 'warning',
-            message,
-          });
-        }
-      }
-    }
-  }, [fetchClient, toggleNotification]);
-
-  useEffect(() => {
-    if (shouldFetchData) {
-      fetchRolesList();
-    }
-
-    return () => {
-      isMounted.current = false;
-    };
-  }, [shouldFetchData, fetchRolesList]);
-
-  return { roles, isLoading, getData: fetchRolesList };
-};
-
-export default useRolesList;

package/admin/src/hooks/useRolesList/init.js

@@ -1,5 +0,0 @@
-const init = (initialState, shouldFetchData) => {
-  return { ...initialState, isLoading: shouldFetchData };
-};
-
-export default init;

package/admin/src/hooks/useRolesList/reducer.js

@@ -1,31 +0,0 @@
-/* eslint-disable consistent-return */
-import produce from 'immer';
-
-export const initialState = {
-  roles: [],
-  isLoading: true,
-};
-
-const reducer = (state, action) =>
-  produce(state, (draftState) => {
-    switch (action.type) {
-      case 'GET_DATA': {
-        draftState.isLoading = true;
-        draftState.roles = [];
-        break;
-      }
-      case 'GET_DATA_SUCCEEDED': {
-        draftState.roles = action.data;
-        draftState.isLoading = false;
-        break;
-      }
-      case 'GET_DATA_ERROR': {
-        draftState.isLoading = false;
-        break;
-      }
-      default:
-        return draftState;
-    }
-  });
-
-export default reducer;

package/admin/src/pages/AdvancedSettings/utils/api.js

@@ -1,16 +0,0 @@
-import { getFetchClient } from '@strapi/helper-plugin';
-
-const fetchData = async () => {
-  const { get } = getFetchClient();
-  const { data } = await get('/users-permissions/advanced');
-
-  return data;
-};
-
-const putAdvancedSettings = (body) => {
-  const { put } = getFetchClient();
-
-  return put('/users-permissions/advanced', body);
-};
-
-export { fetchData, putAdvancedSettings };

package/admin/src/pages/EmailTemplates/utils/api.js

@@ -1,16 +0,0 @@
-import { getFetchClient } from '@strapi/helper-plugin';
-
-const fetchData = async () => {
-  const { get } = getFetchClient();
-  const { data } = await get('/users-permissions/email-templates');
-
-  return data;
-};
-
-const putEmailTemplate = (body) => {
-  const { put } = getFetchClient();
-
-  return put('/users-permissions/email-templates', body);
-};
-
-export { fetchData, putEmailTemplate };

package/admin/src/pages/Providers/reducer.js

@@ -1,54 +0,0 @@
-import produce from 'immer';
-import set from 'lodash/set';
-
-const initialState = {
-  formErrors: {},
-  isLoading: true,
-  initialData: {},
-  modifiedData: {},
-};
-
-const reducer = (state, action) =>
-  // eslint-disable-next-line consistent-return
-  produce(state, (draftState) => {
-    switch (action.type) {
-      case 'GET_DATA': {
-        draftState.isLoading = true;
-        draftState.initialData = {};
-        draftState.modifiedData = {};
-
-        break;
-      }
-
-      case 'GET_DATA_SUCCEEDED': {
-        draftState.isLoading = false;
-        draftState.initialData = action.data;
-        draftState.modifiedData = action.data;
-
-        break;
-      }
-      case 'GET_DATA_ERROR': {
-        draftState.isLoading = true;
-        break;
-      }
-      case 'ON_CHANGE': {
-        set(draftState, ['modifiedData', ...action.keys.split('.')], action.value);
-        break;
-      }
-      case 'RESET_FORM': {
-        draftState.modifiedData = state.initialData;
-        draftState.formErrors = {};
-        break;
-      }
-      case 'SET_ERRORS': {
-        draftState.formErrors = action.errors;
-        break;
-      }
-      default: {
-        return draftState;
-      }
-    }
-  });
-
-export default reducer;
-export { initialState };

package/admin/src/pages/Providers/utils/api.js

@@ -1,24 +0,0 @@
-import { getFetchClient } from '@strapi/helper-plugin';
-
-// eslint-disable-next-line import/prefer-default-export
-export const fetchData = async (toggleNotification) => {
-  try {
-    const { get } = getFetchClient();
-    const { data } = await get('/users-permissions/providers');
-
-    return data;
-  } catch (err) {
-    toggleNotification({
-      type: 'warning',
-      message: { id: 'notification.error' },
-    });
-
-    throw new Error('error');
-  }
-};
-
-export const putProvider = (body) => {
-  const { put } = getFetchClient();
-
-  return put('/users-permissions/providers', body);
-};

package/admin/src/pages/Providers/utils/createProvidersArray.js

@@ -1,21 +0,0 @@
-import sortBy from 'lodash/sortBy';
-
-const createProvidersArray = (data) => {
-  return sortBy(
-    Object.keys(data).reduce((acc, current) => {
-      const { icon: iconName, enabled, subdomain } = data[current];
-      const icon = iconName === 'envelope' ? ['fas', 'envelope'] : ['fab', iconName];
-
-      if (subdomain !== undefined) {
-        acc.push({ name: current, icon, enabled, subdomain });
-      } else {
-        acc.push({ name: current, icon, enabled });
-      }
-
-      return acc;
-    }, []),
-    'name'
-  );
-};
-
-export default createProvidersArray;