An Important Control Consideration

• Peer editing - the ability for anyone to rearrange all content on a page - keeps topics focused.

Permissions settings of the webs on this TWiki site

See TWikiAccessControl for details

Please Note:

• A blank in the the above table may mean either the corresponding control is absent or commented out or that it has been set to a null value. The two conditions have dramatically different and possibly opposed semantics.
• TWikiGuest is the guest account - used by unauthenticated users.
• The TWiki web must not deny view to TWikiGuest; otherwise, people will not be able to register.

Note: Above table comes from SitePermissions

• WikiName and encrypted password are recorded using the password manager if authentication is enabled.

• Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeGroup

• Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup

The Super Admin Group

• Set GROUP= Main.ElizabethWindsor, Main.TonyBlair

Restricting Access

• Restricting VIEW blocks viewing and searching of content.
• Restricting CHANGE blocks creating new topics, changing topics or attaching files.
• Restricting RENAME controls who is allowed to rename, move or delete a topic.
  • To rename, move or delete a topic, the user also also needs VIEW and CHANGE permission. They also need CHANGE access to change references in any referring topics (though the rename can proceed without this access), and CHANGE access to the target topic.
• Restricting MANAGE controls access to certain management functions, such as 'create web'. It must be set in the TWiki web.

Controlling access to a Web

• 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.

• You can define these settings in the WebPreferences topic, preferable towards the end of the topic:
  • Set DENYWEBVIEW = < comma-delimited list of Users and Groups >
  • Set ALLOWWEBVIEW = < comma-delimited list of Users and Groups >
  • Set DENYWEBCHANGE = < comma-delimited list of Users and Groups >
  • Set ALLOWWEBCHANGE = < comma-delimited list of Users and Groups >
  • Set DENYWEBRENAME = < comma-delimited list of Users and Groups >
  • Set ALLOWWEBRENAME = < comma-delimited list of Users and Groups >

Be careful with empty values for any of these. In older versions of TWiki,

• Set ALLOWWEBVIEW =

• Set DENYWEBVIEW =

Controlling access to a Topic

• You can define these settings in the WebPreferences topic, preferable towards the end of the topic:
  • Set DENYTOPICVIEW = < comma-delimited list of Users and Groups >
  • Set ALLOWTOPICVIEW = < comma-delimited list of Users and Groups >
  • Set DENYTOPICCHANGE = < comma-delimited list of Users and Groups >
  • Set ALLOWTOPICCHANGE = < comma-delimited list of Users and Groups >
  • Set DENYTOPICRENAME = < comma-delimited list of Users and Groups >
  • Set ALLOWTOPICRENAME = < comma-delimited list of Users and Groups >

Remember when opening up access to specific topics within a restricted web that other topics in the web - for example, the WebLeftBar - may also be accessed when viewing the topics. The message you get when you are denied access should tell you what topic you were not permitted to access.

Be careful with empty values for any of these. In older versions of TWiki,

• Set ALLOWTOPICVIEW =

• Set DENYTOPICVIEW =

Controlling access to Attachments

  ScriptAlias /twiki/bin/ /filesystem/path/to/twiki/bin/
  Alias /twiki/pub/       /filesystem/path/to/twiki/pub/

How TWiki evaluates ALLOW/DENY settings

1. If the user is a super-user
   • access is PERMITTED.
2. If DENYTOPIC is set to a list of wikinames
   • people in the list will be DENIED.
3. If DENYTOPIC is set to empty ( i.e. Set DENYTOPIC = )
   • access is PERMITTED i.e no-one is denied access to this topic
4. If ALLOWTOPIC is set
   1. people in the list are PERMITTED
   2. everyone else is DENIED
      • Note that this means that setting ALLOWTOPIC to empty denies access to everyone except admins (unless DENYTOPIC is also set to empty, as described above)
5. If DENYWEB is set to a list of wikiname
   • people in the list are DENIED access
6. If ALLOWWEB is set to a list of wikinames
   • people in the list will be PERMITTED
   • everyone else will be DENIED
     • Note that setting ALLOWWEB to empty denies access to everyone except admins
7. If you got this far, access is PERMITTED

Access Control quick recipes

Obfuscating Webs

Authenticate all Webs and Restrict Selected Webs

Authenticate and Restrict Selected Webs Only

Hide Control Settings

<!--
   * Set DENYTOPICCHANGE = Main.SomeGroup
-->

-- Contributors: TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.CrawfordCurrie

Authentication vs. Access Control

Authentication: Identifies who a user is based on a login procedure. See TWikiUserAuthentication.

Access control: Restrict access to content based on users and groups once a user is identified.

• WikiName and encrypted password are recorded in .htpasswd if authentication is enabled.
• A confirmation e-mail is sent to the user.
• A user home page with the WikiName of the user is created in the Main web.
• The user is added to the TWikiUsers topic.

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.

The default visitor name is TWikiGuest. This is the non-authenticated user.

• • 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.

• • 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.

<style="background-color:#f5f5f5"> <!--
   * Set DENYTOPICCHANGE = Main.SomeGroup
-->

Restricting Read Access

Deny Viewing by Topic

Deny Viewing by Web

You can define restrictions of who is allowed to view a Proyecto META 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 WebPreferences:

• Set NOSEARCHALL = on

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

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 WebPreferences topic:

1. Hide the web from an "all webs" search. Enable this restriction with the NOSEARCHALL variable in its WebPreferences topic:

1. Add view to the list of authenticated scripts in the .htaccess file.

Authenticate and Restricting Selected Webs Only

1. Restrict view access to selected Users and Groups. Set one or both of these variables in its WebPreferences topic:
   • Set DENYWEBVIEW = < list of Users and Groups >
   • Set ALLOWWEBVIEW = < list of Users and Groups >
2. Hide the web from an "all webs" search. Enable this restriction with the NOSEARCHALL variable in its WebPreferences topic:
   • Set NOSEARCHALL = on

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, Proyecto META 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.

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.

• 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:

• 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 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.

1. Edit TWikiGroups by entering a new topic with a name that ends in Group. Example:

1. Set Preferences for two Variables in the new group topic:
   • Set GROUP = < list of Users and/or Groups >
   • Set ALLOWTOPICCHANGE = < list of Users and/or Groups >
   • The GROUP variable is a comma-separated list of Users and/or other Groups. Example:
     • Set GROUP = Main.SomeUser, Main.OtherUser, Main.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 TWikiAdminGroup topic write:

• • Set DENYTOPICCHANGE = < list of Users and Groups >
  • Set ALLOWTOPICCHANGE = < list of Users and Groups >

• DENYTOPICCHANGE defines Users or Groups that are not allowed to make changes to the topic, with a comma-delimited list. Example:

• 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 DENYWEBCHANGE = < list of Users and Groups >
  • Set ALLOWWEBCHANGE = < list of Users and Groups >

• • Set DENYTOPICRENAME = < list of Users and Groups >
  • Set ALLOWTOPICRENAME = < list of Users and Groups >

• DENYTOPICCRENAME defines Users or Groups that are not allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:

• ALLOWTOPICRENAME defines Users or Groups that are allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:

• • Set DENYWEBRENAME = < list of Users and Groups >
  • Set ALLOWWEBRENAME = < list of Users and Groups >

• Set DENYWEBVIEW = < list of Users and Groups >
• Set ALLOWWEBVIEW = < list of Users and Groups >

• • 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 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.

• 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 DENYTOPICCHANGE = Main.SomeGroup
  

• Set the $superAdminGroup variable in lib/TWiki.cfg to the name of a group of Users who are always allowed to edit/view topics.

• • Edits can be undone by the TWikiAdminGroup (the default administrators group; see #ManagingGroups).

1. Start in TWikiGroups and create a new topic with a name that ends in Group. Example:
   • SomeGroup
2. Define two variables in the group topic:
   • Set GROUP = < list of users and/or groups >
   • Set ALLOWTOPICCHANGE = < list of users and/or groups >

• A variables is defined as a bullet of format Set NAME = value. A bullet line starts with a multiple of three spaces, an asterisk, and a space.
• The GROUP variable is a comma-separated list of users and/or other groups. Example:
  • 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. (This prevents users not in the group from editing the topic and from gaining unauthorized membership to the group.) For example, for the TWikiAdminGroup topic write:
  • Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup

• • Set DENYTOPICCHANGE = < list of users and groups >
  • Set ALLOWTOPICCHANGE = < list of users and groups >

• 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:
  • Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.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 ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup

• • Set DENYWEBCHANGE = < list of users and groups >
  • Set ALLOWWEBCHANGE = < list of users and groups >

• • Set DENYTOPICRENAME = < list of users and groups >
  • Set ALLOWTOPICRENAME = < list of users and groups >

• 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 DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.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 ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup

• • Set DENYWEBRENAME = < list of users and groups >
  • Set ALLOWWEBRENAME = < list of users and groups >

• Set DENYWEBVIEW = < list of users and groups >
• Set ALLOWWEBVIEW = < list of users and groups >

• Set NOSEARCHALL = on

• • Set NOSEARCHALL = on

• • 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 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.

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.)

THIS SECTION CONTAINS WORKAROUNDS. Perhaps unconventional for official documentation, but practical, the following method for extending TWiki functionality involves modifying core TWiki, making it essentially not a feature but a hack. Still, it is officially TWiki developer-approved and documented, and will no doubt be included in some form in an upcoming edition of TWiki.

To selectively restrict web access with the security of Basic Authentication, there is a reliable workaround that involves some straightforward code modification:

• (mod by ImmoHuneke^? - 16 Mar 2002)

1. Enable the $doRememberRemoteUser flag in lib/TWiki.cfg as described in TWikiUserAuthentication. Proyecto META will now remember the IP address of an authenticated user.
2. Copy the view script to viewauth (or better, create a symbolic link)
3. Add viewauth to the list of authenticated scripts in the .htaccess file.

• Set the $superAdminGroup variable in lib/TWiki.cfg to the name of a group of users who are always allowed to edit/view topics.

Restricting Web Access

Create Hidden Webs

You can prevent selected users and groups from viewing certain Proyecto META webs by setting one or both of these variables in each web's WebPreferences topic:

• If keeping a hidden web out of general use is a consideration, you should also prevent the "all webs" search option from accessing each hidden web, by enabling the NOSEARCHALL variable in WebPreferences:
  • Set NOSEARCHALL = on
  • It is not recommended to restrict view access to individual topics since all content is searchable within a web.
• 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 TWikiGuest, can get around this, allowing anyone to login with, for example, view-only access for public webs.) TWikiInstallationGuide has more on Basic Authentication, using the .htaccess file.
• 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.

Create Authenticated Access By Web

1. Set aside the view script (rename) and create a view subdirectory in its place.
2. In the view subdirectory, create a separate copy of a modified viewing script for each web, and create .htaccess settings for the restricted webs.
   • You can use symbolic links to a single copy of the viewing script to make any script updates that much easier.

Example of viewing script redirect

#!/usr/bin/perl -w
#

# Adjust SCRIPT and PATH_INFO variables to account for the changed directory my $web = $ENV{SCRIPT_NAME}; $web =~ s#^.*/view(/[^/]*).*$#$1#; # isolate the path element after "view" $ENV{PATH_TRANSLATED} =~ s#(/[^/]*)$#$web$1#; $ENV{PATH_INFO} =~ s#(/[^/]*)$#$web$1#; $ENV{SCRIPT_NAME} =~ s#/view$web#/view#; $ENV{SCRIPT_FILENAME} =~ s#/view$web#/view#;

# open (LOG, '>>/tmp/redirect.log'); # print LOG join ("\n", scalar localtime (time ()), %ENV); # close LOG; exec ('/usr/bin/perl', '-wT', 'view.orig') or

print <<EOF; Content-type: text/plain

Error executing /cgi-bin/view.orig: $? Click the BACK button in your browser and contact webmaster\@bcs-oops.org.

EOF

• (Mod by ImmoHuneke^? - 16 Mar 2002)

1. Enable the $doRememberRemoteUser flag in lib/TWiki.cfg as described in TWikiUserAuthentication. Proyecto META 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.

1. Create a new topic with A name that ends in Group, SomeGroup

• GROUP is a comma-separated list of users and of other groups:
      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,
      Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup
  for the TWikiAdminGroup topic. (This prevents users not in the group from editing the topic and from gaining unauthorized membership to the group.)

Hiding Control Settings

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

<!--
Set DENYTOPICCHANGE = Main.SomeGroup
-->

• • Edits can be undone by the TWikiAdminGroup (the default administrators group; see #ManagingGroups).

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

• 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.

1. 1. Enable the $doRememberRemoteUser flag in lib/TWiki.cfg as described in TWikiUserAuthentication. Proyecto META will now remember the IP address of an authenticated user.

Warning: Can't find topic TWiki.UtilTempDocNote

TWiki Access Control

Overview

An Important Control Consideration

Users and Groups

Managing Users

Managing Groups

Restricting Write Access

Deny Editing by Topic

Deny Editing by Web

Restricting Rename Access

Deny Renaming by Topic

Deny Renaming by Web

Restricting Read Access

Known Issues

Selective Unrestricted Web Access

The SuperAdminGroup

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 editing - the ability to rearrange anything on a page - keeps topics focussed.

• • 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 can be authenticated using Basic Authentication or SSL. Authentication is required in order to track user identities.

1. Create a new topic with A name that ends in Group, SomeGroup
2. Define two variables:

• • GROUP is a comma-separated list of users and of other groups:
        * 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,
        * Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup
    for the TWikiAdminGroup topic. (This prevents users not in the group from editing the topic and from gaining unauthorized membership to the group.)

Deny Editing by Topic

• Define one or both of these variables in a topic, preferably at the end of the page:

• 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:
      * Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.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 ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.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.

• Define one or both of these variable in the WebPreferences topic:

• Define one or both of these variables in a topic, preferably at the end of the topic:

• 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 DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.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 ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.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.

• Define one or both of these variable in the WebPreferences topic:

• Define one or both of these variable in the WebPreferences topic:

1. 1. Omit the view script from the .htaccess file.
   2. Enable the $doRememberRemoteUser flag in lib/wikicfg.pm as described in User Authentication. Proyecto META will now remember the IP address of an authenticated user.
   3. Copy the view script to viewauth (or better, create a symbolic link)
   4. Add viewauth to the list of authenticated scripts in the .htaccess file.

• Set the $superAdminGroup variable in lib/TWiki.cfg to the name of a group of users that are always allowed to edit/view topics.

Overview

• Peer influence is enough to ensure that only relevant content is posted.
• Peer editing - edit anything on a page - keeps topics focussed.
• All content is preserved under revision control.
  • Edits can be undone by the TWikiAdminGroup (the default administrators group; see Managing Groups).
  • Editing and refactoring (condensing a long topic) is encouraged (there's a safety net).

Managing Users

A user is created by 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.

• Users can be authenticated using Basic Authentication or SSL. TWiki Authentication has more.

Managing Groups

• A group topic name must end in _Group

• GROUP defines the members of the group; it is a comma delimited list of users and other groups. Example:
      * Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeOtherGroup

Restricting Write Access

Deny Editing by Topic

Deny Editing by Web

Restricting Rename Access

Deny Renaming by Topic

Deny Renaming by Web

Restricting Read Access

Known Issues

• 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 Guide has more on Basic Authentication based on the .htaccess file.

Selective Unrestricted Web Access

• • Leave the view script non-authenticated in the .htaccess file.
  • Enable the $doRememberRemoteUser flag in lib/wikicfg.pm as described in User Authentication. Proyecto META 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.

• 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:

• It is not recommended to restrict view access to individual topics since all content is searchable within a web.

• Set the $superAdminGroup variable in lib/TWiki.cfg to the name of a group of users that are always allowed to edit/view topics.

• The default setting is not to have superusers.

Read Restriction Known Issues

• 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:

• • When a user accesses a web where you enabled view restriction, Proyecto META 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.

The SuperAdminGroup

Write Access Restriction by Topic

Write Access Restriction by Web

Rename Access Restriction by Topic

Rename Access Restriction by Web

Read Access Restriction by Web

Read Access Restriction Notes

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.:

$superAdminGroup = "TWikiAdminGroup";

• the default setting is not to have superusers

-- AndreaSterbini^? - 11 Apr 2001

Related topics: TWikiPreferences, WebPreferences (in every web), TWikiAdminGroup, TWikiGroups

Rename Access Restriction for Individual Topics

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.

Define one or both of these variables in a topic, preferably at the end of the topic:

• Set DENYTOPICRENAME = < list of users and groups >
• Set ALLOWTOPICRENAME = < list of users and groups >

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 DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.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 ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.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.

Rename Access Restriction for a Whole Proyecto META Web

You can define restrictions of who is allowed to do renames for a Proyecto META web.

Define one or both of these variable in the WebPreferences topic:

• Set DENYWEBRENAME = < list of users and groups >
• Set ALLOWWEBRENAME = < list of users and groups >

The same rules apply like the one for Access Control for Individual Topics; with these additions:

• DENYTOPICRENAME (in topic) overrides DENYWEBRENAME (in WebPreferences)
• ALLOWTOPICRENAME (in topic) overrides ALLOWWEBRENAME (in WebPreferences)

• • Add viewauth to the list of authenticated scripts in the .htaccess file.

TWiki Access Control

Users and Groups

Write Access Restriction for Individual Topics

Write Access Restriction for a Whole Proyecto META Web

Read Access Restriction for a Whole Proyecto META Web

• 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 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. Proyecto META will now remember the IP address of an authenticated user.
  • Copy the view script to viewauth (or better, create a symbolic link)
  • Enable authentication for the viewauth script in the .htaccess file.
  • When a user accesses a web where you enabled view restriction, Proyecto META 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.

You can define restrictions of who is allowed to view a Proyecto META web.

Define one or both of these variable in the WebPreferences topic:

• Set DENYWEBVIEW = < list of users and groups >
• Set ALLOWWEBVIEW = < list of users and groups >

Notes for read access restriction:

• 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.

• DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in WebPreferences)
• ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in WebPreferences)

• 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.

IMPORTANT NOTE: Is is recommended to use the access control feature only if absolutely necessary because it goes against the free WikiCulture, where everybody is invited to contribute to any topic.

Users and Groups

Access control is based on users and groups.

Users are defined by the user topics in the Main web, i.e. TWikiGuest

• Users can be authenticated using basic authentication or SSL. Installation Notes has more.

Groups are defined by group topics in the Main web, i.e. TWikiAdminGroup

• 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:
      * 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.
      * Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup
  for the TWikiAdminGroup topic. (This is to prevent users not in the group from editing the topic and gaining unauthorized membership to the group.)