Changes between Version 2 and Version 3 of TracFineGrainedPermissions


Ignore:
Timestamp:
2019-05-02T09:45:05-03:00 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFineGrainedPermissions

    v2 v3  
    1515{{{#!ini
    1616[trac]
    17 permission_policies = ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    18 }}}
    19 This 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.
     17permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     18}}}
     19This 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.
    2020
    2121Among the optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See
     
    2828=== !AuthzPolicy ===
    2929==== Configuration ====
     30* Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj].
    3031* 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.
    3132* Update your `trac.ini`:
     
    3435[trac]
    3536...
    36 permission_policies = AuthzPolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     37permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    3738}}}
    3839  1. add a new `[authz_policy]` section:
     
    222223==== Trac Configuration ====
    223224
    224 To activate granular permissions you __must__ specify the {{{authz_file}}} option in the `[svn]` section of trac.ini. If this option is set to null or not specified, the permissions will not be used.
    225 
    226 {{{#!ini
    227 [svn]
     225To activate granular 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.
     226
     227{{{#!ini
     228[trac]
    228229authz_file = /path/to/svnaccessfile
    229230}}}
     
    235236}}}
    236237
    237 where ''modulename'' refers to the same repository indicated by the `<name>.dir` entry in the `[repositories]` section. As an example, if the `somemodule.dir` entry in the `[repositories]` section is `/srv/active/svn/somemodule`, that would yield the following:
     238where ''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/somemodule}}}, that would yield the following:
    238239
    239240{{{ #!ini
    240 [svn]
     241[trac]
    241242authz_file = /path/to/svnaccessfile
    242243authz_module_name = somemodule
    243244...
    244 [repositories]
    245 somemodule.dir = /srv/active/svn/somemodule
     245repository_dir = /srv/active/svn/somemodule
    246246}}}
    247247
     
    254254{{{#!ini
    255255[trac]
    256 permission_policies = AuthzSourcePolicy, ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
     256permission_policies = AuthzSourcePolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
    257257}}}
    258258
     
    272272For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess].
    273273
    274 === ReadonlyWikiPolicy
    275 
    276 Since 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:
    277 {{{
    278 [trac]
    279 permission_policies = ReadonlyWikiPolicy,
    280  DefaultPermissionPolicy,
    281  LegacyAttachmentPolicy
    282 }}}
    283 
    284 When 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.
    285 
    286 **!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.
    287 
    288 The `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.
    289 
    290 When 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.
    291 {{{
    292 [trac]
    293 permission_policies = AuthzPolicy,
    294  ReadonlyWikiPolicy,
    295  DefaultPermissionPolicy,
    296  LegacyAttachmentPolicy
    297 }}}
    298 
    299 The placement of [#AuthzSourcePolicy] relative to `ReadonlyWikiPolicy` does not matter since they don't perform checks on the same realms.
    300 
    301 For 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.
    302 
    303274== Debugging permissions
    304275In trac.ini set: