Skip to content

Commit

Permalink
[TASK] Add Setting Up BE Groups section for Permissions Managemend docs
Browse files Browse the repository at this point in the history
This commit adds the Setting Up Backend User Groups section to the new
Permissions Management documentation.

This is part #3 from the PR series.
  • Loading branch information
Marcin Sągol committed Feb 27, 2024
1 parent f23bdff commit 732d2d7
Show file tree
Hide file tree
Showing 4 changed files with 248 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions Documentation/PermissionsManagement/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ of recommended practices and guidelines that could be beneficial in managing
permissions within the TYPO3 backend. However, remember that these recommendations
are adaptable and can be tailored to suit your specific requirements.

.. _available_acl_options:

What access options can be set within TYPO3?
============================================

Expand Down Expand Up @@ -103,3 +105,4 @@ the naming convention for backend groups later on.
:titlesonly:
:glob:

SettingUpBackendGroups/Index
245 changes: 245 additions & 0 deletions Documentation/PermissionsManagement/SettingUpBackendGroups/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
.. include:: /Includes.rst.txt

.. index:: backend, acl, permissions, user groups, user management

.. _setting-up-backend-user-groups:

==============================
Setting up backend user groups
==============================

Backend user groups can be categorized into three main types. Those used to
grant permissions to pages and define mounts for databases, categories,
or files we can refer to as **System Groups**. The ones responsible for granting
access to modules, various content elements, record types, and specific fields
within forms can be termed **Access Control List (ACL) Groups**. Finally,
we have **Role Groups**, which aggregate groups from both the System and ACL Groups
to provide a permissions set representing a specific role.

This classification should not be seen as a TYPO3 standard, but rather as a guideline
that will assist in configuring groups later on. Read more to discover the details.

.. _system-groups:

System groups
=============

System groups will be those from the lowest level of permissions without which
other groups like :ref:`Access Control List (ACL) <_acl-groups>`
and :ref:`Role <_role_groups>` groups will not work.
They enable access to individual pages based on user and group IDs, allow
the definition of accessible sections of the pages or categories tree for users,
and determine access to files and folders within storages (via File Mounts).
System groups are likely to be the ones you modify the least often.

.. note::
System groups are likely to be the ones you modify the least often.

.. _acl-groups:

Access Control List (ACL) groups
================================

Access Control List (ACL) groups will form the largest set of groups, used to
set detailed permissions for elements like modules, dashboard widgets, tables
for listing and editing, and specific fields in backend forms.

It's crucial to configure the ACL group in such a way that it grants all
the necessary permissions for managing a specific element. For instance,
let's consider a custom record type (like Article, Product etc.), which
is displayed by custom plugins. Users responsible for managing these records
on the site should have the capability to list existing news items, create
new records, and access them, either through a dedicated custom backend module
or the List module. With this in mind, we should ensure such a group has access to:

* Listing and modifying the table of a records
* Editing all necessary fields within the record to align with this group's purpose
* Accessing the core List module or custom module for records management
* If there are relations from this record, for example, to files, it should also permit uploading, selecting, and processing these files

Therefore, consider such a group as an independent unit that provides complete
access to a specific part of the system and can be integrated later with other units (groups).

.. note::
Consider an Access Control List (ACL) group as a standalone, complete set of
permissions tailored to a specific element(s), designed to fulfill its defined
scope or purpose (editing/managing Articles or Products).

.. _role-groups:

Role groups as aggregators of specific role permissions
=======================================================

Backend role groups in TYPO3 are designed to correspond to the specific roles
users fulfill, such as editor, proofreader, etc. These groups inherit permissions
from other assigned groups rather than having direct accesses assigned to them.
Instead, they accumulate permissions exclusively through the inheritance from subgroups.
This hierarchical setup ensures that role groups can effectively grant users
the precise set of permissions needed to perform their designated roles, such as editing.
By utilizing this structure, TYPO3 allows for a clear and organized approach
to managing access rights, ensuring users have just the permissions they need,
nothing more, nothing less.

.. note::
Role groups inherit permissions from subgroups and should not have any
access configured directly on themselves.

.. _naming-convention:

Implementing a naming convention for simplified group management
================================================================

At the moment TYPO3 does not allow grouping backend user groups by some context
or their purpose. Instead when they are listed (for example in the backend user
edit form, where we can assign them to the user) they appear sorted by their
names (ascending). From one side this might be good as you can quickly find
what you are looking for. On the other hand if you will have a lot of groups
defined, and you will try to quickly find and select/assign some of them
to the user, it might be challenging to scroll over a large list.

The situation might be even worse if there is more than 1 administrator responsible
for group and user permissions management. If there won’t be some conventions
used to name such groups which all administrators follow, then they might find it
difficult to figure out what given group is responsible for.

As mentioned in one of the previous chapters, which detailed various
:ref:`Access Control Options in TYPO3 <_available_acl_options>`,
these options can be categorized into types like access lists, mounts, page permissions,
etc. This categorization can also aid in organizing backend user groups.
Let’s explore how implementing prefixes in group names can help streamline their organization.

.. _role-group::

Role Group
----------

**ROLE_** or **R_**
Examples: *R_editor*, *R_editor_advanced*, *R_proofreader*

A group representing a specific role, such as editor or proofreader, will
inherit permissions from multiple other groups (aggregates them) to compile
the necessary permissions set.

.. _page-group:

Page Group
----------

**PAGE_GROUP_** or **PG_**
Examples: *PG_website_a*, *PG_website_a_blog*, *PG_website_b*, *PG_website_b_gallery*

Grants permissions to all pages in the pages tree for a given site or only
selected branches of pages in such a tree.

Those groups will be assigned directly to the pages (see Page Permissions
for more details) following the TSConfig or the Access Module configuration.

.. _database-mount:

Database Mount
--------------

**DATABASE_MOUNT_** or **DBM_**
Examples: *DBM_website_a*, *DBM_website_a_blog*, *DBM_website_b*, *DBM_website_b_gallery*

Specifies which portion (either the entirety or a segment) of the pages tree
will be displayed to the user.

This setting is closely linked to page access permissions — without sufficient
permissions to list the pages, a user will not be able to view the mounted page tree.

.. _file-mount:

File Mount
----------

**FILE_MOUNT_** or **FM_**
Examples: *FM_website_a*, *FM_website_a_blog*, *FM_website_b*, *FM_website_b_gallery*, *FM_shared*

Grants access to the selected folders (File Mounts) within file storages.

.. _category-mount:

Category Mount
--------------

**CATEGORY_MOUNT_** or **CM_**
Examples: *CM_website_a*, *CM_website_b*

Provides access to system categories, or more precisely, to the entire categories tree or a portion of it.

.. _access-control-lists:

Access Control Lists
--------------------

**ACCESS_CONTROL** or **ACL_**
Examples: *ACL_content_elements*, *ACL_news*, *ACL_news_extended*, *ACL_module_reports*

These groups will constitute the largest segment among all, defining granular
access to content elements, plugins, modules, fields and more.

.. _file-operations:

File Operations
---------------

**FILE_OPERATION_** or **FO_**
Examples: *FO_all*, *FO_read_write*

Defines the range of allowed operations for files and folders, such as read, write, delete, etc.

.. _limit-to-languages:

Limit to languages
------------------

**LANGUAGE_**
Examples: *L_all*, *L_english_german*, *L_en_pl_de*

Specifies the list of languages available for managing content. Keep in mind
that you would have to have access to the source language when creating the translation.


As you can see we now have dedicated groups prefixes for Pages access,
Database Mounts, File Mounts, File Operations, Category Mounts and access
to modules, tables, widgets, languages etc. Remember, these are just examples,
and you could — and should — tailor them to meet your specific needs.
Each group name should be simple and self explaining (tell what permissions it contains).

.. figure:: ../../Images/ManualScreenshots/PermissionsManagement/PermissionsManagementPrefixedGroupName.png
:alt: Prefixed group names

Prefixing group names makes them more organized and easier to search within forms

.. note::
Use prefixes or other naming conventions which will allow you to easily
distinguish backend user groups by their purpose.

Here’s a useful tip for those managing backend groups in your project.
If you’re implementing naming conventions for groups, you likely have documentation
detailing these guidelines. Instead of directing your colleagues to consult
the documentation for this information, consider extending the TCA for
the be_groups and be_users tables (and potentially others where the group
selection box appears). You can add a field description that outlines
the naming conventions and prefixes used. This approach ensures that anyone
modifying backend group inheritance or assignments will have immediate access
to explanations of the naming conventions directly within the interface.

.. code-block:: php
:caption: Add description to a form field through TCA
$GLOBALS['TCA']['be_users']['columns']['usergroup']['description'] = 'Prefixes: R_ - Role, PG_ - Page Group, DBM_ - Database Mount, FM_ - File Mount, FO_ - File Operations, CM_ - Category Mount, ACL_ - Access Control';
This code demonstrates the assignment of a static description for the usergroup
field in the backend user form. However, you should place it in a translation
file and retrieve it from there for better flexibility and localization support.

Another good practice for managing backend groups is to clearly describe
the purpose or scope of each group. This can be done using the Description
field located within the Notes tab of the backend group form.

.. figure:: ../../Images/ManualScreenshots/PermissionsManagement/PermissionsManagementTCAFieldDescription.png
:alt: TCA field description

Describe the scope or purpose of the group

0 comments on commit 732d2d7

Please sign in to comment.