Changes between Initial Version and Version 1 of TracFineGrainedPermissions


Ignore:
Timestamp:
01/06/12 06:59:04 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFineGrainedPermissions

    v1 v1  
     1= Fine grained permissions =
     2
     3Before Trac 0.11, it was only possible to define fine-grained permissions checks on the repository browser sub-system.
     4
     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
     7== Permission Policies ==
     8
     9=== !AuthzPolicy ===
     10
     11An example policy based on an Authz-style system has been added. See
     12[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.)
     13
     14 - Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (required).
     15 - 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.
     17 - Update your `trac.ini`:
     18   1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section
     19{{{
     20[trac]
     21...
     22permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     23}}}
     24   2. add a new `[authz_policy]` section
     25{{{
     26[authz_policy]
     27authz_file = /some/trac/env/conf/authzpolicy.conf
     28}}}
     29   3. enable the single file plugin
     30{{{
     31[components]
     32...
     33authz_policy.* = enabled
     34}}}
     35
     36Note that the order in which permission policies are specified is quite critical,
     37as policies will be examined in the sequence provided.
     38
     39A policy will return either `True`, `False` or `None` for a given permission check.
     40Only if the return value is `None` will the ''next'' permission policy be consulted.
     41If no policy explicitly grants the permission, the final result will be `False`
     42(i.e. no permission).
     43
     44For example, if the `authz_file` contains:
     45{{{
     46[wiki:WikiStart@*]
     47* = WIKI_VIEW
     48
     49[wiki:PrivatePage@*]
     50john = WIKI_VIEW
     51* =
     52}}}
     53and the default permissions are set like this:
     54{{{
     55john           WIKI_VIEW
     56jack           WIKI_VIEW
     57# anonymous has no WIKI_VIEW
     58}}}
     59
     60Then:
     61 - All versions of WikiStart will be viewable by everybody (including anonymous)
     62 - !PrivatePage will be viewable only by john
     63 - other pages will be viewable only by john and jack
     64
     65
     66=== mod_authz_svn-like permission policy ===
     67
     68At 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.
     69
     70That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn.
     71More 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.
     72
     73Example:
     74{{{
     75[/]
     76* = r
     77
     78[/branches/calc/bug-142]
     79harry = rw
     80sally = r
     81
     82[/branches/calc/bug-142/secret]
     83harry =
     84}}}
     85
     86 * '''/''' = ''Everyone has read access by default''
     87 * '''/branches/calc/bug-142''' = ''harry has read/write access, sally read only''
     88 * '''/branches/calc/bug-142/secret''' = ''harry has no access, sally has read access (inherited as a sub folder permission)''
     89
     90==== Trac Configuration ====
     91
     92To 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 specified the permissions will not be used.
     93
     94{{{
     95[trac]
     96authz_file = /path/to/svnaccessfile
     97}}}
     98
     99if you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add
     100
     101{{{
     102authz_module_name = modulename
     103}}}
     104
     105where ''modulename'' refers to the same repository indicated by the `repository_dir` entry in the `[trac]` section.
     106
     107'''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac.
     108
     109==== Subversion Configuration ====
     110
     111The same access file is typically applied to the corresponding Subversion repository using an Apache directive like this:
     112{{{
     113<Location /repos>
     114  DAV svn
     115  SVNParentPath /usr/local/svn
     116
     117  # our access control policy
     118  AuthzSVNAccessFile /path/to/svnaccessfile
     119</Location>
     120}}}
     121
     122For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]
     123
     124== Getting TracFineGrainedPermissions to work ==
     125
     126Don't forget to restart Trac engine to apply new configuration if you are running tracd standalone server.
     127
     128----
     129See also: TracPermissions
     130http://trac-hacks.org/wiki/FineGrainedPageAuthzEditorPlugin for a simple editor plugin.