Changes between Version 1 and Version 2 of TracPermissions

Timestamp:

Apr 28, 2008, 2:20:40 PM (16 years ago)

Author:

trac

Comment:

--

TracPermissions

@@ -2 +2 @@
 [[TracGuideToc]]
 
-Trac uses a simple but flexible permission system to control what users can and can't access.
+Trac uses a simple, case sensitive, permission system to control what users can and can't access.
 
-Permission privileges are managed using the [wiki:TracAdmin trac-admin] tool.
+Permission privileges are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' web interface.
 
-Regular visitors, non-authenticated users, accessing the system are assigned the default 
-role (''user'') named {{{anonymous}}}. 
-Assign permissions to the {{{anonymous}}} user to set privileges for non-authenticated/guest users.
+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.
 
-In addition to these privileges users can be granted additional individual 
-rights in effect when authenticated and logged into the system.
+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.
+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".
 
 == 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 let you do anything you want.
+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:
+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 ===
@@ -31 +29 @@
 || `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
 || `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
-|| `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties ||
+|| `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field ||
 || `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] ||
-|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments. ||
+|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||
+
+Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
 
 === Roadmap ===
@@ -42 +42 @@
 || `MILESTONE_DELETE` || Delete milestones ||
 || `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
-|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page ||
-|| `ROADMAP_ADMIN` || Alias for `MILESTONE_ADMIN` (deprecated) ||
+|| `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 ===
 
-|| `REPORT_VIEW` || View [wiki:TracReports reports] ||
+|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
 || `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
 || `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
@@ -62 +62 @@
 || `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
 
+=== Permissions ===
+
+|| `PERMISSION_GRANT` || add/grant a permission ||
+|| `PERMISSION_REVOKE` || remove/revoke a permission ||
+|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
+
+
 === Others ===
 
@@ -67 +74 @@
 || `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 ==
 
-Currently the only way to grant privileges to users is by using the `trac-admin` script. The current set of privileges can be listed with the following command:
+You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
 {{{
   $ trac-admin /path/to/projenv permission list
@@ -80 +88 @@
 }}}
 
+The `permission add` command also accepts multiple privilege names:
+{{{
+  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
+}}}
+
+Or add all privileges:
+{{{
+  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
+}}}
+
 == 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.
+
+Custom groups may be defined that inherit permissions from the two built-in groups.
 
 Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
@@ -91 +117 @@
 }}}
 
+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 ==
+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)
+{{{ 
+   $ trac-admin /path/to/projenv permission add bob beta_testers
+   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
+
+}}}
+
+== Removing Permissions ==
+
+Permissions can be removed using the 'remove' command. For example:
+
+This command will prevent the user ''bob'' from deleting reports:
+{{{
+  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
+}}}
+
+Just like `permission add`, this command accepts multiple privilege names.
+
+You can also remove all privileges for a specific user:
+{{{
+  $ trac-admin /path/to/projenv permission remove bob '*'
+}}}
+
+Or one privilege for all users:
+{{{
+  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
+}}}
+
 == Default Permissions ==
 
-Granting privileges to the special user ''anonymous'' can be used to control what an anonymous user can do before they have logged in.
+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''.
 
-In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
+ '''anonymous'''::
+ 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 
+
+ '''authenticated'''::
+ TICKET_CREATE 
+ TICKET_MODIFY 
+ WIKI_CREATE 
+ WIKI_MODIFY  
 
 ----
-See also: TracAdmin, TracGuide
+See also: TracAdmin, TracGuide and TracFineGrainedPermissions