(r26) TWikiAccessControl < TWiki

TWiki Web>TWikiAccessControl (revision 26) (raw view)~~EditAttach~~
%TOC%
%STARTINCLUDE%

---# TWiki Access Control

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

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

---++ An Important Control Consideration

Open, freeform editing is the essence of WikiCulture - what makes TWiki different and often more effective than other collaboration tools. For that reason, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with care - the more restrictions, the less Wiki in the mix. 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 for anyone to rearrange all content on a page - keeps topics focussed.

   * In TWiki, content is transparently 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-based Groups (for more and varied input), and...
   * Avoid creating view-only Users (if you can read it, you should be able to contribute to it).

---++ Users and Groups

Access control is based on the familiar concept of Users and Groups. Users are defined by their WikiNames. They can then be organized in unlimited combinations by inclusion in one or more user Groups. For convenience, Groups can also be included in other Groups. 

---+++ Managing Users

A user is created 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 (htaccess) or SSL (secure server). In either case, TWikiUserAuthentication is required in order to track user identities, and use User and Group access control.

#ManagingGroups
---+++ Managing Groups

Groups are defined by group topics created in the ==%MAINWEB%== web, like the %MAINWEB%.TWikiAdminGroup. To create a new group:
   1. ==Edit== %MAINWEB%.TWikiGroups by entering a new topic with a name that ends in ==Group==. Example:
      * ==<nop>SomeGroup==
   1. *Set Preferences* for two Variables in the new group topic:
      * ==Set <nop>GROUP = &lt; list of Users and/or Groups &gt;==
      * ==Set <nop>ALLOWTOPICCHANGE = &lt; list of Users and/or Groups &gt;==
      * The GROUP variable is a comma-separated list of Users and/or other Groups. Example:
         * ==Set GROUP = %MAINWEB%.<nop>SomeUser, %MAINWEB%.<nop>OtherUser, %MAINWEB%.<nop>SomeGroup==
      * 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. (This prevents Users not in the Group from editing the topic to give themselves or others access. For example, for the <nop>TWikiAdminGroup topic write:
      * ==Set ALLOWTOPICCHANGE = %MAINWEB%.<nop>TWikiAdminGroup==

---++ 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 file attachment; 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, with a comma-delimited list. Example:
      * ==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:
      * ==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:
      * ==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:
      * ==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 who is allowed to see a web.

---+++ Deny Viewing by Topic

%X% Technically it is possible to restrict read access to an individual topic based on ==DENYTOPICVIEW== / ==ALLOWTOPICVIEW== preferences variables, provided that the view script is authenticated. However this setup is not recommended since all content is searchable within a web - a search will turn up view restricted topics.

---+++ Deny Viewing by Web

You can define restrictions of who is allowed to view a %WIKITOOLNAME% web. You can restrict access to certain webs to selected Users and Groups, by:

   * *obfuscating webs:* Insecure but handy method to hide new webs until content is ready for deployment.
   * *authenticating all webs and restricting selected webs:* Topic access in all webs is authenticated, and selected webs have restricted access.
   * *authenticating and restricting selected webs only:* Provide unrestricted viewing access to open webs, with authentication and restriction only on selected webs.

---++++ Obfuscate Webs

The idea is to keep a web hidden by not publishing its URL and by preventing the ==all webs== search option from accessing obfuscated webs. Do so by enabling the ==NOSEARCHALL== variable in %WEBPREFSTOPIC%:
   * ==Set <nop>NOSEARCHALL = on==

This setup can be useful to hide a new web until content its ready for deployment.

%X% *Obfuscating webs is insecure*, as anyone who knows the URL can access the web.

---++++ Authenticate all Webs and Restrict Selected Webs

Use the following setup to authenticate users for topic viewing in all webs and to restrict access to selected webs:

   1. *Restrict* view access to selected Users and Groups. Set one or both of these variables in its %WEBPREFSTOPIC% topic:
      * ==Set <nop>DENYWEBVIEW = &lt; list of Users and Groups &gt;==
      * ==Set <nop>ALLOWWEBVIEW = &lt; list of Users and Groups &gt;==
      * __Note:__ =DENYWEBVIEW= is evaluated before =ALLOWWEBVIEW=. Access is denied if the authenticated person is in the =DENYWEBVIEW= list, or not in the =ALLOWWEBVIEW= list. Access is granted in case =DENYWEBVIEW= and =ALLOWWEBVIEW= is not defined.
   1. *Hide* the web from an "all webs" search. Enable this restriction with the ==NOSEARCHALL== variable in its %WEBPREFSTOPIC% topic:
      * ==Set <nop>NOSEARCHALL = on==
   1. *Add* ==view== to the list of authenticated scripts in the =.htaccess= file.

%H% This method only works if the ==view== script is authenticated, which means that all Users have to login, even for read-only access. (An open guest account, like Main.TWikiGuest, can get around this, allowing anyone to login to a common account with, for example, view-only access for public webs.) TWikiInstallationGuide has more on Basic Authentication, using the ==.htaccess== file.

---++++ Authenticate and Restricting Selected Webs Only

Use the following setup to provide unrestricted viewing access to open webs, with authentication only on selected webs:

   1. *Restrict* view access to selected Users and Groups. Set one or both of these variables in its %WEBPREFSTOPIC% topic:
      * ==Set <nop>DENYWEBVIEW = &lt; list of Users and Groups &gt;==
      * ==Set <nop>ALLOWWEBVIEW = &lt; list of Users and Groups &gt;==
      * __Note:__ =DENYWEBVIEW= is evaluated before =ALLOWWEBVIEW=. Access is denied if the authenticated person is in the =DENYWEBVIEW= list, or not in the =ALLOWWEBVIEW= list. Access is granted in case =DENYWEBVIEW= and =ALLOWWEBVIEW= is not defined.
   1. *Hide* the web from an "all webs" search. Enable this restriction with the ==NOSEARCHALL== variable in its %WEBPREFSTOPIC% topic:
      * ==Set <nop>NOSEARCHALL = on==
   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. The ==view== script should not be listed 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.

%X% *Authenticating webs is not very secure*, as there is a way to circumvent the read access restriction. It can be useful in certain situations - for example, to simplify site organization and clutter, by hiding low traffic webs - but is not recommended for securing sensitive content.


---++ Hiding Control Settings

%T% To hide access control settings from normal browser viewing, place them in comment markers.

<style="background-color:#f5f5f5">
=&lt;!--= <br />
=&nbsp;  * Set <nop>DENYTOPICCHANGE = Main.<nop>SomeGroup= <br />
=--&gt;=
</style>

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

By mistyping a user or group name in the ALLOWTOPICCHANGE setting, it's possible to lock a topic so that no-one can edit it from a browser. To avoid this, you can create Web-based *superusers*:
   * Set the ==$superAdminGroup== variable in ==lib/TWiki.cfg== to the name of a group of Users who 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.PeterThoeny - 04 May 2002<br />
-- Main.MikeMannix - 12 May 2002 

%STOPINCLUDE%
Topic revision: r26 - 29 May 2002 - 12:36:00 - PeterThoeny
TWiki
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
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiAccessControl