Changes between Version 2 and Version 3 of TracPermissions


Ignore:
Timestamp:
May 26, 2018, 6:07:36 PM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracPermissions

    v2 v3  
    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.''
     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 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
    1514
    1615To 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):
    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.
     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)]]
    2827
    2928From 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.
    3029
    31 == Available Privileges ==
     30== Available Privileges
    3231
    3332To 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.
    … …  
    3534Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
    3635
    37 === Repository Browser ===
    38 
    39 || `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
    40 || `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
    41 || `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
    42 || `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
    43 
    44 === Ticket System ===
    45 
    46 || `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
    47 || `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
    48 || `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
    49 || `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 ||
    50 || `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. ||
     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. ||
    5150|| `TICKET_EDIT_CC` || Full modify cc field ||
    5251|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
    53 || `TICKET_EDIT_COMMENT` || Modify comments ||
    54 || `TICKET_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets ||
    55 || `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. ||
    56 
    57 Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
    58 
    59 === 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 (it will appear that another user created the ticket). It also allows managing ticket properties through the web administration module. ||
     55
     56=== Roadmap
    6057
    6158|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
    62 || `MILESTONE_CREATE` || Create a new milestone ||
    63 || `MILESTONE_MODIFY` || Modify existing milestones ||
     59|| `MILESTONE_CREATE` || Create new milestones ||
     60|| `MILESTONE_MODIFY` || Modify milestones ||
    6461|| `MILESTONE_DELETE` || Delete milestones ||
    6562|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
    66 || `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] ||
    6764|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
    6865
    69 === Reports ===
    70 
    71 || `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
    72 || `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
    73 || `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
    74 || `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
    75 || `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] ||
    7673|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
    7774
    78 === Wiki System ===
    79 
    80 || `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
    81 || `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
    82 || `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
    83 || `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
    84 || `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 ||
    8582|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
    8683
    87 === Permissions ===
     84=== Permissions
    8885
    8986|| `PERMISSION_GRANT` || add/grant a permission ||
    … …  
    9188|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
    9289
    93 === Others ===
    94 
    95 || `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
    96 || `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
    97 || `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
    98 || `EMAIL_VIEW` || Shows email addresses even if [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false ||
    99 
    100 == Creating New Privileges ==
    101 
    102 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  on the [wiki:TracIni#extra-permissions-section TracIni] page after enabling the component.
    103 
    104 == Granting Privileges ==
    105 
    106 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,
     126it is not necessary to add the WIKI_MODIFY permission to the //authenticated// group as well.
     127
     128Custom groups may be defined that inherit permissions from the two built-in groups.
     129
     130Permissions 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
     139Group 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'''.
     140
     141== Adding a New Group and Permissions
     142Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
     143
     144The 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
     148}}}
     149
     150== Removing Permissions
     151
     152Permissions can be removed using the 'remove' command. For example:
     153
     154This command will prevent the user ''bob'' from deleting reports:
     155{{{#!sh
     156$ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     157}}}
     158
     159Just like `permission add`, this command accepts multiple privilege names.
     160
     161You can also remove all privileges for a specific user:
     162{{{#!sh
     163$ trac-admin /path/to/projenv permission remove bob '*'
     164}}}
     165
     166Or one privilege for all users:
     167{{{#!sh
     168$ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     169}}}
     170
     171== Creating New Privileges
     172
     173To 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== Default Permissions
     176
     177By 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.
     178On the other hand, the //authenticated// users will have the permissions to ''create and modify tickets and wiki pages''.
     179
     180//**anonymous**//
    107181{{{
    108   $ trac-admin /path/to/projenv permission list
    109 }}}
    110 
    111 This command will allow the user ''bob'' to delete reports:
     182BROWSER_VIEW
     183CHANGESET_VIEW
     184FILE_VIEW
     185LOG_VIEW
     186MILESTONE_VIEW
     187REPORT_SQL_VIEW
     188REPORT_VIEW
     189ROADMAP_VIEW
     190SEARCH_VIEW
     191TICKET_VIEW
     192TIMELINE_VIEW
     193WIKI_VIEW
     194}}}
     195
     196//**authenticated**//
    112197{{{
    113   $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
    114 }}}
    115 
    116 The `permission add` command also accepts multiple privilege names:
    117 {{{
    118   $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
    119 }}}
    120 
    121 Or add all privileges:
    122 {{{
    123   $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    124 }}}
    125 
    126 == Permission Groups ==
    127 
    128 There are two built-in groups, "authenticated" and "anonymous".
    129 Any user who has not logged in is automatically in the "anonymous" group.
    130 Any user who has logged in is also in the "authenticated" group.
    131 The "authenticated" group inherits permissions from the "anonymous" group.
    132 For example, if the "anonymous" group has permission WIKI_MODIFY,
    133 it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well.
    134 
    135 Custom groups may be defined that inherit permissions from the two built-in groups.
    136 
    137 Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
    138 {{{
    139   $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
    140   $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
    141   $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
    142   $ trac-admin /path/to/projenv permission add bob developer
    143   $ trac-admin /path/to/projenv permission add john developer
    144 }}}
    145 
    146 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'''.
    147 
    148 == Adding a New Group and Permissions ==
    149 Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
    150 
    151 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)
    152 {{{
    153    $ trac-admin /path/to/projenv permission add bob beta_testers
    154    $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
    155 
    156 }}}
    157 
    158 == Removing Permissions ==
    159 
    160 Permissions can be removed using the 'remove' command. For example:
    161 
    162 This command will prevent the user ''bob'' from deleting reports:
    163 {{{
    164   $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
    165 }}}
    166 
    167 Just like `permission add`, this command accepts multiple privilege names.
    168 
    169 You can also remove all privileges for a specific user:
    170 {{{
    171   $ trac-admin /path/to/projenv permission remove bob '*'
    172 }}}
    173 
    174 Or one privilege for all users:
    175 {{{
    176   $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
    177 }}}
    178 
    179 == Default Permissions ==
    180 
    181 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.
    182 On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
    183 
    184 '''anonymous'''
    185 {{{
    186  BROWSER_VIEW
    187  CHANGESET_VIEW
    188  FILE_VIEW
    189  LOG_VIEW
    190  MILESTONE_VIEW
    191  REPORT_SQL_VIEW
    192  REPORT_VIEW
    193  ROADMAP_VIEW
    194  SEARCH_VIEW
    195  TICKET_VIEW
    196  TIMELINE_VIEW
    197  WIKI_VIEW
    198 }}}
    199 
    200 '''authenticated'''
    201 {{{
    202  TICKET_CREATE
    203  TICKET_MODIFY
    204  WIKI_CREATE
    205  WIKI_MODIFY 
     198TICKET_CREATE
     199TICKET_MODIFY
     200WIKI_CREATE
     201WIKI_MODIFY 
    206202}}}
    207203----
    208 See also: TracAdmin, TracGuide and TracFineGrainedPermissions
     204See also: TracAdmin, TracFineGrainedPermissions