Changes between Version 1 and Version 2 of TracPermissions

Show
Ignore:
Timestamp:
02/01/11 22:58:21 (3 years ago)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v1 v2  
    22[[TracGuideToc]] 
    33 
    4 Trac uses a simple permission system to control what users can and can't access. 
     4Trac uses a simple, case sensitive, permission system to control what users can and can't access. 
    55 
    6 Permission privileges are managed using the [wiki:TracAdmin trac-admin] tool. 
     6Permission privileges are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' 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. 
    79 
    810Non-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. 
    9  
    1011In 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". 
    1112 
    1213== Available Privileges == 
    1314 
    14 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 allow you perform any operation. 
     15To 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. 
    1516 
    16 Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac (note that the privilege names are case-sensitive): 
     17Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''): 
    1718 
    1819=== Repository Browser === 
     
    2829|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] || 
    2930|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] || 
    30 || `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field || 
     31|| `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field, cc field add/remove when logged in or set email to pref || 
    3132|| `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] || 
     33|| `TICKET_EDIT_CC` || Full modify cc field || 
     34|| `TICKET_EDIT_DESCRIPTION` || Modify description field || 
    3235|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field || 
     36 
     37Attention: the "view tickets" button appears with the `REPORT_VIEW` permission. 
    3338 
    3439=== Roadmap === 
     
    3944|| `MILESTONE_DELETE` || Delete milestones || 
    4045|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions || 
    41 || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page || 
     46|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see #4292 || 
     47|| `ROADMAP_ADMIN` || to be removed with #3022, replaced by MILESTONE_ADMIN || 
    4248 
    4349=== Reports === 
    4450 
    45 || `REPORT_VIEW` || View [wiki:TracReports reports] || 
     51|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. || 
    4652|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] || 
    4753|| `REPORT_CREATE` || Create new [wiki:TracReports reports] || 
     
    5864|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. || 
    5965 
     66=== Permissions === 
     67 
     68|| `PERMISSION_GRANT` || add/grant a permission || 
     69|| `PERMISSION_REVOKE` || remove/revoke a permission || 
     70|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions || 
     71 
     72 
    6073=== Others === 
    6174 
     
    6376|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries || 
    6477|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins || 
     78|| `EMAIL_VIEW` || Shows email addresses even if [wiki:0.11/TracIni `trac show_email_addresses` configuration option is `false`] || 
    6579 
    6680== Granting Privileges == 
     
    8195}}} 
    8296 
     97Or add all privileges: 
     98{{{ 
     99  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN 
     100}}} 
     101 
    83102== Permission Groups == 
     103 
     104There are two built-in groups, "authenticated" and "anonymous".[[BR]] 
     105Any user who has not logged in is automatically in the "anonymous" group.[[BR]] 
     106Any user who has logged in is also in the "authenticated" group.[[BR]] 
     107The "authenticated" group inherits permissions from the "anonymous" group.[[BR]] 
     108eg. if the "anonymous" group has permission WIKI_MODIFY, it's not necessary to add the WIKI_MODIFY permisison to the "authenticated" group as well. 
     109 
     110Custom groups may be defined that inherit permissions from the two built-in groups. 
    84111 
    85112Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc. 
     
    92119}}} 
    93120 
    94 Group membership can be checked by doing a {{{permission list}}} with no further arguments; the resulting output will include group memberships. Use lowercase for group names, as uppercase is reserved for permissions. 
     121Group membership can be checked by doing a {{{permission list}}} with no further arguments; the resulting output will include group memberships. '''Use lowercase for group names, as uppercase is reserved for permissions'''. 
     122 
     123== Adding a New Group and Permissions == 
     124Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group. 
     125 
     126The 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) 
     127{{{  
     128   $ trac-admin /path/to/projenv permission add bob beta_testers 
     129   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN 
     130 
     131}}} 
    95132 
    96133== Removing Permissions == 
     
    107144You can also remove all privileges for a specific user: 
    108145{{{ 
    109   $ trac-admin /path/to/projenv permission remove bob * 
     146  $ trac-admin /path/to/projenv permission remove bob '*' 
    110147}}} 
    111148 
    112149Or one privilege for all users: 
    113150{{{ 
    114   $ trac-admin /path/to/projenv permission remove * REPORT_ADMIN 
     151  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN 
    115152}}} 
    116153 
    117154== Default Permissions == 
    118155 
    119 Granting privileges to the special user ''anonymous'' can be used to control what an anonymous user can do before they have logged in. 
     156By 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. 
     157On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''. 
    120158 
    121 In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user. 
     159 '''anonymous''':: 
     160 BROWSER_VIEW  
     161 CHANGESET_VIEW  
     162 FILE_VIEW  
     163 LOG_VIEW  
     164 MILESTONE_VIEW  
     165 REPORT_SQL_VIEW  
     166 REPORT_VIEW  
     167 ROADMAP_VIEW  
     168 SEARCH_VIEW  
     169 TICKET_VIEW  
     170 TIMELINE_VIEW 
     171 WIKI_VIEW  
     172 
     173 '''authenticated''':: 
     174 TICKET_CREATE  
     175 TICKET_MODIFY  
     176 WIKI_CREATE  
     177 WIKI_MODIFY   
    122178 
    123179---- 
    124 See also: TracAdmin, TracGuide and [http://trac.edgewall.org/wiki/FineGrainedPermissions FineGrainedPermissions] 
     180See also: TracAdmin, TracGuide and TracFineGrainedPermissions