source: wiki/pages/TracPermissions @ 40542

Last change on this file since 40542 was 40542, checked in by obi, 2 years ago

reset wiki files

File size: 10.9 KB
Line 
1= Trac Permissions
2[[TracGuideToc]]
3
4Trac uses a simple, case sensitive, permission system to control what users can and can't access.
5
6Permission privileges are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' tab of the web interface.
7
8In 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.
9
10Non-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.
11In 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
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):
16{{{
17  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
18}}}
19
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.'''
21
22 1. [[Image(htdocs:../common/guide/admin.png)]]
23 1. [[Image(htdocs:../common/guide/admin-permissions.png)]]
24 1. [[Image(htdocs:../common/guide/admin-permissions-TICKET_ADMIN.png)]]
25
26An 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.
27
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
31
32To 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.
33
34Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
35
36=== Repository Browser
37
38|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
39|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
40|| `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
41|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
42
43=== Ticket System
44
45|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
46|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
47|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
48|| `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 ||
49|| `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. ||
50|| `TICKET_EDIT_CC` || Full modify cc field ||
51|| `TICKET_EDIT_DESCRIPTION` || Modify description field ||
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. ||
55
56Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
57
58=== Roadmap
59
60|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
61|| `MILESTONE_CREATE` || Create a new milestone ||
62|| `MILESTONE_MODIFY` || Modify existing milestones ||
63|| `MILESTONE_DELETE` || Delete milestones ||
64|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
65|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see [trac:#4292 #4292] ||
66|| `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN ||
67
68=== Reports
69
70|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
71|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
72|| `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
73|| `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
74|| `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
75|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
76
77=== Wiki System
78
79|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
80|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
81|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
82|| `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages ||
83|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
84|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
85
86=== Permissions
87
88|| `PERMISSION_GRANT` || add/grant a permission ||
89|| `PERMISSION_REVOKE` || remove/revoke a permission ||
90|| `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
91
92=== Others
93
94|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
95|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
96|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
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
104
105You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
106{{{
107  $ trac-admin /path/to/projenv permission list
108}}}
109
110This command will allow the user ''bob'' to delete reports:
111{{{
112  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
113}}}
114
115The `permission add` command also accepts multiple privilege names:
116{{{
117  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
118}}}
119
120Or add all privileges:
121{{{
122  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
123}}}
124
125== Permission Groups
126
127There are two built-in groups, "authenticated" and "anonymous".
128Any user who has not logged in is automatically in the "anonymous" group.
129Any user who has logged in is also in the "authenticated" group.
130The "authenticated" group inherits permissions from the "anonymous" group.
131For example, if the "anonymous" group has permission WIKI_MODIFY,
132it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well.
133
134Custom groups may be defined that inherit permissions from the two built-in groups.
135
136Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
137{{{
138  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
139  $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
140  $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
141  $ trac-admin /path/to/projenv permission add bob developer
142  $ trac-admin /path/to/projenv permission add john developer
143}}}
144
145Group 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'''.
146
147== Adding a New Group and Permissions
148Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
149
150The 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)
151{{{
152   $ trac-admin /path/to/projenv permission add bob beta_testers
153   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
154
155}}}
156
157== Removing Permissions
158
159Permissions can be removed using the 'remove' command. For example:
160
161This command will prevent the user ''bob'' from deleting reports:
162{{{
163  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
164}}}
165
166Just like `permission add`, this command accepts multiple privilege names.
167
168You can also remove all privileges for a specific user:
169{{{
170  $ trac-admin /path/to/projenv permission remove bob '*'
171}}}
172
173Or one privilege for all users:
174{{{
175  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
176}}}
177
178== Default Permissions
179
180By 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.
181On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
182
183'''anonymous'''
184{{{
185 BROWSER_VIEW
186 CHANGESET_VIEW
187 FILE_VIEW
188 LOG_VIEW
189 MILESTONE_VIEW
190 REPORT_SQL_VIEW
191 REPORT_VIEW
192 ROADMAP_VIEW
193 SEARCH_VIEW
194 TICKET_VIEW
195 TIMELINE_VIEW
196 WIKI_VIEW
197}}}
198
199'''authenticated'''
200{{{
201 TICKET_CREATE
202 TICKET_MODIFY
203 WIKI_CREATE
204 WIKI_MODIFY 
205}}}
206----
207See also: TracAdmin, TracGuide and TracFineGrainedPermissions
Note: See TracBrowser for help on using the repository browser.