COIN-OR::LEMON - Graph Library

Changes between Version 1 and Version 2 of TracFineGrainedPermissions


Ignore:
Timestamp:
02/13/13 21:18:40 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFineGrainedPermissions

    v1 v2  
    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.
     6
     7Note 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
    69
    710== Permission Policies ==
    811
    9 === !AuthzPolicy ===
     12A great diversity of permission policies can be implemented, and Trac comes with a few examples.
    1013
    11 An example policy based on an Authz-style system has been added. See
    12 [source:trunk/sample-plugins/permissions/authz_policy.py] for details. (See also [source:trunk/sample-plugins/permissions] for more samples.)
     14Which policies are currently active is determined by a configuration setting in TracIni:
     15e.g.
     16{{{
     17[trac]
     18permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     19}}}
     20This 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
     22Among 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
     25Another 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
     27See also [trac:source:branches/0.12-stable/sample-plugins/permissions sample-plugins/permissions] for more examples.
     28
     29
     30=== !AuthzPolicy ===
    1331
    1432 - Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (required).
    1533 - Copy authz_policy.py into your plugins directory.
    16  - 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.
     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.
    1735 - Update your `trac.ini`:
     36   1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section
    1837{{{
    1938[trac]
    2039...
    2140permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    22 
     41}}}
     42   2. add a new `[authz_policy]` section
     43{{{
    2344[authz_policy]
    2445authz_file = /some/trac/env/conf/authzpolicy.conf
    25 
     46}}}
     47   3. enable the single file plugin
     48{{{
    2649[components]
    2750...
    28 authz_policy = enabled
     51# Trac 0.12
     52tracopt.perm.authz_policy.* = enabled
     53# for Trac 0.11 use this
     54#authz_policy.* = enabled
    2955}}}
    3056
     
    5985
    6086
    61 === mod_authz_svn-like permission policy ===
     87=== !AuthzSourcePolicy  (mod_authz_svn-like permission policy) === #AuthzSourcePolicy
    6288
    63 At 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 differences.
     89At 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.
    6490
    6591That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn.
    66 More information about this file format and about its usage in Subversion is available in the [http://svnbook.red-bean.com/svnbook/book.html#svn-ch-6-sect-4.4.2 Subversion Book (Per-Directory Access Control)].
     92More 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.
    6793
    6894Example:
     
    92118}}}
    93119
    94 if you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add
     120If you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add
    95121
    96122{{{
     
    98124}}}
    99125
    100 where ''modulename'' refers to the same repository indicated by the `repository_dir` entry in the `[trac]` section.
     126where ''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:
     127
     128{{{
     129[trac]
     130authz_file = /path/to/svnaccessfile
     131authz_module_name = blahblah
     132...
     133repository_dir = /srv/active/svn/blahblah
     134}}}
     135
     136where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[blahblah:/some/path]}}}.
    101137
    102138'''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac.
     139
     140As 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]
     144permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     145}}}
    103146
    104147==== Subversion Configuration ====
     
    117160For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]
    118161
     162== Debugging permissions
     163In trac.ini set:
     164{{{
     165[logging]
     166log_file = trac.log
     167log_level = DEBUG
     168log_type = file
     169}}}
     170
     171And watch:
     172{{{
     173tail -n 0 -f log/trac.log | egrep '\[perm\]|\[authz_policy\]'
     174}}}
     175
     176to understand what checks are being performed. See the sourced documentation of the plugin for more info.
     177
     178
    119179----
    120 See also: TracPermissions
     180See also: TracPermissions,
     181[http://trac-hacks.org/wiki/FineGrainedPageAuthzEditorPlugin TracHacks:FineGrainedPageAuthzEditorPlugin] for a simple editor plugin.