![(please configure the [header_logo] section in trac.ini)](/pubtrac/GeniusWebProfilesServer/chrome/site/your_project_logo.png){kind=logo}
Changes between Version 1 and Version 2 of TracFineGrainedPermissions
- Timestamp:
- 12/24/20 01:28:04 (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFineGrainedPermissions
v1 v2 5 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 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. 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. 8 10 9 11 == Permission Policies 10 12 11 A great diversity of permission policies can be implemented and Trac comes with a few examples. 13 A great diversity of permission policies can be implemented and Trac comes with a few examples. 12 14 13 15 The active policies are determined by a [TracIni#trac-permission_policies-option configuration setting]: … … 15 17 {{{#!ini 16 18 [trac] 17 permission_policies = ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 18 }}} 19 20 * [#ReadonlyWikiPolicy] controls readonly access to wiki pages. 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. 21 27 * !DefaultPermissionPolicy checks for the traditional coarse-grained permissions described in TracPermissions. 22 28 * !LegacyAttachmentPolicy uses the coarse-grained permissions to check permissions on attachments. 23 29 24 30 Among the optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See 25 [trac:source:branches/1. 2-stable/tracopt/perm/authz_policy.py authz_policy.py] for details.31 [trac:source:branches/1.4-stable/tracopt/perm/authz_policy.py authz_policy.py] for details. 26 32 27 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. 28 34 29 See also [trac:source:branches/1. 2-stable/sample-plugins/permissions sample-plugins/permissions] for more examples.35 See also [trac:source:branches/1.4-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. 30 36 31 37 === !AuthzPolicy 32 38 ==== Configuration 33 * Put a [http://swapoff.org/files/authzpolicy.conf conf] filein 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.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. 34 40 * Update your `trac.ini`: 35 1. modify the [TracIni#trac- section permission_policies] entryin the `[trac]` section:36 {{{#!ini 37 [trac] 38 permission_policies = AuthzPolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy41 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 39 45 }}} 40 46 1. add a new `[authz_policy]` section and point the `authz_file` option to the conf file: … … 88 94 * Sections are checked against the current Trac resource descriptor '''IN ORDER''' of appearance in the configuration file. '''ORDER IS CRITICAL'''. 89 95 90 * Once a section matches, the current username is matched against the keys (usernames) of the section, '''IN ORDER'''. 91 * If a key (username) is prefixed with a `@`, it is treated as a group. 96 * Once a section matches, the current username is matched against the keys (usernames) of the section, '''IN ORDER'''. 97 * If a key (username) is prefixed with a `@`, it is treated as a group. 92 98 * If a value (permission) is prefixed with a `!`, the permission is denied rather than granted. 93 99 94 The username will match any of 'anonymous', 'authenticated', <username> or '*', using normal Trac permission rules. || '''Note:''' Other groups which are created by user (e.g. by 'adding subjects to groups' on web interface page //Admin / Permissions//) cannot be used. See [trac:ticket:5648 #5648] for details about this missing feature. || 100 The username will match any of 'anonymous', 'authenticated', <username> or '*', using normal Trac permission rules. 101 102 || '''Note:''' Other groups which are created by user (e.g. by 'adding subjects to groups' on web interface page //Admin / Permissions//) cannot be used. See [trac:#5648] for details about this missing feature. || 95 103 96 104 For example, if the `authz_file` contains: … … 110 118 }}} 111 119 112 Then: 120 Then: 113 121 * All versions of WikiStart will be viewable by everybody, including anonymous 114 122 * !PrivatePage will be viewable only by john … … 164 172 john = BROWSER_VIEW, FILE_VIEW 165 173 166 # John has BROWSER_VIEW and FILE_VIEW access to all revisions of 'somefile' at trunk/src/some/location only 174 # John has BROWSER_VIEW and FILE_VIEW access to all revisions of 'somefile' at trunk/src/some/location only 167 175 [repository:test_repo@*/source:trunk/src/some/location/somefile@*] 168 176 john = BROWSER_VIEW, FILE_VIEW … … 176 184 177 185 ==== Missing Features 178 Although possible with the !DefaultPermissionPolicy handling (see Admin panel), fine-grained permissions still miss those grouping features (see [trac: ticket:9573 #9573], [trac:ticket:5648#5648]). Patches are partially available, see authz_policy.2.patch, part of [trac:ticket:6680 #6680].186 Although possible with the !DefaultPermissionPolicy handling (see Admin panel), fine-grained permissions still miss those grouping features (see [trac:#9573], [trac:#5648]). Patches are partially available, see authz_policy.2.patch, part of [trac:ticket:6680 #6680]. 179 187 180 188 You cannot do the following: … … 198 206 }}} 199 207 200 === !AuthzSourcePolicy ( mod_authz_svn-like permission policy) #AuthzSourcePolicy201 202 `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.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. 204 212 205 213 Example: … … 243 251 ... 244 252 [repositories] 245 somemodule.dir = /srv/active/svn/somemodule 253 somemodule.dir = /srv/active/svn/somemodule 246 254 }}} 247 255 248 256 where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[somemodule:/some/path]}}}. 249 257 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, LegacyAttachmentPolicy258 '''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 257 265 }}} 258 266 … … 272 280 For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]. 273 281 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, 280 289 DefaultPermissionPolicy, 281 290 LegacyAttachmentPolicy 282 291 }}} 283 292 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 292 308 [trac] 293 309 permission_policies = AuthzPolicy, 294 ReadonlyWikiPolicy, 310 DefaultWikiPolicy, 311 DefaultTicketPolicy, 295 312 DefaultPermissionPolicy, 296 313 LegacyAttachmentPolicy 297 314 }}} 298 315 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. 302 319 303 320 == Debugging permissions … … 319 336 ---- 320 337 See also: TracPermissions, 321 [http ://trac-hacks.org/wiki/FineGrainedPageAuthzEditorPlugin TracHacks:FineGrainedPageAuthzEditorPlugin] for a simple editor plugin.338 [https://trac-hacks.org/wiki/FineGrainedPageAuthzEditorPlugin FineGrainedPageAuthzEditorPlugin] for a simple editor.
