86b4b3efda5f52bceec55617c1a6f5182a67311f
[openafs-wiki.git] / TWiki / TWikiAccessControl.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Access Control"> TWiki Access Control</a><ul>
4         <li><a href="#An Important Control Considerati"> An Important Control Consideration</a></li>
5         <li><a href="#Users and Groups"> Users and Groups</a><ul>
6             <li><a href="#Managing Users"> Managing Users</a></li>
7             <li><a href="#Managing Groups"> Managing Groups</a></li>
8           </ul>
9         </li>
10         <li><a href="#Restricting Write Access"> Restricting Write Access</a><ul>
11             <li><a href="#Deny Editing by Topic"> Deny Editing by Topic</a></li>
12             <li><a href="#Deny Editing by Web"> Deny Editing by Web</a></li>
13           </ul>
14         </li>
15         <li><a href="#Restricting Rename Access"> Restricting Rename Access</a><ul>
16             <li><a href="#Deny Renaming by Topic"> Deny Renaming by Topic</a></li>
17             <li><a href="#Deny Renaming by Web"> Deny Renaming by Web</a></li>
18           </ul>
19         </li>
20         <li><a href="#Restricting Read Access"> Restricting Read Access</a><ul>
21             <li><a href="#Deny Viewing by Topic"> Deny Viewing by Topic</a></li>
22             <li><a href="#Deny Viewing by Web"> Deny Viewing by Web</a><ul>
23                 <li><a href="#Obfuscate Webs"> Obfuscate Webs</a></li>
24                 <li><a href="#Authenticate all Webs and Restri"> Authenticate all Webs and Restrict Selected Webs</a></li>
25                 <li><a href="#Authenticate and Restricting Sel"> Authenticate and Restricting Selected Webs Only</a></li>
26               </ul>
27             </li>
28           </ul>
29         </li>
30         <li><a href="#Hiding Control Settings"> Hiding Control Settings</a></li>
31         <li><a href="#The _SuperAdminGroup"> The SuperAdminGroup</a></li>
32       </ul>
33     </li>
34   </ul>
35 </div>
36
37 # <a name="TWiki Access Control"></a> TWiki Access Control
38
39 _Restricting read and write access to topics and webs, by Users and groups_
40
41 [[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.
42
43 ## <a name="An Important Control Considerati"></a> An Important Control Consideration
44
45 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:
46
47 - **Peer influence** is enough to ensure that only relevant content is posted.
48
49 - **Peer editing** - the ability for anyone to rearrange all content on a page - keeps topics focussed.
50
51 - In TWiki, content is transparently preserved under **revision control**:
52   - Edits can be undone by the [[TWikiAdminGroup]] (the default administrators group; see [[#ManagingGroups|Main/WebHome#ManagingGroups]]).
53   - Users are encouraged to edit and refactor (condense a long topic), since there's a safety net.
54
55 As a **collaboration guideline**:
56
57 - Create broad-based Groups (for more and varied input), and...
58 - Avoid creating view-only Users (if you can read it, you should be able to contribute to it).
59
60 ## <a name="Users and Groups"></a> Users and Groups
61
62 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.
63
64 ### <a name="Managing Users"></a> Managing Users
65
66 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]].
67
68 - 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.
69
70 <a name="ManagingGroups"></a>
71
72 ### <a name="Managing Groups"></a> Managing Groups
73
74 Groups are defined by group topics created in the <code>**Main**</code> web, like the [[TWikiAdminGroup]]. To create a new group:
75
76 1. <code>**Edit**</code> [[TWikiGroups]] by entering a new topic with a name that ends in <code>**Group**</code>. Example:
77   - <code>**SomeGroup**</code>
78 2. **Set Preferences** for two Variables in the new group topic:
79   - <code>**Set GROUP = &lt; list of Users and/or Groups &gt;**</code>
80   - <code>**Set ALLOWTOPICCHANGE = &lt; list of Users and/or Groups &gt;**</code>
81   - The GROUP variable is a comma-separated list of Users and/or other Groups. Example:
82     - <code>**Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeGroup**</code>
83   - 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:
84   - <code>**Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup**</code>
85
86 ## <a name="Restricting Write Access"></a> Restricting Write Access
87
88 You can define who is allowed to make changes to a web or a topic.
89
90 ### <a name="Deny Editing by Topic"></a> Deny Editing by Topic
91
92 Denying editing of a topic also restricts file attachment; both privileges are assigned together.
93
94 - Define one or both of these variables in a topic, preferably at the end of the page:
95   - <code>**Set DENYTOPICCHANGE = &lt; list of Users and Groups &gt;**</code>
96   - <code>**Set ALLOWTOPICCHANGE = &lt; list of Users and Groups &gt;**</code>
97
98 - DENYTOPICCHANGE defines Users or Groups that **are not** allowed to make changes to the topic, with a comma-delimited list. Example:
99   - <code>**Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
100
101 - 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:
102   - <code>**Set ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
103
104 - 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.
105
106 ### <a name="Deny Editing by Web"></a> Deny Editing by Web
107
108 Restricting web-level editing blocks creating new topics, changing topics or attaching files.
109
110 - Define one or both of these variable in the [[WebPreferences]] topic:
111   - <code>**Set DENYWEBCHANGE = &lt; list of Users and Groups &gt;**</code>
112   - <code>**Set ALLOWWEBCHANGE = &lt; list of Users and Groups &gt;**</code>
113
114 The same rules apply as for restricting topics, with these additions:
115
116 - DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in WebPreferences)
117 - ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in WebPreferences)
118
119 ## <a name="Restricting Rename Access"></a> Restricting Rename Access
120
121 You can define who is allowed to rename, move or delete a topic, or rename a web.
122
123 ### <a name="Deny Renaming by Topic"></a> Deny Renaming by Topic
124
125 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.
126
127 - Define one or both of these variables in a topic, preferably at the end of the topic:
128   - <code>**Set DENYTOPICRENAME = &lt; list of Users and Groups &gt;**</code>
129   - <code>**Set ALLOWTOPICRENAME = &lt; list of Users and Groups &gt;**</code>
130
131 - DENYTOPICCRENAME defines Users or Groups that **are not** allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:
132   - <code>**Set DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
133
134 - ALLOWTOPICRENAME defines Users or Groups that **are** allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:
135   - <code>**Set ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
136
137 - 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.
138
139 ### <a name="Deny Renaming by Web"></a> Deny Renaming by Web
140
141 You can define restrictions of who is allowed to rename a %WIKITOOLNAME% web.
142
143 - Define one or both of these variable in the [[WebPreferences]] topic:
144   - <code>**Set DENYWEBRENAME = &lt; list of Users and Groups &gt;**</code>
145   - <code>**Set ALLOWWEBRENAME = &lt; list of Users and Groups &gt;**</code>
146
147 The same rules apply as for topics, with these additions:
148
149 - DENYTOPICRENAME (in topic) overrides DENYWEBRENAME (in WebPreferences)
150 - ALLOWTOPICRENAME (in topic) overrides ALLOWWEBRENAME (in WebPreferences)
151
152 ## <a name="Restricting Read Access"></a> Restricting Read Access
153
154 You can define who is allowed to see a web.
155
156 ### <a name="Deny Viewing by Topic"></a> Deny Viewing by Topic
157
158 %X% Technically it is possible to restrict read access to an individual topic based on <code>**DENYTOPICVIEW**</code> / <code>**ALLOWTOPICVIEW**</code> 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.
159
160 ### <a name="Deny Viewing by Web"></a> Deny Viewing by Web
161
162 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:
163
164 - **obfuscating webs:** Insecure but handy method to hide new webs until content is ready for deployment.
165 - **authenticating all webs and restricting selected webs:** Topic access in all webs is authenticated, and selected webs have restricted access.
166 - **authenticating and restricting selected webs only:** Provide unrestricted viewing access to open webs, with authentication and restriction only on selected webs.
167
168 #### <a name="Obfuscate Webs"></a> Obfuscate Webs
169
170 The idea is to keep a web hidden by not publishing its URL and by preventing the <code>**all webs**</code> search option from accessing obfuscated webs. Do so by enabling the <code>**NOSEARCHALL**</code> variable in [[WebPreferences]]:
171
172 - <code>**Set NOSEARCHALL = on**</code>
173
174 This setup can be useful to hide a new web until content its ready for deployment.
175
176 %X% **Obfuscating webs is insecure**, as anyone who knows the URL can access the web.
177
178 #### <a name="Authenticate all Webs and Restri"></a> Authenticate all Webs and Restrict Selected Webs
179
180 Use the following setup to authenticate users for topic viewing in all webs and to restrict access to selected webs:
181
182 1. **Restrict** view access to selected Users and Groups. Set one or both of these variables in its [[WebPreferences]] topic:
183   - <code>**Set DENYWEBVIEW = &lt; list of Users and Groups &gt;**</code>
184   - <code>**Set ALLOWWEBVIEW = &lt; list of Users and Groups &gt;**</code>
185 2. **Hide** the web from an "all webs" search. Enable this restriction with the <code>**NOSEARCHALL**</code> variable in its [[WebPreferences]] topic:
186   - <code>**Set NOSEARCHALL = on**</code>
187 3. **Add** <code>**view**</code> to the list of authenticated scripts in the `.htaccess` file.
188
189 %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.
190
191 #### <a name="Authenticate and Restricting Sel"></a> Authenticate and Restricting Selected Webs Only
192
193 Use the following setup to provide unrestricted viewing access to open webs, with authentication only on selected webs:
194
195 1. **Restrict** view access to selected Users and Groups. Set one or both of these variables in its [[WebPreferences]] topic:
196   - <code>**Set DENYWEBVIEW = &lt; list of Users and Groups &gt;**</code>
197   - <code>**Set ALLOWWEBVIEW = &lt; list of Users and Groups &gt;**</code>
198 2. **Hide** the web from an "all webs" search. Enable this restriction with the <code>**NOSEARCHALL**</code> variable in its [[WebPreferences]] topic:
199   - <code>**Set NOSEARCHALL = on**</code>
200 3. **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.
201 4. **Copy** the <code>**view**</code> script to <code>**viewauth**</code> (or better, create a symbolic link)
202 5. **Add** <code>**viewauth**</code> to the list of authenticated scripts in the `.htaccess` file. The <code>**view**</code> script should not be listed in the `.htaccess` file.
203
204 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.
205
206 %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.
207
208 ## <a name="Hiding Control Settings"></a> Hiding Control Settings
209
210 - %T% To hide access control settings from normal browser viewing, place them in comment markers.
211
212 > &lt;!--
213 >
214 > <br />
215 >
216 > - Set DENYTOPICCHANGE = Main.SomeGroup<br /> --&gt;
217
218 <a name="SuperAdminGroup"></a>
219
220 ## <a name="The _SuperAdminGroup"></a> The SuperAdminGroup
221
222 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**:
223
224 - 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.
225
226 > $superAdminGroup = "TWikiAdminGroup";
227
228 - The default setting is not to have superusers.
229
230 -- [[PeterThoeny]] - 04 May 2002<br /> -- [[MikeMannix]] - 12 May 2002