Changes between Version 1 and Version 2 of TracFineGrainedPermissions
- Timestamp:
- Apr 16, 2016, 7:10:42 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFineGrainedPermissions
v1 v2 1 = Fine grained permissions = 1 2 [[PageOutline(2-5, Contents, floated)]] 2 = Fine grained permissions = 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 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. 10 8 11 9 == Permission Policies == 12 10 13 A great diversity of permission policies can be implemented ,and Trac comes with a few examples.11 A great diversity of permission policies can be implemented and Trac comes with a few examples. 14 12 15 13 Which policies are currently active is determined by a configuration setting in TracIni: 16 e.g. 17 {{{ 14 15 {{{#!ini 18 16 [trac] 19 17 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy … … 21 19 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. 22 20 23 Among the possibleoptional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See24 [trac:source:branches/ 0.12-stable/tracopt/perm/authz_policy.py authz_policy.py] for details.21 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. 25 23 26 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. 27 25 28 See also [trac:source:branches/0.12-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. 29 26 See also [trac:source:branches/1.0-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. 30 27 31 28 === !AuthzPolicy === 32 29 ==== Configuration ==== 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). 30 * Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj]. 35 31 * 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. 36 32 * Update your `trac.ini`: 37 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section 38 {{{ 33 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section: 34 {{{#!ini 39 35 [trac] 40 36 ... 41 37 permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 42 38 }}} 43 1. add a new `[authz_policy]` section 44 {{{ 39 1. add a new `[authz_policy]` section: 40 {{{#!ini 45 41 [authz_policy] 46 42 authz_file = /some/trac/env/conf/authzpolicy.conf 47 43 }}} 48 1. enable the plugin through [/admin/general/plugin WebAdmin] or by editing the `[components]` section 49 {{{ 44 1. enable the plugin through [/admin/general/plugin WebAdmin] or by editing the `[components]` section: 45 {{{#!ini 50 46 [components] 51 ...52 # Trac 0.1253 47 tracopt.perm.authz_policy.* = enabled 54 # for Trac 0.11 use this 55 #authz_policy.* = enabled 56 }}} 57 48 }}} 58 49 59 50 ==== Usage Notes ==== 60 Note that the order in which permission policies are specified is quite critical, 61 as policies will be examined in the sequence provided.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. 62 53 63 54 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. 64 55 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). 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. 68 57 69 58 The `authzpolicy.conf` file is a `.ini` style configuration file: 70 {{{ 59 {{{#!ini 71 60 [wiki:PrivatePage@*] 72 61 john = WIKI_VIEW, !WIKI_MODIFY … … 74 63 * = 75 64 }}} 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: 65 * Each section of the config is a glob pattern used to match against a Trac resource descriptor. These descriptors are in the form: 78 66 {{{ 79 67 <realm>:<id>@<version>[/<realm>:<id>@<version> ...] 80 68 }}} 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 {{{ 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 87 72 [wiki:*] 88 73 [wiki:WikiStart*] … … 91 76 }}} 92 77 93 Example: Match the attachment `wiki:WikiStart@117/attachment/FOO.JPG@*` 94 on WikiStart 95 {{{ 78 Example: Match the attachment `wiki:WikiStart@117/attachment:FOO.JPG@*` on WikiStart: 79 {{{#!ini 96 80 [wiki:*] 97 81 [wiki:WikiStart*] 98 82 [wiki:WikiStart@*] 99 [wiki:WikiStart@*/attachment/*] 100 [wiki:WikiStart@117/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'''. 83 [wiki:WikiStart@*/attachment:*] 84 [wiki:WikiStart@117/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'''. 108 90 * If a key (username) is prefixed with a `@`, it is treated as a group. 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 || 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. || 113 94 114 95 For example, if the `authz_file` contains: 115 {{{ 96 {{{#!ini 116 97 [wiki:WikiStart@*] 117 98 * = WIKI_VIEW … … 129 110 130 111 Then: 131 * All versions of WikiStart will be viewable by everybody (including anonymous)112 * All versions of WikiStart will be viewable by everybody, including anonymous 132 113 * !PrivatePage will be viewable only by john 133 114 * other pages will be viewable only by john and jack 134 115 135 116 Groups: 136 {{{ 117 {{{#!ini 137 118 [groups] 138 119 admins = john, jack … … 155 136 156 137 Some repository examples (Browse Source specific): 157 {{{ 138 {{{#!ini 158 139 # A single repository: 159 140 [repository:test_repo@*] 160 141 john = BROWSER_VIEW, FILE_VIEW 161 142 # 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_VIEW 147 # John has BROWSER_VIEW and FILE_VIEW for the entire default repository 162 148 163 149 # All repositories: 164 150 [repository:*@*] 165 151 jack = BROWSER_VIEW, FILE_VIEW 166 # J ohnhas BROWSER_VIEW and FILE_VIEW for all repositories167 }}} 168 169 Very fine grainrepository access:170 {{{ 152 # Jack has BROWSER_VIEW and FILE_VIEW for all repositories 153 }}} 154 155 Very granular repository access: 156 {{{#!ini 171 157 # John has BROWSER_VIEW and FILE_VIEW access to trunk/src/some/location/ only 172 158 [repository:test_repo@*/source:trunk/src/some/location/*@*] 173 159 john = BROWSER_VIEW, FILE_VIEW 174 160 175 176 161 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of all files at trunk/src/some/location only 177 162 [repository:test_repo@*/source:trunk/src/some/location/*@1] 178 163 john = BROWSER_VIEW, FILE_VIEW 179 164 180 181 165 # John has BROWSER_VIEW and FILE_VIEW access to all revisions of 'somefile' at trunk/src/some/location only 182 166 [repository:test_repo@*/source:trunk/src/some/location/somefile@*] 183 167 john = BROWSER_VIEW, FILE_VIEW 184 168 185 186 169 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of 'somefile' at trunk/src/some/location only 187 170 [repository:test_repo@*/source:trunk/src/some/location/somefile@1] … … 191 174 Note: In order for Timeline to work/visible for John, we must add CHANGESET_VIEW to the above permission list. 192 175 193 194 176 ==== Missing Features ==== 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]).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]. 196 178 197 179 You cannot do the following: 198 {{{ 180 {{{#!ini 199 181 [groups] 200 182 team1 = a, b, c … … 204 186 }}} 205 187 206 Permission groups are not supported either . You cannot do the following:207 {{{ 188 Permission groups are not supported either, so you cannot do the following: 189 {{{#!ini 208 190 [groups] 209 191 permission_level_1 = WIKI_VIEW, TICKET_VIEW … … 217 199 === !AuthzSourcePolicy (mod_authz_svn-like permission policy) === #AuthzSourcePolicy 218 200 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 nodifference.220 221 That kind of fine-grainedpermission 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 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 any difference. 202 203 That kind of granular permission 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. 223 205 224 206 Example: 225 {{{ 207 {{{#!ini 226 208 [/] 227 209 * = r … … 241 223 ==== Trac Configuration ==== 242 224 243 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 specifiedthe permissions will not be used.244 245 {{{ 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 {{{#!ini 246 228 [trac] 247 229 authz_file = /path/to/svnaccessfile 248 230 }}} 249 231 250 If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add 251 252 {{{ 232 If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add: 233 234 {{{#!ini 253 235 authz_module_name = modulename 254 236 }}} 255 237 256 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 {{{ 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 {{{ #!ini 259 241 [trac] 260 242 authz_file = /path/to/svnaccessfile 261 authz_module_name = blahblah243 authz_module_name = somemodule 262 244 ... 263 repository_dir = /srv/active/svn/ blahblah264 }}} 265 266 where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[ blahblah:/some/path]}}}.245 repository_dir = /srv/active/svn/somemodule 246 }}} 247 248 where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[somemodule:/some/path]}}}. 267 249 268 250 '''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac. … … 270 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. 271 253 272 {{{ 254 {{{#!ini 273 255 [trac] 274 256 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy … … 278 260 279 261 The same access file is typically applied to the corresponding Subversion repository using an Apache directive like this: 280 {{{ 262 {{{#!apache 281 263 <Location /repos> 282 264 DAV svn … … 288 270 }}} 289 271 290 For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess] 272 For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]. 291 273 292 274 == Debugging permissions 293 275 In trac.ini set: 294 {{{ 276 {{{#!ini 295 277 [logging] 296 278 log_file = trac.log … … 299 281 }}} 300 282 301 And watch:302 {{{ 283 Display the trac.log to understand what checks are being performed: 284 {{{#!sh 303 285 tail -n 0 -f log/trac.log | egrep '\[perm\]|\[authz_policy\]' 304 286 }}} 305 287 306 to understand what checks are being performed. See the sourced documentation of the plugin for more info. 307 288 See the sourced documentation of the plugin for more info. 308 289 309 290 ----