Changes between Version 2 and Version 3 of TracPermissions

Timestamp:

Sep 13, 2025, 3:01:44 PM (3 months ago)

Author:

trac

Comment:

--

TracPermissions

@@ -8 +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 [TracIni#trac-permission_policies-option "[trac] permission_policies"]. See TracFineGrainedPermissions for more details.
 
-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 privilege for will not be displayed in the navigation.
+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 privileges for will not be displayed in the navigation bar.
 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
 
-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):
+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 with a more detailed description [#GrantingPrivileges below]:
 {{{#!sh
 $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
 }}}
 
-Then, 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.'''
+Then, the user `bob` will be able to see the Admin tab, and can access the permissions menu. This menu allows you to perform 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.'''
 
 [[Image(htdocs:../common/guide/admin.png)]]
@@ -30 +30 @@
 == 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.
-
-Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
+To 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 on Trac.
+
+Otherwise, individual privileges can be assigned to users for the different functional areas of Trac and '''note that the privilege names are uppercase''':
 
 === Repository Browser
@@ -45 +45 @@
 || `TICKET_VIEW` || View existing [TracTickets tickets] and perform [TracQuery ticket queries] ||
 || `TICKET_CREATE` || Create new [TracTickets tickets] ||
-|| `TICKET_APPEND` || Add comments or attachments to [TracTickets tickets] ||
-|| `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 ||
+|| `TICKET_APPEND` || Add comments and attachments to [TracTickets tickets], and edit description of ticket that the user created ||
+|| `TICKET_CHGPROP` || Modify [TracTickets ticket] properties (priority, assignment, keywords, etc.) with the following exceptions: edit description of tickets created by others, add/remove other users from cc field when logged in ||
 || `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. ||
 || `TICKET_EDIT_CC` || Full modify cc field ||
-|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
+|| `TICKET_EDIT_DESCRIPTION` || Modify description field. User with `TICKET_APPEND` or `TICKET_CHGPROP` can modify description of ticket they created. ||
 || `TICKET_EDIT_COMMENT` || Modify another user's comments. Any user can modify their own comments by default. ||
 || `TICKET_BATCH_MODIFY` || [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. ||
+|| `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. ||
 
 === Roadmap
@@ -62 +62 @@
 || `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
 || `ROADMAP_VIEW` || View the [TracRoadmap roadmap] page, which 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 ||
+|| `ROADMAP_ADMIN` || To be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
 
 === Reports
@@ -95 +95 @@
 || `EMAIL_VIEW` || Shows email addresses even if [TracIni#trac-section trac show_email_addresses] configuration option is false ||
 
+== Attachment Permissions
+
+Attachment permissions are handled by `LegacyAttachmentPolicy`, and unlike the permissions discussed so far, the permissions provided by `LegacyAttachmentPolicy` are not directly granted. Rather, the ability to create, view and delete attachments is determined by the attachment's parent realm and permissions that the user possesses for that realm.
+
+The attachment actions are determined by the following permissions in the ticket, wiki and milestone realms:
+{{{#!table class="listing"
+||= Granted By: =||= Ticket =||= Wiki =||= Milestone =||
+|| `ATTACHMENT_CREATE` || `TICKET_APPEND` || `WIKI_MODIFY` || `MILESTONE_MODIFY` ||
+|| `ATTACHMENT_VIEW` || `TICKET_VIEW` || `WIKI_VIEW` || `MILESTONE_VIEW` ||
+|| `ATTACHMENT_DELETE` || `TICKET_ADMIN` || `WIKI_DELETE` || `MILESTONE_DELETE` ||
+}}}
+
+An authenticated user can delete an attachment //they added// without possessing the permission that grants `ATTACHMENT_DELETE`.
+
+If explicit attachment permissions are preferred, then `ATTACHMENT_CREATE`, `ATTACHMENT_DELETE` and `ATTACHMENT_VIEW` can be created using the [trac:ExtraPermissionsProvider]. The simplest implementation is to simply define the actions:
+{{{#!ini
+[extra-permissions]
+_perms = ATTACHMENT_CREATE, ATTACHMENT_DELETE, ATTACHMENT_VIEW
+}}}
+
+An alternative configuration adds an `ATTACHMENT_ADMIN` meta-permission that grants the other 3 permissions:
+{{{#!ini
+[extra-permissions]
+ATTACHMENT_ADMIN = ATTACHMENT_CREATE, ATTACHMENT_DELETE, ATTACHMENT_VIEW
+}}}
+
+The explicit permissions can be used in conjunction with `LegacyAttachmentPolicy`, or `LegacyAttachmentPolicy` can be removed from `permission_policies`, in which case only users that have been explicitly granted the corresponding attachment actions will be able to create, delete and view attachments.
+
 == Granting Privileges
 
-You grant privileges to users using [TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
+Privileges are granted to users through [TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
 {{{#!sh
 $ trac-admin /path/to/projenv permission list
@@ -123 +151 @@
 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.
+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.
@@ -140 +167 @@
 
 == 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.
 
-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)
+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.
 {{{#!sh
 $ trac-admin /path/to/projenv permission add bob beta_testers
@@ -150 +178 @@
 == Removing Permissions
 
-Permissions can be removed using the 'remove' command. For example:
+Permissions can be removed using the 'remove' command.
 
 This command will prevent the user ''bob'' from deleting reports:
@@ -175 +203 @@
 == 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''.
+By default on a new Trac installation, the //anonymous// user has ''view'' access to everything in Trac, but is not able to create or modify anything.
+The //authenticated// user has the permissions to ''create and modify tickets and wiki pages''.
 
 //**anonymous**//
 {{{
-BROWSER_VIEW 
-CHANGESET_VIEW 
-FILE_VIEW 
-LOG_VIEW 
-MILESTONE_VIEW 
-REPORT_SQL_VIEW 
-REPORT_VIEW 
-ROADMAP_VIEW 
-SEARCH_VIEW 
-TICKET_VIEW 
+BROWSER_VIEW
+CHANGESET_VIEW
+FILE_VIEW
+LOG_VIEW
+MILESTONE_VIEW
+REPORT_SQL_VIEW
+REPORT_VIEW
+ROADMAP_VIEW
+SEARCH_VIEW
+TICKET_VIEW
 TIMELINE_VIEW
 WIKI_VIEW
@@ -196 +224 @@
 //**authenticated**//
 {{{
-TICKET_CREATE 
-TICKET_MODIFY 
-WIKI_CREATE 
-WIKI_MODIFY  
-}}}
+TICKET_CREATE
+TICKET_MODIFY
+WIKI_CREATE
+WIKI_MODIFY
+}}}
+
 ----
 See also: TracAdmin, TracFineGrainedPermissions