| 5 | | There is a general mechanism in place that allows custom **permission policy plugins** to grant or deny any action on any kind of Trac resource, even at the level of specific versions of such resources. |
| 6 | | |
| 7 | | That mechanism is `authz_policy`, which is an optional module in `tracopt.perm.authz_policy.*`, so it is installed by default. It can be activated via the //Plugins// panel in the Trac administration module. |
| 8 | | |
| 9 | | == Permission Policies == |
| 10 | | |
| 11 | | A great diversity of permission policies can be implemented and Trac comes with a few examples. |
| 12 | | |
| 13 | | Which policies are currently active is determined by a configuration setting in TracIni: |
| 14 | | |
| 15 | | {{{#!ini |
| 16 | | [trac] |
| 17 | | permission_policies = ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy |
| 18 | | }}} |
| 19 | | This lists the [#ReadonlyWikiPolicy] which controls readonly access to wiki pages, followed by the !DefaultPermissionPolicy which checks for the traditional coarse grained style permissions described in TracPermissions, and the !LegacyAttachmentPolicy which knows how to use the coarse grained permissions for checking the permissions available on attachments. |
| | 5 | There is a general mechanism in place that allows custom **permission policies** to grant or deny any action on any Trac resource, or even specific versions of a resource. |
| | 6 | |
| | 7 | That mechanism is `AuthzPolicy`, an optional component in `tracopt.perm.authz_policy.*` which is not activated by default. It can be activated via the //Plugins// panel in the Trac administration module. |
| | 8 | |
| | 9 | See TracPermissions for a more general introduction to Trac permissions and permission policies. |
| | 10 | |
| | 11 | == Permission Policies |
| | 12 | |
| | 13 | A great diversity of permission policies can be implemented and Trac comes with a few examples. |
| | 14 | |
| | 15 | The active policies are determined by a [TracIni#trac-permission_policies-option configuration setting]: |
| | 16 | |
| | 17 | {{{#!ini |
| | 18 | [trac] |
| | 19 | permission_policies = DefaultWikiPolicy, |
| | 20 | DefaultTicketPolicy, |
| | 21 | DefaultPermissionPolicy, |
| | 22 | LegacyAttachmentPolicy |
| | 23 | }}} |
| | 24 | |
| | 25 | * [#DefaultWikiPolicyandDefaultTicketPolicy DefaultWikiPolicy] controls readonly access to wiki pages. |
| | 26 | * [#DefaultWikiPolicyandDefaultTicketPolicy DefaultTicketPolicy] provides elevated privileges in the ticket system for authenticated users. |
| | 27 | * !DefaultPermissionPolicy checks for the traditional coarse-grained permissions described in TracPermissions. |
| | 28 | * !LegacyAttachmentPolicy uses the coarse-grained permissions to check permissions on attachments. |
| 22 | | [trac:source:branches/1.0-stable/tracopt/perm/authz_policy.py authz_policy.py] for details. |
| 23 | | |
| 24 | | Another popular permission policy [#AuthzSourcePolicy], re-implements the pre-0.12 support for checking fine-grained permissions limited to Subversion repositories in terms of the new system. |
| 25 | | |
| 26 | | See also [trac:source:branches/1.0-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. |
| 27 | | |
| 28 | | === !AuthzPolicy === |
| 29 | | ==== Configuration ==== |
| 30 | | * Put a [http://swapoff.org/files/authzpolicy.conf authzpolicy.conf] file somewhere, preferably on a secured location on the server, not readable for others than the webuser. If the file contains non-ASCII characters, the UTF-8 encoding should be used. |
| | 31 | [trac:source:branches/1.4-stable/tracopt/perm/authz_policy.py authz_policy.py] for details. |
| | 32 | |
| | 33 | Another permission policy [#AuthzSourcePolicy], uses the [http://svnbook.red-bean.com/nightly/en/svn.serverconfig.pathbasedauthz.html path-based authorization] defined by Subversion to enforce permissions on the version control system. |
| | 34 | |
| | 35 | See also [trac:source:branches/1.4-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. |
| | 36 | |
| | 37 | === !AuthzPolicy |
| | 38 | ==== Configuration |
| | 39 | * Put an empty conf file (`authzpolicy.conf`) in a secure location on the server, not readable by users other than the webuser. If the file contains non-ASCII characters, the UTF-8 encoding should be used. |
| 32 | | 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section: |
| 33 | | {{{#!ini |
| 34 | | [trac] |
| 35 | | ... |
| 36 | | permission_policies = AuthzPolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy |
| 37 | | }}} |
| 38 | | 1. add a new `[authz_policy]` section: |
| | 41 | 1. modify the [TracIni#trac-permission_policies-option permission_policies] option in the `[trac]` section: |
| | 42 | {{{#!ini |
| | 43 | [trac] |
| | 44 | permission_policies = AuthzPolicy, DefaultWikiPolicy, DefaultTicketPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy |
| | 45 | }}} |
| | 46 | 1. add a new `[authz_policy]` section and point the `authz_file` option to the conf file: |
| 198 | | === !AuthzSourcePolicy (mod_authz_svn-like permission policy) === #AuthzSourcePolicy |
| 199 | | |
| 200 | | At the time of this writing, the old granular permissions system from Trac 0.11 and before used for restricting access to the repository has been converted to a permission policy component. But from the user's point of view, this makes little if any difference. |
| 201 | | |
| 202 | | That kind of granular permission control needs a definition file, which is the one used by Subversion's mod_authz_svn. |
| 203 | | More information about this file format and about its usage in Subversion is available in the [http://svnbook.red-bean.com/en/1.5/svn.serverconfig.pathbasedauthz.html Path-Based Authorization] section in the Server Configuration chapter of the svn book. |
| | 208 | === !AuthzSourcePolicy (`mod_authz_svn`-like permission policy) #AuthzSourcePolicy |
| | 209 | |
| | 210 | `AuthzSourcePolicy` can be used for restricting access to the repository. Granular permission control needs a definition file, which is the one used by Subversion's `mod_authz_svn`. |
| | 211 | More information about this file format and about its usage in Subversion is available in the [http://svnbook.red-bean.com/en/1.7/svn.serverconfig.pathbasedauthz.html Path-Based Authorization] section in the Server Configuration chapter of the svn book. |
| 250 | | '''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac. |
| 251 | | |
| 252 | | As of version 0.12, make sure you have ''!AuthzSourcePolicy'' included in the permission_policies list in trac.ini, otherwise the authz permissions file will be ignored. |
| 253 | | |
| 254 | | {{{#!ini |
| 255 | | [trac] |
| 256 | | permission_policies = AuthzSourcePolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy |
| 257 | | }}} |
| 258 | | |
| 259 | | ==== Subversion Configuration ==== |
| | 258 | '''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac. |
| | 259 | |
| | 260 | Make sure you have ''!AuthzSourcePolicy'' included in the permission_policies list in trac.ini, otherwise the authz permissions file will be ignored. |
| | 261 | |
| | 262 | {{{#!ini |
| | 263 | [trac] |
| | 264 | permission_policies = AuthzSourcePolicy, DefaultWikiPolicy, DefaultTicketPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy |
| | 265 | }}} |
| | 266 | |
| | 267 | ==== Subversion Configuration |
| 274 | | === ReadonlyWikiPolicy |
| 275 | | |
| 276 | | Since 1.1.2, the read-only attribute of wiki pages is enabled and enforced when `ReadonlyWikiPolicy` is in the list of active permission policies. The default for new Trac installations in 1.1.2 and later is: |
| 277 | | {{{ |
| 278 | | [trac] |
| 279 | | permission_policies = ReadonlyWikiPolicy, |
| | 282 | === !DefaultWikiPolicy and !DefaultTicketPolicy |
| | 283 | |
| | 284 | Since 1.1.2, the read-only attribute of wiki pages is enabled and enforced when `DefaultWikiPolicy` is in the list of active permission policies (`DefaultWikiPolicy` was named `ReadonlyWikiPolicy` from Trac 1.1.2 to 1.3.1). The default for new Trac installations in 1.3.2 and later is: |
| | 285 | {{{#!ini |
| | 286 | [trac] |
| | 287 | permission_policies = DefaultWikiPolicy, |
| | 288 | DefaultTicketPolicy, |
| 284 | | When upgrading from earlier versions of Trac, `ReadonlyWikiPolicy` will be appended to the list of `permission_policies` when upgrading the environment, provided that `permission_policies` has the default value. If any non-default `permission_polices` are active, `ReadonlyWikiPolicy` **will need to be manually added** to the list. A message will be echoed to the console when upgrading the environment, indicating if any action needs to be taken. |
| 285 | | |
| 286 | | **!ReadonlyWikiPolicy must be listed //before// !DefaultPermissionPolicy**. The latter returns `True` to allow modify, delete or rename actions when the user has the respective `WIKI_*` permission, without consideration for the read-only attribute. |
| 287 | | |
| 288 | | The `ReadonlyWikiPolicy` returns `False` to deny modify, delete and rename actions on wiki pages when the page has the read-only attribute set and the user does not have `WIKI_ADMIN`, regardless of `WIKI_MODIFY`, `WIKI_DELETE` and `WIKI_RENAME` permissions. It returns `None` for all other cases. |
| 289 | | |
| 290 | | When active, the [#AuthzPolicy] should therefore come before `ReadonlyWikiPolicy`, allowing it to grant or deny the actions on individual resources, which is the usual ordering for `AuthzPolicy` in the `permission_policies` list. |
| 291 | | {{{ |
| | 293 | `DefaultWikiPolicy` returns `False` to deny modify, delete and rename actions on wiki pages when the page has the read-only attribute set and the user does not have `WIKI_ADMIN`, regardless of `WIKI_MODIFY`, `WIKI_DELETE` and `WIKI_RENAME` permissions. It returns `None` for all other cases, which causes the next permission policy in the list to be consulted. |
| | 294 | |
| | 295 | Since 1.3.2 `DefaultTicketPolicy` implements the following behaviors: |
| | 296 | * Authenticated user can edit their own comments. |
| | 297 | * Authenticated user with `TICKET_APPEND` or `TICKET_CHGPROP` can modify the description of a ticket they reported. |
| | 298 | * User with `MILESTONE_VIEW` can change the ticket milestone. |
| | 299 | |
| | 300 | The wiki- and ticket-specific behaviors are implemented in permission policies so they can be easily replaced in case other behavior is desired. |
| | 301 | |
| | 302 | When upgrading from earlier versions of Trac, `DefaultWikiPolicy, DefaultTicketPolicy` will be appended to the list of `permission_policies` when upgrading the environment, provided that `permission_policies` has the default value (`ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy` if upgrading from Trac 1.1.2 or later). If any non-default `permission_polices` are active, `DefaultWikiPolicy, DefaultTicketPolicy` **will need to be manually added** to the list. A message will be echoed to the console when upgrading the environment, indicating if any action needs to be taken. |
| | 303 | |
| | 304 | **!DefaultWikiPolicy and !DefaultTicketPolicy must be listed //before// !DefaultPermissionPolicy**. The latter returns `True` to allow modify, delete or rename actions when the user has the respective `WIKI_*` permission, without consideration for the read-only attribute. Similarly, some of the behaviors implemented in `DefaultTicketPolicy` won't be considered if `DefaultPermissionPolicy` is executed first. |
| | 305 | |
| | 306 | When active, the [#AuthzPolicy] should therefore come before `DefaultWikiPolicy, DefaultTicketPolicy`, allowing it to grant or deny the actions on individual resources, which is the usual ordering for `AuthzPolicy` in the `permission_policies` list. |
| | 307 | {{{#!ini |
| 299 | | The placement of [#AuthzSourcePolicy] relative to `ReadonlyWikiPolicy` does not matter since they don't perform checks on the same realms. |
| 300 | | |
| 301 | | For all other permission policies, the user will need to decide the proper ordering. Generally, if the permission policy should be capable of overriding the check performed by `ReadonlyWikiPolicy`, it should come before `ReadonlyWikiPolicy` in the list. If the `ReadonlyWikiPolicy` should override the check performed by another permission policy, as is the case for `DefaultPermissionPolicy`, then `ReadonlyWikiPolicy` should come first. |
| | 316 | The placement of [#AuthzSourcePolicy] relative to `DefaultWikiPolicy, DefaultTicketPolicy` does not matter since they don't perform checks on the same realms. |
| | 317 | |
| | 318 | For all other permission policies, the user will need to decide the proper ordering. Generally, if the permission policy should be capable of overriding the checks performed by `DefaultWikiPolicy` or `DefaultTicketPolicy`, it should come before the policy it overrides. If `DefaultWikiPolicy` or `DefaultTicketPolicy` should override the check performed by another permission policy, as is the case for those policies relative to `DefaultPermissionPolicy`, then the overriding policy should come first. |
