Changes between Version 1 and Version 2 of TracPermissions


Ignore:
Timestamp:
Apr 13, 2011, 9:05:26 PM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracPermissions

    v1 v2  
    1 == Trac Permissions ==
     1= Trac Permissions =
    22[[TracGuideToc]]
    33
    4 Trac uses a simple but flexible permission system to control what users can and can't access.
    5 
    6 Permission privilegies 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 privilegies 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.
    14 
    15 === Available privileges ===
    16 
    17  * {{{TRAC_ADMIN}}}
    18  * {{{LOG_VIEW}}}
    19  * {{{FILE_VIEW}}}
    20  * {{{CHANGESET_VIEW}}}
    21  * {{{BROWSER_VIEW}}}
    22  * {{{TICKET_VIEW, TICKET_CREATE, TICKET_MODIFY, TICKET_ADMIN}}}
    23  * {{{REPORT_VIEW, REPORT_CREATE, REPORT_MODIFY, REPORT_DELETE, REPORT_ADMIN, REPORT_SQL_VIEW}}}
    24  * {{{WIKI_VIEW, WIKI_CREATE, WIKI_MODIFY, WIKI_DELETE, WIKI_ADMIN}}}
    25  * {{{MILESTONE_VIEW, MILESTONE_CREATE, MILESTONE_MODIFY, MILESTONE_DELETE}}}
    26  * {{{ROADMAP_VIEW, ROADMAP_ADMIN}}}
    27  * {{{TIMELINE_VIEW}}}
    28  * {{{SEARCH_VIEW}}}
    29  * {{{CONFIG_VIEW}}}
    30 
    31 The {{{something_ADMIN}}} privileges are just shortcuts that can be used to grant a user all the ''something'' privileges in one go. Having {{{TRAC_ADMIN}}}
    32 is like being {{{root}}} on a *NIX system, it will let you do anything you want.
    33 
    34 === Granting privileges ===
    35 
    36 Currently the only way to grant privileges to users is by using the
    37 {{{trac-admin}}} script. The current set of privileges can be listed
    38 with the following command:
    39 
     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 `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.
     28
     29== Available Privileges ==
     30
     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'''):
     34
     35=== Repository Browser ===
     36
     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] ||
     41
     42=== Ticket System ===
     43
     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. ||
     53
     54Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
     55
     56=== Roadmap ===
     57
     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 ||
     65
     66=== Reports ===
     67
     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 ||
     74
     75=== Wiki System ===
     76
     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. ||
     83
     84=== Permissions ===
     85
     86|| `PERMISSION_GRANT` || add/grant a permission ||
     87|| `PERMISSION_REVOKE` || remove/revoke a permission ||
     88|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
     89
     90=== Others ===
     91
     92|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
     93|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
     94|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
     95|| `EMAIL_VIEW` || Shows email addresses even if [trac:wiki:0.11/TracIni trac show_email_addresses configuration option is false] ||
     96
     97== Creating New Privileges ==
     98
     99To create custom permissions, for example to be used in a custom workflow, enable the optional `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.
     100
     101== Granting Privileges ==
     102
     103You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
    40104{{{
    41105  $ trac-admin /path/to/projenv permission list
    42106}}}
    43107
    44 This command will let the user ''bob'' delete reports:
    45 
     108This command will allow the user ''bob'' to delete reports:
    46109{{{
    47110  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
    48111}}}
    49112
    50 === Permission groups ===
    51 
    52 Permissions can be grouped together to form roles such as
    53 ''developer'', ''admin'', etc.
    54 
     113The `permission add` command also accepts multiple privilege names:
     114{{{
     115  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
     116}}}
     117
     118Or add all privileges:
     119{{{
     120  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     121}}}
     122
     123== Permission Groups ==
     124
     125There are two built-in groups, "authenticated" and "anonymous".
     126Any user who has not logged in is automatically in the "anonymous" group.
     127Any user who has logged in is also in the "authenticated" group.
     128The "authenticated" group inherits permissions from the "anonymous" group.
     129For example, if the "anonymous" group has permission WIKI_MODIFY,
     130it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well.
     131
     132Custom groups may be defined that inherit permissions from the two built-in groups.
     133
     134Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
    55135{{{
    56136  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
    … …  
    61141}}}
    62142
    63 === Default permissions ===
    64 
    65 Granting privileges to the special user ''anonymous'' can be used to control
    66 what an anonymous user can do before they have logged in.
    67 
    68 In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
    69 
     143Group 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'''.
     144
     145== Adding a New Group and Permissions ==
     146Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
     147
     148The 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)
     149{{{
     150   $ trac-admin /path/to/projenv permission add bob beta_testers
     151   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     152
     153}}}
     154
     155== Removing Permissions ==
     156
     157Permissions can be removed using the 'remove' command. For example:
     158
     159This command will prevent the user ''bob'' from deleting reports:
     160{{{
     161  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     162}}}
     163
     164Just like `permission add`, this command accepts multiple privilege names.
     165
     166You can also remove all privileges for a specific user:
     167{{{
     168  $ trac-admin /path/to/projenv permission remove bob '*'
     169}}}
     170
     171Or one privilege for all users:
     172{{{
     173  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     174}}}
     175
     176== Default Permissions ==
     177
     178By 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.
     179On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
     180
     181'''anonymous'''
     182{{{
     183 BROWSER_VIEW
     184 CHANGESET_VIEW
     185 FILE_VIEW
     186 LOG_VIEW
     187 MILESTONE_VIEW
     188 REPORT_SQL_VIEW
     189 REPORT_VIEW
     190 ROADMAP_VIEW
     191 SEARCH_VIEW
     192 TICKET_VIEW
     193 TIMELINE_VIEW
     194 WIKI_VIEW
     195}}}
     196
     197'''authenticated'''
     198{{{
     199 TICKET_CREATE
     200 TICKET_MODIFY
     201 WIKI_CREATE
     202 WIKI_MODIFY 
     203}}}
    70204----
    71 See also: TracAdmin, TracGuide
     205See also: TracAdmin, TracGuide and TracFineGrainedPermissions