wiki:RestrictedAreaPlugin

Version 2 (modified by Chriki, 7 years ago) (diff)

added tags, added credits

Set up restricted areas with access only for privileged users

Description

The RestrictedAreaPlugin is a pretty simple Trac plugin that allows the Trac administrator to set up restricted areas which are accessible only for privileged users. The access is controlled via the new Trac action RESTRICTED_AREA_ACCESS and a list of paths configured in the Trac INI-file.

The plugin is tested only in our Trac environment which is a version 0.10.3 installation. As said, the plugin is pretty simple and probably runs in most other Trac versions from 0.9 on equally well (no guaranty, though!). If you are running the plugin in any other installation, then please feel free to edit this page accordingly -- alternatively file an informational ticket and I'll add the information myself ;-)

Bugs/Feature Requests

Existing bugs and feature requests for RestrictedAreaPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out RestrictedAreaPlugin from here using Subversion, or browse the source with Trac.

Example

To enable the plugin, add the following line to the [components] section of your Trac INI-file:

restrictedarea.filter = enabled

If you don't explicitly set anything, the path /wiki/restricted has restricted access only. Usually, however, you will specify your own restricted areas via paths in the Trac INI-file. Therefore you add the [restrictedarea] section with paths specified in the following form:

[restrictedarea]
paths = /wiki/secret, /wiki/area51

Finally you have to add RESTRICTED_AREA_ACCESS action permissions to each subject (users or groups) that may access the pages below the specified paths -- just like you would do with any of the Trac built-in actions.

Recent Changes

[4373] by Chriki on 2008-10-02 12:56:31
license added to package; fixes #3847
[3184] by Chriki on 2008-02-06 10:53:19
fix for bug #2526
[1928] by Chriki on 2007-02-07 10:22:03
RestrictedAreaPlugin:

clear error message for users of Trac versions <0.10.3 (cf. bug #1184)

Author/Credits

Author: Chriki

The plugin was originally inspired by the HttpAuthPlugin. It was developed at the German Research Center for Artificial Intelligence, DFKI by me, Christian Spurk. Suggestions and feedback are always welcome; please note, however, that the plugin is my very first Python work and was developed during my first few weeks of contact with Trac. That means I'm neither a Python nor a Trac guru at all, so if you suggest enhancements to the plugin, then it would help a lot to give me some hints on how to implement certain things.