Changes between Initial Version and Version 1 of TracPermissions

Show
Ignore:
Timestamp:
01/07/11 15:31:50 (9 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 
     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 `TRAC_ADMIN privileges`. This can be performed as follows (more on the trac-admin script 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). 
     22 
     23 
     24An 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. 
     25 
     26== Available Privileges == 
     27 
     28To 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. 
     29 
     30Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''): 
     31 
     32=== Repository Browser === 
     33 
     34|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] || 
     35|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] || 
     36|| `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] || 
     37|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] || 
     38 
     39=== Ticket System === 
     40 
     41|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] || 
     42|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] || 
     43|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] || 
     44|| `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 || 
     45|| `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. || 
     46|| `TICKET_EDIT_CC` || Full modify cc field || 
     47|| `TICKET_EDIT_DESCRIPTION` || Modify description field || 
     48|| `TICKET_EDIT_COMMENT` || Modify comments || 
     49|| `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. || 
     50 
     51Attention: the "view tickets" button appears with the `REPORT_VIEW` permission. 
     52 
     53=== Roadmap === 
     54 
     55|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. || 
     56|| `MILESTONE_CREATE` || Create a new milestone || 
     57|| `MILESTONE_MODIFY` || Modify existing milestones || 
     58|| `MILESTONE_DELETE` || Delete milestones || 
     59|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions || 
     60|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] || 
     61|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN || 
     62 
     63=== Reports === 
     64 
     65|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. || 
     66|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] || 
     67|| `REPORT_CREATE` || Create new [wiki:TracReports reports] || 
     68|| `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] || 
     69|| `REPORT_DELETE` || Delete [wiki:TracReports reports] || 
     70|| `REPORT_ADMIN` || All `REPORT_*` permissions || 
     71 
     72=== Wiki System === 
     73 
     74|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages || 
     75|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages || 
     76|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages || 
     77|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages || 
     78|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments || 
     79|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. || 
     80 
     81=== Permissions === 
     82 
     83|| `PERMISSION_GRANT` || add/grant a permission || 
     84|| `PERMISSION_REVOKE` || remove/revoke a permission || 
     85|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions || 
     86 
     87 
     88=== Others === 
     89 
     90|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page || 
     91|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries || 
     92|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins || 
     93|| `EMAIL_VIEW` || Shows email addresses even if [trac:wiki:0.11/TracIni trac show_email_addresses configuration option is false] || 
     94 
     95== Granting Privileges == 
     96 
     97You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command: 
     98{{{ 
     99  $ trac-admin /path/to/projenv permission list 
     100}}} 
     101 
     102This command will allow the user ''bob'' to delete reports: 
     103{{{ 
     104  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE 
     105}}} 
     106 
     107The `permission add` command also accepts multiple privilege names: 
     108{{{ 
     109  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE 
     110}}} 
     111 
     112Or add all privileges: 
     113{{{ 
     114  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN 
     115}}} 
     116 
     117== Permission Groups == 
     118 
     119There are two built-in groups, "authenticated" and "anonymous". 
     120Any user who has not logged in is automatically in the "anonymous" group. 
     121Any user who has logged in is also in the "authenticated" group. 
     122The "authenticated" group inherits permissions from the "anonymous" group. 
     123For example, if the "anonymous" group has permission WIKI_MODIFY,  
     124it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well. 
     125 
     126Custom groups may be defined that inherit permissions from the two built-in groups. 
     127 
     128Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc. 
     129{{{ 
     130  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN 
     131  $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN 
     132  $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY 
     133  $ trac-admin /path/to/projenv permission add bob developer 
     134  $ trac-admin /path/to/projenv permission add john developer 
     135}}} 
     136 
     137Group 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'''. 
     138 
     139== Adding a New Group and Permissions == 
     140Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group. 
     141 
     142The 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) 
     143{{{  
     144   $ trac-admin /path/to/projenv permission add bob beta_testers 
     145   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN 
     146 
     147}}} 
     148 
     149== Removing Permissions == 
     150 
     151Permissions can be removed using the 'remove' command. For example: 
     152 
     153This command will prevent the user ''bob'' from deleting reports: 
     154{{{ 
     155  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE 
     156}}} 
     157 
     158Just like `permission add`, this command accepts multiple privilege names. 
     159 
     160You can also remove all privileges for a specific user: 
     161{{{ 
     162  $ trac-admin /path/to/projenv permission remove bob '*' 
     163}}} 
     164 
     165Or one privilege for all users: 
     166{{{ 
     167  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN 
     168}}} 
     169 
     170== Default Permissions == 
     171 
     172By 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. 
     173On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''. 
     174 
     175'''anonymous''' 
     176{{{ 
     177 BROWSER_VIEW  
     178 CHANGESET_VIEW  
     179 FILE_VIEW  
     180 LOG_VIEW  
     181 MILESTONE_VIEW  
     182 REPORT_SQL_VIEW  
     183 REPORT_VIEW  
     184 ROADMAP_VIEW  
     185 SEARCH_VIEW  
     186 TICKET_VIEW  
     187 TIMELINE_VIEW 
     188 WIKI_VIEW 
     189}}} 
     190 
     191'''authenticated''' 
     192{{{ 
     193 TICKET_CREATE  
     194 TICKET_MODIFY  
     195 WIKI_CREATE  
     196 WIKI_MODIFY   
     197}}} 
     198---- 
     199See also: TracAdmin, TracGuide and TracFineGrainedPermissions