Changes between Version 7 and Version 8 of TracFineGrainedPermissions


Ignore:
Timestamp:
27/10/2014 13:13:05 (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFineGrainedPermissions

    v7 v8  
    1717{{{
    1818[trac]
    19 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    20 }}}
    21 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.
    2222
    2323Among the possible optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See
     
    3131=== !AuthzPolicy ===
    3232==== Configuration ====
    33 * Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (still needed for 0.12).
    34 * Copy authz_policy.py into your plugins directory (only for Trac 0.11).
     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).
    3535* 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.
    3636* Update your `trac.ini`:
     
    3939[trac]
    4040...
    41 permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     41permission_policies = AuthzPolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    4242}}}
    4343  1. add a new `[authz_policy]` section
     
    9191}}}
    9292
    93   Example: Match the attachment `wiki:WikiStart@117/attachment/FOO.JPG@*`
     93  Example: Match the attachment `wiki:WikiStart@117/attachment:FOO.JPG@*`
    9494  on WikiStart
    9595{{{
     
    9797[wiki:WikiStart*]
    9898[wiki:WikiStart@*]
    99 [wiki:WikiStart@*/attachment/*]
    100 [wiki:WikiStart@117/attachment/FOO.JPG]
     99[wiki:WikiStart@*/attachment:*]
     100[wiki:WikiStart@117/attachment:FOO.JPG]
    101101}}}
    102102
     
    161161# John has BROWSER_VIEW and FILE_VIEW for the entire test_repo
    162162
     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
    163168# All repositories:
    164169[repository:*@*]
    165170jack = BROWSER_VIEW, FILE_VIEW
    166 # John has BROWSER_VIEW and FILE_VIEW for all repositories
     171# Jack has BROWSER_VIEW and FILE_VIEW for all repositories
    167172}}}
    168173
     
    272277{{{
    273278[trac]
    274 permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     279permission_policies = AuthzSourcePolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    275280}}}
    276281
     
    289294
    290295For 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.
    291325
    292326== Debugging permissions
     
    306340to understand what checks are being performed. See the sourced documentation of the plugin for more info.
    307341
    308 
    309342----
    310343See also: TracPermissions,