Changes between Version 7 and Version 8 of TracFineGrainedPermissions


Ignore:
Timestamp:
Dec 14, 2014, 5:16:20 PM (10 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracFineGrainedPermissions

    v7 v8  
    33Before Trac 0.11, it was only possible to define fine-grained permissions checks on the repository browser sub-system.
    44
    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.
     5Since 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.
    66
    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 
     7Note that for Trac 0.12, `authz_policy` has been integrated in trunk branch as `tracopt.perm.authz_policy.*`
    98
    109== Permission Policies ==
    1110
    12 A great diversity of permission policies can be implemented, and Trac comes with a few examples.
     11=== !AuthzPolicy ===
    1312
    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.
     13An example policy based on an Authz-style system has been added. See
     14[trac:source:branches/0.11-stable/sample-plugins/permissions/authz_policy.py authz_policy.py] for details (current version requires >= Python 2.4). (See also [trac:source:branches/0.11-stable/sample-plugins/permissions sample-plugins/permissions] for more samples.)
    2115
    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 ===
    31 ==== Configuration ====
    32 * Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (still needed for 0.12).
    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.
    35 * Update your `trac.ini`:
    36   1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section
     16 - Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (required).
     17 - Copy authz_policy.py into your plugins directory.
     18 - 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.
     19 - Update your `trac.ini`:
     20   1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section
    3721{{{
    3822[trac]
    … …  
    4024permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    4125}}}
    42   2. add a new `[authz_policy]` section
     26   2. add a new `[authz_policy]` section
    4327{{{
    4428[authz_policy]
    4529authz_file = /some/trac/env/conf/authzpolicy.conf
    4630}}}
    47   3. enable the single file plugin
     31   3. enable the single file plugin
    4832{{{
    4933[components]
    5034...
    51 # Trac 0.12
    52 tracopt.perm.authz_policy.* = enabled
    53 # for Trac 0.11 use this
    54 #authz_policy.* = enabled
     35authz_policy.* = enabled
    5536}}}
    56 ==== Usage Notes ====
     37
    5738Note that the order in which permission policies are specified is quite critical,
    5839as policies will be examined in the sequence provided.
    5940
    60 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.
    61 
    62 NOTE: Only if the return value is `None` will the ''next'' permission policy be consulted.
    63 If none of the policies explicitly grants the permission, the final result will be `False`
    64 (i.e. permission denied).
    65 
    66 The `authzpolicy.conf` file is a `.ini` style configuration file:
    67 {{{
    68 [wiki:PrivatePage@*]
    69 john = WIKI_VIEW, !WIKI_MODIFY
    70 jack = WIKI_VIEW
    71 * =
    72 }}}
    73 * Each section of the config is a glob pattern used to match against a Trac resource
    74   descriptor. These descriptors are in the form:
    75 {{{
    76 <realm>:<id>@<version>[/<realm>:<id>@<version> ...]
    77 }}}
    78   Resources are ordered left to right, from parent to child. If any
    79   component is inapplicable, `*` is substituted. If the version pattern is
    80   not specified explicitely, all versions (`@*`) is added implicitly
    81 
    82   Example: Match the WikiStart page
    83 {{{
    84 [wiki:*]
    85 [wiki:WikiStart*]
    86 [wiki:WikiStart@*]
    87 [wiki:WikiStart]
    88 }}}
    89 
    90   Example: Match the attachment `wiki:WikiStart@117/attachment/FOO.JPG@*`
    91   on WikiStart
    92 {{{
    93 [wiki:*]
    94 [wiki:WikiStart*]
    95 [wiki:WikiStart@*]
    96 [wiki:WikiStart@*/attachment/*]
    97 [wiki:WikiStart@117/attachment/FOO.JPG]
    98 }}}
    99 
    100 * Sections are checked against the current Trac resource descriptor '''IN ORDER''' of
    101   appearance in the configuration file. '''ORDER IS CRITICAL'''.
    102 
    103 * Once a section matches, the current username is matched against the keys
    104   (usernames) of the section, '''IN ORDER'''.
    105   * If a key (username) is prefixed with a `@`, it is treated as a group.
    106   * If a value (permission) is prefixed with a `!`, the permission is
    107     denied rather than granted.
    108 
    109   The username will match any of 'anonymous',
    110   'authenticated', <username> or '*', using normal Trac permission rules.
     41A policy will return either `True`, `False` or `None` for a given permission check.
     42Only if the return value is `None` will the ''next'' permission policy be consulted.
     43If no policy explicitly grants the permission, the final result will be `False`
     44(i.e. no permission).
    11145
    11246For example, if the `authz_file` contains:
    … …  
    11751[wiki:PrivatePage@*]
    11852john = WIKI_VIEW
    119 * = !WIKI_VIEW
     53* =
    12054}}}
    12155and the default permissions are set like this:
    … …  
    12761
    12862Then:
    129   * All versions of WikiStart will be viewable by everybody (including anonymous)
    130   * !PrivatePage will be viewable only by john
    131   * other pages will be viewable only by john and jack
    132 
    133 Groups:
    134 {{{
    135 [groups]
    136 admins = john, jack
    137 devs = alice, bob
    138 
    139 [wiki:Dev@*]
    140 @admins = TRAC_ADMIN
    141 @devs = WIKI_VIEW
    142 * =
    143 
    144 [*]
    145 @admins = TRAC_ADMIN
    146 * =
    147 }}}
    148 
    149 Then:
    150 - everything is blocked (whitelist approach), but
    151 - admins get all TRAC_ADMIN everywhere and
    152 - devs can view wiki pages.
    153 
    154 Some repository examples (Browse Source specific):
    155 {{{
    156 # A single repository:
    157 [repository:test_repo@*]
    158 john = BROWSER_VIEW, FILE_VIEW
    159 # John has BROWSER_VIEW and FILE_VIEW for the entire test_repo
    160 
    161 # All repositories:
    162 [repository:*@*]
    163 jack = BROWSER_VIEW, FILE_VIEW
    164 # John has BROWSER_VIEW and FILE_VIEW for all repositories
    165 }}}
    166 
    167 Very fine grain repository access:
    168 {{{
    169 # John has BROWSER_VIEW and FILE_VIEW access to trunk/src/some/location/ only
    170 [repository:test_repo@*/source:trunk/src/some/location/*@*]
    171 john = BROWSER_VIEW, FILE_VIEW
     63 - All versions of WikiStart will be viewable by everybody (including anonymous)
     64 - !PrivatePage will be viewable only by john
     65 - other pages will be viewable only by john and jack
    17266
    17367
    174 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of all files at trunk/src/some/location only
    175 [repository:test_repo@*/source:trunk/src/some/location/*@1]
    176 john = BROWSER_VIEW, FILE_VIEW
     68=== mod_authz_svn-like permission policy ===
    17769
    178 
    179 # John has BROWSER_VIEW and FILE_VIEW access to all revisions of 'somefile' at trunk/src/some/location only
    180 [repository:test_repo@*/source:trunk/src/some/location/somefile@*]
    181 john = BROWSER_VIEW, FILE_VIEW
    182 
    183 
    184 # John has BROWSER_VIEW and FILE_VIEW access to only revision 1 of 'somefile' at trunk/src/some/location only
    185 [repository:test_repo@*/source:trunk/src/some/location/somefile@1]
    186 john = BROWSER_VIEW, FILE_VIEW
    187 }}}
    188 
    189 Note: In order for Timeline to work/visible for John, we must add CHANGESET_VIEW to the above permission list.
    190 
    191 
    192 === !AuthzSourcePolicy  (mod_authz_svn-like permission policy) === #AuthzSourcePolicy
    193 
    194 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.
     70At the time of this writing, the old fine grained permissions system from Trac 0.10 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 difference.
    19571
    19672That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn.
    … …  
    243119'''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac.
    244120
    245 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.
    246 
    247 {{{
    248 [trac]
    249 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    250 }}}
    251 
    252121==== Subversion Configuration ====
    253122
    … …  
    265134For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]
    266135
    267 == Debugging permissions
    268 In trac.ini set:
    269 {{{
    270 [logging]
    271 log_file = trac.log
    272 log_level = DEBUG
    273 log_type = file
    274 }}}
     136== Getting TracFineGrainedPermissions to work ==
    275137
    276 And watch:
    277 {{{
    278 tail -n 0 -f log/trac.log | egrep '\[perm\]|\[authz_policy\]'
    279 }}}
    280 
    281 to understand what checks are being performed. See the sourced documentation of the plugin for more info.
    282 
     138Don't forget to restart Trac engine to apply new configuration if you are running tracd standalone server.
    283139
    284140----