Changes between Initial Version and Version 1 of TracPermissions


Ignore:
Timestamp:
Feb 7, 2016, 1:07:44 AM (22 months 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
     6Permission privileges are managed using the [TracAdmin trac-admin] tool or (new in version 0.11) 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 the `[trac] permission_policies` configuration entry in the TracIni. 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 the privileges 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''This feature is new in version 0.11.''
     15
     16To 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):
     17{{{
     18  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     19}}}
     20
     21Then, the user `bob` will be able to see the Admin tab, and can then access the permissions menu. This menu will allow you to perform all the following actions, but from the browser without requiring root access to the server (just the correct permissions for your user account). '''Use at least one lowercase character in user names, as all-uppercase names are reserved for permissions.'''
     22
     23 1. [[Image(htdocs:../common/guide/admin.png)]]
     24 1. [[Image(htdocs:../common/guide/admin-permissions.png)]]
     25 1. [[Image(htdocs:../common/guide/admin-permissions-TICKET_ADMIN.png)]]
     26
     27An easy way to quickly secure a new Trac install is to run the above command on the anonymous user, install the [http://trac-hacks.org/wiki/AccountManagerPlugin AccountManagerPlugin], create a new admin account graphically and then remove the TRAC_ADMIN permission from the anonymous user.
     28
     29From 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.
     30
     31== Available Privileges ==
     32
     33To 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.
     34
     35Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
     36
     37=== Repository Browser ===
     38
     39|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
     40|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
     41|| `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
     42|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
     43
     44=== Ticket System ===
     45
     46|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
     47|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
     48|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
     49|| `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) with the following exceptions: edit description field, add/remove other users from cc field when logged in, and set email to pref ||
     50|| `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets]. Tickets can be assigned to users through a [TracTickets#Assign-toasDrop-DownList drop-down list] when the list of possible owners has been restricted. ||
     51|| `TICKET_EDIT_CC` || Full modify cc field ||
     52|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
     53|| `TICKET_EDIT_COMMENT` || Modify comments ||
     54|| `TICKET_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets ||
     55|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the reporter and description fields. It also allows managing ticket properties in the WebAdmin panel. ||
     56
     57Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
     58
     59=== Roadmap ===
     60
     61|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
     62|| `MILESTONE_CREATE` || Create a new milestone ||
     63|| `MILESTONE_MODIFY` || Modify existing milestones ||
     64|| `MILESTONE_DELETE` || Delete milestones ||
     65|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
     66|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
     67|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
     68
     69=== Reports ===
     70
     71|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
     72|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
     73|| `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
     74|| `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
     75|| `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
     76|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
     77
     78=== Wiki System ===
     79
     80|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
     81|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
     82|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
     83|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
     84|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
     85|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
     86
     87=== Permissions ===
     88
     89|| `PERMISSION_GRANT` || add/grant a permission ||
     90|| `PERMISSION_REVOKE` || remove/revoke a permission ||
     91|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
     92
     93=== Others ===
     94
     95|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
     96|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
     97|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
     98|| `EMAIL_VIEW` || Shows email addresses even if [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false ||
     99
     100== Creating New Privileges ==
     101
     102To 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 [wiki:TracIni#extra-permissions-section trac.ini]. For more information, please refer to the documentation  on the [wiki:TracIni#extra-permissions-section TracIni] page after enabling the component.
     103
     104== Granting Privileges ==
     105
     106You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
     107{{{
     108  $ trac-admin /path/to/projenv permission list
     109}}}
     110
     111This command will allow the user ''bob'' to delete reports:
     112{{{
     113  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
     114}}}
     115
     116The `permission add` command also accepts multiple privilege names:
     117{{{
     118  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
     119}}}
     120
     121Or add all privileges:
     122{{{
     123  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     124}}}
     125
     126== Permission Groups ==
     127
     128There are two built-in groups, "authenticated" and "anonymous".
     129Any user who has not logged in is automatically in the "anonymous" group.
     130Any user who has logged in is also in the "authenticated" group.
     131The "authenticated" group inherits permissions from the "anonymous" group.
     132For example, if the "anonymous" group has permission WIKI_MODIFY,
     133it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well.
     134
     135Custom groups may be defined that inherit permissions from the two built-in groups.
     136
     137Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
     138{{{
     139  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
     140  $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
     141  $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
     142  $ trac-admin /path/to/projenv permission add bob developer
     143  $ trac-admin /path/to/projenv permission add john developer
     144}}}
     145
     146Group 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'''.
     147
     148== Adding a New Group and Permissions ==
     149Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
     150
     151The 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)
     152{{{
     153   $ trac-admin /path/to/projenv permission add bob beta_testers
     154   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     155
     156}}}
     157
     158== Removing Permissions ==
     159
     160Permissions can be removed using the 'remove' command. For example:
     161
     162This command will prevent the user ''bob'' from deleting reports:
     163{{{
     164  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     165}}}
     166
     167Just like `permission add`, this command accepts multiple privilege names.
     168
     169You can also remove all privileges for a specific user:
     170{{{
     171  $ trac-admin /path/to/projenv permission remove bob '*'
     172}}}
     173
     174Or one privilege for all users:
     175{{{
     176  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     177}}}
     178
     179== Default Permissions ==
     180
     181By 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.
     182On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
     183
     184'''anonymous'''
     185{{{
     186 BROWSER_VIEW
     187 CHANGESET_VIEW
     188 FILE_VIEW
     189 LOG_VIEW
     190 MILESTONE_VIEW
     191 REPORT_SQL_VIEW
     192 REPORT_VIEW
     193 ROADMAP_VIEW
     194 SEARCH_VIEW
     195 TICKET_VIEW
     196 TIMELINE_VIEW
     197 WIKI_VIEW
     198}}}
     199
     200'''authenticated'''
     201{{{
     202 TICKET_CREATE
     203 TICKET_MODIFY
     204 WIKI_CREATE
     205 WIKI_MODIFY 
     206}}}
     207----
     208See also: TracAdmin, TracGuide and TracFineGrainedPermissions