Changes between Version 3 and Version 4 of TracPermissions


Ignore:
Timestamp:
Apr 24, 2017, 10:36:12 AM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v3 v4  
    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 `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).
     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.'''
    2221
    2322 1. [[Image(htdocs:../common/guide/admin.png)]]
     
    2726An 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.
    2827
    29 == 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
    3031
    3132To 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.
     
    3334Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
    3435
    35 === Repository Browser ===
     36=== Repository Browser
    3637
    3738|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
     
    4041|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
    4142
    42 === Ticket System ===
     43=== Ticket System
    4344
    4445|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
     
    4950|| `TICKET_EDIT_CC` || Full modify cc field ||
    5051|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
    51 || `TICKET_EDIT_COMMENT` || Modify comments ||
    52 || `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. ||
     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. ||
    5355
    5456Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
    5557
    56 === Roadmap ===
     58=== Roadmap
    5759
    5860|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
     
    6466|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
    6567
    66 === Reports ===
     68=== Reports
    6769
    6870|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
     
    7375|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
    7476
    75 === Wiki System ===
     77=== Wiki System
    7678
    7779|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
     
    8284|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
    8385
    84 === Permissions ===
     86=== Permissions
    8587
    8688|| `PERMISSION_GRANT` || add/grant a permission ||
     
    8890|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
    8991
    90 
    91 === Others ===
     92=== Others
    9293
    9394|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
    9495|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
    9596|| `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 [trac:wiki:0.11/TracIni trac show_email_addresses configuration option is false] ||
    97 
    98 == 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
    99104
    100105You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
     
    118123}}}
    119124
    120 == Permission Groups ==
     125== Permission Groups
    121126
    122127There are two built-in groups, "authenticated" and "anonymous".
     
    140145Group 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'''.
    141146
    142 == Adding a New Group and Permissions ==
     147== Adding a New Group and Permissions
    143148Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
    144149
     
    150155}}}
    151156
    152 == Removing Permissions ==
     157== Removing Permissions
    153158
    154159Permissions can be removed using the 'remove' command. For example:
     
    171176}}}
    172177
    173 == Default Permissions ==
     178== Default Permissions
    174179
    175180By 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.