Changes between Initial Version and Version 1 of TracPermissions

01/14/11 15:54:51 (13 years ago)



  • TracPermissions

    v1 v1  
     1= Trac Permissions = 
     4Trac uses a simple, case sensitive, permission system to control what users can and can't access. 
     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. 
     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. 
     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". 
     13== Graphical Admin Tab == 
     14''This feature is new in version 0.11.'' 
     16To access this tab, a user must have `TRAC_ADMIN privileges`. This can be performed as follows (more on the trac-admin script below): 
     18  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN 
     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). 
     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)]] 
     27An easy way to quickly secure a new Trac install is to run the above command on the anonymous user, install the [ AccountManagerPlugin], create a new admin account graphically and then remove the TRAC_ADMIN permission from the anonymous user. 
     29== Available Privileges == 
     31To 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. 
     33Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''): 
     35=== Repository Browser === 
     37|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] || 
     38|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] || 
     39|| `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] || 
     40|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] || 
     42=== Ticket System === 
     44|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] || 
     45|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] || 
     46|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] || 
     47|| `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 || 
     48|| `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. || 
     49|| `TICKET_EDIT_CC` || Full modify cc field || 
     50|| `TICKET_EDIT_DESCRIPTION` || Modify description field || 
     51|| `TICKET_EDIT_COMMENT` || Modify comments || 
     52|| `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. || 
     54Attention: the "view tickets" button appears with the `REPORT_VIEW` permission. 
     56=== Roadmap === 
     58|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. || 
     59|| `MILESTONE_CREATE` || Create a new milestone || 
     60|| `MILESTONE_MODIFY` || Modify existing milestones || 
     61|| `MILESTONE_DELETE` || Delete milestones || 
     62|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions || 
     63|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, 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 || 
     66=== Reports === 
     68|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. || 
     69|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] || 
     70|| `REPORT_CREATE` || Create new [wiki:TracReports reports] || 
     71|| `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] || 
     72|| `REPORT_DELETE` || Delete [wiki:TracReports reports] || 
     73|| `REPORT_ADMIN` || All `REPORT_*` permissions || 
     75=== Wiki System === 
     77|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages || 
     78|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages || 
     79|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages || 
     80|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages || 
     81|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments || 
     82|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. || 
     84=== Permissions === 
     86|| `PERMISSION_GRANT` || add/grant a permission || 
     87|| `PERMISSION_REVOKE` || remove/revoke a permission || 
     88|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions || 
     91=== Others === 
     93|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page || 
     94|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries || 
     95|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins || 
     96|| `EMAIL_VIEW` || Shows email addresses even if [trac:wiki:0.11/TracIni trac show_email_addresses configuration option is false] || 
     98== Granting Privileges == 
     100You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command: 
     102  $ trac-admin /path/to/projenv permission list 
     105This command will allow the user ''bob'' to delete reports: 
     107  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE 
     110The `permission add` command also accepts multiple privilege names: 
     112  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE 
     115Or add all privileges: 
     117  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN 
     120== Permission Groups == 
     122There are two built-in groups, "authenticated" and "anonymous". 
     123Any user who has not logged in is automatically in the "anonymous" group. 
     124Any user who has logged in is also in the "authenticated" group. 
     125The "authenticated" group inherits permissions from the "anonymous" group. 
     126For example, if the "anonymous" group has permission WIKI_MODIFY,  
     127it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well. 
     129Custom groups may be defined that inherit permissions from the two built-in groups. 
     131Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc. 
     133  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN 
     134  $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN 
     135  $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY 
     136  $ trac-admin /path/to/projenv permission add bob developer 
     137  $ trac-admin /path/to/projenv permission add john developer 
     140Group 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'''. 
     142== Adding a New Group and Permissions == 
     143Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group. 
     145The 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) 
     147   $ trac-admin /path/to/projenv permission add bob beta_testers 
     148   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN 
     152== Removing Permissions == 
     154Permissions can be removed using the 'remove' command. For example: 
     156This command will prevent the user ''bob'' from deleting reports: 
     158  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE 
     161Just like `permission add`, this command accepts multiple privilege names. 
     163You can also remove all privileges for a specific user: 
     165  $ trac-admin /path/to/projenv permission remove bob '*' 
     168Or one privilege for all users: 
     170  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN 
     173== Default Permissions == 
     175By 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. 
     176On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''. 
     180 BROWSER_VIEW  
     182 FILE_VIEW  
     183 LOG_VIEW  
     185 REPORT_SQL_VIEW  
     186 REPORT_VIEW  
     187 ROADMAP_VIEW  
     188 SEARCH_VIEW  
     189 TICKET_VIEW  
     191 WIKI_VIEW 
     196 TICKET_CREATE  
     197 TICKET_MODIFY  
     198 WIKI_CREATE  
     199 WIKI_MODIFY   
     202See also: TracAdmin, TracGuide and TracFineGrainedPermissions