Changes between Version 1 and Version 2 of TracFineGrainedPermissions
- Timestamp:
- 2011-11-17T12:29:42Z (13 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFineGrainedPermissions
v1 v2 3 3 Before Trac 0.11, it was only possible to define fine-grained permissions checks on the repository browser sub-system. 4 4 5 Since 0.11, there's a general mechanism in place that allows custom permission policy plugins to grant or deny any action on any kind of Trac resources, even at the level of specific versions of such resources. 5 Since 0.11, there's a general mechanism in place that allows custom **permission policy plugins** to grant or deny any action on any kind of Trac resources, even at the level of specific versions of such resources. 6 7 Note that for Trac 0.12, `authz_policy` has been integrated as an optional module (in `tracopt.perm.authz_policy.*`), so it's installed by default and can simply be activated via the //Plugins// panel in the Trac administration module. 8 6 9 7 10 == Permission Policies == 8 11 9 === !AuthzPolicy === 12 A great diversity of permission policies can be implemented, and Trac comes with a few examples. 10 13 11 An example policy based on an Authz-style system has been added. See 12 [source:trunk/sample-plugins/permissions/authz_policy.py] for details. (See also [source:trunk/sample-plugins/permissions] for more samples.) 14 Which policies are currently active is determined by a configuration setting in TracIni: 15 e.g. 16 {{{ 17 [trac] 18 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 19 }}} 20 This lists the [#AuthzSourcePolicy] described below as the first policy, 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. 21 22 Among the possible optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See 23 [trac:source:branches/0.12-stable/tracopt/perm/authz_policy.py authz_policy.py] for details. 24 25 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. 26 27 See also [trac:source:branches/0.12-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. 28 29 30 === !AuthzPolicy === 13 31 14 32 - Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (required). 15 - Copy this file in your plugins directory16 - P lonk a [http://swapoff.org/files/authzpolicy.conf authzpolicy.conf] file somewhere. FIXME: what does ''plonk'' mean? ;-)33 - Copy authz_policy.py into your plugins directory. 34 - 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. 17 35 - Update your `trac.ini`: 36 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section 18 37 {{{ 19 38 [trac] 20 39 ... 21 permission_policies = AuthzPolicy, DefaultPermissionPolicy 22 40 permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 41 }}} 42 2. add a new `[authz_policy]` section 43 {{{ 23 44 [authz_policy] 24 45 authz_file = /some/trac/env/conf/authzpolicy.conf 25 46 }}} 47 3. enable the single file plugin 48 {{{ 26 49 [components] 27 50 ... 28 authz_policy = enabled 51 # Trac 0.12 52 tracopt.perm.authz_policy.* = enabled 53 # for Trac 0.11 use this 54 #authz_policy.* = enabled 29 55 }}} 30 56 … … 40 66 {{{ 41 67 [wiki:WikiStart@*] 42 * = VIEW68 * = WIKI_VIEW 43 69 44 70 [wiki:PrivatePage@*] 45 john = VIEW71 john = WIKI_VIEW 46 72 * = 47 73 }}} … … 59 85 60 86 61 === mod_authz_svn-like permission policy ===87 === !AuthzSourcePolicy (mod_authz_svn-like permission policy) === #AuthzSourcePolicy 62 88 63 At the time of this writing, the old fine grained permissions system from Trac 0.1 0 and before used for restricting access to the repository has not yet been converted to a permission policy component, but from the user point of view, this makes little if no differences.89 At the time of this writing, the old fine grained 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 point of view, this makes little if no difference. 64 90 65 91 That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn. 66 More information about this file format and about its usage in Subversion is available in the [http://svnbook.red-bean.com/svnbook/book.html#svn-ch-6-sect-4.4.2 Subversion Book (Per-Directory Access Control)].92 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. 67 93 68 94 Example: … … 92 118 }}} 93 119 94 if you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add120 If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add 95 121 96 122 {{{ … … 98 124 }}} 99 125 100 where ''modulename'' refers to the same repository indicated by the `repository_dir` entry in the `[trac]` section. 126 where ''modulename'' refers to the same repository indicated by the `repository_dir` entry in the `[trac]` section. As an example, if the `repository_dir` entry in the `[trac]` section is {{{/srv/active/svn/blahblah}}}, that would yield the following: 127 128 {{{ 129 [trac] 130 authz_file = /path/to/svnaccessfile 131 authz_module_name = blahblah 132 ... 133 repository_dir = /srv/active/svn/blahblah 134 }}} 135 136 where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[blahblah:/some/path]}}}. 101 137 102 138 '''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac. 139 140 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. 141 142 {{{ 143 [trac] 144 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 145 }}} 103 146 104 147 ==== Subversion Configuration ==== … … 117 160 For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess] 118 161 162 == Debugging permissions 163 In trac.ini set: 164 {{{ 165 [logging] 166 log_file = trac.log 167 log_level = DEBUG 168 log_type = file 169 }}} 170 171 And watch: 172 {{{ 173 tail -n 0 -f log/trac.log | egrep '\[perm\]|\[authz_policy\]' 174 }}} 175 176 to understand what checks are being performed. See the sourced documentation of the plugin for more info. 177 178 119 179 ---- 120 See also: TracPermissions 180 See also: TracPermissions, 181 [http://trac-hacks.org/wiki/FineGrainedPageAuthzEditorPlugin TracHacks:FineGrainedPageAuthzEditorPlugin] for a simple editor plugin.
