Changes between Initial Version and Version 1 of TracPermissions


Ignore:
Timestamp:
Apr 21, 2020, 11:11:05 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v1 v1  
     1= Trac Permissions
     2[[TracGuideToc]]
     3
     4Trac uses a simple, case sensitive, permission system to control what users can and can't access.
     5
     6Permissions are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' tab of the web interface.
     7
     8In addition to the default permission policy described in this page, it is possible to activate additional permission policies by enabling plugins and listing them in [TracIni#trac-permission_policies-option "[trac] permission_policies"]. See TracFineGrainedPermissions for more details.
     9
     10Non-authenticated users accessing the system are assigned the name //anonymous//. Assign permissions to the //anonymous// user to set privileges for anonymous/guest users. The parts of Trac that a user does not have privilege for will not be displayed in the navigation.
     11In addition to these privileges, users can be granted additional individual rights in effect when authenticated and logged into the system. All logged in users belong to the virtual group //authenticated//, which inherits permissions from //anonymous//.
     12
     13== Graphical Admin Tab
     14
     15To access this tab, a user must have one of the following permissions: `TRAC_ADMIN`, `PERMISSION_ADMIN`, `PERMISSION_GRANT`, `PERMISSION_REVOKE`. The permissions can be granted using the `trac-admin` command (more on `trac-admin` below):
     16{{{#!sh
     17$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     18}}}
     19
     20Then, the user `bob` will be able to see the Admin tab, and can access the permissions menu. This menu will allow you to perform all the following actions, but from the browser rather than requiring root access to the server. '''Use at least one lowercase character in user names, as all-uppercase names are reserved for permissions.'''
     21
     22[[Image(htdocs:../common/guide/admin.png)]]
     23
     24[[Image(htdocs:../common/guide/admin-permissions.png)]]
     25
     26[[Image(htdocs:../common/guide/admin-permissions-TICKET_ADMIN.png)]]
     27
     28From the graphical admin tab, users with `PERMISSION_GRANT` will only be allowed to grant permissions that they possess, and users with `PERMISSION_REVOKE` will only be allowed to revoke permissions that they possess. For example, a user cannot grant `MILESTONE_ADMIN` unless they have `PERMISSION_GRANT` and `MILESTONE_ADMIN`, and they cannot revoke `MILESTONE_ADMIN` unless they have `PERMISSION_REVOKE` and `MILESTONE_ADMIN`. `PERMISSION_ADMIN` just grants the user both `PERMISSION_GRANT` and `PERMISSION_REVOKE`, and users with `TRAC_ADMIN` can grant or revoke any permission.
     29
     30== Available Privileges
     31
     32To enable all privileges for a user, use the `TRAC_ADMIN` permission. Having `TRAC_ADMIN` is like being `root` on a *NIX system: it will allow you to perform any operation.
     33
     34Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
     35
     36=== Repository Browser
     37
     38|| `BROWSER_VIEW` || View directory listings in the [TracBrowser repository browser] ||
     39|| `FILE_VIEW` || View files in the [TracBrowser repository browser] ||
     40|| `CHANGESET_VIEW` || View [TracChangeset repository check-ins] ||
     41|| `LOG_VIEW` || View revision logs of files and directories in the [TracBrowser repository browser] ||
     42
     43=== Ticket System
     44
     45|| `TICKET_VIEW` || View existing [TracTickets tickets] and perform [TracQuery ticket queries] ||
     46|| `TICKET_CREATE` || Create new [TracTickets tickets] ||
     47|| `TICKET_APPEND` || Add comments and attachments to [TracTickets tickets], and edit description of ticket the user created ||
     48|| `TICKET_CHGPROP` || Modify [TracTickets ticket] properties (priority, assignment, keywords, etc.) with the following exceptions: edit description of tickets created by others, add/remove other users from cc field when logged in ||
     49|| `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [TracTickets tickets] in the [TracWorkflow default workflow]. Tickets can be assigned to users through a [TracTickets#Assign-toasDrop-DownList drop-down list] when the list of possible owners has been restricted. ||
     50|| `TICKET_EDIT_CC` || Full modify cc field ||
     51|| `TICKET_EDIT_DESCRIPTION` || Modify description field. User with `TICKET_APPEND` or `TICKET_CHGPROP` can modify description of ticket they created. ||
     52|| `TICKET_EDIT_COMMENT` || Modify another user's comments. Any user can modify their own comments by default. ||
     53|| `TICKET_BATCH_MODIFY` || [TracBatchModify Batch modify] tickets ||
     54|| `TICKET_ADMIN` || All `TICKET_*` permissions, deletion of ticket attachments and modification of the reporter field, which grants ability to create a ticket on behalf of another user (it will appear that another user created the ticket). It also allows managing ticket properties through the web administration module. ||
     55
     56=== Roadmap
     57
     58|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
     59|| `MILESTONE_CREATE` || Create new milestones ||
     60|| `MILESTONE_MODIFY` || Modify milestones ||
     61|| `MILESTONE_DELETE` || Delete milestones ||
     62|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
     63|| `ROADMAP_VIEW` || View the [TracRoadmap roadmap] page, which is not yet the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
     64|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
     65
     66=== Reports
     67
     68|| `REPORT_VIEW` || View [TracReports reports], i.e. the //View Tickets// link. ||
     69|| `REPORT_SQL_VIEW` || View the SQL query of a [TracReports report] ||
     70|| `REPORT_CREATE` || Create new [TracReports reports] ||
     71|| `REPORT_MODIFY` || Modify [TracReports reports] ||
     72|| `REPORT_DELETE` || Delete [TracReports reports] ||
     73|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
     74
     75=== Wiki System
     76
     77|| `WIKI_VIEW` || View [TracWiki wiki] pages ||
     78|| `WIKI_CREATE` || Create new [TracWiki wiki] pages ||
     79|| `WIKI_MODIFY` || Modify [TracWiki wiki] pages ||
     80|| `WIKI_RENAME` || Rename [TracWiki wiki] pages ||
     81|| `WIKI_DELETE` || Delete [TracWiki wiki] pages and attachments ||
     82|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
     83
     84=== Permissions
     85
     86|| `PERMISSION_GRANT` || add/grant a permission ||
     87|| `PERMISSION_REVOKE` || remove/revoke a permission ||
     88|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
     89
     90=== Others
     91
     92|| `TIMELINE_VIEW` || View the [TracTimeline timeline] page ||
     93|| `SEARCH_VIEW` || View and execute [TracSearch search] queries ||
     94|| `CONFIG_VIEW` || Enables additional sections on ''About Trac'' that show the current configuration and the list of installed plugins ||
     95|| `EMAIL_VIEW` || Shows email addresses even if [TracIni#trac-section trac show_email_addresses] configuration option is false ||
     96
     97== Attachment Permissions
     98
     99Attachment permissions are handled by `LegacyAttachmentPolicy`, and unlike the permissions discussed so far, the permissions provided by `LegacyAttachmentPolicy` are not directly granted. Rather, the ability to create, view and delete attachments is determined by the attachment's parent realm and permissions the user possesses for that realm.
     100
     101The attachment actions are determined by the following
     102permissions in the ticket, wiki and milestone realms:
     103{{{#!table class="listing"
     104||= Granted By: =||= Ticket =||= Wiki =||= Milestone =||
     105|| `ATTACHMENT_CREATE` || `TICKET_APPEND` || `WIKI_MODIFY` || `MILESTONE_MODIFY` ||
     106|| `ATTACHMENT_VIEW` || `TICKET_VIEW` || `WIKI_VIEW` || `MILESTONE_VIEW` ||
     107|| `ATTACHMENT_DELETE` || `TICKET_ADMIN` || `WIKI_DELETE` || `MILESTONE_DELETE` ||
     108}}}
     109
     110If explicit attachment permissions are preferred, `ATTACHMENT_CREATE`, `ATTACHMENT_DELETE` and `ATTACHMENT_VIEW` can be created using the [trac:ExtraPermissionsProvider]. The simplest implementation is to simply define the actions.
     111{{{#!ini
     112[extra-permissions]
     113_perms = ATTACHMENT_CREATE, ATTACHMENT_DELETE, ATTACHMENT_VIEW
     114}}}
     115
     116An alternative configuration adds an `ATTACHMENT_ADMIN` meta-permission that grants the other 3 permission.
     117{{{#!ini
     118[extra-permissions]
     119ATTACHMENT_ADMIN = ATTACHMENT_CREATE, ATTACHMENT_DELETE, ATTACHMENT_VIEW
     120}}}
     121
     122The explicit permissions can be used in concert with `LegacyAttachmentPolicy`, or `LegacyAttachmentPolicy` can be removed from `permission_policies`, in which case only users that have been explicitly granted the corresponding attachment actions will be able to create, delete and view attachments.
     123
     124== Granting Privileges
     125
     126You grant privileges to users using [TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
     127{{{#!sh
     128$ trac-admin /path/to/projenv permission list
     129}}}
     130
     131This command will allow the user ''bob'' to delete reports:
     132{{{#!sh
     133$ trac-admin /path/to/projenv permission add bob REPORT_DELETE
     134}}}
     135
     136The `permission add` command also accepts multiple privilege names:
     137{{{#!sh
     138$ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
     139}}}
     140
     141Or add all privileges:
     142{{{#!sh
     143$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     144}}}
     145
     146== Permission Groups
     147
     148There are two built-in groups, //authenticated// and //anonymous//.
     149Any user who has not logged in is automatically in the //anonymous// group.
     150Any user who has logged in is also in the //authenticated// group.
     151The //authenticated// group inherits permissions from the //anonymous// group.
     152For example, if the //anonymous// group has permission WIKI_MODIFY,
     153it is not necessary to add the WIKI_MODIFY permission to the //authenticated// group as well.
     154
     155Custom groups may be defined that inherit permissions from the two built-in groups.
     156
     157Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
     158{{{#!sh
     159$ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
     160$ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
     161$ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
     162$ trac-admin /path/to/projenv permission add bob developer
     163$ trac-admin /path/to/projenv permission add john developer
     164}}}
     165
     166Group membership can be checked by doing a {{{permission list}}} with no further arguments; the resulting output will include group memberships. '''Use at least one lowercase character in group names, as all-uppercase names are reserved for permissions'''.
     167
     168== Adding a New Group and Permissions
     169Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
     170
     171The following will add ''bob'' to the new group called ''beta_testers'' and then will assign WIKI_ADMIN permissions to that group. (Thus, ''bob'' will inherit the WIKI_ADMIN permission)
     172{{{#!sh
     173$ trac-admin /path/to/projenv permission add bob beta_testers
     174$ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     175}}}
     176
     177== Removing Permissions
     178
     179Permissions can be removed using the 'remove' command. For example:
     180
     181This command will prevent the user ''bob'' from deleting reports:
     182{{{#!sh
     183$ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     184}}}
     185
     186Just like `permission add`, this command accepts multiple privilege names.
     187
     188You can also remove all privileges for a specific user:
     189{{{#!sh
     190$ trac-admin /path/to/projenv permission remove bob '*'
     191}}}
     192
     193Or one privilege for all users:
     194{{{#!sh
     195$ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     196}}}
     197
     198== Creating New Privileges
     199
     200To create custom permissions, for example to be used in a custom workflow, enable the optional [trac:ExtraPermissionsProvider tracopt.perm.config_perm_provider.ExtraPermissionsProvider] component in the "Plugins" admin panel, and add the desired permissions to the `[extra-permissions]` section in your [TracIni#extra-permissions-section trac.ini]. For more information, please refer to the documentation  on the [TracIni#extra-permissions-section TracIni] page after enabling the component.
     201
     202== Default Permissions
     203
     204By default on a new Trac installation, the //anonymous// user will have ''view'' access to everything in Trac, but will not be able to create or modify anything.
     205On the other hand, the //authenticated// users will have the permissions to ''create and modify tickets and wiki pages''.
     206
     207//**anonymous**//
     208{{{
     209BROWSER_VIEW
     210CHANGESET_VIEW
     211FILE_VIEW
     212LOG_VIEW
     213MILESTONE_VIEW
     214REPORT_SQL_VIEW
     215REPORT_VIEW
     216ROADMAP_VIEW
     217SEARCH_VIEW
     218TICKET_VIEW
     219TIMELINE_VIEW
     220WIKI_VIEW
     221}}}
     222
     223//**authenticated**//
     224{{{
     225TICKET_CREATE
     226TICKET_MODIFY
     227WIKI_CREATE
     228WIKI_MODIFY 
     229}}}
     230----
     231See also: TracAdmin, TracFineGrainedPermissions