Changes between Version 1 and Version 2 of TracPermissions


Ignore:
Timestamp:
08/30/22 13:00:08 (2 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracPermissions

    v1 v2  
    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.
    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 the `[trac] permission_policies` configuration entry in the TracIni. 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 the privileges 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".
    12 
    13 == Graphical Admin Tab ==
    14 ''This feature is new in version 0.11.''
    15 
    16 To access this tab, a user must have one of the following permissions: `TRAC_ADMIN`, `PERMISSION_ADMIN`, `PERMISSION_ADD`, `PERMISSION_REMOVE`. The permissions can granted using the `trac-admin` command (more on `trac-admin` below):
    17 {{{
    18   $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    19 }}}
    20 
    21 Then, 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 
    27 An 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 
    31 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 to perform any operation.
    32 
    33 Otherwise, 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. ||
     6Permissions 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 [TracPlugins plugins] and listing them in [TracIni#trac-permission_policies-option "[trac] permission_policies"]. 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 privilege 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
     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 with a more detailed description [#GrantingPrivileges below]:
     16{{{#!sh
     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 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)]]
     27
     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
     31
     32To enable all privileges for a user, use the `TRAC_ADMIN` permission. This permission is like being `root` on a *NIX system: it will allow you to perform any operation.
     33
     34Otherwise, individual privileges can be assigned to users for the different functional areas of Trac and '''note that the privilege names are uppercase''':
     35
     36=== Repository Browser
     37
     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] ||
     42
     43=== Ticket System
     44
     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. ||
    4950|| `TICKET_EDIT_CC` || Full modify cc field ||
    5051|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
    51 || `TICKET_EDIT_COMMENT` || Modify comments ||
    52 || `TICKET_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets ||
    53 || `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. ||
    54 
    55 Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
    56 
    57 === Roadmap ===
     52|| `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 ||
     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 and it will appear that another user created the ticket. It also allows managing ticket properties through the web administration module. ||
     55
     56=== Roadmap
    5857
    5958|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
    60 || `MILESTONE_CREATE` || Create a new milestone ||
    61 || `MILESTONE_MODIFY` || Modify existing milestones ||
     59|| `MILESTONE_CREATE` || Create new milestones ||
     60|| `MILESTONE_MODIFY` || Modify milestones ||
    6261|| `MILESTONE_DELETE` || Delete milestones ||
    6362|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
    64 || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
     63|| `ROADMAP_VIEW` || View the [TracRoadmap roadmap] page, which is not yet the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
    6564|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
    6665
    67 === Reports ===
    68 
    69 || `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
    70 || `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
    71 || `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
    72 || `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
    73 || `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
     66=== Reports
     67
     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] ||
    7473|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
    7574
    76 === Wiki System ===
    77 
    78 || `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
    79 || `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
    80 || `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
    81 || `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
    82 || `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
     75=== Wiki System
     76
     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 ||
    8382|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
    8483
    85 === Permissions ===
     84=== Permissions
    8685
    8786|| `PERMISSION_GRANT` || add/grant a permission ||
    … …  
    8988|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
    9089
    91 === Others ===
    92 
    93 || `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
    94 || `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
    95 || `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
    96 || `EMAIL_VIEW` || Shows email addresses even if [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false ||
    97 
    98 == Creating New Privileges ==
    99 
    100 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 [wiki:TracIni#extra-permissions-section trac.ini]. For more information, please refer to the documentation of the component in the admin panel.
    101 
    102 == Granting Privileges ==
    103 
    104 You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
     90=== Others
     91
     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 ||
     96
     97== Granting Privileges
     98
     99You 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
     102}}}
     103
     104This command will allow the user ''bob'' to delete reports:
     105{{{#!sh
     106$ trac-admin /path/to/projenv permission add bob REPORT_DELETE
     107}}}
     108
     109The `permission add` command also accepts multiple privilege names:
     110{{{#!sh
     111$ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
     112}}}
     113
     114Or add all privileges:
     115{{{#!sh
     116$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     117}}}
     118
     119== Permission Groups
     120
     121There are two built-in groups, //authenticated// and //anonymous//.
     122Any user who has not logged in is automatically in the //anonymous// group.
     123Any user who has logged in is also in the //authenticated// group.
     124The //authenticated// group inherits permissions from the //anonymous// group.
     125For example, if the //anonymous// group has permission WIKI_MODIFY, it is not necessary to add the WIKI_MODIFY permission to the //authenticated// group as well.
     126
     127Custom groups may be defined that inherit permissions from the two built-in groups.
     128
     129Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
     130{{{#!sh
     131$ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
     132$ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
     133$ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
     134$ trac-admin /path/to/projenv permission add bob developer
     135$ trac-admin /path/to/projenv permission add john developer
     136}}}
     137
     138Group 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'''.
     139
     140== Adding a New Group and Permissions
     141Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
     142
     143The 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.
     144{{{#!sh
     145$ trac-admin /path/to/projenv permission add bob beta_testers
     146$ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     147}}}
     148
     149== Removing Permissions
     150
     151Permissions can be removed using the 'remove' command.
     152
     153This command will prevent the user ''bob'' from deleting reports:
     154{{{#!sh
     155$ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     156}}}
     157
     158Just like `permission add`, this command accepts multiple privilege names.
     159
     160You can also remove all privileges for a specific user:
     161{{{#!sh
     162$ trac-admin /path/to/projenv permission remove bob '*'
     163}}}
     164
     165Or one privilege for all users:
     166{{{#!sh
     167$ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     168}}}
     169
     170== Creating New Privileges
     171
     172To 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.
     173
     174== Default Permissions
     175
     176By 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.
     177On the other hand, the //authenticated// users will have the permissions to ''create and modify tickets and wiki pages''.
     178
     179//**anonymous**//
    105180{{{
    106   $ trac-admin /path/to/projenv permission list
    107 }}}
    108 
    109 This command will allow the user ''bob'' to delete reports:
     181BROWSER_VIEW
     182CHANGESET_VIEW
     183FILE_VIEW
     184LOG_VIEW
     185MILESTONE_VIEW
     186REPORT_SQL_VIEW
     187REPORT_VIEW
     188ROADMAP_VIEW
     189SEARCH_VIEW
     190TICKET_VIEW
     191TIMELINE_VIEW
     192WIKI_VIEW
     193}}}
     194
     195//**authenticated**//
    110196{{{
    111   $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
    112 }}}
    113 
    114 The `permission add` command also accepts multiple privilege names:
    115 {{{
    116   $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
    117 }}}
    118 
    119 Or add all privileges:
    120 {{{
    121   $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    122 }}}
    123 
    124 == Permission Groups ==
    125 
    126 There are two built-in groups, "authenticated" and "anonymous".
    127 Any user who has not logged in is automatically in the "anonymous" group.
    128 Any user who has logged in is also in the "authenticated" group.
    129 The "authenticated" group inherits permissions from the "anonymous" group.
    130 For example, if the "anonymous" group has permission WIKI_MODIFY,
    131 it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well.
    132 
    133 Custom groups may be defined that inherit permissions from the two built-in groups.
    134 
    135 Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
    136 {{{
    137   $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
    138   $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
    139   $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
    140   $ trac-admin /path/to/projenv permission add bob developer
    141   $ trac-admin /path/to/projenv permission add john developer
    142 }}}
    143 
    144 Group 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'''.
    145 
    146 == Adding a New Group and Permissions ==
    147 Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
    148 
    149 The 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)
    150 {{{
    151    $ trac-admin /path/to/projenv permission add bob beta_testers
    152    $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
    153 
    154 }}}
    155 
    156 == Removing Permissions ==
    157 
    158 Permissions can be removed using the 'remove' command. For example:
    159 
    160 This command will prevent the user ''bob'' from deleting reports:
    161 {{{
    162   $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
    163 }}}
    164 
    165 Just like `permission add`, this command accepts multiple privilege names.
    166 
    167 You can also remove all privileges for a specific user:
    168 {{{
    169   $ trac-admin /path/to/projenv permission remove bob '*'
    170 }}}
    171 
    172 Or one privilege for all users:
    173 {{{
    174   $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
    175 }}}
    176 
    177 == Default Permissions ==
    178 
    179 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.
    180 On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
    181 
    182 '''anonymous'''
    183 {{{
    184  BROWSER_VIEW
    185  CHANGESET_VIEW
    186  FILE_VIEW
    187  LOG_VIEW
    188  MILESTONE_VIEW
    189  REPORT_SQL_VIEW
    190  REPORT_VIEW
    191  ROADMAP_VIEW
    192  SEARCH_VIEW
    193  TICKET_VIEW
    194  TIMELINE_VIEW
    195  WIKI_VIEW
    196 }}}
    197 
    198 '''authenticated'''
    199 {{{
    200  TICKET_CREATE
    201  TICKET_MODIFY
    202  WIKI_CREATE
    203  WIKI_MODIFY 
     197TICKET_CREATE
     198TICKET_MODIFY
     199WIKI_CREATE
     200WIKI_MODIFY 
    204201}}}
    205202----
    206 See also: TracAdmin, TracGuide and TracFineGrainedPermissions
     203See also: TracAdmin, TracFineGrainedPermissions