none
[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 Web Access"> Restricting Web Access</a><ul>
21             <li><a href="#Create Hidden Webs"> Create Hidden Webs</a></li>
22             <li><a href="#Create Authenticated Access By W"> Create Authenticated Access By Web</a></li>
23           </ul>
24         </li>
25         <li><a href="#Hiding Control Settings"> Hiding Control Settings</a></li>
26         <li><a href="#The _SuperAdminGroup"> The SuperAdminGroup</a></li>
27       </ul>
28     </li>
29   </ul>
30 </div>
31
32 # <a name="TWiki Access Control"></a> TWiki Access Control
33
34 _Restricting read and write access to topics and webs, by users and groups_
35
36 [[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.
37
38 ## <a name="An Important Control Considerati"></a> An Important Control Consideration
39
40 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:
41
42 - Peer influence is enough to ensure that only relevant content is posted.
43
44 - Peer editing - the ability to rearrange anything on a page - keeps topics focussed.
45
46 - All content is preserved under revision control.
47   - Edits can be undone by the [[TWikiAdminGroup]] (the default administrators group; see [[#ManagingGroups|Main/WebHome#ManagingGroups]]).
48   - Users are encouraged to edit and refactor (condense a long topic), since there's a safety net.
49
50 As a collaboration guideline:
51
52 - Create broad groups (more and varied input), and...
53 - Avoid creating view-only users (if you can read it, you can contribute to it).
54
55 ## <a name="Users and Groups"></a> Users and Groups
56
57 Access control is based on users and groups. Users are defined by their [[WikiNames]], an then organized in unlimited combinations under different user groups.
58
59 ### <a name="Managing Users"></a> Managing Users
60
61 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]].
62
63 - Users can be authenticated using Basic Authentication or SSL. [[TWikiUserAuthentication]] is required in order to track user identities.
64
65 <a name="ManagingGroups"></a>
66
67 ### <a name="Managing Groups"></a> Managing Groups
68
69 Groups are defined by group topics in the <code>**Main**</code> web, like the [[TWikiAdminGroup]]. To create a new group:
70
71 1. Start in [[TWikiGroups]] and **create** a new topic with a name that ends in **Group**. Example:
72   - <code>**SomeGroup**</code>
73 2. **Define** two variables in the group topic:
74   - <code>**Set GROUP = &lt; list of users and/or groups &gt;**</code>
75   - <code>**Set ALLOWTOPICCHANGE = &lt; list of users and/or groups &gt;**</code>
76
77 - 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.
78 - The GROUP variable is a comma-separated list of users and/or other groups. Example:
79   - <code>**Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeOtherGroup**</code>
80 - 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:
81   - <code>**Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup**</code>
82
83 ## <a name="Restricting Write Access"></a> Restricting Write Access
84
85 You can define who is allowed to make changes to a web or a topic.
86
87 ### <a name="Deny Editing by Topic"></a> Deny Editing by Topic
88
89 Denying editing of a topic also restricts file attachment; both privileges are assigned together.
90
91 - Define one or both of these variables in a topic, preferably at the end of the page:
92   - <code>**Set DENYTOPICCHANGE = &lt; list of users and groups &gt;**</code>
93   - <code>**Set ALLOWTOPICCHANGE = &lt; list of users and groups &gt;**</code>
94
95 - 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:
96   - <code>**Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
97
98 - 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:
99   - <code>**Set ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
100
101 - 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.
102
103 ### <a name="Deny Editing by Web"></a> Deny Editing by Web
104
105 Restricting web-level editing blocks creating new topics, changing topics or attaching files.
106
107 - Define one or both of these variable in the [[WebPreferences]] topic:
108   - <code>**Set DENYWEBCHANGE = &lt; list of users and groups &gt;**</code>
109   - <code>**Set ALLOWWEBCHANGE = &lt; list of users and groups &gt;**</code>
110
111 The same rules apply as for restricting topics, with these additions:
112
113 - DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in WebPreferences)
114 - ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in WebPreferences)
115
116 ## <a name="Restricting Rename Access"></a> Restricting Rename Access
117
118 You can define who is allowed to rename, move or delete a topic, or rename a web.
119
120 ### <a name="Deny Renaming by Topic"></a> Deny Renaming by Topic
121
122 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.
123
124 - Define one or both of these variables in a topic, preferably at the end of the topic:
125   - <code>**Set DENYTOPICRENAME = &lt; list of users and groups &gt;**</code>
126   - <code>**Set ALLOWTOPICRENAME = &lt; list of users and groups &gt;**</code>
127
128 - DENYTOPICCRENAME defines users or groups that **are not** allowed to rename the topic. It is a comma delimited list of users and groups. Example:
129   - <code>**Set DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
130
131 - ALLOWTOPICRENAME defines users or groups that **are** allowed to rename the topic. It is a comma delimited list of users and groups. Example:
132   - <code>**Set ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
133
134 - 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.
135
136 ### <a name="Deny Renaming by Web"></a> Deny Renaming by Web
137
138 You can define restrictions of who is allowed to rename a %WIKITOOLNAME% web.
139
140 - Define one or both of these variable in the [[WebPreferences]] topic:
141   - <code>**Set DENYWEBRENAME = &lt; list of users and groups &gt;**</code>
142   - <code>**Set ALLOWWEBRENAME = &lt; list of users and groups &gt;**</code>
143
144 The same rules apply as for topics, with these additions:
145
146 - DENYTOPICRENAME (in topic) overrides DENYWEBRENAME (in WebPreferences)
147 - ALLOWTOPICRENAME (in topic) overrides ALLOWWEBRENAME (in WebPreferences)
148
149 ## <a name="Restricting Web Access"></a> Restricting Web Access
150
151 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.
152
153 ### <a name="Create Hidden Webs"></a> Create Hidden Webs
154
155 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:
156
157 - <code>**Set DENYWEBVIEW = &lt; list of users and groups &gt;**</code>
158 - <code>**Set ALLOWWEBVIEW = &lt; list of users and groups &gt;**</code>
159
160 %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]]:
161
162 - <code>**Set NOSEARCHALL = on**</code>
163   - It is not recommended to restrict view access to individual topics since all content is searchable _within_ a web.
164   - %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.
165
166 %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.)_
167
168 ### <a name="Create Authenticated Access By W"></a> Create Authenticated Access By Web
169
170 Use the following setup to provide unrestricted viewing access to open webs, with authentication only on selected webs:
171
172 1. **Omit** the <code>**view**</code> script from the `.htaccess` file.
173 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.
174 3. **Copy** the <code>**view**</code> script to <code>**viewauth**</code> (or better, create a symbolic link)
175 4. **Add** <code>**viewauth**</code> to the list of authenticated scripts in the .htaccess file.
176
177 - 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.
178 - 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:
179   - <code>**Set NOSEARCHALL = on**</code>
180 - It is not recommended to restrict view access to individual topics since all content is searchable _within_ a web.
181
182 ## <a name="Hiding Control Settings"></a> Hiding Control Settings
183
184 - %T% To hide access control settings from normal browser viewing, place them in comment markers.
185
186 > &lt;!--
187 >
188 > <br />
189 >
190 > Set DENYTOPICCHANGE = Main.SomeGroup
191 >
192 > <br />
193 >
194 > --&gt;
195
196 <a name="SuperAdminGroup"></a>
197
198 ## <a name="The _SuperAdminGroup"></a> The SuperAdminGroup
199
200 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**:
201
202 - Set the `$superAdminGroup` variable in `lib/TWiki.cfg` to the name of a group of users who are always allowed to edit/view topics.
203
204 > $superAdminGroup = "TWikiAdminGroup";
205
206 - The default setting is not to have superusers.
207
208 -- [[MikeMannix]] - 01 Apr 2002 <br /> -- [[PeterThoeny]] - 04 May 2002