Changes between Version 4 and Version 5 of TracFineGrainedPermissions
- Timestamp:
- Jan 12, 2016, 11:21:52 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFineGrainedPermissions
v4 v5 1 [[PageOutline(2-5, Contents, floated)]] 1 2 = Fine grained permissions = 2 [[PageOutline(2-5, Contents, floated)]] 3 [[TracGuideToc]] 4 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. 3 4 Before Trac 0.11, it was only possible to define fine-grained permissions checks on the repository browser sub-system. 5 6 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. 7 8 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. 9 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 Which policies are currently active is determined by a configuration setting in TracIni: 14 15 {{{ #!ini16 e.g. 17 {{{ 16 18 [trac] 17 19 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy … … 19 21 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. 20 22 21 Among the optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See22 [trac:source:branches/ 1.0-stable/tracopt/perm/authz_policy.py authz_policy.py] for details.23 Among the possible optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See 24 [trac:source:branches/0.12-stable/tracopt/perm/authz_policy.py authz_policy.py] for details. 23 25 24 26 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 27 26 See also [trac:source:branches/1.0-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. 28 See also [trac:source:branches/0.12-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. 29 27 30 28 31 === !AuthzPolicy === 29 32 ==== Configuration ==== 30 * Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj]. 33 * Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (still needed for 0.12). 34 * Copy authz_policy.py into your plugins directory (only for Trac 0.11). 31 35 * 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. 32 36 * Update your `trac.ini`: 33 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section :34 {{{ #!ini37 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section 38 {{{ 35 39 [trac] 36 40 ... 37 41 permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 38 42 }}} 39 1. add a new `[authz_policy]` section :40 {{{ #!ini43 1. add a new `[authz_policy]` section 44 {{{ 41 45 [authz_policy] 42 46 authz_file = /some/trac/env/conf/authzpolicy.conf 43 47 }}} 44 1. enable the plugin through [/admin/general/plugin WebAdmin] or by editing the `[components]` section :45 {{{ #!ini48 1. enable the plugin through [/admin/general/plugin WebAdmin] or by editing the `[components]` section 49 {{{ 46 50 [components] 51 ... 52 # Trac 0.12 47 53 tracopt.perm.authz_policy.* = enabled 48 }}} 54 # for Trac 0.11 use this 55 #authz_policy.* = enabled 56 }}} 57 49 58 50 59 ==== Usage Notes ==== 51 52 Note the order in which permission policies are specified: policies are implemented in the sequence provided and therefore may override earlier policy specifications.60 Note that the order in which permission policies are specified is quite critical, 61 as policies will be examined in the sequence provided. 53 62 54 63 A policy will return either `True`, `False` or `None` for a given permission check. `True` is returned if the policy explicitly grants the permission. `False` is returned if the policy explicitly denies the permission. `None` is returned if the policy is unable to either grant or deny the permission. 55 64 56 NOTE: Only if the return value is `None` will the ''next'' permission policy be consulted. If none of the policies explicitly grants the permission, the final result will be `False`, i.e. permission denied. 65 NOTE: Only if the return value is `None` will the ''next'' permission policy be consulted. 66 If none of the policies explicitly grants the permission, the final result will be `False` 67 (i.e. permission denied). 57 68 58 69 The `authzpolicy.conf` file is a `.ini` style configuration file: 59 {{{ #!ini70 {{{ 60 71 [wiki:[email protected]*] 61 72 john = WIKI_VIEW, !WIKI_MODIFY … … 63 74 * = 64 75 }}} 65 * Each section of the config is a glob pattern used to match against a Trac resource descriptor. These descriptors are in the form: 76 * Each section of the config is a glob pattern used to match against a Trac resource 77 descriptor. These descriptors are in the form: 66 78 {{{ 67 79 <realm>:<id>@<version>[/<realm>:<id>@<version> ...] 68 80 }}} 69 70 Resources are ordered left to right, from parent to child. If any component is inapplicable, `*` is substituted. If the version pattern is not specified explicitly, all versions (`@*`) is added implicitly. Example: Match the WikiStart page: 71 {{{#!ini 81 Resources are ordered left to right, from parent to child. If any 82 component is inapplicable, `*` is substituted. If the version pattern is 83 not specified explicitely, all versions (`@*`) is added implicitly 84 85 Example: Match the WikiStart page 86 {{{ 72 87 [wiki:*] 73 88 [wiki:WikiStart*] … … 76 91 }}} 77 92 78 Example: Match the attachment `wiki:[email protected]/attachment:[email protected]*` on WikiStart: 79 {{{#!ini 93 Example: Match the attachment `wiki:[email protected]/attachment/[email protected]*` 94 on WikiStart 95 {{{ 80 96 [wiki:*] 81 97 [wiki:WikiStart*] 82 98 [wiki:[email protected]*] 83 [wiki:[email protected]*/attachment:*] 84 [wiki:[email protected]/attachment:FOO.JPG] 85 }}} 86 87 * Sections are checked against the current Trac resource descriptor '''IN ORDER''' of appearance in the configuration file. '''ORDER IS CRITICAL'''. 88 89 * Once a section matches, the current username is matched against the keys (usernames) of the section, '''IN ORDER'''. 99 [wiki:[email protected]*/attachment/*] 100 [wiki:[email protected]/attachment/FOO.JPG] 101 }}} 102 103 * Sections are checked against the current Trac resource descriptor '''IN ORDER''' of 104 appearance in the configuration file. '''ORDER IS CRITICAL'''. 105 106 * Once a section matches, the current username is matched against the keys 107 (usernames) of the section, '''IN ORDER'''. 90 108 * If a key (username) is prefixed with a `@`, it is treated as a group. 91 * If a value (permission) is prefixed with a `!`, the permission is denied rather than granted. 92 93 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. || 109 * If a value (permission) is prefixed with a `!`, the permission is 110 denied rather than granted. 111 112 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 || 94 113 95 114 For example, if the `authz_file` contains: 96 {{{ #!ini115 {{{ 97 116 [wiki:[email protected]*] 98 117 * = WIKI_VIEW … … 110 129 111 130 Then: 112 * All versions of WikiStart will be viewable by everybody , including anonymous131 * All versions of WikiStart will be viewable by everybody (including anonymous) 113 132 * !PrivatePage will be viewable only by john 114 133 * other pages will be viewable only by john and jack 115 134 116 135 Groups: 117 {{{ #!ini136 {{{ 118 137 [groups] 119 138 admins = john, jack … … 136 155 137 156 Some repository examples (Browse Source specific): 138 {{{ #!ini157 {{{ 139 158 # A single repository: 140 159 [repository:[email protected]*] 141 160 john = BROWSER_VIEW, FILE_VIEW 142 161 # John has BROWSER_VIEW and FILE_VIEW for the entire test_repo 143 144 # The default repository (requires Trac 1.0.2 or later):145 [repository:@*]146 john = BROWSER_VIEW, FILE_VIEW147 # John has BROWSER_VIEW and FILE_VIEW for the entire default repository148 162 149 163 # All repositories: 150 164 [repository:*@*] 151 165 jack = BROWSER_VIEW, FILE_VIEW 152 # J ackhas BROWSER_VIEW and FILE_VIEW for all repositories153 }}} 154 155 Very granularrepository access:156 {{{ #!ini166 # John has BROWSER_VIEW and FILE_VIEW for all repositories 167 }}} 168 169 Very fine grain repository access: 170 {{{ 157 171 # John has BROWSER_VIEW and FILE_VIEW access to trunk/src/some/location/ only 158 172 [repository:[email protected]*/source:trunk/src/some/location/*@*] 159 173 john = BROWSER_VIEW, FILE_VIEW 160 174 175 161 176 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of all files at trunk/src/some/location only 162 177 [repository:[email protected]*/source:trunk/src/some/location/*@1] 163 178 john = BROWSER_VIEW, FILE_VIEW 164 179 180 165 181 # John has BROWSER_VIEW and FILE_VIEW access to all revisions of 'somefile' at trunk/src/some/location only 166 182 [repository:[email protected]*/source:trunk/src/some/location/[email protected]*] 167 183 john = BROWSER_VIEW, FILE_VIEW 168 184 185 169 186 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of 'somefile' at trunk/src/some/location only 170 187 [repository:[email protected]*/source:trunk/src/some/location/[email protected]] … … 174 191 Note: In order for Timeline to work/visible for John, we must add CHANGESET_VIEW to the above permission list. 175 192 193 176 194 ==== Missing Features ==== 177 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].195 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 forgotten authz_policy.2.patch part of [trac:ticket:6680 #6680]). 178 196 179 197 You cannot do the following: 180 {{{ #!ini198 {{{ 181 199 [groups] 182 200 team1 = a, b, c … … 186 204 }}} 187 205 188 Permission groups are not supported either , so you cannot do the following:189 {{{ #!ini206 Permission groups are not supported either. You cannot do the following: 207 {{{ 190 208 [groups] 191 209 permission_level_1 = WIKI_VIEW, TICKET_VIEW … … 199 217 === !AuthzSourcePolicy (mod_authz_svn-like permission policy) === #AuthzSourcePolicy 200 218 201 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 anydifference.202 203 That kind of granularpermission control needs a definition file, which is the one used by Subversion's mod_authz_svn.204 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.219 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. 220 221 That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn. 222 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. 205 223 206 224 Example: 207 {{{ #!ini225 {{{ 208 226 [/] 209 227 * = r … … 223 241 ==== Trac Configuration ==== 224 242 225 To activate granular permissions you __must__ specify the {{{authz_file}}} option in the {{{[trac]}}} section of trac.ini. If this option is set to null or not specified,the permissions will not be used.226 227 {{{ #!ini243 To activate fine grained permissions you __must__ specify the {{{authz_file}}} option in the {{{[trac]}}} section of trac.ini. If this option is set to null or not specified the permissions will not be used. 244 245 {{{ 228 246 [trac] 229 247 authz_file = /path/to/svnaccessfile 230 248 }}} 231 249 232 If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add :233 234 {{{ #!ini250 If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add 251 252 {{{ 235 253 authz_module_name = modulename 236 254 }}} 237 255 238 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/ somemodule}}}, that would yield the following:239 240 {{{ #!ini256 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: 257 258 {{{ 241 259 [trac] 242 260 authz_file = /path/to/svnaccessfile 243 authz_module_name = somemodule261 authz_module_name = blahblah 244 262 ... 245 repository_dir = /srv/active/svn/ somemodule246 }}} 247 248 where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[ somemodule:/some/path]}}}.263 repository_dir = /srv/active/svn/blahblah 264 }}} 265 266 where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[blahblah:/some/path]}}}. 249 267 250 268 '''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac. … … 252 270 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 271 254 {{{ #!ini272 {{{ 255 273 [trac] 256 274 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy … … 260 278 261 279 The same access file is typically applied to the corresponding Subversion repository using an Apache directive like this: 262 {{{ #!apache280 {{{ 263 281 <Location /repos> 264 282 DAV svn … … 270 288 }}} 271 289 272 For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess] .290 For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess] 273 291 274 292 == Debugging permissions 275 293 In trac.ini set: 276 {{{ #!ini294 {{{ 277 295 [logging] 278 296 log_file = trac.log … … 281 299 }}} 282 300 283 Display the trac.log to understand what checks are being performed:284 {{{ #!sh301 And watch: 302 {{{ 285 303 tail -n 0 -f log/trac.log | egrep '\[perm\]|\[authz_policy\]' 286 304 }}} 287 305 288 See the sourced documentation of the plugin for more info. 306 to understand what checks are being performed. See the sourced documentation of the plugin for more info. 307 289 308 290 309 ----