Changes between Version 6 and Version 7 of TracPermissions


Ignore:
Timestamp:
03/07/18 16:17:30 (15 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v6 v7  
    1 = Trac Permissions =
     1= Trac Permissions
    22[[TracGuideToc]]
    33
    44Trac uses a simple, case sensitive, permission system to control what users can and can't access.
    55
    6 Permission 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.
     6Permission privileges are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' tab of the web interface.
    77
    88In 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.
     
    1111In 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".
    1212
    13 == Graphical Admin Tab ==
    14 ''This feature is new in version 0.11.''
    15 
    16 To access this tab, a user must have `TRAC_ADMIN privileges`. This can be performed as follows (more on the trac-admin script below):
     13== Graphical Admin Tab
     14
     15To access this tab, a user must have one of the following permissions: `TRAC_ADMIN`, `PERMISSION_ADMIN`, `PERMISSION_GRANT`, `PERMISSION_REVOKE`. The permissions can be granted using the `trac-admin` command (more on `trac-admin` below):
    1716{{{
    1817  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    1918}}}
    2019
    21 Then, 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 
     20Then, 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.'''
     21
     22 1. [[Image(htdocs:../common/guide/admin.png)]]
     23 1. [[Image(htdocs:../common/guide/admin-permissions.png)]]
     24 1. [[Image(htdocs:../common/guide/admin-permissions-TICKET_ADMIN.png)]]
    2325
    2426An 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.
    2527
    26 == Available Privileges ==
     28From the graphical admin tab, users with `PERMISSION_GRANT` will only be allowed to grant permissions that they possess, and users with `PERMISSION_REVOKE` will only be allowed to revoke permissions that they possess. For example, a user cannot grant `MILESTONE_ADMIN` unless they have `PERMISSION_GRANT` and `MILESTONE_ADMIN`, and they cannot revoke `MILESTONE_ADMIN` unless they have `PERMISSION_REVOKE` and `MILESTONE_ADMIN`. `PERMISSION_ADMIN` just grants the user both `PERMISSION_GRANT` and `PERMISSION_REVOKE`, and users with `TRAC_ADMIN` can grant or revoke any permission.
     29
     30== Available Privileges
    2731
    2832To 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.
     
    3034Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
    3135
    32 === Repository Browser ===
     36=== Repository Browser
    3337
    3438|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
     
    3741|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
    3842
    39 === Ticket System ===
     43=== Ticket System
    4044
    4145|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
    4246|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
    4347|| `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] ||
     48|| `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 ||
     49|| `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. ||
    4650|| `TICKET_EDIT_CC` || Full modify cc field ||
    4751|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
    48 || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||
     52|| `TICKET_EDIT_COMMENT` || Modify another user's comments. Any user can modify their own comments by default. ||
     53|| `TICKET_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets ||
     54|| `TICKET_ADMIN` || All `TICKET_*` permissions, deletion of ticket attachments and modification of the reporter field, which grants ability to create a ticket on behalf of another user (it will appear that another user created the ticket). It also allows managing ticket properties through the web administration module. ||
    4955
    5056Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
    5157
    52 === Roadmap ===
    53 
    54 || `MILESTONE_VIEW` || View a milestone ||
     58=== Roadmap
     59
     60|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
    5561|| `MILESTONE_CREATE` || Create a new milestone ||
    5662|| `MILESTONE_MODIFY` || Modify existing milestones ||
    5763|| `MILESTONE_DELETE` || Delete milestones ||
    5864|| `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 ===
     65|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
     66|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
     67
     68=== Reports
    6369
    6470|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
     
    6975|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
    7076
    71 === Wiki System ===
     77=== Wiki System
    7278
    7379|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
    7480|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
    7581|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
     82|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
    7683|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
    7784|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
    7885
    79 === Permissions ===
     86=== Permissions
    8087
    8188|| `PERMISSION_GRANT` || add/grant a permission ||
     
    8390|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
    8491
    85 
    86 === Others ===
     92=== Others
    8793
    8894|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
    8995|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
    9096|| `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 ==
     97|| `EMAIL_VIEW` || Shows email addresses even if [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false ||
     98
     99== Creating New Privileges
     100
     101To 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  on the [wiki:TracIni#extra-permissions-section TracIni] page after enabling the component.
     102
     103== Granting Privileges
    94104
    95105You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
     
    113123}}}
    114124
    115 == Permission Groups ==
    116 
    117 There are two built-in groups, "authenticated" and "anonymous".[[BR]]
    118 Any user who has not logged in is automatically in the "anonymous" group.[[BR]]
    119 Any user who has logged in is also in the "authenticated" group.[[BR]]
    120 The "authenticated" group inherits permissions from the "anonymous" group.[[BR]]
    121 eg. if the "anonymous" group has permission WIKI_MODIFY, it's not necessary to add the WIKI_MODIFY permisison to the "authenticated" group as well.
     125== Permission Groups
     126
     127There are two built-in groups, "authenticated" and "anonymous".
     128Any user who has not logged in is automatically in the "anonymous" group.
     129Any user who has logged in is also in the "authenticated" group.
     130The "authenticated" group inherits permissions from the "anonymous" group.
     131For example, if the "anonymous" group has permission WIKI_MODIFY,
     132it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well.
    122133
    123134Custom groups may be defined that inherit permissions from the two built-in groups.
     
    132143}}}
    133144
    134 Group membership can be checked by doing a {{{
    135 permission list
    136 }}} with no further arguments; the resulting output will include group memberships. '''Use lowercase for group names, as uppercase is reserved for permissions'''.
    137 
    138 == Adding a New Group and Permissions ==
     145Group 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'''.
     146
     147== Adding a New Group and Permissions
    139148Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
    140149
    141150The 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)
    142 {{{
     151{{{ 
    143152   $ trac-admin /path/to/projenv permission add bob beta_testers
    144153   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     
    146155}}}
    147156
    148 == Removing Permissions ==
     157== Removing Permissions
    149158
    150159Permissions can be removed using the 'remove' command. For example:
     
    167176}}}
    168177
    169 == Default Permissions ==
     178== Default Permissions
    170179
    171180By 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.
    172181On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
    173182
    174  '''anonymous'''::
     183'''anonymous'''
     184{{{
    175185 BROWSER_VIEW
    176186 CHANGESET_VIEW
     
    184194 TICKET_VIEW
    185195 TIMELINE_VIEW
    186  WIKI_VIEW
    187 
    188  '''authenticated'''::
     196 WIKI_VIEW
     197}}}
     198
     199'''authenticated'''
     200{{{
    189201 TICKET_CREATE
    190202 TICKET_MODIFY
    191203 WIKI_CREATE
    192204 WIKI_MODIFY 
    193 
     205}}}
    194206----
    195207See also: TracAdmin, TracGuide and TracFineGrainedPermissions
    196