Changes between Version 1 and Version 2 of TracPermissions

Timestamp:

Jul 21, 2015, 11:34:14 AM (9 years ago)

Author:

trac

Comment:

--

TracPermissions

@@ -1 @@
-= Trac Permissions =
+= Trac Permissions
 [[TracGuideToc]]
 
 Trac uses a simple, case sensitive, permission system to control what users can and can't access.
 
-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.
+Permission privileges are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' tab of the web interface.
 
 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.
@@ -11 +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".
 
-== Graphical Admin Tab ==
-''This feature is new in version 0.11.''
-
-To access this tab, a user must have `TRAC_ADMIN privileges`. This can be performed as follows (more on the trac-admin script below):
+== Graphical Admin Tab
+
+To 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):
 {{{
   $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
 }}}
 
-Then, the user 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).
-
+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.'''
+
+ 1. [[Image(htdocs:../common/guide/admin.png)]]
+ 1. [[Image(htdocs:../common/guide/admin-permissions.png)]]
+ 1. [[Image(htdocs:../common/guide/admin-permissions-TICKET_ADMIN.png)]]
 
 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.
 
-== Available Privileges ==
+From 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.
+
+== Available Privileges
 
 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.
@@ -30 +34 @@
 Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
 
-=== Repository Browser ===
+=== Repository Browser
 
 || `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
@@ -37 +41 @@
 || `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
 
-=== Ticket System ===
+=== Ticket System
 
 || `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
 || `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
 || `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
-|| `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 ||
-|| `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] ||
+|| `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 ||
+|| `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. ||
 || `TICKET_EDIT_CC` || Full modify cc field ||
 || `TICKET_EDIT_DESCRIPTION` || Modify description field ||
-|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||
+|| `TICKET_EDIT_COMMENT` || Modify another user's comments. Any user can modify their own comments by default. ||
+|| `TICKET_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets ||
+|| `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. ||
 
 Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
 
-=== Roadmap ===
-
-|| `MILESTONE_VIEW` || View a milestone ||
+=== Roadmap
+
+|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
 || `MILESTONE_CREATE` || Create a new milestone ||
 || `MILESTONE_MODIFY` || Modify existing milestones ||
 || `MILESTONE_DELETE` || Delete milestones ||
 || `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
-|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see #4292 ||
-|| `ROADMAP_ADMIN` || to be removed with #3022, replaced by MILESTONE_ADMIN ||
-
-=== Reports ===
+|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
+|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
+
+=== Reports
 
 || `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
@@ -69 +75 @@
 || `REPORT_ADMIN` || All `REPORT_*` permissions ||
 
-=== Wiki System ===
+=== Wiki System
 
 || `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
 || `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
 || `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
+|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
 || `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
 || `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
 
-=== Permissions ===
+=== Permissions
 
 || `PERMISSION_GRANT` || add/grant a permission ||
@@ -83 +90 @@
 || `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
 
-
-=== Others ===
+=== Others
 
 || `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
 || `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
 || `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
-|| `EMAIL_VIEW` || Shows email addresses even if [wiki:0.11/TracIni `trac show_email_addresses` configuration option is `false`] ||
-
-== Granting Privileges ==
+|| `EMAIL_VIEW` || Shows email addresses even if [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false ||
+
+== Creating New Privileges
+
+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.
+
+== Granting Privileges
 
 You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
@@ -113 +123 @@
 }}}
 
-== Permission Groups ==
-
-There are two built-in groups, "authenticated" and "anonymous".[[BR]]
-Any user who has not logged in is automatically in the "anonymous" group.[[BR]]
-Any user who has logged in is also in the "authenticated" group.[[BR]]
-The "authenticated" group inherits permissions from the "anonymous" group.[[BR]]
-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.
+== Permission Groups
+
+There are two built-in groups, "authenticated" and "anonymous".
+Any user who has not logged in is automatically in the "anonymous" group.
+Any user who has logged in is also in the "authenticated" group.
+The "authenticated" group inherits permissions from the "anonymous" group.
+For 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.
 
 Custom groups may be defined that inherit permissions from the two built-in groups.
@@ -132 +143 @@
 }}}
 
-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'''.
-
-== Adding a New Group and Permissions ==
+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'''.
+
+== Adding a New Group and Permissions
 Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
 
@@ -144 +155 @@
 }}}
 
-== Removing Permissions ==
+== Removing Permissions
 
 Permissions can be removed using the 'remove' command. For example:
@@ -165 +176 @@
 }}}
 
-== Default Permissions ==
+== Default Permissions
 
 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.
 On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
 
- '''anonymous'''::
+'''anonymous'''
+{{{
  BROWSER_VIEW 
  CHANGESET_VIEW 
@@ -182 +194 @@
  TICKET_VIEW 
  TIMELINE_VIEW
- WIKI_VIEW 
-
- '''authenticated'''::
+ WIKI_VIEW
+}}}
+
+'''authenticated'''
+{{{
  TICKET_CREATE 
  TICKET_MODIFY 
  WIKI_CREATE 
  WIKI_MODIFY  
-
+}}}
 ----
 See also: TracAdmin, TracGuide and TracFineGrainedPermissions