Changes between Version 4 and Version 5 of TracPermissions


Ignore:
Timestamp:
Jun 6, 2013 4:39:50 AM (14 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v4 v5  
    22[[TracGuideToc]] 
    33 
    4 Trac uses a simple but flexible permission system to control what users can and can't access. 
    5  
    6 Permission privileges are managed using the [wiki:TracAdmin trac-admin] tool. 
    7  
    8 Regular visitors, non-authenticated users, accessing the system are assigned the default  
    9 role (''user'') named {{{anonymous}}}.  
    10 Assign permissions to the {{{anonymous}}} user to set privileges for non-authenticated/guest users. 
    11  
    12 In addition to these privileges users can be granted additional individual  
    13 rights in effect when authenticated and logged into the system. 
     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_ADD`, `PERMISSION_REMOVE`. The permissions can 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. 
    1428 
    1529== Available Privileges == 
    1630 
    17 To enable all privileges for a user, use the `TRAC_ADMIN` permission. Having `TRAC_ADMIN` is like being `root` on a *NIX system, it will let you do anything you want. 
    18  
    19 Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac: 
     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. 
     32 
     33Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''): 
    2034 
    2135=== Repository Browser === 
     
    3145|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] || 
    3246|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] || 
    33 || `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties || 
    34 || `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] || 
    35 || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments. || 
     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_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets || 
     53|| `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. || 
     54 
     55Attention: the "view tickets" button appears with the `REPORT_VIEW` permission. 
    3656 
    3757=== Roadmap === 
    3858 
    39 || `MILESTONE_VIEW` || View a milestone || 
     59|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. || 
    4060|| `MILESTONE_CREATE` || Create a new milestone || 
    4161|| `MILESTONE_MODIFY` || Modify existing milestones || 
    4262|| `MILESTONE_DELETE` || Delete milestones || 
    4363|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions || 
    44 || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page || 
    45 || `ROADMAP_ADMIN` || Alias for `MILESTONE_ADMIN` (deprecated) || 
     64|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] || 
     65|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN || 
    4666 
    4767=== Reports === 
    4868 
    49 || `REPORT_VIEW` || View [wiki:TracReports reports] || 
     69|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. || 
    5070|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] || 
    5171|| `REPORT_CREATE` || Create new [wiki:TracReports reports] || 
     
    5979|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages || 
    6080|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages || 
     81|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages || 
    6182|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments || 
    6283|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. || 
     84 
     85=== Permissions === 
     86 
     87|| `PERMISSION_GRANT` || add/grant a permission || 
     88|| `PERMISSION_REVOKE` || remove/revoke a permission || 
     89|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions || 
    6390 
    6491=== Others === 
     
    6794|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries || 
    6895|| `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 [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false || 
     97 
     98== Creating New Privileges == 
     99 
     100To 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 of the component in the admin panel. 
    69101 
    70102== Granting Privileges == 
    71103 
    72 Currently the only way to grant privileges to users is by using the `trac-admin` script. The current set of privileges can be listed with the following command: 
     104You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command: 
    73105{{{ 
    74106  $ trac-admin /path/to/projenv permission list 
     
    80112}}} 
    81113 
     114The `permission add` command also accepts multiple privilege names: 
     115{{{ 
     116  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE 
     117}}} 
     118 
     119Or add all privileges: 
     120{{{ 
     121  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN 
     122}}} 
     123 
    82124== Permission Groups == 
     125 
     126There are two built-in groups, "authenticated" and "anonymous". 
     127Any user who has not logged in is automatically in the "anonymous" group. 
     128Any user who has logged in is also in the "authenticated" group. 
     129The "authenticated" group inherits permissions from the "anonymous" group. 
     130For example, if the "anonymous" group has permission WIKI_MODIFY,  
     131it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well. 
     132 
     133Custom groups may be defined that inherit permissions from the two built-in groups. 
    83134 
    84135Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc. 
     
    91142}}} 
    92143 
     144Group 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'''. 
     145 
     146== Adding a New Group and Permissions == 
     147Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group. 
     148 
     149The 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) 
     150{{{  
     151   $ trac-admin /path/to/projenv permission add bob beta_testers 
     152   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN 
     153 
     154}}} 
     155 
     156== Removing Permissions == 
     157 
     158Permissions can be removed using the 'remove' command. For example: 
     159 
     160This command will prevent the user ''bob'' from deleting reports: 
     161{{{ 
     162  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE 
     163}}} 
     164 
     165Just like `permission add`, this command accepts multiple privilege names. 
     166 
     167You can also remove all privileges for a specific user: 
     168{{{ 
     169  $ trac-admin /path/to/projenv permission remove bob '*' 
     170}}} 
     171 
     172Or one privilege for all users: 
     173{{{ 
     174  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN 
     175}}} 
     176 
    93177== Default Permissions == 
    94178 
    95 Granting privileges to the special user ''anonymous'' can be used to control what an anonymous user can do before they have logged in. 
    96  
    97 In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user. 
    98  
     179By 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. 
     180On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''. 
     181 
     182'''anonymous''' 
     183{{{ 
     184 BROWSER_VIEW  
     185 CHANGESET_VIEW  
     186 FILE_VIEW  
     187 LOG_VIEW  
     188 MILESTONE_VIEW  
     189 REPORT_SQL_VIEW  
     190 REPORT_VIEW  
     191 ROADMAP_VIEW  
     192 SEARCH_VIEW  
     193 TICKET_VIEW  
     194 TIMELINE_VIEW 
     195 WIKI_VIEW 
     196}}} 
     197 
     198'''authenticated''' 
     199{{{ 
     200 TICKET_CREATE  
     201 TICKET_MODIFY  
     202 WIKI_CREATE  
     203 WIKI_MODIFY   
     204}}} 
    99205---- 
    100 See also: TracAdmin, TracGuide 
     206See also: TracAdmin, TracGuide and TracFineGrainedPermissions