TWikiAccessControl < TWiki/

%TOC%
%STARTINCLUDE%

---# TWiki Access Control

_Restricting read and write access to topics and webs, by users and groups_

---++ Overview

TWikiAccessControl allows you restrict access to single topics and entire webs, by individual user and by user groups, in three main areas: view; edit &amp; attach; and rename/move/delete. These controls, combined with TWikiUserAuthentication, let you easily create and manage an extremely flexible, fine-grained privilege system.

---++ An Important Control Consideration

Open, freeform editing is the essence of the WikiCulture - it's what makes TWiki different and often more effective than other collaboration tools. So, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with care. Experience shows that _unrestricted write access_ works very well because:

   * Peer influence is enough to ensure that only relevant content is posted.

   * Peer editing - the ability to rearrange anything on a page - keeps topics focussed.

   * All content is preserved under revision control.
      * Edits can be undone by the %MAINWEB%.TWikiAdminGroup (the default administrators group; see #ManagingGroups).
      * Users are encouraged to edit and refactor (condense a long topic), since there's a safety net.

As a collaboration guideline:

   * Create broad groups (more and varied input), and...
   * Avoid creating view-only users (if you can read it, you can contribute to it).

---++ Users and Groups

Access control is based on users and groups. Users are defined by their WikiNames, an then organized into unlimited combinations under different user groups.  

---+++ Managing Users

A user is created by with the TWikiRegistration form. The process generates a topic in the %MAINWEB% web in the new user's WikiName. The default visitor name is %MAINWEB%.TWikiGuest.

   * Users can be authenticated using Basic Authentication or SSL. TWikiUserAuthentication is required in order to track user identities.

#ManagingGroups
---+++ Managing Groups

Groups are defined by group topics in the ==%MAINWEB%== web, like the %MAINWEB%.TWikiAdminGroup. To start a new group:
   1. *Create* a new topic with A name that ends in *Group*, =<nop>SomeGroup=
   1. *Define* two variables:
      * Set <nop>GROUP = &lt; list of users and groups &gt;
      * Set <nop>ALLOWTOPICCHANGE = &lt; list of users and groups &gt;

   * GROUP is a comma-separated list of users and of other groups:<br />
     ==&nbsp; &nbsp; Set <nop>GROUP = %MAINWEB%.<nop>SomeUser, %MAINWEB%.<nop>OtherUser, %MAINWEB%.<nop>SomeOtherGroup==

   * ALLOWTOPICCHANGE defines who is allowed to change the group topic; it is a comma delimited list of users and groups. You typically want to restrict that to the members of the group itself, so it should contain the name of the topic,<br /> 
     ==&nbsp; &nbsp; Set <nop>ALLOWTOPICCHANGE = %MAINWEB%.<nop>TWikiAdminGroup== <br /> 
     for the <nop>TWikiAdminGroup topic. (This prevents users not in the group from editing the topic and from gaining unauthorized membership to the group.)

---++ Restricting Write Access

You can define who is allowed to make changes to a web or a topic. 

---+++ Deny Editing by Topic

Denying editing of a topic also restricts attaching files to it; both privileges are assigned together.
   * Define one or both of these variables in a topic, preferably at the end of the page:
      * Set <nop>DENYTOPICCHANGE = &lt; list of users and groups &gt;
      * Set <nop>ALLOWTOPICCHANGE = &lt; list of users and groups &gt;

   * DENYTOPICCHANGE defines users or groups that *are not* allowed to make changes to the topic. It is a comma delimited list of users and groups. Example: <br> =&nbsp; &nbsp; * Set <nop>DENYTOPICCHANGE = %MAINWEB%.<nop>SomeBadBoy, %MAINWEB%.<nop>SomeBadGirl, %MAINWEB%.<nop>SomeHackerGroup=

   * ALLOWTOPICCHANGE defines users or groups that *are* allowed to make changes to the topic. It is a comma delimited list of users and groups. Example: <br> =&nbsp; &nbsp; * Set <nop>ALLOWTOPICCHANGE = %MAINWEB%.<nop>SomeGoodGuy, %MAINWEB%.<nop>SomeGoodGirl, %MAINWEB%.<nop>TWikiAdminGroup=

   * DENYTOPICCHANGE is evaluated before ALLOWTOPICCHANGE. Access is denied if the authenticated person is in the DENYTOPICCHANGE list, or not in the ALLOWTOPICCHANGE list. Access is granted in case DENYTOPICCHANGE and ALLOWTOPICCHANGE is not defined.

---+++ Deny Editing by Web

Restricting web-level editing blocks creating new topics, changing topics or attaching files.

   * Define one or both of these variable in the %WEBPREFSTOPIC% topic:
      * Set <nop>DENYWEBCHANGE = &lt; list of users and groups &gt;
      * Set <nop>ALLOWWEBCHANGE = &lt; list of users and groups &gt;

The same rules apply as for restricting topics, with these additions:
   * DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in <nop>%WEBPREFSTOPIC%)
   * ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in <nop>%WEBPREFSTOPIC%)

---++ Restricting Rename Access

You can define who is allowed to rename, move or delete a topic, or rename a web.

---+++ Deny Renaming by Topic

To allow a user to rename, move or delete a topic, they also need write (editing) permission.  They also need write access to change references in referring topics.

   * Define one or both of these variables in a topic, preferably at the end of the topic:
      * Set <nop>DENYTOPICRENAME = &lt; list of users and groups &gt;
      * Set <nop>ALLOWTOPICRENAME = &lt; list of users and groups &gt;

   * DENYTOPICCRENAME defines users or groups that *are not* allowed to rename the topic. It is a comma delimited list of users and groups. Example: <br> =&nbsp; &nbsp; * Set <nop>DENYTOPICRENAME = %MAINWEB%.<nop>SomeBadBoy, %MAINWEB%.<nop>SomeBadGirl, %MAINWEB%.<nop>SomeHackerGroup=

   * ALLOWTOPICRENAME defines users or groups that *are* allowed to rename the topic. It is a comma delimited list of users and groups. Example: <br> =&nbsp; &nbsp; * Set <nop>ALLOWTOPICRENAME = %MAINWEB%.<nop>SomeGoodGuy, %MAINWEB%.<nop>SomeGoodGirl, %MAINWEB%.<nop>TWikiAdminGroup=

   * DENYTOPICRENAME is evaluated before ALLOWTOPICRENAME. Access is denied if the authenticated person is in the DENYTOPICRENAME list, or not in the ALLOWTOPICRENAME list. Access is granted in case DENYTOPICRENAME and ALLOWTOPICRENAME is not defined.

---+++ Deny Renaming by Web

You can define restrictions of who is allowed to rename a %WIKITOOLNAME% web.

   * Define one or both of these variable in the %WEBPREFSTOPIC% topic:
      * Set <nop>DENYWEBRENAME = &lt; list of users and groups &gt;
      * Set <nop>ALLOWWEBRENAME = &lt; list of users and groups &gt;

The same rules apply as for topics, with these additions:
   * DENYTOPICRENAME (in topic) overrides DENYWEBRENAME (in <nop>%WEBPREFSTOPIC%)
   * ALLOWTOPICRENAME (in topic) overrides ALLOWWEBRENAME (in <nop>%WEBPREFSTOPIC%)

---++ Restricting Read Access

You can define restrictions of who is allowed to view a %WIKITOOLNAME% web.

   * Define one or both of these variable in the %WEBPREFSTOPIC% topic:
      * Set <nop>DENYWEBVIEW = &lt; list of users and groups &gt;
      * Set <nop>ALLOWWEBVIEW = &lt; list of users and groups &gt;

---+++ Known Issues

   * The view restriction is not suitable for very sensitive content since there is a way to circumvent the read access restriction.
   * Read access restriction only works if the view script is authenticated, that means that users need to log on also just to read topics. TWikiInstallationGuide has more on Basic Authentication based on the ==.htaccess== file.

---++++ Selective Unrestricted Web Access

   * There is a workaround if you prefer to have unrestricted access to view topics located in normal webs, and to authenticate users only for webs where view restriction is enabled:
      1. *Omit* the ==view== script from the =.htaccess= file.
      1. *Enable* the ==$doRememberRemoteUser== flag in ==lib/TWiki.cfg== as described in TWikiUserAuthentication. %WIKITOOLNAME% will now remember the IP address of an authenticated user.
      1. *Copy* the ==view== script to ==viewauth== (or better, create a symbolic link)
      1. *Add* ==viewauth== to the list of authenticated scripts in the .htaccess file.
         * When a user accesses a web where you enabled view restriction, %WIKITOOLNAME% will redirect from the =view= script to the =viewauth= script once (this happens only if the user has never edited a topic). Doing so will ask for authentication. The =viewauth= script shows the requested topic if the user could log on and if the user is authorized to see that web.
         * If you enable view restriction for a web, it is recommended to restrict search "all webs" from searching this web. Enable this restriction with the ==NOSEARCHALL== variable in its WebPreferences, like:
            * Set <nop>NOSEARCHALL = on
         * It is not recommended to restrict view access to individual topics since all content is searchable _within_ a web.

---++ Hiding Control Settings

   * %T% To hide access control settings from normal browser viewing, place them in comment markers. 
<blockquote style="background-color:#f5f5f5">
   &lt;!--<br />
   Set <nop>DENYTOPICCHANGE = Main.<nop>SomeGroup<br />
   --&gt;
</blockquote>

#SuperAdminGroup
---++ The <nop>SuperAdminGroup

By mistyping a user or group name in the ALLOWTOPICCHANGE setting, it's possible to lock a topic so that it no-one can edit it from a browser. To avoid this:
   * Set the =$superAdminGroup= variable in =lib/TWiki.cfg= to the name of a group of users that are always allowed to edit/view topics.
<blockquote style="background-color:#f5f5f5">
<verbatim>
$superAdminGroup = "TWikiAdminGroup";
</verbatim>
</blockquote>
   * The default setting is not to have superusers.

-- Main.MikeMannix - 02 Dec 2001
This topic: TWiki/ > TWikiAccessControl
Topic revision: r20 - 02 Dec 2001 - 07:02:00 - MikeMannix?
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback