close Warning:

Changes between Version 2 and Version 3 of TracPermissions


Ignore:
Timestamp:
May 13, 2015, 11:55:11 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v2 v3  
    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 the ''General / Permissions'' panel in the ''Admin'' web interface.
     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.
    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.
     
    1010Non-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.
    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".
     12
     13== Graphical Admin Tab ==
     14''This feature is new in version 0.11.''
     15
     16To 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
     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
     29From 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.
    1230
    1331== Available Privileges ==
     
    2947|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
    3048|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
    31 || `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 ||
    32 || `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [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. ||
    3351|| `TICKET_EDIT_CC` || Full modify cc field ||
    3452|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
    35 || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the 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. ||
    3656
    3757Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
     
    3959=== Roadmap ===
    4060
    41 || `MILESTONE_VIEW` || View a milestone ||
     61|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
    4262|| `MILESTONE_CREATE` || Create a new milestone ||
    4363|| `MILESTONE_MODIFY` || Modify existing milestones ||
    4464|| `MILESTONE_DELETE` || Delete milestones ||
    4565|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
    46 || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see #4292 ||
    47 || `ROADMAP_ADMIN` || to be removed with #3022, replaced by MILESTONE_ADMIN ||
     66|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
     67|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
    4868
    4969=== Reports ===
     
    6181|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
    6282|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
     83|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
    6384|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
    6485|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
     
    7091|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
    7192
    72 
    7393=== Others ===
    7494
     
    7696|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
    7797|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
    78 || `EMAIL_VIEW` || Shows email addresses even if [wiki:0.11/TracIni `trac show_email_addresses` configuration option is `false`] ||
     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
     102To 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.
    79103
    80104== Granting Privileges ==
     
    102126== Permission Groups ==
    103127
    104 There are two built-in groups, "authenticated" and "anonymous".[[BR]]
    105 Any user who has not logged in is automatically in the "anonymous" group.[[BR]]
    106 Any user who has logged in is also in the "authenticated" group.[[BR]]
    107 The "authenticated" group inherits permissions from the "anonymous" group.[[BR]]
    108 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.
     128There are two built-in groups, "authenticated" and "anonymous".
     129Any user who has not logged in is automatically in the "anonymous" group.
     130Any user who has logged in is also in the "authenticated" group.
     131The "authenticated" group inherits permissions from the "anonymous" group.
     132For example, if the "anonymous" group has permission WIKI_MODIFY,
     133it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well.
    109134
    110135Custom groups may be defined that inherit permissions from the two built-in groups.
     
    119144}}}
    120145
    121 Group membership can be checked by doing a {{{permission list}}} with no further arguments; the resulting output will include group memberships. '''Use lowercase for group names, as uppercase is reserved for permissions'''.
     146Group 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'''.
    122147
    123148== Adding a New Group and Permissions ==
     
    157182On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
    158183
    159  '''anonymous'''::
     184'''anonymous'''
     185{{{
    160186 BROWSER_VIEW
    161187 CHANGESET_VIEW
     
    169195 TICKET_VIEW
    170196 TIMELINE_VIEW
    171  WIKI_VIEW
    172 
    173  '''authenticated'''::
     197 WIKI_VIEW
     198}}}
     199
     200'''authenticated'''
     201{{{
    174202 TICKET_CREATE
    175203 TICKET_MODIFY
    176204 WIKI_CREATE
    177205 WIKI_MODIFY 
    178 
     206}}}
    179207----
    180208See also: TracAdmin, TracGuide and TracFineGrainedPermissions