Changes between Initial Version and Version 1 of TracPermissions


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