Changes between Version 2 and Version 3 of TracFineGrainedPermissions


Ignore:
Timestamp:
07/06/12 15:43:08 (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracFineGrainedPermissions

    v2 v3  
    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. 
    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 ===  
     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.) 
    3115 
    3216 - Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (required). 
    … …  
    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}}} 
    5637 
    … …  
    8566 
    8667 
    87 === !AuthzSourcePolicy  (mod_authz_svn-like permission policy) === #AuthzSourcePolicy 
     68=== mod_authz_svn-like permission policy === 
    8869 
    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. 
     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. 
    9071 
    9172That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn.  
    … …  
    138119'''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac.  
    139120 
    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 }}} 
    146  
    147121==== Subversion Configuration ==== 
    148122 
    … …  
    160134For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess] 
    161135 
    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 }}} 
     136== Getting TracFineGrainedPermissions to work == 
    170137 
    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  
     138Don't forget to restart Trac engine to apply new configuration if you are running tracd standalone server. 
    178139 
    179140----