<div>
<ul>
<li><a href="#TWiki Access Control"> TWiki Access Control</a><ul>
- <li><a href="#Users and Groups"> Users and Groups</a></li>
- <li><a href="#Write Access Restriction by Topi"> Write Access Restriction by Topic</a></li>
- <li><a href="#Write Access Restriction by Web"> Write Access Restriction by Web</a></li>
- <li><a href="#Rename Access Restriction by Top"> Rename Access Restriction by Topic</a></li>
- <li><a href="#Rename Access Restriction by Web"> Rename Access Restriction by Web</a></li>
- <li><a href="#Read Access Restriction by Web"> Read Access Restriction by Web</a><ul>
- <li><a href="#Read Access Restriction Notes"> Read Access Restriction Notes</a></li>
+ <li><a href="#An Important Control Considerati"> An Important Control Consideration</a></li>
+ <li><a href="#Users and Groups"> Users and Groups</a><ul>
+ <li><a href="#Managing Users"> Managing Users</a></li>
+ <li><a href="#Managing Groups"> Managing Groups</a></li>
</ul>
</li>
+ <li><a href="#Restricting Write Access"> Restricting Write Access</a><ul>
+ <li><a href="#Deny Editing by Topic"> Deny Editing by Topic</a></li>
+ <li><a href="#Deny Editing by Web"> Deny Editing by Web</a></li>
+ </ul>
+ </li>
+ <li><a href="#Restricting Rename Access"> Restricting Rename Access</a><ul>
+ <li><a href="#Deny Renaming by Topic"> Deny Renaming by Topic</a></li>
+ <li><a href="#Deny Renaming by Web"> Deny Renaming by Web</a></li>
+ </ul>
+ </li>
+ <li><a href="#Restricting Web Access"> Restricting Web Access</a><ul>
+ <li><a href="#Create Hidden Webs"> Create Hidden Webs</a></li>
+ <li><a href="#Create Authenticated Access By W"> Create Authenticated Access By Web</a></li>
+ </ul>
+ </li>
+ <li><a href="#Hiding Control Settings"> Hiding Control Settings</a></li>
<li><a href="#The _SuperAdminGroup"> The SuperAdminGroup</a></li>
</ul>
</li>
</ul>
</div>
-## <a name="TWiki Access Control"></a> TWiki Access Control
+# <a name="TWiki Access Control"></a> 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 & attach; and rename/move/delete. Access control, combined with [[TWikiUserAuthentication]], lets you easily create and manage an extremely flexible, fine-grained privilege system.
+
+## <a name="An Important Control Considerati"></a> 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.
-%WIKITOOLNAME% allows you to define restrictions of who is allowed to view a %WIKITOOLNAME% web, make changes to topics or attach files.
+- In TWiki, content is transparently preserved under **revision control**:
+ - Edits can be undone by the [[TWikiAdminGroup]] (the default administrators group; see [[#ManagingGroups|Main/WebHome#ManagingGroups]]).
+ - Users are encouraged to edit and refactor (condense a long topic), since there's a safety net.
-**IMPORTANT NOTE:** Think twice before restricting read or write access to a web or a topic, because an open system where everybody can contribute is the essence of the [[WikiCulture]]. Experience shows that unrestricted write access works very well because:
+As a **collaboration guideline**:
-- There is enough peer pressure to post only conform content.
-- Content does not get lost because topics are under revision control.
-- A topic revision can be undone by a member of the [[TWikiAdminGroup]] in case needed.
+- 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).
-### <a name="Users and Groups"></a> Users and Groups
+## <a name="Users and Groups"></a> Users and Groups
-Access control is based on 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.
-**_Users_** are defined by the user topics in the Main web, i.e. [[TWikiGuest]]
+### <a name="Managing Users"></a> Managing Users
-- Users can be authenticated using basic authentication or SSL. [Installation Notes](TWikiDocumentation#installation) has more.
+A user is created with the [[TWikiRegistration]] form. The process generates a topic in the Main web in the new user's [[WikiName]]. The default visitor name is [[TWikiGuest]].
-**_Groups_** are defined by group topics in the Main web, i.e. [[TWikiAdminGroup]]
+- 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.
-- A group topic name must end in **...Group**
-- The group topic should define these two variables:
- - Set GROUP = < list of users and groups >
- - Set ALLOWTOPICCHANGE = < list of users and groups >
-- GROUP defines the members of the group; it is a comma delimited list of users and other groups. Example: <br />` * Set GROUP = Main.SomeUser, Main.OtherUser, Main.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, i.e. <br />` * Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup`<br /> for the TWikiAdminGroup topic. (This is to prevent users not in the group from editing the topic and gaining unauthorized membership to the group.)
+<a name="ManagingGroups"></a>
-### <a name="Write Access Restriction by Topi"></a> Write Access Restriction by Topic
+### <a name="Managing Groups"></a> Managing Groups
-You can define restrictions of who is allowed to make changes to a topic or attach files to it.
+Groups are defined by group topics created in the <code>**Main**</code> web, like the [[TWikiAdminGroup]]. To create a new group:
-Define one or both of these variables in a topic, preferably at the end of the topic:
+1. <code>**Edit**</code> [[TWikiGroups]] by entering a new topic with a name that ends in <code>**Group**</code>. Example:
+ - <code>**SomeGroup**</code>
+2. **Set Preferences** for two Variables in the new group topic:
+ - <code>**Set GROUP = < list of Users and/or Groups >**</code>
+ - <code>**Set ALLOWTOPICCHANGE = < list of Users and/or Groups >**</code>
+ - The GROUP variable is a comma-separated list of Users and/or other Groups. Example:
+ - <code>**Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeGroup**</code>
+ - 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 TWikiAdminGroup topic write:
+ - <code>**Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup**</code>
-- Set DENYTOPICCHANGE = < list of users and groups >
-- Set ALLOWTOPICCHANGE = < list of users and groups >
+## <a name="Restricting Write Access"></a> Restricting Write Access
-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 />` * Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup`
+You can define who is allowed to make changes to a web or a topic.
-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 />` * Set ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup`
+### <a name="Deny Editing by Topic"></a> Deny Editing by Topic
-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.
+Denying editing of a topic also restricts file attachment; both privileges are assigned together.
-### <a name="Write Access Restriction by Web"></a> Write Access Restriction by Web
+- Define one or both of these variables in a topic, preferably at the end of the page:
+ - <code>**Set DENYTOPICCHANGE = < list of Users and Groups >**</code>
+ - <code>**Set ALLOWTOPICCHANGE = < list of Users and Groups >**</code>
-You can define restrictions of who is allowed to make changes to a %WIKITOOLNAME% web. This includes creating new topics, changing topics or attaching files.
+- DENYTOPICCHANGE defines Users or Groups that **are not** allowed to make changes to the topic, with a comma-delimited list. Example:
+ - <code>**Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
-Define one or both of these variable in the [[WebPreferences]] topic:
+- 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:
+ - <code>**Set ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
-- Set DENYWEBCHANGE = < list of users and groups >
-- Set ALLOWWEBCHANGE = < list of users and groups >
+- 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.
-The same rules apply like the one for Access Control for Individual Topics; with these additions:
+### <a name="Deny Editing by Web"></a> 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 [[WebPreferences]] topic:
+ - <code>**Set DENYWEBCHANGE = < list of Users and Groups >**</code>
+ - <code>**Set ALLOWWEBCHANGE = < list of Users and Groups >**</code>
+
+The same rules apply as for restricting topics, with these additions:
- DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in WebPreferences)
- ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in WebPreferences)
-### <a name="Rename Access Restriction by Top"></a> Rename Access Restriction by Topic
+## <a name="Restricting Rename Access"></a> Restricting Rename Access
-You can define restrictions of who is allowed to rename a topic. Note that users need this permission in addition to the CHANGE permission in order to rename a topic. They also need CHANGE access to change references in referring topics.
+You can define who is allowed to rename, move or delete a topic, or rename a web.
-Define one or both of these variables in a topic, preferably at the end of the topic:
+### <a name="Deny Renaming by Topic"></a> Deny Renaming by Topic
-- Set DENYTOPICRENAME = < list of users and groups >
-- Set ALLOWTOPICRENAME = < list of users and groups >
+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.
-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 />` * Set DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup`
+- Define one or both of these variables in a topic, preferably at the end of the topic:
+ - <code>**Set DENYTOPICRENAME = < list of Users and Groups >**</code>
+ - <code>**Set ALLOWTOPICRENAME = < list of Users and Groups >**</code>
-ALLOWTOPICRENAME defines users or groups that **are** allowed to rename the topic. It is a comma delimited list of users and groups. Example: <br />` * Set ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup`
+- DENYTOPICCRENAME defines Users or Groups that **are not** allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:
+ - <code>**Set DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
-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.
+- ALLOWTOPICRENAME defines Users or Groups that **are** allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:
+ - <code>**Set ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
-### <a name="Rename Access Restriction by Web"></a> Rename Access Restriction by Web
+- 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.
-You can define restrictions of who is allowed to do renames for a %WIKITOOLNAME% web.
+### <a name="Deny Renaming by Web"></a> Deny Renaming by Web
-Define one or both of these variable in the [[WebPreferences]] topic:
+You can define restrictions of who is allowed to rename a %WIKITOOLNAME% web.
-- Set DENYWEBRENAME = < list of users and groups >
-- Set ALLOWWEBRENAME = < list of users and groups >
+- Define one or both of these variable in the [[WebPreferences]] topic:
+ - <code>**Set DENYWEBRENAME = < list of Users and Groups >**</code>
+ - <code>**Set ALLOWWEBRENAME = < list of Users and Groups >**</code>
-The same rules apply like the one for Access Control for Individual Topics; with these additions:
+The same rules apply as for topics, with these additions:
- DENYTOPICRENAME (in topic) overrides DENYWEBRENAME (in WebPreferences)
- ALLOWTOPICRENAME (in topic) overrides ALLOWWEBRENAME (in WebPreferences)
-### <a name="Read Access Restriction by Web"></a> Read Access Restriction by Web
+## <a name="Restricting Web Access"></a> Restricting Web Access
+
+You can prevent selected Users and Groups from accessing certain webs, by hiding them using restricting read access, or by requiring login. There are two basic methods, one simple, using standard preferences variables to hide a web, but offering low security, and a secure log-in approach that is currently a workaround, involving some minor script and filesystem modification.
+
+### <a name="Create Hidden Webs"></a> Create Hidden Webs
+
+You can prevent selected Users and Groups from viewing certain %WIKITOOLNAME% webs by setting one or both of these variables in each web's [[WebPreferences]] topic:
+
+- <code>**Set DENYWEBVIEW = < list of Users and Groups >**</code>
+- <code>**Set ALLOWWEBVIEW = < list of Users and Groups >**</code>
+
+%T% If keeping a hidden web out of general use is a consideration, you can prevent the <code>**all webs**</code> search option from accessing hidden webs, by enabling the <code>**NOSEARCHALL**</code> variable in [[WebPreferences]]:
+
+- <code>**Set NOSEARCHALL = on**</code>
+ - It is not recommended to restrict view access to individual topics since all content is searchable _within_ a web.
+ - %H%This method only works if the <code>**view**</code> script is authenticated, which means that all Users have to login, even for read-only access. (An open guest account, like [[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 <code>**.htaccess**</code> file.
+
+%X% **Hiding 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. _(See the next section for a more secure approach.)_
+
+### <a name="Create Authenticated Access By W"></a> Create Authenticated Access By Web
+
+Use the following setup to provide unrestricted viewing access to open webs, with authentication only on selected webs:
-You can define restrictions of who is allowed to view a %WIKITOOLNAME% web.
+1. **Omit** the <code>**view**</code> script from the `.htaccess` file.
+2. **Enable** the <code>**$doRememberRemoteUser**</code> flag in <code>**lib/TWiki.cfg**</code> as described in [[TWikiUserAuthentication]]. %WIKITOOLNAME% will now remember the IP address of an authenticated user.
+3. **Copy** the <code>**view**</code> script to <code>**viewauth**</code> (or better, create a symbolic link)
+4. **Add** <code>**viewauth**</code> to the list of authenticated scripts in the .htaccess file.
-Define one or both of these variable in the [[WebPreferences]] topic:
+- 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 <code>**NOSEARCHALL**</code> variable in its [[WebPreferences]], like:
+ - <code>**Set NOSEARCHALL = on**</code>
+- It is not recommended to restrict view access to individual topics since all content is searchable within a web - a search will turn up the "hidden" topic.
-- Set DENYWEBVIEW = < list of users and groups >
-- Set ALLOWWEBVIEW = < list of users and groups >
+## <a name="Hiding Control Settings"></a> Hiding Control Settings
-#### <a name="Read Access Restriction Notes"></a> Read Access Restriction Notes
+- %T% To hide access control settings from normal browser viewing, place them in comment markers.
-- 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. [TWiki Installation](TWikiDocumentation#installation) has more on basic authentication based on the `.htaccess` file.
-- There is a workaround if you prefer to to have unrestricted access to view topics located in normal webs, and to authenticate users only for webs where view restriction is enabled:
- - Leave the `view` script non authenticated in the `.htaccess` file.
- - Enable the `$doRememberRemoteUser` flag in `wikicfg.pm` as described in [TWiki Authentication](TWikiDocumentation#authentication). %WIKITOOLNAME% will now remember the IP address of an authenticated user.
- - Copy the `view` script to `viewauth` (or better, create a symbolic link)
- - 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 hapens 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 NOSEARCHALL = on
-- It is not recommended to restrict view access to individual topics since all content is searchable **_within_** a web.
-- The view restriction is not suitable for very sensitive content since there is a way to circumvent the read access restriction.
+> <!--
+>
+> <br />
+>
+> - Set DENYTOPICCHANGE = Main.SomeGroup<br /> -->
-### <a name="The _SuperAdminGroup"></a> The [[SuperAdminGroup]]
+<a name="SuperAdminGroup"></a>
-The above schema can lock completely a topic in case of a typing error of the ALLOWTOPICCHANGE setting (see [UnchangeableTopicBug](http://www.twiki.org/cgi-bin/view/Codev/UnchangeableTopicBug)). To avoid this:
+## <a name="The _SuperAdminGroup"></a> The SuperAdminGroup
-- set the `$superAdminGroup` variable in `TWiki.cfg` to the name of a group of users that are always allowed to edit/view topics. E.g.:
+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**:
- $superAdminGroup = "TWikiAdminGroup";
+- Set the <code>**$superAdminGroup**</code> variable in <code>**lib/TWiki.cfg**</code> to the name of a group of Users who are always allowed to edit/view topics.
-- the default setting is not to have superusers
+> $superAdminGroup = "TWikiAdminGroup";
--- [[PeterThoeny]] - 16 Mar 2001 <br /> -- [[AndreaSterbini]] - 11 Apr 2001 <br />
+- The default setting is not to have superusers.
-**_Related topics:_** [[TWikiPreferences]], [[WebPreferences]] (in every web), [[TWikiAdminGroup]], [[TWikiGroups]]
+-- [[PeterThoeny]] - 04 May 2002<br /> -- [[MikeMannix]] - 12 May 2002
git://git.openafs.org / openafs-wiki.git / blobdiff