Changes between Version 2 and Version 3 of TracFineGrainedPermissions
- Timestamp:
- Jan 5, 2017, 12:12:45 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFineGrainedPermissions
v2 v3 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 {{{ 18 [trac] 19 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy20 }}} 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.22 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.14 15 {{{#!ini 16 [trac] 17 permission_policies = ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 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. 20 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).35 30 * 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 31 * Update your `trac.ini`: 37 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section 38 {{{ 32 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section: 33 {{{#!ini 39 34 [trac] 40 35 ... 41 permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy42 }}} 43 1. add a new `[authz_policy]` section 44 {{{ 36 permission_policies = AuthzPolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 37 }}} 38 1. add a new `[authz_policy]` section: 39 {{{#!ini 45 40 [authz_policy] 46 41 authz_file = /some/trac/env/conf/authzpolicy.conf 47 42 }}} 48 1. enable the plugin through [/admin/general/plugin WebAdmin] or by editing the `[components]` section 49 {{{ 43 1. enable the plugin through [/admin/general/plugin WebAdmin] or by editing the `[components]` section: 44 {{{#!ini 50 45 [components] 51 ...52 # Trac 0.1253 46 tracopt.perm.authz_policy.* = enabled 54 # for Trac 0.11 use this 55 #authz_policy.* = enabled 56 }}} 57 47 }}} 58 48 59 49 ==== 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.50 51 Note the order in which permission policies are specified: policies are implemented in the sequence provided and therefore may override earlier policy specifications. 62 52 63 53 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 54 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). 55 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 56 69 57 The `authzpolicy.conf` file is a `.ini` style configuration file: 70 {{{ 58 {{{#!ini 71 59 [wiki:PrivatePage@*] 72 60 john = WIKI_VIEW, !WIKI_MODIFY … … 74 62 * = 75 63 }}} 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: 64 * Each section of the config is a glob pattern used to match against a Trac resource descriptor. These descriptors are in the form: 78 65 {{{ 79 66 <realm>:<id>@<version>[/<realm>:<id>@<version> ...] 80 67 }}} 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 {{{ 68 69 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: 70 {{{#!ini 87 71 [wiki:*] 88 72 [wiki:WikiStart*] … … 91 75 }}} 92 76 93 Example: Match the attachment `wiki:WikiStart@117/attachment/FOO.JPG@*` 94 on WikiStart 95 {{{ 77 Example: Match the attachment `wiki:WikiStart@117/attachment:FOO.JPG@*` on WikiStart: 78 {{{#!ini 96 79 [wiki:*] 97 80 [wiki:WikiStart*] 98 81 [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'''. 82 [wiki:WikiStart@*/attachment:*] 83 [wiki:WikiStart@117/attachment:FOO.JPG] 84 }}} 85 86 * Sections are checked against the current Trac resource descriptor '''IN ORDER''' of appearance in the configuration file. '''ORDER IS CRITICAL'''. 87 88 * Once a section matches, the current username is matched against the keys (usernames) of the section, '''IN ORDER'''. 108 89 * 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 || 90 * If a value (permission) is prefixed with a `!`, the permission is denied rather than granted. 91 92 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 93 114 94 For example, if the `authz_file` contains: 115 {{{ 95 {{{#!ini 116 96 [wiki:WikiStart@*] 117 97 * = WIKI_VIEW … … 129 109 130 110 Then: 131 * All versions of WikiStart will be viewable by everybody (including anonymous)111 * All versions of WikiStart will be viewable by everybody, including anonymous 132 112 * !PrivatePage will be viewable only by john 133 113 * other pages will be viewable only by john and jack 134 114 135 115 Groups: 136 {{{ 116 {{{#!ini 137 117 [groups] 138 118 admins = john, jack … … 155 135 156 136 Some repository examples (Browse Source specific): 157 {{{ 137 {{{#!ini 158 138 # A single repository: 159 139 [repository:test_repo@*] 160 140 john = BROWSER_VIEW, FILE_VIEW 161 141 # John has BROWSER_VIEW and FILE_VIEW for the entire test_repo 142 143 # The default repository (requires Trac 1.0.2 or later): 144 [repository:@*] 145 john = BROWSER_VIEW, FILE_VIEW 146 # John has BROWSER_VIEW and FILE_VIEW for the entire default repository 162 147 163 148 # All repositories: 164 149 [repository:*@*] 165 150 jack = BROWSER_VIEW, FILE_VIEW 166 # J ohnhas BROWSER_VIEW and FILE_VIEW for all repositories167 }}} 168 169 Very fine grainrepository access:170 {{{ 151 # Jack has BROWSER_VIEW and FILE_VIEW for all repositories 152 }}} 153 154 Very granular repository access: 155 {{{#!ini 171 156 # John has BROWSER_VIEW and FILE_VIEW access to trunk/src/some/location/ only 172 157 [repository:test_repo@*/source:trunk/src/some/location/*@*] 173 158 john = BROWSER_VIEW, FILE_VIEW 174 159 175 176 160 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of all files at trunk/src/some/location only 177 161 [repository:test_repo@*/source:trunk/src/some/location/*@1] 178 162 john = BROWSER_VIEW, FILE_VIEW 179 163 180 181 164 # John has BROWSER_VIEW and FILE_VIEW access to all revisions of 'somefile' at trunk/src/some/location only 182 165 [repository:test_repo@*/source:trunk/src/some/location/somefile@*] 183 166 john = BROWSER_VIEW, FILE_VIEW 184 167 185 186 168 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of 'somefile' at trunk/src/some/location only 187 169 [repository:test_repo@*/source:trunk/src/some/location/somefile@1] … … 191 173 Note: In order for Timeline to work/visible for John, we must add CHANGESET_VIEW to the above permission list. 192 174 193 194 175 ==== 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]).176 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 177 197 178 You cannot do the following: 198 {{{ 179 {{{#!ini 199 180 [groups] 200 181 team1 = a, b, c … … 204 185 }}} 205 186 206 Permission groups are not supported either . You cannot do the following:207 {{{ 187 Permission groups are not supported either, so you cannot do the following: 188 {{{#!ini 208 189 [groups] 209 190 permission_level_1 = WIKI_VIEW, TICKET_VIEW … … 217 198 === !AuthzSourcePolicy (mod_authz_svn-like permission policy) === #AuthzSourcePolicy 218 199 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 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. 223 204 224 205 Example: 225 {{{ 206 {{{#!ini 226 207 [/] 227 208 * = r … … 241 222 ==== Trac Configuration ==== 242 223 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 {{{ 246 [ trac]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. 225 226 {{{#!ini 227 [svn] 247 228 authz_file = /path/to/svnaccessfile 248 229 }}} 249 230 250 If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add 251 252 {{{ 231 If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add: 232 233 {{{#!ini 253 234 authz_module_name = modulename 254 235 }}} 255 236 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 {{{ 259 [ trac]237 where ''modulename'' refers to the same repository indicated by the `<name>.dir` entry in the `[repositories]` section. As an example, if the `somemodule.dir` entry in the `[repositories]` section is `/srv/active/svn/somemodule`, that would yield the following: 238 239 {{{ #!ini 240 [svn] 260 241 authz_file = /path/to/svnaccessfile 261 authz_module_name = blahblah242 authz_module_name = somemodule 262 243 ... 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]}}}. 244 [repositories] 245 somemodule.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 {{{ 273 [trac] 274 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy254 {{{#!ini 255 [trac] 256 permission_policies = AuthzSourcePolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy 275 257 }}} 276 258 … … 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]. 273 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, 280 DefaultPermissionPolicy, 281 LegacyAttachmentPolicy 282 }}} 283 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 {{{ 292 [trac] 293 permission_policies = AuthzPolicy, 294 ReadonlyWikiPolicy, 295 DefaultPermissionPolicy, 296 LegacyAttachmentPolicy 297 }}} 298 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. 291 302 292 303 == Debugging permissions 293 304 In trac.ini set: 294 {{{ 305 {{{#!ini 295 306 [logging] 296 307 log_file = trac.log … … 299 310 }}} 300 311 301 And watch:302 {{{ 312 Display the trac.log to understand what checks are being performed: 313 {{{#!sh 303 314 tail -n 0 -f log/trac.log | egrep '\[perm\]|\[authz_policy\]' 304 315 }}} 305 316 306 to understand what checks are being performed. See the sourced documentation of the plugin for more info. 307 317 See the sourced documentation of the plugin for more info. 308 318 309 319 ----