Trac uses a simple, case sensitive, 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 [TracAdmin trac-admin] tool or 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.
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.
...
@@ -13,17 +13,17 @@ In addition to these privileges, users can be granted additional individual righ
...
@@ -13,17 +13,17 @@ In addition to these privileges, users can be granted additional individual righ
== Graphical Admin Tab
== 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 (more on `trac-admin` below):
{{{
```
$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
}}}
```
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.'''
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.**
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.
An easy way to quickly secure a new Trac install is to run the above command on the anonymous user, install the [AccountManagerPlugin](http://trac-hacks.org/wiki/AccountManagerPlugin), create a new admin account graphically and then remove the TRAC_ADMIN permission from the anonymous user.
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.
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.
...
@@ -31,96 +31,103 @@ From the graphical admin tab, users with `PERMISSION_GRANT` will only be allowed
...
@@ -31,96 +31,103 @@ From the graphical admin tab, users with `PERMISSION_GRANT` will only be allowed
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.
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'''):
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] ||
| `BROWSER_VIEW` | View directory listings in the [repository browser](./TracBrowser) |
|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
| `TICKET_CREATE` | Create new [tickets](./TracTickets) |
|| `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_APPEND` | Add comments or attachments to [tickets](./TracTickets) |
|| `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_CHGPROP` | Modify [ticket](./TracTickets) 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_EDIT_CC` || Full modify cc field ||
| `TICKET_MODIFY` | Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [tickets](./TracTickets). 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_DESCRIPTION` || Modify description field ||
| `TICKET_EDIT_CC` | Full modify cc field |
|| `TICKET_EDIT_COMMENT` || Modify another user's comments. Any user can modify their own comments by default. ||
| `TICKET_EDIT_DESCRIPTION` | Modify description field |
| `TICKET_EDIT_COMMENT` | Modify another user's comments. Any user can modify their own comments by default. |
|| `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 (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.
Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
=== Roadmap
=== Roadmap
|| `MILESTONE_VIEW` || View milestones and assign tickets to milestones. ||
| `MILESTONE_VIEW` | View milestones and assign tickets to milestones. |
|| `MILESTONE_CREATE` || Create a new milestone ||
|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
| `SEARCH_VIEW` | View and execute [search](./TracSearch) queries |
|| `EMAIL_VIEW` || Shows email addresses even if [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false ||
| `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 [trac show_email_addresses](./TracIni#trac-section) configuration option is false |
== Creating New Privileges
== 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.
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 [trac.ini](./TracIni#extra-permissions-section). For more information, please refer to the documentation on the [TracIni](./TracIni#extra-permissions-section) page after enabling the component.
== Granting Privileges
== Granting Privileges
You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
You grant privileges to users using [trac-admin](./TracAdmin). The current set of privileges can be listed with the following command:
{{{
```
$ trac-admin /path/to/projenv permission list
$ trac-admin /path/to/projenv permission list
}}}
```
This command will allow the user ''bob'' to delete reports:
This command will allow the user _bob_ to delete reports:
{{{
```
$ trac-admin /path/to/projenv permission add bob REPORT_DELETE
$ trac-admin /path/to/projenv permission add bob REPORT_DELETE
}}}
```
The `permission add` command also accepts multiple privilege names:
The `permission add` command also accepts multiple privilege names:
{{{
```
$ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
$ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
}}}
```
Or add all privileges:
Or add all privileges:
{{{
```
$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
}}}
```
== Permission Groups
== Permission Groups
...
@@ -133,21 +140,21 @@ it is not necessary to add the WIKI_MODIFY permission to the "authenticated" gro
...
@@ -133,21 +140,21 @@ it is not necessary to add the WIKI_MODIFY permission to the "authenticated" gro
Custom groups may be defined that inherit permissions from the two built-in groups.
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.
Permissions can be grouped together to form roles such as _developer_, _admin_, etc.
$ trac-admin /path/to/projenv permission add bob developer
$ trac-admin /path/to/projenv permission add bob developer
$ trac-admin /path/to/projenv permission add john developer
$ trac-admin /path/to/projenv permission add john developer
}}}
```
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'''.
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
== 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.
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)
{{{
{{{
$ trac-admin /path/to/projenv permission add bob beta_testers
$ trac-admin /path/to/projenv permission add bob beta_testers
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.
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''.
On the other hand, the `authenticated` users will have the permissions to _create and modify tickets and wiki pages_.
'''anonymous'''
**anonymous**
{{{
```
BROWSER_VIEW
BROWSER_VIEW
CHANGESET_VIEW
CHANGESET_VIEW
FILE_VIEW
FILE_VIEW
...
@@ -194,14 +201,14 @@ On the other hand, the `authenticated` users will have the permissions to ''crea
...
@@ -194,14 +201,14 @@ On the other hand, the `authenticated` users will have the permissions to ''crea
TICKET_VIEW
TICKET_VIEW
TIMELINE_VIEW
TIMELINE_VIEW
WIKI_VIEW
WIKI_VIEW
}}}
```
'''authenticated'''
**authenticated**
{{{
```
TICKET_CREATE
TICKET_CREATE
TICKET_MODIFY
TICKET_MODIFY
WIKI_CREATE
WIKI_CREATE
WIKI_MODIFY
WIKI_MODIFY
}}}
```
----
----
See also: TracAdmin, TracGuide and TracFineGrainedPermissions
See also: TracAdmin, TracGuide and TracFineGrainedPermissions
