Changes between Version 1 and Version 2 of TracFineGrainedPermissions


Ignore:
Timestamp:
Dec 2, 2015, 12:23:52 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFineGrainedPermissions

    v1 v2  
     1[[PageOutline(2-5, Contents, floated)]]
    12= Fine grained permissions =
    23
     
    1617{{{
    1718[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.
     19permission_policies = ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     20}}}
     21This 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.
    2122
    2223Among the possible optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See
     
    3031=== !AuthzPolicy ===
    3132==== 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.
     33* Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (still needed for 0.12 and later).
     34* Copy [browser:/trunk/tracopt/perm/authz_policy.py /tracopt/perm/authz_policy.py] to your environment's plugins directory (only for Trac 0.11).
    3435* 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.
    3536* Update your `trac.ini`:
     
    3839[trac]
    3940...
    40 permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    41 }}}
    42   2. add a new `[authz_policy]` section
     41permission_policies = AuthzPolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     42}}}
     43  1. add a new `[authz_policy]` section
    4344{{{
    4445[authz_policy]
    4546authz_file = /some/trac/env/conf/authzpolicy.conf
    4647}}}
    47   3. enable the single file plugin
     48  1. enable the plugin through [/admin/general/plugin WebAdmin] or by editing the `[components]` section
    4849{{{
    4950[components]
     
    5455#authz_policy.* = enabled
    5556}}}
     57
     58
    5659==== Usage Notes ====
    5760Note that the order in which permission policies are specified is quite critical,
     
    8891}}}
    8992
    90   Example: Match the attachment `wiki:WikiStart@117/attachment/FOO.JPG@*`
     93  Example: Match the attachment `wiki:WikiStart@117/attachment:FOO.JPG@*`
    9194  on WikiStart
    9295{{{
     
    9497[wiki:WikiStart*]
    9598[wiki:WikiStart@*]
    96 [wiki:WikiStart@*/attachment/*]
    97 [wiki:WikiStart@117/attachment/FOO.JPG]
     99[wiki:WikiStart@*/attachment:*]
     100[wiki:WikiStart@117/attachment:FOO.JPG]
    98101}}}
    99102
     
    107110    denied rather than granted.
    108111
    109   The username will match any of 'anonymous',
    110   'authenticated', <username> or '*', using normal Trac permission rules.
     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 ||
    111113
    112114For example, if the `authz_file` contains:
     
    159161# John has BROWSER_VIEW and FILE_VIEW for the entire test_repo
    160162
     163# The default repository (requires Trac 1.0.2 or later):
     164[repository:@*]
     165john = BROWSER_VIEW, FILE_VIEW
     166# John has BROWSER_VIEW and FILE_VIEW for the entire default repository
     167
    161168# All repositories:
    162169[repository:*@*]
    163170jack = BROWSER_VIEW, FILE_VIEW
    164 # John has BROWSER_VIEW and FILE_VIEW for all repositories
     171# Jack has BROWSER_VIEW and FILE_VIEW for all repositories
    165172}}}
    166173
     
    189196Note: In order for Timeline to work/visible for John, we must add CHANGESET_VIEW to the above permission list.
    190197
     198
     199==== Missing Features ====
     200Although 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]).
     201
     202You cannot do the following:
     203{{{
     204[groups]
     205team1 = a, b, c
     206team2 = d, e, f
     207team3 = g, h, i
     208departmentA = team1, team2
     209}}}
     210
     211Permission groups are not supported either. You cannot do the following:
     212{{{
     213[groups]
     214permission_level_1 = WIKI_VIEW, TICKET_VIEW
     215permission_level_2  = permission_level_1, WIKI_MODIFY, TICKET_MODIFY
     216[*]
     217@team1 = permission_level_1
     218@team2 = permission_level_2
     219@team3 = permission_level_2, TICKET_CREATE
     220}}}
    191221
    192222=== !AuthzSourcePolicy  (mod_authz_svn-like permission policy) === #AuthzSourcePolicy
     
    247277{{{
    248278[trac]
    249 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     279permission_policies = AuthzSourcePolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    250280}}}
    251281
     
    264294
    265295For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]
     296
     297=== ReadonlyWikiPolicy
     298
     299Since 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:
     300{{{
     301[trac]
     302permission_policies = ReadonlyWikiPolicy,
     303 DefaultPermissionPolicy,
     304 LegacyAttachmentPolicy
     305}}}
     306
     307When 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.
     308
     309**!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.
     310
     311The `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.
     312
     313When 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.
     314{{{
     315[trac]
     316permission_policies = AuthzPolicy,
     317 ReadonlyWikiPolicy,
     318 DefaultPermissionPolicy,
     319 LegacyAttachmentPolicy
     320}}}
     321
     322The placement of [#AuthzSourcePolicy] relative to `ReadonlyWikiPolicy` does not matter since they don't perform checks on the same realms.
     323
     324For 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.
    266325
    267326== Debugging permissions
     
    281340to understand what checks are being performed. See the sourced documentation of the plugin for more info.
    282341
    283 
    284342----
    285343See also: TracPermissions,