Changes between Version 4 and Version 5 of TracPermissions


Ignore:
Timestamp:
Feb 26, 2008 5:40:00 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v4 v5  
    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 ===
     
    3233|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||
    3334
     35Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
     36
    3437=== Roadmap ===
    3538
     
    3942|| `MILESTONE_DELETE` || Delete milestones ||
    4043|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
    41 || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page ||
     44|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see #4292 ||
     45|| `ROADMAP_ADMIN` || to be removed with #3022, replaced by MILESTONE_ADMIN ||
    4246
    4347=== Reports ===
    4448
    45 || `REPORT_VIEW` || View [wiki:TracReports reports] ||
     49|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
    4650|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
    4751|| `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
     
    5862|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
    5963
     64=== Permissions ===
     65
     66|| `PERMISSION_GRANT` || add/grant a permission ||
     67|| `PERMISSION_REVOKE` || remove/revoke a permission ||
     68|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
     69
     70
    6071=== Others ===
    6172
     
    6374|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
    6475|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
     76|| `EMAIL_VIEW` || Shows email addresses even if [wiki:0.11/TracIni `trac show_email_addresses` configuration option is `false`] ||
    6577
    6678== Granting Privileges ==
     
    8193}}}
    8294
     95Or add all privileges:
     96{{{
     97  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     98}}}
     99
    83100== Permission Groups ==
     101
     102There are two built-in groups, "authenticated" and "anonymous".[[BR]]
     103Any user who has not logged in is automatically in the "anonymous" group.[[BR]]
     104Any user who has logged in is also in the "authenticated" group.[[BR]]
     105The "authenticated" group inherits permissions from the "anonymous" group.[[BR]]
     106eg. if the "anonymous" group has permission WIKI_MODIFY, it's not necessary to add the WIKI_MODIFY permisison to the "authenticated" group as well.
     107
     108Custom groups may be defined that inherit permissions from the two built-in groups.
    84109
    85110Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
     
    92117}}}
    93118
    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.
     119Group 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'''.
     120
     121== Adding a New Group and Permissions ==
     122Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
     123
     124The 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)
     125{{{
     126   $ trac-admin /path/to/projenv permission add bob beta_testers
     127   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     128
     129}}}
    95130
    96131== Removing Permissions ==
     
    107142You can also remove all privileges for a specific user:
    108143{{{
    109   $ trac-admin /path/to/projenv permission remove bob *
     144  $ trac-admin /path/to/projenv permission remove bob '*'
    110145}}}
    111146
    112147Or one privilege for all users:
    113148{{{
    114   $ trac-admin /path/to/projenv permission remove * REPORT_ADMIN
     149  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
    115150}}}
    116151
    117152== Default Permissions ==
    118153
    119 Granting privileges to the special user ''anonymous'' can be used to control what an anonymous user can do before they have logged in.
     154By 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.
     155On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
    120156
    121 In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
     157 '''anonymous'''::
     158 BROWSER_VIEW
     159 CHANGESET_VIEW
     160 FILE_VIEW
     161 LOG_VIEW
     162 MILESTONE_VIEW
     163 REPORT_SQL_VIEW
     164 REPORT_VIEW
     165 ROADMAP_VIEW
     166 SEARCH_VIEW
     167 TICKET_VIEW
     168 TIMELINE_VIEW
     169 WIKI_VIEW
     170
     171 '''authenticated'''::
     172 TICKET_CREATE
     173 TICKET_MODIFY
     174 WIKI_CREATE
     175 WIKI_MODIFY 
    122176
    123177----
    124 See also: TracAdmin, TracGuide and [http://trac.edgewall.org/wiki/FineGrainedPermissions FineGrainedPermissions]
     178See also: TracAdmin, TracGuide and TracFineGrainedPermissions