close Warning: Can't synchronize with repository "(default)" (/common/SVN/wimax does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 3 and Version 4 of TracPermissions


Ignore:
Timestamp:
Jan 30, 2019, 11:46:28 PM (19 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v3 v4  
    44Trac uses a simple, case sensitive, permission system to control what users can and can't access.
    55
    6 Permissions are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' tab of the web interface.
    7 
    8 In 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 [TracIni#trac-permission_policies-option "[trac] permission_policies"]. See TracFineGrainedPermissions for more details.
    9 
    10 Non-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 privilege for will not be displayed in the navigation.
    11 In 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//.
     6Permission privileges are managed using the [TracAdmin trac-admin] tool or 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".
    1212
    1313== Graphical Admin Tab
    1414
    1515To 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):
    16 {{{#!sh
    17 $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    18 }}}
    19 
    20 Then, the user `bob` will be able to see the Admin tab, and can access the permissions menu. This menu will allow you to perform all the following actions, but from the browser rather than requiring root access to the server. '''Use at least one lowercase character in user names, as all-uppercase names are reserved for permissions.'''
    21 
    22 [[Image(htdocs:../common/guide/admin.png)]]
    23 
    24 [[Image(htdocs:../common/guide/admin-permissions.png)]]
    25 
    26 [[Image(htdocs:../common/guide/admin-permissions-TICKET_ADMIN.png)]]
     16{{{
     17  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     18}}}
     19
     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)]]
     25
     26An 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.
    2727
    2828From 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.
     
    3636=== Repository Browser
    3737
    38 || `BROWSER_VIEW` || View directory listings in the [TracBrowser repository browser] ||
    39 || `FILE_VIEW` || View files in the [TracBrowser repository browser] ||
    40 || `CHANGESET_VIEW` || View [TracChangeset repository check-ins] ||
    41 || `LOG_VIEW` || View revision logs of files and directories in the [TracBrowser repository browser] ||
     38|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
     39|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
     40|| `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
     41|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
    4242
    4343=== Ticket System
    4444
    45 || `TICKET_VIEW` || View existing [TracTickets tickets] and perform [TracQuery ticket queries] ||
    46 || `TICKET_CREATE` || Create new [TracTickets tickets] ||
    47 || `TICKET_APPEND` || Add comments or attachments to [TracTickets tickets] ||
    48 || `TICKET_CHGPROP` || Modify [TracTickets ticket] properties (priority, assignment, keywords, etc.) with the following exceptions: edit description field, add/remove other users from cc field when logged in ||
    49 || `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [TracTickets tickets] in the [TracWorkflow default workflow]. Tickets can be assigned to users through a [TracTickets#Assign-toasDrop-DownList drop-down list] when the list of possible owners has been restricted. ||
     45|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
     46|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
     47|| `TICKET_APPEND` || Add comments or attachments to [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. ||
    5050|| `TICKET_EDIT_CC` || Full modify cc field ||
    5151|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
    5252|| `TICKET_EDIT_COMMENT` || Modify another user's comments. Any user can modify their own comments by default. ||
    53 || `TICKET_BATCH_MODIFY` || [TracBatchModify Batch modify] tickets ||
     53|| `TICKET_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets ||
    5454|| `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. ||
    5555
     56Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
     57
    5658=== Roadmap
    5759
    5860|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
    59 || `MILESTONE_CREATE` || Create new milestones ||
    60 || `MILESTONE_MODIFY` || Modify milestones ||
     61|| `MILESTONE_CREATE` || Create a new milestone ||
     62|| `MILESTONE_MODIFY` || Modify existing milestones ||
    6163|| `MILESTONE_DELETE` || Delete milestones ||
    6264|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
    63 || `ROADMAP_VIEW` || View the [TracRoadmap roadmap] page, which is not yet the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
     65|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
    6466|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
    6567
    6668=== Reports
    6769
    68 || `REPORT_VIEW` || View [TracReports reports], i.e. the //View Tickets// link. ||
    69 || `REPORT_SQL_VIEW` || View the SQL query of a [TracReports report] ||
    70 || `REPORT_CREATE` || Create new [TracReports reports] ||
    71 || `REPORT_MODIFY` || Modify [TracReports reports] ||
    72 || `REPORT_DELETE` || Delete [TracReports reports] ||
     70|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
     71|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
     72|| `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
     73|| `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
     74|| `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
    7375|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
    7476
    7577=== Wiki System
    7678
    77 || `WIKI_VIEW` || View [TracWiki wiki] pages ||
    78 || `WIKI_CREATE` || Create new [TracWiki wiki] pages ||
    79 || `WIKI_MODIFY` || Modify [TracWiki wiki] pages ||
    80 || `WIKI_RENAME` || Rename [TracWiki wiki] pages ||
    81 || `WIKI_DELETE` || Delete [TracWiki wiki] pages and attachments ||
     79|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
     80|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
     81|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
     82|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
     83|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
    8284|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
    8385
     
    9092=== Others
    9193
    92 || `TIMELINE_VIEW` || View the [TracTimeline timeline] page ||
    93 || `SEARCH_VIEW` || View and execute [TracSearch search] queries ||
    94 || `CONFIG_VIEW` || Enables additional sections on ''About Trac'' that show the current configuration and the list of installed plugins ||
    95 || `EMAIL_VIEW` || Shows email addresses even if [TracIni#trac-section trac show_email_addresses] configuration option is false ||
     94|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
     95|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
     96|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
     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.
    96102
    97103== Granting Privileges
    98104
    99 You grant privileges to users using [TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
    100 {{{#!sh
    101 $ trac-admin /path/to/projenv permission list
     105You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
     106{{{
     107  $ trac-admin /path/to/projenv permission list
    102108}}}
    103109
    104110This command will allow the user ''bob'' to delete reports:
    105 {{{#!sh
    106 $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
     111{{{
     112  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
    107113}}}
    108114
    109115The `permission add` command also accepts multiple privilege names:
    110 {{{#!sh
    111 $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
     116{{{
     117  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
    112118}}}
    113119
    114120Or add all privileges:
    115 {{{#!sh
    116 $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     121{{{
     122  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    117123}}}
    118124
    119125== Permission Groups
    120126
    121 There are two built-in groups, //authenticated// and //anonymous//.
    122 Any user who has not logged in is automatically in the //anonymous// group.
    123 Any user who has logged in is also in the //authenticated// group.
    124 The //authenticated// group inherits permissions from the //anonymous// group.
    125 For example, if the //anonymous// group has permission WIKI_MODIFY,
    126 it is not necessary to add the WIKI_MODIFY permission to the //authenticated// group as well.
     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.
    127133
    128134Custom groups may be defined that inherit permissions from the two built-in groups.
    129135
    130136Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
    131 {{{#!sh
    132 $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
    133 $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
    134 $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
    135 $ trac-admin /path/to/projenv permission add bob developer
    136 $ trac-admin /path/to/projenv permission add john developer
     137{{{
     138  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
     139  $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
     140  $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
     141  $ trac-admin /path/to/projenv permission add bob developer
     142  $ trac-admin /path/to/projenv permission add john developer
    137143}}}
    138144
     
    143149
    144150The 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)
    145 {{{#!sh
    146 $ trac-admin /path/to/projenv permission add bob beta_testers
    147 $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     151{{{
     152   $ trac-admin /path/to/projenv permission add bob beta_testers
     153   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     154
    148155}}}
    149156
     
    153160
    154161This command will prevent the user ''bob'' from deleting reports:
    155 {{{#!sh
    156 $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     162{{{
     163  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
    157164}}}
    158165
     
    160167
    161168You can also remove all privileges for a specific user:
    162 {{{#!sh
    163 $ trac-admin /path/to/projenv permission remove bob '*'
     169{{{
     170  $ trac-admin /path/to/projenv permission remove bob '*'
    164171}}}
    165172
    166173Or one privilege for all users:
    167 {{{#!sh
    168 $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
    169 }}}
    170 
    171 == Creating New Privileges
    172 
    173 To 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 [TracIni#extra-permissions-section trac.ini]. For more information, please refer to the documentation  on the [TracIni#extra-permissions-section TracIni] page after enabling the component.
     174{{{
     175  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     176}}}
    174177
    175178== Default Permissions
    176179
    177 By 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.
    178 On the other hand, the //authenticated// users will have the permissions to ''create and modify tickets and wiki pages''.
    179 
    180 //**anonymous**//
    181 {{{
    182 BROWSER_VIEW
    183 CHANGESET_VIEW
    184 FILE_VIEW
    185 LOG_VIEW
    186 MILESTONE_VIEW
    187 REPORT_SQL_VIEW
    188 REPORT_VIEW
    189 ROADMAP_VIEW
    190 SEARCH_VIEW
    191 TICKET_VIEW
    192 TIMELINE_VIEW
    193 WIKI_VIEW
    194 }}}
    195 
    196 //**authenticated**//
    197 {{{
    198 TICKET_CREATE
    199 TICKET_MODIFY
    200 WIKI_CREATE
    201 WIKI_MODIFY 
     180By 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.
     181On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
     182
     183'''anonymous'''
     184{{{
     185 BROWSER_VIEW
     186 CHANGESET_VIEW
     187 FILE_VIEW
     188 LOG_VIEW
     189 MILESTONE_VIEW
     190 REPORT_SQL_VIEW
     191 REPORT_VIEW
     192 ROADMAP_VIEW
     193 SEARCH_VIEW
     194 TICKET_VIEW
     195 TIMELINE_VIEW
     196 WIKI_VIEW
     197}}}
     198
     199'''authenticated'''
     200{{{
     201 TICKET_CREATE
     202 TICKET_MODIFY
     203 WIKI_CREATE
     204 WIKI_MODIFY 
    202205}}}
    203206----
    204 See also: TracAdmin, TracFineGrainedPermissions
     207See also: TracAdmin, TracGuide and TracFineGrainedPermissions