Changes between Version 2 and Version 3 of TracFineGrainedPermissions
- Timestamp:
- Dec 25, 2018, 9:20:53 PM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFineGrainedPermissions
v2 v3 1 = Fine grained permissions =1 = Fine grained permissions 2 2 [[PageOutline(2-5, Contents, floated)]] 3 3 [[TracGuideToc]] 4 4 5 There is a general mechanism in place that allows custom **permission polic y plugins** to grant or deny any action on any kind of Trac resource, even at the level of specific versions of such resources.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 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 8 9 == Permission Policies ==9 == Permission Policies 10 10 11 11 A great diversity of permission policies can be implemented and Trac comes with a few examples. 12 12 13 Which policies are currently active is determined by a configuration setting in TracIni:13 The active policies are determined by a [TracIni#trac-permission_policies-option configuration setting]: 14 14 15 15 {{{#!ini … … 17 17 permission_policies = ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 18 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. 19 20 * [#ReadonlyWikiPolicy] controls readonly access to wiki pages. 21 * !DefaultPermissionPolicy checks for the traditional coarse-grained permissions described in TracPermissions. 22 * !LegacyAttachmentPolicy uses the coarse-grained permissions to check permissions on attachments. 20 23 21 24 Among the optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See 22 [trac:source:branches/1. 0-stable/tracopt/perm/authz_policy.py authz_policy.py] for details.23 24 Another p opular permission policy [#AuthzSourcePolicy], re-implements the pre-0.12 support for checking fine-grained permissions limited to Subversion repositories in terms of the newsystem.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 othersthan the webuser. If the file contains non-ASCII characters, the UTF-8 encoding should be used.25 [trac:source:branches/1.2-stable/tracopt/perm/authz_policy.py authz_policy.py] for details. 26 27 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 29 See also [trac:source:branches/1.2-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. 30 31 === !AuthzPolicy 32 ==== Configuration 33 * Put a [http://swapoff.org/files/authzpolicy.conf conf] file 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. 31 34 * Update your `trac.ini`: 32 35 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section: 33 36 {{{#!ini 34 37 [trac] 35 ...36 38 permission_policies = AuthzPolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 37 39 }}} 38 1. add a new `[authz_policy]` section :40 1. add a new `[authz_policy]` section and point the `authz_file` option to the conf file: 39 41 {{{#!ini 40 42 [authz_policy] … … 47 49 }}} 48 50 49 ==== Usage Notes ====51 ==== Usage Notes 50 52 51 53 Note the order in which permission policies are specified: policies are implemented in the sequence provided and therefore may override earlier policy specifications. … … 173 175 Note: In order for Timeline to work/visible for John, we must add CHANGESET_VIEW to the above permission list. 174 176 175 ==== Missing Features ====177 ==== Missing Features 176 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]. 177 179 … … 196 198 }}} 197 199 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. 200 === !AuthzSourcePolicy (mod_authz_svn-like permission policy) #AuthzSourcePolicy 201 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.7/svn.serverconfig.pathbasedauthz.html Path-Based Authorization] section in the Server Configuration chapter of the svn book. 204 204 205 205 Example: … … 220 220 * '''/branches/calc/bug-142/secret''' = ''harry has no access, sally has read access (inherited as a sub folder permission)'' 221 221 222 ==== Trac Configuration ====222 ==== Trac Configuration 223 223 224 224 To activate granular permissions you __must__ specify the {{{authz_file}}} option in the `[svn]` section of trac.ini. If this option is set to null or not specified, the permissions will not be used. … … 257 257 }}} 258 258 259 ==== Subversion Configuration ====259 ==== Subversion Configuration 260 260 261 261 The same access file is typically applied to the corresponding Subversion repository using an Apache directive like this:
